abtion-aid 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a1339e7c88c58cb0b3e6bd78f80b381433f50075466af838e62b53352ffec23
+  data.tar.gz: 673ba5a521e3e86853c9acbeaa46d7dccf3000faea06fa47ce5321c0b82f4eca
+SHA512:
+  metadata.gz: eeaebd179113a9cb4ac6f52c1789b1f20286a428c6c0d1bb380322c91519e99663988e403ddb048fea646f923a4f6773560e30a014f69e3e61d0ecde11236701
+  data.tar.gz: d35bb798022f67a5f91c550cd0b6b526a84c548992454061ae1a7e9b22ba3e4e902331b254dd95faa3c7266621670d9fa0fcf90e37f2a17c73e65c853e5df4fc

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.aid
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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

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

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+[0.2.0](https://github.com/dbalatero/aid/tag/0.2.0)
+
+#### New features:
+* 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)
+
+#### New features:
+* Added instance methods for help and description to `Aid::Script`
+
+[0.1.1](https://github.com/dbalatero/aid/tag/0.1.1)
+
+#### New features:
+* Added doctor script
+
+#### Bug fixes:
+* Allow subclassing a Script

data/Gemfile

@@ -0,0 +1,16 @@
+# 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 aid.gemspec
+gemspec
+
+group :development do
+  gem 'aid-foo',
+      require: false,
+      path: File.dirname(__FILE__) + '/spec/plugins/aid-foo'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Balatero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aid
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dbalatero/aid.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/aid.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'abtion-aid'
+  spec.version       = Aid::VERSION
+  spec.authors       = ['Abtion', 'David Balatero']
+  spec.email         = ['mail@abtion.com']
+
+  spec.summary       = 'A library to make repo scripts easy and discoverable.'
+  spec.homepage      = 'https://github.com/abtion/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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  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

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/begin.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'tempfile'
+require 'fileutils'
+
+require_relative './shared/pivotal'
+require_relative './shared/git_config'
+
+class Begin < Aid::Script
+  include GitConfig
+
+  def self.description
+    '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.
+    EOF
+  end
+
+  def run
+    check_for_clean_git_workspace!
+
+    check_for_hub!
+    check_for_hub_credentials!
+    check_for_pivotal_credentials!
+
+    step 'Starting the story' do
+      if story_id
+        pivotal_start(story_id)
+      else
+        interactive_prompt_for_story
+      end
+    end
+
+    reset_hard_to_master!
+    create_git_branch
+
+    step 'Pushing to Github' do
+      make_empty_commit
+      push_branch_to_github
+    end
+
+    open_pull_request_on_github!
+    remove_story_id_from_master_branch
+  end
+
+  private
+
+  def remove_story_id_from_master_branch
+    FileUtils.rm_rf('tmp/.pivo_flow/stories/master')
+  end
+
+  def check_for_clean_git_workspace!
+    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.
+      HEADER
+
+      abort "#{header}\n\n#{`git status`}"
+    end
+  end
+
+  def reset_hard_to_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'
+    end
+  end
+
+  def make_empty_commit
+    silent(
+      'git commit --allow-empty -m "Initial commit for story #' +
+        story_id + ' [ci skip]"'
+    )
+  end
+
+  def push_branch_to_github
+    silent "git push -u origin #{branch_name}"
+  end
+
+  def project_id
+    @project_id ||= git_config('pivo-flow.project-id')
+  end
+
+  def branch_name
+    @branch_name ||= `git symbolic-ref HEAD 2>/dev/null | cut -d '/' -f3`.strip
+  end
+
+  def default_tasks
+    ['Add your tasks here']
+  end
+
+  def pivotal_tasks
+    return @pivotal_tasks if defined?(@pivotal_tasks)
+
+    @pivotal_tasks = begin
+      tasks = pivotal
+              .request("/projects/#{project_id}/stories/#{story_id}/tasks")
+
+      return nil if tasks.empty?
+
+      tasks.map { |task| task['description'] }
+    end
+  end
+
+  def tasks
+    pivotal_tasks || default_tasks
+  end
+
+  def formatted_task_list
+    checkbox_list(tasks)
+  end
+
+  def checkbox_list(items)
+    items
+      .map { |item| "- [ ] #{item}" }
+      .join("\n")
+  end
+
+  def story
+    @story ||= pivotal.request("/projects/#{project_id}/stories/#{story_id}")
+  end
+
+  def pull_request_description
+    parts = [
+      story['name'],
+      story['url']
+    ]
+
+    story_description = story['description']
+
+    if story_description
+      parts << '# Description'
+      parts << story_description
+    end
+
+    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')
+
+      begin
+        tempfile.write(pull_request_description)
+        tempfile.close
+
+        labels = ['WIP', story['story_type']].join(',')
+
+        url = `hub pull-request -F #{tempfile.path} -l "#{labels}" -a "" -o`
+
+        # Copy it to your clipboard
+        system("echo #{url} | pbcopy")
+        puts url
+      ensure
+        tempfile.unlink
+      end
+    end
+  end
+
+  def silent(*cmds)
+    cmds.each { |cmd| system("#{cmd} >/dev/null 2>&1") }
+  end
+
+  def command?(name)
+    `which #{name}`
+    $CHILD_STATUS.success?
+  end
+
+  def prompt(msg)
+    print "#{msg} > "
+    value = STDIN.gets.strip
+    puts
+    value
+  end
+
+  def normalized_branch_name(branch_name)
+    branch_name
+      .gsub(/[^\w\s-]/, '')
+      .gsub(/\s+/, '-')
+      .downcase
+      .gsub(/-*$/, '') # trailing dashes
+  end
+
+  def check_for_hub!
+    return if command?('hub')
+
+    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`.
+
+      To fix:
+
+        Download it at #{download_url}
+        Untar the downloaded tarball, cd to the directory, and run:
+        $ ./install
+    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)
+
+    unless credentials_exist
+      abort <<~EOF
+        Your GitHub credentials are not set. Run this command:
+
+          $ hub pull-request
+
+        and when prompted for login details, enter them. It will give you
+        an error at the end, but you can safely ignore it.
+      EOF
+    end
+  end
+
+  def check_for_pivotal_credentials!
+    config_abort_if_blank!(
+      'pivo-flow.api-token',
+      api_token,
+      'You can find this value in your user Profile section on Pivotal.'
+    )
+
+    config_abort_if_blank!(
+      'pivo-flow.project-id',
+      project_id,
+      'Please run: $ git config pivo-flow.project-id 2092669'
+    )
+  end
+
+  def interactive_prompt_for_story
+    system 'bundle exec pf stories'
+    @story_id = `bundle exec pf current`.strip
+  end
+
+  def pivotal_start(story_id)
+    system! "bundle exec pf start #{story_id}"
+  end
+
+  def story_id
+    @story_id ||= argv.first&.gsub(/[^\d]/, '')
+  end
+
+  def api_token
+    @api_token ||= git_config('pivo-flow.api-token')
+  end
+
+  def pivotal
+    @pivotal ||= Pivotal.new(api_token)
+  end
+end