zenflow 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2a7fe35213635ae55bf69cce6c44d5914743138
-  data.tar.gz: 0a798aa732b4204dcdd5c09cc615016129d76424
+  metadata.gz: f9d8ccc7d838dd8da74652e08db81f9c90e1f7fc
+  data.tar.gz: 6d69ea2a6f87cfccf50eaa3246ec34c0db8ad28e
 SHA512:
-  metadata.gz: cc718ca6a9cf65af94caa3b8d21c5742f6674c2ff867071127a61016ba34ab7eec2307a16bd2faa6efaf03c2e592854e5ce269fa7904f8bb4daf6eff1cc223c7
-  data.tar.gz: 346f1c47fd6e658b8a5fcbf2f1b7742ac0fdb34bdb50f6a243a1925b1239d63ce956c1eb238536a71275620db78d50333763062c69b3623538c8648a227c09b8
+  metadata.gz: 1be8b2137b79aa83045c2bb68d03f794f7628327cd03d525d17b901c868afb61f9bbbe7ef8781973ac870ed5b7d2dd666432e0b03de259481d804ea5adf1b22e
+  data.tar.gz: 7d5c7c29425dca685c9c5930b6b5290baae381cc0c0ba7e90ab39981195d40df2f883085978bf2874059d59fb4d26d5e36dc7e5c4288d9760253d6cc7e44e99f

data/.zenflow

@@ -8,3 +8,4 @@ confirm_staging: true
 remote: origin
 release_branch: production
 staging_branch: staging
+merge_strategy: merge

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zenflow (0.8.0)
+    zenflow (0.8.2)
       colored (~> 1.2)
       httparty (~> 0.11.0)
       terminal-table (~> 1.4.5)
@@ -13,7 +13,14 @@ GEM
     addressable (2.3.5)
     coderay (1.0.9)
     colored (1.2)
+    colorize (0.5.8)
     columnize (0.3.6)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
     crack (0.4.0)
       safe_yaml (~> 0.9.0)
     debugger (1.6.1)
@@ -47,6 +54,7 @@ GEM
       rb-kqueue (>= 0.2)
     lumberjack (1.0.4)
     method_source (0.8.1)
+    mime-types (1.23)
     multi_json (1.7.7)
     multi_xml (0.5.4)
     pry (0.9.12.2)
@@ -58,6 +66,8 @@ GEM
       ffi (>= 0.5.0)
     rb-kqueue (0.2.0)
       ffi (>= 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.14.0)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -85,6 +95,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   debugger (~> 1.6.1)
   fuubar (~> 1.1.1)
   guard-rspec (~> 3.0.2)

data/README.markdown

@@ -1,15 +1,21 @@
 # Zenflow
 
+[![Gem Version](https://badge.fury.io/rb/zenflow.png)](http://badge.fury.io/rb/zenflow)
 [![Code Climate](https://codeclimate.com/repos/51bf6e3b7e00a411ad00f6c3/badges/111fbe3664cebffa8e23/gpa.png)](https://codeclimate.com/repos/51bf6e3b7e00a411ad00f6c3/feed)
+[![Coverage Status](https://coveralls.io/repos/zencoder/zenflow/badge.png)](https://coveralls.io/r/zencoder/zenflow)
+[![Dependency Status](https://gemnasium.com/a1d29c5ea446d54bead93a6878bc204b.png)](https://gemnasium.com/zencoder/zenflow)
 ![CircleCI](https://circleci.com/gh/zencoder/zenflow.png?circle-token=992f1e59d778a8f6eef0fb9f2888e80cf60d7226)
+
 -------
 
-[Getting Started](#getting-started)
-[Usage](#usage)
-[Commands Quick Reference](#commands)
-[Requirements](#requirements)
+* [Getting Started](#getting-started)
+* [Usage](#usage)
+* [Commands Quick Reference](#commands)
+* [Requirements](#requirements)
+
+-------
 
-### What is this?
+### What is Zenflow?
 
 Zenflow is a Ruby implimentation of the [GitFlow process](http://nvie.com/posts/a-successful-git-branching-model/) for managing development in Git. It's been used at [Zencoder](http://zencoder.com) since 2010 and we've benefitted greatly from the structure it helps enforce, so we wanted to share it with the world.
 
@@ -77,16 +83,16 @@ To deploy to production, type `zenflow deploy production`. Hotfixes are not auto
 
 #### <a name="commands"></a> Commands Quick Ref
 
-  zenflow init
-  zenflow (feature|hotfix|release) start
-  zenflow (feature|hotfix|release) deploy
-  zenflow (feature|hotfix|release) review
-  zenflow (feature|hotfix|release) finish
-  zenflow deploy (qa|staging|production)
+    zenflow init
+    zenflow (feature|hotfix|release) start
+    zenflow (feature|hotfix|release) deploy
+    zenflow (feature|hotfix|release) review
+    zenflow (feature|hotfix|release) finish
+    zenflow deploy (qa|staging|production)
 
 ### <a name="requirements"></a> Requirements/Assumptions
 
-* Git > 1.8
-* Ruby > 1.9.3
+* Git >= 1.8
+* Ruby >= 1.9.3
 * Capistrano and cap-ext
 * A repository on GitHub

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 major: 0
 minor: 8
-patch: 2
+patch: 3
 pre:

data/lib/zenflow/cli.rb

@@ -37,22 +37,26 @@ module Zenflow
 
     desc "init", "Write the zenflow config file."
     def init(force=false)
-      already_configured if Zenflow::Config.configured? && !force
-      set_up_github
-      authorize_github
-      configure_project
-      configure_branches
-      configure_remotes
-      confirm_some_stuff
-      set_up_changelog
-      Zenflow::Config.save!
+      if Zenflow::Config.configured? && !force
+        already_configured
+      else
+        set_up_github
+        authorize_github
+        configure_project
+        configure_branches
+        configure_merge_strategy
+        configure_remotes
+        confirm_some_stuff
+        set_up_changelog
+        Zenflow::Config.save!
+      end
     end
 
     desc "set_up_github", "Set up GitHub user information"
     def set_up_github
       user = Zenflow::Github.user
       if user.to_s != ''
-        if Zenflow::Ask("Your GitHub user is currently #{user}. Do you want to use that?", :options => ["y", "N"], :default => "Y") == "n"
+        if Zenflow::Ask("Your GitHub user is currently #{user}. Do you want to use that?", :options => ["Y", "n"], :default => "y") == "n"
           Zenflow::Github.set_user
         end
       else
@@ -63,7 +67,7 @@ module Zenflow
     desc "authorize_github", "Get an auth token from GitHub"
     def authorize_github
       if Zenflow::Github.zenflow_token
-        if Zenflow::Ask("You already have a token from GitHub. Do you want to set a new one?", :options => ["Y", "n"], :default => "Y") == "y"
+        if Zenflow::Ask("You already have a token from GitHub. Do you want to set a new one?", :options => ["y", "N"], :default => "n") == "y"
           Zenflow::Github.authorize
         end
       else
@@ -75,7 +79,7 @@ module Zenflow
 
       def already_configured
         Zenflow::Log("Warning", :color => :red)
-        if Zenflow::Ask("There is an existing config file. Overwrite it?", :options => ["y", "N"], :default => "N") == "y"
+        if Zenflow::Ask("There is an existing config file. Overwrite it?", :options => ["y", "N"], :default => "n") == "y"
           init(true)
         else
           Zenflow::Log("Aborting...", :color => :red)
@@ -97,7 +101,7 @@ module Zenflow
       end
 
       def configure_branch(branch, question, default)
-        if Zenflow::Ask(question, :options => ["Y", "n"], :default => "Y") == "y"
+        if Zenflow::Ask(question, :options => ["Y", "n"], :default => "y") == "y"
           Zenflow::Config[branch] = Zenflow::Ask("What is the name of that branch?", :default => default)
         else
           Zenflow::Config[branch] = false
@@ -106,23 +110,27 @@ module Zenflow
 
       def configure_remotes
         Zenflow::Config[:remote] = Zenflow::Ask("What is the name of your primary remote?", :default => "origin")
-        if Zenflow::Ask("Use a backup remote?", :options => ["Y", "n"], :default => "n") == "y"
+        if Zenflow::Ask("Use a backup remote?", :options => ["y", "N"], :default => "n") == "y"
           Zenflow::Config[:backup_remote] = Zenflow::Ask("What is the name of your backup remote?", :default => "backup")
         else
           Zenflow::Config[:backup_remote] = false
         end
       end
 
-      def set_up_changelog
-        return if File.exist?("CHANGELOG.md")
-        Zenflow::Log("Changelog Management")
-        Zenflow::Changelog.create if Zenflow::Ask("Set up a changelog?", :options => ["Y", "n"], :default => "Y") == "y"
+      def configure_merge_strategy
+        Zenflow::Config[:merge_strategy] = Zenflow::Ask("What merge strategy would you prefer?", default: "merge", options: ['merge', 'rebase'])
       end
 
       def confirm_some_stuff
         Zenflow::Log("Confirmations")
-        Zenflow::Config[:confirm_staging] = Zenflow::Ask("Require deployment to a staging environment?", :options => ["Y", "n"], :default => "Y") == "y"
-        Zenflow::Config[:confirm_review] = Zenflow::Ask("Require code reviews?", :options => ["Y", "n"], :default => "Y") == "y"
+        Zenflow::Config[:confirm_staging] = Zenflow::Ask("Require deployment to a staging environment?", :options => ["Y", "n"], :default => "y") == "y"
+        Zenflow::Config[:confirm_review] = Zenflow::Ask("Require code reviews?", :options => ["Y", "n"], :default => "y") == "y"
+      end
+
+      def set_up_changelog
+        return if File.exist?("CHANGELOG.md")
+        Zenflow::Log("Changelog Management")
+        Zenflow::Changelog.create if Zenflow::Ask("Set up a changelog?", :options => ["Y", "n"], :default => "y") == "y"
       end
 
     end

data/lib/zenflow/helpers/ask.rb

@@ -45,6 +45,16 @@ module Zenflow
     end
 
     def self.valid_response?(response, options={})
+      if response == ''
+        response = options[:default].downcase if options[:default]
+      end
+
+      # The guard in the line below is required to allow branches to be named
+      # directly on the command line and bypass the prompt for branch name
+      response.downcase! unless options[:response]
+
+      options[:options].map!(&:downcase) if options[:options]
+
       return false if options[:options] && !options[:options].include?(response)
       return false if options[:validate] && options[:validate].is_a?(Regexp) && !response[options[:validate]]
       return false if options[:required] && response == ""

data/lib/zenflow/helpers/branch.rb

@@ -13,9 +13,23 @@ module Zenflow
         branch.chomp.sub(/\* #{prefix}\/?/, "") unless branch.empty?
       end
 
-      def update(name)
-        Zenflow::Log("Updating the #{name} branch")
-        Zenflow::Shell["git checkout #{name} && git pull"]
+      def update(name, rebase_override=false)
+        if Zenflow::Config[:merge_strategy] == 'rebase' || rebase_override == true
+          Zenflow::Log("Updating the #{name} branch using pull with --rebase")
+          Zenflow::Shell["git checkout #{name} && git pull --rebase"]
+        else
+          Zenflow::Log("Updating the #{name} branch")
+          Zenflow::Shell["git checkout #{name} && git pull"]
+        end
+      end
+
+      def apply_merge_strategy(flow, name, destination, rebase_override=false)
+        if Zenflow::Config[:merge_strategy] == 'rebase' || rebase_override == true
+          Zenflow::Branch.rebase("#{flow}/#{name}", destination)
+        else
+          Zenflow::Branch.checkout("#{flow}/#{name}")
+          Zenflow::Branch.merge(destination)
+        end
       end
 
       def create(name, base)
@@ -51,6 +65,11 @@ module Zenflow
         Zenflow::Shell["git checkout #{name}"]
       end
 
+      def rebase(name, source)
+        Zenflow::Log("Rebasing #{name} on top of the #{source} branch")
+        Zenflow::Shell["git rebase #{source} #{name}"]
+      end
+
       def merge(name)
         Zenflow::Log("Merging in the #{name} branch")
         Zenflow::Shell["git merge --no-ff #{name}"]

data/lib/zenflow/helpers/branch_command.rb

@@ -51,12 +51,13 @@ module Zenflow
 
   protected
 
+    #TODO: move the validation regex to a single place
     def branch_name
       @branch_name ||= Zenflow::Branch.current(flow) ||
                        Zenflow::Ask("Name of the #{flow}:",
                            required:      true,
-                           validate:      /^[-0-9a-z]+$/,
-                           error_message: "Names can only contain dashes, 0-9, and a-z").downcase
+                           validate:      /^[-_0-9a-z]+$/,
+                           error_message: "Names can only contain dashes, underscores, 0-9, and a-z").downcase
     end
 
 

data/lib/zenflow/helpers/branch_commands/finish.rb

@@ -23,7 +23,7 @@ module Zenflow
           no_commands do
             def confirm(confirmation, question, failure_response)
               return unless Zenflow::Config[confirmation]
-              if Zenflow::Ask(question, options: ["Y", "n"], default: "Y") == "n"
+              if Zenflow::Ask(question, options: ["Y", "n"], default: "y") == "n"
                 Zenflow::Log(failure_response, color: :red)
                 exit(1)
               end
@@ -47,8 +47,7 @@ module Zenflow
             def update_branch_from_destination
               destination = (branch(:destination) || branch(:source))
               Zenflow::Branch.update(destination) if !options[:offline]
-              Zenflow::Branch.checkout("#{flow}/#{branch_name}")
-              Zenflow::Branch.merge(destination)
+              Zenflow::Branch.apply_merge_strategy(flow, branch_name, destination)
             end
 
             def merge_branch_into_destination

data/lib/zenflow/helpers/branch_commands/start.rb

@@ -10,8 +10,8 @@ module Zenflow
           def start(name=nil)
             @branch_name = Zenflow::Ask("Name of the #{flow}:",
                                         required:      true,
-                                        validate:      /^[-0-9a-z]+$/,
-                                        error_message: "Names can only contain dashes, 0-9, and a-z",
+                                        validate:      /^[-_0-9a-z]+$/,
+                                        error_message: "Names can only contain dashes, underscores, 0-9, and a-z",
                                         response:      name).downcase
 
             create_new_branch(options[:offline])

data/lib/zenflow/helpers/branch_commands/update.rb

@@ -7,11 +7,11 @@ module Zenflow
 
           desc "update", "Update the branch to the latest code"
           option :offline, type: :boolean, desc: "Runs in offline mode"
+          option :rebase, type: :boolean, desc: "Rebases the current branch against a source branch instead of doing a merge of that source into itself"
           def update
             branch_name
-            Zenflow::Branch.update(branch(:source)) if !options[:offline]
-            Zenflow::Branch.checkout("#{flow}/#{branch_name}")
-            Zenflow::Branch.merge(branch(:source))
+            Zenflow::Branch.update(branch(:source), options[:rebase]) if !options[:offline]
+            Zenflow::Branch.apply_merge_strategy(flow, branch_name, branch(:source), options[:rebase])
           end
 
         end

data/lib/zenflow/helpers/changelog.rb

@@ -29,7 +29,7 @@ module Zenflow
           f.write prepended_changelog(new_changes)
         end
         rotate(:name => options[:name]) if options[:rotate]
-        Zenflow::Shell["git add . && git commit -a -m 'Adding line to CHANGELOG: #{new_changes}'"]
+        Zenflow::Shell["git add CHANGELOG.md && git commit -a -m 'Adding line to CHANGELOG: #{new_changes}'"]
       end
 
       def prepended_changelog(new_changes)

data/lib/zenflow/helpers/github.rb

@@ -2,15 +2,17 @@ module Zenflow
 
   module Github
     def self.user
-      user = Zenflow::Shell.run('git config --get github.user', silent: true)
-      user = user.chomp unless user.nil?
-      user
+      get_config('github.user')
     end
 
     def self.zenflow_token
-      zenflow_token = Zenflow::Shell.run('git config --get zenflow.token', silent: true)
-      zenflow_token = zenflow_token.chomp unless zenflow_token.nil?
-      zenflow_token
+      get_config('zenflow.token')
+    end
+
+    def self.get_config(key)
+      config = Zenflow::Shell.run("git config --get #{key.to_s}", silent: true)
+      config = config.chomp unless config.nil?
+      config
     end
 
     def self.authorize

data/lib/zenflow/helpers/pull_request.rb

@@ -13,7 +13,7 @@ module Zenflow
 
       def find_by_ref(ref, options={})
         Zenflow::Log("Looking up pull request for #{ref}") unless options[:silent]
-        if !list.nil?
+        if list.any?
           pull = list.detect do |p|
             p["head"]["ref"] == ref
           end

data/spec/fixtures/cassettes/create_bad_pull_request.yml

@@ -5,12 +5,13 @@ http_interactions:
     uri: https://api.github.com/repos/zencoder/zenflow-example/pulls
     body:
       encoding: UTF-8
-      string: '{"base":null,"head":null,"title":null,"body":null}'
+      string: '{"base":"master","head":"feature/phoney","title":"this feature does
+        not exist","body":"gonna fail"}'
     headers:
       Authorization:
       - token <ZENFLOW-TOKEN>
       User-Agent:
-      - Zencoder/Zenflow-0.8.0
+      - Zencoder/Zenflow-0.8.2
   response:
     status:
       code: 422
@@ -19,19 +20,17 @@ http_interactions:
       Server:
       - GitHub.com
       Date:
-      - Wed, 10 Jul 2013 23:12:20 GMT
+      - Thu, 18 Jul 2013 17:06:44 GMT
       Content-Type:
       - application/json; charset=utf-8
-      Connection:
-      - keep-alive
       Status:
       - 422 Unprocessable Entity
       X-Ratelimit-Limit:
       - '5000'
       X-Ratelimit-Remaining:
-      - '4979'
+      - '4974'
       X-Ratelimit-Reset:
-      - '1373498449'
+      - '1374170098'
       X-Oauth-Scopes:
       - repo
       X-Accepted-Oauth-Scopes:
@@ -41,7 +40,7 @@ http_interactions:
       X-Content-Type-Options:
       - nosniff
       Content-Length:
-      - '172'
+      - '298'
       Access-Control-Allow-Credentials:
       - 'true'
       Access-Control-Expose-Headers:
@@ -51,7 +50,8 @@ http_interactions:
       - '*'
     body:
       encoding: UTF-8
-      string: '{"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"missing_field","field":"base"},{"resource":"PullRequest","code":"missing_field","field":"head"}]}'
+      string: '{"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"missing_field","field":"head_sha"},{"resource":"PullRequest","code":"missing_field","field":"base_sha"},{"resource":"PullRequest","code":"custom","message":"No
+        commits between zencoder:master and zencoder:feature/phoney"}]}'
     http_version: 
-  recorded_at: Wed, 10 Jul 2013 23:12:20 GMT
+  recorded_at: Thu, 18 Jul 2013 17:06:44 GMT
 recorded_with: VCR 2.5.0