startling 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8af8796ba134784e1a43a9cc6afe4206089989b
-  data.tar.gz: cd4fd0ad6d0a46f235acad5d66c1721cafb3cac0
+  metadata.gz: 6f04b6e9ac2708a21d861de715b8c0533465265d
+  data.tar.gz: cf63e7176023764951ac7082ed88acb9222ad773
 SHA512:
-  metadata.gz: f9d77f0b239694944fca9d5cfbeb415d370c81952c23a262adecfbb7fac3839378c2ccdb10f695db4297dccf083f32ddd83fdbf35013067b7a26d8a327317b87
-  data.tar.gz: a13542fc2890aa0f63a873b1c6d69a72e0eb7e469105012f7e4c68cb4ad0cc3a98963587f66ddbfebbc3511b84a65c9b139fb00ff7630da204f134fa6f8306f9
+  metadata.gz: 1fbb64b4d9071f7e17b86815e61d71ed216868630baad8749c6121235846fb62364340001982673980a9e25ec13a90e0daefc97d8350c53f969eb4d26b95c400
+  data.tar.gz: 9c7f0484384773d10a17ffd99913f0415e9efee1bebc5deadf8c6b6b906548b86517d4cf3f380023102ec8453a7f701ac6be24e84e2f87a774f6c75fe8e4b9f2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at startling@substantial.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,5 +1,15 @@
 # Startling
 
