fossgit 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7eca5110eb895f6f749b936257f8afdc5319cfae
-  data.tar.gz: 42265b429b00832cb61896d2479a7bc1ac352ff9
+  metadata.gz: 3c99282d257c6859651f8f047352af6af3b5baaf
+  data.tar.gz: 4f1054d869c6f7af44e259d9807b36cb52d8a9d4
 SHA512:
-  metadata.gz: b020ff7cde1febd18476afe0f13fd84b1b910e80d717d40173a57e2be74a81ac4975e8293c64c146a1bd75bcdcef39e94dc58f872e6ae99d99aa06f5b484f45a
-  data.tar.gz: 203a1b2366d7ac83e3d476a7af9e06679b691b4b75c7d9d208a66e9ec1a37f244254dfdbbc358a7a760514e89451cd1a059d625169be43d457a045bbde28486b
+  metadata.gz: 881a6fd0ce1c6e9f0b4592269fbb3060e044a0aa3a8ddecca4d2b1a6e26a344e13e5e546eff10d926c41ec4e2b15a638c48284b02fab657dd082965d5e783656
+  data.tar.gz: 7ed9257abb9763d7af0ab6895fc14e132376e335335cd51c17edfae43d09eb9474b8a1be00a7cf182c44baf4c8217f455c0759cc14daff45200b5d7b06e82205

data/README.md

@@ -109,9 +109,12 @@ In order from most preferred to least preferred:
 
 ## Roadmap
 
-* Add more tests, maybe.
+* Add autovivifying functionality for a local Git mirror.
+* Add autovivifying functionality for GitHub and GitLab remotes.
+* Add more tests.
 * Change defaults for v2.0, perhaps.
 * Incorporate this functionality into FossRec, a more comprehensive tool.
