abstract_feature_branch 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c3d5ba3f2d87215c418e884e974eb2a8850899d
-  data.tar.gz: cc27d0818364f12cc1fa88c4548cda823b752de4
+  metadata.gz: 6f1030acce2b8092fcf6ac90e233253b273d5e10
+  data.tar.gz: 91baad506146ddd0aa419062c30c8d3f7d8dae3e
 SHA512:
-  metadata.gz: d18c7bc9cfb24c793078e81b50beea7549fb867714f2a55a2f7fd690a613a7004aa0839644b5c4c33f13fe778be9507d5c7539d685a29e30d3e3c9ae1a7b6e71
-  data.tar.gz: 6f72bc02aae8b05d3d0751267648ca12b0f7b3bf275f1418149b216a683b0b0735ebc80b8253a93719ba254710deb41bd334ca3c23d4a93398d25eebfe2c1ea8
+  metadata.gz: c4a44fabd06d5945c799cc157b22019cc2522fcbe7aa86ff0174d83f0bba64eebdee6d539b28c2628c61b0d84343167ed6ff37f17877ad6241f750472ee5be7c
+  data.tar.gz: 54c63e4ea5f19b9900ec5b565f8c8100f033bdaa35a40640dd960d3809855f109b5eb8defd5bbe825122eeff18eda10bce03a82af32e0cf5bdb42372a81cbb3b

data/README.md

@@ -24,7 +24,7 @@ Setup
 -----
 
 1. Configure Rubygem
-   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.3.5'</pre>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.3.6'</pre>
    - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'absract_feature_branch'</pre>
 2. Generate config/features.yml in your Rails app directory by running <pre>rails g abstract_feature_branch:install</pre>
 
@@ -56,13 +56,19 @@ overridden as false (disabled) in production. This is a recommended practice.
 Instructions
 ------------
 
-- declaratively feature branch logic to only run when feature1 is enabled:
+- Declaratively feature branch logic to only run when feature1 is enabled:
 
+multi-line logic:
 >     feature_branch :feature1 do
 >       # perform logic
 >     end
 
-- declaratively feature branch two paths of logic, one that runs when feature1 is enabled and one that runs when it is disabled:
+single-line logic:
+>     feature_branch(:feature1) { # perform logic }
+
+Note that feature_branch returns nil and does not execute the block if the feature is disabled or non-existent.
+
+- Declaratively feature branch two paths of logic, one that runs when feature1 is enabled and one that runs when it is disabled:
 
 >     feature_branch :feature1,
 >                    :true => lambda {
@@ -72,7 +78,9 @@ Instructions
 >                      # perform alternate logic
 >                    }
 
-- imperatively check if a feature is enabled or not:
+Note that feature_branch executes the false branch if the feature is non-existent.
+
+- Imperatively check if a feature is enabled or not:
 
 >     if feature_enabled?(:feature1)
 >       # perform logic
@@ -80,6 +88,8 @@ Instructions
 >       # perform alternate logic
 >     end
 
+Note that feature_enabled? returns false if the feature is disabled and nil if the feature is non-existent (practically the same effect, but nil can sometimes be useful to detect if a feature is referenced).
+
 Recommendations
 ---------------
 
@@ -107,6 +117,35 @@ simply switching off the URL route to them. Example:
 >       </h4>
 >     <% end %>
 
+- In Rails 4, wrap newly added strong parameters in controllers for data security. Example:
+
+>     params.require(:project).permit(
+>       feature_branch(:project_gallery) {:exclude_display},
+>       :name,
+>       :description,
+>       :website
+>     )
+
+- In Rails 4 and 3.1+ with the asset pipeline, wrap newly added CSS or JavaScript using .erb format. Example (renamed projects.css.scss to projects.css.scss.erb and wrapped CSS with an abstract feature branch block):
+
+>     <% feature_branch :project_gallery do %>
+>     .exclude_display {
+>       margin-left: auto;
+>       margin-right: auto;
+>       label {
+>         font-size: 1em;
+>         text-align: center;
+>       }
+>       height: 47px;
+>     }
+>     <% end %>
+>     label {
+>       font-size: 1.5em;
+>       margin-bottom: -15px;
+>       margin-top: 3px;
+>       display: inline;
+>     }
+
 - 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.
@@ -114,6 +153,9 @@ for better maintenance as the need is not longer there for feature branching at
 Release Notes
 -------------
 
+Version 0.3.6:
+- Fixed feature_branch issue with invalid feature name, preventing block execution and returning nil instead
+
 Version 0.3.5:
 - Fixed issue with generator not allowing consuming client app to start Rails server successfully
 

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/abstract_feature_branch.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Annas \"Andy\" Maleh"]

data/lib/ext/feature_branch.rb

@@ -3,7 +3,7 @@ class Object
   def self.feature_branch(feature_name, branches = {}, &feature_work)
     branches[:true] ||= feature_work
     branches[:false] ||= lambda {}
-    feature_status = AbstractFeatureBranch.features[Rails.env.to_s][feature_name.to_s].to_s.to_sym
+    feature_status = (AbstractFeatureBranch.features[Rails.env.to_s][feature_name.to_s] || false).to_s.to_sym
     branches[feature_status].call
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Annas "Andy" Maleh