fossgit 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b587f5714e832075d9bfa3935c3814e242267712
-  data.tar.gz: 0e0dd8b1f92c433492dd35873f254494b727de1f
+  metadata.gz: 7eca5110eb895f6f749b936257f8afdc5319cfae
+  data.tar.gz: 42265b429b00832cb61896d2479a7bc1ac352ff9
 SHA512:
-  metadata.gz: fd6d9a5534f350c48b55ed9c754e031e058ff7bdba4401417999f6cac2df4394e7f4bc09243c9eabd2b002b28d1e8e0cb690d323083dabe36740dac45f629e48
-  data.tar.gz: 9edbe6e60d9d38398e4c196cce02d191afe45e6ab8cbd665b297a1758fd7cec5837fc557ce753baefb6564253645871bd429db69c40579bdaabb864272748ff6
+  metadata.gz: b020ff7cde1febd18476afe0f13fd84b1b910e80d717d40173a57e2be74a81ac4975e8293c64c146a1bd75bcdcef39e94dc58f872e6ae99d99aa06f5b484f45a
+  data.tar.gz: 203a1b2366d7ac83e3d476a7af9e06679b691b4b75c7d9d208a66e9ec1a37f244254dfdbbc358a7a760514e89451cd1a059d625169be43d457a045bbde28486b

data/LICENSE

@@ -1,4 +1,4 @@
-FossGit: Copyright 2016 Chad Perrin, released under the terms of version 0.4 of
+FossGit: Copyright 2016 Chad Perrin, released under the terms of version 0.5 of
 the Copyfree Open Innovation License.
 
 ## Terms and Conditions
@@ -17,10 +17,10 @@ and/or otherwise deal in the licensed material without restriction.
 license to reproduce, modify, distribute, publish, sell, use, and/or otherwise
 deal in the licensed material without restriction, for any and all patents:
 
-    a. Held presently or in the future by each such holder of copyright or
-    other legal privilege, author or assembler, or contributor, necessarily
-    infringed by the contributions alone or by combination with the work, of
-    that privilege holder, author or assembler, or contributor.
+    a. Held by each such holder of copyright or other legal privilege, author
+    or assembler, or contributor, necessarily infringed by the contributions
+    alone or by combination with the work, of that privilege holder, author or
+    assembler, or contributor.
 
     b. Necessarily infringed by the work at the time that holder of copyright
     or other privilege, author or assembler, or contributor made any

data/README.md

@@ -12,21 +12,86 @@ Install the [Ruby Gem][gem]:
 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].
+1. Clone it from the [Fossil repository][frepo], the [GitHub][ghrepo] mirror,
+   or the [GitLab][glrepo] mirror.
 
-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.
+2. Build a gem, using this command:
+
+        gem build fossgit.gemspec
+
+3. Install the gem, using this command, using the whole filename of the gem
+   filename, substituting the actual version number for `<version`:
+
+        gem install fossgit-<version>
+
+If that still does not suit your needs, you're on your own for now.  I'd be
+happy to accept suggestions for additional installation methods to describe.
 
 ## Usage
 
+After installation, you can use this command to see documentation for command
+line usage and (optional) configuration:
+
+    $ fossgit -h
+
+### Basic Command Line
+
 With an open checkout of your Fossil repository:
 
     $ cd /path/to/open/fossil/checkout
     $ fossgit /path/to/git/repository
 
