repo_manager 0.7.1

data/lib/repo_manager/actions/git_action.rb

@@ -0,0 +1,113 @@
+require 'optparse'
+require 'repo_manager/actions/action_helper'
+
+module RepoManager
+
+  # @group CLI actions
+  #
+  # Native 'git' command pass-through
+  #
+  # @example Usage: repo [options] git args [options]
+  #
+  #   repo ls-files
+  #   repo git ls-files
+  #
+  #   repo add .
+  #   repo add . --filter=test
+  #   repo git add . --filter=test
+  #
+  # @return [Numeric] pass through of 'git' result code
+  class GitAction < AppAction
+    include RepoManager::ActionHelper
+
+    # allow pass through of unknown options
+    def parse_options(parser_configuration = {:raise_on_invalid_option => false})
+      super parser_configuration
+    end
+
+    def asset_options
+      result = super
+
+      # to allow pass through options, argument based filters must be ignored,
+      # delete the arg based filters and recreate from the --filter option
+      result.delete(:filter)
+      result = result.merge(:filter => options[:filter]) if options[:filter]
+
+      result
+    end
+
+    def process
+      logger.debug "process() args: #{args.inspect}"
+      logger.debug "process() asset_options: #{asset_options.inspect}"
+
+      # the first arg is optionally 'git'
+      unless args.empty?
+        args.shift if args[0] == 'git'
+      else
+        raise "no git command given" if args.empty?
+      end
+
+      command = args.shift
+      st = 0
+      result = 0
+      output = ""
+
+      unless configuration.commands.include?(command)
+        raise "git command '#{command}' is not enabled, see #{configuration[:configuration_filename]}"
+      end
+
+      # args should not match a repo name
+      if ((!args.empty?) && (!options[:filter]))
+        repos.each do |repo|
+          raise "repo name '#{repo.name}' cannot be used as a filter for git native commands, use --r, --repos, or --filter switches instead" if args.include?(repo.name)
+        end
+      end
+
+      repos.each do |repo|
+        begin
+          st = repo.status.bitfield
+        rescue InvalidRepositoryError => e
+          st = 0 #Status::INVALID
+        rescue NoSuchPathError => e
+          st = Status::NOPATH
+        end
+
+        case st
+          when (Status::NOPATH)
+            output += repo.name.red
+            output += ": #{relative_path(repo.path)}"
+            output += " [no such path]\n"
+          else
+            git_output = ''
+            begin
+              git = Git::Lib.new(:working_directory => repo.path, :repository => File.join(repo.path, '.git'))
+              git_output = git.native(command, args)
+              result |= $?.exitstatus unless ($?.exitstatus == 0)
+            rescue Git::CommandFailed => e
+              result |= e.exitstatus
+              git_output = e.error
+            end
+            if git_output != ''
+              output += repo.name.green + "\n"
+              output += git_output + "\n"
+            end
+        end
+        write_to_output(output)
+        output = ""
+      end
+
+      # numeric return
+      result
+    end
+
+    def help
+      super(:comment_starting_with => "Native 'git' command", :located_in_file => __FILE__) +
+        "\n" +
+        "\n" +
+        "Git commands are whitelisted.  The following git commands enabled in #{configuration[:configuration_filename]}:\n" +
+        "\n" +
+        configuration.commands.join(',')
+    end
+
+  end
+end

data/lib/repo_manager/actions/help_action.rb

@@ -0,0 +1,52 @@
+####################################################
+# The file is was originally cloned from "Basic App"
+# More information on "Basic App" can be found in the
+# "Basic App" repository.
+#
+# See http://github.com/robertwahler
+####################################################
+require 'optparse'
+
+module RepoManager
+
+  # @group CLI actions
+  #
+  # CLI help
+  #
+  # Provide help for an action
+  #
+  # @example Usage: repo help [action]
+  class HelpAction < AppAction
+
+    def process
+      action = args.shift
+
+      unless action
+        puts "no action specified"
+        puts "Usage: repo help action | repo --help"
+        puts ""
+        puts "Where 'action' is one of: #{AVAILABLE_ACTIONS.join(' ')}"
+
+        exit(0)
+      end
+
+      action = action.downcase
+      unless AVAILABLE_ACTIONS.include?(action)
+        puts "invalid help action: #{action}"
+        exit(0)
+      end
+
+      klass = Object.const_get('RepoManager').const_get("#{action.capitalize}Action")
+      app_action = klass.new(['--help'], configuration)
+      app_action.option_parser = self.option_parser
+      result = app_action.execute
+
+      exit(0)
+    end
+
+    def help
+      super :comment_starting_with => "CLI help", :located_in_file => __FILE__
+    end
+
+  end
+end

data/lib/repo_manager/actions/list_action.rb

