hustle_and_flow 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09c8b0e8909c7e772f202f9c4a8d5d51ef65423b
-  data.tar.gz: 29362f1b7e998396294e1925c69d939ba66dc2a2
+  metadata.gz: 4e0388db2dcb3bd47c54a5e03da9956cf4b7a85f
+  data.tar.gz: 4a59058b00ec6581f3cd0fc33bb8b6c0bb0fec09
 SHA512:
-  metadata.gz: 623381f2772547914f6a2c26604542131eeec13d0c82351b0cd17e4bec7ba5c592ea646f0584f9cfb2032bda48ba839bb2f96d59ce435f2c1924f593ce4f95ba
-  data.tar.gz: 2f3f3906195c4043b503ab2939c8cc0625effb86badebf5c781a1cd6e928a5632bd18bb96ca0f1448f6aa062aadfca8c818811bb6d69bb24675b54a121a3e3fd
+  metadata.gz: 48892f977a6e1a681caf40921f84c0761f9b8ec4de97b1715eefd95fe571c1aeb9b699334d408f48c33073bcd58b4ccb8fe73bfd4ab8b621e9f085d9fa8293cc
+  data.tar.gz: 0ea72b1ccb1cd67a9935b842eab8187cc5a61fa6caca0006b7801a9ac8badd65100a9d50922acafdf7e922f8d38dd4fd1ba09e469be43159679e516f82d6d7a3

data/README.md

@@ -1,29 +1,205 @@
 # HustleAndFlow
 
-TODO: Write a gem description
+## Start
 
