startling 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b81828502a01ce8ee1ab14f367308fe5011fe1
-  data.tar.gz: 12ae20e6f491a62a5bfa6f927882d28ee0e9dd27
+  metadata.gz: 17935770cd88048b4d21b0e6a1228dbc893f1e10
+  data.tar.gz: 2daa700a446e7b6296dcfd24153e4ffc0e385f7f
 SHA512:
-  metadata.gz: d9afbd953c0d337b087bd92b293d61f7b93756ade4fc891b6264dad031bd1f47c0e792d007b5e84767bd98332fb281c5a23ee99164f3a7bd7f094c9443c01016
-  data.tar.gz: a7d1ae4c5c9711b1c0ea7f20b960cd4c54eed75bb14c1e4a47246382c23749939947b12ac836bb6c05971e43dbaecbfb47bf71b2dda68c04d30d04ec9db33a8b
+  metadata.gz: e3e44fe9f1b40cbc973ff5dd67eced7c15373ff87953ebe089214b7ac9928a3bf0ed0eda0f29df7b410e57916848c6e78ca3618cc51669527b3aeff134672602
+  data.tar.gz: a997e6be44acc04f2ec241f9c98c6222930d79244d4a004a94018b8eaa35aef79592490d88c2b131edd63c9ab1ccd385b84f6f0734a8f77b48fc949f14d80734

data/.ruby-gemset

@@ -1 +1 @@
-teaching-channel_start
+startling

data/README.md

