flip_fab 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b178cc3f97fb1405b48a143a52b83bc205891f57
-  data.tar.gz: 78b6d508d839d2dfdfa955645f98c71164bd0a2f
+  metadata.gz: 41ce116c1d345217c1e9b1eb22afb50ae36cf0b5
+  data.tar.gz: 30446aedb0dab73151be9b4bb1744b9dbad8d15e
 SHA512:
-  metadata.gz: 55be299324bf08e81c806491487d3c81e76aa98c61d3601cf3a8c3b3be61bea7e5c044e8e7e65a263e183accac1423870c1d584a0af47f826949729b4fa3416d
-  data.tar.gz: 13a8bebb70660b3987caf0aa797518a22f62b0b32eac6e055d8dc15ef9435e88dfa46417229c9528af2187bb6636aaa203363a995bcffc0bab176e0edb737271
+  metadata.gz: f39f8b192ab5a888ef29d325ee94de4eb88f86a78b09b76ef872a61e3895ff1018ce1223185cb8cd53df92edfb34823ed05106ca2b2792f23b15ea334a21a26f
+  data.tar.gz: 8758cb9740f64f0abe4035ef0048c000e9e671fc88ea52cf36f81b37ff03f09948c21e77f80f71e23dc1952c03e0c9d759e9ca8ebf3846f01843ec0734f67e19

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Lint/EndAlignment:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/flip_fab/persistence.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/support/test_app.rb'
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/lib/flip_fab/contextual_feature_spec.rb'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'example/rails_app/test/test_helper.rb'
+
+Style/Documentation:
+  Enabled: false
+

data/example/rails_app/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '~> 4.2'
+gem 'rails', '~> 5.0'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3'
 # Use SCSS for stylesheets
@@ -10,27 +10,10 @@ gem 'sass-rails'
 gem 'uglifier', '>= 1.3.0'
 # Use CoffeeScript for .js.coffee assets and views
 gem 'coffee-rails'
-# See https://github.com/sstephenson/execjs#readme for more supported runtimes
-# gem 'therubyracer',  platforms: :ruby
-
 # Use jquery as the JavaScript library
 gem 'jquery-rails'
-# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
-gem 'turbolinks'
-# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem 'jbuilder', '~> 2.0'
-# bundle exec rake doc:rails generates the API under doc/api.
-gem 'sdoc', '~> 0.4.0',          group: :doc
-
-# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-gem 'spring',        group: :development
-
-# Use unicorn as the app server
-gem 'unicorn'
-
-# Use Capistrano for deployment
-# gem 'capistrano-rails', group: :development
 
 gem 'flip_fab', path: '../../'
 
+gem 'rails-controller-testing', group: :test
 gem 'rspec-rails', group: :test

data/example/rails_app/app/assets/javascripts/application.js

@@ -12,5 +12,4 @@
 //
 //= require jquery
 //= require jquery_ujs
-//= require turbolinks
 //= require_tree .

data/example/rails_app/app/controllers/beavers_controller.rb

@@ -9,8 +9,7 @@ class BeaversController < ApplicationController
 
   # GET /beavers/1
   # GET /beavers/1.json
-  def show
-  end
+  def show; end
 
   # GET /beavers/new
   def new
@@ -18,8 +17,7 @@ class BeaversController < ApplicationController
   end
 
   # GET /beavers/1/edit
-  def edit
-  end
+  def edit; end
 
   # POST /beavers
   # POST /beavers.json
@@ -62,13 +60,14 @@ class BeaversController < ApplicationController
   end
 
   private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_beaver
-      @beaver = Beaver.find(params[:id])
-    end
 
-    # Never trust parameters from the scary internet, only allow the white list through.
-    def beaver_params
-      params.require(:beaver).permit(:name)
-    end
+  # Use callbacks to share common setup or constraints between actions.
+  def set_beaver
+    @beaver = Beaver.find(params[:id])
+  end
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def beaver_params
+    params.require(:beaver).permit(:name)
+  end
 end

data/example/rails_app/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/example/rails_app/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/example/rails_app/config/environments/development.rb

@@ -20,7 +20,7 @@ Rails.application.configure do
   # config.action_dispatch.rack_cache = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_files = false
+  config.public_file_server.enabled = false
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

data/example/rails_app/config/environments/test.rb

@@ -13,8 +13,8 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
-  config.static_cache_control = 'public, max-age=3600'
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true

data/example/rails_app/config/initializers/cookies_serializer.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.action_dispatch.cookies_serializer = :json
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/example/rails_app/db/schema.rb

@@ -11,12 +11,10 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140424102400) do
-
-  create_table "beavers", force: true do |t|
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+ActiveRecord::Schema.define(version: 20_140_424_102_400) do
+  create_table 'beavers', force: true do |t|
+    t.string   'name'
+    t.datetime 'created_at'
+    t.datetime 'updated_at'
   end
-
 end

data/example/rails_app/spec/rails_helper.rb

@@ -1,7 +1,7 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
+ENV['RAILS_ENV'] ||= 'test'
 require 'spec_helper'
-require File.expand_path("../../config/environment", __FILE__)
+require File.expand_path('../../config/environment', __FILE__)
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 

data/example/rails_app/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 RSpec.configure do |config|
-
   # 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.

data/example/rails_app/test/controllers/beavers_controller_test.rb

@@ -5,43 +5,43 @@ class BeaversControllerTest < ActionController::TestCase
     @beaver = beavers(:one)
   end
 
-  test "should get index" do
+  test 'should get index' do
     get :index
     assert_response :success
     assert_not_nil assigns(:beavers)
   end
 
-  test "should get new" do
+  test 'should get new' do
     get :new
     assert_response :success
   end
 
-  test "should create beaver" do
+  test 'should create beaver' do
     assert_difference('Beaver.count') do
-      post :create, beaver: { name: @beaver.name }
+      post :create, params: { beaver: { name: @beaver.name } }
     end
 
     assert_redirected_to beaver_path(assigns(:beaver))
   end
 
-  test "should show beaver" do
-    get :show, id: @beaver
+  test 'should show beaver' do
+    get :show, params: { id: @beaver }
     assert_response :success
   end
 
-  test "should get edit" do
-    get :edit, id: @beaver
+  test 'should get edit' do
+    get :edit, params: { id: @beaver }
     assert_response :success
   end
 
-  test "should update beaver" do
-    patch :update, id: @beaver, beaver: { name: @beaver.name }
+  test 'should update beaver' do
+    patch :update, params: { id: @beaver, beaver: { name: @beaver.name } }
     assert_redirected_to beaver_path(assigns(:beaver))
   end
 
-  test "should destroy beaver" do
+  test 'should destroy beaver' do
     assert_difference('Beaver.count', -1) do
-      delete :destroy, id: @beaver
+      delete :destroy, params: { id: @beaver }
     end
 
     assert_redirected_to beavers_path

data/flip_fab.gemspec

@@ -8,19 +8,20 @@ Gem::Specification.new do |spec|
   spec.version       = FlipFab::VERSION
   spec.authors       = ['Simply Business']
   spec.email         = ['tech@simplybusiness.co.uk']
-  spec.description   = %q{A gem providing persistent, per-user feature flipping to Rack applications.}
-  spec.summary       = %q{A gem providing persistent, per-user feature flipping to Rack applications.}
+  spec.description   = 'A gem providing persistent, per-user feature flipping to Rack applications.'
+  spec.summary       = 'A gem providing persistent, per-user feature flipping to Rack applications.'
   spec.homepage      = 'https://github.com/simplybusiness/flip_fab'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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 'rack'
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rutabaga'
-  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rack', '~> 2.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rutabaga', '~> 2.1'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.46'
 end

data/lib/flip_fab.rb

@@ -6,16 +6,16 @@ require 'flip_fab/persistence'
 require 'flip_fab/cookie_persistence'
 
 module FlipFab
-  extend self
-
   attr_reader :features
 
-  def define_feature name, options={}
+  def define_feature(name, options = {})
     @features ||= {}
     @features[name] = Feature.new name, options
   end
 
   @features ||= FeaturesByName.new
+
+  module_function :features, :define_feature
 end
 
 if defined?(ActionController)

data/lib/flip_fab/contextual_feature.rb

@@ -2,13 +2,12 @@ module FlipFab
   class ContextualFeature
     attr_reader :feature, :context
 
-    def initialize feature, context
+    def initialize(feature, context)
       @feature = feature
       @context = context