+* Organize lib APIs and document them.  (Don't rely on undocumented APIs.)
 
 [gem]: https://rubygems.org/gems/fossgit
 [frepo]: https://fossrec.com/u/apotheon/fossgit

data/bin/fossgit

@@ -1,66 +1,81 @@
 #!/usr/bin/env ruby
 require 'fossgit'
 require 'fossgit/cli'
-require 'yaml'
-
-def projectname
-  fossil_info = YAML.load `fossil info | head -n 1`
-  name = fossil_info ? fossil_info['project-name'] : fossil_info
-  name if not name.eql? '<unnamed>'
-end
 
 @cli = CLI.new ARGV, File.basename($0)
-@fg = FossGit.new (@cli.get_option('-c') or Dir.pwd)
+@fg = FossGit.new (@cli.get_option('checkout') or Dir.pwd)
 
 Dir.chdir @fg.checkout_path
 
-if @cli.config['gitdir'] and projectname and not @cli.config['gitrepo']
-  @cli.config['gitrepo'] = File.join(@cli.config['gitdir'], projectname)
+if @cli.config['gitdir'] and @fg.project_name
+  @cli.config['gitrepo'] ||= File.join(@cli.config['gitdir'], @fg.project_name)
 end
 
-if @cli.option_switch? 'help'
+@cli.parse_switches %w(all help local newgit text-export version)
+
+if @cli.switches['help']
   puts @cli.help_text
   exit
-elsif @cli.option_switch? 'version'
-  puts [@cli.name, FossGit.version].join ' '
-elsif @cli.option_switch? 'text-export'
+elsif @cli.switches['version']
+  puts @cli.name + ' ' + FossGit.version
+elsif @cli.switches['text-export']
   system @fg.text_export_command
   exit
 else
-  opts = Hash.new
-  opts[:local] = @cli.option_switch? 'local'
+  if remotes = @cli.get_option('remotes')
+    remotes = remotes.split ','
+  end
 
-  @cli.remotes = nil if (opts[:all] = @cli.remotes.eql? 'all')
+  ### NO MORE OPTION PARSING
 
-  @cli.option_switch?('all').tap {|v| opts[:all] ||= v }
+  gitrepo = (@cli.args.shift or @cli.config['gitrepo'])
 
-  remotes = (@cli.get_option '-r') or @cli.remotes
+  unless remotes or @cli.switches['local']
+    if @cli.switches['all']
+      remotes = @fg.git_remotes(gitrepo)
+    elsif @cli.remotes and not @cli.switches['newgit']
+      remotes = (@cli.remotes == 'all') ? @fg.git_remotes(gitrepo) : @cli.remotes
+    else
+      remotes = ['origin']
+    end
+  end
 
-  gitrepo = (@cli.args.shift or @cli.config['gitrepo'])
+  hasgit = Dir.exist? gitrepo
 
   if gitrepo.to_s.empty?
     STDERR.puts 'Error!  No Git path provided.'
     exit!
-  elsif Dir.exist? gitrepo
+  elsif @cli.switches['newgit'] and gitrepo
+    if hasgit
+      STDERR.puts %Q{Error!  Directory "#{gitrepo}" already exists.}
+      exit!
+    elsif Dir.mkdir gitrepo
+      Dir.chdir(gitrepo)
+
+      if `git init`.empty?
+        STDERR.puts %{Error!  Cannot init Git within "#{gitrepo}".}
+        exit!
+      end
+    else
+      STDERR.puts %Q{Error!  Cannot create directory "#{gitrepo}".}
+      exit!
+    end
+  elsif @cli.switches['newgit']
+    STDERR.puts %Q{Error!  Name for new Git repository unknown.}
+    exit!
+  elsif hasgit
     Dir.chdir gitrepo
   else
     STDERR.puts %Q{Error!  Invalid Git path "#{gitrepo}" provided.}
     exit!
   end
 
-  if remotes
-    remotes = remotes.split ','
-  else
-    if opts[:all]
-      remotes = @fg.git_remotes gitrepo
-    else
-      remotes = ['origin']
-    end
-  end
-
   if system 'git status'
-    if opts[:local]
+    if @cli.switches['local']
       system @fg.mirror_command
+    elsif remotes.empty?
+      STDERR.print %Q{Error!  Git repository "#{Dir.pwd}" has no remotes.}
+      exit!
     else
       @fg.push_remote_list! remotes
     end

data/lib/fossgit.rb

@@ -1,16 +1,21 @@
+require 'yaml'
+
 class FossGit
   attr_reader :checkout_path
   attr_reader :fossil_repository
+  attr_accessor :project_name
 
   def initialize checkout_path=''
     @checkout_path = checkout_path
     @checkout_path = get_element_matching :'local-root'
 
     @fossil_repository = get_repository_path
+
+    @project_name = get_project_name
   end
 
   def self.version
-    '1.1.0'
+    '1.2.0'
   end
 
   def fossil_marks
@@ -45,6 +50,7 @@ class FossGit
   end
 
   def sed_command
+    # legacy fix for a bug in an old Fossil version's Git-export
     %q{sed 's/^\(committer \+\)\([^ ]\+@[^ ]\+\)\( *<\)\(\w\+\)\(>.*\)$/\1\4\3\2\5/'}
   end
 
@@ -79,6 +85,12 @@ class FossGit
 
   private
 
+  def get_project_name
+    fossil_info = YAML.load `fossil info | head -n 1`
+    name = fossil_info ? fossil_info['project-name'] : fossil_info
+    name if not name.eql? '<unnamed>'
+  end
+
   def get_repository_path
     File.absolute_path get_element_matching :repository
   end
@@ -94,7 +106,7 @@ class FossGit
     stat = `fossil status`
 
     if stat.size > 0
-      stat.split(/\n/)
+      stat.split "\n"
     else
       raise ArgumentError, "#{checkout_path} is not a valid checkout path"
     end

data/lib/fossgit/cli.rb

@@ -1,7 +1,7 @@
 require 'yaml'
 
 class CLI
-  attr_accessor :args, :config, :name
+  attr_accessor :args, :config, :name, :switches
 
   def initialize args=[], cliname='fossgit', filename='.fossgit'
     @args = args
@@ -12,6 +12,8 @@ class CLI
     @home_config_file = File.join(Dir.home, @config_filename)
 
     configure @config_filename
+
+    @switches = Hash.new
   end
 
   def configure file=@config_filename
@@ -51,7 +53,7 @@ class CLI
       3. a Git repository to use as a mirror
 
       USAGE:  #{name} [-h | -v | -t]
-              #{name} [-c <CHECKOUT>] [-a | -r REMOTE | -l] [GITREPO]
+              #{name} [-c <CHECKOUT>] [-a | -r REMOTE | -l] [[-n] GITREPO]
 
           By default, when exporting to local Git repository GITREPO, #{name}
           attempts to push updates to a configured upstream Git repository.  It
@@ -62,37 +64,53 @@ class CLI
 
       OPTIONS/ARGUMENTS:
 
-          -h              Display this help text and exit, ignoring all other
-                          arguments.
+          -h | --help
+
+              Display this help text and exit, ignoring all other arguments.
+
+          -a | --all
+
+              Push to all configured remotes for the target Git repository.
+              Default is to push only to the configured "origin" remote.
+
+          -c <CHECKOUT> | --checkout <CHECKOUT>
 
-          -a              Push to all configured remotes for the target Git
-                          repository.  Default behavior is to push only to the
-                          configured "origin" remote.
+              Specify CHECKOUT, your Fossil repository's checkout location.
+              This is optional; you may simply use this tool from within an
+              open checkout of your Fossil repository instead.
 
-          -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 | --local
 
-          -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.
+              Perform local-only mirror operations without pushing to a remote
+              Git repository.  By default, #{name} pushes to an upstream Git
+              repository whenever it exports from Fossil to Git.
 
-          -r              Specify which of your Git mirror's configured remotes
-                          you want to push.  This overrides the -a switch.  For
-                          multiple remotes, use a comma-separated list with no
-                          spaces between them.
+          -n | --newgit
+          
+              Create a local Git repository mirror when it does not already
+              exist.  Use this option from the Fossil repository's directory
+              hierarchy root and specify the Git repository's location as for
+              updating a mirror via config file, GITREPO argument, or Fossil
+              project-name setting in `fossil info` output.
 
-          -t              Dump export to STDOUT as text rather than sending it
-                          to Git.  This overrides the `-l` switch and GITREPO
-                          argument, if present.
+          -r | --remotes <COMMA,SEPARATED,REMOTES>
 
-          -v              Show FossGit version number.
+              Specify which of the Git mirror's configured remotes to push in a
+              comma separated list with no spaces.  This overrides `--all`.
 
-          GITREPO         Specify the location of your local Git repository.
-                          This is optional if there is a configuration file
-                          that specifies it for you.
+          -t | --text-export
+          
+              Dump export to STDOUT as text rather than sending it to Git.
+              This overrides the `-l` switch and GITREPO argument, if present.
+
+          -v | --version
+          
+              Show FossGit version number.
+
+          GITREPO
+          
+              Specify the location of the local Git mirror, if there is no
+              configuration file specification or to override configuration.
 
       COMMAND EXAMPLES:
 
@@ -149,8 +167,8 @@ class CLI
     EOF
   end
 
-  def get_option opt, default=nil
-    if val = args.index(opt)
+  def get_option long_name, default=nil
+    if val = (args.index "-#{long_name[0]}" or args.index "--#{long_name}")
       return (args.delete_at val and args.delete_at val)
     else
       return default
@@ -160,4 +178,8 @@ class CLI
   def option_switch? long_name
     args.delete "-#{long_name[0]}" or args.delete "--#{long_name}"
   end
+
+  def parse_switches opts
+    opts.each {|opt| switches[opt] = option_switch? opt }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fossgit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chad Perrin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies: []
 description: "    Maintain a presence in Git hosting for Fossil project mirrors.\n"
 email: code@apotheon.net
@@ -34,9 +34,8 @@ post_install_message: |2
       * Git (the world's most popular DVCS)
       * sed (standard on Unix-like systems)
 
-      This update adds support for configuration files and specifying which Git
-      remotes to push.  It should not break backward compatibility.  If it does,
-      that is a bug, and you are encouraged to report it at:
+      This update adds support for a full range of long options and for an option
+      to create a new local Git mirror on the fly.  Please report bugs at:
 
           https://fossrec.com/u/apotheon/fossgit/index.cgi/reportlist