@@ -25,13 +25,13 @@ Startlingfile.rb or startlingfile.rb should be defined in the root of the projec
 
 ```ruby
 Startling.configure do |config|
-  # WIP Limit 
+  # WIP Limit
   # config.wip_limit = 4
 
   # Repos to check against for WIP limit
   # config.repos << 'substantial/startling-dev'
 
-  # Valid story estimations 
+  # Valid story estimations
   # config.valid_estimates = [1, 2, 4, 8, 16, 32, 64, 128]
 
   # Commands to be run before a story is stared
@@ -47,11 +47,17 @@ Startling.configure do |config|
   # config.hook_commands.after_pull_request = []
 
   # Handler used to start a provider specific story related to the pull request
-  config.story_handler = :pivotal_start
+  # config.story_handler = :pivotal_start
+
+  # Validate branch name with a Proc that returns a boolean
+  # config.validate_branch_name = -> (branch_name) { /feature\/.*/ =~ branch_name }
 
   # Message for pull request commit
   # config.pull_request_commit_message = "Startling"
 
+  # Message for pull request body
+  # config.pull_request_body = "Startling Body"
+
   # Labels for a pull request
   # config.pull_request_labels = [WIP, REVIEW, HOLD]
 
@@ -76,3 +82,9 @@ TODO: Write usage instructions here
 
 1. Create `.env` from the Secure Note `startling .env` in
    LastPass.
+1. `gem install bundler`
+1. `bundle install`
+
+### Running tests
+
+`rake`

data/lib/generators/startling/configuration_generator.rb

@@ -46,6 +46,9 @@ 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 }
+
   # Message for pull request commit
   # config.pull_request_commit_message = "Startling"
 

data/lib/startling/commands/create_branch.rb

@@ -1,9 +1,13 @@
+require 'highline/import'
+require 'octokit'
 require_relative "base"
 
 module Startling
   module Commands
     class CreateBranch < Base
       def execute
+        abort "Branch name, #{branch_name}, is not valid" unless valid_branch_name?
+
         create_branch if branch_name != git.current_branch
         branch_name
       end
@@ -22,12 +26,29 @@ module Startling
       end
 
       def branch_name
-        abort "Branch name must be specified." if branch.empty?
-        @branch_name ||= "#{branch}".gsub(/\s+/, '-')
+        @branch_name ||= get_branch_name
+      end
+
+      def valid_branch_name?
+        (branch_name != default_branch) && custom_validate_branch_name
       end
 
       private
 
+      def get_branch_name
+        if branch.empty?
+          git.current_branch
+        else
+          "#{branch}".gsub(/\s+/, '-')
+        end
+      end
+
+      def custom_validate_branch_name
+        return true if Startling.validate_branch_name.nil?
+
+        Startling.validate_branch_name.call(branch_name)
+      end
+
       def branch
         @branch ||=
           if args.length > 1

data/lib/startling/commands/create_pull_request.rb

@@ -15,7 +15,11 @@ module Startling
 
       def open_pull_request
         puts "Opening pull request..."
-        git.create_empty_commit(pull_request_handler.commit_message)
+
+        if git.current_branch_has_no_commits?
+          git.create_empty_commit(pull_request_handler.commit_message)
+        end
+
         git.push_origin_head
 
         repo.open_pull_request title: pull_request_handler.title,

data/lib/startling/configuration.rb

@@ -17,8 +17,9 @@ module Startling
       'Startlingfile.rb'
     ].freeze
 
-    attr_accessor :cache_dir, :root_dir, :wip_limit, :repos, :story_handler, :pull_request_body,
-      :pull_request_handler, :pull_request_labels, :pull_request_commit_message, :cli_options
+    attr_accessor :cache_dir, :root_dir, :wip_limit, :repos, :story_handler,
+      :validate_branch_name, :pull_request_body, :pull_request_handler,
+      :pull_request_labels, :pull_request_commit_message, :cli_options
 
     def initialize
       @cache_dir = Dir.pwd
@@ -26,6 +27,7 @@ module Startling
       @wip_limit = DEFAULT_WIP_LIMIT
       @repos = []
       @story_handler = nil
+      @validate_branch_name = nil
       @pull_request_handler = nil
       @pull_request_body = DEFAULT_BODY
       @pull_request_commit_message = DEFAULT_COMMIT_MESSAGE

data/lib/startling/git_local.rb

@@ -1,3 +1,4 @@
+require 'shellwords'
 require_relative 'shell'
 
 module Startling
@@ -23,7 +24,7 @@ module Startling
     end
 
     def create_empty_commit(message)
-      Shell.run "git commit --allow-empty -m #{message}"
+      Shell.run "git commit --allow-empty -m #{Shellwords.escape(message)}"
     end
 
     def create_remote_branch(branch_name, base_branch: 'origin/master')
@@ -48,10 +49,18 @@ module Startling
      `git rev-parse --show-toplevel`.strip
     end
 
+    def current_branch_has_no_commits?(base_branch: 'origin/master')
+      revision_sha(base_branch) == revision_sha('HEAD')
+    end
+
     private
 
     def remote_url
       `git config --get remote.origin.url`.strip
     end
+
+    def revision_sha(revision)
+      Shell.run "git rev-parse #{revision}"
+    end
   end
 end

data/lib/startling/version.rb

@@ -1,3 +1,3 @@
 module Startling
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/spec/startling/commands/create_branch_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+require 'startling/commands/create_branch'
+
+describe Startling::Commands::CreateBranch do
+  let(:git) { double('GitLocal') }
+  let(:attrs) { { args: [], git: git } }
+  let(:create_branch) { Startling::Commands::CreateBranch.new(attrs) }
+
+  describe '#execute' do
+    let(:branch_name) { 'my-branch' }
+    let(:attrs) { { args: [1, branch_name], git: git } }
+
+    before do
+      allow(create_branch).to receive(:valid_branch_name?) { true }
+      allow(git).to receive(:current_branch) { 'current-branch' }
+      allow(create_branch).to receive(:create_branch)
+    end
+
+    it 'returns an error if the branch name is invalid' do
+      allow(create_branch).to receive(:valid_branch_name?) { false }
+
+      expect { create_branch.execute }.to raise_exception(SystemExit)
+    end
+
+    it 'creates the branch if it is not the current branch' do
+      allow(git).to receive(:current_branch) { 'current-branch' }
+
+      expect(create_branch).to receive(:create_branch)
+      create_branch.execute
+    end
+
+    it 'does not create the branch if it is the current branch' do
+      allow(git).to receive(:current_branch) { branch_name }
+
+      expect(create_branch).not_to receive(:create_branch)
+      create_branch.execute
+    end
+
+    it 'returns the branch name' do
+      expect(create_branch.execute).to eq(branch_name)
+    end
+  end
+
+  describe '#branch_name' do
+    subject { create_branch.branch_name }
+
+    context 'when branch command line option is set' do
+      let(:attrs) { { args: [1, 'test everything'] } }
+
+      it 'returns the command line option' do
+        expect(subject).to eq('test-everything')
+      end
+    end
+
+    context 'when branch command line option is not set' do
+      let(:default_branch) { 'master' }
+
+      before do
+        allow(create_branch).to receive(:default_branch) { default_branch }
+      end
+
+      it 'returns the branch entered through the prompt' do
+        allow($terminal).to receive(:ask) { 'entered branch' }
+
+        expect(subject).to eq('entered-branch')
+      end
+
+      it 'returns the current branch when no branch is entered through the prompt' do
+        allow($terminal).to receive(:ask) { '' }
+        allow(git).to receive(:current_branch) { 'current-branch' }
+
+        expect(subject).to eq('current-branch')
+      end
+    end
+  end
+
+  describe '#valid_branch_name?' do
+    let(:branch_name) { 'validate-me' }
+    let(:attrs) { { args: [1, branch_name] } }
+
+    subject { create_branch.valid_branch_name? }
+
+    before do
+      allow(create_branch).to receive(:default_branch) { 'master' }
+      allow(Startling).to receive(:validate_branch_name) { nil }
+    end
+
+    it 'succeeds if branch passes validation' do
+      expect(subject).to be_truthy
+    end
+
+    it 'fails if the branch is the default branch' do
+      allow(create_branch).to receive(:default_branch) { branch_name }
+
+      expect(subject).to be_falsey
+    end
+
+    it 'fails if the custom validation Proc fails' do
+      allow(Startling).to receive(:validate_branch_name) { -> (branch_name) { /feature\/.*/ =~ branch_name } }
+
+      expect(subject).to be_falsey
+    end
+  end
+end

data/spec/startling/commands/create_pull_request_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+require 'startling/commands/create_pull_request'
+
+describe Startling::Commands::CreatePullRequest do
+  let(:git) { double('GitLocal') }
+  let(:attrs) { { git: git } }
+  let(:create_pull_request) { Startling::Commands::CreatePullRequest.new(attrs) }
+
+  describe '#open_pull_request' do
+    let(:commit_message) { 'test' }
+    let(:pull_request_handler) do
+      double(:pull_request_handler,
+        commit_message: commit_message,
+        title: 'title',
+        body: 'body'
+      )
+    end
+
+    let(:repo) { double(:repo, open_pull_request: true) }
+
+    before do
+      allow(create_pull_request).to receive(:pull_request_handler) { pull_request_handler }
+      allow(create_pull_request).to receive(:repo) { repo }
+
+      allow(git).to receive(:current_branch_has_no_commits?) { false }
+      allow(git).to receive(:create_empty_commit)
+      allow(git).to receive(:push_origin_head)
+    end
+
+    it 'should create an empty commit when the branch has no commits' do
+      allow(git).to receive(:current_branch_has_no_commits?) { true }
+
+      expect(git).to receive(:create_empty_commit).with(commit_message)
+      create_pull_request.open_pull_request
+    end
+
+    it 'should not create an empty commit when the branch has commits' do
+      allow(git).to receive(:current_branch_has_no_commits?) { false }
+
+      expect(git).not_to receive(:create_empty_commit)
+      create_pull_request.open_pull_request
+    end
+  end
+end

data/spec/startling_spec.rb

@@ -39,6 +39,9 @@ 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 }
+
   # Message for pull request commit
   # config.pull_request_commit_message = "Startling"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: startling
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Aaron Jensen
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -247,6 +247,8 @@ files:
 - lib/startling/version.rb
 - spec/spec_helper.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
@@ -278,13 +280,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: script for startling a story
 test_files:
 - spec/spec_helper.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