-      if overridden?
-        @state = override
-        persist
-      end
+      return unless overridden?
+      @state = override
+      persist
     end
 
     def enabled?
@@ -27,16 +26,15 @@ module FlipFab
       self.state = :disabled
     end
 
-    def state= value
+    def state=(value)
       raise "Invalid state provided: `#{value}`, possible states are :enabled, :disabled" unless %i(enabled disabled).include? value
-      unless overridden?
-        @state = value
-        persist
-      end
+      return if overridden?
+      @state = value
+      persist
     end
 
     def persist
-      persistence_adapters.each{ |adapter| adapter.write state }
+      persistence_adapters.each { |adapter| adapter.write state }
     end
 
     private
@@ -46,11 +44,7 @@ module FlipFab
     end
 
     def state
-      @state ||= if state_in_context?
-        state_from_context
-      else
-        default_state
-      end
+      @state ||= state_in_context? ? state_from_context : default_state
     end
 
     def state_in_context?
@@ -62,7 +56,7 @@ module FlipFab
     end
 
     def first_adapter_with_state
-      persistence_adapters.detect{|adapter| !adapter.read.nil?}
+      persistence_adapters.detect { |adapter| !adapter.read.nil? }
     end
 
     def default_state

data/lib/flip_fab/cookie_persistence.rb

@@ -1,12 +1,11 @@
 module FlipFab
   class CookiePersistence < FlipFab::Persistence
+    COOKIE_PATH = '/'.freeze
+    COOKIE_DURATION_MONTHS = 12
+    # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L214
+    DOMAIN_REGEXP          = /[^.]*\.([^.]*|..\...|...\...)$/
 
-      COOKIE_PATH            = '/'
-      COOKIE_DURATION_MONTHS = 12
-      # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L214
-      DOMAIN_REGEXP          = /[^.]*\.([^.]*|..\...|...\...)$/
-
-    def initialize feature_name, context
+    def initialize(feature_name, context)
       super
     end
 
@@ -14,14 +13,12 @@ module FlipFab
       value.to_sym unless value.nil?
     end
 
-    def write state
+    def write(state)
       cookie_domain = ".#{top_level_domain}" unless top_level_domain.nil?
-      context.response.set_cookie key, {
-        value:   state,
-        expires: cookie_expiration,
-        domain:  cookie_domain,
-        path:    COOKIE_PATH,
-      }
+      context.response.set_cookie key, value:   state,
+                                       expires: cookie_expiration,
+                                       domain:  cookie_domain,
+                                       path:    COOKIE_PATH
     end
 
     private
@@ -36,9 +33,7 @@ module FlipFab
 
     # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L286-L294
     def top_level_domain
-      if (host !~ /^[\d.]+$/) && (host =~ DOMAIN_REGEXP)
-        $&
-      end
+      $& if (host !~ /^[\d.]+$/) && (host =~ DOMAIN_REGEXP)
     end
 
     def cookie_expiration

data/lib/flip_fab/feature.rb

@@ -1,9 +1,8 @@
 module FlipFab
   class Feature
-
     attr_reader :name, :default, :persistence_adapters
 
-    def initialize name, options={}
+    def initialize(name, options = {})
       @name                 = name
       @default              = options[:default] || :disabled
       @persistence_adapters = options[:persistence_adapters] || [CookiePersistence]
@@ -17,7 +16,7 @@ module FlipFab
       !enabled?
     end
 
-    def with_context context
+    def with_context(context)
       ContextualFeature.new self, context
     end
   end

data/lib/flip_fab/features_by_name.rb

@@ -4,17 +4,17 @@ module FlipFab
   class FeaturesByName
     extend Forwardable
 
-    def initialize features_by_name={}
+    def initialize(features_by_name = {})
       @features_by_name = features_by_name
     end
 
-    def [] name
+    def [](name)
       raise "no feature has been defined with the name: #{name}" if @features_by_name[name].nil?
       @features_by_name[name]
     end
 
-    def with_context context
-      FeaturesByName.new Hash[@features_by_name.map{|name, feature| [name, (feature.with_context context)]}]
+    def with_context(context)
+      FeaturesByName.new Hash[@features_by_name.map { |name, feature| [name, (feature.with_context context)] }]
     end
 
     def_delegators :@features_by_name, :[]=, :clear, :count, :each