experiment_light 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2a9dd106ddd9ad492edc39ae8cbdf46d5feec78
+  data.tar.gz: 339337336df9e307094cf0f1283f1f6a662a285d
+SHA512:
+  metadata.gz: 1f9ab1e2562b9b6095f65cd76f67c23df965b7795360f46017bf688a7680e38337c1a7b359b6a7a8da91f117600cae3e08aa818185af423d8874fff67cc9c962
+  data.tar.gz: 1345ebff04f930025158e9f093104bb85ef86badddb027617e5bc92eee5e50189ebd615b959a6cd7592e110ecb3c76173fe911e154e3266327fe382d8b97a8dd

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea

data/Gemfile

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

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,55 @@
+# Experiment::Light
+
+Turn features on or off in various rails environments
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'experiment_light'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install experiment_light
+
+## Usage
+
+Run install generator:
+
+    $ rails generate experiment_light:install
+
+A yaml file named `experiment.yml` will be added into `config/` after running install generator, now your can define your experimental features:
+
+    foo:
+        development: true
+        test: true
+        production: false
+
+    bar:
+        development: false
+        test: true
+        production: false
+
+Now you can use it in your views like this:
+
+    <% if ExperimentLight::Experiment.on?(:foo) %>
+        <p>Experiment foo is on</p>
+    <% end %>
+
+    <% if ExperimentLight::Experiment.off?(:bar) %>
+        <p>Experiment bar is off</p>
+    <% end %>
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/experiment_light/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/experiment_light.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'experiment_light/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "experiment_light"
+  spec.version       = ExperimentLight::VERSION
+  spec.authors       = ["Sen-Zhang"]
+  spec.email         = ["solowolf21@gmail.com"]
+  spec.summary       = %q{Feature Toggles for Rails}
+  spec.description   = %q{Turn features on or off in various rails environments}
+  spec.homepage      = "https://github.com/Sen-Zhang/experiment_light.git"
+  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.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/experiment_light/experiment.rb

@@ -0,0 +1,37 @@
+class ExperimentLight::Experiment
+  class << self
+    def on?(experiment_name)
+      experiment_feature_data
+
+      reload! unless @experiment_data.has_key?(experiment_name)
+
+      unless @experiment_data.has_key?(experiment_name)
+        raise "Cannot find experiment '#{experiment_name}', check out your experiment.yml file"
+      end
+
+      @experiment_data[experiment_name][Rails.env]
+    end
+
+    def off?(experiment_name)
+      !on?(experiment_name)
+    end
+
+    private
+    def default_experiment_file_name
+      'experiment.yml'
+    end
+
+    def load(file_name)
+      file_path = Rails.root.join('config', file_name)
+      HashWithIndifferentAccess.new(YAML::load(File.open(file_path)))
+    end
+
+    def reload!
+      @experiment_data = load(default_experiment_file_name)
+    end
+
+    def experiment_feature_data
+      @experiment_data ||= load(default_experiment_file_name)
+    end
+  end
+end

data/lib/experiment_light/version.rb

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

data/lib/experiment_light.rb

@@ -0,0 +1,5 @@
+module ExperimentLight
+end
+
+require 'experiment_light/experiment'
+require 'experiment_light/version'

data/lib/generators/experiment_light/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+
+module ExperimentLight
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Copy experiment_sample.yml files to your application.'
+
+      def copy_initializer
+        template 'experiment_sample.yml', 'config/experiment.yml'
+      end
+    end
+  end
+end

data/lib/generators/templates/experiment_sample.yml

@@ -0,0 +1,17 @@
+# Example:
+#
+# experiment_feature_a:
+#   development: true
+#   test: true
+#   dev: true
+#   qa: true
+#   prodstage: true
+#   production: false
+#
+# experiment_feature_b:
+#   development: true
+#   test: true
+#   dev: true
+#   qa: true
+#   prodstage: true
+#   production: true

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: experiment_light
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sen-Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Turn features on or off in various rails environments
+email:
+- solowolf21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- experiment_light.gemspec
+- lib/experiment_light.rb
+- lib/experiment_light/experiment.rb
+- lib/experiment_light/version.rb
+- lib/generators/experiment_light/install_generator.rb
+- lib/generators/templates/experiment_sample.yml
+homepage: https://github.com/Sen-Zhang/experiment_light.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Feature Toggles for Rails
+test_files: []