zenflow 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a0a86e94828d1a8dc8cf6d84367463efcfd4a6c
+  data.tar.gz: b3544bd8cb5bc89fc525ce06a72bf4853e7c36e2
+SHA512:
+  metadata.gz: 70da301341826b7fb54e659722e231bbbf7656ce1291c699dc3ed973e20b2cdf8492a13b423f50bd5af00142dcb670bfca6c9ac3520b40f3018d83d8c93137a1
+  data.tar.gz: b8e6fa22c96321a2b56ee1140e0ac4413472959844fba16f17c01d60597f7b944af50d5707e153c8f540b38464933e4ddbe517493780c6bde72dc24c4ae65e2b

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.zenflow-log
+.rvmrc
+.DS_Store
+coverage
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+zenflow

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.zenflow

@@ -0,0 +1,10 @@
+---
+project: zenflow
+development_branch: master
+qa_branch: qa
+backup_remote: false
+confirm_review: true
+confirm_staging: true
+remote: origin
+release_branch: production
+staging_branch: staging

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    zenflow (0.8.0)
+      colored (~> 1.2)
+      httparty (~> 0.11.0)
+      terminal-table (~> 1.4.5)
+      thor (~> 0.18.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    coderay (1.0.9)
+    colored (1.2)
+    columnize (0.3.6)
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    fuubar (1.1.1)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.1)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rspec (2.14.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.0)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.1)
+    ruby-progressbar (1.1.1)
+    safe_yaml (0.9.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.5)
+    terminal-table (1.4.5)
+    thor (0.18.1)
+    vcr (2.5.0)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger (~> 1.6.1)
+  fuubar (~> 1.1.1)
+  guard-rspec (~> 3.0.2)
+  rspec (~> 2.14)
+  simplecov (~> 0.7.1)
+  vcr (~> 2.5.0)
+  webmock (~> 1.13.0)
+  zenflow!

data/Guardfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zencoder
+
+MIT License
+
+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,92 @@
+# Zenflow
+
+[![Code Climate](https://codeclimate.com/repos/51bf6e3b7e00a411ad00f6c3/badges/111fbe3664cebffa8e23/gpa.png)](https://codeclimate.com/repos/51bf6e3b7e00a411ad00f6c3/feed)
+![CircleCI](https://circleci.com/gh/zencoder/zenflow.png?circle-token=992f1e59d778a8f6eef0fb9f2888e80cf60d7226)
+-------
+
+[Getting Started](#getting-started)
+[Usage](#usage)
+[Commands Quick Reference](#commands)
+[Requirements](#requirements)
+
+### What is this?
+
+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.
+
+### <a name="getting-started"></a> Getting Started
+
+Start off by installing the gem.
+
+    gem install zenflow
+
+Once you've installed the gem there are a few questions to answer so that Zenflow knows what sort of branches you want to track and what your qa/staging/production setup looks like.
+
+To get started make sure you're in the root directory of the repository you want to work with, then run
+
+    zenflow init
+
+and answer the questions, then you're ready to start using Zenflow!
+
+### <a name="usage"></a> Usage
+
+#### Features
+
+In Zenflow a feature branch is used to isolate the development of a new feature or refactoring of existing code.
+
+To start a feature in Zenflow run `zenflow feature start`.
+
+You'll be asked for the name of the feature - make it something descriptive - and a new branch will be creaated from master called feature/FEATURE-NAME.
+
+Now you can work and commit normally. If you have Capistrano set up with a QA server, you can deploy the feature at any time by running `zenflow feature deploy`. This will merge the current feature branch in to the qa branch, deploy to the QA server if you have one configured with Capistrano, then go back to the feature branch.
+
+If master has been updated and you want the latest code brought to your feature, you can run `zenflow feature update` to merge the latest code from master.
+
+When you're ready for code review run `zenflow feature review` to create a pull request on GitHub, comparing the master branch and the feature branch. Work with any feedback from the rest of the team as necessary until the code is ready for production.
+
+Once development of the feature is completed run `zenflow feature finish` to merge the feature branch in to master and delete the local and remote branches. If Zenflow is set up to confirm review and testing you'll be asked if you've tested this code on QA and had it code reviewed. Don't lie to Zenflow.
+
+#### Releases
+
+As features are finished they accumulate in the `master` branch. To get them to production we create a release.
+
+To start a release in Zenflow run `zenflow release start` and provide a release name. Themed release names are fun - robots, spaceships, football players, flowers. Something there's a lot of.
+
+There's typically not much that should be done within a new release - active development isn't supposed to happen at this stage. If code review turns up a bug fix it here, but anything more should be done in a feature or hotfix branch.
+
+Once the release is made, typing `zenflow release deploy` will merge the release in to the staging branch, deploy to staging if you have a staging server configured with Capistano, then switch back to the release branch.
+
+After confirming that things are running properly on Staging a release can be reviewed on GitHub by typing `zenflow release review`, which creates a pull request from the release to the production branch.
+
+Once review is completed, type `zenflow release finish` to merge the release branch in to production and delete the local and remote release branches.
+
+To deploy to production, type `zenflow deploy production`.
+
+#### Hotfixes
+
+Hotfixes are used for code updates that need to be deployed outside of a release, usually to address a breaking issue in production.
+
+To start a hotfix type `zenflow hotfix start`. This creates a new hotfix branch off of the production branch.
+
+After the hotfix branch is created you can work and commit as normally. Running `zenflow hotfix deploy` deploys to the staging and qa servers.
+
+When you're ready for code review run `zenflow hotfix review` to create a pull request on GitHub, comparing the production branch and the hotfix branch. Work with any feedback from the rest of the team as necessary until the code is ready for production.
+
+Once development of the feature is completed run `zenflow hotfix finish` to merge the feature branch in to production and master, plus delete the local and remote branches. If Zenflow is set up to confirm review and testing you'll be asked if you've tested this code on QA and had it code reviewed. Don't lie to Zenflow.
+
+To deploy to production, type `zenflow deploy production`. Hotfixes are not automatically deployed to production when they are finished.
+
+#### <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)
+
+### <a name="requirements"></a> Requirements/Assumptions
+
+* Git > 1.8
+* Ruby > 1.9.3
+* Capistrano and cap-ext
+* A repository on GitHub

data/VERSION.yml

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

data/bin/zenflow

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("#{File.dirname(__FILE__)}/../lib")
+require 'rubygems'
+require 'zenflow'
+
+Zenflow::LogToFile("====== Zenflow #{Zenflow::VERSION}/#{Time.now.strftime('%c')} ======")
+Zenflow::LogToFile("$ zenflow #{ARGV.join(' ')}\n")
+
+if ARGV.first != "init" && !Zenflow::Config.configured?
+  Zenflow::Log("This project has not been configured. Please run `zenflow init`.", :color => :red)
+  exit(1)
+end
+
+Zenflow::CLI.start(ARGV)
+
+Zenflow::LogToFile("\n")
+exit(Zenflow::Shell.status)

data/lib/zenflow.rb

@@ -0,0 +1,35 @@
+require 'thor'
+require 'yaml'
+require 'colored'
+require 'terminal-table'
+require 'httparty'
+require 'json'
+
+require 'zenflow/helpers/version'
+require 'zenflow/version'
+require 'zenflow/helpers/log'
+require 'zenflow/helpers/config'
+require 'zenflow/helpers/help'
+require 'zenflow/helpers/shell'
+require 'zenflow/helpers/ask'
+require 'zenflow/helpers/branch'
+require 'zenflow/helpers/repo'
+require 'zenflow/helpers/changelog'
+require 'zenflow/helpers/github'
+require 'zenflow/helpers/pull_request'
+require 'zenflow/helpers/branch_commands/abort'
+require 'zenflow/helpers/branch_commands/branches'
+require 'zenflow/helpers/branch_commands/compare'
+require 'zenflow/helpers/branch_commands/deploy'
+require 'zenflow/helpers/branch_commands/diff'
+require 'zenflow/helpers/branch_commands/finish'
+require 'zenflow/helpers/branch_commands/review'
+require 'zenflow/helpers/branch_commands/start'
+require 'zenflow/helpers/branch_commands/update'
+require 'zenflow/helpers/branch_command'
+require 'zenflow/commands/feature'
+require 'zenflow/commands/hotfix'
+require 'zenflow/commands/release'
+require 'zenflow/commands/deploy'
+require 'zenflow/commands/reviews'
+require 'zenflow/cli'

data/lib/zenflow/cli.rb

@@ -0,0 +1,130 @@
+module Zenflow
+  class CLI < Thor
+
+    map "-v" => "version", "--version" => "version"
+    map "-h" => "help", "--help" => "help"
+
+    desc "version", "Show zenflow version.", :hide => true
+    def version
+      puts "Zenflow #{Zenflow::VERSION}"
+    end
+
+    desc "help", "Show zenflow help.", :hide => true
+    def help
+      version
+      puts
+      puts "Options:"
+      puts "  -h, --help      # Prints help"
+      puts "  -v, --version   # Prints Zenflow version"
+      puts
+      super
+    end
+
+    desc "feature SUBCOMMAND", "Manage feature branches."
+    subcommand "feature", Zenflow::Feature
+
+    desc "hotfix SUBCOMMAND", "Manage hotfix branches."
+    subcommand "hotfix", Zenflow::Hotfix
+
+    desc "release SUBCOMMAND", "Manage release branches."
+    subcommand "release", Zenflow::Release
+
+    desc  "reviews SUBCOMMAND", "Works with code reviews."
+    subcommand "reviews", Zenflow::Reviews
+
+    desc  "deploy ENV", "Deploy to an environment."
+    subcommand "deploy", Zenflow::Deploy
+
+    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!
+    end
+
+    desc "set_up_github", "Set up GitHub user information"
+    def set_up_github
+      if user = Zenflow::Github.user != ''
+        if Zenflow::Ask("Your GitHub user is currently #{Zenflow::Github.user}. Do you want to use that?", :options => ["y", "N"], :default => "Y") == "n"
+          Zenflow::Github.set_user
+        end
+      else
+        Zenflow::Github.set_user
+      end
+    end
+
+    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"
+          Zenflow::Github.authorize
+        end
+      else
+        Zenflow::Github.authorize
+      end
+    end
+
+    no_commands do
+
+      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"
+          init(true)
+        else
+          Zenflow::Log("Aborting...", :color => :red)
+          exit(1)
+        end
+      end
+
+      def configure_project
+        Zenflow::Log("Project")
+        Zenflow::Config[:project] = Zenflow::Ask("What is the name of this project?", :required => true)
+      end
+
+      def configure_branches
+        Zenflow::Log("Branches")
+        Zenflow::Config[:development_branch] = Zenflow::Ask("What is the name of the main development branch?", :default => "master")
+        configure_branch(:staging_branch, "Use a branch for staging releases and hotfixes?", "staging")
+        configure_branch(:qa_branch, "Use a branch for testing features?", "qa")
+        configure_branch(:release_branch, "Use a release branch?", "production")
+      end
+
+      def configure_branch(branch, question, default)
+        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
+        end
+      end
+
+      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"
+          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"
+      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"
+      end
+
+    end
+
+  end
+end