octopolo 0.3.6 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjBkOWNlNGY5ZGYyYThmNjE4NjA5YzAyNDhmOGViOTVhMmI0ZTJkNw==
+    ZTBjNTI0MzM3MzRiZmM4ODYxNGNlM2I4YjFjYjFiODkyZTYxMmNjNg==
   data.tar.gz: !binary |-
-    ZGUzMGFmZmM2ZGQxNDk5YjhhNjFlMWY3M2IxOWM3YmRiMWZjMTA2MA==
+    MjQ3MDg1YWM2ZTMyNzdiMjlhMzFkM2FlNzg0YmQyM2I5MTQ0OTNjZQ==
 SHA512:
   metadata.gz: !binary |-
-    NDcwNjNkYTQ3OWI2OTRjNTE3YWRkMWEyOTRlMTJiZDg0OGRiYWJkMGFhZGZh
-    NGMxOTM0MjU5ZTAxZGE1NzllNmIyODQ2ODdlYmUwODQzNTU0OTYzZDQwY2Nm
-    YzQyYWJlNDg5OWM3OTllNjNkZTUwYzUzNjdlYWRiMzdkNjk5YmY=
+    ZTUzNWI1NWZkMTBiY2Y3M2MzZTg1MmEyMmIwMGEyZmJkMjg3NmJhZmE4ZmIy
+    MTNlNzBkYTJiMDU3NDcwYWQ5MDE1MDQ1NGE3M2NmNDYyNGY4ZGZiNDg5ZjBk
+    NGUzYzE4Y2NkY2FlZmU2ZGRhYjU5OTM4MWIwODA2MDBlODRhMDI=
   data.tar.gz: !binary |-
-    OThiMTI3NjcyZmVjMDI5OWJlMTZlZTVkMTA1Njk1ODZiZmU4NTk0Zjc5YWRh
-    OGU2NmM4MmEzOGMzYzQ5Y2RhYThlN2U5Y2Q5Mjk1OGM3MTJmMjFjNzhiZGI3
-    OTAzYmE5YjVkMWY2MjJlZmU0MTU3MzE5MWE4MzY3MGEyYmU5Zjg=
+    NWI5YzI3NWU5NDU2YTIxODVhNzY2OWY5OGY5MTk4M2JkMGU4YTU1OWYwZGU3
+    ZDk1MzIwMWZkZGYxNDBmZjhjNTczY2RkNzAwYjQ4NjQ5NTg5NmI4OWI1NThl
+    ZjYyNTc2YjAyMDI0MTk2ZGIwZmUwYmRkOWMwODAxMTA4ZTRkYmM=

data/.travis.yml

@@ -1,3 +1,7 @@
+sudo: false
+branches:
+  only:
+    - master
 language: ruby
 rvm:
   - 1.9.3

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v0.4.0
+* Adding issue command to create issues.
+
+  > Brian Bergstrom: Nick LaMuro: https://github.com/sportngin/octopolo/pull/54
+
 #### v0.3.6
 * Some git commands are expected to return non-zero
 

data/lib/octopolo/commands/issue.rb

@@ -0,0 +1,14 @@
+desc "Create an issue for the current project."
+command 'issue' do |c|
+  config = Octopolo::Config.parse
+  user_config = Octopolo::UserConfig.parse
+
+  c.desc "Use $EDITOR to update PR description before creating"
+  c.switch [:e, :editor], :default_value => user_config.editor
+
+  c.action do |global_options, options, args|
+    require_relative '../scripts/issue'
+    options = global_options.merge(options)
+    Octopolo::Scripts::Issue.execute options
+  end
+end

data/lib/octopolo/github.rb

@@ -71,6 +71,14 @@ module Octopolo
       client.create_pull_request *args
     end
 
+    def self.issue *args
+      client.issue *args
+    end
+
+    def self.create_issue *args
+      client.create_issue *args
+    end
+
     def self.add_comment *args
       client.add_comment *args
     end
@@ -101,12 +109,11 @@ module Octopolo
       client.remove_label *args
     end
 
-    def self.add_labels_to_pull *args
+    def self.add_labels_to_issue *args
       client.add_labels_to_an_issue *args
     end
 
 
-
     # now that you've set up your credentials, try again
     TryAgain = Class.new(StandardError)
     # the credentials you've entered are bad

data/lib/octopolo/github/issue.rb