+Utility script for starting a story from a Github repository.
+
+1. Checks WIP limit. (optional)
+1. Starts the story in your project management tool (optional).
+   [Pivotal Tracker](https://rubygems.org/gems/startling_pivotal) and
+   [Trello](https://rubygems.org/gems/startling_trello) are
+   supported.
+1. Creates a branch if the specified branch does not already exist.
+1. Opens a pull request on Github.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,29 +25,21 @@ Or install it yourself as:
     $ gem install startling
 
 Generate configuration file in rails. 
-Use -H to generate a handler folder and -C to generate a commands folder
+Use -H to generate a handlers directory and -C to generate a commands directory
 
     $ rails g startling:configuration 
 
 ## Configuration
 
-Startlingfile.rb or startlingfile.rb should be defined in the root of the project. It can contain a block for configuration:
+Startlingfile.rb or startlingfile.rb should be defined in the root of the
+project. It can contain a block for configuration:
 
 ```ruby
 Startling.configure do |config|
-  # WIP Limit
-  # config.wip_limit = 4
-
-  # Labels for WIP pull requests
-  # config.wip_labels = ["WIP", "REVIEW"]
-
-  # Repos to check against for WIP limit
-  # config.repos << "substantial/startling"
-
   # Commands to be run before a story is stared
   # config.hook_commands.before_story_start = [:check_wip]
 
-  # Command to be run after a story has started
+  # Commands to be run after a story has started
   # config.hook_commands.after_story_start = []
 
   # Commands to be run before a pull request is created
@@ -49,42 +51,161 @@ Startling.configure do |config|
   # Handler used to start a provider specific story related to the pull request
   # config.story_handler = :pivotal_start
 
-  # Validate branch name with a Proc that returns a boolean
-  # config.validate_branch_name = -> (branch_name) { /feature\/.*/ =~ branch_name }
+  # Handler used for setting the title and body of a pull request
+  # config.pull_request_handler = :default_pull_request_handler
+end
+```
 
-  # Message for pull request commit
-  # config.pull_request_commit_message = "Startling"
+### 1. WIP limit
 
-  # Message for pull request body
-  # config.pull_request_body = "Startling Body"
+WIP is calculated by the number of pull requests open in the repository. 
 
-  # Labels for a pull request
-  # config.pull_request_labels = [WIP, REVIEW, HOLD]
+Set WIP limit:
 
-  # Handler used for setting the title and body of a pull request
-  #config.pull_request_handler = :custom_pull_request_handler
-end
+```ruby
+config.wip_limit = 4
+```
+
+### 2. WIP labels
+
+You can limit the pull requests included in WIP by configuring the pull request
+labels for WIP.
+
+```ruby
+config.wip_labels = ["WIP", "REVIEW"]
+```
+
+### 3. WIP repositories
+
+WIP limit can be checked across multiple Github repositories. Use the same
+branch name across repositories to count multiple pull requests as only one WIP.
+
+```ruby
+config.repos << "substantial/startling"
+```
+
+### 4. Check the WIP limit before starting a story:
+
+```ruby
+config.hook_commands.before_story_start = [:check_wip]
+```
+
+### 5. Branch name
+
+You can check the branch name being used with a custom Proc. For example, this
+Proc only allows branches that are prefixed with `feature/`:
+
+```ruby
+config.validate_branch_name = -> (branch_name) { /feature\/.*/ =~ branch_name }
+```
+
+### 6. Pull request commit message
+
+If the branch is newly created, Startling must create an empty commit in order
+to open a pull request. The commit message for the empty commit can be set:
+
+```ruby
+config.pull_request_commit_message = "Startling"
+```
+
+### 7. Pull request description
+
+You will be prompted to set a title for the pull request, but the pull request
+description is set to a default value that can be configured:
+
+```ruby
+config.pull_request_body = "Startling Body"
+```
+
+### 8. Pull request labels
+
+You can set one or more labels on the pull request:
+
+```ruby
+config.pull_request_labels = [WIP, REVIEW, HOLD]
+
+config.hook_commands.after_pull_request = [:label_pull_request]
 ```
 
 ## Usage
 
 Start a new story with a given story id
 
-    $ start 12345
+    $ start '#12345'
 
 Start a new story with a given story id and branch name
 
-    $ start 12345 foo
+    $ start '#12345' foo
+
+Check WIP
+
+    $ wip
+
+## Commands
+
+Commands are custom Ruby scripts that can be run at various stages of Startling.
+
+1. Before the story is started
+1. After the story is started
+1. Before the pull request is opened
+1. After the pull request is opened
+
+### Creating a custom command
+
+Custom commands should be put in the startling/commands directory. Create a
+Ruby class that inherits from the Startling::Commands::Base class and
+implements an execute method. Add your command class to the corresponding
+config value for the stage in which your command should be executed.
+
+```ruby
+config.hook_commands.before_story_start = [:check_wip]
+```
+
+## Handlers
+
+Handlers allow for customization of Startling behavior.
+
+Existing handlers:
+
+1. PullRequestHandler
+
+Handles setting the title and description of the pull request and setting the
+commit message for the empty commit.
+
+### Creating a custom handler
+
+Custom handlers should be put in the startling/handlers directory.
+
+1. PullRequestHandler
+
+Create a Ruby class that inherits from the PullRequestHandler::Base class. Set
+`pull_request_handler` config value to your handler class.
+
+```ruby
+config.pull_request_handler = :default_pull_request_handler
+```
+
+## Development
+
+After checking out the repo, run `cd startling/startling && bin/setup` to
+install dependencies. Create `.env` from the Secure Note `startling .env` in
+LastPass. Then, run `rake spec` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to experiment.
 
-TODO: Write usage instructions here
+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
 
-1. Create `.env` from the Secure Note `startling .env` in
-   LastPass.
-1. `gem install bundler`
-1. `bundle install`
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/substantial/startling. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-### Running tests
+## License
 
-`rake`
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "startling"
+
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/generators/startling/configuration_generator.rb

@@ -1,5 +1,6 @@
 require 'rails/generators'
 require 'rails/generators/base'
+require 'startling'
 
 module Startling
   module Generators
@@ -19,7 +20,7 @@ module Startling
 
       def create_startling_folders
         pull_request_handler_file = "#{destination_root.split('/').last.underscore}_pull_request_handler"
-        create_file "startlingfile.rb" do
+        create_file Startling::Configuration::DEFAULT_STARTLINGFILES[0] do
 <<CONFIG
 Startling.configure do |config|
   # WIP Limit
@@ -34,7 +35,7 @@ Startling.configure do |config|
   # Commands to be run before a story is stared
   # config.hook_commands.before_story_start = [:check_wip]
 
-  # Command to be run after a story has started
+  # Commands to be run after a story has started
   # config.hook_commands.after_story_start = []
 
   # Commands to be run before a pull request is created
@@ -59,7 +60,7 @@ Startling.configure do |config|
   # config.pull_request_labels = [WIP, REVIEW, HOLD]
 
   # Handler used for setting the title and body of a pull request
-  #config.pull_request_handler = :#{pull_request_handler_file}
+  # config.pull_request_handler = :#{pull_request_handler_file}
 end
 CONFIG
         end

data/lib/startling/configuration.rb

@@ -22,6 +22,14 @@ module Startling
       :validate_branch_name, :pull_request_body, :pull_request_handler,
       :pull_request_labels, :pull_request_commit_message, :cli_options
 
+    # Pivotal
+    DEFAULT_VALID_ESTIMATES = [1, 2, 3]
+
+    attr_accessor :valid_estimates
+
+    # Trello
+    attr_accessor :developer_public_key, :doing_list_id
+
     def initialize
       @cache_dir = Dir.pwd
       @root_dir = Dir.pwd
@@ -35,6 +43,13 @@ module Startling
       @pull_request_commit_message = DEFAULT_COMMIT_MESSAGE
       @pull_request_labels = []
       @cli_options = []
+
+      # Pivotal
+      @valid_estimates = DEFAULT_VALID_ESTIMATES
+
+      # Trello
+      @developer_public_key = nil
+      @doing_list_id = nil
     end
 
     def self.load_configuration

data/lib/startling/version.rb

@@ -1,3 +1,3 @@
 module Startling
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/startling.gemspec

@@ -6,26 +6,25 @@ require 'startling/version'
 Gem::Specification.new do |spec|
   spec.name          = "startling"
   spec.version       = Startling::VERSION
-  spec.authors       = ["Aaron Jensen", "Shaun Dern", "Jeff Forde"]
-  spec.email         = ["tchdevs@substantial.com"]
-  spec.description   = %q{script for startling a story}
+  spec.authors       = ["Aaron Jensen", "Shaun Dern", "Jeff Forde", "Cassie Koomjian"]
+  spec.email         = ["startling@substantial.com"]
   spec.summary       = %q{script for startling a story}
   spec.homepage      = ""
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "vcr", "~> 2.9"
   spec.add_development_dependency "webmock", "~> 1.20"
-  spec.add_development_dependency "excon"
-  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "excon", "~> 0.45"
+  spec.add_development_dependency "dotenv", "~> 2.1"
 
   spec.add_dependency "octokit", "~> 4.2"
   spec.add_dependency "highline", "~> 1.6"

metadata

@@ -1,45 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: startling
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Aaron Jensen
 - Shaun Dern
 - Jeff Forde
+- Cassie Koomjian
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,16 +59,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -100,30 +101,30 @@ dependencies:
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.45'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -208,9 +209,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.3
-description: script for startling a story
+description: 
 email:
-- tchdevs@substantial.com
+- startling@substantial.com
 executables:
 - start
 - wip
@@ -218,12 +219,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".ruby-gemset"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/start
-- bin/wip
+- bin/console
+- bin/setup
+- exe/start
+- exe/wip
 - lib/generators/startling/configuration_generator.rb
 - lib/startling.rb
 - lib/startling/cache.rb
@@ -251,23 +255,6 @@ files:
 - lib/startling/version.rb
 - lib/startling/work.rb
 - lib/startling/work_printer.rb
-- spec/spec_helper.rb
-- spec/startling/command_spec.rb
-- spec/startling/commands/base_spec.rb
-- spec/startling/commands/create_branch_spec.rb
-- spec/startling/commands/create_pull_request_spec.rb
-- spec/startling/configuration_spec.rb
-- spec/startling/git_local_spec.rb
-- spec/startling/github/pull_request_spec.rb
-- spec/startling/handlers/default_pull_request_handler_spec.rb
-- spec/startling/time_format_helpers_spec.rb
-- spec/startling_configuration_spec.rb
-- spec/startling_spec.rb
-- spec/support/dotenv.rb
-- spec/support/tokens.rb
-- spec/support/vcr.rb
-- spec/vcr_cassettes/bin_start_starts_stories.yml
-- spec/vcr_cassettes/bin_start_starts_stories_pr_body.yml
 - startling.gemspec
 homepage: ''
 licenses:
@@ -293,21 +280,4 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: script for startling a story
-test_files:
-- spec/spec_helper.rb
-- spec/startling/command_spec.rb
-- spec/startling/commands/base_spec.rb
-- spec/startling/commands/create_branch_spec.rb
-- spec/startling/commands/create_pull_request_spec.rb
-- spec/startling/configuration_spec.rb
-- spec/startling/git_local_spec.rb
-- spec/startling/github/pull_request_spec.rb
-- spec/startling/handlers/default_pull_request_handler_spec.rb
-- spec/startling/time_format_helpers_spec.rb
-- spec/startling_configuration_spec.rb
-- spec/startling_spec.rb
-- spec/support/dotenv.rb
-- spec/support/tokens.rb
-- spec/support/vcr.rb
-- spec/vcr_cassettes/bin_start_starts_stories.yml
-- spec/vcr_cassettes/bin_start_starts_stories_pr_body.yml
+test_files: []