abstract_feature_branch 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Annas "Andy" Maleh
+
+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,106 @@
+Abstract Feature Branch
+=======================
+
+abstract_feature_branch is a Rails gem that enables developers to easily branch by
+abstraction as per this pattern: http://paulhammant.com/blog/branch_by_abstraction.html
+
+It gives ability to wrap blocks of code with an abstract feature branch name, and then
+specify which features to be switched on or off in a configuration file.
+
+The goal is to build out future features with full integration into the codebase, thus
+ensuring no delay in integration in the future, while releasing currently done features
+at the same time. Developers then disable future features until they are ready to be
+switched on in production, but do enable them in staging and locally.
+
+This gives developers the added benefit of being able to switch a feature off after
+release should big problems arise for a high risk feature.
+
+Setup
+-----
+
+In Rails 3.x:
+
+1. Add 'abstract_feature_branch' gem to Gemfile in Rails 3.x or
+"config.gem 'absract_feature_branch'" to environment.rb in Rails 2.x
+2. Configure config/features.yml in your Rails app directory as follows:
+\*
+    defaults: &defaults
+      features:
+    #    feature1: true
+    #    feature2: true
+    #    feature3: false
+
+    development:
+      <<: *defaults
+
+    test:
+      <<: *defaults
+
+    staging:
+      <<: *defaults
+    #    feature2: false
+
+    production:
+      <<: *defaults
+      features:
+    #    feature1: false
+    #    feature2: false
+\*
+Notice how the feature "add_business_project" was configured as true (enabled) by default, but
+overridden as false (disabled) in production. This is a recommended practice.
+3. feature branch your logic as per this example:
+\*
+    feature_branch :feature1 do
+      # perform add business logic
+    end
+\*
+
+Recommendations
+---------------
+- Wrap routes in routes.rb with feature blocks to disable entire MVC feature elements by
+simply switching off the URL route to them. Example:
+\*
+    feature_branch :add_business_project do
+      resources :projects
+    end
+\*
+
+- Wrap visual links to these routes in ERB views. Example:
+\*
+    <% feature_branch :add_business_project do %>
+      <h2>Submit a Business</h2>
+      <p>
+        Please submit a business idea for investors to look at.
+      </p>
+      <ul>
+        <% current_user.projects.each do |p| %>
+        <li><%= link_to p.business_campaign_name, project_path(p) %></li>
+        <% end %>
+      </ul>
+      <h4>
+        <%= link_to('Start', new_project_path, :id => "business_background_invitation", :class => 'button') %>
+      </h4>
+    <% end %>
+\*
+- Once a feature has been released and switched on in production, and it has worked well for a while,
+it is recommended that its feature branching code is plucked out of the code base to simplify the code
+for better maintenance as the need is not longer there for feature branching at that point.
+
+
+Contributing to abstract_feature_branch
+---------------------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------------------------------------
+
+Copyright (c) 2012 Annas "Andy" Maleh. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/abstract_feature_branch.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "abstract_feature_branch"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Annas \"Andy\" Maleh"]
+  s.date = "2012-11-12"
+  s.description = "It gives ability to wrap blocks of code with an abstract feature branch name, and then\nspecify which features to be switched on or off in a configuration file.\n\nThe goal is to build out future features with full integration into the codebase, thus\nensuring no delay in integration in the future, while releasing currently done features\nat the same time. Developers then disable future features until they are ready to be\nswitched on in production, but do enable them in staging and locally.\n\nThis gives developers the added benefit of being able to switch a feature off after\nrelease should big problems arise for a high risk feature.\n"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "LICENSE.txt",
+    "README.md",
+    "VERSION",
+    "abstract_feature_branch.gemspec",
+    "lib/abstract_feature_branch.rb",
+    "lib/ext/feature_branch.rb"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/abstract_feature_branch"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "abstract_feature_branch is a Rails gem that enables developers to easily branch by abstraction as per this pattern: http://paulhammant.com/blog/branch_by_abstraction.html"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails_config>, [">= 0.3.1"])
+      s.add_development_dependency(%q<rspec>, ["= 2.11.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_runtime_dependency(%q<rails_config>, [">= 0.3.1"])
+    else
+      s.add_dependency(%q<rails_config>, [">= 0.3.1"])
+      s.add_dependency(%q<rspec>, ["= 2.11.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rails_config>, [">= 0.3.1"])
+    end
+  else
+    s.add_dependency(%q<rails_config>, [">= 0.3.1"])
+    s.add_dependency(%q<rspec>, ["= 2.11.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rails_config>, [">= 0.3.1"])
+  end
+end
+

data/lib/abstract_feature_branch.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rails_config'
+
+RailsConfig.setup do |config|
+  config.const_name = "Settings"
+end
+RailsConfig.load_and_set_settings("#{Rails.root}/config/features.yml")
+
+# Add this line if you need a local override. Make sure it is added to .gitignore
+#Settings.add_source!("#{Rails.root}/config/features.local.yml")
+
+Settings.reload!
+
+require File.join(File.dirname(__FILE__), 'ext', 'feature_branch')

data/lib/ext/feature_branch.rb

@@ -0,0 +1,13 @@
+class Object
+  raise 'Abstract branch conflicts with another Ruby library' if respond_to?(:feature_branch)
+  def self.feature_branch(feature_name, &feature_work)
+    if Settings[Rails.env.to_s]['features'][feature_name]
+      feature_work.call
+    end
+  end
+
+  raise 'Abstract branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_branch)
+  def feature_branch(feature_name, &feature_work)
+    Object.feature_branch(feature_name, &feature_work)
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: abstract_feature_branch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Annas "Andy" Maleh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails_config
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rails_config
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+description: ! 'It gives ability to wrap blocks of code with an abstract feature branch
+  name, and then
+
+  specify which features to be switched on or off in a configuration file.
+
+
+  The goal is to build out future features with full integration into the codebase,
+  thus
+
+  ensuring no delay in integration in the future, while releasing currently done features
+
+  at the same time. Developers then disable future features until they are ready to
+  be
+
+  switched on in production, but do enable them in staging and locally.
+
+
+  This gives developers the added benefit of being able to switch a feature off after
+
+  release should big problems arise for a high risk feature.
+
+'
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- VERSION
+- abstract_feature_branch.gemspec
+- lib/abstract_feature_branch.rb
+- lib/ext/feature_branch.rb
+homepage: http://github.com/AndyObtiva/abstract_feature_branch
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -381377031789369031
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'abstract_feature_branch is a Rails gem that enables developers to easily
+  branch by abstraction as per this pattern: http://paulhammant.com/blog/branch_by_abstraction.html'
+test_files: []