octokom 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e09a35e0cf96d8108161d2e98d3b0bb2eef732d
-  data.tar.gz: 53ab6973726062831ce6fdea8e5abfe87eead951
+  metadata.gz: a827d2870894f3b5f4c778cbc97475081b536758
+  data.tar.gz: 925ab8ea02b3347905a44f4752f79348329b2801
 SHA512:
-  metadata.gz: 748cbaac055db47202bfb129952bf8656b96054606599ef11790ec8beeeaf34a189266608cb0c1f72d937aafb978aa84335e7377c3573bc71b969beef4aea3c8
-  data.tar.gz: 1ef8d30e2359cb1d5292f876acaeb306dccc11cb52e8a2edaab8ea5094fc7a793228eb3cf7f2e17dec0769caee7eed5cecce7751bad4fbee5c63d305f243383a
+  metadata.gz: 1cb21e97e894109e9b5e05a0a1c30df072d3de2f2a446a197f838ce6c6d07340d4896fcadca62b7007406990bc6cf3ea3d749d0a33d0f22009e05d1da0e7796a
+  data.tar.gz: cdde0f3ac7c090bb8ce170091a1ffcd2d5a3849d4d6ec93b5aee7cac933e48d091755d70596c8a2ccd4411797f3cef9f0e9dcc4025fd9fb11195f400a0b5387f

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/support/.netrc

data/.rspec

@@ -1,3 +1,2 @@
 --color
---fail-fast
 --order random

data/.travis.yml

@@ -1,15 +1,22 @@
 language: ruby
 
 rvm:
+  - rbx-19mode
+  - jruby-19mode
+  - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - ruby-head
 
 matrix:
   allow_failures:
+    - rvm: rbx-19mode
+    - rvm: jruby-19mode
+    - rvm: 1.9.2
     - rvm: ruby-head
 
 notifications:
   email:
-    on_success: change
+    on_success: never
     on_failure: always

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Martin Jagusch
+Copyright (c) 2013-2014 Martin Jagusch
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Octokom
 
-Work in progress command line application for your every day GitHub workflow.
+Create pull requests, GitHub issues etc. quickly from your command line in three words `octokom pull-request create`. Octokom finds automatically the name of your repository and Git branch.
 
 ## Installation
 
@@ -8,10 +8,18 @@ Work in progress command line application for your every day GitHub workflow.
 $ gem install octokom
 ```
 
-## Examples
+## The Interface
 
-#### Create a new pull request
+Run `octokom --help` to see a list of all supported commands and options.
+
+#### Pull Request
 
 ```bash
 $ octokom pull-request create --title "New feature"
 ```
+
+#### GitHub Issue
+
+```bash
+$ octokom issue create --title "Nasty Bug"
+```

data/bin/octokom

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'octokom'
 
-Octokom.start(*ARGV)
+Octokom::CLI.run

data/lib/octokom.rb

@@ -1,15 +1,11 @@
-require 'clamp'
-require 'octokit'
-require 'security'
-
-require 'octokom/authentication'
-require 'octokom/command'
-require 'octokom/keychain'
-require 'octokom/repository'
-require 'octokom/version'
+require 'octokom/core_ext/blank'
 
 module Octokom
-  def self.start(*args)
-    Octokom::Command.run(args)
-  end
+  autoload :CLI,        'octokom/cli'
+  autoload :Client,     'octokom/client'
+  autoload :Command,    'octokom/command'
+  autoload :Editor,     'octokom/editor'
+  autoload :Repository, 'octokom/repository'
+  autoload :Shell,      'octokom/shell'
+  autoload :VERSION,    'octokom/version'
 end

data/lib/octokom/cli.rb

@@ -0,0 +1,6 @@
+module Octokom
+  class CLI < Command
+    sub_command 'issue',        'Create or update GitHub issues.',        Issue
+    sub_command 'pull-request', 'Create, update or merge pull requests.', PullRequest
+  end
+end

data/lib/octokom/client.rb

@@ -0,0 +1,99 @@
+require 'io/console'
+require 'netrc'
+
+module Octokom
+  class Client
+    private_class_method :new
+
+    attr_reader :token
+
+    KEY = 'api.github.com'
+    URL = 'https://github.com/mjio/octokom'
+
+    def self.authenticate
+      new.authenticate
+    end
+
+    # Use the existing credentials form the ~/.netrc file to verify API
+    # requests to GitHub. When no credentials exist, ask for login and
+    # password to request a new token from GitHub.
+    def authenticate
+      _, @token = netrc[KEY]
+
+      unless token
+        login, password = ask_for_credentials
+        create_authorization(login, password)
+      end
+
+      self
+    end
+
+    def client
+      require 'octokit'
+      Octokit::Client.new(access_token: token)
+    end
+
+    private
+
+    def path
+      @path ||= Netrc.default_path
+    end
+
+    def file
+      @file ||= File.open(path, File::RDWR|File::CREAT, 0600)
+    end
+
+    def data
+      @data ||= Netrc.parse(Netrc.lex(file.each_line.to_a))
+    end
+
+    def netrc
+      @netrc ||= Netrc.new(path, data)
+    end
+
+    def ask_for_credentials
+      login = ask_for_login
+      password = ask_for_password
+      puts # newline
+      [login, password]
+    end
+
+    def ask_for_login
+      print 'GitHub Login: '
+      STDIN.gets.chomp
+    end
+
+    def ask_for_password
+      print 'Password: '
+      STDIN.noecho(&:gets).chomp
+    end
+
+    def create_authorization(login, password)
+      require 'octokit'
+
+      begin
+        client = Octokit::Client.new(login: login, password: password)
+        auth   = client.create_authorization(scopes: ['repo'], note: api_note, note_url: URL)
+      rescue Octokit::Unauthorized
+        puts "Unable to authorise user @#{login}"
+        exit(1)
+      end
+
+      @token = auth.token
+      save_token_to_netrc(login)
+    end
+
+    def save_token_to_netrc(login)
+      netrc[KEY] = login, @token
+      netrc.save
+    end
+
+    def api_note
+      "Octokom #{hostname}@#{Time.now.usec}"
+    end
+
+    def hostname
+      `hostname`.chomp
+    end
+  end
+end

data/lib/octokom/command.rb

@@ -1,7 +1,70 @@
+require 'clamp'
+
+autoload :Issue,       'octokom/command/issue'
+autoload :PullRequest, 'octokom/command/pull_request'
+
 module Octokom
   class Command < Clamp::Command
-    autoload :PullRequest, 'octokom/command/pull_request'
+    include Octokom::Shell
+
+    # Shortcut for `Clamp::Command.option` with `:flag` argument.
+    #
+    # For example:
+    #   flag ['-a'], A option'
+    #
+    # Is the same as:
+    #   option ['-a'], :flag, 'A option'
+    def self.flag(tags, desc, &block)
+      option_without_type(tags, :flag, desc, &block)
+    end
+
+    # Alias for the `Clamp::Command.option` method that uses the long option
+    # tag as type string.
+    #
+    # For example:
+    #   Octokom::Command.option ['-a', '--abc'], 'ABC option'
+    #
+    # Is the same as:
+    #   Clamp::Command.option ['-a', '--abc'], 'ABC', 'ABC option'
+    def self.option_with_type(tags, desc, &block)
+      type = tags.first[/^--(.*)$/, 1].upcase
+      option_without_type(tags, type, desc, &block)
+    end
+
+    # Override `Clamp::Command.execute` method so it can be used as a block.
+    def self.execute(&block)
+      define_method(:execute, block) do
+        yield if block_given?
+      end
+    end
+
+    # Create aliases for the Clamp::Command `option` and `subcommand` methods.
+    singleton_class.class_eval do
+      alias_method :option_without_type, :option
+      alias_method :option, :option_with_type
+      alias_method :sub_command, :subcommand
+    end
+
+    flag ['--dry-run', '-y'], 'Do nothing, only show what would happen.'
+    flag ['--verbose', '-v'], 'Show the debug output.'
+
+    flag ['--version'], 'Version number.' do
+      puts "Octokom #{Octokom::VERSION}"
+    end
+
+    # Override the Clamp help message option.
+    flag ['--help'], 'Help message.' do
+      request_help
+    end
+
+    # Initializes a new Repository instance that is available in all
+    # Octokom::Command instances.
+    def git
+      @git ||= Octokom::Repository.new(verbose?)
+    end
 
-    subcommand 'pull-request', 'Create, update or merge pull requests.', PullRequest
+    def authenticate(&block)
+      yield Octokom::Client.authenticate
+    end
   end
 end

data/lib/octokom/command/issue.rb

@@ -0,0 +1,26 @@
+class Issue < Octokom::Command
+  sub_command 'create', 'Create a GitHub issue.' do
+    option ['--title',  '-t'], 'Title for the issue.'
+    option ['--desc',   '-d'], 'Description for the issue.'
+    option ['--repo',   '-r'], 'The GitHub repository you want to update. (e.g. mjio/octokom)'
+    flag   ['--editor', '-e'], 'Open the editor even when the issue title is set.'
+
+    execute do
+      @repo ||= git.repo_path
+
+      if @editor || @title.blank?
+        @title, @desc = Octokom::Editor.open(git, @title, @desc)
+      end
+
+      if @title.blank?
+        error('The title can not be empty')
+      end
+
+      authenticate do |auth|
+        task("Create issue #{@repo}") do
+          auth.client.create_issue(@repo, @title, @desc) unless dry_run?
+        end
+      end
+    end
+  end
+end

data/lib/octokom/command/pull_request.rb

@@ -1,29 +1,38 @@
-module Octokom
-  class Command
-    class PullRequest < Clamp::Command
-      include Octokom::Authentication
+class PullRequest < Octokom::Command
+  sub_command 'create', 'Create a pull request.' do
+    option ['--title',  '-t'], 'Title for the pull request.'
+    option ['--desc',   '-d'], 'Description for the pull request.'
+    option ['--base',   '-b'], 'The branch you want your changes pulled into. (e.g. master)'
+    option ['--head',   '-h'], 'The branch where your changes are implemented. (e.g. feature)'
+    option ['--repo',   '-r'], 'The GitHub repository you want to update. (e.g. mjio/octokom)'
+    flag   ['--editor', '-e'], 'Open the editor even when the pull request title is set.'
 
-      subcommand 'create', 'Create a new pull request.' do
-        option ['--repo',  '-r'], '', 'The GitHub repository. Example: "mjio/octokom"'
-        # TODO make ancestor default base
-        option ['--base',  '-b'], '', 'The branch you want your changes pulled into. Example: "master"', default: 'master'
-        option ['--head',  '-d'], '', 'The branch where your changes are implemented. Example: "new_feature"'
-        # option ['--issue', '-i'], '', 'Create pull request from an existing issue. Example: "123"'
-        option ['--title', '-t'], '', 'Title for the pull request.'
-        option ['--body',  '-b'], '', 'Body for the pull request.'
+    execute do
+      @base ||= git.base_branch
+      @head ||= git.head_branch
+      @repo ||= git.repo_path
 
-        def execute
-          authenticate do |client|
-            repo ||= Repository.remote_path
-            head ||= Repository.current_branch
+      if @base == @head
+        error("Base and head branch can not be the same (#{@base}:#{@head})")
+      end
+
+      if @editor || @title.blank?
+        @title, @desc = Octokom::Editor.open(git, @title, @desc)
+      end
 
-            if Repository.unpushed_commits?
-              exit unless system 'git push'
-            end
+      if @title.blank?
+        error('The title can not be empty')
+      end
+
+      if git.pending_commits?
+        task('Push latests commits') do
+          git.push(@head) unless dry_run?
+        end
+      end
 
-            puts "Create pull request (#{repo}) #{base}:#{head}"
-            client.create_pull_request(repo, base, head, title, body)
-          end
+      authenticate do |auth|
+        task("Create pull-request #{@repo} (#{@base}:#{@head})") do
+          auth.client.create_pull_request(@repo, @base, @head, @title, @desc) unless dry_run?
         end
       end
     end

data/lib/octokom/core_ext/blank.rb

@@ -0,0 +1,51 @@
+# This file is from "activesupport/lib/active_support/core_ext/object/blank.rb"
+
+class Object
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  def blank?
+    false
+  end
+end
+
+class Array
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  def blank?
+    BLANK_RE === self
+  end
+end
+
+class Numeric
+  def blank?
+    false
+  end
+end

data/lib/octokom/editor.rb

@@ -0,0 +1,106 @@
+module Octokom
+  # The `Octokom::Editor` class opens and parses files where you can insert
+  # a title and description for pull-requests or GitHub issues. This class is
+  # inspired by the `Pry::Editor` class (http://pry.github.io).
+  class Editor
+    def self.open(repo, title, desc)
+      editor = Editor.new(repo, title, desc)
+      editor.prepare_tempfile
+      editor.open_editor
+      editor.parse_user_input
+    end
+
+    def initialize(repo, title, desc)
+      @repo  = repo
+      @title = title
+      @desc  = desc
+    end
+
+    # Save a tempfile that includes the input from the command line or the
+    # last commit message.
+    # TODO Remove #Title and #Description section and use first line; following lines.
+    # TODO use last commit message for title
+    def prepare_tempfile
+      File.open(file_name, 'w') do |f|
+        f.puts '# Please enter a title and optional a description below'
+        f.puts '# the comments. To continue, save end close the file.'
+        f.puts "# Comment lines starting with '#' will be ignored."
+        f.puts
+        f.puts '# Title'
+        f.puts @title
+        f.puts
+        f.puts '# Description'
+        f.puts @desc
+      end
+    end
+
+    # Execute the command that is used to start the editor. This includes the
+    # waiting flag as well as the file and line number.
+    def open_editor
+      system("#{editor_name} #{waiting_flag} #{file_inc_line(file_name, 6)}")
+    end
+
+    # Opens the tempfile once again to parse the content and return the `title`
+    # and `description`.
+    def parse_user_input
+      input = {title: [], desc: []}
+      parsing = false
+
+      read_tempfile.each do |line|
+        match = /^\s*#\s*(title|desc)/i.match(line)
+        parsing = match[1].downcase.to_sym if match
+
+        unless line =~ /^\s*#/
+          input[parsing] << line if parsing
+        end
+      end
+
+      input.update(input) { |_, lines| lines.join("\n") }.values
+    end
+
+    private
+
+    def editor_name
+      @editor_name ||= ENV['GIT_EDITOR'] || ENV['VISUAL'] || ENV['EDITOR'] || 'vi'
+    end
+
+    # Make sure the editor waits for the file to be closed.
+    def waiting_flag
+      case editor_name
+      when /^[gm]?vi/
+        '--nofork'
+      when /^subl/, /^mate/
+        '--wait'
+      when /^jedit/
+        '-wait'
+      end
+    end
+
+    # Different editors have different ways how to open a file starting at
+    # a specific line number.
+    def file_inc_line(file_name, line)
+      case editor_name
+      when /^[gm]?vi/, /^emacs/, /^nano/, /^pico/, /^gedit/, /^kate/
+        "+#{line} #{file_name}"
+      when /^mate/, /^geany/
+        "--line #{line} #{file_name}"
+      when /^subl/
+        "#{file_name}:#{line}"
+      when /^uedit32/
+        "#{file_name}/#{line}"
+      when /^jedit/
+        "#{file_name} +line:#{line}"
+      else
+        file_name
+      end
+    end
+
+    def file_name
+      @file_name ||= "#{@repo.toplevel_path}/.git/OCTOKOM-#{Time.now.usec}"
+    end
+
+    def read_tempfile
+      File.open(file_name).map(&:chop).reject(&:empty?)
+    end
+  end
+end