simple_switch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e196b4dbccf7c2c73739986749bb98cd95ddd98
-  data.tar.gz: 9e6b4e88f48d8b07bf82565349c689bbb439c1c3
+  metadata.gz: 4f8379b3f743c3831e33cf764452d91835d03ece
+  data.tar.gz: 066a6820f1ae9d8dfe3b62870281baab8c4ee904
 SHA512:
-  metadata.gz: 0a9c14464bc5a31d7066fd9f69ef076cdb54b412c675d54265dc8c10ccdf343ef9fb322b183ad25759a6ab9aab1b6b54a1bd499c39f2261fbd1356d4d17e6b54
-  data.tar.gz: b6e2fcfca4bdbdbfb32cee9a3279781181ec733ca666323cf14e802b061e8cc333cac4978774abfe3d211b5b340333ac006e7829efcfd6007e5275f9455a50a7
+  metadata.gz: 8110097a9c077e7a8dfc7d00bd4e60c6e49f8acd1f877a1c009e7f7baecc1196b56b8418fb9c495788fad337c42950b31ea66bda24a2673b27ee1d728684630b
+  data.tar.gz: fbc574f38d60b26b78ecfa5a9895b931b5fc02388e4b573c1b088e9c11b00915f4fd4834a08426cd3cef3e52559abe5936373916a2a76eb6d1cc50c8cc12ecd7

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+ - "2.2.0"
+
+before_install: gem install bundler -v 1.10.6
+
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,12 @@
 # simple_switch Change Log
 
 All notable changes to this project will be documented in this file.
+
+simple_switch is in a 0.2.0 beta state. This means that its APIs and behavior are subject to breaking changes without deprecation notices.
+
+## [0.2.0](https://github.com/Sen-Zhang/simple_switch/releases/tag/v0.2.0) (2015-12-08)
+
+Changes:
+
+* Add tests
+* Refactor APIs for action_controller

data/README.md

@@ -3,6 +3,7 @@
 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)
+[![Build Status](https://travis-ci.org/Sen-Zhang/simple_switch.svg?branch=master)](https://travis-ci.org/Sen-Zhang/simple_switch)
 
 
 ## Requirement
@@ -27,4 +28,99 @@ Or install it yourself as:
 
 ## Usage
 
-  TODO
+### Basic
+
+Run install generator:
+
+    $ rails generate simple_switch:install
+
+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.
+
+      # 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'
+
+Then run the following commands to copy feature configuration yaml file to the target directory.
+
+Run install generator:
+
+    $ rails generate simple_switch:install_yaml
+
+Now you are ready to define features:
+
+    foo:
+        development: true
+        test: true
+        production: false
+
+    bar:
+        development: false
+        test: true
+        production: false
+
+Now you can use it in models like this:
+
+    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:
+
+    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 %>
+
+    <% if feature_off?(:bar) %>
+        <p>Experiment bar is off</p>
+    <% end %>
+
+### Toggle Features
+
+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_off(feature, env)` turn off a feature on a indicated environment.
+
+    turn_off(:foo, :development)

data/lib/simple_switch/shared_controller_methods.rb

@@ -5,8 +5,12 @@ module SimpleSwitch
       SimpleSwitch.feature_manager.feature_config
     end
 
-    def update_feature(feature, env, new_value)
-      SimpleSwitch.feature_manager.update(feature, env, new_value)
+    def turn_on(feature, env)
+      SimpleSwitch.feature_manager.update(feature, env, true)
+    end
+
+    def turn_off(feature, env)
+      SimpleSwitch.feature_manager.update(feature, env, false)
     end
 
   end

data/lib/simple_switch/version.rb

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

data/simple_switch.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rails', '~> 4.2.0'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
 end

data/spec/config/feature_config.yml

@@ -0,0 +1,9 @@
+---
+foo:
+  development: true
+  test: true
+  production: false
+bar:
+  development: true
+  test: false
+  production: true

data/spec/simple_switch_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe 'SimpleSwitch' do
+  describe 'Switch' do
+    it 'on? works fine' do
+      allow(Rails).to receive(:env).and_return('development')
+
+      expect(SimpleSwitch.feature_manager.on?(:foo)).to be_truthy
+      expect(SimpleSwitch.feature_manager.on?(:bar)).to be_truthy
+
+      allow(Rails).to receive(:env).and_return('test')
+
+      expect(SimpleSwitch.feature_manager.on?(:foo)).to be_truthy
+      expect(SimpleSwitch.feature_manager.on?(:bar)).to be_falsey
+
+      allow(Rails).to receive(:env).and_return('production')
+
+      expect(SimpleSwitch.feature_manager.on?(:foo)).to be_falsey
+      expect(SimpleSwitch.feature_manager.on?(:bar)).to be_truthy
+
+      expect(SimpleSwitch.feature_manager.on?(:foo, :development)).to be_truthy
+      expect(SimpleSwitch.feature_manager.on?(:bar, :development)).to be_truthy
+
+      expect(SimpleSwitch.feature_manager.on?(:foo, :test)).to be_truthy
+      expect(SimpleSwitch.feature_manager.on?(:bar, :test)).to be_falsey
+
+      expect(SimpleSwitch.feature_manager.on?(:foo, :production)).to be_falsey
+      expect(SimpleSwitch.feature_manager.on?(:bar, :production)).to be_truthy
+    end
+
+    it 'off? works fine' do
+      allow(Rails).to receive(:env).and_return('development')
+
+      expect(SimpleSwitch.feature_manager.off?(:foo)).to be_falsey
+      expect(SimpleSwitch.feature_manager.off?(:bar)).to be_falsey
+
+      allow(Rails).to receive(:env).and_return('test')
+
+      expect(SimpleSwitch.feature_manager.off?(:foo)).to be_falsey
+      expect(SimpleSwitch.feature_manager.off?(:bar)).to be_truthy
+
+      allow(Rails).to receive(:env).and_return('production')
+
+      expect(SimpleSwitch.feature_manager.off?(:foo)).to be_truthy
+      expect(SimpleSwitch.feature_manager.off?(:bar)).to be_falsey
+
+      expect(SimpleSwitch.feature_manager.off?(:foo, :development)).to be_falsey
+      expect(SimpleSwitch.feature_manager.off?(:bar, :development)).to be_falsey
+
+      expect(SimpleSwitch.feature_manager.off?(:foo, :test)).to be_falsey
+      expect(SimpleSwitch.feature_manager.off?(:bar, :test)).to be_truthy
+
+      expect(SimpleSwitch.feature_manager.off?(:foo, :production)).to be_truthy
+      expect(SimpleSwitch.feature_manager.off?(:bar, :production)).to be_falsey
+    end
+
+    it 'update works fine' do
+      expect(SimpleSwitch.feature_manager.on?(:foo, :development)).to be_truthy
+
+      SimpleSwitch.feature_manager.update(:foo, :development, false)
+
+      expect(SimpleSwitch.feature_manager.off?(:foo, :development)).to be_truthy
+
+      expect(SimpleSwitch.feature_manager.off?(:bar, :test)).to be_truthy
+
+      SimpleSwitch.feature_manager.update(:bar, :test, true)
+
+      expect(SimpleSwitch.feature_manager.on?(:bar, :test)).to be_truthy
+    end
+
+    it 'delete works fine' do
+      expect(SimpleSwitch.feature_manager.on?(:foo, :development)).to be_truthy
+
+      SimpleSwitch.feature_manager.delete(:foo)
+
+      expect {
+        SimpleSwitch.feature_manager.on?(:foo, :development)
+      }.to raise_error(RuntimeError, "Cannot find feature 'foo', check out your feature_config.yml file.")
+    end
+
+    it 'raise errors correctly' do
+      expect {
+        SimpleSwitch.feature_manager.update(:foobar, :development, false)
+      }.to raise_error(RuntimeError, "Cannot find feature 'foobar', check out your feature_config.yml file.")
+
+      expect {
+        SimpleSwitch.feature_manager.update(:foo, :dev, false)
+      }.to raise_error(RuntimeError, "Cannot find environment 'dev' for feature 'foo', check out your feature_config.yml file.")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+require 'rails'
+require 'simple_switch'
+
+Bundler.setup
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  config.order = :random
+
+  config.before :each do
+    # reset feature_config.yml
+    File.open('spec/config/feature_config.yml', 'w') do |f|
+      init_hash = HashWithIndifferentAccess.new(
+        {
+          foo: {
+            development: true,
+            test:        true,
+            production:  false
+          },
+          bar: {
+            development: true,
+            test:        false,
+            production:  true
+          }
+        }
+      )
+
+      f.puts init_hash.to_hash.to_yaml
+    end
+
+    allow_any_instance_of(SimpleSwitch::Switch).to receive(:file_path).and_return('spec/config/feature_config.yml')
+    SimpleSwitch.feature_manager.send(:reload_config!)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_switch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sen Zhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 description: Simple Feature Switch Engine
 email:
 - solowolf21@gmail.com
@@ -46,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -64,6 +94,9 @@ files:
 - lib/simple_switch/switch.rb
 - lib/simple_switch/version.rb
 - simple_switch.gemspec
+- spec/config/feature_config.yml
+- spec/simple_switch_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/Sen-Zhang/simple_switch
 licenses:
 - MIT
@@ -88,5 +121,8 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple Feature Switch Engine
-test_files: []
+test_files:
+- spec/config/feature_config.yml
+- spec/simple_switch_spec.rb
+- spec/spec_helper.rb
 has_rdoc: