simple_switch 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8379b3f743c3831e33cf764452d91835d03ece
-  data.tar.gz: 066a6820f1ae9d8dfe3b62870281baab8c4ee904
+  metadata.gz: 809dd823c24166538111b727e8cf8a270cbc7cb9
+  data.tar.gz: aaa927b1c39fad4af8bd64207aee1c9401a13166
 SHA512:
-  metadata.gz: 8110097a9c077e7a8dfc7d00bd4e60c6e49f8acd1f877a1c009e7f7baecc1196b56b8418fb9c495788fad337c42950b31ea66bda24a2673b27ee1d728684630b
-  data.tar.gz: fbc574f38d60b26b78ecfa5a9895b931b5fc02388e4b573c1b088e9c11b00915f4fd4834a08426cd3cef3e52559abe5936373916a2a76eb6d1cc50c8cc12ecd7
+  metadata.gz: e674618fc957becb492c60b92be41ae8d6a4bea8743c217ac85f12745ffd49297a1ff06f1dbe056a22670871c372a431af53fbbd818b089b581d41e994c33f74
+  data.tar.gz: 780a68a379e3af34c7c43a7ea5ddc2cc09c515f616084a69940cfb6b73538df7dbd3f4532b6a4167c893a48280cd4f999ad30dd1f5982fd2242f8eef32aa8d35

data/CHANGELOG.md

@@ -9,4 +9,13 @@ simple_switch is in a 0.2.0 beta state. This means that its APIs and behavior ar
 Changes:
 
 * Add tests
-* Refactor APIs for action_controller
+* Refactor APIs for action_controller
+
+## [0.3.0](https://github.com/Sen-Zhang/simple_switch/releases/tag/v0.3.0) (2015-12-17)
+
+Changes:
+
+* Minor refactor
+* Add another feature management strategy: store features and configurations in database instead of yml
+* Add turn_on and turn_off APIs
+* Add rake tasks to manage features and configurations for database strategy

data/README.md

@@ -8,7 +8,7 @@ Simple Feature Switch Engine
 
 ## Requirement
 * Ruby 2.0+
-* Rails 3.0+
+* Rails 4.0+
 
 ## Installation
 
@@ -28,88 +28,198 @@ Or install it yourself as:
 
 ## Usage
 
-### Basic
+### Database Strategy
+Store and manage features and configurations in database.
 
-Run install generator:
+Run initialize generator:
 
-    $ rails generate simple_switch:install
+    $ rails generate simple_switch:initialize
 
 A initializer file named `simple_switch.rb` will be added into `config/initializers` after running
-install generator. In that file, you can customize the feature configuration yaml file's name and
-installation place.
+install generator. Set feature store strategy to `:database` and leave configuration for yaml strategy
+commented out.
+
+````ruby
+  # feature management strategy
+  # the supported strategies are: [:yml, :database]
+  # default strategy is [:database]
+  config.feature_store = :database
+
+  # configuration for yml strategy
+  # feature switch configuration yaml file stored location, by default it is stored
+  # under config directory
+  # config.feature_config_file_dir  = 'config'
+
+  # configuration for yml strategy
+  # feature switch configuration yaml file name, by default it is 'feature_config.yml'
+  # config.feature_config_file_name = 'feature_config.yml'
+````
+Then run the following commands to copy required migration files to root application and migrate the database.
 
-      # feature switch configuration yaml file stored location, by default it is stored
-      # under config directory
-      config.feature_config_file_dir  = 'config'
+    $ rails generate simple_switch:install
+    $ bundle exec rake db:migrate
 
-      # feature switch configuration yaml file name, by default it is 'feature_config.yml'
-      config.feature_config_file_name = 'feature_config.yml'
+The data structure for `simple_switch` is described as followed:
 
-Then run the following commands to copy feature configuration yaml file to the target directory.
+![ERR Diagram](/images/err_diagram.png)
 
-Run install generator:
+The following rake tasks are created to generate data for features, environments and configurations. You can also
+add data through rails console.
 
-    $ rails generate simple_switch:install_yaml
+    $ bundle exec rake simple_switch:add_feature name='Foo' description='Foo feature'
+    $ bundle exec rake simple_switch:add_environment name='test'
+    $ bundle exec rake simple_switch:add_feature_config feature='foo' environment='test' status=true
 
-Now you are ready to define features:
-
-    foo:
-        development: true
-        test: true
-        production: false
+Now you can use it in models like this:
 
-    bar:
-        development: false
-        test: true
-        production: false
+````ruby
+class TestModel < ActiveRecord::Base
+  ...
 
-Now you can use it in models like this:
+  if feature_on?(:foo)
+    def foo_method
+      ...
+    end
+  end
 
-    class TestModel < ActiveRecord::Base
+  def bar_method
+    if feature_on?(:bar)
       ...
+    end
+  end
 
-      if feature_on?(:foo)
-        def foo_method
-          ...
-        end
-      end
+  ...
+end
+````
+In controllers like this:
 
-      def bar_method
-        if feature_on?(:bar)
-          ...
-        end
-      end
+````ruby
+class TestController < ApplicationController
+  ...
 
-      ...
+  def index
+    ...
+
+    if feature_on?(:foo)
+      redirect_to :back
     end
 
-In controllers like this:
+    ...
+  end
 
-    class TestController < ApplicationController
-      ...
+  ...
+end
+````
+And in views like this:
+
+````erb
+<% if feature_on?(:foo) %>
+  <p>Experiment foo is on</p>
+<% end %>
+
+<% if feature_off?(:bar) %>
+  <p>Experiment bar is off</p>
+<% end %>
+````
+
+### YML Strategy
+Store and manage features and configurations all in a single yaml file.
 
-      def index
-        ...
+Run initialize generator:
 
-        if feature_on?(:foo)
-          redirect_to :back
-        end
+    $ rails generate simple_switch:initialize
 
-        ...
-      end
+A initializer file named `simple_switch.rb` will be added into `config/initializers` after running
+install generator. Set feature store strategy to `:yml` and customize the feature configuration yaml
+file's name and installation place in this file.
+
+````ruby
+  # feature management strategy
+  # the supported strategies are: [:yml, :database]
+  # default strategy is [:database]
+  config.feature_store = :yml
+
+  # configuration for yml strategy
+  # feature switch configuration yaml file stored location, by default it is stored
+  # under config directory
+  config.feature_config_file_dir  = 'config'
+
+  # configuration for yml strategy
+  # feature switch configuration yaml file name, by default it is 'feature_config.yml'
+  config.feature_config_file_name = 'feature_config.yml'
+````
+Then run the following commands to copy feature configuration yaml file to the target directory.
+
+Run install generator:
+
+    $ rails generate simple_switch:install
 
+Now you are ready to define features:
+````yml
+foo:
+  description: Foo Feature
+  states:
+    development: true
+    test: true
+    production: false
+bar:
+  description: Bar Feature
+  states:
+    development: true
+    test: true
+    production: true
+````
+Now you can use it in models like this:
+
+````ruby
+class TestModel < ActiveRecord::Base
+  ...
+
+  if feature_on?(:foo)
+    def foo_method
       ...
     end
+  end
 
+  def bar_method
+    if feature_on?(:bar)
+      ...
+    end
+  end
+
+  ...
+end
+````
+In controllers like this:
+
+````ruby
+class TestController < ApplicationController
+  ...
+
+  def index
+    ...
+
+    if feature_on?(:foo)
+      redirect_to :back
+    end
+
+    ...
+  end
+
+  ...
+end
+````
 And in views like this:
 
-    <% if feature_on?(:foo) %>
-        <p>Experiment foo is on</p>
-    <% end %>
+````erb
+<% if feature_on?(:foo) %>
+  <p>Experiment foo is on</p>
+<% end %>
 
-    <% if feature_off?(:bar) %>
-        <p>Experiment bar is off</p>
-    <% end %>
+<% if feature_off?(:bar) %>
+  <p>Experiment bar is off</p>
+<% end %>
+````
 
 ### Toggle Features
 
@@ -117,10 +227,17 @@ The following methods are only accessible in controllers:
 
 `feature_config_info` return a hash represents the current feature configuration condition.
 
-`turn_on(feature, env)` turn on a feature on a indicated environment.
-
-    turn_on(:foo, :development)
+`turn_on(feature, env)` turn on a feature on an indicated environment.
+````ruby
+turn_on(:foo, :development)
+````
+`turn_off(feature, env)` turn off a feature on an indicated environment.
+````ruby
+turn_off(:foo, :development)
+````
 
-`turn_off(feature, env)` turn off a feature on a indicated environment.
+The following rake tasks are created to toggle features for database strategy only, and feature
+name and environment name are required:
 
-    turn_off(:foo, :development)
+    $ bundle exec rake simple_switch:turn_on feature='foo' environment='test'
+    $ bundle exec rake simple_switch:turn_off feature='foo' environment='test'

data/Rakefile

@@ -1 +1,21 @@
-require 'bundler/gem_tasks'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleSwitch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/simple_switch/application.js

@@ -0,0 +1 @@
+//= require_tree .

data/app/assets/stylesheets/simple_switch/application.css

@@ -0,0 +1,4 @@
+/*
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/simple_switch/application_controller.rb

@@ -0,0 +1,4 @@
+module SimpleSwitch
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/simple_switch/application_helper.rb

@@ -0,0 +1,4 @@
+module SimpleSwitch
+  module ApplicationHelper
+  end
+end

data/app/models/simple_switch/environment.rb

@@ -0,0 +1,8 @@
+module SimpleSwitch
+  class Environment < ActiveRecord::Base
+    has_many :states, dependent: :destroy
+    has_many :features, through: :states
+
+    validates :name, presence: true, uniqueness: true
+  end
+end

data/app/models/simple_switch/feature.rb

@@ -0,0 +1,8 @@
+module SimpleSwitch
+  class Feature < ActiveRecord::Base
+    has_many :states, dependent: :destroy
+    has_many :environments, through: :states
+
+    validates :name, presence: true, uniqueness: true
+  end
+end

data/app/models/simple_switch/state.rb

@@ -0,0 +1,15 @@
+module SimpleSwitch
+  class State < ActiveRecord::Base
+    before_save :set_default_status, if: proc { |s| s.status.nil? }
+
+    belongs_to :feature
+    belongs_to :environment
+
+    validates_presence_of :feature_id, :environment_id
+
+    private
+    def set_default_status
+      status = false;
+    end
+  end
+end

data/app/views/layouts/simple_switch/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SimpleSwitch</title>
+  <%= stylesheet_link_tag    'simple_switch/application', media: 'all' %>
+  <%= javascript_include_tag 'simple_switch/application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+SimpleSwitch::Engine.routes.draw do
+end

data/db/migrate/20151216180633_create_simple_switch_tables.simple_switch.rb

@@ -0,0 +1,24 @@
+class CreateSimpleSwitchTables < ActiveRecord::Migration
+  def change
+    create_table :simple_switch_features do |t|
+      t.string :name, null: false, index: true
+      t.string :description, limit: 500
+
+      t.timestamps null: false
+    end
+
+    create_table :simple_switch_environments do |t|
+      t.string :name, null: false, index: true
+
+      t.timestamps null: false
+    end
+
+    create_table :simple_switch_states do |t|
+      t.boolean :status,         default: false
+      t.belongs_to :feature,     index: true
+      t.belongs_to :environment, index: true
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/simple_switch/initialize_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/base'
+
+module SimpleSwitch
+  module Generators
+
+    class InitializeGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Copy initializer file simple_switch.rb to config/initializers.'
+
+      def copy_initializer
+        copy_file 'simple_switch.rb', 'config/initializers/simple_switch.rb'
+      end
+    end
+
+  end
+end