experiment_light 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e46f730bc84ca401359ce193ffb06b539b013de
-  data.tar.gz: 62f675859403c020698c4db0db056a0c211a8b07
+  metadata.gz: 321c9146d36b78ece9250963412a581b6192e6db
+  data.tar.gz: b768c6980f76478ef05f3d2df343d3cd189a9621
 SHA512:
-  metadata.gz: e1a1395399d93afffd9aa79b92c31941132b686c9abac3cb71461a63206c9929b3b9beb74afd59aa1ed8fb9e2b32cfb814f9bbece8908692a429938a1e08257b
-  data.tar.gz: 747ef726a4ce0dfe7c210f8e23c6d796ecfc3a67da425ee88522598f9623da6a304187e9914a6401eda8481f2c88109c0c8a169499c9688b0d8b9e94e4f31557
+  metadata.gz: 278303702d11befe8cf853813b297850f53a84be2525c3e0b99698961b1f010e791278c17435fec5dccc6129adb153d3935d427104cbe718030e428da1af3d8b
+  data.tar.gz: 4d99cfbb06591974c319268e74e08e0d743fdc36e6934b8f5971f4fdf583e78a6fe497f3741250bb0a3537f1fec7fd7a8d9253abdd45c3b95c4bc11912228e7a

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+languages:
+  Ruby: true
+  JavaScript: true
+
+exclude_paths:
+  - "pkg"

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - "2.2.0"
+
+script: bundle exec rspec spec

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in experiment_light.gemspec
 gemspec
-
-gem 'rails', '~> 4.2.0'

data/README.md

@@ -1,4 +1,7 @@
-# Experiment::Light
+# ExperimentLight
+
+[![Code Climate](https://codeclimate.com/github/Sen-Zhang/experiment_light/badges/gpa.svg)](https://codeclimate.com/github/Sen-Zhang/experiment_light)
+[![Build Status](https://travis-ci.org/Sen-Zhang/experiment_light.svg)](https://travis-ci.org/Sen-Zhang/experiment_light)
 
 Turn features on or off in various rails environments
 
@@ -20,6 +23,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic
+
 Run install generator:
 
     $ rails generate experiment_light:install
@@ -78,6 +83,22 @@ And in views like this:
         <p>Experiment bar is off</p>
     <% end %>
 
+### Toggel feature from view
+
+Run install generator:
+
+    $ rails generate experiment_light:install_toggle
+
+- A controller file named `experiments_controller.rb` will be added into `app/controllers`
+- A view template file name 'index.html.erb' will be added into `app/views/experiments`
+- The following two routes will be added:
+
+  ```ruby
+  get 'experiments' => 'experiments#index'
+  post 'update_experiment' => 'experiments#update'
+  ```
+You may want to customize the newly generated files base on your need. Now you are ready to go to `localhost:3000/experiments` to check out and toggle your features.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/experiment_light/fork )

data/experiment_light.gemspec

@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "jquery-rails"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   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/lib/experiment_light.rb

@@ -2,6 +2,7 @@ module ExperimentLight
 end
 
 require 'experiment_light/experiment'
+require 'experiment_light/helper_methods'
 require 'experiment_light/version'
 require 'experiment_light/action_controller/base'
 require 'experiment_light/active_record/base'

data/lib/experiment_light/action_controller/base.rb

@@ -2,13 +2,14 @@ require 'action_controller'
 
 module ExperimentLight
   class ActionController::Base
+    include ExperimentLight::HelperMethods
 
-    def experiment_on?(experiment_name)
-      ExperimentLight::Experiment.on?(experiment_name)
+    def experiment_data
+      ExperimentLight::Experiment.experiment_feature_data
     end
 
-    def experiment_off?(experiment_name)
-      !experiment_on?(experiment_name)
+    def toggle_feature(experiment, env, value)
+      ExperimentLight::Experiment.update(experiment, env, value)
     end
 
     helper_method :experiment_on?, :experiment_off?

data/lib/experiment_light/active_record/base.rb

@@ -2,16 +2,6 @@ require 'active_record'
 
 module ExperimentLight
   class ActiveRecord::Base
-
-    class << self
-      def experiment_on?(experiment_name)
-        ExperimentLight::Experiment.on?(experiment_name)
-      end
-
-      def experiment_off?(experiment_name)
-        !experiment_on?(experiment_name)
-      end
-    end
-
+    extend ExperimentLight::HelperMethods
   end
 end

data/lib/experiment_light/experiment.rb

@@ -1,37 +1,78 @@
 class ExperimentLight::Experiment
   class << self
-    def on?(experiment_name)
+    def experiment_feature_data
+      @experiment_data ||= load(experiment_file_name)
+    end
+
+    def on?(experiment, env=Rails.env)
       experiment_feature_data
 
-      reload! unless @experiment_data.has_key?(experiment_name)
+      @experiment_data[experiment][env] if valid_feature_name_and_env?(experiment, env)
+    end
 
-      unless @experiment_data.has_key?(experiment_name)
-        raise "Cannot find experiment '#{experiment_name}', check out your experiment.yml file"
-      end
+    def off?(experiment, env=Rails.env)
+      !on?(experiment, env)
+    end
+
+    def update(experiment, env, value)
+      experiment_feature_data
+
+      @experiment_data[experiment][env] = value if valid_feature_name_and_env?(experiment, env)
 
-      @experiment_data[experiment_name][Rails.env]
+      save_to_yaml
     end
 
-    def off?(experiment_name)
-      !on?(experiment_name)
+    def delete(experiment)
+      experiment_feature_data
+
+      @experiment_data.delete(experiment) if valid_feature_name?(experiment)
+
+      save_to_yaml
     end
 
     private
-    def default_experiment_file_name
+    def experiment_file_name
       'experiment.yml'
     end
 
+    def file_path(file_name)
+      Rails.root.join('config', file_name)
+    end
+
     def load(file_name)
-      file_path = Rails.root.join('config', file_name)
-      HashWithIndifferentAccess.new(YAML::load(File.open(file_path)))
+      HashWithIndifferentAccess.new(YAML::load(File.open(file_path(file_name))))
     end
 
     def reload!
-      @experiment_data = load(default_experiment_file_name)
+      @experiment_data = load(experiment_file_name)
     end
 
-    def experiment_feature_data
-      @experiment_data ||= load(default_experiment_file_name)
+    def save_to_yaml
+      File.open(file_path(experiment_file_name), 'w') do |f|
+        f.puts @experiment_data.to_hash.to_yaml
+      end
+
+      true
+    end
+
+    def valid_feature_name?(experiment)
+      reload! unless @experiment_data.has_key?(experiment)
+
+      unless @experiment_data.has_key?(experiment)
+        raise "Cannot find experiment '#{experiment}', check out your #{experiment_file_name} file"
+      end
+
+      true
+    end
+
+    def valid_feature_name_and_env?(experiment, env=Rails.env)
+      valid_feature_name?(experiment)
+
+      unless @experiment_data[experiment].has_key?(env)
+        raise "Cannot find environment '#{env}' for experiment '#{experiment}', check out your #{experiment_file_name} file"
+      end
+
+      true
     end
   end
 end

data/lib/experiment_light/helper_methods.rb

@@ -0,0 +1,13 @@
+module ExperimentLight
+  module HelperMethods
+
+    def experiment_on?(experiment_name)
+      ExperimentLight::Experiment.on?(experiment_name)
+    end
+
+    def experiment_off?(experiment_name)
+      !experiment_on?(experiment_name)
+    end
+
+  end
+end

data/lib/experiment_light/version.rb

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

data/lib/generators/experiment_light/install_generator.rb

@@ -8,7 +8,7 @@ module ExperimentLight
       desc 'Copy experiment_sample.yml files to your application.'
 
       def copy_initializer
-        template 'experiment_sample.yml', 'config/experiment.yml'
+        copy_file 'experiment_sample.yml', 'config/experiment.yml'
       end
     end
   end

data/lib/generators/experiment_light/install_toggle_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators/base'
+
+module ExperimentLight
+  module Generators
+    class InstallToggleGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Copy experiment_sample.yml files to your application.'
+
+      def copy_initializer
+        copy_file 'experiments_controller.rb', 'app/controllers/experiments_controller.rb'
+        copy_file 'index.html.erb', 'app/views/experiments/index.html.erb'
+
+        route "get 'experiments' => 'experiments#index'"
+        route "post 'update_experiment' => 'experiments#update'"
+      end
+    end
+  end
+end

data/lib/generators/templates/experiments_controller.rb

@@ -0,0 +1,13 @@
+class ExperimentsController < ApplicationController
+
+  def index
+    @experiments = experiment_data
+  end
+
+  def update
+    if toggle_feature(params[:name], params[:env], params[:value]=='true')
+      render json: {status: :ok}
+    end
+  end
+
+end

data/lib/generators/templates/index.html.erb

@@ -0,0 +1,37 @@
+<h2>Experiment Features</h2>
+
+<% @experiments.each do |feature, status| %>
+  <h4><%= feature %></h4>
+
+  <% status.each do |env, value| %>
+    <div>
+      <%= check_box_tag "#{feature}_#{env}", 1, value,
+                        class: 'js-feature-checkbox', data: {url: update_experiment_path(name: feature, env: env)} %>
+      <%= label_tag "#{feature}_#{env}", env %>
+    </div>
+  <% end %>
+<% end %>
+
+<script>
+  'use strict';
+
+  $(function () {
+    $('.js-feature-checkbox').on('change', function () {
+      var checkBox = $(this),
+          url = checkBox.data('url'),
+          value = checkBox.is(':checked') ? true : false;
+
+      $.ajax({
+        url: url,
+        type: 'POST',
+        dataType: 'json',
+        data: {value: value}
+      }).done(function () {
+        alert('Feature toggle succeed!')
+      }).fail(function () {
+        alert('Feature toggle failed!')
+      })
+    });
+  });
+
+</script>

data/spec/config/experiment.yml

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

data/spec/experiment_light_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'bundler/setup'
+require 'experiment_light'
+
+Bundler.setup
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  config.order = :random
+
+  config.before :each do
+    # reset experiment.yml
+    File.open('spec/config/experiment.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(ExperimentLight::Experiment).to receive(:file_path).and_return('spec/config/experiment.yml')
+    ExperimentLight::Experiment.send(:reload!)
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: experiment_light
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sen-Zhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,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: Turn features on or off in various rails environments
 email:
 - solowolf21@gmail.com
@@ -45,7 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .codeclimate.yml
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,9 +100,16 @@ files:
 - lib/experiment_light/action_controller/base.rb
 - lib/experiment_light/active_record/base.rb
 - lib/experiment_light/experiment.rb
+- lib/experiment_light/helper_methods.rb
 - lib/experiment_light/version.rb
 - lib/generators/experiment_light/install_generator.rb
+- lib/generators/experiment_light/install_toggle_generator.rb
 - lib/generators/templates/experiment_sample.yml
+- lib/generators/templates/experiments_controller.rb
+- lib/generators/templates/index.html.erb
+- spec/config/experiment.yml
+- spec/experiment_light_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/Sen-Zhang/experiment_light.git
 licenses:
 - MIT
@@ -82,4 +134,7 @@ rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Feature Toggles for Rails
-test_files: []
+test_files:
+- spec/config/experiment.yml
+- spec/experiment_light_spec.rb
+- spec/spec_helper.rb