simple_switch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e196b4dbccf7c2c73739986749bb98cd95ddd98
+  data.tar.gz: 9e6b4e88f48d8b07bf82565349c689bbb439c1c3
+SHA512:
+  metadata.gz: 0a9c14464bc5a31d7066fd9f69ef076cdb54b412c675d54265dc8c10ccdf343ef9fb322b183ad25759a6ab9aab1b6b54a1bd499c39f2261fbd1356d4d17e6b54
+  data.tar.gz: b6e2fcfca4bdbdbfb32cee9a3279781181ec733ca666323cf14e802b061e8cc333cac4978774abfe3d211b5b340333ac006e7829efcfd6007e5275f9455a50a7

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.idea
+.ruby-version

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# simple_switch Change Log
+
+All notable changes to this project will be documented in this file.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_switch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sen Zhang
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Simple Switch
+
+Simple Feature Switch Engine
+
+[![Code Climate](https://codeclimate.com/github/Sen-Zhang/simple_switch/badges/gpa.svg)](https://codeclimate.com/github/Sen-Zhang/simple_switch)
+
+
+## Requirement
+* Ruby 2.0+
+* Rails 3.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_switch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_switch
+
+## Usage
+
+  TODO

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/codeclimate.yml

@@ -0,0 +1,3 @@
+engines:
+  rubocop:
+    enabled: true

data/lib/generators/simple_switch/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/base'
+
+module SimpleSwitch
+  module Generators
+
+    class InstallGenerator < 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

data/lib/generators/simple_switch/install_yaml_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/base'
+
+module SimpleSwitch
+  module Generators
+
+    class InstallYamlGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Copy feature configuration sample file feature_config_sample.yml to your application.'
+
+      def copy_initializer
+        copy_file 'feature_config_sample.yml',
+                  "#{SimpleSwitch::feature_config_file_dir}/#{SimpleSwitch::feature_config_file_name}"
+      end
+    end
+
+  end
+end

data/lib/generators/templates/feature_config_sample.yml

@@ -0,0 +1,17 @@
+# Example:
+#
+# feature_foo:
+#   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

data/lib/generators/templates/simple_switch.rb

@@ -0,0 +1,10 @@
+SimpleSwitch.setup do |config|
+
+  # feature switch configuration yaml file stored location, by default it is stored
+  # under config directory
+  config.feature_config_file_dir  = 'config'
+
+  # feature switch configuration yaml file name, by default it is 'feature_config.yml'
+  config.feature_config_file_name = 'feature_config.yml'
+
+end

data/lib/simple_switch.rb

@@ -0,0 +1,26 @@
+require 'simple_switch/version'
+
+module SimpleSwitch
+  mattr_accessor :feature_config_file_dir
+  @@feature_config_file_name = 'config'
+
+  mattr_accessor :feature_config_file_name
+  @@feature_config_file_name = 'feature_config.yml'
+
+  def self.setup
+    yield self
+  end
+
+  def self.feature_manager
+    SimpleSwitch::Switch.instance
+  end
+
+  class Engine < ::Rails::Engine
+  end
+end
+
+require 'simple_switch/switch'
+require 'simple_switch/shared_methods'
+require 'simple_switch/shared_controller_methods'
+require 'simple_switch/action_controller/base'
+require 'simple_switch/active_record/base'

data/lib/simple_switch/action_controller/base.rb

@@ -0,0 +1,10 @@
+require 'action_controller'
+
+module SimpleSwitch
+  class ActionController::Base
+    include SimpleSwitch::SharedMethods
+    include SimpleSwitch::SharedControllerMethods
+
+    helper_method :feature_on?, :feature_off?
+  end
+end

data/lib/simple_switch/active_record/base.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+module SimpleSwitch
+  class ActiveRecord::Base
+    extend SimpleSwitch::SharedMethods
+    include SimpleSwitch::SharedMethods
+  end
+end

data/lib/simple_switch/shared_controller_methods.rb

@@ -0,0 +1,13 @@
+module SimpleSwitch
+  module SharedControllerMethods
+
+    def feature_config_info
+      SimpleSwitch.feature_manager.feature_config
+    end
+
+    def update_feature(feature, env, new_value)
+      SimpleSwitch.feature_manager.update(feature, env, new_value)
+    end
+
+  end
+end

data/lib/simple_switch/shared_methods.rb

@@ -0,0 +1,13 @@
+module SimpleSwitch
+  module SharedMethods
+
+    def feature_on?(feature)
+      SimpleSwitch.feature_manager.on?(feature)
+    end
+
+    def feature_off?(feature)
+      !feature_on?(feature)
+    end
+
+  end
+end

data/lib/simple_switch/switch.rb

@@ -0,0 +1,77 @@
+module SimpleSwitch
+  class Switch
+    def initialize
+      @feature_config = load_config
+    end
+
+    def self.instance
+      return @@instance ||= send(:new)
+    end
+
+    private_class_method :new
+
+    def on?(feature, env=Rails.env)
+      @feature_config[feature][env] if valid_feature_name_for_env?(feature, env)
+    end
+
+    def off?(feature, env=Rails.env)
+      !on?(feature, env)
+    end
+
+    def update(feature, env, value)
+      @feature_config[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(SimpleSwitch::feature_config_file_dir, SimpleSwitch::feature_config_file_name)
+    end
+
+    def load_config
+      HashWithIndifferentAccess.new(YAML::load(File.open(file_path)))
+    end
+
+    def reload_config!
+      @feature_config = load_config
+    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?(feature)
+      reload_config! unless @feature_config.has_key?(feature)
+
+      return true if @feature_config.has_key?(feature)
+
+      raise "Cannot find feature '#{feature}', check out your "\
+            "#{SimpleSwitch::feature_config_file_name} file."
+    end
+
+    def valid_feature_name_for_env?(feature, env=Rails.env)
+      valid_feature_name?(feature)
+
+      return true if @feature_config[feature].has_key?(env)
+
+      raise "Cannot find environment '#{env}' for feature '#{feature}', "\
+            "check out your #{SimpleSwitch::feature_config_file_name} file."
+    end
+  end
+end

data/lib/simple_switch/version.rb

@@ -0,0 +1,3 @@
+module SimpleSwitch
+  VERSION = '0.1.0'
+end

data/simple_switch.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'simple_switch/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'simple_switch'
+  spec.version     = SimpleSwitch::VERSION
+  spec.authors     = ['Sen Zhang']
+  spec.email       = ['solowolf21@gmail.com']
+  spec.summary     = %q{Simple Feature Switch Engine}
+  spec.description = %q{Simple Feature Switch Engine}
+  spec.homepage    = 'https://github.com/Sen-Zhang/simple_switch'
+  spec.license     = 'MIT'
+
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: simple_switch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sen Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple Feature Switch Engine
+email:
+- solowolf21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- codeclimate.yml
+- lib/generators/simple_switch/install_generator.rb
+- lib/generators/simple_switch/install_yaml_generator.rb
+- lib/generators/templates/feature_config_sample.yml
+- lib/generators/templates/simple_switch.rb
+- lib/simple_switch.rb
+- lib/simple_switch/action_controller/base.rb
+- lib/simple_switch/active_record/base.rb
+- lib/simple_switch/shared_controller_methods.rb
+- lib/simple_switch/shared_methods.rb
+- lib/simple_switch/switch.rb
+- lib/simple_switch/version.rb
+- simple_switch.gemspec
+homepage: https://github.com/Sen-Zhang/simple_switch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple Feature Switch Engine
+test_files: []
+has_rdoc: