simple_switch 0.2.0 → 0.3.0

data/lib/generators/simple_switch/install_generator.rb

@@ -6,10 +6,20 @@ module SimpleSwitch
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('../../templates', __FILE__)
 
-      desc 'Copy initializer file simple_switch.rb to config/initializers.'
+      desc 'Copy required files for each strategy'
 
-      def copy_initializer
-        copy_file 'simple_switch.rb', 'config/initializers/simple_switch.rb'
+      def copy_files
+        case SimpleSwitch.feature_store
+        when :database
+          # Copy the migration file to db/migrate.
+          copy_file 'migration.rb',
+                    "db/migrate/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_create_simple_switch_tables.simple_switch.rb"
+        when :yml
+          # Copy feature configuration sample file feature_config_sample.yml to customized location.
+          copy_file 'feature_config_sample.yml',
+                    "#{SimpleSwitch.feature_config_file_dir}/#{SimpleSwitch.feature_config_file_name}"
+        else
+        end
       end
     end
 

data/lib/generators/templates/feature_config_sample.yml

@@ -1,17 +1,21 @@
 # Example:
 #
 # feature_foo:
-#   development: true
-#   test: true
-#   dev: true
-#   qa: true
-#   prodstage: true
-#   production: false
+#   description: Foo Feature
+#   states:
+#     development: true
+#     test: true
+#     dev: true
+#     qa: true
+#     prodstage: true
+#     production: false
 #
 # feature_bar:
-#   development: true
-#   test: true
-#   dev: true
-#   qa: true
-#   prodstage: true
-#   production: true
+#   description: Bar Feature
+#   states:
+#     development: true
+#     test: true
+#     dev: true
+#     qa: true
+#     prodstage: true
+#     production: true

data/lib/generators/templates/migration.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/templates/simple_switch.rb

@@ -1,10 +1,17 @@
 SimpleSwitch.setup do |config|
 
+  # 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'
+  # 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'
+  # config.feature_config_file_name = 'feature_config.yml'
 
 end

data/lib/simple_switch.rb

@@ -1,6 +1,9 @@
-require 'simple_switch/version'
+require 'simple_switch/engine'
 
 module SimpleSwitch
+  mattr_accessor :feature_store
+  @@feature_store = :database
+
   mattr_accessor :feature_config_file_dir
   @@feature_config_file_name = 'config'
 
@@ -12,15 +15,16 @@ module SimpleSwitch
   end
 
   def self.feature_manager
-    SimpleSwitch::Switch.instance
-  end
-
-  class Engine < ::Rails::Engine
+    SimpleSwitch::FeatureManager.get_manager
   end
 end
 
-require 'simple_switch/switch'
+require 'simple_switch/manager_shared_methods'
+require 'simple_switch/feature_manager_db'
+require 'simple_switch/feature_manager_yaml'
+require 'simple_switch/feature_manager'
 require 'simple_switch/shared_methods'
 require 'simple_switch/shared_controller_methods'
 require 'simple_switch/action_controller/base'
 require 'simple_switch/active_record/base'
+require 'simple_switch/railtie'

data/lib/simple_switch/engine.rb

@@ -0,0 +1,10 @@
+module SimpleSwitch
+  class Engine < ::Rails::Engine
+    isolate_namespace SimpleSwitch
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end

data/lib/simple_switch/feature_manager.rb

@@ -0,0 +1,15 @@
+module SimpleSwitch
+  class FeatureManager
+    class << self
+      def get_manager
+        case SimpleSwitch.feature_store
+        when :database
+          FeatureManagerDb.instance
+        when :yml
+          FeatureManagerYaml.instance
+        else
+        end
+      end
+    end
+  end
+end

data/lib/simple_switch/feature_manager_db.rb

@@ -0,0 +1,88 @@
+module SimpleSwitch
+  class FeatureManagerDb
+    include SimpleSwitch::ManagerSharedMethods
+    attr_reader :feature_config
+
+    def initialize
+      @feature_config = load_config
+    end
+
+    def self.instance
+      return @@instance ||= send(:new)
+    end
+
+    private_class_method :new
+
+    def has_feature?(feature)
+      SimpleSwitch::Feature.find_by_name(feature).present?
+    end
+
+    def add_feature(options)
+      feature = SimpleSwitch::Feature.find_or_create_by(name: options[:name])
+      feature.update(description: options[:description])
+
+      reload_config!
+    end
+
+    def has_environment?(environment)
+      SimpleSwitch::Environment.find_by_name(environment).present?
+    end
+
+    def add_environment(options)
+      SimpleSwitch::Environment.find_or_create_by(name: options[:name])
+
+      reload_config!
+    end
+
+    def add_state(options)
+      feature     = SimpleSwitch::Feature.find_by_name(options[:feature])
+      environment = SimpleSwitch::Environment.find_by_name(options[:environment])
+
+      feature.states.create(status: options[:status], environment: environment)
+      reload_config!
+    end
+
+    def update(feature, env, value)
+      states(feature)[env][0] = value if valid_feature_name_for_env?(feature, env)
+
+      SimpleSwitch::State.update(states(feature)[env][1], status: value)
+    end
+
+    def delete(feature)
+      feature_config.delete(feature) if valid_feature_name?(feature)
+
+      SimpleSwitch::Feature.find_by_name(feature).destroy
+    end
+
+    private
+
+    def load_config
+      features = SimpleSwitch::Feature.includes([:states, :environments]).all
+
+      HashWithIndifferentAccess.new(
+        features.inject({}) do |hash, f|
+          hash.merge(
+            f.name => {
+              description: f.description,
+              states:      f.states.inject({}) { |h, s| h.merge(s.environment.name => [s.status, s.id]) }
+            })
+        end
+      )
+    end
+
+    def valid_feature_name_with_message?(feature)
+      return true if valid_feature_name_without_message?(feature)
+
+      raise "Cannot find feature '#{feature}', check out your database."
+    end
+
+    def valid_feature_name_for_env_with_message?(feature, env=Rails.env)
+      return true if valid_feature_name_for_env_without_message?(feature, env)
+
+      raise "Cannot find environment '#{env}' for feature '#{feature}', check out your database."
+    end
+
+    alias_method_chain :valid_feature_name?, :message
+    alias_method_chain :valid_feature_name_for_env?, :message
+  end
+end

data/lib/simple_switch/feature_manager_yaml.rb

@@ -0,0 +1,68 @@
+module SimpleSwitch
+  class FeatureManagerYaml
+    include SimpleSwitch::ManagerSharedMethods
+    attr_reader :feature_config, :file_dir, :file_name
+
+    def initialize
+      @file_dir       = SimpleSwitch.feature_config_file_dir
+      @file_name      = SimpleSwitch.feature_config_file_name
+      @feature_config = load_config
+    end
+
+    def self.instance
+      return @@instance ||= send(:new)
+    end
+
+    private_class_method :new
+
+    def update(feature, env, value)
+      states(feature)[env] = value if valid_feature_name_for_env?(feature, env)
+
+      save_to_yaml
+    end
+
+    def delete(feature)
+      feature_config.delete(feature) if valid_feature_name?(feature)
+
+      save_to_yaml
+    end
+
+    private
+
+    def file_path
+      Rails.root.join(file_dir, file_name)
+    end
+
+    def load_config
+      HashWithIndifferentAccess.new(YAML::load(File.open(file_path)))
+    end
+
+    def save_to_yaml
+      begin
+        File.open(file_path, 'w') do |f|
+          f.puts @feature_config.to_hash.to_yaml
+        end
+
+        true
+      rescue
+        false
+      end
+    end
+
+    def valid_feature_name_with_message?(feature)
+      return true if valid_feature_name_without_message?(feature)
+
+      raise "Cannot find feature '#{feature}', check out your #{file_name} file."
+    end
+
+    def valid_feature_name_for_env_with_message?(feature, env=Rails.env)
+      return true if valid_feature_name_for_env_without_message?(feature, env)
+
+      raise "Cannot find environment '#{env}' for feature '#{feature}', "\
+            "check out your #{file_name} file."
+    end
+
+    alias_method_chain :valid_feature_name?, :message
+    alias_method_chain :valid_feature_name_for_env?, :message
+  end
+end

data/lib/simple_switch/manager_shared_methods.rb

@@ -0,0 +1,52 @@
+module SimpleSwitch
+  module ManagerSharedMethods
+
+    def on?(feature, env=Rails.env)
+      reload_config! if env == 'development'
+
+      begin
+        if valid_feature_name_for_env?(feature, env)
+          config = states(feature)[env]
+
+          config.is_a?(Array) ? config[0] : config
+        end
+      rescue
+        true
+      end
+    end
+
+    def off?(feature, env=Rails.env)
+      !on?(feature, env)
+    end
+
+    def turn_on(feature, env)
+      update(feature, env, true)
+    end
+
+    def turn_off(feature, env)
+      update(feature, env, false)
+    end
+
+    private
+    def reload_config!
+      @feature_config = load_config
+    end
+
+    def states(feature)
+      feature_config[feature][:states]
+    end
+
+    def valid_feature_name?(feature)
+      reload_config! unless feature_config.has_key?(feature)
+
+      feature_config.has_key?(feature)
+    end
+
+    def valid_feature_name_for_env?(feature, env)
+      valid_feature_name?(feature)
+
+      states(feature).has_key?(env)
+    end
+
+  end
+end

data/lib/simple_switch/railtie.rb

