r-git 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b9b8b71821185add335a94f2b6cb8b36a54b769
-  data.tar.gz: 0fedb11778194aebeb7ea22d62aad4e04975f848
+  metadata.gz: a1c3c72baf1287072aa53b4100a22dadeb09b5df
+  data.tar.gz: aff200aa42a7e921d4ed29eeaf05592ce4e52b4b
 SHA512:
-  metadata.gz: a39436aa0aa0c0d786ddc8955c53e884cc489360b79d5248dac56195382c9a520fde0bde227f6ccd0008736decf0fede53a15eb290ad85184fb7e30a5fd9ab3e
-  data.tar.gz: 620463392c4514f91755e129271aa92cadfc5b4a0c540077f12fe377521b143c5187f1c6d6c21f338da51a94ec8bb82c3350ec60b724328a72932a1274665532
+  metadata.gz: 3b5183f8e1ef149f5a2a8c26165f9044a44afc4148c4c1c4eff725bf0212a816ec6f2405b55ffc90abc44194065a7caa20d4aeda02540cd398a07149a5e2e8fd
+  data.tar.gz: 42b80f19cac4f77df0a831d66778a574218997fbf510476a65fb17ba658da073b50e5f83cdc98d5f777096a30cedff9602f4f5ff18b94fd9a705c10fd0817486

data/.rubocop.yml

@@ -11,7 +11,4 @@ Metrics/CyclomaticComplexity:
 Metrics/LineLength:
   Max: 120
 Metrics/MethodLength:
-  Max: 40
-Metrics/PerceivedComplexity:
-  Exclude:
-    - lib/rgit/cli.rb
+  Max: 40

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 ## Change Log
 
+### 1.2
+* Fixed ```bin/console```
+* Re-factored Cli class and added help/usage information for subcommands
+* Added internationalization support (via i18n)
+
 ### 1.1
 * Added travis configuration
 * Added code climate configuration
 * Increased test coverage and code quality
 * Moved to sub-commands
+
 ### 1.0.2
 * Initial Version

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'rgit'
+require 'rgit/rgit'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/exe/rgit

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
-
 require 'rgit/rgit'
-Rgit::Cli.parse(ARGV)
+require 'i18n'
+include Rgit
+I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)
+I18n.reload!
+
+rgit = Rgit::Rgit.new(Configuration.exist? ? Configuration.load : Configuration.create)
+Rgit::Cli.new(rgit).parse(ARGV)

data/lib/rgit/cli.rb

@@ -6,44 +6,102 @@ module Rgit
 
     SUB_COMMANDS = %w(add-root remove-root show-roots checkout pull fetch status version).freeze
 
-    def self.parse(args, rgit = Rgit.new(Configuration.exist? ? Configuration.load : Configuration.create))
-      global_opts = Trollop.options(args) do
-        banner 'rgit is a utility for managing multiple git repositories'
-        opt :verbose, 'Run verbosely', short: '-v'
-        stop_on SUB_COMMANDS
-      end
+    def initialize(rgit)
+      @rgit = rgit
+    end
+
+    def parse(args)
+      parser = rgit_argument_parser
+      global_opts = get_global_options(parser, args)
 
-      rgit.verbose = global_opts[:verbose]
+      @rgit.verbose = global_opts[:verbose]
 
       cmd = args.shift
       case cmd
         when 'add-root'
-          path = args.size == 1 ? args[0] : Dir.pwd
-          rgit.add_root(path)
+          add_root(args)
         when 'remove-root'
-          path = args.size == 1 ? args[0] : Dir.pwd
-          rgit.remove_root(path)
+          remove_root(args)
         when 'checkout'
-          branch = args[0] if args.size == 1
-          unless branch
-            puts 'ERROR: checkout subcommand expects a branch name'.red
-            return
-          end
-          rgit.checkout branch
-        when 'show-root'
-          rgit.print_roots
+          checkout(args)
+        when 'show-roots'
+          show_roots(args)
         when 'pull'
-          rgit.pull
+          pull(args)
         when 'fetch'
-          rgit.fetch
+          fetch(args)
         when 'status'
-          rgit.status
+          status(args)
         when 'version'
           puts "rgit #{VERSION}"
         else
-          puts "ERROR: unknown subcommand #{cmd}".red
-          return
+          puts I18n.t('rgit.unknown_subcommand', command: cmd).red
+      end
+    end
+
+    private
+
+    def rgit_argument_parser
+      Trollop::Parser.new do
+        banner I18n.t('rgit.banner')
+        opt :verbose, I18n.t('rgit.run_verbosely'), short: '-v'
+        stop_on SUB_COMMANDS
+      end
+    end
+
+    def get_global_options(parser, args)
+      Trollop.with_standard_exception_handling parser do
+        raise Trollop::HelpNeeded if args.empty?
+        parser.parse args
+      end
+    end
+
+    def register_options_banner(args, banner_text)
+      Trollop.options(args) do
+        banner banner_text
       end
     end
+
+    def add_root(args)
+      register_options_banner(args, I18n.t('add_root.banner'))
+      path = args.size == 1 ? args[0] : Dir.pwd
+      @rgit.add_root(path)
+    end
+
+    def remove_root(args)
+      register_options_banner(args, I18n.t('remove_root.banner'))
+      path = args.size == 1 ? args[0] : Dir.pwd
+      @rgit.remove_root(path)
+    end
+
+    def checkout(args)
+      register_options_banner(args, I18n.t('checkout.banner'))
+      branch = args[0] if args.size == 1
+      unless branch
+        puts I18n.t('branch.expect_name').red
+        return
+      end
+      @rgit.checkout branch
+    end
+
+    def show_roots(args)
+      register_options_banner(args, I18n.t('show_roots.banner'))
+      @rgit.print_roots
+    end
+
+    def pull(args)
+      register_options_banner(args, I18n.t('pull.banner'))
+      @rgit.pull
+    end
+
+    def fetch(args)
+      register_options_banner(args, I18n.t('fetch.banner'))
+      @rgit.fetch
+    end
+
+    def status(args)
+      register_options_banner(args, I18n.t('status.banner'))
+      @rgit.status
+    end
   end
 end

data/lib/rgit/rgit.rb

@@ -4,6 +4,7 @@ require 'rgit/cli'
 require 'optparse'
 require 'git'
 require 'colorize'
+require 'i18n'
 module Rgit
   class Rgit
     attr_accessor :verbose
@@ -15,14 +16,14 @@ module Rgit
 
     def add_root(path)
       raise "Not a directory: #{path}" unless File.directory?(path)
-      puts "Adding root: #{path}"
+      puts I18n.t('add_root.adding_root', path: path)
       @config.add_root path
       @config.save
     end
 
     def remove_root(path)
       raise "Not a directory: #{path}" unless File.directory?(path)
-      puts "Removing root: #{path}"
+      puts I18n.t('remove_root.removing_root', path: path)
       @config.remove_root path
       @config.save
     end
@@ -30,7 +31,7 @@ module Rgit
     def pull(path = Dir.pwd)
       recursive_cmd(path) do |git|
         git.remotes.each do |remote|
-          puts " Pulling remote: #{remote.name}".colorize(:light_cyan)
+          puts " #{I18n.t('pull.pulling_remote', name: remote.name)}".colorize(:light_cyan)
           results = git.pull(remote.name, git.current_branch)
           puts results.split("\n").map { |l| "   #{l}" }.join("\n") if @verbose
         end
@@ -40,7 +41,7 @@ module Rgit
     def fetch(path = Dir.pwd)
       recursive_cmd(path) do |git|
         git.remotes.each do |remote|
-          puts " Fetching remote: #{remote.name}".colorize(:light_cyan)
+          puts " #{I18n.t('fetch.fetching_remote', name: remote.name)}".colorize(:light_cyan)
           results = git.fetch(remote.name, all: true)
           puts results.split("\n").map { |l| "   #{l}" }.join("\n") if @verbose
         end
@@ -49,32 +50,33 @@ module Rgit
 
     def checkout(branch, path = Dir.pwd)
       recursive_cmd(path) do |git|
-        puts " Checkout branch: #{branch}".colorize(:light_cyan)
+        puts " #{I18n.t('checkout.checkout_branch', branch: branch)}".colorize(:light_cyan)
         git.checkout branch
       end
     end
 
     def status(path = Dir.pwd)
+      puts path
       recursive_cmd(path) do |git|
         unless git.status.untracked.empty?
-          puts " Untracked changes (#{git.current_branch}):".colorize(:light_red)
+          puts " #{I18n.t('status.untracked_changes', branch: git.current_branch)}:".colorize(:light_red)
           git.status.untracked.keys.each { |filename| puts "   - #{filename}" }
         end
         unless git.status.changed.empty?
-          puts " Uncommitted changes (#{git.current_branch}):".colorize(:light_magenta)
+          puts " #{I18n.t('status.uncommitted_changes', branch: git.current_branch)}:".colorize(:light_magenta)
           git.status.changed.keys.each { |filename| puts "   - #{filename}" }
         end
         if git.status.untracked.empty? && git.status.changed.empty?
-          puts " On branch: #{git.current_branch}".colorize(:green)
+          puts " #{I18n.t('status.on_branch', branch: git.current_branch)}".colorize(:green)
         end
       end
     end
 
     def print_roots
       if @config.roots.empty?
-        puts "No roots have been configured. Run 'rgit --add-root' to add the current directory as a root"
+        puts I18n.t('show_roots.no_routes_configured')
       else
-        puts 'Roots:'
+        puts "#{I18n.t('roots')}:"
         @config.roots.each do |root|
           puts "  - #{root}"
         end
@@ -87,11 +89,11 @@ module Rgit
       parent_path = @config.find_root(path)
       repositories(parent_path).each do |git|
         repo_name = git.dir.path.gsub("#{path}/", '')