+### Config
+
+The following is just a basic introduction to FossGit configuration.  See full
+config documentation via the command line tool's `-h` option.
+
+By placing a config file in the directory that will serve as your working
+directory while running `fossgit` (typically the root of your Fossil repository
+checkout directory tree), you can do away with the need to specify the path to
+the local Git repository mirror.  Simply create a file there called `.fossgit`
+containing the following:
+
+    gitrepo: /path/to/gitdir/reponame
+
+You can then run the command without arguments:
+
+    $ cd /path/to/open/fossil/checkout
+    $ fossgit
+
+You can also place a `.fossgit` config file in your home directory, in which
+case you may wish to specify the path to a directory in which you keep all your
+Git repository mirrors and let `fossgit` infer your repository name from the
+project-name setting in your Fossil repository:
+
+    gitpath: /path/to/gitdir
+
+Once again, this allows you to run the command without arguments, but in this
+case you should ensure the "project name" setting has been configured in your
+Fossil repository, because it will default to using that to find your local Git
+mirror.  If you want to specify a different Git repository name, using the
+`gitrepo` setting in a `.fossgit` file within the checkout of your Fossil
+repository as described above might be a better option.
+
+You can check whether your project name has been configured by running this
+command from within an open checkout:
+
+    $ fossil info
+
+If the `project-name` line says `<unnamed>`, the project name is unconfigured.
+You can cofigure it yourself; open the web UI for the repository (e.g.  run
+`fossil serve` from within an open checkout and open `localhost:8080` in your
+browser), navigate to `Admin > Configuration`, fill in the Project Name field,
+and click the button to apply your changes.
+
+If you do both, the most-specific option (gitrepo) will be chosen as the target
+Git repository, which is probably a good idea if, for a specific project, you
+have not configured the Fossil repository's project-name setting, or if you
+want to default to updating a mirror with a different name than the Fossil
+project-name.  Specifying a repository path at the command line will cause
+`fossgit` to ignore both, and just use the command line argument as the target
+Git repository path.
+
 ## Dependencies
 
 * Fossil SCM
@@ -40,27 +105,15 @@ With an open checkout of your Fossil repository:
 In order from most preferred to least preferred:
 
 * Add a ticket in the Fossil repository.
-* Add a ticket in the GitHub repository (then I'll copy it to Fossil).
+* Add a ticket in the GitHub or GitLab repository (and I'll copy it to Fossil).
 
 ## Roadmap
 
-* Add tests, maybe.
+* Add more tests, maybe.
+* Change defaults for v2.0, perhaps.
 * Incorporate this functionality into FossRec, a more comprehensive tool.
 
-## Development
-
-The discerning programmer may look over FossGit in its current form and realize
-it is neither object-oriented nor functional in its design.  It is, in fact, a
-pretty straightforward procedural program, written in Ruby (an odd language to
-use for procedural programming, perhaps).  The reason for this is simple: it is
-in essence a glorified shell script.  There are plans to make it part of a
-larger set of libraries and utilities (see the Roadmap), and it will need to
-undergo a fair bit of redesign as part of that; I expect it to be largely
-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
+[ghrepo]: https://github.com/apotheon/fossgit
+[glrepo]: https://gitlab.com/apotheon/fossgit

data/bin/fossgit

@@ -1,97 +1,69 @@
 #!/usr/bin/env ruby
 require 'fossgit'
+require 'fossgit/cli'
+require 'yaml'
 
-@fg = FossGit.new Dir.pwd
-
-def mirror_command
-  [fossil_command, sed_command, git_command].join '|'
-end
-
-def sed_command
-  %q{sed 's/^\(committer \+\)\([^ ]\+@[^ ]\+\)\( *<\)\(\w\+\)\(>.*\)$/\1\4\3\2\5/'}
-end
-
-def fossil_command
-  cmd = ['fossil export --git']
-
-  cmd << "--import-marks #{fossil_marks}" if update_export?
-  cmd << "--export-marks #{fossil_marks}"
-  cmd << @fg.fossil_repository
-
-  cmd.join ' '
-end
-
-def git_command
-  cmd = ['git fast-import']
-
-  cmd << "--import-marks=#{git_marks}" if update_export?
-  cmd << "--export-marks=#{git_marks}"
-
-  cmd.join ' '
-end
-
-def push_command
-  '; git checkout trunk; git push origin trunk'
+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
 
-def update_export?
-  File.exist? git_marks and File.exist? fossil_marks
-end
+@cli = CLI.new ARGV, File.basename($0)
+@fg = FossGit.new (@cli.get_option('-c') or Dir.pwd)
 
-def fossil_marks
-  fossil_file 'fossil.marks'
-end
+Dir.chdir @fg.checkout_path
 
-def git_marks
-  fossil_file 'git.marks'
+if @cli.config['gitdir'] and projectname and not @cli.config['gitrepo']
+  @cli.config['gitrepo'] = File.join(@cli.config['gitdir'], projectname)
 end
 
-def fossil_file filename
-  File.join fossil_path, filename
-end
-
-def fossil_path
-  get_option '-c' or Dir.pwd
-end
-
-def get_option opt, default=nil
-  ARGV.index(opt).tap do |val|
-    return val ? (ARGV.delete_at val and ARGV.delete_at val) : default
-  end
-end
-
-def option_switch? long_name
-  ARGV.delete "-#{long_name[0]}" or ARGV.delete "--#{long_name}"
-end
-
-name = File.basename $0
-
-if option_switch? 'help'
-  puts FossGit.help_text name
+if @cli.option_switch? 'help'
+  puts @cli.help_text
   exit
-elsif option_switch? 'version'
-  puts [name, FossGit.version].join ' '
-elsif option_switch? 'text-export'
-  puts `#{fossil_command}|#{sed_command}`
+elsif @cli.option_switch? 'version'
+  puts [@cli.name, FossGit.version].join ' '
+elsif @cli.option_switch? 'text-export'
+  system @fg.text_export_command
   exit
 else
-  command_line = mirror_command
-  command_line << push_command unless option_switch? 'local'
+  opts = Hash.new
+  opts[:local] = @cli.option_switch? 'local'
+
+  @cli.remotes = nil if (opts[:all] = @cli.remotes.eql? 'all')
+
+  @cli.option_switch?('all').tap {|v| opts[:all] ||= v }
+
+  remotes = (@cli.get_option '-r') or @cli.remotes
 
-  git_path = ARGV.shift
+  gitrepo = (@cli.args.shift or @cli.config['gitrepo'])
 
-  if git_path.to_s.empty?
+  if gitrepo.to_s.empty?
     STDERR.puts 'Error!  No Git path provided.'
     exit!
-  elsif Dir.exist? git_path
-    Dir.chdir git_path
+  elsif Dir.exist? gitrepo
+    Dir.chdir gitrepo
   else
-    STDERR.puts %Q{Error!  Invalid Git path "#{git_path}" provided.}
+    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'
-    system command_line
+    if opts[:local]
+      system @fg.mirror_command
+    else
+      @fg.push_remote_list! remotes
+    end
   else
     STDERR.print %Q{Error!  Invalid Git repository "#{Dir.pwd}" provided.}
     exit!

data/lib/fossgit.rb

@@ -10,58 +10,71 @@ class FossGit
   end
 
   def self.version
-    '1.0.2'
+    '1.1.0'
   end
 
-  def self.help_text name='fossgit'
-    help = <<-EOF
+  def fossil_marks
+    File.join checkout_path, 'fossil.marks'
+  end
 
-      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
+  def git_marks
+    File.join checkout_path, 'git.marks'
+  end
 
-      USAGE:  #{name} -h
-              #{name} [-c <CHECKOUT>] [-l] <GITREPO>
-              #{name} -t
+  def fossil_command
+    cmd = ['fossil export --git']
 
-          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.
+    cmd << "--import-marks #{fossil_marks}" if update_export?
+    cmd << "--export-marks #{fossil_marks}"
+    cmd << fossil_repository
 
-      OPTIONS/ARGUMENTS:
+    cmd.join ' '
+  end
 
-          -h              Display this help text and exit, ignoring all other
-                          arguments.
+  def push_command gitremote
+    "; git checkout trunk; git push #{gitremote} trunk"
+  end
 
-          -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.
+  def git_command
+    cmd = ['git fast-import']
 
-          -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.
+    cmd << "--import-marks=#{git_marks}" if update_export?
+    cmd << "--export-marks=#{git_marks}"
 
-          -t              Dump export to STDOUT rather than sending it to Git.
-                          This overrides the `-l` option and GITREPO argument,
-                          if present.
+    cmd.join ' '
+  end
 
-          GITREPO         Specify the location of your local Git repository.
+  def sed_command
+    %q{sed 's/^\(committer \+\)\([^ ]\+@[^ ]\+\)\( *<\)\(\w\+\)\(>.*\)$/\1\4\3\2\5/'}
+  end
 
-      EXAMPLES:
+  def mirror_command
+    [fossil_command, sed_command, git_command].join '|'
+  end
 
-          $ fossgit -h
+  def push_mirror_command gitremote
+    mirror_command + push_command(gitremote)
+  end
 
-          $ fossgit -c ~/fossil_checkouts/projectname ~/git/projectname
+  def push_remote_list! remote_list
+    remote_list.each do |gitremote|
+      puts "PUSH TO: #{gitremote}"
+      system push_mirror_command(gitremote)
+    end
+  end
 
-          $ cd ~/fossil_checkouts/projectname && fossgit ~/git/projectname
+  def text_export_command
+    [fossil_command, sed_command].join '|'
+  end
 
-    EOF
+  def update_export?
+    File.exist? git_marks and File.exist? fossil_marks
+  end
+
+  def git_remotes gitpath
+    Dir.chdir gitpath do
+      `git remote`.split "\n"
+    end
   end
 
   private
@@ -78,8 +91,10 @@ class FossGit
   def fossil_status
     Dir.chdir checkout_path
 
-    if system 'fossil status'
-      `fossil status`.split(/\n/)
+    stat = `fossil status`
+
+    if stat.size > 0
+      stat.split(/\n/)
     else
       raise ArgumentError, "#{checkout_path} is not a valid checkout path"
     end

data/lib/fossgit/cli.rb

@@ -0,0 +1,163 @@
+require 'yaml'
+
+class CLI
+  attr_accessor :args, :config, :name
+
+  def initialize args=[], cliname='fossgit', filename='.fossgit'
+    @args = args
+    @config = Hash.new
+    @name = cliname
+
+    @config_filename = filename
+    @home_config_file = File.join(Dir.home, @config_filename)
+
+    configure @config_filename
+  end
+
+  def configure file=@config_filename
+    load_home_config
+    load_local_config file
+  end
+
+  def load_home_config
+    if File.exist? @home_config_file
+      @config = YAML.load_file @home_config_file
+    end
+  end
+
+  def load_local_config file=@config_filename
+    if File.exist? file
+      YAML.load_file(file).tap do |local|
+        local.each_key {|k| @config[k] = local[k] }
+      end
+    end
+  end
+
+  def remotes
+    config['remotes']
+  end
+
+  def remotes= gitremotes
+    config['remotes'] = gitremotes
+  end
+
+  def help_text
+    help = <<-EOF
+
+      FossGit mirrors Fossil repositories to Git repositories.  You need:
+      
+      1. both Fossil SCM and Git installed
+      2. a Fossil repository with an open checkout to export
+      3. a Git repository to use as a mirror
+
+      USAGE:  #{name} [-h | -v | -t]
+              #{name} [-c <CHECKOUT>] [-a | -r REMOTE | -l] [GITREPO]
+
+          By default, when exporting to local Git repository GITREPO, #{name}
+          attempts to push updates to a configured upstream Git repository.  It
+          should harmlessly fail to push if there is no upstream repository
+          configured for the local Git repository.  If there is no GITREPO in
+          configuration (see CONFIG below), you must specify GITREPO when using
+          #{name} to mirror your Fossil repository.
+
+      OPTIONS/ARGUMENTS:
+
+          -h              Display this help text and exit, ignoring all other
+                          arguments.
+
+          -a              Push to all configured remotes for the target Git
+                          repository.  Default behavior is to push only to the
+                          configured "origin" remote.
+
+          -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.
+
+          -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.
+
+          -t              Dump export to STDOUT as text rather than sending it
+                          to Git.  This overrides the `-l` switch and GITREPO
+                          argument, if present.
+
+          -v              Show FossGit version number.
+
+          GITREPO         Specify the location of your local Git repository.
+                          This is optional if there is a configuration file
+                          that specifies it for you.
+
+      COMMAND EXAMPLES:
+
+          $ fossgit -h
+
+          $ fossgit -c ~/fossil_checkouts/projectname ~/git/projectname
+
+          $ cd ~/fossil_checkouts/projectname && fossgit ~/git/projectname
+
+      CONFIG:
+
+          A config file named ".fossgit" can be used to set #{name} defaults.
+
+          A universal config file can be placed in the home directory of the
+          user account that executes this command, in which case it will apply
+          every time that account executes #{name}.  A config file can also be
+          placed in the root of an open Fossil repository, in which case it
+          will only apply when #{name} is used for that particular repository.
+          If both files exist, settings from both will be used, but where both
+          have the same setting the more specific config (in the project
+          directory) overrides the equivalent setting from the universal
+          config.  This means a universal configuration can be used for the
+          most common case, but for specific projects that have different needs
+          you can place a config file the project repository.
+
+          These are the available configuration options:
+
+          * The "gitdir" setting can be used to specify a directory in which
+            Git repositories are kept.  In this case, #{name} infers the Git
+            repository name from the "project-name" in "fossil info" output.
+
+          * The "gitrepo" setting can be used to specify the full path to a Git
+            repository, without letting #{name} try to infer the repository
+            name.  This option overrides "gitdir" if both are set.  It is
+            probably a bad idea to set "gitrepo" in a universal config.  It is
+            intended to be set in a project-specific ".fossgit" file because
+            chaos may ensue if all Fossil repositories use the same "gitrepo".
+
+          * The "remotes" setting can be used to specify which of your Git
+            mirror's configured remotes you want to use when pushing from Git.
+            As with the -r command line option, you can list one remote or list
+            several as a comma-separated list with no spaces.  The "remotes"
+            setting in a configuration file accepts the "all" value, equivalent
+            to the -a command line option.
+
+      CONFIG EXAMPLES:
+
+          gitdir: /home/username/fossrec/git
+
+          gitrepo: /home/username/fossrec
+
+          remotes: gitlab
+
+    EOF
+  end
+
+  def get_option opt, default=nil
+    if val = args.index(opt)
+      return (args.delete_at val and args.delete_at val)
+    else
+      return default
+    end
+  end
+
+  def option_switch? long_name
+    args.delete "-#{long_name[0]}" or args.delete "--#{long_name}"
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fossgit
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Chad Perrin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies: []
-description: "    Maintain a presence in Git hosting for Fossil projects.\n"
+description: "    Maintain a presence in Git hosting for Fossil project mirrors.\n"
 email: code@apotheon.net
 executables:
 - fossgit
@@ -21,21 +21,26 @@ files:
 - README.md
 - bin/fossgit
 - lib/fossgit.rb
+- lib/fossgit/cli.rb
 homepage: https://fossrec.com/u/apotheon/fossgit
 licenses:
 - COIL
 metadata: {}
 post_install_message: |2
       Thank you for using FossGit.  For it to work properly, you need to have the
-      following software dependencies installed:
+      following external software dependencies installed:
 
       * Fossil SCM (the world's most decentralized SCM and DVCS)
       * Git (the world's most popular DVCS)
       * sed (standard on Unix-like systems)
 
-      Run "fossgit -h" for usage information.
+      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:
 
-      Version 1.0.1 of FossGit starts the process of extracting a library.
+          https://fossrec.com/u/apotheon/fossgit/index.cgi/reportlist
+
+      Run "fossgit -h" for usage and configuration information.
 rdoc_options: []
 require_paths:
 - lib
@@ -43,7 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.4.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -51,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: 'FossGit: Mirror Fossil to Git.'