flip-flop 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 876ae4f24582ebe07ddc6635c925eacd44bfd4de
-  data.tar.gz: 1009ffb11e5896c310896fde803211ec6f63fea5
+  metadata.gz: 402aff4b7c0a288f0f8f6bf862faa253a991cdeb
+  data.tar.gz: 6344ef9e5da7ed8cfd854feaf488285f01f3bdef
 SHA512:
-  metadata.gz: f2d7d4bbac7019588892afb82c06ce1bbaabc2b0548f32c347c59668682e27e1717ca72b6d2ef2069614fe6ffd7f5eb6675a2b938620deef4e808c239116a1de
-  data.tar.gz: f4a91ff2fa037b1e824f94f4b4f17b63171d700a0973a006997a288a12d18294e716b05413f596672197034e551b770faf99b22a89c0485a20a07bc56fc9793d
+  metadata.gz: eb0ee52c53566d20e347126e2978c10606a0d04f460c426456fbe08d0bf115eeb9c261826148a3fd3668f66e23471a642dc68428da0a6e1b2207d6829adbd13e
+  data.tar.gz: ecaf65cefa2a7d68e85093e1ea3d1593ce2d09ba301dcf3ccdec4eaff90f93adbb865d7d90ceed942d633085e915ac8aba6276c3de3e4a53d2a148bd1e0b66cb

data/Gemfile

@@ -2,4 +2,9 @@ source 'https://rubygems.org'
 gemspec :name => 'flip-flop'
 
 gem 'rake', '~> 10.4.2'
-gem 'rspec', '~> 3.0'
+gem 'rspec', '~> 3.0'
+
+group :test do
+  gem 'activerecord'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -1,12 +1,30 @@
 PATH
   remote: .
   specs:
