flipper 0.10.2 → 0.11.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: babc8ef94b2e4998e345e538272ce930a3fc8919
-  data.tar.gz: 0fa3de8f4ab472e65bcf203fdaece22a44e481a6
+  metadata.gz: 1dba40ce57cd34d4be2608ce8725c2b314eb5345
+  data.tar.gz: 929230ec45235cfb08634d63ab0bdfe704197b45
 SHA512:
-  metadata.gz: 2b12d5d3debc25773f9ffe0f07d1f58d13b1eaec384603d7cdf1b5d073a25c98d4c61364f94021d5ad017e3071810d1f91a4e69b865004246c8b3b53ff87cf96
-  data.tar.gz: 1633e3e20e4ecb43673c438d1a45e54e35c438ac33f86e25337766b2ca0732f1052cc5dd48af17e2cf33315e5e15756b8a040861a243db93a73fe93d61e4dec0
+  metadata.gz: 3618c5c38a0901f219e719de7b04230ad8ca4534673f271b31c055fe1d88bb7545638b5bdb90c3fdec6e842819678e4137c2f32eb83eb77826381396eb75d95e
+  data.tar.gz: 98e939ae62ee4ac6bd7f19eab5be8c0c58281525db190a852a0b36643e8108c16feb5df94a4ca943ab4517bccec6c7a20d80ea5389fa7bb595bb7d7fdb394cf9

data/.rubocop.yml

@@ -0,0 +1,42 @@
+# This is the configuration used to check the rubocop source code.
+
+require: rubocop-rspec
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'docker-compose/**/*'
+    - 'examples/**/*'
+    - 'tmp/**/*'
+    - 'bin/**/*'
+  TargetRubyVersion: 2.0
+  # DefaultFormatter: fuubar
+Style/Alias:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - '*.gemspec'
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+RSpec/InstanceVariable:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,188 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-11-20 15:49:33 +0000 using RuboCop version 0.45.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+require: rubocop-rspec
+
+# Offense count: 2
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'lib/flipper/instrumentation/metriks.rb'
+    - 'lib/flipper/instrumentation/statsd.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/flipper/adapters/active_record.rb'
+    - 'lib/flipper/adapters/sequel.rb'
+    - 'lib/flipper/feature.rb'
+    - 'lib/flipper/gate_values.rb'
+
+# Offense count: 1
+Lint/Eval:
+  Exclude:
+    - 'flipper.gemspec'
+
+# Offense count: 3
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/flipper/adapters/mongo_spec.rb'
+    - 'test/adapters/mongo_test.rb'
+    - 'test/helper.rb'
+
+# Offense count: 24
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'lib/flipper/adapters/active_record.rb'
+    - 'lib/flipper/adapters/instrumented.rb'
+    - 'lib/flipper/adapters/sequel.rb'
+    - 'spec/flipper/api/v1/actions/actors_gate_spec.rb'
+    - 'spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb'
+    - 'spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb'
+    - 'spec/flipper/dsl_spec.rb'
+    - 'spec/flipper/feature_spec.rb'
+    - 'spec/flipper/types/group_spec.rb'
+
+# Offense count: 26
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/flipper/instrumentation/log_subscriber.rb'
+    - 'lib/flipper/instrumentation/subscriber.rb'
+    - 'lib/flipper/ui/actions/groups_gate.rb'
+    - 'spec/flipper/api/action_spec.rb'
+    - 'spec/flipper/dsl_spec.rb'
+    - 'spec/flipper/feature_spec.rb'
+    - 'spec/flipper/gates/group_spec.rb'
+    - 'spec/flipper/instrumentation/metriks_subscriber_spec.rb'
+    - 'spec/flipper/instrumentation/statsd_subscriber_spec.rb'
+    - 'spec/flipper_spec.rb'
+    - 'spec/flipper/middleware/memoizer_spec.rb'
+    - 'test/helper.rb'
+
+# Offense count: 27
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 195
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 178
+
+# Offense count: 39
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 65
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: CustomTransform.
+RSpec/FilePath:
+  Exclude:
+    - 'spec/flipper/adapters/pstore_spec.rb'
+    - 'spec/integration_spec.rb'
+
+# Offense count: 91
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/flipper/adapters/operation_logger_spec.rb'
+    - 'spec/flipper/dsl_spec.rb'
+    - 'spec/flipper/feature_spec.rb'
+    - 'spec/flipper/instrumentation/log_subscriber_spec.rb'
+    - 'spec/flipper/ui/actions/add_feature_spec.rb'
+    - 'spec/flipper/ui/actions/features_spec.rb'
+    - 'spec/flipper/ui/decorators/feature_spec.rb'
+    - 'spec/flipper/ui/decorators/gate_spec.rb'
+    - 'spec/flipper/ui_spec.rb'
+    - 'spec/flipper_spec.rb'
+    - 'spec/integration_spec.rb'
+
+# Offense count: 15
+# Configuration parameters: IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/flipper/api/v1/actions/features_spec.rb'
+    - 'spec/flipper/dsl_spec.rb'
+    - 'spec/flipper/feature_spec.rb'
+    - 'spec/flipper/types/group_spec.rb'
+    - 'spec/flipper_spec.rb'
+    - 'spec/integration_spec.rb'
+
+# Offense count: 2
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/flipper/adapters/memory.rb'
+    - 'lib/flipper/adapters/pstore.rb'
+
+# Offense count: 7
+Style/ConstantName:
+  Exclude:
+    - 'lib/flipper.rb'
+    - 'lib/flipper/adapters/dalli.rb'
+    - 'lib/flipper/adapters/memoizable.rb'
+    - 'lib/flipper/adapters/memory.rb'
+    - 'lib/flipper/adapters/mongo.rb'
+    - 'lib/flipper/adapters/pstore.rb'
+    - 'lib/flipper/adapters/redis.rb'
+
+# Offense count: 3
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/flipper/adapters/memoizable.rb'
+    - 'lib/flipper/gates/boolean.rb'
+    - 'lib/flipper/typecast.rb'
+
+# Offense count: 7
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'lib/flipper-active_record.rb'
+    - 'lib/flipper-api.rb'
+    - 'lib/flipper-cloud.rb'
+    - 'lib/flipper-dalli.rb'
+    - 'lib/flipper-mongo.rb'
+    - 'lib/flipper-redis.rb'
+    - 'lib/flipper-sequel.rb'
+    - 'lib/flipper-ui.rb'
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'lib/flipper/instrumentation/log_subscriber.rb'
+
+# Offense count: 10
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/flipper/api/v1/actions/percentage_of_actors_gate.rb'
+    - 'lib/flipper/api/v1/actions/percentage_of_time_gate.rb'
+    - 'lib/flipper/gate_values.rb'
+    - 'lib/flipper/instrumentation/statsd_subscriber.rb'
+    - 'lib/flipper/instrumentation/subscriber.rb'
+    - 'lib/flipper/registry.rb'
+    - 'lib/flipper/typecast.rb'
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/flipper/gates/actor.rb'
+
+# Offense count: 1
+Style/MethodMissing:
+  Exclude:
+    - 'lib/flipper/types/actor.rb'