@@ -0,0 +1,12 @@
+require 'simple_switch'
+require 'rails'
+
+module SimpleSwitch
+  class Railtie < Rails::Railtie
+    railtie_name :simple_switch
+
+    rake_tasks do
+      load 'tasks/simple_switch.rake'
+    end
+  end
+end

data/lib/simple_switch/shared_controller_methods.rb

@@ -6,11 +6,11 @@ module SimpleSwitch
     end
 
     def turn_on(feature, env)
-      SimpleSwitch.feature_manager.update(feature, env, true)
+      SimpleSwitch.feature_manager.turn_on(feature, env)
     end
 
     def turn_off(feature, env)
-      SimpleSwitch.feature_manager.update(feature, env, false)
+      SimpleSwitch.feature_manager.turn_off(feature, env)
     end
 
   end

data/lib/simple_switch/version.rb

@@ -1,3 +1,3 @@
 module SimpleSwitch
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/tasks/simple_switch.rake

@@ -0,0 +1,106 @@
+namespace :simple_switch do
+
+  # eg: bundle exec rake simple_switch:add_feature name='Foo' description='Foo feature'
+  desc 'Add a feature'
+  task :add_feature => :environment do
+    check_strategy
+
+    name            = ENV['name']
+    description     = ENV['description']
+    feature_manager = SimpleSwitch.feature_manager
+
+    abort 'Feature name is required.' if name.blank?
+    abort "Feature #{name} already exists." if feature_manager.has_feature?(name)
+
+    feature_manager.add_feature(name: name, description: description)
+    abort "Feature #{name} added."
+  end
+
+  # eg: bundle exec rake simple_switch:add_environment name='test'
+  desc 'Add an environment'
+  task :add_environment => :environment do
+    check_strategy
+
+    name            = ENV['name']
+    feature_manager = SimpleSwitch.feature_manager
+
+    abort 'Environment name is required.' if name.blank?
+    abort "Environment #{name} already exists." if feature_manager.has_environment?(name)
+
+    feature_manager.add_environment(name: name)
+    abort "Environment #{name} added."
+  end
+
+  # eg: bundle exec rake simple_switch:add_feature_config feature='foo' environment='test' status=true
+  desc 'Add feature configuration'
+  task :add_feature_config => :environment do
+    check_strategy
+
+    feature     = ENV['feature']
+    environment = ENV['environment']
+    status      = ENV['status']
+
+    feature_manager = SimpleSwitch.feature_manager
+
+    abort 'Feature name is required.' if feature.blank?
+    abort "Feature #{feature} does not exist, add this feature first." unless feature_manager.has_feature?(feature)
+    abort 'Environment name is required.' if environment.blank?
+    abort "Environment #{environment} does not exist, add this environment first." unless feature_manager.has_environment?(environment)
+
+    feature_manager.add_state(feature: feature, environment: environment, status: status)
+
+    abort 'Feature configuration added.'
+  end
+
+  # eg: bundle exec rake simple_switch:turn_on feature='foo' environment='test'
+  desc 'Turn on feature for an environment'
+  task :turn_on => :environment do
+    toggle_feature_task(:on)
+  end
+
+  # eg: bundle exec rake simple_switch:turn_off feature='foo' environment='test'
+  desc 'Turn off feature for an environment'
+  task :turn_off => :environment do
+    toggle_feature_task(:off)
+  end
+
+  private
+  def check_strategy
+    # TODO: Temporarily disable rake tasks for yml strategy
+    abort "'yml' strategy does not support this task, please modify feature"\
+          ' configuration yaml file instead.' if SimpleSwitch.feature_store != :database
+  end
+
+  def toggle_feature_task(status)
+    check_strategy
+
+    environment, feature, feature_manager = validate_args
+    toggle_feature(feature, environment, feature_manager, status)
+  end
+
+  def validate_args
+    feature     = ENV['feature']
+    environment = ENV['environment']
+
+    feature_manager = SimpleSwitch.feature_manager
+
+    abort 'Feature name is required.' if feature.blank?
+    abort "Feature #{feature} does not exist." unless feature_manager.has_feature?(feature)
+    abort 'Environment name is required.' if environment.blank?
+    abort "Environment #{environment} does not exist, add this environment first." unless feature_manager.has_environment?(environment)
+    return environment, feature, feature_manager
+  end
+
+  def toggle_feature(feature, environment, feature_manager, status)
+    success_msg   = "Feature '#{feature}' has been turned #{status} for environment '#{environment}'."
+    error_msg     = "Feature '#{feature}' is not configured on environment '#{environment}'."
+    toggle_method = status == :on ? :turn_on : :turn_off
+
+    begin
+      feature_manager.send(toggle_method, feature, environment)
+      abort success_msg
+    rescue
+      abort error_msg
+    end
+  end
+end