hull 0.1.0 → 0.1.1

data/lib/hull.rb

@@ -6,6 +6,8 @@ require 'grit'
 require 'hull/command'
 require 'hull/hull'
 require 'hull/list'
+require 'hull/help'
+require 'hull/show'
 
 module Hull
 end

data/lib/hull/command.rb

@@ -12,7 +12,7 @@ module Hull
       :white  => "37",
     }
 
-    def write(text, color)
+    def self.write(text, color)
       if BASH_COLORS.keys.include?(color)
         "\033[#{BASH_COLORS[color]}m#{text}\033[#{BASH_COLORS[:reset]}m"
       else
@@ -20,19 +20,19 @@ module Hull
       end
     end
 
-    def error(text); puts "#{write('error', :red)     }: #{text}"; end
-    def warn(text);  puts "#{write('warning', :purple)}: #{text}"; end
-    def note(text);  puts "#{write('note', :green)    }: #{text}"; end
+    def self.error(text); puts "#{write('error', :red)     }: #{text}"; end
+    def self.warn(text);  puts "#{write('warning', :purple)}: #{text}"; end
+    def self.note(text);  puts "#{write('note', :green)    }: #{text}"; end
 
-    def column_size
+    def self.column_size
       [ `stty size`.scan(/\d+/).last.to_i, 80 ].max
     end
 
-    def pad_left(str, length)
+    def self.pad_left(str, length)
       "% #{length}s" % str[0, length]
     end
 
-    def pad_right(str, length)
+    def self.pad_right(str, length)
       if str.length > length
         "#{str[0, length - 3]}..."
       elsif str.length < length
@@ -42,7 +42,7 @@ module Hull
       end
     end
 
-    def validate_config
+    def self.validate_config
       if username == '' || api_token == ''
         error('github.user and github.token not found in git config')
         Help.new
@@ -52,35 +52,35 @@ module Hull
       end
     end
 
-    def username
-      @username ||= repo.config['github.user']
+    def self.username
+      @username ||= config['github.user']
     end
 
-    def api_token
-      @api_token ||= repo.config['github.token']
+    def self.api_token
+      @api_token ||= config['github.token']
     end
 
-    def remote
-      @remote ||= (repo.config['hull.remote'] || 'origin')
+    def self.remote
+      @remote ||= (config['hull.remote'] || 'origin')
     end
 
-    def github_url
-      @github_url ||=
-        begin
-          unless valid_repository?(repo)
-            raise InvalidRepository.new("Must be a GitHub repository")
-          end
-          _, owner, project = repo.config["remote.#{remote}.url"].match(/^git@github.com:([^\/]*)\/(.*)/).to_a
-          project.gsub!(/\.git$/, '')
-          "https://github.com/api/v2/json/pulls/#{owner}/#{project}"
-        end
+    def self.github_url(number=nil)
+      raise InvalidRepository unless has_valid_repository?
+      url = config["remote.#{remote}.url"]
+      _, owner, project = url.match(/^git@github.com:([^\/]*)\/(.*)/).to_a
+      project.gsub!(/\.git$/, '')
+      "https://github.com/api/v2/json/pulls/#{owner}/#{project}/#{number}"
     end
 
-    def repo
+    def self.repo
       @repo = Grit::Repo.new(".")
     end
 
-    def get_json(url)
+    def self.config
+      repo.config
+    end
+
+    def self.get_json(url)
       options = {
         :http_basic_authentication => [
           "#{username}/token",
@@ -90,10 +90,11 @@ module Hull
       JSON.load(open(url, options))
     end
 
-    def valid_repository?(repository)
-      repository.remote_list.include?(remote) &&
-        repository.config["remote.#{remote}.url"].match(/^git@github.com:/)
+    def self.has_valid_repository?
+      repo.remote_list.include?(remote) &&
+        config["remote.#{remote}.url"].match(/^git@github.com:/)
     end
+
   end
 
   class InvalidRepository < RuntimeError; end

data/lib/hull/help.rb

@@ -0,0 +1,65 @@
+module Hull
+  class Help < Command
+    def self.title(title)
+      write(title, :cyan)
+    end
+
+    def self.hull
+      write('hull', :yellow)
+    end
+
+    def self.command(command)
+      write(command, :pink)
+    end
+
+    def self.number(number)
+      write(number, :purple)
+    end
+
+    def self.red(red)
+      write(red, :red)
+    end
+
+    def self.help
+      <<HELP
+#{title('### Setup')}
+
+Config Github user name:
+
+    $ git config github.username <github_username>
+
+Config GitHub API key (https://github.com/account/admin):
+
+    $ git config github.token <api_token>
+
+#{title('### Usage')}
+
+This help doc:
+
+    $ #{hull} #{command('help')}
+
+List all pull requests for this project:
+
+    $ #{hull} #{command('list')}
+
+Show details about pull request number <number>:
+
+    $ #{hull} #{command('show')} <#{number('number')}>
+
+#{title('### Unimplemented Features')}
+
+Check out the contents of pull request number <number> and switch to that branch:
+
+    $ #{hull} <#{command('checkout')}|#{command('co')}|#{command('pull')}> <#{number('number')}>
+
+Remove contents of pull request <number> that has been checked out:
+
+    $ #{hull} <#{command('rm')}|#{command('remove')}|#{command('delete')}> <#{number('number')}>
+
+#{title('### Why Hull?')}
+
+Originally it was called puller, but @natekross pushed a gem with the same name to rubygems.org, literally the day I started working on Hull. #{red("\x28\xe2\x95\xaf\xc2\xb0\xe2\x96\xa1\xc2\xb0\xef\xbc\x89\xe2\x95\xaf")}\xef\xb8\xb5\x20\xe2\x94\xbb\xe2\x94\x81\xe2\x94\xbb
+HELP
+    end
+  end
+end

data/lib/hull/hull.rb

@@ -9,14 +9,15 @@ module Hull
     def run
       case command
       when 'list'
-        List.new
+        puts List.run
       when 'show'
-        Show.new(number)
+        puts Show.run(number)
       when 'pull', 'checkout', 'co'
         Pull.new(number)
       when 'rm', 'remove', 'delete'
         Remove.new(number)
-      else # help
+      else
+        puts Help.help
       end
     end
 

data/lib/hull/list.rb

@@ -1,26 +1,27 @@
 module Hull
   class List < Command
-    def initialize
+    def self.run
       validate_config
       json = get_json(github_url)
       if json['error'].to_s != ''
-        return error("Pull request ##{request_number} might not exist.")
+        return error(json['error'])
       end
 
       pulls = json['pulls']
-      puts "Number of pull requests: #{pulls.length}"
       return if pulls.length == 0
 
       branch_names = pulls.map { |pull| pull['head']['label'].split(/:/) }
       @repo_len   = [ branch_names.map(&:first).map(&:length).max, 15 ].min
       @branch_len = [ branch_names.map(&:last).map(&:length).max,  30 ].min
 
+      lines = [ "Number of pull requests: #{pulls.length}" ]
       pulls.each do |pull|
-        puts pull_info(pull)
+        lines << pull_info(pull)
       end
+      lines.join("\n")
     end
 
-    def pull_info(pull)
+    def self.pull_info(pull)
       number      = pull['number'].to_s
       mergeable   = pull['mergeable']
       title       = pull['title']

data/lib/hull/show.rb

@@ -0,0 +1,72 @@
+module Hull
+  class Show < Command
+    def self.run(number)
+      validate_config
+
+      url  = github_url(number)
+      begin
+        body = get_json(url)
+      rescue OpenURI::HTTPError
+        return error("Pull request ##{number} might not exist. Try running 'hull list'.")
+      end
+
+      if body['error'].to_s != ''
+        return error(body['error'])
+      end
+
+      pull = body["pull"]
+      title = pull["title"]
+      description = pull["body"]
+      discussions = pull["discussion"]
+      comments = discussions.select do |msg|
+        msg["type"] =~ /Comment/
+      end.map do |msg|
+        message = {}
+        message[:user]    = msg["user"]["login"]
+        message[:message] = msg["body"]
+        message[:path]    = msg["path"]
+        message
+      end
+
+      if pull['merged_at']
+        merge_status = write('MERGED', :green)
+      elsif pull['mergeable']
+        merge_status = write('NOT MERGED', :yellow)
+      elsif pull["state"] == "closed"
+        merge_status = write('CLOSED', :red)
+      else
+        merge_status = write('CONFLICT', :red)
+      end
+
+      lines = []
+      lines << "Number:      #{write(number, :yellow)}"
+      lines << "Title:       #{write(title, :purple)}"
+      lines << "Description: #{pad_right(description.gsub(/[\r\n]+/, ' '), column_size - 13)}"
+      lines << "Status:      #{merge_status}"
+
+      if comments.length > 0
+        lines.push('', 'Comments:')
+        comments.each do |comment|
+          lines << write_comment(comment)
+        end
+      end
+      lines.join("\n")
+    end
+
+    def self.write_comment(comment)
+      arr = []
+      remaining_cols = column_size
+      if comment[:path]
+        path = comment[:path].split(/\//).last
+        arr.push('@', write(path, :pink), ' ')
+        remaining_cols -= path.length + 2
+      end
+      arr.push('<', write(comment[:user], :yellow), '>')
+      remaining_cols -= comment[:user].length + 4
+      remaining_cols = [ remaining_cols, 30 ].max
+      message = pad_right(comment[:message].gsub(/[\r\n]+/, ' '), remaining_cols)
+      arr.push(': ', write(message, :white))
+      arr.join('')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hull
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70150332753920 !ruby/object:Gem::Requirement
+  requirement: &70337977483900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70150332753920
+  version_requirements: *70337977483900
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70150332753480 !ruby/object:Gem::Requirement
+  requirement: &70337977483460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70150332753480
+  version_requirements: *70337977483460
 description: Code Review helper using GitHub's Pull Requests
 email: hc5duke@gmail.com
 executables: