flip_fab 0.0.1

data/spec/lib/flip_fab/helper_spec.rb

@@ -0,0 +1,90 @@
+require 'rack/test'
+
+module FlipFab
+  describe Helper do
+    include Rack::Test::Methods
+    let(:app) { TestApp.new }
+    after  { FlipFab.features.clear  }
+
+    it 'runs the feature' do
+      feature
+    end
+
+    step 'there is a feature with a default state of :default_state' do |default_state|
+      FlipFab.define_feature :example_feature, { default: default_state.to_sym, persistence_adapters: [TestPersistence] }
+    end
+
+    step 'there are two contexts' do
+      @first_context  = TestContext.new
+      @second_context = TestContext.new
+    end
+
+    step 'the feature is :expected_state_in_first_context in the first context, :expected_state_in_second_context in the second context' do |expected_state_in_first_context, expected_state_in_second_context|
+      expect(@first_context.features[:example_feature].enabled?).to eq(expected_state_in_first_context == 'enabled')
+      expect(@second_context.features[:example_feature].enabled?).to eq(expected_state_in_second_context == 'enabled')
+    end
+
+    step 'I :enable_or_disable the feature in the first context' do |enable_or_disable|
+      @first_context.features[:example_feature].send(enable_or_disable.to_sym)
+    end
+
+    step 'there is a feature with a default state of :default_state with cookie persistence' do |default_state|
+      FlipFab.define_feature :example_feature, { default: default_state.to_sym }
+    end
+
+    step 'I override the state in the URL parameters with :overridden_state' do |overridden_state|
+      get "/?example_feature=#{overridden_state}"
+    end
+
+    step 'the feature is :state for the user' do |state|
+      expect(app.contextual_features[:example_feature].enabled?).to eq(state=='enabled')
+    end
+
+    step 'I :enable_or_disable the feature for the user' do |enable_or_disable|
+      app.contextual_features[:example_feature].send(enable_or_disable.to_sym)
+    end
+
+    describe '#features' do
+      let(:params)         {{}}
+      let(:feature_states) {{ example_feature: :enabled }}
+      let(:context)        { (TestContext.new feature_states, params) }
+      before { FlipFab.define_feature :example_feature, { persistence_adapters: [TestPersistence] } }
+      subject { context.features }
+
+      it 'maps the features to contextual features by feature name' do
+        expect(subject[:example_feature]).to be_a ContextualFeature
+      end
+
+      it 'is a FeaturesByName' do
+        expect(subject).to be_a FeaturesByName
+      end
+
+      context 'when the feature is overridden in the params' do
+        let(:params) {{'example_feature' => 'disabled'}}
+
+        it 'applies the override to the feature' do
+          expect(subject[:example_feature].disabled?).to be_truthy
+        end
+
+        it 'prevents the feature\'s state from being changed' do
+          expect{ subject[:example_feature].enable }.not_to change{ subject[:example_feature].enabled? }.from(false)
+        end
+      end
+
+      context 'passing the context to the feature' do
+
+        it 'feature toggling is applied to the context' do
+          expect{ subject[:example_feature].disable }.to change{ subject[:example_feature].enabled? }.from(true).to(false)
+        end
+
+        it 'feature toggling is persisted in the context' do
+          expect{ subject[:example_feature].disable }.to change{ feature_states }.from({ example_feature: :enabled }).to({ example_feature: :disabled })
+        end
+      end
+
+      it 'caches the features' do
+        expect(subject).to eq(context.features)
+      end
+    end
+  end
+end

data/spec/lib/flip_fab/persistence_spec.rb

@@ -0,0 +1,32 @@
+module FlipFab
+  describe Persistence do
+    let(:feature_name) { :example_test }
+    let(:context)      { double(:context) }
+    subject { described_class.new feature_name, context }
+
+    describe '.new' do
+
+      it 'assigns the feature name' do
+        expect(subject.feature_name).to eq(:example_test)
+      end
+
+      it 'assigns the context' do
+        expect(subject.context).to eq(context)
+      end
+    end
+
+    describe '#read' do
+
+      it 'is not implemented' do
+        expect{ subject.read }.to raise_error NotImplementedError
+      end
+    end
+
+    describe '#write' do
+
+      it 'is not implemented' do
+        expect{ subject.write feature_name }.to raise_error NotImplementedError
+      end
+    end
+  end
+end

data/spec/lib/flip_fab.feature

@@ -0,0 +1,10 @@
+Feature: Feature flipping at an application level
+
+  Scenario Outline: Features can be declared as enabled or disabled and remain as such
+    When I define a feature that is '<enabled_or_disabled>'
+    Then the feature is '<enabled_or_disabled>'
+
+    Examples:
+      | enabled_or_disabled |
+      |             enabled |
+      |            disabled |

data/spec/lib/flip_fab_spec.rb

@@ -0,0 +1,47 @@
+describe FlipFab do
+  let(:name) { :example_feature }
+
+  it 'runs the feature' do
+    feature
+  end
+
+  step 'I define a feature that is :enabled_or_disabled' do |enabled_or_disabled|
+    described_class.define_feature name, { default: enabled_or_disabled.to_sym }
+  end
+
+  step 'the feature is :enabled_or_disabled' do |enabled_or_disabled|
+    expect(described_class.features[name].enabled?).to eq(enabled_or_disabled == 'enabled')
+  end
+
+  it 'initializes features' do
+    expect(described_class.features).to be_a FlipFab::FeaturesByName
+  end
+
+  context '.define_feature' do
+    subject{ described_class.define_feature name }
+    after{ described_class.features.clear }
+
+    it 'returns the feature' do
+      expect(subject).to be_a FlipFab::Feature
+      expect(subject.name).to eq(:example_feature)
+    end
+
+    context 'when the feature exists' do
+
+      it 'overwrites the existing feature' do
+        existing_feature = described_class.define_feature name
+        expect{ subject }.not_to change{ described_class.features.count }.from(1)
+        expect(subject).not_to eq(existing_feature)
+      end
+    end
+
+    context 'when the feature does not exist' do
+
+      it 'saves the feature' do
+        expect{ subject }.to change{ described_class.features.count }.from(0).to(1)
+        expected_feature = subject
+        expect(described_class.features[:example_feature]).to eq(expected_feature)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'flip_fab'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f}
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/test_app.rb

@@ -0,0 +1,16 @@
+class TestApp
+  include FlipFab::Helper
+
+  attr_reader :request, :response, :params, :contextual_features
+
+  def call env
+    @request  = Rack::Request.new env
+    @response = Rack::Response.new
+    @params   = request.params
+
+    @contextual_features = features
+
+    request.cookies.each{|k,v| response.set_cookie k, v }
+    [response.status, response.header, response.body]
+  end
+end

data/spec/support/test_context.rb

@@ -0,0 +1,10 @@
+class TestContext
+  include FlipFab::Helper
+
+  attr_reader :feature_states, :params
+
+  def initialize feature_states={}, params={}
+    @feature_states = feature_states
+    @params         = params
+  end
+end

data/spec/support/test_multiple_persistence.rb

@@ -0,0 +1,14 @@
+class TestMultiplePersistence < FlipFab::Persistence
+
+  def initialize feature_name, context
+    super
+  end
+
+  def read
+    context.feature_states[:different_example_feature]
+  end
+
+  def write value
+    context.feature_states[:different_example_feature] = value
+  end
+end

data/spec/support/test_persistence.rb

@@ -0,0 +1,14 @@
+class TestPersistence < FlipFab::Persistence
+
+  def initialize feature_name, context
+    super
+  end
+
+  def read
+    context.feature_states[feature_name]
+  end
+
+  def write state
+    context.feature_states[feature_name] = state
+  end
+end

data/spec/support/test_rack_context.rb

@@ -0,0 +1,15 @@
+class TestRackContext
+  include FlipFab::Helper
+
+  attr_reader :request, :response
+
+  def initialize cookies, host
+    @request  = Rack::Request.new({ 'HTTP_COOKIE' => cookies, 'HTTP_HOST' => host })
+    @response = Rack::Response.new
+    request.cookies.each{|k,v| response.set_cookie k, v }
+  end
+
+  def response_cookies
+    response.header['Set-Cookie']
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: flip_fab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Simply Business
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies: []
+description: A gem providing persistent, per-user feature flipping to Rack applications.
+email:
+- tech@simplybusiness.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- example/rails_app/.gitignore
+- example/rails_app/Gemfile
+- example/rails_app/Gemfile.lock
+- example/rails_app/README.rdoc
+- example/rails_app/Rakefile
+- example/rails_app/app/assets/images/.keep
+- example/rails_app/app/assets/images/justin_beaver.jpg
+- example/rails_app/app/assets/images/regular_beaver.jpg
+- example/rails_app/app/assets/javascripts/application.js
+- example/rails_app/app/assets/javascripts/beavers.js.coffee
+- example/rails_app/app/assets/stylesheets/application.css
+- example/rails_app/app/assets/stylesheets/beavers.css.scss
+- example/rails_app/app/assets/stylesheets/scaffolds.css.scss
+- example/rails_app/app/controllers/application_controller.rb
+- example/rails_app/app/controllers/beavers_controller.rb
+- example/rails_app/app/controllers/concerns/.keep
+- example/rails_app/app/helpers/application_helper.rb
+- example/rails_app/app/helpers/beavers_helper.rb
+- example/rails_app/app/mailers/.keep
+- example/rails_app/app/models/.keep
+- example/rails_app/app/models/beaver.rb
+- example/rails_app/app/models/concerns/.keep
+- example/rails_app/app/views/beavers/_form.html.erb
+- example/rails_app/app/views/beavers/edit.html.erb
+- example/rails_app/app/views/beavers/index.html.erb
+- example/rails_app/app/views/beavers/index.json.jbuilder
+- example/rails_app/app/views/beavers/new.html.erb
+- example/rails_app/app/views/beavers/show.html.erb
+- example/rails_app/app/views/beavers/show.json.jbuilder
+- example/rails_app/app/views/layouts/application.html.erb
+- example/rails_app/bin/bundle
+- example/rails_app/bin/rails
+- example/rails_app/bin/rake
+- example/rails_app/config.ru
+- example/rails_app/config/application.rb
+- example/rails_app/config/boot.rb
+- example/rails_app/config/database.yml
+- example/rails_app/config/environment.rb
+- example/rails_app/config/environments/development.rb
+- example/rails_app/config/environments/test.rb
+- example/rails_app/config/initializers/backtrace_silencers.rb
+- example/rails_app/config/initializers/cookies_serializer.rb
+- example/rails_app/config/initializers/filter_parameter_logging.rb
+- example/rails_app/config/initializers/flip_fab.rb
+- example/rails_app/config/initializers/inflections.rb
+- example/rails_app/config/initializers/mime_types.rb
+- example/rails_app/config/initializers/session_store.rb
+- example/rails_app/config/initializers/wrap_parameters.rb
+- example/rails_app/config/locales/en.yml
+- example/rails_app/config/rabbit_feed.yml
+- example/rails_app/config/routes.rb
+- example/rails_app/config/secrets.yml
+- example/rails_app/config/unicorn.rb
+- example/rails_app/db/migrate/20140424102400_create_beavers.rb
+- example/rails_app/db/schema.rb
+- example/rails_app/db/seeds.rb
+- example/rails_app/lib/assets/.keep
+- example/rails_app/lib/tasks/.keep
+- example/rails_app/log/.keep
+- example/rails_app/public/404.html
+- example/rails_app/public/422.html
+- example/rails_app/public/500.html
+- example/rails_app/public/favicon.ico
+- example/rails_app/public/robots.txt
+- example/rails_app/spec/rails_helper.rb
+- example/rails_app/spec/spec_helper.rb
+- example/rails_app/test/controllers/.keep
+- example/rails_app/test/controllers/beavers_controller_test.rb
+- example/rails_app/test/fixtures/.keep
+- example/rails_app/test/fixtures/beavers.yml
+- example/rails_app/test/helpers/.keep
+- example/rails_app/test/helpers/beavers_helper_test.rb
+- example/rails_app/test/integration/.keep
+- example/rails_app/test/mailers/.keep
+- example/rails_app/test/models/.keep
+- example/rails_app/test/models/beaver_test.rb
+- example/rails_app/test/test_helper.rb
+- flip_fab.gemspec
+- lib/flip_fab.rb
+- lib/flip_fab/contextual_feature.rb
+- lib/flip_fab/cookie_persistence.rb
+- lib/flip_fab/feature.rb
+- lib/flip_fab/features_by_name.rb
+- lib/flip_fab/helper.rb
+- lib/flip_fab/persistence.rb
+- lib/flip_fab/version.rb
+- spec/lib/flip_fab.feature
+- spec/lib/flip_fab/contextual_feature_spec.rb
+- spec/lib/flip_fab/cookie_persistence.feature
+- spec/lib/flip_fab/cookie_persistence_spec.rb
+- spec/lib/flip_fab/feature_spec.rb
+- spec/lib/flip_fab/features_by_name_spec.rb
+- spec/lib/flip_fab/helper.feature
+- spec/lib/flip_fab/helper_spec.rb
+- spec/lib/flip_fab/persistence_spec.rb
+- spec/lib/flip_fab_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_app.rb
+- spec/support/test_context.rb
+- spec/support/test_multiple_persistence.rb
+- spec/support/test_persistence.rb
+- spec/support/test_rack_context.rb
+homepage: https://github.com/simplybusiness/flip_fab
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A gem providing persistent, per-user feature flipping to Rack applications.
+test_files:
+- spec/lib/flip_fab.feature
+- spec/lib/flip_fab/contextual_feature_spec.rb
+- spec/lib/flip_fab/cookie_persistence.feature
+- spec/lib/flip_fab/cookie_persistence_spec.rb
+- spec/lib/flip_fab/feature_spec.rb
+- spec/lib/flip_fab/features_by_name_spec.rb
+- spec/lib/flip_fab/helper.feature
+- spec/lib/flip_fab/helper_spec.rb
+- spec/lib/flip_fab/persistence_spec.rb
+- spec/lib/flip_fab_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_app.rb
+- spec/support/test_context.rb
+- spec/support/test_multiple_persistence.rb
+- spec/support/test_persistence.rb
+- spec/support/test_rack_context.rb
+has_rdoc: