aid 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 364445296a94aa6258e1a9d4460cd5102d5f23e2
-  data.tar.gz: c6cc1caf09b1ecab073e930c6d71a2d904ba6da5
+SHA256:
+  metadata.gz: 993f88f2e0e6fa2b82b2e0f0282ce3f59d60d7ad49f236dd11ba1a8aa4f75aeb
+  data.tar.gz: 93fdf4f041e88d9906af88b01521f9e04b4a48715a9652a03a0dce330b9e4b7c
 SHA512:
-  metadata.gz: 84bae2584c00206dbbd3debd1f446d43208f2514e3928863ccf60e9a5ddb37d3d87c95c8f5aa9adc6977788ba1b0553918b8c6c02b72e7aee40ab7a5d14860c0
-  data.tar.gz: 9dde22ee384ba50a8d2a383cdf1437bba2e500f2ce7710564ab2351340b3bbb6c3da22f97db421dd68c6890d2b57b2227a2b51163f26114e348aaa7fc1ea065f
+  metadata.gz: 7663785bb164b3f775505aec9cd288d57347dfcff6be51ba1fab309030ed49cd913ee7e1b2473b4734ef11c33c5eded71d4c8e37207f7ae9fd490654c067d898
+  data.tar.gz: b585a2dbea6e35a8de76c38a3aea699d4fc24125c4b931206c652a4c90b228988b05ff6792000fe4310083167ca45365382637d21570c7e56663b4cd2d742479

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require: []
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'examples/*.rb'
+    - 'spec/plugins/**/*'
+
+Layout/AlignHash:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false

data/.solargraph.yml

@@ -0,0 +1,18 @@
+---
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - rubocop
+  - require_not_found
+plugins:
+  - runtime
+require_paths:
+  - spec
+max_files: 7000

data/.travis.yml

@@ -1,5 +1,12 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.3
+  - 2.6.3
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,8 +1,16 @@
-[0.1.3](https://github.com/dbalatero/aid/tag/0.1.3)
+[0.2.0](https://github.com/dbalatero/aid/tag/0.2.0)
 
 #### New features:
-* Added `$project_root/.aid` to the load path so aid loads top-level scripts while in subdirectories
-* Added `within_dir` convenience method to `Aid::Script`
+* Sorted the list of commands in the `aid help` output
+* Will auto-load an `.aid/config.rb` file last if present
+* Added auto-fixing support to `aid doctor`
+* Added plugin loading support for gems prefixed with `aid-`
+
+### Dev changes:
+* Added Rubocop config
+* Changed Travis CI to build on Ruby 2.6
+* Configured solargraph
+* Added CI build badge
 
 [0.1.2](https://github.com/dbalatero/aid/tag/0.1.2)
 

data/Gemfile

@@ -1,8 +1,16 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 git_source(:github) do |repo_name|
   "https://github.com/#{repo_name}"
 end
 
-# Specify your gem's dependencies in aide.gemspec
+# Specify your gem's dependencies in aid.gemspec
 gemspec
+
+group :development do
+  gem 'aid-foo',
+      require: false,
+      path: File.dirname(__FILE__) + '/spec/plugins/aid-foo'
+end

data/README.md

@@ -1,5 +1,7 @@
 # Aid
 
+[![Build Status](https://travis-ci.com/dbalatero/aid.svg?branch=master)](https://travis-ci.com/dbalatero/aid)
+
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aid`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/aid.gemspec

@@ -1,27 +1,30 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "aid/version"
+require 'aid/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "aid"
+  spec.name          = 'aid'
   spec.version       = Aid::VERSION
-  spec.authors       = ["David Balatero"]
-  spec.email         = ["dbalatero@gmail.com"]
+  spec.authors       = ['David Balatero']
+  spec.email         = ['dbalatero@gmail.com']
 
-  spec.summary       = %q{A library to make repo scripts easy and discoverable.}
-  spec.homepage      = "https://github.com/dbalatero/aid"
-  spec.license       = "MIT"
+  spec.summary       = 'A library to make repo scripts easy and discoverable.'
+  spec.homepage      = 'https://github.com/dbalatero/aid'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "aide"
+require 'bundler/setup'
+require 'aid'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "aide"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/examples/begin.rb

@@ -1,6 +1,8 @@
-require "json"
-require "tempfile"
-require "fileutils"
+# frozen_string_literal: true
+
+require 'json'
+require 'tempfile'
+require 'fileutils'
 
 require_relative './shared/pivotal'
 require_relative './shared/git_config'
@@ -9,24 +11,21 @@ class Begin < Aid::Script
   include GitConfig
 
   def self.description
-    "Starts your Pivotal Tracker story and opens a new PR on Github"
+    'Starts your Pivotal Tracker story and opens a new PR on Github'
   end
 
   def self.help
     <<~EOF
-    aid begin #{colorize(:light_blue, "[story id] [branch name]")}
-
-    Example: $ #{colorize(:light_blue, 'aid begin "#133717234"')}
-
-    This command will start your Pivotal Tracker story for you, open a pull
-    request on Github, and copy over the Pivotal Tracker story description to
-    the Github pull request description. As well, any tasks in your
-    Pivotal Tracker story will automatically become [x] checkbox tasks on the
-    Github PR.
-
-    * All branch names will be auto-converted to kebab-case, lowercase
-    * Passing story id/branch name as arguments are optional - if
-      they are missing, you'll be prompted.
+      aid begin #{colorize(:light_blue, '[story id] [branch name]')}
+       Example: $ #{colorize(:light_blue, 'aid begin "#133717234"')}
+       This command will start your Pivotal Tracker story for you, open a pull
+      request on Github, and copy over the Pivotal Tracker story description to
+      the Github pull request description. As well, any tasks in your
+      Pivotal Tracker story will automatically become [x] checkbox tasks on the
+      Github PR.
+       * All branch names will be auto-converted to kebab-case, lowercase
+      * Passing story id/branch name as arguments are optional - if
+        they are missing, you'll be prompted.
     EOF
   end
 
@@ -37,7 +36,7 @@ class Begin < Aid::Script
     check_for_hub_credentials!
     check_for_pivotal_credentials!
 
-    step "Starting the story" do
+    step 'Starting the story' do
       if story_id
         pivotal_start(story_id)
       else
@@ -48,7 +47,7 @@ class Begin < Aid::Script
     reset_hard_to_master!
     create_git_branch
 
-    step "Pushing to Github" do
+    step 'Pushing to Github' do
       make_empty_commit
       push_branch_to_github
     end
@@ -60,11 +59,11 @@ class Begin < Aid::Script
   private
 
   def remove_story_id_from_master_branch
-    FileUtils.rm_rf("tmp/.pivo_flow/stories/master")
+    FileUtils.rm_rf('tmp/.pivo_flow/stories/master')
   end
 
   def check_for_clean_git_workspace!
-    unless system("git diff-index --quiet HEAD --")
+    unless system('git diff-index --quiet HEAD --')
       header = colorize :red, <<~HEADER
         You have unstaged changes in your git repository. Please commit or
         stash them first.
@@ -75,14 +74,14 @@ class Begin < Aid::Script
   end
 
   def reset_hard_to_master!
-    silent "git checkout master",
-      "git fetch origin",
-      "git reset --hard origin/master"
+    silent 'git checkout master',
+           'git fetch origin',
+           'git reset --hard origin/master'
   end
 
   def create_git_branch
-    step "Creating git branch" do
-      system! "bundle exec pf branch"
+    step 'Creating git branch' do
+      system! 'bundle exec pf branch'
     end
   end
 
@@ -98,7 +97,7 @@ class Begin < Aid::Script
   end
 
   def project_id
-    @project_id ||= git_config("pivo-flow.project-id")
+    @project_id ||= git_config('pivo-flow.project-id')
   end
 
   def branch_name
@@ -106,7 +105,7 @@ class Begin < Aid::Script
   end
 
   def default_tasks
-    ["Add your tasks here"]
+    ['Add your tasks here']
   end
 
   def pivotal_tasks
@@ -114,7 +113,7 @@ class Begin < Aid::Script
 
     @pivotal_tasks = begin
       tasks = pivotal
-        .request("/projects/#{project_id}/stories/#{story_id}/tasks")
+              .request("/projects/#{project_id}/stories/#{story_id}/tasks")
 
       return nil if tasks.empty?
 
@@ -146,28 +145,28 @@ class Begin < Aid::Script
       story['url']
     ]
 
-    story_description = story["description"]
+    story_description = story['description']
 
     if story_description
-      parts << "# Description"
+      parts << '# Description'
       parts << story_description
     end
 
-    parts << "## TODO"
+    parts << '## TODO'
     parts << formatted_task_list
 
     parts.join("\n\n").strip
   end
 
   def open_pull_request_on_github!
-    step "Opening pull request..." do
-      tempfile = Tempfile.new("begin_pull_request")
+    step 'Opening pull request...' do
+      tempfile = Tempfile.new('begin_pull_request')
 
       begin
         tempfile.write(pull_request_description)
         tempfile.close
 
-        labels = ["WIP", story["story_type"]].join(",")
+        labels = ['WIP', story['story_type']].join(',')
 
         url = `hub pull-request -F #{tempfile.path} -l "#{labels}" -a "" -o`
 
@@ -180,15 +179,13 @@ class Begin < Aid::Script
     end
   end
 
-  private
-
   def silent(*cmds)
     cmds.each { |cmd| system("#{cmd} >/dev/null 2>&1") }
   end
 
   def command?(name)
     `which #{name}`
-    $?.success?
+    $CHILD_STATUS.success?
   end
 
   def prompt(msg)
@@ -200,18 +197,19 @@ class Begin < Aid::Script
 
   def normalized_branch_name(branch_name)
     branch_name
-      .gsub(/[^\w\s-]/, "")
-      .gsub(/\s+/, "-")
+      .gsub(/[^\w\s-]/, '')
+      .gsub(/\s+/, '-')
       .downcase
-      .gsub(/-*$/, "") # trailing dashes
+      .gsub(/-*$/, '') # trailing dashes
   end
 
   def check_for_hub!
-    if !command?("hub")
-      download_url = "https://github.com/github/hub/releases"\
-        "/download/v2.3.0-pre10/hub-darwin-amd64-2.3.0-pre10.tgz"
+    return if command?('hub')
 
-      abort <<~EOF
+    download_url = 'https://github.com/github/hub/releases'\
+      '/download/v2.3.0-pre10/hub-darwin-amd64-2.3.0-pre10.tgz'
+
+    abort <<~HELP
       You need to install `hub` before you can use this program.
       We use a pre-release version of hub as it adds some additional
       flags to `hub pull-request`.
@@ -219,18 +217,15 @@ class Begin < Aid::Script
       To fix:
 
         Download it at #{download_url}
-
         Untar the downloaded tarball, cd to the directory, and run:
-
         $ ./install
-      EOF
-    end
+    HELP
   end
 
   def check_for_hub_credentials!
     config_file = "#{ENV['HOME']}/.config/hub"
     credentials_exist = File.exist?(config_file) &&
-      File.read(config_file).match(/oauth_token/i)
+                        File.read(config_file).match(/oauth_token/i)
 
     unless credentials_exist
       abort <<~EOF
@@ -246,20 +241,20 @@ class Begin < Aid::Script
 
   def check_for_pivotal_credentials!
     config_abort_if_blank!(
-      "pivo-flow.api-token",
+      'pivo-flow.api-token',
       api_token,
-      "You can find this value in your user Profile section on Pivotal."
+      'You can find this value in your user Profile section on Pivotal.'
     )
 
     config_abort_if_blank!(
-      "pivo-flow.project-id",
+      'pivo-flow.project-id',
       project_id,
-      "Please run: $ git config pivo-flow.project-id 2092669"
+      'Please run: $ git config pivo-flow.project-id 2092669'
     )
   end
 
   def interactive_prompt_for_story
-    system "bundle exec pf stories"
+    system 'bundle exec pf stories'
     @story_id = `bundle exec pf current`.strip
   end
 
@@ -268,11 +263,11 @@ class Begin < Aid::Script
   end
 
   def story_id
-    @story_id ||= argv.first&.gsub(/[^\d]/, "")
+    @story_id ||= argv.first&.gsub(/[^\d]/, '')
   end
 
   def api_token
-    @api_token ||= git_config("pivo-flow.api-token")
+    @api_token ||= git_config('pivo-flow.api-token')
   end
 
   def pivotal