surf: build infrastructure

When we attempted to publish the new version of `radicle-surf` we ran
into issues with the `build.rs` file executing -- it was missing the
path to `data/git-platinum.tgz` in its isolated environment.

The fix here is to move the `data` artifacts into the `surf` directory
and add the `git-platinum.tgz` file as an `include` artifact.
When the `build.rs` file executes it will detect whether it ran with
`cargo build` or `cargo publish` by looking at the current directory.
Depending on which it is using it will unpack the tar file into the
correct directory.

Moving the `data` directory required us to also change the tests to
point to the correct directory.

Signed-off-by: Fintan Halpenny <[email protected]>

.gitignore

@@ -18,4 +18,4 @@ Cargo.lock
 
 # This is an inner git repo unpacked (if necessary) from the archive.
 # Git doesn't like nested repos, and we don't really want to use submodules.
-/data/git-platinum
+/surf/data/git-platinum

source/src/revision.rs

@@ -127,7 +127,7 @@ where
 }
 
 /// Provide the [`Revisions`] for the given `peer_id`, looking for the
-/// branches as [`BranchType::Local`].
+/// branches as [`BranchSelector::Local`].
 ///
 /// If there are no branches then this returns `None`.
 ///

surf/Cargo.toml

@@ -12,6 +12,7 @@ license = "GPL-3.0-or-later"
 include = [
     "**/*.rs",
     "Cargo.toml",
+    "data/git-platinum.tgz",
 ]
 
 [features]

surf/build.rs

@@ -15,14 +15,46 @@
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
-use std::{fs::File, path::Path};
+use std::{
+    env,
+    fs::File,
+    io,
+    path::{Path, PathBuf},
+};
 
 use flate2::read::GzDecoder;
 use tar::Archive;
 
+enum Command {
+    Build(PathBuf),
+    Publish(PathBuf),
+}
+
+impl Command {
+    fn new() -> io::Result<Self> {
+        let current = env::current_dir()?;
+        Ok(if current.ends_with("surf") {
+            Self::Build(current)
+        } else {
+            Self::Publish(PathBuf::from(
+                env::var("OUT_DIR").map_err(|err| io::Error::new(io::ErrorKind::Other, err))?,
+            ))
+        })
+    }
+
+    fn target(&self) -> PathBuf {
+        match self {
+            Self::Build(path) => path.join("data"),
+            Self::Publish(path) => path.join("data"),
+        }
+    }
+}
+
 fn main() {
-    let git_platinum_tarball = "../data/git-platinum.tgz";
-    let target = "../data/";
+    let target = Command::new()
+        .expect("could not determine the cargo command")
+        .target();
+    let git_platinum_tarball = "./data/git-platinum.tgz";
 
     unpack(git_platinum_tarball, target).expect("Failed to unpack git-platinum");
 

surf/examples/diff.rs

@@ -35,7 +35,7 @@ fn main() {
         git::Browser::new(&repo, git::Branch::local("master")).expect("failed to create browser:");
 
     match options.head_revision {
-        HeadRevision::HEAD => {
+        HeadRevision::Head => {
             reset_browser_to_head_or_exit(&mut browser);
         },
         HeadRevision::Commit(id) => {
@@ -148,7 +148,7 @@ struct Options {
 }
 
 enum HeadRevision {
-    HEAD,
+    Head,
     Commit(String),
 }
 
@@ -168,7 +168,7 @@ impl Options {
         let base_revision = args[2].clone();
         let head_revision = {
             if args[3].eq_ignore_ascii_case("HEAD") {
-                HeadRevision::HEAD
+                HeadRevision::Head
             } else {
                 HeadRevision::Commit(args[3].clone())
             }

surf/src/lib.rs

@@ -38,7 +38,7 @@
 //!
 //! # fn main() -> Result<(), Box<dyn Error>> {
 //! // We're going to point to this repo.
-//! let repo = git::Repository::new("../data/git-platinum")?;
+//! let repo = git::Repository::new("./data/git-platinum")?;
 //!
 //! // Here we initialise a new Broswer for a the git repo.
 //! let mut browser = git::Browser::new(&repo, git::Branch::local("master"))?;