data/Changelog.md

@@ -1,3 +1,13 @@
+## 0.11
+
+* Use primary keys with sequel adapter (https://github.com/jnunemaker/flipper/pull/210).
+* Add redis cache adapter (https://github.com/jnunemaker/flipper/pull/211).
+* Finish API and HTTP adapter that speaks to API.
+* Set flipper from env for API and UI (https://github.com/jnunemaker/flipper/pull/223 and https://github.com/jnunemaker/flipper/pull/229).
+* Add flipper cloud adapter (https://github.com/jnunemaker/flipper/pull/249).
+* Allow unregistered groups (https://github.com/jnunemaker/flipper/pull/244).
+* Drop support for Ruby 2.0 as it is end of lined (https://github.com/jnunemaker/flipper/commit/c2c81ed89938155ce91acb5173ac38580f630e3d).
+
 ## 0.10.2
 
 * Add Adapter#get_multi to allow for efficient loading of more than one feature at a time (https://github.com/jnunemaker/flipper/pull/198)

data/Gemfile

@@ -1,9 +1,9 @@
 source 'https://rubygems.org'
-gemspec :name => 'flipper'
+gemspec name: 'flipper'
 
 Dir['flipper-*.gemspec'].each do |gemspec|
   plugin = gemspec.scan(/flipper-(.*)\.gemspec/).flatten.first
-  gemspec(:name => "flipper-#{plugin}", :development_group => plugin)
+  gemspec(name: "flipper-#{plugin}", development_group: plugin)
 end
 
 gem 'rake', '~> 10.4.2'
@@ -13,8 +13,11 @@ gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
 gem 'rack-test', '~> 0.6.3'
 gem 'sqlite3', '~> 1.3.11'
-gem 'rails', "~> #{ENV["RAILS_VERSION"] || '4.2.5'}"
+gem 'rails', "~> #{ENV['RAILS_VERSION'] || '4.2.5'}"
 gem 'minitest', '~> 5.8.0'
+gem 'rubocop', '~> 0.45.0'
+gem 'rubocop-rspec', '= 1.5.1'
+gem 'webmock', '~> 2.0'
 
 # for active support tests in test/ and only needed for ruby 2.2.x
 gem 'test-unit', '~> 3.0'

data/README.md

@@ -80,9 +80,10 @@ Of course there are more [examples for you to peruse](examples/). You could also
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Check your changes with Rubocop tests (`script/rubocop`)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
 
 ## Releasing
 

data/Rakefile

@@ -1,7 +1,7 @@
 #!/usr/bin/env rake
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'rake/testtask'
-require "flipper/version"
+require 'flipper/version'
 
 # gem install pkg/*.gem
 # gem uninstall flipper flipper-ui flipper-redis
@@ -16,34 +16,34 @@ task :build do
 end
 
 desc 'Tags version, pushes to remote, and pushes gem'
-task :release => :build do
+task release: :build do
   sh 'git', 'tag', "v#{Flipper::VERSION}"
-  sh "git push origin master"
+  sh 'git push origin master'
   sh "git push origin v#{Flipper::VERSION}"
-  sh "ls pkg/*.gem | xargs -n 1 gem push"
+  sh 'ls pkg/*.gem | xargs -n 1 gem push'
 end
 
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w(--color)
 end
 
 namespace :spec do
-  desc "Run specs for UI queue"
+  desc 'Run specs for UI queue'
   RSpec::Core::RakeTask.new(:ui) do |t|
     t.rspec_opts = %w(--color)
-    t.pattern = ["spec/flipper/ui/**/*_spec.rb", "spec/flipper/ui_spec.rb"]
+    t.pattern = ['spec/flipper/ui/**/*_spec.rb', 'spec/flipper/ui_spec.rb']
   end
 end
 
 Rake::TestTask.new do |t|
-  t.libs = ['lib', 'test']
-  t.pattern = "test/**/*_test.rb"
+  t.libs = %w(lib test)
+  t.pattern = 'test/**/*_test.rb'
 end
 
 Rake::TestTask.new(:shared_test) do |t|
-  t.libs = ['lib', 'test']
-  t.pattern = "lib/flipper/shared/test/**_test.rb"
+  t.libs = %w(lib test)
+  t.pattern = 'lib/flipper/shared/test/**_test.rb'
 end
 
-task :default => [:spec, :test, :shared_test]
+task default: [:spec, :test, :shared_test]

data/docs/Adapters.md

@@ -11,10 +11,11 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 * [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, and 5.
 * [Sequel adapter](https://github.com/jnunemaker/flipper/blob/master/docs/sequel)
 * [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
+* [read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only)
+* [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http)
 
 ## Community Supported
 
-* [Active Record 4 adapter](https://github.com/bgentry/flipper-activerecord)
 * [Active Record 3 adapter](https://github.com/blueboxjesse/flipper-activerecord)
 * [Consul adapter](https://github.com/gdavison/flipper-consul)
 

data/docs/DockerCompose.md

@@ -7,9 +7,12 @@ new contributor could start working on code with a minumum efforts.
 ## Steps:
 
 1. Install Docker Compose https://docs.docker.com/compose/install
-2. Install gems `docker-compose run --rm app bundle install`
-3. Run specs `docker-compose run --rm app bundle exec rspec`
-4. Optional: log in to container an using a bash for running specs
+1. Build the app container `docker-compose build`
+1. Install gems `docker-compose run --rm app bundle install`
+1. Run specs `docker-compose run --rm app bundle exec rspec`
+1. Run tests `docker-compose run --rm app bundle exec rake test`
+1. Clear and check files with Rubocop `docker-compose run --rm  app bundle exec rubocop -D`
+1. Optional: log in to container an using a bash for running specs
 ```sh
 docker-compose run --rm app bash
 bundle exec rspec

data/docs/Gates.md

@@ -24,8 +24,8 @@ end
 
 flipper = Flipper.new(adapter)
 
-flipper[:stats].enable flipper.group(:admins) # turn on for admins
-flipper[:stats].disable flipper.group(:admins) # turn off for admins
+flipper[:stats].enable flipper.group(:admins) # turn on the stats feature for admins
+flipper[:stats].disable flipper.group(:admins) # turn off the stats feature for admins
 
 person = Person.find(params[:id])
 flipper[:stats].enabled? person # check if enabled, returns true if person.admin? is true
@@ -37,7 +37,29 @@ flipper[:stats].enable_group :admins
 flipper[:stats].disable_group :admins
 ```
 
-There is no requirement that the thing yielded to the block be a user model or whatever. It can be anything you want, therefore it is a good idea to check that the thing passed into the group block actually responds to what you are trying.
+Here's a quick explanation of the above code block:
+
+```
+Flipper.register(:admins) do |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+end
+```
+- The above first registers a group called `admins` which essentially saves a [Proc](http://www.eriktrautman.com/posts/ruby-explained-blocks-procs-and-lambdas-aka-closures) to be called later.
+
+```
+flipper[:stats].enable flipper.group(:admins)
+```
+
+- The above enables the stats feature to any object that returns true from the :admins proc.
+
+```
+person = Person.find(params[:id])
+flipper[:stats].enabled? person # check if person is enabled, returns true if person.admin? is true
+```
+
+When the `person` object is passed to the `enabled?` method, it is then passed into the proc. If the proc returns true, the entire statement returns true and so `flipper[:stats].enabled? person` returns true. Whatever logic follows this conditional check is then executed.
+
+There is no requirement that the thing yielded to the block be a user model or whatever. It can be anything you want, therefore it is a good idea to check that the thing passed into the group block actually responds to what you are trying to do in the `register` proc.
 
 ## 3. Individual Actor
 

data/docs/Optimization.md

@@ -12,8 +12,10 @@ You can use the middleware from a Rails initializer like so:
 # create flipper dsl instance, see above Usage for more details
 flipper = Flipper.new(...)
 
+require 'flipper/middleware/setup_env'
 require 'flipper/middleware/memoizer'
-config.middleware.use Flipper::Middleware::Memoizer, flipper
+config.middleware.use Flipper::Middleware::SetupEnv, flipper
+config.middleware.use Flipper::Middleware::Memoizer
 ```
 
 If you set your flipper instance up in an initializer, you can pass a block to the middleware and it will lazily load the instance the first time the middleware is invoked.
@@ -27,9 +29,12 @@ module MyRailsApp
 end
 
 # config/application.rb
-config.middleware.use Flipper::Middleware::Memoizer, lambda {
+require 'flipper/middleware/setup_env'
+require 'flipper/middleware/memoizer'
+config.middleware.use Flipper::Middleware::SetupEnv, lambda {
   MyRailsApp.flipper
 }
+config.middleware.use Flipper::Middleware::Memoizer
 ```
 
 **Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.
@@ -40,12 +45,12 @@ The Memoizer middleware also supports a few options. Use either `preload` or `pr
 
 * **`:preload`** - An `Array` of feature names (`Symbol`) to preload for every request. Useful if you have features that are used on every endpoint. `preload` uses `Adapter#get_multi` to attempt to load the features in one network call instead of N+1 network calls.
     ```ruby
-    config.middleware.use Flipper::Middleware::Memoizer, flipper,
+    config.middleware.use Flipper::Middleware::Memoizer,
       preload: [:stats, :search, :some_feature]
     ```
-* **`:preload_all`** - A Boolean value (default: false) of whether or not all features should be preloaded. Using this results in a `preload` call with the result of `Adapter#features`. Any subsequent feature checks will be memoized and perform no network calls. I wouldn't recommend using this unless you have few features (< 30?) and nearly all of them are used on every request.  
+* **`:preload_all`** - A Boolean value (default: false) of whether or not all features should be preloaded. Using this results in a `preload` call with the result of `Adapter#features`. Any subsequent feature checks will be memoized and perform no network calls. I wouldn't recommend using this unless you have few features (< 30?) and nearly all of them are used on every request.
     ```ruby
-    config.middleware.use Flipper::Middleware::Memoizer, flipper,
+    config.middleware.use Flipper::Middleware::Memoizer,
       preload_all: true
     ```
 
@@ -67,3 +72,20 @@ memory_adapter = Flipper::Adapters::Memory.new
 adapter = Flipper::Adapters::Dalli.new(memory_adapter, dalli_client, 600)
 flipper = Flipper.new(adapter)
 ```
+### RedisCache
+
+Applications using [Redis](https://redis.io/) via the [redis-rb](https://github.com/redis/redis-rb) client can take advantage of the RedisCache adapter.
+
+Initialize `RedisCache`  with a flipper [adapter](https://github.com/jnunemaker/flipper/blob/master/docs/Adapters.md), a Redis client instance, and an optional TTL in seconds. TTL defaults to 3600 seconds.
+
+Example using the RedisCache adapter with the Memory adapter and a TTL of 4800 seconds:
+
+```ruby
+  require 'flipper/adapters/memory'
+  require 'flipper/adapters/redis_cache'
+
+  redis = Redis.new(url: ENV['REDIS_URL'])
+  memory_adapter = Flipper::Adapters::Memory.new
+  adapter = Flipper::Adapters::RedisCache.new(memory_adapter, redis, 4800)
+  flipper = Flipper.new(adapter)
+```