@@ -0,0 +1,106 @@
+require "octokit"
+
+module Octopolo
+  module GitHub
+    class Issue
+      attr_accessor :data
+      attr_accessor :repo_name
+      attr_accessor :number
+
+      def initialize repo_name, number, data = nil
+        raise MissingParameter if repo_name.nil? or number.nil?
+
+        self.repo_name = repo_name
+        self.number = number
+        self.data = data
+      end
+
+      # Public: Create a issue for the given repo
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      # options - Hash of issue information
+      #   title: Title of the issue
+      #   description: Brief description of the issue
+      #
+      # Returns a Issue instance
+      def self.create(repo_name, options)
+        # create via the API
+        creator = IssueCreator.perform(repo_name, options)
+        # wrap in our class
+        new repo_name, creator.number, creator.data
+      end
+
+      def data
+        @data ||= GitHub.issue(repo_name, number)
+      rescue Octokit::NotFound
+        raise NotFound
+      end
+
+      def title
+        data.title
+      end
+
+      def url
+        data.html_url
+      end
+
+      def commenter_names
+        exclude_octopolo_user (comments.map{ |comment| GitHub::User.new(comment.user.login).author_name }.uniq)
+      end
+
+      def exclude_octopolo_user(user_list)
+        user_list.reject{|u| GitHub.excluded_users.include?(u) }
+      end
+
+      def body
+        data.body || ""
+      end
+
+      def external_urls
+        # extract http and https URLs from the body
+        URI.extract body, %w(http https)
+      end
+
+      def human_app_name
+        repo = repo_name.split("/").last
+        repo.split("_").map(&:capitalize).join(" ")
+      end
+
+      def comments
+        @comments ||= GitHub.issue_comments(repo_name, number)
+      end
+
+      # Public: Add a comment to the issue
+      #
+      # message - A String containing the desired comment body
+      def write_comment(message)
+        GitHub.add_comment repo_name, number, ":octocat: #{message}"
+      rescue Octokit::UnprocessableEntity => error
+        raise CommentFailed, "Unable to write the comment: '#{error.message}'"
+      end
+
+      # Public: Adds labels to a pull-request
+      #
+      # labels - label objects, can be a single label, an array of labels,
+      #          or a list of labels
+      def add_labels(*labels)
+        built_labels = Label.build_label_array(labels)
+        GitHub.add_labels_to_issue(repo_name, number, built_labels.map(&:name) )
+      end
+
+      # Public: Removes labels from a pull-request,
+      #
+      # labels - label objects, can be a single label, an array of labels,
+      #          or a list of labels
+      def remove_labels(*labels)
+        Label.build_label_array(labels).each do |built_label|
+          GitHub.remove_label(repo_name, number, built_label.name)
+        end
+      end
+
+      MissingParameter = Class.new StandardError
+      NotFound = Class.new StandardError
+      CommentFailed = Class.new StandardError
+    end
+  end
+end

data/lib/octopolo/github/issue_creator.rb

@@ -0,0 +1,147 @@
+require_relative "../renderer"
+require 'tempfile'
+
+module Octopolo
+  module GitHub
+    class IssueCreator
+      include ConfigWrapper
+      # for instantiating the issue creator
+      attr_accessor :repo_name
+      attr_accessor :options
+      # for caputuring the created issue information
+      attr_accessor :number
+      attr_accessor :data
+
+      # Public: Create a issue for the given repo with the given options
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      # options - Hash of issue information
+      #   title: Title of the issue
+      def initialize repo_name, options
+        self.repo_name = repo_name
+        self.options = options
+      end
+
+      # Public: Create a issue for the given repo with the given options
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      # options - Hash of issue information
+      #   title: Title of the issue
+      #
+      # Returns the IssueCreator instance
+      def self.perform repo_name, options
+        new(repo_name, options).tap do |creator|
+          creator.perform
+        end
+      end
+
+      # Public: Create the issue
+      #
+      # Returns an array with the first element being the issue's
+      # number, the second being a Mash of the response from GitHub's API
+      def perform
+        # labels option cannot be null due to https://github.com/octokit/octokit.rb/pull/538
+        result = GitHub.create_issue(repo_name, title, body, labels: [])
+        # capture the information
+        self.number = result.number
+        self.data = result
+      rescue => e
+        raise CannotCreate, e.message
+      end
+
+      # Public: The created resource's details
+      def data
+        @data || raise(NotYetCreated)
+      end
+
+      # Public: The created issue's number
+      def number
+        @number || raise(NotYetCreated)
+      end
+
+      # Public: Title of the issue
+      #
+      # Returns a String with the title
+      def title
+        options[:title] || raise(MissingAttribute)
+      end
+
+      # Public: The Pivotal Tracker story IDs associated with the issue
+      #
+      # Returns an Array of Strings
+      def pivotal_ids
+        options[:pivotal_ids] || []
+      end
+
+      # Public: Jira Issue IDs associated with the issue
+      #
+      # Returns an Array of Strings
+      def jira_ids
+        options[:jira_ids] || []
+      end
+
+      # Public: Jira Url associated with the issue
+      #
+      # Returns Jira Url
+      def jira_url
+        config.jira_url
+      end
+
+      # Public: Rendering template for body property
+      #
+      # Returns Name of template file
+      def renderer_template
+        Renderer::ISSUE_BODY
+      end
+
+      # Public: Temporary file for body editing
+      #
+      # Returns Name of temporary file
+      def body_edit_temp_name
+        'octopolo_issue'
+      end
+
+
+      # Public: The body (primary copy) of the issue
+      #
+      # Returns a String
+      def body
+        output = Renderer.render renderer_template, body_locals
+        output = edit_body(output) if options[:editor]
+        output
+      end
+
+      def edit_body(body)
+        return body unless ENV['EDITOR']
+
+        # Open the file, write the contents, and close it
+        tempfile = Tempfile.new([body_edit_temp_name, '.md'])
+        tempfile.write(body)
+        tempfile.close
+
+        # Allow the user to edit the file
+        system "#{ENV['EDITOR']} #{tempfile.path}"
+
+        # Reopen the file, read the contents, and delete it
+        tempfile.open
+        output = tempfile.read
+        tempfile.unlink
+
+        output
+      end
+
+      # Public: The local variables to pass into the template
+      def body_locals
+        {
+          pivotal_ids: pivotal_ids,
+          jira_ids: jira_ids,
+          jira_url: jira_url,
+        }
+      end
+
+      MissingAttribute = Class.new(StandardError)
+      NotYetCreated = Class.new(StandardError)
+      CannotCreate = Class.new(StandardError)
+    end
+  end
+end