@@ -0,0 +1,123 @@
+require 'optparse'
+require 'repo_manager/actions/action_helper'
+
+module RepoManager
+
+  # @group CLI actions
+  #
+  # List assets to the screen or file with or without templates
+  # using regular expression (regex) filtering.
+  #
+  # @example Usage: repo list
+  #
+  #     repo list
+  #     repo list --list=NAME
+  #     repo list --type=asset_type
+  #     repo list --template ~/templates/myTemplate.slim
+  #
+  # @example Asset regex filtering:
+  #
+  #     repo list --filter=ass.t1,as.et2
+  #
+  # @example Equivalent asset filtering:
+  #
+  #     repo list --filter=asset1,asset2
+  #     repo list --asset=asset1,asset2
+  #     repo list asset1 asset2
+  #
+  # @example Equivalent usage, file writing:
+  #
+  #    repo list --template=default.slim --output=tmp/aruba/index.html
+  #    repo list --template=default.slim >> tmp/aruba/index.html
+  #
+  # @example return just the first matching asset
+  #
+  #     repo list --match=FIRST
+  #
+  # @example Fail out if more than one matching asset
+  #
+  #     repo list --match=ONE
+  #
+  # @example Disable regex filter matching
+  #
+  #     repo list --match=EXACT
+  #
+  # @example Future usage (not implemented):
+  #
+  #     repo list --tags=adventure,favorites --group_by=tags --sort=ACQUIRED
+  #
+  # @example Create a Bash 'alias' named 'rcd' to chdir to the folder of the repo
+  #
+  #     function rcd(){ cd "$(repo --match=ONE --no-color path $@)"; }
+  #
+  #     rcd my_repo_name
+  #
+  # @example Repo versions of Bash's pushd and popd
+  #
+  #     function rpushd(){ pushd "$(repo path --match=ONE --no-color $@)"; }
+  #     alias rpopd="popd"
+  #
+  #     rcd my_repo_name
+  #
+  # @return [Number] 0 if successful
+  class ListAction < AppAction
+    include RepoManager::ActionHelper
+
+    # Add action specific options
+    def parse_options
+      super do |opts|
+
+        opts.on("--list MODE", "Listing mode.  ALL, NAME, SHORT, PATH") do |u|
+          options[:list] = u
+          options[:list].upcase!
+          unless ["ALL", "NAME", "SHORT", "PATH"].include?(options[:list])
+            raise "invalid list mode '#{options[:list]}' for '--list' option"
+          end
+        end
+
+        opts.on("--short", "List summary status only, alias for '--list=SHORT'") do |s|
+          options[:list] = 'SHORT'
+        end
+
+        # Most decendants of BaseAction will only handle one type of asset, the
+        # list action is unique in that you can specify the type of asset to list
+        opts.on("--type ASSET_TYPE", "Asset type to list:  app_asset (default)") do |t|
+          options[:type] = t
+          unless ["app_asset"].include?(options[:type])
+            raise "unknown asset type '#{options[:type]}' for '--type' option"
+          end
+        end
+
+      end
+    end
+
+    def render(view_options=configuration)
+      # templates override all other modes, if no mode specified, allow super to handle
+      list_mode = options[:template] || options[:list]
+      result = ""
+      case list_mode
+        when 'NAME'
+          items.each do |item|
+            result += "#{item.name.green}\n"
+          end
+        when 'SHORT'
+          items.each do |item|
+            result += item.name.green
+            result += ": #{relative_path(item.path)}\n"
+          end
+        when 'PATH'
+          items.each do |item|
+            result += "#{item.path}\n"
+          end
+        else
+          result = super(view_options)
+      end
+      result
+    end
+
+    def help
+      super :comment_starting_with => "List assets", :located_in_file => __FILE__
+    end
+
+  end
+end

data/lib/repo_manager/actions/path_action.rb

@@ -0,0 +1,22 @@
+module RepoManager
+
+  # @group CLI actions
+  #
+  # Show repository path contained in the configuration file to STDOUT.
+  #
+  # @example Usage: repo path
+  #
+  # Alias for 'repo list --list=path'
+  #
+  # @see #list
+  class PathAction < AppAction
+
+    def execute
+      RepoManager::ListAction.new(args.push('--list=path'), configuration).execute
+    end
+
+    def help
+      super :comment_starting_with => "Show repository path", :located_in_file => __FILE__
+    end
+  end
+end

data/lib/repo_manager/actions/status_action.rb