-        puts "#{'Repository:'.colorize(:light_blue)} #{repo_name}"
+        puts "#{(I18n.t('repository') + ':').colorize(:light_blue)} #{repo_name}"
         begin
           yield git
         rescue Git::GitExecuteError => e
-          puts '   Failed:'.colorize(:red)
+          puts "   #{I18n.t('failed')}:".colorize(:red)
           puts e.message.split("\n").map { |l| "    #{l}" }.join("\n").colorize(:red)
         end
       end

data/lib/rgit/version.rb

@@ -1,3 +1,3 @@
 module Rgit
-  VERSION = '1.1'.freeze
+  VERSION = '1.2'.freeze
 end

data/locales/en.yml

@@ -0,0 +1,115 @@
+en:
+  add_root:
+    adding_root: 'Adding root: %{path}'
+    banner: |
+      USAGE:
+        rgit add-root [PATH]
+
+      DESCRIPTION:
+        Add a root directory (PATH defaults to working directory if not specified).
+
+        A 'root' is a parent directory containing many git repositories. By adding a
+        directory as a root directory rgit can execute commands on all repositories
+        within that root. Regarless of whether you are in a specfic repository or the
+        parent folder.
+
+      OPTIONS:
+  branch:
+    expect_name: 'ERROR: checkout subcommand expects a branch name'
+  checkout:
+    banner: |
+      USAGE:
+        rgit checkout BRANCH
+
+      DESCRIPTION:
+        Checkout the specified branch across all git repositories.
+
+      OPTIONS:
+    checkout_branch: 'Checking branch: %{branch}'
+  failed: 'Failed'
+  fetch:
+    banner: |
+      USAGE:
+        rgit fetch
+
+      DESCRIPTION:
+        Fetch all repositories within the root (based on working directory).
+
+      OPTIONS
+    fetching_remote: 'Fetching remote: %{name}'
+  pull:
+    banner: |
+      USAGE:
+        rgit pull
+
+      DESCRIPTION:
+        Pull all repositories within the root (based on working directory).
+
+      OPTIONS
+    pulling_remote: 'Pulling remote: %{name}'
+  remove_root:
+    banner: |
+      USAGE:
+        rgit remove-root [PATH]
+
+      DESCRIPTION:
+        Remove a root directory (PATH defaults to working directory if not specified).
+
+      OPTIONS
+    removing_root: 'Removing root: %{path}'
+  rgit:
+    banner: |
+      rgit is a utility for managing multiple git repositories.
+
+      USAGE:
+        rgit [global options] COMMAND [command options]
+
+      GLOBAL OPTIONS:
+        -v                         Run verbosely
+
+      COMMANDS:
+        add-root [PATH]            Add a root directory (defaults to working directory).
+        remove-root [PATH]         Remove a root directory (defaults to working directory).
+        show-roots                 Show roots.
+        pull                       Git pull.
+        fetch                      Git fetch.
+        checkout BRANCH            Git checkout
+        status                     Git status
+        -h, --help                 Show this message
+        version                    Show version
+
+      ADDITIONAL HELP:
+        rgit COMMAND -h
+
+      OPTIONS:
+    run_verbosely: 'Run verbosely'
+    unknown_subcommand: 'ERROR: unknown subcommand %{command}'
+  repository: 'Repository'
+  roots: 'Roots'
+  show_roots:
+    banner: |
+      USAGE:
+        rgit show-roots
+
+      DESCRIPTION:
+        Lists the root directories that have been configured.
+
+        A 'root' is a parent directory containing many git repositories. From within
+        a root directory or sub directory of a root it is possible to execute an rgit
+        command across all repositories within that root.
+
+      OPTIONS
+    no_routes_configured: "No roots have been configured. Run 'rgit --add-root' to add the current directory as a root"
+  status:
+    banner: |
+      USAGE:
+        rgit status
+
+      DESCRIPTION:
+        Show a status summary of all repositories within the root (based on working
+        directory).
+
+      OPTIONS
+    untracked_changes: 'Untracked changes: %{branch}'
+    uncommitted_changes: 'Uncommitted changes: %{branch}'
+    on_branch: 'On branch: %{branch}'

data/r-git.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'trollop', '~> 2.1.2'
   spec.add_dependency 'git', '~> 1.2.9'
   spec.add_dependency 'colorize', '~> 0.7.7'
+  spec.add_dependency 'i18n', '~> 0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r-git
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - James Ridgway
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: |-
   Executable gem for managing multiple git repositories in a top level directory. r-git allow
                           you to easily fetch, pull, change branch, etc. across multiple git repositories with a single
@@ -164,6 +178,7 @@ files:
 - lib/rgit/configuration.rb
 - lib/rgit/rgit.rb
 - lib/rgit/version.rb
+- locales/en.yml
 - r-git.gemspec
 homepage: https://github.com/jamesridgway/r-git
 licenses: