gerrit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e622e3bacf3ff603e41ef0aaad895a33c5c0c531
-  data.tar.gz: 463bc6a58c060e6ad3d8825fc108e9b0fcd3f1f6
+  metadata.gz: 87240c9921a5ea4b76b05a57b7e6a0f68c003c88
+  data.tar.gz: cd7197693ac6dcc24945697c450e7b8f0712c3ee
 SHA512:
-  metadata.gz: 25f0ee6364cd63cdc9d3a2519a6bccff966f03735b5bffba41400be186b23316a7df56b1f0bbf108322be73fc6fa41c4d488214ffe1825477dc95677e8b7ff8a
-  data.tar.gz: 6e95f4c7472f6ab0c5f422c44316cec1296665ca3f0a0fd6a9cd1b309237d50e20f809266e0710741bba71cede221dca108742e80995599eec8acf0871097c81
+  metadata.gz: 5467e171e12670ab484430cb9b0ed93f0a70bc42d42fb2fabe96c31bb0d1f087d3b01fcbc47115fd8d5cd7226472448fe76c1991f4145c5a557b78479a01f7ee
+  data.tar.gz: 04f16de2f0662152a187694d0ac06ed32f82f89b01c4465a74653e9633cada93b760d4c5fcade14d42c6dadb73ad556a220cfa54bd1028f869f0defa27914404

data/lib/gerrit/client.rb

@@ -43,11 +43,17 @@ module Gerrit
     #
     # @param group [String] full name of the group
     # @param recursive [Boolean] whether to include members of sub-groups.
-    # @return [Array<String>]
-    def members(group, recursive: true)
+    # @return [Array<Hash>]
+    def group_members(group, recursive: true)
       flags = []
       flags << '--recursive' if recursive
-      execute(%w[ls-members] + ["'#{group}'"] + flags)
+
+      rows = execute(%w[ls-members] + ["'#{group}'"] + flags).split("\n")[1..-1]
+
+      rows.map do |row|
+        id, username, full_name, email = row.split("\t")
+        { id: id, username: username, full_name: full_name, email: email }
+      end
     end
 
     # Returns basic information about a change.
@@ -63,5 +69,21 @@ module Gerrit
         JSON.parse(rows.first)
       end
     end
+
+    # Returns a list of all users to include in the default search scope.
+    #
+    # Gerrit doesn't actually have an endpoint to return all visible users, so
+    # we do the next best thing which is to get users for all groups the user is
+    # a part of, which for all practical purposes is probably good enough.
+    #
+    # Set the `user_search_groups` configuration option to speed this up,
+    # ideally to just one group so we don't have to make parallel calls.
+    def users
+      search_groups = Array(@config.fetch(:user_search_groups, groups))
+
+      Utils.map_in_parallel(search_groups) do |group|
+        group_members(group).map{ |user| user[:username] }
+      end.flatten.uniq
+    end
   end
 end

data/lib/gerrit/command/base.rb

@@ -5,6 +5,8 @@ module Gerrit::Command
   #
   # @abstract
   class Base
+    include Gerrit::Utils
+
     # @param config [Gerrit::Configuration]
     # @param ui [Gerrit::UI]
     # @param arguments [Array<String>]
@@ -56,7 +58,7 @@ module Gerrit::Command
     # @param args [Array<String>]
     # @return [#status, #stdout, #stderr]
     def spawn(args)
-      Subprocess.spawn(args)
+      Gerrit::Subprocess.spawn(args)
     end
   end
 end

data/lib/gerrit/command/checkout.rb

@@ -2,10 +2,17 @@ module Gerrit::Command
   # Check out a patchset locally.
   class Checkout < Base
     def execute
-      result = spawn(%W[git fetch #{repo.remote_url} #{change_refspec}])
-      if result.success?
-        spawn(%w[git checkout FETCH_HEAD])
+      refspec = change_refspec
+
+      ui.spinner('Fetching patchset...') do
+        result = spawn(%W[git fetch #{repo.remote_url} #{refspec}])
+        if result.success?
+          spawn(%w[git checkout FETCH_HEAD])
+        end
       end
+
+      ui.newline
+      ui.success "You have checked out #{refspec}"
     end
 
     private
@@ -31,7 +38,9 @@ module Gerrit::Command
           ui.ask('Enter change number or Change-ID').argument(:required).read_string
         end
 
-      client.change(change_num_or_id)
+      ui.spinner('Finding latest patchset...') do
+        client.change(change_num_or_id)
+      end
     end
   end
 end

data/lib/gerrit/command/members.rb

@@ -4,7 +4,13 @@ module Gerrit::Command
   # This allows you to list the members of a group by regex.
   class Members < Base
     def execute
-      ui.print client.members(find_group), newline: false
+      users = client.group_members(find_group)
+
+      ui.table(header: %w[ID Username Name Email]) do |t|
+        users.each do |user|
+          t << [user[:id], user[:username], user[:full_name], user[:email]]
+        end
+      end
     end
 
     private

data/lib/gerrit/command/push.rb

@@ -0,0 +1,133 @@
+module Gerrit::Command
+  # Push one or more commits for review.
+  class Push < Base
+    def execute
+      # Sanity check: does this repository have a valid remote_url?
+      # (this will raise an exception if that's not the case)
+      remote_url = repo.remote_url
+
+      # If an explicit ref is given, skip a bunch of the questions
+      if commit_hash?(arguments[1]) || arguments[1] == 'HEAD'
+        ref = arguments[1]
+        reviewer_args = arguments[2..-1] || []
+        target_branch = 'master'
+        type = 'publish'
+        topic = nil
+      else
+        ref = 'HEAD'
+        reviewer_args = arguments[1..-1] || []
+        target_branch = ask_target_branch
+        type = ask_review_type
+        topic = ask_topic
+      end
+
+      reviewers = extract_reviewers(reviewer_args)
+
+      push_changes(remote_url, ref, reviewers, target_branch, type, topic)
+    end
+
+    private
+
+    def push_changes(remote_url, ref, reviewers, target_branch, type, topic)
+      command = %W[git push #{remote_url}]
+
+      if reviewers.any?
+        reviewer_flags = reviewers.map { |reviewer| "--reviewer=#{reviewer}" }
+        command += ['--receive-pack', "git receive-pack #{reviewer_flags.join(' ')}"]
+      end
+
+      destination_ref = "refs/#{type}/#{target_branch}"
+      destination_ref += "/#{topic}" if topic
+      command += ["#{ref}:#{destination_ref}"]
+
+      result =
+        ui.spinner('Pushing changes...') do
+          spawn(command)
+        end
+
+      if result.success?
+        ui.success result.stdout
+        ui.success result.stderr
+      else
+        ui.error result.stdout
+        ui.error result.stderr
+      end
+    end
+
+    def extract_reviewers(reviewer_args)
+      if reviewer_args.empty?
+        reviewer_args = ui.ask('Enter users/groups you would like to review your changes')
+                          .argument(:required)
+                          .read_string
+                          .split(/\s*,\s*/)
+      end
+
+      return [] if reviewer_args.empty?
+
+      ui.spinner('Finding matching users/groups...') do
+        extract_users(reviewer_args)
+      end
+    end
+
+    def extract_users(reviewer_args)
+      usernames = []
+      groups = client.groups
+      users = client.users
+
+      reviewer_args.each do |arg|
+        users_or_groups = arg.split(/\s*,\s*|\s+/)
+
+        users_or_groups.each do |user_or_group|
+          usernames += users_from_pattern(users, groups, user_or_group)
+        end
+      end
+
+      usernames.uniq.sort
+    end
+
+    def users_from_pattern(users, groups, pattern)
+      group_users = users_from_group(groups, pattern)
+
+      # Don't scan users since we already matched a group
+      return group_users if group_users.any?
+
+      users.grep(/#{pattern}/i)
+    end
+
+    def users_from_group(groups, group)
+      matching_groups = groups.grep(/#{group}/i)
+
+      map_in_parallel(matching_groups) do |match|
+        client.group_members(match).map { |user| user[:username] }
+      end.flatten.uniq
+    end
+
+    def ask_target_branch
+      target = ui.ask('Target branch (default master)')
+                 .modify(:trim)
+                 .read_string
+
+      target.empty? ? 'master' : target
+    end
+
+    def ask_review_type
+      draft = ui.ask('Are you pushing this as a draft? (y/n) [n]')
+                .argument(:required)
+                .default('n')
+                .modify(:downcase)
+                .read_string
+
+      draft == 'y' ? 'draft' : 'publish'
+    end
+
+    def ask_topic
+      topic = ui.ask('Topic name (optional; enter * to autofill with your current branch:')
+                .argument(:optional)
+                .read_string
+
+      topic = repo.branch('HEAD') if topic == '*'
+      topic.strip.empty? ? nil : topic
+    end
+
+  end
+end

data/lib/gerrit/command/setup.rb

@@ -0,0 +1,69 @@
+module Gerrit::Command
+  # Sets up the remotes for this repository to push/pull to/from Gerrit.
+  class Setup < Base
+    def execute
+      remotes_to_add = config[:remotes]
+      existing_remotes = repo.remotes.keys & remotes_to_add.keys
+
+      if existing_remotes.any?
+        return unless can_replace?(existing_remotes)
+      end
+
+      add_remotes(remotes_to_add)
+    end
+
+    private
+
+    def can_replace?(existing_remotes)
+      ui.warning 'The following remotes already exist and will be replaced:'
+      existing_remotes.each do |remote|
+        ui.info remote
+      end
+
+      ui.newline
+      ui.ask('Replace them? (y/n)[n]')
+        .argument(:required)
+        .default('n')
+        .modify(:downcase)
+        .read_string == 'y'
+    end
+
+    def add_remotes(remotes)
+      remotes.each do |remote_name, remote_config|
+        remote_url = render_remote_url(remote_config)
+
+        `git remote rm #{remote_name} &> /dev/null`
+        `git remote add #{remote_name} #{remote_url}`
+
+        if remote_config['push']
+          `git config remote.#{remote_name}.push #{remote_config['push']}`
+        end
+
+        ui.success "Added #{remote_name} #{remote_url}"
+      end
+
+      ui.newline
+      ui.info 'You can now push commits for review by running: ', newline: false
+      ui.print 'gerrit push'
+    end
+
+    def render_remote_url(remote_config)
+      remote_config['url'] % {
+        user: config[:user],
+        host: config[:host],
+        port: config[:port],
+        project: project_name,
+      }
+    end
+
+    # Allow a project name to be explicitly specified, otherwise just use the
+    # repo root directory name.
+    def project_name
+      if arguments[2]
+        arguments[2]
+      else
+        File.basename(repo.root)
+      end
+    end
+  end
+end

data/lib/gerrit/configuration.rb

@@ -23,7 +23,9 @@ module Gerrit
           from_file(config_file)
         else
           raise Errors::ConfigurationMissingError,
-                'No configuration file was found'
+                "No configuration file '#{FILE_NAME}' was found in the " \
+                "current directory or any ancestor directory.\n\n" \
+                "See #{REPO_URL}#configuration for instructions on setting up."
         end
       end
 
@@ -68,11 +70,19 @@ module Gerrit
     # Access the configuration as if it were a hash.
     #
     # @param key [String, Symbol]
-    # @return [Array,Hash,Number,String]
+    # @return [Array, Hash, Number, String]
     def [](key)
       @options[key.to_s]
     end
 
+    # Access the configuration as if it were a hash.
+    #
+    # @param key [String, Symbol]
+    # @return [Array, Hash, Number, String]
+    def fetch(key, *args)
+      @options.fetch(key.to_s, *args)
+    end
+
     # Compares this configuration with another.
     #
     # @param other [HamlLint::Configuration]

data/lib/gerrit/error_handler.rb

@@ -16,6 +16,7 @@ module Gerrit
     def handle(ex)
       case ex
       when Errors::UsageError
+        ui.error ex.message
         CLI::ExitCodes::USAGE
       when Errors::ConfigurationError
         ui.error ex.message

data/lib/gerrit/errors.rb

@@ -12,6 +12,9 @@ module Gerrit::Errors
   # Base class for all configuration-related errors.
   class ConfigurationError < GerritError; end
 
+  # Raised when something is incorrect with the configuration.
+  class ConfigurationInvalidError < ConfigurationError; end
+
   # Raised when a configuration file is not present.
   class ConfigurationMissingError < ConfigurationError; end
 

data/lib/gerrit/repo.rb

@@ -8,6 +8,18 @@ module Gerrit
       @config = config
     end
 
+    # Returns the name of the currently checked-out branch or the branch the
+    # specified ref is on.
+    #
+    # Returns nil if it is detached.
+    #
+    # @return [String, nil]
+    def branch(ref = 'HEAD')
+      name = `git branch`.split("\n").grep(/^\* /).first[/\w+/]
+      # Check if detached head
+      name.start_with?('(') ? nil : name
+    end
+
     # Returns the absolute path to the root of the current repository the
     # current working directory resides within.
     #
@@ -60,12 +72,42 @@ module Gerrit
     #
     # @return [String]
     def project
-      @config[:project] || File.basename(root)
+      if url = remote_url
+        File.basename(url[/\/[^\/]+$/], '.git')
+      else
+        # Otherwise just use the name of this repository
+        File.basename(root)
+      end
+      #
+    end
+
+    # Returns all remotes this repository has configured.
+    #
+    # @return [Hash] hash of remote names mapping to their URLs
+    def remotes
+      Hash[
+        `git config --get-regexp '^remote\..+\.url$'`.split("\n").map do |line|
+          match = line.match(/^remote\.(?<name>\S+)\.url\s+(?<url>.*)/)
+          [match[:name], match[:url]]
+        end
+      ]
     end
 
     # Returns the Gerrit remote URL for this repo.
     def remote_url
-      "ssh://#{@config[:user]}@#{@config[:host]}:#{@config[:port]}/#{project}"
+      unless push_remote = @config[:push_remote]
+        raise Errors::ConfigurationInvalidError,
+              'You must specify the `push_remote` option in your configuration.'
+      end
+
+      unless url = remotes[push_remote]
+        raise Errors::ConfigurationInvalidError,
+              "The '#{push_remote}' `push_remote` specified in your " \
+              'configuration is not a remote in this repository. ' \
+              'Have you run `gerrit setup`?'
+      end
+
+      url
     end
   end
 end

data/lib/gerrit/ui.rb

@@ -90,12 +90,28 @@ module Gerrit
       print('')
     end
 
+    # Execute a command with a spinner animation until it completes.
+    def spinner(*args, &block)
+      spinner = TTY::Spinner.new(*args)
+      spinner_thread = Thread.new do
+        loop do
+          sleep 0.1
+          spinner.spin
+        end
+      end
+
+      block.call
+    ensure
+      spinner_thread.kill
+      newline # Ensure next line of ouptut on separate line from spinner
+    end
+
     # Prints a table.
     #
     # Customize the table by passing a block and operating on the table object
     # passed to that block to add rows and customize its appearance.
-    def table(&block)
-      t = TTY::Table.new
+    def table(options = {}, &block)
+      t = TTY::Table.new(options)
       block.call(t)
       print(t.render(:unicode))
     end

data/lib/gerrit/utils.rb

@@ -1,3 +1,5 @@
+require 'parallel'
+
 module Gerrit
   # A miscellaneous set of utility functions.
   module Utils
@@ -13,6 +15,24 @@ module Gerrit
             .join
     end
 
+    # Returns whether a string appears to be a commit SHA1 hash.
+    #
+    # @param string [String]
+    # @return [Boolean]
+    def commit_hash?(string)
+      string =~ /^\h{7,40}$/
+    end
+
+    # Executing a block on each item in parallel.
+    #
+    # @param items [Enumerable]
+    # @return [Array]
+    def map_in_parallel(items, &block)
+      Parallel.map(items, in_threads: Parallel.processor_count) do |item|
+        block.call(item)
+      end
+    end
+
     # Convert string containing camel case or spaces into snake case.
     #
     # @see stackoverflow.com/questions/1509915/converting-camel-case-to-underscore-case-in-ruby

data/lib/gerrit/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module Gerrit
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gerrit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.6
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: tty
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +70,8 @@ files:
 - lib/gerrit/command/help.rb
 - lib/gerrit/command/members.rb
 - lib/gerrit/command/projects.rb
+- lib/gerrit/command/push.rb
+- lib/gerrit/command/setup.rb
 - lib/gerrit/command/version.rb
 - lib/gerrit/configuration.rb
 - lib/gerrit/constants.rb