@@ -0,0 +1,192 @@
+require 'optparse'
+require 'repo_manager/actions/action_helper'
+
+module RepoManager
+
+  # @group CLI actions
+  #
+  # Show simplified summary status of repos. The exit code is a bitfield
+  # that collects simplified status codes. The RepoManager status simplifies
+  # Git's porcelain output by combining Git status X and Y and boiling
+  # down status returns to just five types,
+  #
+  #   M ? A D U
+  #
+  # From git 1.7+ documentation
+  #
+  #   X          Y     Meaning
+  #   -------------------------------------------------
+  #             [MD]   not updated
+  #   M        [ MD]   updated in index
+  #   A        [ MD]   added to index
+  #   D        [ MD]   deleted from index
+  #   R        [ MD]   renamed in index
+  #   C        [ MD]   copied in index
+  #   [MARC]           index and work tree matches
+  #   [ MARC]     M    work tree changed since index
+  #   [ MARC]     D    deleted in work tree
+  #   -------------------------------------------------
+  #   D           D    unmerged, both deleted
+  #   A           U    unmerged, added by us
+  #   U           D    unmerged, deleted by them
+  #   U           A    unmerged, added by them
+  #   D           U    unmerged, deleted by us
+  #   A           A    unmerged, both added
+  #   U           U    unmerged, both modified
+  #   -------------------------------------------------
+  #   ?           ?    untracked
+  #   -------------------------------------------------
+  #
+  # @example Usage: repo status
+  #
+  #   repo status
+  #   repo status --short
+  #   repo status repo1 --unmodified DOTS
+  #   repo status repo1 repo2 --unmodified DOTS
+  #
+  # @example Equivalent filtering
+  #
+  #   repo status --filter=test2 --unmodified DOTS
+  #   repo status test2 --unmodified DOTS
+  #
+  # @example Alternatively, run the native git status command
+  #
+  #   repo git status
+  #
+  # @return [Number] bitfield with combined repo status
+  #
+  # @see Status bitfield return values
+  class StatusAction < AppAction
+    include RepoManager::ActionHelper
+
+    # Add action specific options
+    def parse_options
+      super do |opts|
+
+        opts.on("-u", "--unmodified [MODE]", "Show unmodified repos.  MODE=SHOW (default), DOTS, or HIDE") do |u|
+          options[:unmodified] = u || "SHOW"
+          options[:unmodified].upcase!
+        end
+
+        opts.on("--short", "Summary status only, do not show individual file status") do |s|
+          options[:short] = s
+        end
+
+      end
+    end
+
+    def process
+      st = 0
+      result = 0
+      count_unmodified = 0
+      need_lf = false
+      output = ""
+      unmodified_mode = options[:unmodified] || 'HIDE'
+
+      repos.each do |repo|
+        # M ? A D I X
+        begin
+          st = repo.status.bitfield
+        rescue InvalidRepositoryError => e
+          st = Status::INVALID # I
+        rescue NoSuchPathError => e
+          st = Status::NOPATH # X
+        end
+
+        result |= st unless (st == 0)
+
+        case st
+
+          when Status::CLEAN
+            count_unmodified += 1
+            case unmodified_mode
+              when "HIDE"
+                # do nothing
+              when "SHOW"
+                output += "\t#{repo.name}\n"
+              when "DOTS"
+                output += ".".green
+                need_lf = true
+              else
+                raise "invalid mode '#{unmodified_mode}' for '--unmodified' option"
+            end
+
+          when Status::NOPATH
+            output += "\n" if need_lf
+            output += "X\t#{repo.name}: #{relative_path(repo.path)}"
+            output += " [no such path]".red + "\n"
+            need_lf = false
+
+          when Status::INVALID
+            output += "\n" if need_lf
+            output += "I\t#{repo.name}: #{relative_path(repo.path)}"
+            output += " [not a valid repo]".red + "\n"
+            need_lf = false
+
+          else
+            output += "\n" if need_lf
+
+            # print M?ADU status letters
+            output += (st & Status::CHANGED == Status::CHANGED) ? "M".red : " "
+            output += (st & Status::UNTRACKED == Status::UNTRACKED) ? "?".blue.bold : " "
+            output += (st & Status::ADDED == Status::ADDED) ? "A".green : " "
+            output += (st & Status::DELETED == Status::DELETED) ? "D".yellow : " "
+            output += (st & Status::UNMERGED == Status::UNMERGED) ? "U".red.bold : " "
+
+            output += "\t#{repo.name}\n"
+            need_lf = false
+
+            unless options[:short]
+              # modified (M.red)
+              repo.status.changed.sort.each do |k, f|
+                output += "\t  modified: #{f.path}".red + "\n"
+              end
+
+              # untracked (?.blue.bold)
+              repo.status.untracked.sort.each do |k, f|
+                output += "\t  untracked: #{f.path}".blue.bold + "\n"
+              end
+
+              # added (A.green)
+              repo.status.added.sort.each do |k, f|
+                output += "\t  added: #{f.path}".green + "\n"
+              end
+
+              # deleted (D.yellow)
+              repo.status.deleted.sort.each do |k, f|
+                output += "\t  deleted: #{f.path}".yellow + "\n"
+              end
+
+              # unmerged (U.red.bold)
+              repo.status.unmerged.sort.each do |k, f|
+                output += "\t  unmerged: #{f.path}".red.bold + "\n"
+              end
+            end
+        end
+        write_to_output(output)
+        output = ""
+      end
+
+      output = "\n" if need_lf
+
+
+      if (repos.size == 0)
+        # missing configuration or filter didn't match
+        output += "no repositories found\n"
+      elsif (count_unmodified == repos.size)
+        # summary
+        output += "no modified repositories, all working folders are clean\n"
+      end
+
+      write_to_output(output)
+
+      # numeric return
+      result
+    end
+
+    def help
+      super :comment_starting_with => "Show simplified summary status", :located_in_file => __FILE__
+    end
+
+  end
+end