-    flip-flop (0.0.2)
+    flip-flop (0.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
     diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.4)
     rake (10.4.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
@@ -21,14 +39,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
+    sqlite3 (1.3.11)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   flip-flop!
   rake (~> 10.4.2)
   rspec (~> 3.0)
+  sqlite3
 
 BUNDLED WITH
-   1.11.2
+   1.12.4

data/README.md

@@ -36,7 +36,7 @@ FlipFlop.configure do |config|
 end
 ```
 
-and add a YAML file: `config/flip-flop.yml`
+and add a YAML file: `config/flip_flop.yml`
 
 for example:
 
@@ -57,12 +57,23 @@ for example:
     begin: 2016-01-01
     end: 2016-02-01
     excl: false
+:rails_env_example:
+  :type: :rails_env
+  :value: :production
+:another_rails_env_example:
+  :type: :rails_env
+  :env:
+    - :production
+    - :test
 ```
 
 Example Usage
 -------------
 
-In a view:
+Once FlipFlop has been configured, (see above section) you can start checking if features
+are enabled or not.
+
+### In a Rails View:
 
 ```ruby
 if feature_enabled? :my_cool_feature
@@ -73,7 +84,7 @@ end
 
 ```
 
-In a controller:
+### In a Rails Controller:
 
 ```ruby
 class SomeController < ApplicationController
@@ -85,10 +96,10 @@ class SomeController < ApplicationController
 end
 ```
 
-Without Rails:
+### Without Rails:
 
 ```ruby
-if FlipFlop::get_instance.feature_enabled? :some_feature
+if FlipFlop.feature_enabled? :some_feature
   puts 'something'
 else
   puts 'something else'
@@ -106,6 +117,7 @@ Gates
 * `until_time` &mdash; enable a feature until a time has passed
 * `time_range` &mdash; enable a feature for the duration of a time range
 * `percentage_of_time` &mdash; enable a feature for a given percentage of checks
+* `rails_env` &mdash; enable a feature for a specified Rails environment
 
 Adapters
 --------
@@ -122,6 +134,11 @@ about enabled and disabled features. The YAML file is parsed once when the appli
 loaded. It's quick and easy to use, but it requres a deployment if a feature needs
 to be quickly flipped.
 
+### ActiveRecord
+
+Allows feature settings to be stored in a database table. Because of typecasting and 
+additional garbage collection this will not be as fast as the YAML adapter. Futher 
+efforts will be made to makeing The ActiveRecord adapter more performant.
 
 Extending FlipFlop
 ------------------
@@ -151,4 +168,4 @@ Contributing to FlipFlop
 * branch
 * commit
 * push
-* pull request
+* pull request

data/lib/flip-flop/adapters/active_record.rb

@@ -0,0 +1,61 @@
+require 'active_record'
+
+module FlipFlop
+  module Adapters
+    module ActiveRecord
+
+      # override this method to prevent the feature being loaded from the
+      # database twice.
+      def feature_enabled?(feature_name)
+        f = get_feature(feature_name)
+        public_send f.gate_type, f.value
+      rescue
+        false
+      end
+      
+      def get_feature(name)
+        Feature::find_by_name(name)
+      end
+
+      # Load the record from the DB if it's already there, and store
+      # the gate type and value
+      def set_feature(name, gate_type, value)
+        f = Feature::find_or_initialize_by(name: name)
+        f.gate_type = gate_type
+        f.value = value
+        f.save
+      end
+
+      # Diable the feature by deleting the record from the DB
+      def disable_feature(name)
+        get_feature(name).delete
+      end
+
+      # here for compatability, should not really be used
+      def feature_type(name)
+        get_feature(name).gate_type.to_sym
+      end
+
+      # here for compatabilty, should not really be used
+      def feature_value(name)
+        get_feature(name).value
+      end
+
+      class Feature < ::ActiveRecord::Base
+        self.table_name = 'flip_flop_features'.freeze
+        serialize :value
+
+        # getter to type case to symbol
+        def name
+          super.to_sym
+        end
+
+        # getter to type case to symbol
+        def gate_type
+          super.to_sym
+        end
+        
+      end
+    end
+  end
+end

data/lib/flip-flop/gates.rb

@@ -23,15 +23,19 @@ module FlipFlop
     end
 
     def until_time(value)
-      Time.now < value
+      Time.now.utc < value
     end
 
     def after_time(value)
-      Time.now > value
+      Time.now.utc > value
     end
 
     def percentage_of_time(value)
       rand < (value / 100.0)
     end
+
+    def rails_env(value)
+      value == Rails.env.to_sym || value.include?(Rails.env.to_sym)
+    end
   end
 end

data/lib/flip-flop/version.rb

@@ -1,3 +1,3 @@
 module FlipFlop
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/lib/flip-flop.rb

@@ -21,7 +21,8 @@ module FlipFlop
   # Arguments:
   #   configuration block: (block)
   def self.configure(&block)
-    get_instance.configure(&block)
+    @flip_flop = FlipFlop.new
+    @flip_flop.configure(&block)
   end
 
   # Check if a feature is enabled or not

data/lib/generators/flip-flop/migrations_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/active_record'
+
+module FlipFlop
+  module Generators
+    class MigrationsGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      desc 'Generates migration for FlipFlop tables'
+
+      source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_flip_flop_tables.rb'
+      end
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateFlipFlopFeatureTable < ActiveRecord::Migration
+  def self.up
+    create_table :flip_flop_features do |t|
+      t.string :name
+      t.string :gate_type
+      t.text :value
+    end
+
+    add_index :flip_flop_features, :name, unique: true
+  end
+
+  def self.down
+    drop_table :flip_flop_features
+  end
+end

data/spec/lib/adapters/active_record_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'flip-flop/adapters/active_record'
+require 'generators/templates/migration'
+
+ActiveRecord::Migration.verbose = false
+
+describe FlipFlop::Adapters::ActiveRecord do
+  context 'ActiveRecord' do
+
+    before :all do
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+      FlipFlop.configure { |config| config[:adapter] = FlipFlop::Adapters::ActiveRecord }
+    end
+
+    before :each do
+      CreateFlipFlopFeatureTable.up
+      FlipFlop.get_instance.set_feature :db, :boolean, true
+    end
+
+    after :each do
+      CreateFlipFlopFeatureTable.down
+    end
+
+    it 'should save a feature to the database' do
+      r = FlipFlop::Adapters::ActiveRecord::Feature.all
+      expect(r.size).to eql 1
+      expect(r.first.name).to eql :db
+      expect(r.first.value).to be_truthy
+      expect(r.first.gate_type).to eql :boolean
+    end
+
+    it 'should return true for a bool' do
+      expect(FlipFlop.feature_enabled?(:db)).to be_truthy
+    end
+
+    it 'should be changeable' do
+      FlipFlop.get_instance.set_feature :db, :boolean, false
+      r = FlipFlop::Adapters::ActiveRecord::Feature.all
+      expect(r.size).to eql 1
+      expect(r.first.name).to eql :db
+      expect(r.first.value).to be_falsey
+      expect(r.first.gate_type).to eql :boolean
+    end
+
+    it 'should still work with other datatypes' do
+      FlipFlop.get_instance.set_feature :dates, :date_range, (Date.today - 2)..(Date.today + 2)
+      expect(FlipFlop.feature_enabled?(:dates)).to be_truthy
+    end
+
+  end
+end

data/spec/lib/view_helpers_spec.rb

@@ -7,7 +7,18 @@ class DummyController
   include FlipFlop::ViewHelpers
 end
 
-describe DummyController do  
+if !defined? Rails
+  module Rails
+    def self.env
+      :test
+    end
+  end
+end
+
+describe DummyController do
+  before :each do
+     FlipFlop.configure {}
+  end
 
   describe '#feature_enabled?' do
     it 'should return false if nothing has been set' do
@@ -101,15 +112,42 @@ describe DummyController do
       end
 
       it 'feature should be disabled if range not started yet' do
-        ::FlipFlop::get_instance.set_feature(:ranged, :date_range, (Time.now.utc + 60)..(Time.now.utc + ONE_DAY))
+        ::FlipFlop::get_instance.set_feature(:ranged, :time_range, (Time.now.utc + 60)..(Time.now.utc + ONE_DAY))
         expect(subject.feature_enabled? :ranged).to be_falsey
       end
 
       it 'feature should be disabled if range is past' do
-        ::FlipFlop::get_instance.set_feature(:ranged, :date_range, (Time.now.utc - ONE_DAY)..(Time.now.utc - 60))
+        ::FlipFlop::get_instance.set_feature(:ranged, :time_range, (Time.now.utc - ONE_DAY)..(Time.now.utc - 60))
         expect(subject.feature_enabled? :ranged).to be_falsey
       end
     end
+
+    context 'rails_env gate' do
+      it 'should work if value is equal to rails env' do
+        ::FlipFlop::get_instance.set_feature(:qwerty, :rails_env, :test)
+        expect(subject.feature_enabled? :qwerty).to be_truthy
+      end
+
+      it 'should fail if value is not equal to rails env' do
+        ::FlipFlop::get_instance.set_feature(:qwerty, :rails_env, :production)
+        expect(subject.feature_enabled? :qwerty).to be_falsey
+      end
+
+      it 'should pass in value is an array containing the env' do
+        ::FlipFlop::get_instance.set_feature(:qwerty, :rails_env, [:production, :test])
+        expect(subject.feature_enabled? :qwerty).to be_truthy
+      end
+
+      it 'should fail in value is an array not containing the env' do
+        ::FlipFlop::get_instance.set_feature(:qwerty, :rails_env, [:production, :dev])
+        expect(subject.feature_enabled? :qwerty).to be_falsey
+      end
+
+      it 'should fail if the env contains part of the value' do
+        ::FlipFlop::get_instance.set_feature(:qwerty, :rails_env, [:production, :testing])
+        expect(subject.feature_enabled? :test).to be_falsey
+      end
+    end
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-$:.unshift(File.expand_path('../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 
 require 'pathname'
 FlopFlopRoot = Pathname(__FILE__).dirname.join('..').expand_path
@@ -6,10 +6,10 @@ FlopFlopRoot = Pathname(__FILE__).dirname.join('..').expand_path
 require 'rubygems'
 require 'bundler'
 
-Bundler.setup(:default)
+Bundler.setup(:default, :test)
 
 require 'flip-flop'
 
-RSpec.configure do |config|
+RSpec.configure do
   FlipFlop.configure {}
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flip-flop
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brian Kulyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies: []
 description: Enable or disable features easily
 email:
@@ -23,12 +23,16 @@ files:
 - Rakefile
 - flip-flop.gemspec
 - lib/flip-flop.rb
+- lib/flip-flop/adapters/active_record.rb
 - lib/flip-flop/adapters/memory.rb
 - lib/flip-flop/adapters/yaml.rb
 - lib/flip-flop/gates.rb
 - lib/flip-flop/railtie.rb
 - lib/flip-flop/version.rb
 - lib/flip-flop/view_helpers.rb
+- lib/generators/flip-flop/migrations_generator.rb
+- lib/generators/templates/migration.rb
+- spec/lib/adapters/active_record_spec.rb
 - spec/lib/adapters/yaml_spec.rb
 - spec/lib/view_helpers_spec.rb
 - spec/spec_helper.rb
@@ -53,11 +57,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Feature flipper
 test_files:
+- spec/lib/adapters/active_record_spec.rb
 - spec/lib/adapters/yaml_spec.rb
 - spec/lib/view_helpers_spec.rb
 - spec/spec_helper.rb