feature_toggles 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b6aff154b3d0208aa37c53a90c3068e2a69fa393ba9e2e3b4a946e17f7479f2
-  data.tar.gz: d2aedea7c963de5cabcec3650b576eb20db4401ae3166978ab0cc0b76e998ebd
+  metadata.gz: ced315883f27c7dfa71e43d3b04a2e0c6111d7e3ab24ebb2d96b309880349abc
+  data.tar.gz: 2567a6b58344a5b1b05c2380374ef85e1325119a243af0310003b2ad170838bf
 SHA512:
-  metadata.gz: 33972a4e5055b04dc3b6507d44b76fa6ed4ed81b594d086c6c0dfba579cf2fe09dbe0d06ccce9aad54390c33640087e61334edb22591cd81424f6b7903a6eb31
-  data.tar.gz: 7e50201fd0c9b9d9ac10babf891bd76bf5337303f2b46a7ad9026d38095ce71a5bdc9b0444efdf4158bbb9344f51ce26f406e0aac75e9695d9dffe03550ea9e6
+  metadata.gz: f3d9058efacee049c3feed1bc5878e3ba301d2e1d424954e8f871e802d2e31f110503a870b6f7dc90a92a84cca9012e02cacc5eb8c3ca52c2af912547fc05e20
+  data.tar.gz: 6f80548653e6f6f6792ef1a0b42c385d9def25c730a91d10d41e3b1d13d49442ecd8e799d7a0d66ac3e591366f207c7723b685b314a2ce670251ef5c0495f9c3

data/README.md

@@ -5,7 +5,7 @@
 
 This gem provides a mechanism for pending features that take longer than a single release cycle. The basic idea is to have a configuration file that defines a bunch of toggles for various features you have pending. The running application then uses these toggles in order to decide whether or not to show the new feature.
 
-<a href="https://evilmartians.com/?utm_source=activerecord-postgres_enum">
+<a href="https://evilmartians.com/?utm_source=feature_toggles">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
 
 ## Installation
@@ -13,7 +13,7 @@ This gem provides a mechanism for pending features that take longer than a singl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'feature_toggles'
+gem "feature_toggles"
 ```
 
 And then execute:
@@ -24,7 +24,9 @@ Or install it yourself as:
 
     $ gem install feature_toggles
 
-## Usage
+## Framework-agnostic usage
+
+Features could be defined dynamically
 
 ```ruby
 features = FeatureToggles.build do
@@ -46,6 +48,81 @@ features.enabled?(:bar, user: user)
 features.for(user: user).enabled?(:foo)
 ```
 
+or loaded from files
+
+```ruby
+features = FeatureToggles.build(["/path/to/features.rb"])
+```
+
+### Rails usage
+
+This is step-by-step guide to add `feature_toggles` to Rails application.
+
+**Step 0. (optional) Add `features` to User model**
+
+**NOTE**: This is not the part of this gem–you can model you per-user features settings differently.
+
+```ruby
+class AddFeaturesToUsers < ActiveRecord::Migration
+  def change
+    # we use a `features` array column to store user's active features
+    add_column :users, :features, :string, array: true, default: []
+  end
+end
+```
+
+**Step 1. Define features**
+
+Features from file `<rails-root-or-engine>/config/initializers/features.rb` are loaded by convention.
+
+```ruby
+# config/initializers/features.rb
+env "FEATURE"
+
+feature :chat do |user: nil|
+  user&.features.include?("chat")
+end
+```
+
+Features will be available at `Rails.features` after the end of application initialization.
+
+**Step 2. Add `current_features` helper and use it.**
+
+```ruby
+class ApplicationController < ActionController::Base
+  # ...
+  helper_method :current_features
+
+  def current_features
+    Rails.features.for(user: current_user)
+  end
+end
+```
+
+**Step 3. Use `current_features`.**
+
+For example, in your navigation template:
+
+```erb
+<ul>
+ <% if current_features.enabled?(:chat) %>
+   <li><a href="/chat">Chat</a></li>
+ <% end %>
+</ul>
+```
+
+Or in your controller:
+
+```ruby
+class ChatController < ApplicationController
+  def index
+    unless current_features.enabled?(:chat)
+      return render template: "comming_soon"
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/feature_toggles/mechatronic.rb

@@ -7,9 +7,13 @@ module FeatureToggles
     # Which env variables should be considered truthy
     POSSIBLE_ENABLING_VALUES = %w(true on yes 1).freeze
 
-    def initialize(&block)
+    def initialize(definition_file_paths = nil, &block)
       @features = {}
 
+      definition_file_paths&.each do |file|
+        instance_eval(File.read(file), file)
+      end
+
       instance_eval(&block) if block_given?
     end
 

data/lib/feature_toggles/railtie.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Rails
+  class << self
+    delegate :features, to: "application.config"
+  end
+end
+
+module FeatureToggles
+  class Railtie < ::Rails::Railtie
+    config.to_prepare do
+      paths = []
+
+      ::Rails.application.railties.each do |railtie|
+        next unless railtie.respond_to?(:root)
+
+        file = railtie.root.join("config", "features.rb")
+        next unless file.exist?
+
+        paths << file.to_s
+      end
+
+      # Rails-root features must be last to override engines' configuration
+      file = ::Rails.root.join("config", "features.rb")
+      paths << file.to_s if file.exist?
+
+      Rails.application.config.features = FeatureToggles.build(paths)
+    end
+  end
+end

data/lib/feature_toggles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FeatureToggles
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/feature_toggles.rb

@@ -6,7 +6,9 @@ require "feature_toggles/mechatronic"
 module FeatureToggles
   module_function
 
-  def build(&block)
-    Mechatronic.new(&block)
+  def build(file_paths = nil, &block)
+    Mechatronic.new(file_paths, &block)
   end
 end
+
+require "feature_toggles/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_toggles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +106,7 @@ files:
 - lib/feature_toggles.rb
 - lib/feature_toggles/mechatronic.rb
 - lib/feature_toggles/proxy.rb
+- lib/feature_toggles/railtie.rb
 - lib/feature_toggles/version.rb
 homepage: https://github.com/bibendi/feature_toggles
 licenses: