octopolo 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2E4MmFlMWM0MTc2YTdkODhhMDc2ODcwNTU0OGY1MzBlZmM4N2ViYQ==
+  data.tar.gz: !binary |-
+    YjMwZWMyNmRjMWUxYmU1ZWJlMGU4MzExYjFiNzI3ZTdhZTAzYTgwMQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzBhYzM4NjM1YzYyOWEzMWJlNmVjZWM3Nzk2NGE4MTU5ZTI5MjBiY2Y5NTk1
+    MjZlY2ZlOWVmZjMyZmVkZWQzMzkxNDBjMjMwZmU4NTU4MTQxNTUxYjdkZTFh
+    NzBhOTE3MWE3Yjk3YTVhMjgzNTI4NWY3MWMzODNhZWY0MmRkNjk=
+  data.tar.gz: !binary |-
+    NjZkMTYyNGU1ZjNkMGRmZTk4YmExMmIyM2M3NzNkMGIxY2FkYjZkMDgwNTAy
+    NWIxMDE4ZWFjOGU5OGEyODIzOWFhMWE1Njg5NzAzODQ0OGU5MDQzY2RlMmQ4
+    YmU1ZGM4YzJlYmRlNjA0MmNlYTNiMjdhYmE1M2YzZGNkMTE1ZWI=

data/.gitignore

@@ -0,0 +1,21 @@
+.automation.yml
+.octopolo.yml
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+Gemfile.lock
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.ruby-gemset

@@ -0,0 +1 @@
+octopolo

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true  do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Sport Ngin
+
+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.markdown

@@ -0,0 +1,55 @@
+Octopolo
+========
+
+[![Build Status][build_status_image]][build_status]
+
+A set of Github workflow scripts.
+
+
+### GitHub Octopolo
+
+#### GitHub Setup
+
+Interactively set up your local machine for GitHub octopolo, including
+configuring your user-level setting and setting up a GitHub API token for our
+scripts to use.
+
+    octopolo-setup
+
+
+#### Create New Branch
+
+Create a new branch from the master branch and push it out to GitHub.
+
+    new-branch bug-123-something
+
+#### Create Pull Request for Current Branch
+
+Create a pull-request against the project's deploy branch, associating with the
+given GitHub issue, if one is provided.
+
+    pull-request
+
+#### Deploy Current Branch to Staging
+
+From within a bugfix branch, merge to the current staging branch.
+
+    stage-up
+
+#### Merge Release Into Your Branch
+
+From within a bugfix branch, merge the latest released code (or, optionally,
+another named branch) into your current branch.
+
+    sync-branch
+    sync-branch some-other-branch
+
+#### Review Changes In Releases
+
+Select from recent release tags and generate a link to the GitHub compare view.
+
+    compare-releases
+
+
+[build_status]: https://travis-ci.org/sportngin/octopolo
+[build_status_image]: https://travis-ci.org/sportngin/octopolo.svg?branch=master

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+# TODO dogfood this rake task and wrap it into a script that is tested and whatnot
+desc "Create new octopolo script"
+task :new, [:scriptname] do |t, args|
+  require "erb"
+  scriptname = args[:scriptname]
+
+  if scriptname.nil? or scriptname.empty?
+    puts "Must provide a script name, e.g., rake new[do_something]"
+  else
+    # turn foo-bar into FooBar
+    class_file_name = scriptname.gsub(/[-]/, "_")
+    class_name = scriptname.split(/[_-]/).map(&:capitalize).join
+
+    puts "Creating a new script named #{scriptname} with a class named #{class_name}"
+
+    files = {
+      "templates/script.erb" => "bin/#{scriptname}",
+      "templates/lib.erb" => "lib/octopolo/scripts/#{class_file_name}.rb",
+      "templates/spec.erb" => "spec/octopolo/scripts/#{class_file_name}_spec.rb",
+    }
+
+    files.each do |template_path, output_path|
+      base_path = File.dirname(__FILE__)
+      template_file = File.expand_path(template_path, base_path)
+      output_file = File.expand_path(output_path, base_path)
+      perms = output_path.include?("bin/") ? 0755 : 0666
+
+      puts "writing to #{output_path}"
+      File.open(output_file, "w+", perms) do |f|
+        f.write(ERB.new(File.read(template_file)).result(binding))
+      end
+    end
+
+  end
+end

data/bash_completion.sh

@@ -0,0 +1,13 @@
+_op() {
+  cur="${COMP_WORDS[COMP_CWORD]}"
+
+  if [[ -z $OCTOPOLO_0_0_1_COMMANDS ]]; then
+    OCTOPOLO_0_0_1_COMMANDS=`op help -c`
+  fi
+
+  COMPREPLY=($(compgen -W "${OCTOPOLO_0_0_1_COMMANDS}" -- ${cur}))
+  return 0
+}
+
+complete -F _op op
+complete -F _op octopolo

data/bin/octopolo

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gli'
+require_relative '../lib/octopolo'
+
+include GLI::App
+
+program_desc 'GitHub workflow scripts.  From the Ngineers as SportNgin.'
+version Octopolo::VERSION
+
+wrap_help_text :verbatim
+
+program_long_desc """
+DOCUMENTATION
+    For documentation and help in setting up your configuration files,
+    see Octopolo's GitHub repo: https://github.com/sportngin/octopolo
+"""
+
+commands_from File.expand_path(File.dirname(__FILE__) + '/../lib/octopolo/commands')
+
+exit run(ARGV)

data/bin/op

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gli'
+require_relative '../lib/octopolo'
+
+include GLI::App
+
+program_desc 'GitHub workflow scripts.  From the Ngineers as SportNgin.'
+version Octopolo::VERSION
+
+wrap_help_text :verbatim
+
+program_long_desc """
+DOCUMENTATION
+    For documentation and help in setting up your configuration files,
+    see Octopolo's GitHub repo: https://github.com/sportngin/octopolo
+"""
+
+commands_from File.expand_path(File.dirname(__FILE__) + '/../lib/octopolo/commands')
+
+exit run(ARGV)

data/lib/octopolo.rb

@@ -0,0 +1,15 @@
+require "readline"
+require "octokit"
+require "hashie"
+require_relative "octopolo/cli"
+require_relative "octopolo/config"
+require_relative "octopolo/version"
+require_relative "octopolo/convenience_wrappers"
+
+module Octopolo
+
+  def self.config
+    @config ||= Octopolo::Config.parse
+  end
+
+end

data/lib/octopolo/changelog.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+
+module Octopolo
+  class Changelog
+    attr_reader :filename
+
+    def initialize(filename="CHANGELOG.markdown")
+      @filename = filename
+    end
+
+    def readlines
+      File.readlines(@filename)
+    end
+
+    def open
+      FileUtils.touch(@filename) unless File.exists?(@filename)
+      File.copy_stream(@filename,'old_changelog')
+      File.open('old_changelog', 'r') do |old_changelog|
+        File.open(@filename, 'w') do |changelog|
+          yield changelog
+          old_changelog.each_line { |line| changelog.puts line }
+        end
+      end
+      File.delete('old_changelog')
+    end
+  end
+end

data/lib/octopolo/cli.rb

@@ -0,0 +1,210 @@
+require "open3"
+require "highline"
+
+module Octopolo
+  # Public: Class to perform cli-related tasks, like performing commands.
+  class CLI
+    # Public: Perform the given shell command.
+    #
+    # command - A String containing the command to perform.
+    # say_command - A Boolean determining whether to display the performed command to the screen. (default: true)
+    #
+    # Examples
+    #
+    #   CLI.perform "git pull", false
+    #   git pull
+    #   Already up-to-date.
+    #   # => "Already up-to-date."
+    #
+    #   CLI.perform "git pull", false
+    #   # => "Already up-to-date."
+    #
+    # Returns the output of the command as a String.
+    def self.perform(command, say_command = true)
+      # display the command
+      say command if say_command
+      # and then perform it
+      if Open3.respond_to?(:capture3)
+        output, error, status = Open3.capture3(command)
+      else
+        # Only necessary as long as we use 1.8.7, which doesn't have Open3.capture3
+        output = `#{command}`
+      end
+
+      # speak the output
+      say output if say_command
+      # return the output of the command
+      output
+    rescue => e
+      say "Unable to perform '#{command}': #{e.message}"
+    end
+
+    # Public: Perform the command, but do not print out the command
+    #
+    # command - A String containing the command to perform.
+    #
+    # Examples
+    #
+    #   CLI.perform_quietly "git pull"
+    #   Already up-to-date.
+    #   # => "Already up-to-date."
+    def self.perform_quietly command
+      perform command, false
+    end
+
+    # Public: Replace the current process with the given shell command.
+    #
+    # command - A String containing the command to perform.
+    #
+    # Returns nothing and exits the current Ruby process.
+    def self.perform_and_exit(command)
+      say command
+      # Kernel#exec replaces the ruby process with the new bash process
+      # executing the command. This is useful for us mainly for things like
+      # calling `ssh` which will be interactive or `hub` which will open a text
+      # editor. Those commands don't play well with Kernel#` or Open3.capture3.
+      exec command
+    end
+
+    # Public: Display the given message.
+    #
+    # message - A String containig the message to display.
+    #
+    # Examples
+    #
+    #   CLI.say "About to do something awesome"
+    #
+    #   CLI.say "This may take a moment..."
+    #
+    # Returns nothing.
+    def self.say(message)
+      unless message.nil? || message.empty?
+        puts message
+      end
+    end
+
+    # Public: Display a blank line
+    def self.spacer_line
+      say " "
+    end
+
+    # Public: Perform a set of commands in the given directory.
+    #
+    # Yields nothing.
+    #
+    # dir - A String indicating the path to perform the commands in.
+    #
+    # Examples
+    #
+    #   CLI.perform_in "~" do
+    #     CLI.perform "rm -Rf"
+    #   end
+    #
+    #   CLI.perform_in "/tmp" do
+    #     CLI.perform "ls"
+    #   end
+    #
+    # Returns nothing.
+    def self.perform_in(dir)
+      say "Performing in #{dir}:"
+      Dir.chdir(dir) do
+        yield
+      end
+    end
+
+    def self.ask(question, choices, skip_asking = false)
+      return choices.first if choices.size == 1
+
+      unless skip_asking
+        say question
+        choices.each_with_index do |choice, i|
+          say "#{i+1}) #{choice}"
+        end
+      end
+
+      selection = nil
+      while not choices.include?(selection)
+        selection = prompt
+        break if choices.include?(selection)
+        # if entering a 1-based index value
+        selection_index = selection.to_i - 1
+        selection = choices[selection_index] if selection_index >= 0
+        break if choices.include?(selection)
+        say "Not a valid choice."
+      end
+
+      selection
+    end
+
+    # Public: Ask a yes or no question
+    #
+    # question - The question to display to the user in the prompt
+    #
+    # Returns a Boolean
+    def self.ask_boolean(question)
+      answer = prompt("#{question} (y/n)")
+      # basically accept anything that starts with Y as a yes answer
+      answer =~ /^y/i
+    end
+
+    def self.prompt prompt_text="> "
+      highline.ask prompt_text do |conf|
+        conf.readline = true
+      end.to_s
+    end
+
+    # Public: Prompt user for multiple lines of input
+    #
+    # prompt_text - The text to display before the prompt
+    #
+    # Example:
+    #
+    #   # Accept multiple lines of text, with the prompt "QA Plan:"
+    #   plan = CLI.prompt_multiline "QA Plan:"
+    #
+    # Returns a String containing the value the user entered
+    def self.prompt_multiline prompt_text
+      highline.ask(prompt_text) do |conf|
+        # accept text until the first blank line (instead of stopping at the
+        # first newline), to allow multiple lines of input
+        conf.gather = ""
+        conf.readline = true
+      end
+    end
+
+    # Public: Prompt user for input, but do not display what they type
+    #
+    # prompt_text - The text to display before the prompt; e.g., "Password: "
+    #
+    # Returns a String containing the value the user entered
+    def self.prompt_secret prompt_text
+      highline.ask(prompt_text) do |conf|
+        # do not display the text input
+        conf.echo = false
+        conf.readline = true
+      end
+    end
+
+    def self.copy_to_clipboard(input)
+      say "Putting '#{input}' on the clipboard."
+      # have to do this all roundy-abouty by passing to /bin/bash, because by default, ruby performs commands with /bin/sh, which doesn't respect the -n flag on echo
+      # http://stackoverflow.com/questions/5059039/ruby-execute-shell-command-echo-with-n-option
+      perform "/bin/bash -c 'echo -n #{input}' | pbcopy", false
+    end
+
+    # Public: Open the given path with Mac OS X's built-in `open` command
+    def self.open path
+      perform_and_exit "open '#{path}'"
+    end
+
+    # Public: Instantiate an instance of HighLine
+    #
+    # This is likely a temporary method until we replace a lot of CLI's guts
+    # with HighLine equivalents.
+    #
+    # Returns an instance of HighLine
+    def self.highline
+      HighLine.new
+    end
+  end
+end