-## Installation
+```
+Usage: start_work_on [-n <issue_type> <issue_title>] [-i <issue_number>]
 
-Add this line to your application's Gemfile:
+ -n <issue_type> <issue_title>
 
-    gem 'hustle_and_flow'
+    Start work on a new issue.  This command will:
+      * Runs issue-tracker-specific pre-start-new-issue tasks.
 
-And then execute:
+      * Checks to see if an issue with that exact type and title
+        already exists. If it does, it will perform all of the actions
+        as though the "-i" flag was used instead of the "-n" flag.
 
-    $ bundle
+      * Create a new issue with the given type and title.
 
-Or install it yourself as:
+      * Open your default browser so you to supply additional
+        information.
 
-    $ gem install hustle_and_flow
+      * Create a branch with a dasherized version of the issue title
+        as well as a dasherized version of the action and issue number
+        in accordance with the type of issue tracker you're using.
 
-## Usage
+        For example, if using Github, and the created issue number was
+        42, with a type of "feature" and a title of "Add awesome new
+        feature!!!", this command would create a branch name of:
 
-TODO: Write usage instructions here
+          feature/add-awesome-new-feature-closes-42
 
-## Contributing
+      * Pushes the newly created branch to Github
 
-1. Fork it ( https://github.com/[my-github-username]/hustle_and_flow/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+      * Performs any issue tracker-specific post-start-new-issue tasks
+
+ -i <issue_number>
+
+    Starts work on an existing issue.  This command will:
+      * Runs issue-tracker-specific pre-start-existing-issue tasks.
+
+      * Check to see if the issue exists. If it does, it will display
+        the issue information and ask for confirmation.  If it does
+        not, the user will be alerted and the command will exit.
+
+      * Assuming the issue exists, and it is unassigned, it will
+        assign it to the user.  If it is already assigned, the user
+        will be asked if they would like to reassign it to themselves.
+
+      * Assuming the issue exists, the command will check to see if
+        there are any branches which already exist that may be
+        applicable to work on.  They will be displayed in the format:
+
+          1. * LT [Jeff Felchner]   feature/add-awesome-new-feature-closes-42
+          2.   R  [Sonny Gonzalez]  feature/add-awesome-new-feature-closes-42-alt-1
+          3.   L  [Drew Montgomery] feature/add-awesome-new-feature-closes-42-alt-2
+
+          c. Create a new branch
+
+        This means that there are three branches which are already
+        being worked on for that issue.  The different parts of the
+        listing are as follows:
+
+          *: Indicates the current branch
+          L: Indicates the a local branch
+          T: Indicates the local branch is tracking a remote branch
+          R: Indicates a remote-only branch
+
+        The name field indicates the person the branch is currently
+        assigned to.  If unassigned, it will be first person who
+        committed to the branch.
+
+        If option "c" is chosen, a new branch will be created with an
+        additional increment added to the "alt" portion of the name.
+
+        If no applicable branches exist, one will be created for you.
+
+      * Runs issue-tracker-specific post-start-existing-issue tasks.
+```
+
+## Stop
+
+```
+Usage: ready_for_review [-n]
+
+  Process:
+    * Runs issue-tracker-specific pre-ready-for-review tasks.
+      For example, if using Github, a pull-request will be
+      created for the branch.
+
+    * Checks to see if the branch is already being reviewed.
+      If it is, the command aborts.
+
+    * Makes sure that the branch is up-to-date with origin/master
+
+    * Runs all of the tests
+
+      If the tests fail, the command will abort.
+
+    * Runs all of the style checks
+
+      If the style checks fail, the command will abort.
+
+    * All updated changes are pushed to origin.
+
+    * The issue modified to indicate that it is ready for review.
+
+    * By default, the users whose code you have modified, will be
+      notified that their assistance is requested for review.
+
+    * Runs issue-tracker-specific post-ready-for-review tasks.
+
+  Options:
+    -n  Skips test run and style checks
+```
+
+## Review
+
+```
+Usage: start_review [-i <issue_number>] [-r]
+
+ -i <issue_number>
+
+    Begins the review of an existing issue (or Pull Request).
+      * Runs issue-tracker-specific pre-start-review tasks.
+
+      * Updates master with origin/master
+
+      * Retrieves all branches/issues that are ready for review and
+        displays them to the user.
+
+          Ready for Review
+          -------------------------------------------------------------------------
+          1. * LT [Jeff Felchner]   feature/add-awesome-new-feature-closes-42
+          2.   R  [Sonny Gonzalez]  feature/add-awesome-new-feature-closes-42-alt-1
+          3.   L  [Drew Montgomery] feature/add-awesome-new-feature-closes-42-alt-2
+
+          Other Available Branches
+          -------------------------------------------------------------------------
+          4. * LT [Michael Myers]   refactor/change-things-up
+          5.   R  [Freddy Kreuger]  bugfix/slay-those-bugs
+          6.   L  [Jason Voorhees]  chore/start-a-fire
+
+      * Checks to see if the issue is currently being reviewed. If so
+        the command will abort.
+
+      * Assigns the issue (or Pull Request if using Github) to the
+        reviewer.
+
+      * Makes sure that the selected branch is up-to-date with
+        origin/master
+
+      * Runs all of the tests
+
+        If the tests fail, the command will abort.
+
+      * Runs all of the style checks
+
+        If the style checks fail, the command will abort.
+
+      * All updated changes are pushed to origin.
+
+      * The issue modified to indicate that it is being reviewed.
+
+      * The user who was previously assigned to the issue will be
+        notified that their code is being reviewed.
+
+      * The user will be presented with a diff command (which will
+        also be copied to their clipboard).  When run, it will show
+        them all of the changes that are being asked to be reviewed.
+
+      * Runs issue-tracker-specific post-start-review tasks.
+
+  Options:
+    -r  Forces the branch to be reviewed by the current user even if
+        it appears it is already being reviewed.
+```
+
+## Finish Review
+
+```
+Usage: finish_review [-m]
+
+  Completes the review of the current issue (or Pull Request).
+    * Runs issue-tracker-specific pre-finish-review tasks.
+
+    * Adds a git note to all commits stating:
+
+        Reviewed-by: Your Username <youremail@example.com>
+
+    * Merges the branch into master using "git-backmerge"
+
+    * Removes anyone assigned to the issue (or Pull Request)
+
+    * Marks the issue as "reviewed"
+
+    * Adds a comment that the issue has been reviewed.
+
+    * If applicable, make sure that the issue has been marked as
+      "finished", "closed", etc.
+
+    * Runs issue-tracker-specific post-finish-review tasks.
+
+  Options:
+    -m  Skips automerging of the branch into master
+```

data/bin/hustle

@@ -2,4 +2,8 @@
 
 require 'hustle_and_flow/binary/runner'
 
+trap 'SIGINT' do
+  exit 130
+end
+
 HustleAndFlow::Binary::Runner.start

data/lib/hustle_and_flow/binary/runner.rb

