fossgit 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff8a4c882972941862c63ab14c1a6a7612523c3e
-  data.tar.gz: f7057fc31c57762a4d3ff715a66a8c0a9ef23eb8
+  metadata.gz: 2f89e1271f8492c9e3b00cb7dc853624f4a8d45f
+  data.tar.gz: 5bfde8253a5a00e3b589734ff913ef87b7881020
 SHA512:
-  metadata.gz: 46fc13e318b8ae5bcf8303e2f6ea6e6868894c3537d5eeed767a8f98fda325af781a3ff8dfc4de111da9001f9542830772db02258abaec5e63e968d99da4bc77
-  data.tar.gz: 065d66e51b3073b7cec46bc8bbf238a555a5af678634f1b45d568ad558e47d84502a5faa73a3a6e8a59fbea3bd34b51fbd6a4bd627cfea4fc2baeb8c0354be09
+  metadata.gz: 2403e9e4bc37f9dd76679dffdac327d114296038385af9da4c91f580ade69864497c2e61e5318d57cdda5973dacdca3a955300db5368083b39f822ed90e4fb7f
+  data.tar.gz: 402e5d4d0379c38db310bcdad31e789b9f388c010965b3fb1f20538d564b17f023d276396543536c88a6c5be1899f06ae72a90e06c9f495ab9beaa457f6eb44f

data/README.md

@@ -1,17 +1,24 @@
 # fossgit
 
-This is a simple command line utility for creating and updating Git
+FossGit provides a simple command line utility for creating and updating Git
 repositories as (one-way) mirrors of Fossil repositories.
 
 ## Installation
 
-Clone it from the [Fossil repository](https://fossrec.com/u/apotheon/fossgit/)
-or the [GitHub mirror](https://github.com/apotheon/fossgit/).
+Install the [Ruby Gem][gem]:
 
-Copy the `fossgit` file to a directory in your execution path, create a symlink
-or hardlink to the repository's `fossgit` file in a directory in your execution
-path, add its location in this repository to your execution path, or execute it
-by entering the explicit path to the `fossgit` file at a shell prompt.
+    $ gem install fossgit
+
+If, for some reason, that is not an available option for you or you wish to do
+things the hard way, there is another installation method:
+
+1. Clone it from the [Fossil repository][frepo] or the [GitHub mirror][grepo].
+
+2. Copy the `fossgit` file to a directory in your execution path, create a
+   symlink or hardlink to the repository's `fossgit` file in a directory in
+   your execution path, add its location in this repository to your execution
+   path, or execute it by entering the explicit path to the `fossgit` file at a
+   shell prompt.
 
 ## Usage
 
@@ -37,9 +44,7 @@ In order from most preferred to least preferred:
 
 ## Roadmap
 
-* Make this a stand-alone Ruby Gem some day, maybe.
 * Add tests, maybe.
-* Add automatic GitHub publishing, maybe.
 * Incorporate this functionality into FossRec, a more comprehensive tool.
 
 ## Development
@@ -55,3 +60,7 @@ unrecognizable by then.
 
 Much of this work was done on Christmas weekend 2016.  That may or may not be
 significant.
+
+[gem]: https://rubygems.org/gems/fossgit
+[frepo]: https://fossrec.com/u/apotheon/fossgit
+[grepo]: https://github.com/apotheon/fossgit

data/bin/fossgit

@@ -76,57 +76,10 @@ end
 
 name = File.basename $0
 
-help = <<-EOF
-
-  FossGit provides a simple tool for creating Git mirrors of Fossil
-  repositories.  To use it, you need:
-  
-  1. both Fossil SCM and Git installed
-  2. a Fossil repository to mirror with an open checkout
-  3. a Git repository to use as a mirror
-
-  USAGE:  #{name} -h
-          #{name} [-c <CHECKOUT>] [-l] <GITREPO>
-          #{name} -t
-
-      By default, when exporting to local Git repository GITREPO, #{name}
-      attempts to push updates to a configured upstream Git repository.  It
-      harmlessly fails to push if no upstream repository is configured for the
-      local Git repository.
-
-  OPTIONS/ARGUMENTS:
-
-      -h              Display this help text and exit, ignoring all other
-                      arguments.
-
-      -c CHECKOUT     Specify the location of your Fossil repository's open
-                      checkout, CHECKOUT.  This is optional; you may simply use
-                      this tool from within an open checkout of your Fossil
-                      repository instead.
-
-      -l              Perform local-only mirror operations, without trying to
-                      push Git updates to a remote repository.  By default,
-                      #{name} tries to push to an upstream Git repository
-                      whenever it exports from Fossil to Git.
-
-      -t              Dump export to STDOUT rather than sending it to Git.
-                      This overrides the `-l` option and GITREPO argument, if
-                      present.
-
-      GITREPO         Specify the location of your local Git repository.
-
-  EXAMPLES:
-
-      $ fossgit -h
-
-      $ fossgit -c ~/fossil_checkouts/projectname ~/git/projectname
-
-      $ cd ~/fossil_checkouts/projectname && fossgit ~/git/projectname
-
-EOF
+fg = FossGit.new
 
 if option_switch? 'help'
-  puts help
+  puts fg.help_text name
   exit
 elsif option_switch? 'version'
   puts [name, FossGit.version].join ' '

data/lib/fossgit.rb

@@ -1,5 +1,56 @@
 class FossGit
   def self.version
-    '1.0.0'
+    '1.0.1'
+  end
+
+  def help_text name='fossgit'
+    help = <<-EOF
+
+      FossGit provides a simple tool for creating Git mirrors of Fossil
+      repositories.  To use it, you need:
+      
+      1. both Fossil SCM and Git installed
+      2. a Fossil repository to mirror with an open checkout
+      3. a Git repository to use as a mirror
+
+      USAGE:  #{name} -h
+              #{name} [-c <CHECKOUT>] [-l] <GITREPO>
+              #{name} -t
+
+          By default, when exporting to local Git repository GITREPO, #{name}
+          attempts to push updates to a configured upstream Git repository.  It
+          harmlessly fails to push if no upstream repository is configured for the
+          local Git repository.
+
+      OPTIONS/ARGUMENTS:
+
+          -h              Display this help text and exit, ignoring all other
+                          arguments.
+
+          -c CHECKOUT     Specify the location of your Fossil repository's open
+                          checkout, CHECKOUT.  This is optional; you may simply use
+                          this tool from within an open checkout of your Fossil
+                          repository instead.
+
+          -l              Perform local-only mirror operations, without trying to
+                          push Git updates to a remote repository.  By default,
+                          #{name} tries to push to an upstream Git repository
+                          whenever it exports from Fossil to Git.
+
+          -t              Dump export to STDOUT rather than sending it to Git.
+                          This overrides the `-l` option and GITREPO argument, if
+                          present.
+
+          GITREPO         Specify the location of your local Git repository.
+
+      EXAMPLES:
+
+          $ fossgit -h
+
+          $ fossgit -c ~/fossil_checkouts/projectname ~/git/projectname
+
+          $ cd ~/fossil_checkouts/projectname && fossgit ~/git/projectname
+
+    EOF
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fossgit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chad Perrin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-25 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Maintain a presence in Git hosting for Fossil projects.
@@ -36,7 +36,7 @@ post_install_message: |2
 
       Run "fossgit -h" for usage information.
 
-      Version 1.0.0 of FossGit is dedicated to my wife.  Happy holidays.
+      Version 1.0.1 of FossGit starts the process of extracting a library.
 rdoc_options: []
 require_paths:
 - lib