data/lib/octopolo/github/pull_request.rb

@@ -1,20 +1,10 @@
+require_relative "issue"
 require_relative "../week"
 require "octokit"
 
 module Octopolo
   module GitHub
-    class PullRequest
-      attr_accessor :pull_request_data
-      attr_accessor :repo_name
-      attr_accessor :number
-
-      def initialize repo_name, number, pull_request_data = nil
-        raise MissingParameter if repo_name.nil? or number.nil?
-
-        self.repo_name = repo_name
-        self.number = number
-        self.pull_request_data = pull_request_data
-      end
+    class PullRequest < Issue
 
       # Public: All closed pull requests for a given repo
       #
@@ -42,100 +32,39 @@ module Octopolo
         # create via the API
         creator = PullRequestCreator.perform(repo_name, options)
         # wrap in our class
-        new repo_name, creator.number, creator.pull_request_data
+        new repo_name, creator.number, creator.data
       end
 
-      def pull_request_data
-        @pull_request_data ||= GitHub.pull_request(repo_name, number)
+      def data
+        @data ||= GitHub.pull_request(repo_name, number)
       rescue Octokit::NotFound
         raise NotFound
       end
 
-      def title
-        pull_request_data.title
-      end
-
-      def url
-        pull_request_data.html_url
-      end
-
       def branch
-        pull_request_data.head.ref
+        data.head.ref
       end
 
       def mergeable?
-        pull_request_data.mergeable
+        data.mergeable
       end
 
       def week
-        Week.parse pull_request_data.closed_at
+        Week.parse data.closed_at
       end
 
       def commenter_names
-        exlude_octopolo_user (comments.map{ |comment| GitHub::User.new(comment.user.login).author_name }.uniq - author_names)
+        exclude_octopolo_user (comments.map{ |comment| GitHub::User.new(comment.user.login).author_name }.uniq - author_names)
       end
 
       def author_names
-        exlude_octopolo_user commits.map(&:author_name).uniq
-      end
-
-      def exlude_octopolo_user(user_list)
-        user_list.reject{|u| GitHub.excluded_users.include?(u) }
-      end
-
-      def body
-        pull_request_data.body || ""
-      end
-
-      def external_urls
-        # extract http and https URLs from the body
-        URI.extract body, %w(http https)
-      end
-
-      def human_app_name
-        repo = repo_name.split("/").last
-        repo.split("_").map(&:capitalize).join(" ")
+        exclude_octopolo_user commits.map(&:author_name).uniq
       end
 
       def commits
         @commits ||= Commit.for_pull_request self
       end
 
-      def comments
-        @comments ||= GitHub.issue_comments(repo_name, number)
-      end
-
-      # Public: Add a comment to the pull request
-      #
-      # message - A String containing the desired comment body
-      def write_comment(message)
-        GitHub.add_comment repo_name, number, ":octocat: #{message}"
-      rescue Octokit::UnprocessableEntity => error
-        raise CommentFailed, "Unable to write the comment: '#{error.message}'"
-      end
-
-      # Public: Adds labels to a pull-request
-      #
-      # labels - label objects, can be a single label, an array of labels,
-      #          or a list of labels
-      def add_labels(*labels)
-        built_labels = Label.build_label_array(labels)
-        GitHub.add_labels_to_pull(repo_name, number, built_labels.map(&:name) )
-      end
-
-      # Public: Removes labels from a pull-request,
-      #
-      # labels - label objects, can be a single label, an array of labels,
-      #          or a list of labels
-      def remove_labels(*labels)
-        Label.build_label_array(labels).each do |built_label|
-          GitHub.remove_label(repo_name, number, built_label.name)
-        end
-      end
-
-      MissingParameter = Class.new StandardError
-      NotFound = Class.new StandardError
-      CommentFailed = Class.new StandardError
     end
   end
 end