phlow 0.7.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phlow.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Isa Goksu
+
+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.md

@@ -0,0 +1,59 @@
+# Phlow
+
+Feature branching is awesome, but it has issues.. Some serious issues! This gem is just aiming to enhance it by creating a workflow around it to make it even work with CI tools like Teamcity, Jenkins, etc. Gem includes a command line wrapper utility around Git.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phlow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phlow
+
+## Usage
+
+Just type:
+
+    $ phlow help
+
+First of all, Git is not designed for Enterprise teams to work on a newly developed code base or an unstable codebase (unlike Linux kernel). This is just an attempt to ease that pain, but I'm underlining and making the next sentence bold. If you want to use Git in your Enterprise company, be careful and without having any workflow, don't even attempt to use Git blindly. I'll be publishing a white-paper soon around that. For the time being, you can email me for the details.
+
+To have a successful Git workflow, I'm assuming you guys already have a central Git repository. If not, please use GitHub or GitLab. It'll reduce the pain a little bit. Let me try to explain how I expect you to work if you are adopting **Phlow**:
+
+By default, **Phlow** will give you 4 branches. These are:
+
+* master (origin/master)
+* development (origin/development)
+* operational (origin/operational)
+* qa (origin/qa)
+
+Let me explain the easy ones first! **Operational** branch is kind of a branch where you do your config changes, small library editions, updating a documentation etc. **QA** branch is for your QA work. Anything QA related goes into this branch. When I say QA, I'm more focusing on acceptance/load/performance testing. Nothing else. I believe unit, integration (contract) and functional (component) tests should be written by devs.
+
+Keep in mind that above branches are not supposed to be manually merged to anywhere. **Phlow** will take care of it for you.
+
+Now, let's get to the bottom of the real magic. Any time you want to work on a new topic/feature/story/bug/issue, you create a new branch for it by typing:
+`phlow new my-awesome-feature`
+
+Phlow will be creating a new branch for you with the necessary settings. You do your normal checkins into this branch. You can switch to another branch or feature any time and come back here using standard git commands. Just make sure that you are not messing anything by applying merging or rebasing (this includes pulls and fetches). If you do this, you are kinda beating the purpose of this gem. Basically, don't do it. Anyways, say you committed 3 checkins and now you want to send this changes to CI environment or other devs. All you need to do at this point is:
+`phlow sync`
+
+Phlow will take care of the rest for you. But bottom-line is, Phlow will sync everything over the **development** branch. Therefore your CI should run against **development** branch. This branch is nothing to be worried, all you will be seeing there is bunch of sync messages with feature names associated to them. The actual history will be fully kept in the master branch. Don't worry! You can sync as many as you want. Just remember, any conflicts on development branch, you gotta manually fix that (no merging back). Once you are done with your feature, just call your fellow colleague to review your changes. And if he is cool with it, then he can sign off to this feature by typing:
+`phlow signoff my-awesome-feature`
+
+As you as you sign off, all your history will be moved to master branch with no fast-forwarding.
+
+Anyways, this is all for the time being. Keep in mind, **Phlow** is still in progress of development. We are actively using it every day and fine-tuning the problems. However, error-reporting mechanism is not that great yet. I'll be fixing that soon hopefully.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/phlow

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require "phlow"
+
+def print_usage
+   puts <<USAGE
+
+Phlow v#{Phlow::VERSION}, your cute little Git workflow..
+
+   init <remote-repo>      = Initialize a new repository with the default setup for given remote repository
+   new <feature>           = Creates a new feature/bug branch with the given name
+   sync [continue|abort]   = Syncs current branch with other users (pull & push)
+   signoff <feature>       = Signs off to the given feature
+   version                 = Displays the version information
+   help                    = Displays this screen
+
+USAGE
+
+end
+
+has_git = `which git`
+if not $?.success?
+   puts "Please install Git first to continue.."
+   exit 1
+end
+
+if ARGV.first
+   command, arg = ARGV.first, (ARGV.last unless ARGV.first == ARGV.last)
+
+   case command
+      when "init"
+         Phlow::init_repository arg
+      when "new"
+         Phlow::new_topic arg
+      when "sync"
+         Phlow::sync arg
+      when "signoff"
+         Phlow::signoff arg
+      when "version"
+         puts "Phlow, v#{Phlow::VERSION}"
+      else
+         print_usage
+   end
+else
+   print_usage
+end

data/lib/phlow/version.rb

@@ -0,0 +1,3 @@
+module Phlow
+  VERSION = "0.7.0"
+end

data/lib/phlow.rb

@@ -0,0 +1,171 @@
+require "phlow/version"
+
+module Phlow
+
+LICENSE = <<LICENSE
+Copyright (c) #{Time.now.year}
+
+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.
+LICENSE
+
+   def self.init_repository(repo)
+      if repo.nil?
+         puts "Oops! Please specify a remote repository url!"
+         exit 1
+      end
+
+      if not File.exists?(".git")
+         puts "Initializing the repo..."
+         result = `git clone #{repo} .`
+      end
+
+      if not File.exists?("LICENSE")
+         puts "Creating a license file..."
+         File.open("LICENSE", "w") {|f| f.write(LICENSE) }
+
+         puts "Committing for the first time..."
+         result = `git add -A && git commit -m 'First commit'`
+      end
+
+      puts "Creating necessary branches..."
+      result = `git push -u origin master &> /dev/null`
+      create_remote_branch 'development'
+      create_remote_branch 'operational'
+      create_remote_branch 'qa'
+      result = `git checkout master &> /dev/null`
+
+      puts "Done!"
+   end
+
+   def self.new_topic(topic)
+      puts "Creating..."
+      result = `git pull &> /dev/null`
+      result = `git checkout -b #{topic} master &> /dev/null`
+
+      puts "#{topic} is ready for you to work on!"
+   end
+
+   def self.sync(action)
+      puts "Syncing.."
+      result = `git status -s`
+
+      if result.nil?
+         puts "Please commit your changes first!"
+         exit 1
+      end
+
+      feature = `echo $(git branch | grep "*" | sed "s/* //")`
+
+      # if there is no branch, it should just do the safe sync
+      if action.nil?
+         puts "Applying remote changes to the #{feature} branch..."
+         result = `git rebase master #{feature}`
+         if not $?.success?
+            puts result
+            exit 1
+         end
+
+         puts "Sending current changes..."
+         result = `git checkout development &> /dev/null`
+         result = `git pull`
+         result = `git merge --squash #{feature}`
+         if not $?.success?
+            puts result
+            exit 1
+         end
+
+         result = `git commit . -m '#{feature} syncing..' &> /dev/null`
+
+         sync_with_operational_branches 'development'
+
+         result = `git push -u origin development`
+         result = `git checkout #{feature} &> /dev/null`
+      end
+   end
+
+   def self.signoff(feature)
+      if feature.nil?
+         puts "Please specify which feature you want to sign off!"
+         exit 1
+      end
+
+      print "Are you sure you want to sign off to #{feature}? Remember, this will delete the #{feature} [y/n]? "
+      answer = STDIN.gets.chomp
+
+      if answer.downcase == 'y' or answer.downcase == 'yes'
+         puts "Signing off [ #{feature} ]..."
+         print "Signee: "
+         signee = STDIN.gets.chomp
+
+         if signee.length < 5
+            puts "Please enter a valid name!"
+            exit 1
+         end
+
+         result = `git checkout master &> /dev/null`
+         result = `git pull &> /dev/null`
+         result = `git rebase master #{feature}`
+         result = `git checkout master &> /dev/null`
+         result = `git merge --no-ff #{feature} -m '#{feature} is signed off by #{signee}'`
+         if not $?.success?
+            puts result
+            exit 1
+         end
+
+         sync_with_operational_branches 'master'
+         result = `git branch -d #{feature}`
+         result = `git push -u origin master`
+      end
+   end
+
+   private
+
+   def self.create_remote_branch(name)
+      result = `git checkout -b #{name} master &> /dev/null`
+      result = `git push -u origin #{name} &> /dev/null`
+
+      if not $?.success?
+         result = `git pull &> /dev/null`
+         result = `git branch #{name} --set-upstream origin/#{name} &> /dev/null`
+      end
+   end
+
+   def self.sync_with_operational_branches(branch)
+      result = `git pull origin &> /dev/null`
+      result = `git checkout operational &> /dev/null`
+      result = `git checkout qa &> /dev/null`
+
+      result = `git checkout #{branch} &> /dev/null`
+      result = `git merge --no-ff operational`
+      if not $?.success?
+         puts result
+         exit 1
+      end
+
+      result = `git merge --no-ff qa`
+      if not $?.success?
+         puts result
+         exit 1
+      end
+   end
+
+end

data/phlow.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/phlow/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Isa Goksu"]
+  gem.email         = ["isa.goksu@gmail.com"]
+  gem.description   = %q{A custom git workflow that actually works with CI environment}
+  gem.summary       = %q{Git-flow is awesome, this gem is just enhancing the workflow to make it work with CI tools like Teamcity, Jenkins, etc. Gem includes bunch of command line wrapper utilities around Git.}
+  gem.homepage      = "https://github.com/isa/phlow"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "phlow"
+  gem.require_paths = ["lib"]
+  gem.version       = Phlow::VERSION
+
+  gem.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: phlow
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
+platform: ruby
+authors: 
+- Isa Goksu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A custom git workflow that actually works with CI environment
+email: 
+- isa.goksu@gmail.com
+executables: 
+- phlow
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/phlow
+- lib/phlow.rb
+- lib/phlow/version.rb
+- phlow.gemspec
+homepage: https://github.com/isa/phlow
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Git-flow is awesome, this gem is just enhancing the workflow to make it work with CI tools like Teamcity, Jenkins, etc. Gem includes bunch of command line wrapper utilities around Git.
+test_files: []
+