@@ -19,16 +19,20 @@ class   Runner < Thor
                 type:     :string,
                 aliases:  '-u',
                 desc:     'When searching for issues, it is the status of the issues you would like to view.'
-  method_option :subject,
+  method_option :title,
                 type:     :string,
-                aliases:  '-s',
-                desc:     'The subject (or title) of the issue which should be searched for or created'
+                aliases:  '-m',
+                desc:     'The subject (or message) of the issue which should be searched for or created'
   method_option :number,
                 type:     :string,
                 aliases:  '-n',
                 desc:     'The number of the issue which should be searched for.'
   def start
-    Commands::Start.new(io: HustleAndFlow::Io::Shell.new, **options).call
+    symbolized_options = options.each_with_object({}) do |value, memo|
+      memo[value[0].to_sym] = value[1]
+    end
+
+    Commands::Start.new(io: HustleAndFlow::Io::Shell.new, **symbolized_options).call
   end
 end
 end

data/lib/hustle_and_flow/commands/start.rb

@@ -1,32 +1,31 @@
-require 'thor/shell/basic'
-require 'hustle_and_flow/vcs_repository'
-require 'hustle_and_flow/issue_tracker'
+require 'hustle_and_flow/version_control'
+require 'hustle_and_flow/issue_trackers/commands/start'
+require 'hustle_and_flow/version_controls/commands/start'
 
 module  HustleAndFlow
 module  Commands
 class   Start
-  attr_accessor :repo,
-                :tracker,
-                :me,
-                :io,
-                :issue_data
+  attr_accessor :io,
+                :options
 
   def initialize(io:, **args)
-    self.repo       = VcsRepository.new(path: Dir.pwd)
-    self.tracker    = IssueTracker.new(repo: repo)
-    self.me         = repo.user
     self.io         = io
-    self.issue_data = args.select { |_k, v| v }
+    self.options    = args
   end
 
   def call
-    issue   = tracker.start(io:         io,
-                            me:         me,
-                            issue_data: issue_data)
-    _branch = repo.start(io:              io,
-                         number:          issue.number,
-                         title:           issue.title,
-                         branch_template: issue.to_branch_name(version: '*****'))
+    repo    = VersionControl.new(path: Dir.pwd)
+    issue   = IssueTrackers::Commands::Start.call \
+                io:              io,
+                repo:            repo,
+                me:              repo.user,
+                options:         options
+    _branch = VersionControls::Commands::Start.call \
+                io:              io,
+                repo:            repo,
+                number:          issue.number,
+                title:           issue.title,
+                branch_template: issue.to_branch_name(version: '*****')
   rescue Git::GitExecuteError => e
     io.say 'There was a problem running a git command.'
     io.say e.message

data/lib/hustle_and_flow/issue_tracker.rb

@@ -1,14 +1,15 @@
-require 'hustle_and_flow/issue_trackers/github'
+require 'hustle_and_flow/issue_trackers/github/tracker'
 
 module  HustleAndFlow
 class   IssueTracker
   attr_accessor :adapter
 
-  def initialize(**args)
-    self.adapter = HustleAndFlow::
-                   IssueTrackers::
-                   Github.
-                   new(repo: args[:repo])
+  def initialize(repo:)
+    self.adapter = self.class.detect.new(repo: repo)
+  end
+
+  def self.detect
+    ::HustleAndFlow::IssueTrackers::Github::Tracker
   end
 
   def method_missing(name, *args)

data/lib/hustle_and_flow/issue_trackers/commands/start.rb

@@ -0,0 +1,17 @@
+require 'hustle_and_flow/issue_tracker'
+require 'hustle_and_flow/issue_trackers/github/commands/start'
+
+module  HustleAndFlow
+module  IssueTrackers
+module  Commands
+class   Start
+  def self.call(**args)
+    issue_tracker_type = IssueTracker.detect.name.gsub('::Tracker', '')
+    command_class      = const_get("::#{issue_tracker_type}::Commands::Start")
+
+    command_class.call(**args)
+  end
+end
+end
+end
+end

data/lib/hustle_and_flow/issue_trackers/github/commands/start.rb

@@ -0,0 +1,99 @@
+require 'hustle_and_flow/issue_trackers/github/tracker'
+require 'hustle_and_flow/issue_trackers/github/issues'
+require 'hustle_and_flow/formatters/issue_table_formatter'
+
+module  HustleAndFlow
+module  IssueTrackers
+module  Github
+module  Commands
+class   Start
+  attr_accessor :mode,
+                :labels,
+                :statuses,
+                :title,
+                :number,
+                :me,
+                :issues,
+                :tracker,
+                :io
+
+  def initialize(**args)
+    self.mode     = args[:options][:create]
+    self.labels   = args[:options][:type]
+    self.statuses = args[:options][:status]
+    self.title    = args[:options][:title]
+    self.number   = args[:options][:number]
+    self.me       = args[:me]
+    self.io       = args[:io]
+    self.tracker  = Github::Tracker.new(repo: args[:repo])
+    self.issues   = Issues.new(tracker:  tracker,
+                               io:       io,
+                               statuses: statuses)
+  end
+
+  def call
+    if !issue_specified? && mode == 'search'
+      applicable_issues = issues.filter_by(issue_data)
+
+      io.print_formatted_table \
+        data:  Formatters::IssueTableFormatter.new(applicable_issues).to_ary,
+        title: 'Available Issues'
+
+      self.number = io.choose_issue until issue_specified?
+    end
+
+    if issue_specified?
+      issue = issues.find_or_create(issue_data)
+
+      if io.correct_issue?(issue)
+        issue.start(me: me)
+      end
+    else
+      fail ArgumentError.new("You must specify both type and a title when starting a new issue")
+    end
+  end
+
+  def self.call(**args)
+    new(**args).call
+  end
+
+  private
+
+  def mode=(other)
+    @mode = other.nil? ? 'search' : 'create'
+  end
+
+  def labels
+    @labels ||= []
+  end
+
+  def labels=(other)
+    other = other.to_s
+
+    @labels = other.split(',')
+  end
+
+  def statuses=(other)
+    other = other.
+              to_s.
+              split(',')
+
+    @statuses = other.empty? ? [:open] : other
+  end
+
+  def issue_specified?
+    (labels.any? && title) || number
+  end
+
+  def issue_data
+    {
+      number: number,
+      labels: labels.empty? ? nil : labels,
+      title:  title,
+    }.each_with_object({}) { |item, memo| memo[item[0]] = item[1] unless item[1].nil? }
+  end
+end
+end
+end
+end
+end

data/lib/hustle_and_flow/issue_trackers/github/issue.rb

@@ -4,7 +4,7 @@ require 'hustle_and_flow/io/shell'
 
 module  HustleAndFlow
 module  IssueTrackers
-class   Github
+module  Github
 class   Issue
   DEFAULT_CATEGORY_LABELS = %w{feature bug refactor test style chore docs spike}
   ISSUE_ACTIONS           = %w{closes references fixes}
@@ -25,12 +25,10 @@ class   Issue
         data:    tracker.client.create_issue(tracker.repo_name,
                                              title,
                                              body,
-                                             **args))
+                                             args))
   end
 
   def start(me: nil)
-    return unless io.correct_issue?(self)
-
     reopen.
     assign_issue? to: me
   end
@@ -58,8 +56,10 @@ class   Issue
     five_minutes_ago <= created_at
   end
 
-  def has_label?(other)
-    labels.include?(other)
+  def has_label?(other = [])
+    other = !other.is_a?(Array) ? [other] : other
+
+    (labels & other).any?
   end
 
   def has_body?
@@ -84,7 +84,7 @@ class   Issue
     assignee == other
   end
 
-  def match?(type: nil, **args)
+  def match?(labels: nil, **args)
     result     = true
     conditions = args
 
@@ -92,7 +92,7 @@ class   Issue
       result &&= public_send(key) == value
     end
 
-    type ? (result && has_label?(type)) : result
+    result &&= labels ? has_label?(labels) : true
   end
 
   def contact

data/lib/hustle_and_flow/issue_trackers/github/issues.rb

@@ -1,48 +1,25 @@
 require 'hustle_and_flow/issue_trackers/github/issue'
-require 'hustle_and_flow/formatters/issue_table_formatter'
 
 module  HustleAndFlow
 module  IssueTrackers
-class   Github
+module  Github
 class   Issues
   include Enumerable
 
   attr_accessor :tracker,
-                :query,
-                :issues
-
-  def initialize(tracker:, issues: nil, query: { state: :all })
-    self.tracker = tracker
-    self.query   = query
-    self.issues  = issues
-  end
-
-  def self.start(tracker:, issues: nil, io:, me:, issue_data:)
-    new(tracker: tracker,
-        issues:  issues).
-    start(io:         io,
-          me:         me,
-          issue_data: issue_data)
-  end
-
-  def start(io:, me:, issue_data:)
-    issue_data = issue_data.merge(status: 'open')
-
-    unless issue_specified?(issue_data)
-      applicable_issues = filter_by(issue_data)
-
-      io.print_formatted_table \
-        data:  Formatters::IssueTableFormatter.new(applicable_issues).to_ary,
-        title: 'Available Issues'
-
-      issue_data[:number] = io.choose_issue until issue_specified?(issue_data)
-    end
-
-    find_or_create(issue_data).start(me: me)
+                :statuses,
+                :issues,
+                :io
+
+  def initialize(tracker:, io:, issues: nil, statuses: nil)
+    self.io       = io
+    self.tracker  = tracker
+    self.statuses = statuses
+    self.issues   = issues
   end
 
   def find_or_create(**args)
-    find(**args) || Issue.create(tracker: tracker, **args)
+    find(**args) || Issue.create(tracker: tracker, io: io, **args)
   end
 
   def each
@@ -51,38 +28,39 @@ class   Issues
     end
   end
 
-  private
-
-  def filter_by(*args)
-    self.class.new(tracker: tracker,
+  def filter_by(**args)
+    self.class.new(io:      io,
+                   tracker: tracker,
                    issues:  issues.select do |issue|
-                              issue if issue.match?(*args)
+                              issue if issue.match?(**args)
                             end)
   end
 
-  def find(type: nil, title: nil, number: nil, **args)
+  private
+
+  def find(labels: nil, title: nil, number: nil)
     issues.find do |issue|
-      issue.match?(type: type, title: title) ||
+      issue.match?(labels: labels, title: title) ||
       issue.match?(number: number.to_i)
     end
   end
 
   def issues
     @issues ||= client.
-                issues(tracker.repo_name, query).
+                issues(tracker.repo_name, query: { state: statuses }).
                 map do |issue_data|
                   Issue.new(tracker: tracker,
                             data:    issue_data)
                 end
   end
 
-  def issue_specified?(data)
-    (data[:type] && data[:title]) || data[:number]
-  end
-
   def client
     tracker.client
   end
+
+  def statuses=(other)
+    @statuses ||= other.nil? ? [:all] : other
+  end
 end
 end
 end

data/lib/hustle_and_flow/issue_trackers/github/tracker.rb

@@ -0,0 +1,63 @@
+require 'octokit'
+
+module  HustleAndFlow
+module  IssueTrackers
+module  Github
+class   Tracker
+  attr_accessor :client,
+                :repo
+
+  def initialize(repo:)
+    Octokit.auto_paginate = true
+
+    self.client = Octokit::Client.new(netrc: true)
+    self.repo   = repo
+  end
+
+  def repo_name
+    repo.base_name
+  end
+
+  # def ready_for_review(branch)
+  #
+  #   No issue number
+  #     Find by title
+  #   Has issue number
+  #     Find by number
+  #
+  #   Issue found
+  #     Issue closed
+  #       Ask to reopen issue
+  #     Issue open
+  #       Issue being reviewed
+  #       Issue not being reviewed
+  #   Issue not found
+  #     Ask to create issue
+  #
+  #   Lookup Pull Request from Issue and Version Number
+  #
+  #   Pull Request Found
+  #     How are PR's found?
+  #
+  #     PR Title Format: #15 v1 - My Issue Title
+  #
+  #     Pull Request Closed
+  #       Reopen PR
+  #     Pull Request Open
+  #       Use found PR
+  #   Pull Request Not Found
+  #     Create New PR
+  #
+  #   pull_request = PullRequest.find_or_create_from_branch_name(branch.name)
+  #   issue        = Issue.find_or_create_from_branch_name(branch.name)
+  #
+  #   issue.ready_for_review(reviewer_names: branch.overwritten_authors)
+  # end
+  #
+  # def update_pull_request(branch)
+  #   client.create_pull_request()
+  # end
+end
+end
+end
+end