feature_gate 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c01ea6a2c8370a2e6cd7824ed5204df6582c33
-  data.tar.gz: 3d00f3bff117db908f48532353aa2ecc022837e0
+  metadata.gz: 08bf6d98804827f7f661d9f14d87f78788a8774b
+  data.tar.gz: 2a86f93c61108519a9363bd81c423fc85a9eb08d
 SHA512:
-  metadata.gz: 6a7affda7d87ccf825d96b66d274b6b8f51bf108c29d33f1e31b17b743809360974baa77bf1f6ce1d48862c891394149bcae5f2b25056e9c011f2a5ef4945e43
-  data.tar.gz: 308e16eeac356c2a0b2ebcc3b43d81b9c9bf0e4bb1ffbaf4725c8d82f99bfb952934f389c8a8b76666feb3b41eb1c95c5c1213de31b658e7a02c8e4f79481c94
+  metadata.gz: 71059b7b798d94b690c39aba6b569b391788261b11e896c31e58b2e18dff28a5a183881bc2b0dc18d209e087362a7376c3b93a6c4cf2b3a12901c0e5b019a266
+  data.tar.gz: f1e22781451d42d3d88107169acf6c03da857de99981981d342f62aec111b0ed8396937690f7fd8aee99a19e08a1306bcb3d3b075c4ac33f628146b7452ecb9b

data/README.md

@@ -1,6 +1,6 @@
 # feature_gate
 
-A gem to help toggle features on and off in Rails applications without having to re-deploy.
+A gem to help manage toggling features on and off in Rails applications without having to re-deploy. Includes a preconfigured page for gate management and an executable for feature gate code cleanup in your codebase after a feature has been deployed.
 
 ## Installation
 
@@ -34,13 +34,15 @@ Add `config/initializers/feature_gate.rb`
 
 All gates are closed by default, meaning the features you gate will be hidden until you toggle the gates open.
 
-In view files (comment in `end` is optional and is just to make it removable via the cleaner):
+To gate a part of a page:
+In view files (add `# gate-name` after `end` to allow the cleaner executable to remove this line when cleaning the gate out of the files):
 
     <% FeatureGate::Manager.gate('gate-name') do %>
       <h1>This is my gated content</h1>
       <p>I am not seen if the gate is on</p>
     <% end # gate-name %>
 
+To gate an entire page:
 In controller actions:
 
     def index
@@ -49,9 +51,10 @@ In controller actions:
 
 ### Managing gates
 
-<img src="http://i.imgur.com/p4lMIfo.png">
+<img src="http://i.imgur.com/qo8zESV.png">
+
+Go to `/feature_gate` for a preconfigured page to manage your gates. It lists all your gates and gives you the ability to toggle them open or closed. Additionally, it lists all your "stale" gates - gates that have not been touched in 1 month (timeframe is configurable, see under Optional Configurations) and allows you to delete them from your database *if* it is no longer used in your codebase (this check is done automatically when you try to delete a gate).
 
-Go to `/feature_gate` for a preconfigured page that lists all your gates and give you the ability to toggle them open or close.
 
 To limit accessibility to this page, define `feature_gate_control_allowed?` in `application_controller.rb`. If the method is not defined, `/feature_gate` will be accessible to <em>all</em> users.
 
@@ -86,3 +89,7 @@ To see the names of all closed gates:
 To see the names of all stale gates:
 
     FeatureGate::Manager.stale_gates
+
+To safely delete a gate (only deletes if not used in codebase):
+
+    FeatureGate::Manager.destroy!('gate-name')

data/app/controllers/feature_gate/gated_features_controller.rb

@@ -13,10 +13,22 @@ module FeatureGate
       gate = FeatureGate::GatedFeature.find(params[:id])
       if params[:gated] == 'true'
         gate.gate_feature!
-        flash[:notice] = 'Feature has been gated'
+        flash[:notice] = "#{gate.name} has been gated"
       else
         gate.deploy_feature!
-        flash[:success] = 'Feature is live!'
+        flash[:success] = "#{gate.name} is live!"
+      end
+
+      redirect_to gated_features_path
+    end
+
+    def destroy
+      gate = FeatureGate::GatedFeature.find(params[:id])
+      if gate.destroyable?
+        gate.destroy!
+        flash[:success] = "#{gate.name} has been deleted"
+      else
+        flash[:error] = "#{gate.name} is currently being used in the codebase, execute `feature_gate_cleaner #{gate.name}` in the terminal to remove all references to #{gate.name}"
       end
 
       redirect_to gated_features_path

data/app/models/feature_gate/gated_feature.rb

@@ -26,5 +26,18 @@ module FeatureGate
         'opened'
       end
     end
+
+    def destroyable?
+      regex = /FeatureGate::Manager.gate(\(|\s)('|")#{name}('|")|FeatureGate::Manager.gate_page(\(|\s)('|")#{name}('|")/
+      files = Dir["#{Dir.pwd}/app/views/**/*.html.erb"] + Dir["#{Dir.pwd}/app/controllers/**/*.rb"]
+
+      files.each do |file|
+        f = File.new(file)
+        text = f.read
+        return false if text =~ regex
+      end
+
+      true
+    end
   end
 end

data/app/models/feature_gate/manager.rb

@@ -35,5 +35,15 @@ module FeatureGate
       gated_feature = GatedFeature.find_by_name!(name)
       gated_feature.gate_feature!
     end
+
+    def self.destroy!(name)
+      gate = GatedFeature.find_by_name!(name)
+      if gate.destroyable?
+        gate.destroy!
+        puts "#{gate.name} destroyed"
+      else
+        puts "#{gate.name} is currently being used in the codebase, execute `feature_gate_cleaner #{gate.name}` in the terminal to remove all references to #{gate.name}"
+      end
+    end
   end
 end

data/app/views/feature_gate/gated_features/index.html.erb

@@ -52,6 +52,7 @@
         <th>Gate name</th>
         <th>Status</th>
         <th>Last updated at</th>
+        <th>Action</th>
       </tr>
 
       <% @stale_gates.each do |gate| %>
@@ -59,6 +60,7 @@
           <td><%= gate.name %></td>
           <td><%= gate.status %></td>
           <td><%= gate.updated_at.strftime('%F') %></td>
+          <td><%= link_to 'Destroy', gated_feature_path(gate), method: :delete, data: { confirm: "Destroying #{gate.name}, are you sure?" } %></td>
         </tr>
       <% end %>
     </table>

data/config/routes.rb

@@ -1,4 +1,4 @@
 FeatureGate::Engine.routes.draw do
-  resources :gated_features, only: [:index, :update]
+  resources :gated_features, only: [:index, :update, :destroy]
   get '/' => 'gated_features#index'
 end

data/lib/feature_gate/version.rb

@@ -1,3 +1,3 @@
 module FeatureGate
-  VERSION = '0.1.9'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_gate
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Tiffany Huang