From b268be1c82c9d66af6743fe917955043039fb26b Mon Sep 17 00:00:00 2001 From: Vadim Lazebny Date: Sun, 20 Nov 2016 08:48:58 +0200 Subject: [PATCH] Add Rubocop --- .rubocop.yml | 36 ++ .rubocop_todo.yml | 186 +++++++++ .travis.yml | 2 +- Gemfile | 8 +- Guardfile | 26 +- README.md | 7 +- Rakefile | 26 +- docker-compose/README.md | 41 ++ docs/DockerCompose.md | 3 +- flipper-active_record.gemspec | 26 +- flipper-api.gemspec | 24 +- flipper-dalli.gemspec | 22 +- flipper-mongo.gemspec | 22 +- flipper-redis.gemspec | 22 +- flipper-sequel.gemspec | 22 +- flipper-ui.gemspec | 24 +- flipper.gemspec | 30 +- lib/flipper/adapters/active_record.rb | 33 +- lib/flipper/adapters/dalli.rb | 2 +- lib/flipper/adapters/instrumented.rb | 72 ++-- lib/flipper/adapters/memoizable.rb | 8 +- lib/flipper/adapters/memory.rb | 19 +- lib/flipper/adapters/mongo.rb | 37 +- lib/flipper/adapters/operation_logger.rb | 2 +- lib/flipper/adapters/pstore.rb | 23 +- lib/flipper/adapters/read_only.rb | 12 +- lib/flipper/adapters/redis.rb | 19 +- lib/flipper/adapters/sequel.rb | 35 +- lib/flipper/api.rb | 4 +- lib/flipper/api/action.rb | 20 +- lib/flipper/api/action_collection.rb | 4 +- lib/flipper/api/error_response.rb | 17 +- lib/flipper/api/v1/actions/feature.rb | 1 - lib/flipper/api/v1/actions/features.rb | 9 +- .../v1/actions/percentage_of_actors_gate.rb | 6 +- lib/flipper/api/v1/decorators/feature.rb | 5 +- lib/flipper/dsl.rb | 4 +- lib/flipper/feature.rb | 21 +- lib/flipper/gate.rb | 6 +- lib/flipper/gate_values.rb | 12 +- lib/flipper/gates/group.rb | 4 +- lib/flipper/instrumentation/log_subscriber.rb | 6 +- lib/flipper/instrumentation/metriks.rb | 2 +- lib/flipper/instrumentation/statsd.rb | 2 +- .../instrumentation/statsd_subscriber.rb | 4 +- lib/flipper/instrumentation/subscriber.rb | 21 +- lib/flipper/instrumenters/memory.rb | 6 +- lib/flipper/instrumenters/noop.rb | 2 +- lib/flipper/middleware/memoizer.rb | 8 +- lib/flipper/registry.rb | 20 +- lib/flipper/spec/shared_adapter_specs.rb | 117 +++--- lib/flipper/test/shared_adapter_test.rb | 46 ++- lib/flipper/typecast.rb | 4 +- lib/flipper/types/actor.rb | 6 +- lib/flipper/types/group.rb | 2 +- lib/flipper/types/percentage.rb | 3 +- lib/flipper/ui.rb | 4 +- lib/flipper/ui/action.rb | 43 +- lib/flipper/ui/action_collection.rb | 4 +- lib/flipper/ui/actions/actors_gate.rb | 14 +- lib/flipper/ui/actions/add_feature.rb | 12 +- lib/flipper/ui/actions/boolean_gate.rb | 4 +- lib/flipper/ui/actions/feature.rb | 11 +- lib/flipper/ui/actions/features.rb | 19 +- lib/flipper/ui/actions/file.rb | 1 - lib/flipper/ui/actions/gate.rb | 7 +- lib/flipper/ui/actions/groups_gate.rb | 14 +- lib/flipper/ui/actions/home.rb | 3 +- .../ui/actions/percentage_of_actors_gate.rb | 4 +- .../ui/actions/percentage_of_time_gate.rb | 4 +- lib/flipper/ui/decorators/feature.rb | 18 +- lib/flipper/ui/decorators/gate.rb | 13 +- lib/flipper/ui/util.rb | 4 +- lib/flipper/version.rb | 2 +- .../flipper/active_record_generator.rb | 8 +- .../flipper/templates/sequel_migration.rb | 4 +- spec/flipper/adapters/active_record_spec.rb | 6 +- spec/flipper/adapters/dalli_spec.rb | 18 +- spec/flipper/adapters/instrumented_spec.rb | 40 +- spec/flipper/adapters/memoizable_spec.rb | 118 +++--- spec/flipper/adapters/mongo_spec.rb | 13 +- .../flipper/adapters/operation_logger_spec.rb | 32 +- spec/flipper/adapters/pstore_spec.rb | 12 +- spec/flipper/adapters/read_only_spec.rb | 66 ++- spec/flipper/adapters/redis_spec.rb | 8 +- spec/flipper/adapters/sequel_spec.rb | 2 +- spec/flipper/api/action_spec.rb | 66 ++- .../api/v1/actions/actors_gate_spec.rb | 26 +- spec/flipper/api/v1/actions/feature_spec.rb | 21 +- spec/flipper/api/v1/actions/features_spec.rb | 87 ++-- .../api/v1/actions/groups_gate_spec.rb | 19 +- .../actions/percentage_of_actors_gate_spec.rb | 17 +- .../actions/percentage_of_time_gate_spec.rb | 16 +- spec/flipper/dsl_spec.rb | 152 +++---- spec/flipper/feature_check_context_spec.rb | 54 +-- spec/flipper/feature_spec.rb | 386 +++++++++--------- spec/flipper/gate_spec.rb | 22 +- spec/flipper/gate_values_spec.rb | 91 +++-- spec/flipper/gates/actor_spec.rb | 4 +- spec/flipper/gates/boolean_spec.rb | 47 +-- spec/flipper/gates/group_spec.rb | 38 +- .../gates/percentage_of_actors_spec.rb | 20 +- spec/flipper/gates/percentage_of_time_spec.rb | 4 +- .../instrumentation/log_subscriber_spec.rb | 40 +- .../metriks_subscriber_spec.rb | 40 +- .../instrumentation/statsd_subscriber_spec.rb | 22 +- spec/flipper/instrumenters/memory_spec.rb | 10 +- spec/flipper/instrumenters/noop_spec.rb | 12 +- spec/flipper/middleware/memoizer_spec.rb | 140 ++++--- spec/flipper/registry_spec.rb | 74 ++-- spec/flipper/typecast_spec.rb | 36 +- spec/flipper/types/actor_spec.rb | 59 +-- spec/flipper/types/boolean_spec.rb | 16 +- spec/flipper/types/group_spec.rb | 56 +-- spec/flipper/types/percentage_spec.rb | 28 +- spec/flipper/ui/action_spec.rb | 44 +- spec/flipper/ui/actions/actors_gate_spec.rb | 94 +++-- spec/flipper/ui/actions/add_feature_spec.rb | 18 +- spec/flipper/ui/actions/boolean_gate_spec.rb | 44 +- spec/flipper/ui/actions/feature_spec.rb | 68 +-- spec/flipper/ui/actions/features_spec.rb | 84 ++-- spec/flipper/ui/actions/file_spec.rb | 16 +- spec/flipper/ui/actions/gate_spec.rb | 32 +- spec/flipper/ui/actions/groups_gate_spec.rb | 106 ++--- spec/flipper/ui/actions/home_spec.rb | 8 +- .../actions/percentage_of_actors_gate_spec.rb | 46 ++- .../actions/percentage_of_time_gate_spec.rb | 46 ++- spec/flipper/ui/decorators/feature_spec.rb | 54 +-- spec/flipper/ui/decorators/gate_spec.rb | 20 +- spec/flipper/ui/util_spec.rb | 8 +- spec/flipper/ui_spec.rb | 117 +++--- spec/flipper_spec.rb | 108 ++--- spec/helper.rb | 44 +- spec/integration_spec.rb | 234 ++++++----- spec/support/fake_udp_socket.rb | 2 +- spec/support/spec_helpers.rb | 36 +- test/adapters/active_record_test.rb | 6 +- test/adapters/mongo_test.rb | 8 +- test/adapters/pstore_test.rb | 6 +- test/adapters/redis_test.rb | 4 +- test/adapters/sequel_test.rb | 2 +- .../flipper/active_record_generator_test.rb | 4 +- test/test_helper.rb | 2 +- 143 files changed, 2416 insertions(+), 2107 deletions(-) create mode 100644 .rubocop.yml create mode 100644 .rubocop_todo.yml create mode 100644 docker-compose/README.md diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 000000000..1249e3335 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,36 @@ +# 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/**/*' + TargetRubyVersion: 2.0 + # DefaultFormatter: fuubar +Style/Alias: + Enabled: false + +Style/Documentation: + Enabled: false + +Style/Encoding: + Enabled: false + +Style/NumericLiterals: + Enabled: false + +Metrics/LineLength: + Max: 100 + Exclude: + - '*.gemspec' + +Style/RegexpLiteral: + EnforcedStyle: mixed + +Style/TrailingCommaInLiteral: + EnforcedStyleForMultiline: consistent_comma + diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml new file mode 100644 index 000000000..34d0d01d5 --- /dev/null +++ b/.rubocop_todo.yml @@ -0,0 +1,186 @@ +# 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' + - '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-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' diff --git a/.travis.yml b/.travis.yml index 2aba8b498..7c9991dc7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,7 +5,7 @@ rvm: - 2.2.4 bundler_args: --without guard before_script: gem install bundler -v 1.10.6 && sudo service redis-server status && sudo service mongodb status -script: bundle exec rake +script: bundle exec rubocop && bundle exec rake services: - redis-server - mongodb diff --git a/Gemfile b/Gemfile index 90b099201..7ef06a608 100644 --- a/Gemfile +++ b/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,10 @@ 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' # for active support tests in test/ and only needed for ruby 2.2.x gem 'test-unit', '~> 3.0' diff --git a/Guardfile b/Guardfile index d60073885..b8e75a93e 100644 --- a/Guardfile +++ b/Guardfile @@ -7,28 +7,28 @@ guard 'bundler' do end rspec_options = { - :all_after_pass => false, - :all_on_start => false, - :failed_mode => :keep, - :cmd => "bundle exec rspec", + all_after_pass: false, + all_on_start: false, + failed_mode: :keep, + cmd: 'bundle exec rspec', } guard 'rspec', rspec_options do - watch(%r{^spec/.+_spec\.rb$}) { "spec" } - watch(%r{^lib/(.+)\.rb$}) { "spec" } - watch(%r{shared_adapter_specs\.rb$}) { "spec" } - watch('spec/helper.rb') { "spec" } + watch(%r{^spec/.+_spec\.rb$}) { 'spec' } + watch(%r{^lib/(.+)\.rb$}) { 'spec' } + watch(/shared_adapter_specs\.rb$/) { 'spec' } + watch('spec/helper.rb') { 'spec' } end coffee_options = { - :input => 'lib/flipper/ui/assets/javascripts', - :output => 'lib/flipper/ui/public/js', - :all_on_start => false, + input: 'lib/flipper/ui/assets/javascripts', + output: 'lib/flipper/ui/public/js', + all_on_start: false, } guard 'coffeescript', coffee_options sass_options = { - :input => 'lib/flipper/ui/assets/stylesheets', - :output => 'lib/flipper/ui/public/css', + input: 'lib/flipper/ui/assets/stylesheets', + output: 'lib/flipper/ui/public/css', } guard 'sass', sass_options diff --git a/README.md b/README.md index b26f114db..843aef6c1 100644 --- a/README.md +++ b/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 (`bundle exec rubocop -aD'`) +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 diff --git a/Rakefile b/Rakefile index 3efecc64c..ba48d30bc 100644 --- a/Rakefile +++ b/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] diff --git a/docker-compose/README.md b/docker-compose/README.md new file mode 100644 index 000000000..7654ff682 --- /dev/null +++ b/docker-compose/README.md @@ -0,0 +1,41 @@ +### ============= Using =================== +1. Mount submodule: git submodule add git@bitbucket.org:forgesp/docker-compose.git docker-compose +2. Create docker compose file with 'app' section: +3. Utils for app: + + * docker-compose/bin/bash - run bash shell for app container + + ```sh + docker-compose/bin/bash + ``` + + * docker-compose/bin/bower - run command with 'bower' gem + + ```sh + docker-compose/bin/bower install + ``` + + * docker-compose/bin/bundle - run bundle wrapper + + ```sh + docker-compose/bin/bundle update + ``` + + * docker-compose/bin/call - run command in working dir + + ```sh + docker-compose/bin/call bin/db/prepare RACK_ENV=test + ``` + + * docker-compose/bin/rake - run rake command + + ```sh + docker-compose/bin/rake db:seed + ``` + + * docker-compose/bin/rspec - run rspec command or bin/rspec if it exists + + ```sh + docker-compose/bin/rspec spec/packages/events + ``` + diff --git a/docs/DockerCompose.md b/docs/DockerCompose.md index 8266d19a6..574aa70b1 100644 --- a/docs/DockerCompose.md +++ b/docs/DockerCompose.md @@ -9,7 +9,8 @@ new contributor could start working on code with a minumum efforts. 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 +4. Clear and check files with Rubocop `docker-compose run --rm app bundle exec rubocop -D` +5. Optional: log in to container an using a bash for running specs ```sh docker-compose run --rm app bash bundle exec rspec diff --git a/flipper-active_record.gemspec b/flipper-active_record.gemspec index 71bee2ef8..30aaed4b2 100644 --- a/flipper-active_record.gemspec +++ b/flipper-active_record.gemspec @@ -1,28 +1,28 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_active_record_files = lambda { |file| +flipper_active_record_files = lambda do |file| file =~ /active_record/ -} +end Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "ActiveRecord adapter for Flipper" - gem.description = "ActiveRecord adapter for Flipper" - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'ActiveRecord adapter for Flipper' + gem.description = 'ActiveRecord adapter for Flipper' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' extra_files = [ - "lib/generators/flipper/templates/migration.rb", - "lib/flipper/version.rb", + 'lib/generators/flipper/templates/migration.rb', + 'lib/flipper/version.rb', ] gem.files = `git ls-files`.split("\n").select(&flipper_active_record_files) + extra_files gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_active_record_files) - gem.name = "flipper-active_record" - gem.require_paths = ["lib"] + gem.name = 'flipper-active_record' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'flipper', "~> #{Flipper::VERSION}" - gem.add_dependency 'activerecord', ">= 3.2", "< 6" + gem.add_dependency 'activerecord', '>= 3.2', '< 6' end diff --git a/flipper-api.gemspec b/flipper-api.gemspec index a695afc95..cb18a9d48 100644 --- a/flipper-api.gemspec +++ b/flipper-api.gemspec @@ -1,21 +1,21 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_api_files = lambda { |file| - file =~ /(flipper)[\/-]api/ -} +flipper_api_files = lambda do |file| + file =~ %r{(flipper)[\/-]api} +end Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "API for the Flipper gem" - gem.description = "Rack middleware that provides an API for the flipper gem." - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" - gem.files = `git ls-files`.split("\n").select(&flipper_api_files) + ["lib/flipper/version.rb"] + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'API for the Flipper gem' + gem.description = 'Rack middleware that provides an API for the flipper gem.' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' + gem.files = `git ls-files`.split("\n").select(&flipper_api_files) + ['lib/flipper/version.rb'] gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_api_files) - gem.name = "flipper-api" - gem.require_paths = ["lib"] + gem.name = 'flipper-api' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'rack', '>= 1.4', '< 3' diff --git a/flipper-dalli.gemspec b/flipper-dalli.gemspec index 4d13b13b0..e3e467b6c 100644 --- a/flipper-dalli.gemspec +++ b/flipper-dalli.gemspec @@ -1,22 +1,22 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_dalli_files = lambda { |file| +flipper_dalli_files = lambda do |file| file =~ /dalli/ -} +end Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "Dalli adapter for Flipper" - gem.description = "Dalli adapter for Flipper" - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'Dalli adapter for Flipper' + gem.description = 'Dalli adapter for Flipper' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' - gem.files = `git ls-files`.split("\n").select(&flipper_dalli_files) + ["lib/flipper/version.rb"] + gem.files = `git ls-files`.split("\n").select(&flipper_dalli_files) + ['lib/flipper/version.rb'] gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_dalli_files) - gem.name = "flipper-dalli" - gem.require_paths = ["lib"] + gem.name = 'flipper-dalli' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'flipper', "~> #{Flipper::VERSION}" diff --git a/flipper-mongo.gemspec b/flipper-mongo.gemspec index f52ac5546..eab67dc3c 100644 --- a/flipper-mongo.gemspec +++ b/flipper-mongo.gemspec @@ -1,22 +1,22 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_mongo_files = lambda { |file| +flipper_mongo_files = lambda do |file| file =~ /mongo/ -} +end Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "Mongo adapter for Flipper" - gem.description = "Mongo adapter for Flipper" - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'Mongo adapter for Flipper' + gem.description = 'Mongo adapter for Flipper' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' - gem.files = `git ls-files`.split("\n").select(&flipper_mongo_files) + ["lib/flipper/version.rb"] + gem.files = `git ls-files`.split("\n").select(&flipper_mongo_files) + ['lib/flipper/version.rb'] gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_mongo_files) - gem.name = "flipper-mongo" - gem.require_paths = ["lib"] + gem.name = 'flipper-mongo' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'flipper', "~> #{Flipper::VERSION}" diff --git a/flipper-redis.gemspec b/flipper-redis.gemspec index 2530294e9..5ad0b8fb4 100644 --- a/flipper-redis.gemspec +++ b/flipper-redis.gemspec @@ -1,22 +1,22 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_redis_files = lambda { |file| +flipper_redis_files = lambda do |file| file =~ /redis/ -} +end Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "Redis adapter for Flipper" - gem.description = "Redis adapter for Flipper" - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'Redis adapter for Flipper' + gem.description = 'Redis adapter for Flipper' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' - gem.files = `git ls-files`.split("\n").select(&flipper_redis_files) + ["lib/flipper/version.rb"] + gem.files = `git ls-files`.split("\n").select(&flipper_redis_files) + ['lib/flipper/version.rb'] gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_redis_files) - gem.name = "flipper-redis" - gem.require_paths = ["lib"] + gem.name = 'flipper-redis' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'flipper', "~> #{Flipper::VERSION}" diff --git a/flipper-sequel.gemspec b/flipper-sequel.gemspec index 879fe7127..07bde5d78 100644 --- a/flipper-sequel.gemspec +++ b/flipper-sequel.gemspec @@ -1,25 +1,25 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_sequel_files = lambda { |file| file =~ /sequel/ } +flipper_sequel_files = ->(file) { file =~ /sequel/ } Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "Sequel adapter for Flipper" - gem.description = "Sequel adapter for Flipper" - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'Sequel adapter for Flipper' + gem.description = 'Sequel adapter for Flipper' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' extra_files = [ - "lib/flipper/version.rb", + 'lib/flipper/version.rb', ] gem.files = `git ls-files`.split("\n").select(&flipper_sequel_files) + extra_files gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_sequel_files) - gem.name = "flipper-sequel" - gem.require_paths = ["lib"] + gem.name = 'flipper-sequel' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'flipper', "~> #{Flipper::VERSION}" - gem.add_dependency 'sequel', ">= 4.0.0", "< 5" + gem.add_dependency 'sequel', '>= 4.0.0', '< 5' end diff --git a/flipper-ui.gemspec b/flipper-ui.gemspec index 2a60ae1b7..cab77e9c0 100644 --- a/flipper-ui.gemspec +++ b/flipper-ui.gemspec @@ -1,22 +1,22 @@ # -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) -flipper_ui_files = lambda { |file| - file =~ /(docs|examples|flipper)[\/-]ui/ -} +flipper_ui_files = lambda do |file| + file =~ %r{(docs|examples|flipper)[\/-]ui} +end Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = "UI for the Flipper gem" - gem.description = "Rack middleware that provides a fully featured web interface for the flipper gem." - gem.license = "MIT" - gem.homepage = "https://github.com/jnunemaker/flipper" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'UI for the Flipper gem' + gem.description = 'Rack middleware that provides a fully featured web interface for the flipper gem.' + gem.license = 'MIT' + gem.homepage = 'https://github.com/jnunemaker/flipper' - gem.files = `git ls-files`.split("\n").select(&flipper_ui_files) + ["lib/flipper/version.rb"] + gem.files = `git ls-files`.split("\n").select(&flipper_ui_files) + ['lib/flipper/version.rb'] gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_ui_files) - gem.name = "flipper-ui" - gem.require_paths = ["lib"] + gem.name = 'flipper-ui' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION gem.add_dependency 'rack', '>= 1.4', '< 3' diff --git a/flipper.gemspec b/flipper.gemspec index 0ec3d0c03..35a3488b2 100644 --- a/flipper.gemspec +++ b/flipper.gemspec @@ -4,34 +4,34 @@ require File.expand_path('../lib/flipper/version', __FILE__) plugin_files = [] plugin_test_files = [] -Dir['flipper-*.gemspec'].map { |gemspec| +Dir['flipper-*.gemspec'].map do |gemspec| spec = eval(File.read(gemspec)) plugin_files << spec.files plugin_test_files << spec.files -} +end ignored_files = plugin_files ignored_files << Dir['script/*'] -ignored_files << ".travis.yml" -ignored_files << ".gitignore" -ignored_files << "Guardfile" +ignored_files << '.travis.yml' +ignored_files << '.gitignore' +ignored_files << 'Guardfile' ignored_files.flatten!.uniq! ignored_test_files = plugin_test_files ignored_test_files.flatten!.uniq! Gem::Specification.new do |gem| - gem.authors = ["John Nunemaker"] - gem.email = ["nunemaker@gmail.com"] - gem.summary = %q{Feature flipper for ANYTHING} - gem.description = %q{Feature flipper is the act of enabling/disabling features in your application, ideally without re-deploying or changing anything in your code base. Flipper makes this extremely easy to do with any backend you would like to use.} - gem.homepage = "https://github.com/jnunemaker/flipper" - gem.license = "MIT" + gem.authors = ['John Nunemaker'] + gem.email = ['nunemaker@gmail.com'] + gem.summary = 'Feature flipper for ANYTHING' + gem.description = 'Feature flipper is the act of enabling/disabling features in your application, ideally without re-deploying or changing anything in your code base. Flipper makes this extremely easy to do with any backend you would like to use.' + gem.homepage = 'https://github.com/jnunemaker/flipper' + gem.license = 'MIT' - gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) } - gem.files = `git ls-files`.split("\n") - ignored_files + ["lib/flipper/version.rb"] + gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) } + gem.files = `git ls-files`.split("\n") - ignored_files + ['lib/flipper/version.rb'] gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files - gem.name = "flipper" - gem.require_paths = ["lib"] + gem.name = 'flipper' + gem.require_paths = ['lib'] gem.version = Flipper::VERSION end diff --git a/lib/flipper/adapters/active_record.rb b/lib/flipper/adapters/active_record.rb index ad2d6981c..87e08a388 100644 --- a/lib/flipper/adapters/active_record.rb +++ b/lib/flipper/adapters/active_record.rb @@ -9,12 +9,12 @@ class ActiveRecord # Private: Do not use outside of this adapter. class Feature < ::ActiveRecord::Base - self.table_name = "flipper_features" + self.table_name = 'flipper_features' end # Private: Do not use outside of this adapter. class Gate < ::ActiveRecord::Base - self.table_name = "flipper_gates" + self.table_name = 'flipper_gates' end # Public: The name of the adapter. @@ -78,7 +78,7 @@ def get(feature) def get_multi(features) db_gates = @gate_class.where(feature_key: features.map(&:key)) - grouped_db_gates = db_gates.group_by { |gate| gate.feature_key } + grouped_db_gates = db_gates.group_by(&:feature_key) result = {} features.each do |feature| result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key]) @@ -165,20 +165,21 @@ def result_for_feature(feature, db_gates) db_gates ||= [] result = {} feature.gates.each do |gate| - result[gate.key] = case gate.data_type - when :boolean - if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } - db_gate.value + result[gate.key] = + case gate.data_type + when :boolean + if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } + db_gate.value + end + when :integer + if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } + db_gate.value + end + when :set + db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set + else + unsupported_data_type gate.data_type end - when :integer - if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } - db_gate.value - end - when :set - db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set - else - unsupported_data_type gate.data_type - end end result end diff --git a/lib/flipper/adapters/dalli.rb b/lib/flipper/adapters/dalli.rb index 1e28ab062..6e13c9eb9 100644 --- a/lib/flipper/adapters/dalli.rb +++ b/lib/flipper/adapters/dalli.rb @@ -7,7 +7,7 @@ module Adapters class Dalli include ::Flipper::Adapter - Version = "v1".freeze + Version = 'v1'.freeze Namespace = "flipper/#{Version}".freeze FeaturesKey = "#{Namespace}/features".freeze diff --git a/lib/flipper/adapters/instrumented.rb b/lib/flipper/adapters/instrumented.rb index 3b1ea71a2..594104183 100644 --- a/lib/flipper/adapters/instrumented.rb +++ b/lib/flipper/adapters/instrumented.rb @@ -34,93 +34,93 @@ def initialize(adapter, options = {}) # Public def features payload = { - :operation => :features, - :adapter_name => @adapter.name, + operation: :features, + adapter_name: @adapter.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.features - } + end end # Public def add(feature) payload = { - :operation => :add, - :adapter_name => @adapter.name, - :feature_name => feature.name, + operation: :add, + adapter_name: @adapter.name, + feature_name: feature.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.add(feature) - } + end end # Public def remove(feature) payload = { - :operation => :remove, - :adapter_name => @adapter.name, - :feature_name => feature.name, + operation: :remove, + adapter_name: @adapter.name, + feature_name: feature.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.remove(feature) - } + end end # Public def clear(feature) payload = { - :operation => :clear, - :adapter_name => @adapter.name, - :feature_name => feature.name, + operation: :clear, + adapter_name: @adapter.name, + feature_name: feature.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.clear(feature) - } + end end # Public def get(feature) payload = { - :operation => :get, - :adapter_name => @adapter.name, - :feature_name => feature.name, + operation: :get, + adapter_name: @adapter.name, + feature_name: feature.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.get(feature) - } + end end # Public def enable(feature, gate, thing) payload = { - :operation => :enable, - :adapter_name => @adapter.name, - :feature_name => feature.name, - :gate_name => gate.name, + operation: :enable, + adapter_name: @adapter.name, + feature_name: feature.name, + gate_name: gate.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.enable(feature, gate, thing) - } + end end # Public def disable(feature, gate, thing) payload = { - :operation => :disable, - :adapter_name => @adapter.name, - :feature_name => feature.name, - :gate_name => gate.name, + operation: :disable, + adapter_name: @adapter.name, + feature_name: feature.name, + gate_name: gate.name, } - @instrumenter.instrument(InstrumentationName, payload) { |payload| + @instrumenter.instrument(InstrumentationName, payload) do |payload| payload[:result] = @adapter.disable(feature, gate, thing) - } + end end end end diff --git a/lib/flipper/adapters/memoizable.rb b/lib/flipper/adapters/memoizable.rb index 337e58cd1..b9759a09d 100644 --- a/lib/flipper/adapters/memoizable.rb +++ b/lib/flipper/adapters/memoizable.rb @@ -120,15 +120,11 @@ def memoizing? private def expire_feature(feature) - if memoizing? - cache.delete(feature.key) - end + cache.delete(feature.key) if memoizing? end def expire_features_set - if memoizing? - cache.delete(FeaturesKey) - end + cache.delete(FeaturesKey) if memoizing? end end end diff --git a/lib/flipper/adapters/memory.rb b/lib/flipper/adapters/memory.rb index b04a0ada0..d0eadf8e5 100644 --- a/lib/flipper/adapters/memory.rb +++ b/lib/flipper/adapters/memory.rb @@ -50,14 +50,15 @@ def get(feature) result = {} feature.gates.each do |gate| - result[gate.key] = case gate.data_type - when :boolean, :integer - read key(feature, gate) - when :set - set_members key(feature, gate) - else - raise "#{gate} is not supported by this adapter yet" - end + result[gate.key] = + case gate.data_type + when :boolean, :integer + read key(feature, gate) + when :set + set_members key(feature, gate) + else + raise "#{gate} is not supported by this adapter yet" + end end result @@ -96,7 +97,7 @@ def disable(feature, gate, thing) # Public def inspect attributes = [ - "name=:memory", + 'name=:memory', "source=#{@source.inspect}", ] "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>" diff --git a/lib/flipper/adapters/mongo.rb b/lib/flipper/adapters/mongo.rb index 14e72c59e..e502c0a7e 100644 --- a/lib/flipper/adapters/mongo.rb +++ b/lib/flipper/adapters/mongo.rb @@ -25,13 +25,13 @@ def features # Public: Adds a feature to the set of known features. def add(feature) - update FeaturesKey, '$addToSet' => {'features' => feature.key} + update FeaturesKey, '$addToSet' => { 'features' => feature.key } true end # Public: Removes a feature from the set of known features. def remove(feature) - update FeaturesKey, '$pull' => {'features' => feature.key} + update FeaturesKey, '$pull' => { 'features' => feature.key } clear feature true end @@ -95,9 +95,9 @@ def disable(feature, gate, thing) when :boolean delete feature.key when :integer - update feature.key, '$set' => {gate.key.to_s => thing.value.to_s} + update feature.key, '$set' => { gate.key.to_s => thing.value.to_s } when :set - update feature.key, '$pull' => {gate.key.to_s => thing.value.to_s} + update feature.key, '$pull' => { gate.key.to_s => thing.value.to_s } else unsupported_data_type gate.data_type end @@ -112,40 +112,41 @@ def unsupported_data_type(data_type) # Private def find(key) - @collection.find({:_id => key.to_s}).limit(1).first || {} + @collection.find(_id: key.to_s).limit(1).first || {} end def find_many(keys) - docs = @collection.find({_id: {'$in' => keys}}).to_a + docs = @collection.find(_id: { '$in' => keys }).to_a result = Hash.new { |hash, key| hash[key] = {} } docs.each do |doc| - result[doc["_id"]] = doc + result[doc['_id']] = doc end result end # Private def update(key, updates) - options = {:upsert => true} - @collection.find({:_id => key.to_s}).update_one(updates, options) + options = { upsert: true } + @collection.find(_id: key.to_s).update_one(updates, options) end # Private def delete(key) - @collection.find({:_id => key.to_s}).delete_one + @collection.find(_id: key.to_s).delete_one end def result_for_feature(feature, doc) result = {} feature.gates.each do |gate| - result[gate.key] = case gate.data_type - when :boolean, :integer - doc[gate.key.to_s] - when :set - doc.fetch(gate.key.to_s) { Set.new }.to_set - else - unsupported_data_type gate.data_type - end + result[gate.key] = + case gate.data_type + when :boolean, :integer + doc[gate.key.to_s] + when :set + doc.fetch(gate.key.to_s) { Set.new }.to_set + else + unsupported_data_type gate.data_type + end end result end diff --git a/lib/flipper/adapters/operation_logger.rb b/lib/flipper/adapters/operation_logger.rb index d7af0ed51..f6a7151a6 100644 --- a/lib/flipper/adapters/operation_logger.rb +++ b/lib/flipper/adapters/operation_logger.rb @@ -19,7 +19,7 @@ class OperationLogger < SimpleDelegator :get_multi, :enable, :disable, - ] + ].freeze # Internal: An array of the operations that have happened. attr_reader :operations diff --git a/lib/flipper/adapters/pstore.rb b/lib/flipper/adapters/pstore.rb index 471e28ef8..811e29e17 100644 --- a/lib/flipper/adapters/pstore.rb +++ b/lib/flipper/adapters/pstore.rb @@ -1,5 +1,5 @@ -require "pstore" -require "set" +require 'pstore' +require 'set' module Flipper module Adapters @@ -17,7 +17,7 @@ class PStore attr_reader :path # Public - def initialize(path = "flipper.pstore") + def initialize(path = 'flipper.pstore') @path = path @store = ::PStore.new(path) @name = :pstore @@ -55,14 +55,15 @@ def get(feature) result = {} feature.gates.each do |gate| - result[gate.key] = case gate.data_type - when :boolean, :integer - read key(feature, gate) - when :set - set_members key(feature, gate) - else - raise "#{gate} is not supported by this adapter yet" - end + result[gate.key] = + case gate.data_type + when :boolean, :integer + read key(feature, gate) + when :set + set_members key(feature, gate) + else + raise "#{gate} is not supported by this adapter yet" + end end result diff --git a/lib/flipper/adapters/read_only.rb b/lib/flipper/adapters/read_only.rb index 13980d5ea..0b4468e6e 100644 --- a/lib/flipper/adapters/read_only.rb +++ b/lib/flipper/adapters/read_only.rb @@ -6,7 +6,7 @@ class ReadOnly class WriteAttempted < Error def initialize(message = nil) - super(message || "write attempted while in read only mode") + super(message || 'write attempted while in read only mode') end end @@ -27,23 +27,23 @@ def get(feature) @adapter.get(feature) end - def add(feature) + def add(_feature) raise WriteAttempted end - def remove(feature) + def remove(_feature) raise WriteAttempted end - def clear(feature) + def clear(_feature) raise WriteAttempted end - def enable(feature, gate, thing) + def enable(_feature, _gate, _thing) raise WriteAttempted end - def disable(feature, gate, thing) + def disable(_feature, _gate, _thing) raise WriteAttempted end end diff --git a/lib/flipper/adapters/redis.rb b/lib/flipper/adapters/redis.rb index 2889c01b3..dfe367b2e 100644 --- a/lib/flipper/adapters/redis.rb +++ b/lib/flipper/adapters/redis.rb @@ -126,14 +126,15 @@ def result_for_feature(feature, doc) fields = doc.keys feature.gates.each do |gate| - result[gate.key] = case gate.data_type - when :boolean, :integer - doc[gate.key.to_s] - when :set - fields_to_gate_value fields, gate - else - unsupported_data_type gate.data_type - end + result[gate.key] = + case gate.data_type + when :boolean, :integer + doc[gate.key.to_s] + when :set + fields_to_gate_value fields, gate + else + unsupported_data_type gate.data_type + end end result @@ -148,7 +149,7 @@ def to_field(gate, thing) # # Returns a Set of the values enabled for the gate. def fields_to_gate_value(fields, gate) - regex = /^#{Regexp.escape(gate.key.to_s)}\// + regex = %r{^#{Regexp.escape(gate.key.to_s)}/} keys = fields.grep(regex) values = keys.map { |key| key.split('/', 2).last } values.to_set diff --git a/lib/flipper/adapters/sequel.rb b/lib/flipper/adapters/sequel.rb index 4eb5b95c0..21234ef04 100644 --- a/lib/flipper/adapters/sequel.rb +++ b/lib/flipper/adapters/sequel.rb @@ -77,7 +77,7 @@ def get(feature) def get_multi(features) db_gates = @gate_class.where(feature_key: features.map(&:key)).to_a - grouped_db_gates = db_gates.group_by { |gate| gate.feature_key } + grouped_db_gates = db_gates.group_by(&:feature_key) result = {} features.each do |feature| result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key]) @@ -98,7 +98,7 @@ def enable(feature, gate, thing) @gate_class.db.transaction do args = { feature_key: feature.key, - key: gate.key.to_s + key: gate.key.to_s, } @gate_class.where(args).delete @@ -128,7 +128,7 @@ def disable(feature, gate, thing) @gate_class.db.transaction do args = { feature_key: feature.key.to_s, - key: gate.key.to_s + key: gate.key.to_s, } @gate_class.where(args).delete @@ -154,27 +154,28 @@ def gate_attrs(feature, gate, thing) { feature_key: feature.key.to_s, key: gate.key.to_s, - value: thing.value.to_s + value: thing.value.to_s, } end def result_for_feature(feature, db_gates) db_gates ||= [] feature.gates.each_with_object({}) do |gate, result| - result[gate.key] = case gate.data_type - when :boolean - if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } - db_gate.value + result[gate.key] = + case gate.data_type + when :boolean + if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } + db_gate.value + end + when :integer + if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } + db_gate.value + end + when :set + db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set + else + unsupported_data_type gate.data_type end - when :integer - if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } - db_gate.value - end - when :set - db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set - else - unsupported_data_type gate.data_type - end end end end diff --git a/lib/flipper/api.rb b/lib/flipper/api.rb index 3edf655fe..486942829 100644 --- a/lib/flipper/api.rb +++ b/lib/flipper/api.rb @@ -8,7 +8,7 @@ module Api CONTENT_TYPE = 'application/json'.freeze def self.app(flipper) - app = App.new(200,{ 'Content-Type' => CONTENT_TYPE }, ['']) + app = App.new(200, { 'Content-Type' => CONTENT_TYPE }, ['']) builder = Rack::Builder.new yield builder if block_given? builder.use Flipper::Api::Middleware, flipper @@ -29,7 +29,7 @@ def initialize(status, headers, body) # Public : Rack expects object that responds to call # env - environment hash - def call(env) + def call(_env) response end diff --git a/lib/flipper/api/action.rb b/lib/flipper/api/action.rb index 8744b613b..cd20b4343 100644 --- a/lib/flipper/api/action.rb +++ b/lib/flipper/api/action.rb @@ -9,11 +9,11 @@ class Action extend Forwardable VALID_REQUEST_METHOD_NAMES = Set.new([ - "get".freeze, - "post".freeze, - "put".freeze, - "delete".freeze, - ]).freeze + 'get'.freeze, + 'post'.freeze, + 'put'.freeze, + 'delete'.freeze, + ]).freeze # Public: Call this in subclasses so the action knows its route. # @@ -50,9 +50,10 @@ def self.regex def_delegator :@request, :params def initialize(flipper, request) - @flipper, @request = flipper, request + @flipper = flipper + @request = request @code = 200 - @headers = {"Content-Type" => Api::CONTENT_TYPE } + @headers = { 'Content-Type' => Api::CONTENT_TYPE } end # Public: Runs the request method for the provided request. @@ -62,7 +63,8 @@ def run if valid_request_method? && respond_to?(request_method_name) catch(:halt) { send(request_method_name) } else - raise Api::RequestMethodNotSupported, "#{self.class} does not support request method #{request_method_name.inspect}" + raise Api::RequestMethodNotSupported, + "#{self.class} does not support request method #{request_method_name.inspect}" end end @@ -137,7 +139,7 @@ def request_method_name # Private: split request path by "/" # Example: "api/v1/features/feature_name" => ['api', 'v1', 'features', 'feature_name'] def path_parts - @request.path.split("/") + @request.path.split('/') end def valid_request_method? diff --git a/lib/flipper/api/action_collection.rb b/lib/flipper/api/action_collection.rb index 60a1dfa87..316e33c53 100644 --- a/lib/flipper/api/action_collection.rb +++ b/lib/flipper/api/action_collection.rb @@ -10,9 +10,9 @@ def add(action_class) end def action_for_request(request) - @action_classes.detect { |action_class| + @action_classes.detect do |action_class| request.path_info =~ action_class.regex - } + end end end end diff --git a/lib/flipper/api/error_response.rb b/lib/flipper/api/error_response.rb index cd11bdf53..b2d10bba7 100644 --- a/lib/flipper/api/error_response.rb +++ b/lib/flipper/api/error_response.rb @@ -7,7 +7,8 @@ class Error def initialize(code, message, http_status) @code = code @message = message - @more_info = "https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference" + @more_info = + 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' @http_status = http_status end @@ -21,13 +22,13 @@ def as_json end ERRORS = { - feature_not_found: Error.new(1, "Feature not found.", 404), - group_not_registered: Error.new(2, "Group not registered.", 404), - percentage_invalid: Error.new(3, "Percentage must be a positive number less than or equal to 100.", 422), - flipper_id_invalid: Error.new(4, "Required parameter flipper_id is missing.", 422), - name_invalid: Error.new(5, "Required parameter name is missing.", 422), - } - + feature_not_found: Error.new(1, 'Feature not found.', 404), + group_not_registered: Error.new(2, 'Group not registered.', 404), + percentage_invalid: + Error.new(3, 'Percentage must be a positive number less than or equal to 100.', 422), + flipper_id_invalid: Error.new(4, 'Required parameter flipper_id is missing.', 422), + name_invalid: Error.new(5, 'Required parameter name is missing.', 422), + }.freeze end end end diff --git a/lib/flipper/api/v1/actions/feature.rb b/lib/flipper/api/v1/actions/feature.rb index b34523da4..d70b9fd7d 100644 --- a/lib/flipper/api/v1/actions/feature.rb +++ b/lib/flipper/api/v1/actions/feature.rb @@ -6,7 +6,6 @@ module Api module V1 module Actions class Feature < Api::Action - route %r{api/v1/features/[^/]*/?\Z} def get diff --git a/lib/flipper/api/v1/actions/features.rb b/lib/flipper/api/v1/actions/features.rb index fba251f7f..7f7290cb5 100644 --- a/lib/flipper/api/v1/actions/features.rb +++ b/lib/flipper/api/v1/actions/features.rb @@ -7,17 +7,14 @@ module Api module V1 module Actions class Features < Api::Action - route %r{api/v1/features\Z} def get - features = flipper.features.map { |feature| + features = flipper.features.map do |feature| Decorators::Feature.new(feature).as_json - } + end - json_response({ - features: features - }) + json_response(features: features) end def post diff --git a/lib/flipper/api/v1/actions/percentage_of_actors_gate.rb b/lib/flipper/api/v1/actions/percentage_of_actors_gate.rb index 057cee9f5..0d07aa199 100644 --- a/lib/flipper/api/v1/actions/percentage_of_actors_gate.rb +++ b/lib/flipper/api/v1/actions/percentage_of_actors_gate.rb @@ -54,11 +54,11 @@ def percentage end end - def feature_names - @feature_names ||= flipper.adapter.features - end + def feature_names + @feature_names ||= flipper.adapter.features end end end end end +end diff --git a/lib/flipper/api/v1/decorators/feature.rb b/lib/flipper/api/v1/decorators/feature.rb index 483204139..288da0a31 100644 --- a/lib/flipper/api/v1/decorators/feature.rb +++ b/lib/flipper/api/v1/decorators/feature.rb @@ -6,7 +6,6 @@ module Api module V1 module Decorators class Feature < SimpleDelegator - # Public: The feature being decorated. alias_method :feature, :__getobj__ @@ -16,9 +15,9 @@ def as_json { 'key' => key, 'state' => state.to_s, - 'gates' => gates.map { |gate| + 'gates' => gates.map do |gate| Decorators::Gate.new(gate, gate_values[gate.key]).as_json - }, + end, } end end diff --git a/lib/flipper/dsl.rb b/lib/flipper/dsl.rb index ca938930c..c7d0e1a26 100644 --- a/lib/flipper/dsl.rb +++ b/lib/flipper/dsl.rb @@ -158,9 +158,7 @@ def feature(name) raise ArgumentError, "#{name} must be a String or Symbol" end - @memoized_features[name.to_sym] ||= Feature.new(name, @adapter, { - :instrumenter => instrumenter, - }) + @memoized_features[name.to_sym] ||= Feature.new(name, @adapter, instrumenter: instrumenter) end # Public: Preload the features with the given names. diff --git a/lib/flipper/feature.rb b/lib/flipper/feature.rb index 7170209e0..0e904d5c1 100644 --- a/lib/flipper/feature.rb +++ b/lib/flipper/feature.rb @@ -41,7 +41,7 @@ def initialize(name, adapter, options = {}) # # Returns the result of Adapter#enable. def enable(thing = true) - instrument(:enable) { |payload| + instrument(:enable) do |payload| adapter.add self gate = gate_for(thing) @@ -50,14 +50,14 @@ def enable(thing = true) payload[:thing] = wrapped_thing adapter.enable self, gate, wrapped_thing - } + end end # Public: Disable this feature for something. # # Returns the result of Adapter#disable. def disable(thing = false) - instrument(:disable) { |payload| + instrument(:disable) do |payload| adapter.add self gate = gate_for(thing) @@ -70,7 +70,7 @@ def disable(thing = false) else adapter.disable self, gate, wrapped_thing end - } + end end # Public: Removes this feature. @@ -84,14 +84,14 @@ def remove # # Returns true if enabled, false if not. def enabled?(thing = nil) - instrument(:enabled?) { |payload| + instrument(:enabled?) do |payload| values = gate_values thing = gate(:actor).wrap(thing) unless thing.nil? payload[:thing] = thing context = FeatureCheckContext.new( feature_name: @name, values: values, - thing: thing, + thing: thing ) if open_gate = gates.detect { |gate| gate.open?(context) } @@ -100,7 +100,7 @@ def enabled?(thing = nil) else false end - } + end end # Public: Enables a feature for an actor. @@ -346,19 +346,18 @@ def gate(name) # Returns a Flipper::Gate. # Raises Flipper::GateNotFound if no gate found for thing def gate_for(thing) - gates.detect { |gate| gate.protects?(thing) } || - raise(GateNotFound.new(thing)) + gates.detect { |gate| gate.protects?(thing) } || raise(GateNotFound, thing) end private # Private: Instrument a feature operation. def instrument(operation) - @instrumenter.instrument(InstrumentationName) { |payload| + @instrumenter.instrument(InstrumentationName) do |payload| payload[:feature_name] = name payload[:operation] = operation payload[:result] = yield(payload) if block_given? - } + end end end end diff --git a/lib/flipper/gate.rb b/lib/flipper/gate.rb index c0e36b411..da7af2e55 100644 --- a/lib/flipper/gate.rb +++ b/lib/flipper/gate.rb @@ -18,21 +18,21 @@ def data_type raise 'Not implemented' end - def enabled?(value) + def enabled?(_value) raise 'Not implemented' end # Internal: Check if a gate is open for a thing. Implemented in subclass. # # Returns true if gate open for thing, false if not. - def open?(thing, value, options = {}) + def open?(_thing, _value, _options = {}) false end # Internal: Check if a gate is protects a thing. Implemented in subclass. # # Returns true if gate protects thing, false if not. - def protects?(thing) + def protects?(_thing) false end diff --git a/lib/flipper/gate_values.rb b/lib/flipper/gate_values.rb index b9bde806e..8aca084ca 100644 --- a/lib/flipper/gate_values.rb +++ b/lib/flipper/gate_values.rb @@ -1,15 +1,15 @@ -require "set" +require 'set' module Flipper class GateValues # Private: Array of instance variables that are readable through the [] # instance method. LegitIvars = { - "boolean" => "@boolean", - "actors" => "@actors", - "groups" => "@groups", - "percentage_of_time" => "@percentage_of_time", - "percentage_of_actors" => "@percentage_of_actors", + 'boolean' => '@boolean', + 'actors' => '@actors', + 'groups' => '@groups', + 'percentage_of_time' => '@percentage_of_time', + 'percentage_of_actors' => '@percentage_of_actors', }.freeze attr_reader :boolean diff --git a/lib/flipper/gates/group.rb b/lib/flipper/gates/group.rb index 30f5c6930..611a75ae8 100644 --- a/lib/flipper/gates/group.rb +++ b/lib/flipper/gates/group.rb @@ -27,14 +27,14 @@ def open?(context) if context.thing.nil? false else - value.any? { |name| + value.any? do |name| begin group = Flipper.group(name) group.match?(context.thing, context) rescue GroupNotRegistered false end - } + end end end diff --git a/lib/flipper/instrumentation/log_subscriber.rb b/lib/flipper/instrumentation/log_subscriber.rb index 45a54e0b1..df06252a9 100644 --- a/lib/flipper/instrumentation/log_subscriber.rb +++ b/lib/flipper/instrumentation/log_subscriber.rb @@ -25,9 +25,7 @@ def feature_operation(event) description = "Flipper feature(#{feature_name}) #{operation} #{result.inspect}" details = "thing=#{thing.inspect}" - unless gate_name.nil? - details += " gate_name=#{gate_name}" - end + details += " gate_name=#{gate_name}" unless gate_name.nil? name = '%s (%.1fms)' % [description, event.duration] debug " #{color(name, CYAN, true)} [ #{details} ]" @@ -54,7 +52,7 @@ def adapter_operation(event) operation = event.payload[:operation] result = event.payload[:result] - description = "Flipper " + description = 'Flipper ' description << "feature(#{feature_name}) " unless feature_name.nil? description << "adapter(#{adapter_name}) " description << "#{operation} " diff --git a/lib/flipper/instrumentation/metriks.rb b/lib/flipper/instrumentation/metriks.rb index 1cc54c71d..4dc10976c 100644 --- a/lib/flipper/instrumentation/metriks.rb +++ b/lib/flipper/instrumentation/metriks.rb @@ -3,4 +3,4 @@ require 'flipper/instrumentation/metriks_subscriber' ActiveSupport::Notifications.subscribe /\.flipper$/, - Flipper::Instrumentation::MetriksSubscriber + Flipper::Instrumentation::MetriksSubscriber diff --git a/lib/flipper/instrumentation/statsd.rb b/lib/flipper/instrumentation/statsd.rb index 899933947..d88cc8137 100644 --- a/lib/flipper/instrumentation/statsd.rb +++ b/lib/flipper/instrumentation/statsd.rb @@ -3,4 +3,4 @@ require 'flipper/instrumentation/statsd_subscriber' ActiveSupport::Notifications.subscribe /\.flipper$/, - Flipper::Instrumentation::StatsdSubscriber + Flipper::Instrumentation::StatsdSubscriber diff --git a/lib/flipper/instrumentation/statsd_subscriber.rb b/lib/flipper/instrumentation/statsd_subscriber.rb index 5d7fdabf6..b7f73f3fb 100644 --- a/lib/flipper/instrumentation/statsd_subscriber.rb +++ b/lib/flipper/instrumentation/statsd_subscriber.rb @@ -18,9 +18,7 @@ def update_timer(metric) end def update_counter(metric) - if self.class.client - self.class.client.increment metric - end + self.class.client.increment metric if self.class.client end end end diff --git a/lib/flipper/instrumentation/subscriber.rb b/lib/flipper/instrumentation/subscriber.rb index 100905e04..3721a500c 100644 --- a/lib/flipper/instrumentation/subscriber.rb +++ b/lib/flipper/instrumentation/subscriber.rb @@ -17,12 +17,12 @@ def initialize(name, start, ending, transaction_id, payload) end # Internal: Override in subclass. - def update_timer(metric) + def update_timer(_metric) raise 'not implemented' end # Internal: Override in subclass. - def update_counter(metric) + def update_counter(_metric) raise 'not implemented' end @@ -34,7 +34,8 @@ def update if respond_to?(method_name) send(method_name) else - puts "Could not update #{operation_type} metrics as #{self.class} did not respond to `#{method_name}`" + puts "Could not update #{operation_type} metrics as #{self.class} " \ + "did not respond to `#{method_name}`" end end @@ -49,11 +50,12 @@ def update_feature_operation_metrics update_timer "flipper.feature_operation.#{operation}" if @payload[:operation] == :enabled? - metric_name = if result - "flipper.feature.#{feature_name}.enabled" - else - "flipper.feature.#{feature_name}.disabled" - end + metric_name = + if result + "flipper.feature.#{feature_name}.enabled" + else + "flipper.feature.#{feature_name}.disabled" + end update_counter metric_name end @@ -67,11 +69,10 @@ def update_adapter_operation_metrics value = @payload[:value] key = @payload[:key] - update_timer "flipper.adapter.#{adapter_name}.#{operation}" end - QUESTION_MARK = "?".freeze + QUESTION_MARK = '?'.freeze # Private def strip_trailing_question_mark(operation) diff --git a/lib/flipper/instrumenters/memory.rb b/lib/flipper/instrumenters/memory.rb index 926a1db67..a7e1d5522 100644 --- a/lib/flipper/instrumenters/memory.rb +++ b/lib/flipper/instrumenters/memory.rb @@ -17,11 +17,7 @@ def instrument(name, payload = {}) # block rather than the one passed to #instrument. payload = payload.dup - result = if block_given? - yield payload - else - nil - end + result = (yield payload if block_given?) @events << Event.new(name, payload, result) result end diff --git a/lib/flipper/instrumenters/noop.rb b/lib/flipper/instrumenters/noop.rb index 982c752ca..cd252431a 100644 --- a/lib/flipper/instrumenters/noop.rb +++ b/lib/flipper/instrumenters/noop.rb @@ -1,7 +1,7 @@ module Flipper module Instrumenters class Noop - def self.instrument(name, payload = {}) + def self.instrument(_name, payload = {}) yield payload if block_given? end end diff --git a/lib/flipper/middleware/memoizer.rb b/lib/flipper/middleware/memoizer.rb index d6e85754e..940e66857 100644 --- a/lib/flipper/middleware/memoizer.rb +++ b/lib/flipper/middleware/memoizer.rb @@ -48,14 +48,12 @@ def call(env) flipper.preload(names) end - if @opts[:preload] - flipper.preload(@opts[:preload]) - end + flipper.preload(@opts[:preload]) if @opts[:preload] response = @app.call(env) - response[2] = Rack::BodyProxy.new(response[2]) { + response[2] = Rack::BodyProxy.new(response[2]) do flipper.adapter.memoize = original - } + end response rescue flipper.adapter.memoize = original diff --git a/lib/flipper/registry.rb b/lib/flipper/registry.rb index e702c7852..630bd9013 100644 --- a/lib/flipper/registry.rb +++ b/lib/flipper/registry.rb @@ -34,29 +34,29 @@ def values def add(key, value) key = key.to_sym - @mutex.synchronize { + @mutex.synchronize do if @source[key] raise DuplicateKey, "#{key} is already registered" else @source[key] = value end - } + end end def get(key) key = key.to_sym - @mutex.synchronize { - @source.fetch(key) { - raise KeyNotFound.new(key) - } - } + @mutex.synchronize do + @source.fetch(key) do + raise KeyNotFound, key + end + end end def key?(key) key = key.to_sym - @mutex.synchronize { - @source.has_key?(key) - } + @mutex.synchronize do + @source.key?(key) + end end def each(&block) diff --git a/lib/flipper/spec/shared_adapter_specs.rb b/lib/flipper/spec/shared_adapter_specs.rb index 45d235505..7b9dd512a 100644 --- a/lib/flipper/spec/shared_adapter_specs.rb +++ b/lib/flipper/spec/shared_adapter_specs.rb @@ -1,5 +1,6 @@ # Requires the following methods: # * subject - The instance of the adapter +# rubocop:disable Metrics/BlockLength RSpec.shared_examples_for 'a flipper adapter' do let(:actor_class) { Struct.new(:flipper_id) } @@ -10,46 +11,46 @@ let(:group_gate) { feature.gate(:group) } let(:actor_gate) { feature.gate(:actor) } let(:actors_gate) { feature.gate(:percentage_of_actors) } - let(:time_gate) { feature.gate(:percentage_of_time) } + let(:time_gate) { feature.gate(:percentage_of_time) } - let(:default_config) { + let(:default_config) do { - :boolean => nil, - :groups => Set.new, - :actors => Set.new, - :percentage_of_actors => nil, - :percentage_of_time => nil, + boolean: nil, + groups: Set.new, + actors: Set.new, + percentage_of_actors: nil, + percentage_of_time: nil, } - } + end before do - Flipper.register(:admins) { |actor| + Flipper.register(:admins) do |actor| actor.respond_to?(:admin?) && actor.admin? - } + end - Flipper.register(:early_access) { |actor| + Flipper.register(:early_access) do |actor| actor.respond_to?(:early_access?) && actor.early_access? - } + end end after do Flipper.unregister_groups end - it "has name that is a symbol" do - expect(subject.name).to_not be_nil + it 'has name that is a symbol' do + expect(subject.name).not_to be_nil expect(subject.name).to be_instance_of(Symbol) end - it "has included the flipper adapter module" do + it 'has included the flipper adapter module' do expect(subject.class.ancestors).to include(Flipper::Adapter) end - it "returns correct default values for the gates if none are enabled" do + it 'returns correct default values for the gates if none are enabled' do expect(subject.get(feature)).to eq(default_config) end - it "can enable, disable and get value for boolean gate" do + it 'can enable, disable and get value for boolean gate' do expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true) result = subject.get(feature) @@ -61,26 +62,24 @@ expect(result[:boolean]).to eq(nil) end - it "fully disables all enabled things when boolean gate disabled" do - actor_22 = actor_class.new('22') + it 'fully disables all enabled things when boolean gate disabled' do + actor22 = actor_class.new('22') expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true) expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true) - expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true) + expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true) expect(subject.enable(feature, actors_gate, flipper.actors(25))).to eq(true) expect(subject.enable(feature, time_gate, flipper.time(45))).to eq(true) expect(subject.disable(feature, boolean_gate, flipper.boolean(false))).to eq(true) - expect(subject.get(feature)).to eq({ - :boolean => nil, - :groups => Set.new, - :actors => Set.new, - :percentage_of_actors => nil, - :percentage_of_time => nil, - }) + expect(subject.get(feature)).to eq(boolean: nil, + groups: Set.new, + actors: Set.new, + percentage_of_actors: nil, + percentage_of_time: nil) end - it "can enable, disable and get value for group gate" do + it 'can enable, disable and get value for group gate' do expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true) expect(subject.enable(feature, group_gate, flipper.group(:early_access))).to eq(true) @@ -96,17 +95,17 @@ expect(result[:groups]).to eq(Set.new) end - it "can enable, disable and get value for actor gate" do - actor_22 = actor_class.new('22') + it 'can enable, disable and get value for actor gate' do + actor22 = actor_class.new('22') actor_asdf = actor_class.new('asdf') - expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true) + expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true) expect(subject.enable(feature, actor_gate, flipper.actor(actor_asdf))).to eq(true) result = subject.get(feature) expect(result[:actors]).to eq(Set['22', 'asdf']) - expect(subject.disable(feature, actor_gate, flipper.actor(actor_22))).to eq(true) + expect(subject.disable(feature, actor_gate, flipper.actor(actor22))).to eq(true) result = subject.get(feature) expect(result[:actors]).to eq(Set['asdf']) @@ -115,7 +114,7 @@ expect(result[:actors]).to eq(Set.new) end - it "can enable, disable and get value for percentage of actors gate" do + it 'can enable, disable and get value for percentage of actors gate' do expect(subject.enable(feature, actors_gate, flipper.actors(15))).to eq(true) result = subject.get(feature) expect(result[:percentage_of_actors]).to eq('15') @@ -125,7 +124,7 @@ expect(result[:percentage_of_actors]).to eq('0') end - it "can enable percentage of actors gate many times and consistently return values" do + it 'can enable percentage of actors gate many times and consistently return values' do (1..100).each do |percentage| expect(subject.enable(feature, actors_gate, flipper.actors(percentage))).to eq(true) result = subject.get(feature) @@ -133,7 +132,7 @@ end end - it "can disable percentage of actors gate many times and consistently return values" do + it 'can disable percentage of actors gate many times and consistently return values' do (1..100).each do |percentage| expect(subject.disable(feature, actors_gate, flipper.actors(percentage))).to eq(true) result = subject.get(feature) @@ -141,7 +140,7 @@ end end - it "can enable, disable and get value for percentage of time gate" do + it 'can enable, disable and get value for percentage of time gate' do expect(subject.enable(feature, time_gate, flipper.time(10))).to eq(true) result = subject.get(feature) expect(result[:percentage_of_time]).to eq('10') @@ -151,7 +150,7 @@ expect(result[:percentage_of_time]).to eq('0') end - it "can enable percentage of time gate many times and consistently return values" do + it 'can enable percentage of time gate many times and consistently return values' do (1..100).each do |percentage| expect(subject.enable(feature, time_gate, flipper.time(percentage))).to eq(true) result = subject.get(feature) @@ -159,7 +158,7 @@ end end - it "can disable percentage of time gate many times and consistently return values" do + it 'can disable percentage of time gate many times and consistently return values' do (1..100).each do |percentage| expect(subject.disable(feature, time_gate, flipper.time(percentage))).to eq(true) result = subject.get(feature) @@ -167,37 +166,37 @@ end end - it "converts boolean value to a string" do + it 'converts boolean value to a string' do expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true) result = subject.get(feature) expect(result[:boolean]).to eq('true') end - it "converts the actor value to a string" do + it 'converts the actor value to a string' do expect(subject.enable(feature, actor_gate, flipper.actor(actor_class.new(22)))).to eq(true) result = subject.get(feature) expect(result[:actors]).to eq(Set['22']) end - it "converts group value to a string" do + it 'converts group value to a string' do expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true) result = subject.get(feature) expect(result[:groups]).to eq(Set['admins']) end - it "converts percentage of time integer value to a string" do + it 'converts percentage of time integer value to a string' do expect(subject.enable(feature, time_gate, flipper.time(10))).to eq(true) result = subject.get(feature) expect(result[:percentage_of_time]).to eq('10') end - it "converts percentage of actors integer value to a string" do + it 'converts percentage of actors integer value to a string' do expect(subject.enable(feature, actors_gate, flipper.actors(10))).to eq(true) result = subject.get(feature) expect(result[:percentage_of_actors]).to eq('10') end - it "can add, remove and list known features" do + it 'can add, remove and list known features' do expect(subject.features).to eq(Set.new) expect(subject.add(flipper[:stats])).to eq(true) @@ -213,33 +212,31 @@ expect(subject.features).to eq(Set.new) end - it "clears all the gate values for the feature on remove" do - actor_22 = actor_class.new('22') + it 'clears all the gate values for the feature on remove' do + actor22 = actor_class.new('22') expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true) expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true) - expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true) + expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true) expect(subject.enable(feature, actors_gate, flipper.actors(25))).to eq(true) expect(subject.enable(feature, time_gate, flipper.time(45))).to eq(true) expect(subject.remove(feature)).to eq(true) - expect(subject.get(feature)).to eq({ - :boolean => nil, - :groups => Set.new, - :actors => Set.new, - :percentage_of_actors => nil, - :percentage_of_time => nil, - }) + expect(subject.get(feature)).to eq(boolean: nil, + groups: Set.new, + actors: Set.new, + percentage_of_actors: nil, + percentage_of_time: nil) end - it "can clear all the gate values for a feature" do - actor_22 = actor_class.new('22') + it 'can clear all the gate values for a feature' do + actor22 = actor_class.new('22') subject.add(feature) expect(subject.features).to include(feature.key) expect(subject.enable(feature, boolean_gate, flipper.boolean)).to eq(true) expect(subject.enable(feature, group_gate, flipper.group(:admins))).to eq(true) - expect(subject.enable(feature, actor_gate, flipper.actor(actor_22))).to eq(true) + expect(subject.enable(feature, actor_gate, flipper.actor(actor22))).to eq(true) expect(subject.enable(feature, actors_gate, flipper.actors(25))).to eq(true) expect(subject.enable(feature, time_gate, flipper.time(45))).to eq(true) @@ -248,11 +245,11 @@ expect(subject.get(feature)).to eq(default_config) end - it "does not complain clearing a feature that does not exist in adapter" do + it 'does not complain clearing a feature that does not exist in adapter' do expect(subject.clear(flipper[:stats])).to eq(true) end - it "can get multiple features" do + it 'can get multiple features' do expect(subject.add(flipper[:stats])).to eq(true) expect(subject.enable(flipper[:stats], boolean_gate, flipper.boolean)).to eq(true) @@ -262,7 +259,7 @@ expect(result).to be_instance_of(Hash) stats, search, other = result.values - expect(stats).to eq(default_config.merge(boolean: "true")) + expect(stats).to eq(default_config.merge(boolean: 'true')) expect(search).to eq(default_config) expect(other).to eq(default_config) end diff --git a/lib/flipper/test/shared_adapter_test.rb b/lib/flipper/test/shared_adapter_test.rb index ca9eeb0c7..bce646b6d 100644 --- a/lib/flipper/test/shared_adapter_test.rb +++ b/lib/flipper/test/shared_adapter_test.rb @@ -1,3 +1,4 @@ +# rubocop:disable Metrics/ModuleLength module Flipper module Test module SharedAdapterTests @@ -9,24 +10,24 @@ def setup @boolean_gate = @feature.gate(:boolean) @group_gate = @feature.gate(:group) @actor_gate = @feature.gate(:actor) - @actors_gate = @feature.gate(:percentage_of_actors) - @time_gate = @feature.gate(:percentage_of_time) + @actors_gate = @feature.gate(:percentage_of_actors) + @time_gate = @feature.gate(:percentage_of_time) @default_config = { - :boolean => nil, - :groups => Set.new, - :actors => Set.new, - :percentage_of_actors => nil, - :percentage_of_time => nil, + boolean: nil, + groups: Set.new, + actors: Set.new, + percentage_of_actors: nil, + percentage_of_time: nil, } Flipper.register(:admins) do |actor| actor.respond_to?(:admin?) && actor.admin? end - Flipper.register(:early_access) { |actor| + Flipper.register(:early_access) do |actor| actor.respond_to?(:early_access?) && actor.early_access? - } + end end def teardown @@ -35,12 +36,12 @@ def teardown end def test_has_name_that_is_a_symbol - refute_empty @adapter.name + refute_empty @adapter.name assert_kind_of Symbol, @adapter.name end def test_has_included_the_flipper_adapter_module - assert_includes @adapter.class.ancestors, Flipper::Adapter + assert_includes @adapter.class.ancestors, Flipper::Adapter end def test_returns_correct_default_values_for_gates_if_none_are_enabled @@ -55,10 +56,10 @@ def test_can_enable_disable_and_get_value_for_boolean_gate end def test_fully_disables_all_enabled_things_when_boolean_gate_disabled - actor_22 = @actor_class.new('22') + actor22 = @actor_class.new('22') assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean) assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins)) - assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22)) + assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22)) assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25)) assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45)) assert_equal true, @adapter.disable(@feature, @boolean_gate, @flipper.boolean(false)) @@ -82,16 +83,16 @@ def test_can_enable_disable_get_value_for_group_gate end def test_can_enable_disable_and_get_value_for_an_actor_gate - actor_22 = @actor_class.new('22') + actor22 = @actor_class.new('22') actor_asdf = @actor_class.new('asdf') - assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22)) + assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22)) assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_asdf)) result = @adapter.get(@feature) assert_equal Set['22', 'asdf'], result[:actors] - assert true, @adapter.disable(@feature, @actor_gate, @flipper.actor(actor_22)) + assert true, @adapter.disable(@feature, @actor_gate, @flipper.actor(actor22)) result = @adapter.get(@feature) assert_equal Set['asdf'], result[:actors] @@ -159,7 +160,8 @@ def test_converts_boolean_value_to_a_string end def test_converts_the_actor_value_to_a_string - assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(@actor_class.new(22))) + assert_equal true, + @adapter.enable(@feature, @actor_gate, @flipper.actor(@actor_class.new(22))) result = @adapter.get(@feature) assert_equal Set['22'], result[:actors] end @@ -199,10 +201,10 @@ def test_can_add_remove_and_list_known_features end def test_clears_all_the_gate_values_for_the_feature_on_remove - actor_22 = @actor_class.new('22') + actor22 = @actor_class.new('22') assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean) assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins)) - assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22)) + assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22)) assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25)) assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45)) @@ -212,13 +214,13 @@ def test_clears_all_the_gate_values_for_the_feature_on_remove end def test_can_clear_all_the_gate_values_for_a_feature - actor_22 = @actor_class.new('22') + actor22 = @actor_class.new('22') @adapter.add(@feature) assert_includes @adapter.features, @feature.key assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean) assert_equal true, @adapter.enable(@feature, @group_gate, @flipper.group(:admins)) - assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor_22)) + assert_equal true, @adapter.enable(@feature, @actor_gate, @flipper.actor(actor22)) assert_equal true, @adapter.enable(@feature, @actors_gate, @flipper.actors(25)) assert_equal true, @adapter.enable(@feature, @time_gate, @flipper.time(45)) @@ -240,7 +242,7 @@ def test_can_get_multiple_features assert_instance_of Hash, result stats, search, other = result.values - assert_equal @default_config.merge(boolean: "true"), stats + assert_equal @default_config.merge(boolean: 'true'), stats assert_equal @default_config, search assert_equal @default_config, other end diff --git a/lib/flipper/typecast.rb b/lib/flipper/typecast.rb index eb37808de..450a1e506 100644 --- a/lib/flipper/typecast.rb +++ b/lib/flipper/typecast.rb @@ -3,8 +3,8 @@ module Typecast TruthMap = { true => true, 1 => true, - "true" => true, - "1" => true, + 'true' => true, + '1' => true, }.freeze # Internal: Convert value to a boolean. diff --git a/lib/flipper/types/actor.rb b/lib/flipper/types/actor.rb index f9ff468b6..e1f10e033 100644 --- a/lib/flipper/types/actor.rb +++ b/lib/flipper/types/actor.rb @@ -9,12 +9,10 @@ def self.wrappable?(thing) attr_reader :thing def initialize(thing) - if thing.nil? - raise ArgumentError.new("thing cannot be nil") - end + raise ArgumentError, 'thing cannot be nil' if thing.nil? unless thing.respond_to?(:flipper_id) - raise ArgumentError.new("#{thing.inspect} must respond to flipper_id, but does not") + raise ArgumentError, "#{thing.inspect} must respond to flipper_id, but does not" end @thing = thing diff --git a/lib/flipper/types/group.rb b/lib/flipper/types/group.rb index 955ad6d83..5b8536443 100644 --- a/lib/flipper/types/group.rb +++ b/lib/flipper/types/group.rb @@ -16,7 +16,7 @@ def initialize(name, &block) @block = block @single_argument = @block.arity == 1 else - @block = lambda { |thing, context| false } + @block = ->(_thing, _context) { false } @single_argument = false end end diff --git a/lib/flipper/types/percentage.rb b/lib/flipper/types/percentage.rb index d94d9539d..b7a6aad48 100644 --- a/lib/flipper/types/percentage.rb +++ b/lib/flipper/types/percentage.rb @@ -5,7 +5,8 @@ def initialize(value) value = Typecast.to_integer(value) if value < 0 || value > 100 - raise ArgumentError, "value must be a positive number less than or equal to 100, but was #{value}" + raise ArgumentError, + "value must be a positive number less than or equal to 100, but was #{value}" end @value = value diff --git a/lib/flipper/ui.rb b/lib/flipper/ui.rb index e0061fcfa..97c194f56 100644 --- a/lib/flipper/ui.rb +++ b/lib/flipper/ui.rb @@ -34,8 +34,8 @@ def self.root @root ||= Pathname(__FILE__).dirname.expand_path.join('ui') end - def self.app(flipper, options = {}) - app = lambda { |env| [200, {'Content-Type' => 'text/html'}, ['']] } + def self.app(flipper, _options = {}) + app = ->(_env) { [200, { 'Content-Type' => 'text/html' }, ['']] } builder = Rack::Builder.new yield builder if block_given? builder.use Rack::Protection diff --git a/lib/flipper/ui/action.rb b/lib/flipper/ui/action.rb index 9b760a386..d1d1f02d5 100644 --- a/lib/flipper/ui/action.rb +++ b/lib/flipper/ui/action.rb @@ -9,11 +9,11 @@ class Action extend Forwardable VALID_REQUEST_METHOD_NAMES = Set.new([ - "get".freeze, - "post".freeze, - "put".freeze, - "delete".freeze, - ]).freeze + 'get'.freeze, + 'post'.freeze, + 'put'.freeze, + 'delete'.freeze, + ]).freeze # Public: Call this in subclasses so the action knows its route. # @@ -60,14 +60,16 @@ def self.public_path def_delegator :@request, :params def initialize(flipper, request) - @flipper, @request = flipper, request + @flipper = flipper + @request = request @code = 200 - @headers = {"Content-Type" => "text/plain"} - @breadcrumbs = if Flipper::UI.application_breadcrumb_href - [Breadcrumb.new("App", Flipper::UI.application_breadcrumb_href)] - else - [] - end + @headers = { 'Content-Type' => 'text/plain' } + @breadcrumbs = + if Flipper::UI.application_breadcrumb_href + [Breadcrumb.new('App', Flipper::UI.application_breadcrumb_href)] + else + [] + end end # Public: Runs the request method for the provided request. @@ -77,7 +79,8 @@ def run if valid_request_method? && respond_to?(request_method_name) catch(:halt) { send(request_method_name) } else - raise UI::RequestMethodNotSupported, "#{self.class} does not support request method #{request_method_name.inspect}" + raise UI::RequestMethodNotSupported, + "#{self.class} does not support request method #{request_method_name.inspect}" end end @@ -110,7 +113,7 @@ def halt(response) # # Returns a response. def view_response(name) - header "Content-Type", "text/html" + header 'Content-Type', 'text/html' body = view_with_layout { view_without_layout name } halt [@code, @headers, [body]] end @@ -132,8 +135,8 @@ def json_response(object) # location - The String location to set the Location header to. def redirect_to(location) status 302 - header "Location", "#{script_name}#{location}" - halt [@code, @headers, [""]] + header 'Location', "#{script_name}#{location}" + halt [@code, @headers, ['']] end # Public: Set the status code for the response. @@ -188,13 +191,11 @@ def view_without_layout(name) def view(name) path = views_path.join("#{name}.erb") - unless path.exist? - raise "Template does not exist: #{path}" - end + raise "Template does not exist: #{path}" unless path.exist? contents = path.read compiled = Eruby.new(contents) - compiled.result Proc.new {}.binding + compiled.result proc {}.binding end # Internal: The path the app is mounted at. @@ -218,7 +219,7 @@ def request_method_name end def csrf_input_tag - %Q() + %() end def valid_request_method? diff --git a/lib/flipper/ui/action_collection.rb b/lib/flipper/ui/action_collection.rb index 937169993..f2dea61fc 100644 --- a/lib/flipper/ui/action_collection.rb +++ b/lib/flipper/ui/action_collection.rb @@ -11,9 +11,9 @@ def add(action_class) end def action_for_request(request) - @action_classes.detect { |action_class| + @action_classes.detect do |action_class| request.path_info =~ action_class.regex - } + end end end end diff --git a/lib/flipper/ui/actions/actors_gate.rb b/lib/flipper/ui/actions/actors_gate.rb index e1b728bed..74df23267 100644 --- a/lib/flipper/ui/actions/actors_gate.rb +++ b/lib/flipper/ui/actions/actors_gate.rb @@ -13,10 +13,10 @@ def get feature = flipper[feature_name.to_sym] @feature = Decorators::Feature.new(feature) - breadcrumb "Home", "/" - breadcrumb "Features", "/features" + breadcrumb 'Home', '/' + breadcrumb 'Features', '/features' breadcrumb @feature.key, "/features/#{@feature.key}" - breadcrumb "Add Actor" + breadcrumb 'Add Actor' view_response :add_actor end @@ -24,7 +24,7 @@ def get def post feature_name = Rack::Utils.unescape(request.path.split('/')[-2]) feature = flipper[feature_name.to_sym] - value = params["value"].to_s.strip + value = params['value'].to_s.strip if Util.blank?(value) error = Rack::Utils.escape("#{value.inspect} is not a valid actor value.") @@ -33,10 +33,10 @@ def post actor = Flipper::UI::Actor.new(value) - case params["operation"] - when "enable" + case params['operation'] + when 'enable' feature.enable_actor actor - when "disable" + when 'disable' feature.disable_actor actor end diff --git a/lib/flipper/ui/actions/add_feature.rb b/lib/flipper/ui/actions/add_feature.rb index 3d65a1c9e..dc6289cbf 100644 --- a/lib/flipper/ui/actions/add_feature.rb +++ b/lib/flipper/ui/actions/add_feature.rb @@ -11,16 +11,16 @@ def get unless Flipper::UI.feature_creation_enabled status 403 - breadcrumb "Home", "/" - breadcrumb "Features", "/features" - breadcrumb "Noooooope" + breadcrumb 'Home', '/' + breadcrumb 'Features', '/features' + breadcrumb 'Noooooope' halt view_response(:feature_creation_disabled) end - breadcrumb "Home", "/" - breadcrumb "Features", "/features" - breadcrumb "Add" + breadcrumb 'Home', '/' + breadcrumb 'Features', '/features' + breadcrumb 'Add' view_response :add_feature end diff --git a/lib/flipper/ui/actions/boolean_gate.rb b/lib/flipper/ui/actions/boolean_gate.rb index 5ac8975b5..db455aa5b 100644 --- a/lib/flipper/ui/actions/boolean_gate.rb +++ b/lib/flipper/ui/actions/boolean_gate.rb @@ -8,11 +8,11 @@ class BooleanGate < UI::Action route %r{features/[^/]*/boolean/?\Z} def post - feature_name = Rack::Utils.unescape(request.path.split("/")[-2]) + feature_name = Rack::Utils.unescape(request.path.split('/')[-2]) feature = flipper[feature_name.to_sym] @feature = Decorators::Feature.new(feature) - if params["action"] == "Enable" + if params['action'] == 'Enable' feature.enable else feature.disable diff --git a/lib/flipper/ui/actions/feature.rb b/lib/flipper/ui/actions/feature.rb index 9dbf340a7..e8189fe07 100644 --- a/lib/flipper/ui/actions/feature.rb +++ b/lib/flipper/ui/actions/feature.rb @@ -5,27 +5,26 @@ module Flipper module UI module Actions class Feature < UI::Action - route %r{features/[^/]*/?\Z} def get - feature_name = Rack::Utils.unescape(request.path.split("/").last) + feature_name = Rack::Utils.unescape(request.path.split('/').last) @feature = Decorators::Feature.new(flipper[feature_name]) @page_title = "#{@feature.key} // Features" @percentages = [0, 1, 5, 10, 15, 25, 50, 75, 100] - breadcrumb "Home", "/" - breadcrumb "Features", "/features" + breadcrumb 'Home', '/' + breadcrumb 'Features', '/features' breadcrumb @feature.key view_response :feature end def delete - feature_name = Rack::Utils.unescape(request.path.split("/").last) + feature_name = Rack::Utils.unescape(request.path.split('/').last) feature = flipper[feature_name] flipper.adapter.remove(feature) - redirect_to "/features" + redirect_to '/features' end end end diff --git a/lib/flipper/ui/actions/features.rb b/lib/flipper/ui/actions/features.rb index 3c59787a5..ad1a8c3fa 100644 --- a/lib/flipper/ui/actions/features.rb +++ b/lib/flipper/ui/actions/features.rb @@ -6,19 +6,18 @@ module Flipper module UI module Actions class Features < UI::Action - route %r{features/?\Z} def get - @page_title = "Features" - @features = flipper.features.map { |feature| + @page_title = 'Features' + @features = flipper.features.map do |feature| Decorators::Feature.new(feature) - }.sort + end.sort @show_blank_slate = @features.empty? - breadcrumb "Home", "/" - breadcrumb "Features" + breadcrumb 'Home', '/' + breadcrumb 'Features' view_response :features end @@ -27,14 +26,14 @@ def post unless Flipper::UI.feature_creation_enabled status 403 - breadcrumb "Home", "/" - breadcrumb "Features", "/features" - breadcrumb "Noooooope" + breadcrumb 'Home', '/' + breadcrumb 'Features', '/features' + breadcrumb 'Noooooope' halt view_response(:feature_creation_disabled) end - value = params["value"].to_s.strip + value = params['value'].to_s.strip if Util.blank?(value) error = Rack::Utils.escape("#{value.inspect} is not a valid feature name.") diff --git a/lib/flipper/ui/actions/file.rb b/lib/flipper/ui/actions/file.rb index a4fc6ac70..173b5b424 100644 --- a/lib/flipper/ui/actions/file.rb +++ b/lib/flipper/ui/actions/file.rb @@ -5,7 +5,6 @@ module Flipper module UI module Actions class File < UI::Action - route %r{(images|css|js|octicons|fonts)/.*\Z} def get diff --git a/lib/flipper/ui/actions/gate.rb b/lib/flipper/ui/actions/gate.rb index fa7c9465d..576ced0f5 100644 --- a/lib/flipper/ui/actions/gate.rb +++ b/lib/flipper/ui/actions/gate.rb @@ -8,7 +8,8 @@ class Gate < UI::Action route %r{features/[^/]*/[^/]*/?\Z} def post - feature_name, gate_name = request.path.split('/').pop(2).map{ |value| Rack::Utils.unescape value } + feature_name, gate_name = request.path.split('/').pop(2) + .map(&Rack::Utils.method(:unescape)) update_gate_method_name = "update_#{gate_name}" feature = flipper[feature_name.to_sym] @@ -27,7 +28,9 @@ def post # Private: Returns error response that gate update method is not defined. def update_gate_method_undefined(gate_name) - error = Rack::Utils.escape("#{gate_name.inspect} gate does not exist therefore it cannot be updated.") + error = Rack::Utils.escape( + "#{gate_name.inspect} gate does not exist therefore it cannot be updated." + ) redirect_to("/features/#{@feature.key}?error=#{error}") end end diff --git a/lib/flipper/ui/actions/groups_gate.rb b/lib/flipper/ui/actions/groups_gate.rb index c118e76ee..1a1aab443 100644 --- a/lib/flipper/ui/actions/groups_gate.rb +++ b/lib/flipper/ui/actions/groups_gate.rb @@ -12,10 +12,10 @@ def get feature = flipper[feature_name.to_sym] @feature = Decorators::Feature.new(feature) - breadcrumb "Home", "/" - breadcrumb "Features", "/features" + breadcrumb 'Home', '/' + breadcrumb 'Features', '/features' breadcrumb @feature.key, "/features/#{@feature.key}" - breadcrumb "Add Group" + breadcrumb 'Add Group' view_response :add_group end @@ -23,12 +23,12 @@ def get def post feature_name = Rack::Utils.unescape(request.path.split('/')[-2]) feature = flipper[feature_name.to_sym] - value = params["value"].to_s.strip + value = params['value'].to_s.strip - case params["operation"] - when "enable" + case params['operation'] + when 'enable' feature.enable_group value - when "disable" + when 'disable' feature.disable_group value end diff --git a/lib/flipper/ui/actions/home.rb b/lib/flipper/ui/actions/home.rb index 0ec716e7d..ea55a01e5 100644 --- a/lib/flipper/ui/actions/home.rb +++ b/lib/flipper/ui/actions/home.rb @@ -5,11 +5,10 @@ module Flipper module UI module Actions class Home < UI::Action - route %r{/?\Z} def get - redirect_to "/features" + redirect_to '/features' end end end diff --git a/lib/flipper/ui/actions/percentage_of_actors_gate.rb b/lib/flipper/ui/actions/percentage_of_actors_gate.rb index ff22f1900..5a5a38058 100644 --- a/lib/flipper/ui/actions/percentage_of_actors_gate.rb +++ b/lib/flipper/ui/actions/percentage_of_actors_gate.rb @@ -8,12 +8,12 @@ class PercentageOfActorsGate < UI::Action route %r{features/[^/]*/percentage_of_actors/?\Z} def post - feature_name = Rack::Utils.unescape(request.path.split("/")[-2]) + feature_name = Rack::Utils.unescape(request.path.split('/')[-2]) feature = flipper[feature_name.to_sym] @feature = Decorators::Feature.new(feature) begin - feature.enable_percentage_of_actors params["value"] + feature.enable_percentage_of_actors params['value'] rescue ArgumentError => exception error = Rack::Utils.escape("Invalid percentage of actors value: #{exception.message}") redirect_to("/features/#{@feature.key}?error=#{error}") diff --git a/lib/flipper/ui/actions/percentage_of_time_gate.rb b/lib/flipper/ui/actions/percentage_of_time_gate.rb index f9c1f7f31..2e0998457 100644 --- a/lib/flipper/ui/actions/percentage_of_time_gate.rb +++ b/lib/flipper/ui/actions/percentage_of_time_gate.rb @@ -8,12 +8,12 @@ class PercentageOfTimeGate < UI::Action route %r{features/[^/]*/percentage_of_time/?\Z} def post - feature_name = Rack::Utils.unescape(request.path.split("/")[-2]) + feature_name = Rack::Utils.unescape(request.path.split('/')[-2]) feature = flipper[feature_name.to_sym] @feature = Decorators::Feature.new(feature) begin - feature.enable_percentage_of_time params["value"] + feature.enable_percentage_of_time params['value'] rescue ArgumentError => exception error = Rack::Utils.escape("Invalid percentage of time value: #{exception.message}") redirect_to("/features/#{@feature.key}?error=#{error}") diff --git a/lib/flipper/ui/decorators/feature.rb b/lib/flipper/ui/decorators/feature.rb index c8bf5e7cf..fd17a4a67 100644 --- a/lib/flipper/ui/decorators/feature.rb +++ b/lib/flipper/ui/decorators/feature.rb @@ -23,20 +23,20 @@ def as_json 'id' => name.to_s, 'name' => pretty_name, 'state' => state.to_s, - 'gates' => gates.map { |gate| + 'gates' => gates.map do |gate| Decorators::Gate.new(gate, gate_values[gate.key]).as_json - }, + end, } end def color_class case feature.state when :on - "text-open" + 'text-open' when :off - "text-closed" + 'text-closed' when :conditional - "text-pending" + 'text-pending' end end @@ -45,10 +45,10 @@ def pretty_enabled_gate_names end StateSortMap = { - :on => 1, - :conditional => 2, - :off => 3, - } + on: 1, + conditional: 2, + off: 3, + }.freeze def <=>(other) if state == other.state diff --git a/lib/flipper/ui/decorators/gate.rb b/lib/flipper/ui/decorators/gate.rb index e14d87a8c..9f02aea0e 100644 --- a/lib/flipper/ui/decorators/gate.rb +++ b/lib/flipper/ui/decorators/gate.rb @@ -17,12 +17,13 @@ def initialize(gate, value = nil) # Public: Returns instance as hash that is ready to be json dumped. def as_json - value_as_json = case data_type - when :set - value.to_a # json doesn't like sets - else - value - end + value_as_json = + case data_type + when :set + value.to_a # json doesn't like sets + else + value + end { 'key' => gate.key.to_s, diff --git a/lib/flipper/ui/util.rb b/lib/flipper/ui/util.rb index 8e56284dd..1f940aceb 100644 --- a/lib/flipper/ui/util.rb +++ b/lib/flipper/ui/util.rb @@ -2,14 +2,14 @@ module Flipper module UI module Util # Private: 0x3000: fullwidth whitespace - NON_WHITESPACE_REGEXP = %r![^\s#{[0x3000].pack("U")}]! + NON_WHITESPACE_REGEXP = /[^\s#{[0x3000].pack("U")}]/ def self.blank?(str) str.to_s !~ NON_WHITESPACE_REGEXP end def self.titleize(str) - str.to_s.split("_").map { |word| word.capitalize }.join(" ") + str.to_s.split('_').map(&:capitalize).join(' ') end end end diff --git a/lib/flipper/version.rb b/lib/flipper/version.rb index 2eb8a0577..1df9cb580 100644 --- a/lib/flipper/version.rb +++ b/lib/flipper/version.rb @@ -1,3 +1,3 @@ module Flipper - VERSION = "0.10.2".freeze + VERSION = '0.10.2'.freeze end diff --git a/lib/generators/flipper/active_record_generator.rb b/lib/generators/flipper/active_record_generator.rb index 62bf1abd1..46e0503c7 100644 --- a/lib/generators/flipper/active_record_generator.rb +++ b/lib/generators/flipper/active_record_generator.rb @@ -1,15 +1,15 @@ -require "rails/generators/active_record" +require 'rails/generators/active_record' module Flipper module Generators class ActiveRecordGenerator < ::Rails::Generators::Base include ::Rails::Generators::Migration - desc "Generates migration for flipper tables" + desc 'Generates migration for flipper tables' - source_paths << File.join(File.dirname(__FILE__), "templates") + source_paths << File.join(File.dirname(__FILE__), 'templates') def create_migration_file - migration_template "migration.rb", "db/migrate/create_flipper_tables.rb" + migration_template 'migration.rb', 'db/migrate/create_flipper_tables.rb' end def self.next_migration_number(dirname) diff --git a/lib/generators/flipper/templates/sequel_migration.rb b/lib/generators/flipper/templates/sequel_migration.rb index 633804af5..028c035ad 100644 --- a/lib/generators/flipper/templates/sequel_migration.rb +++ b/lib/generators/flipper/templates/sequel_migration.rb @@ -1,13 +1,13 @@ class CreateFlipperTablesSequel < Sequel::Migration def up - create_table :flipper_features do |t| + create_table :flipper_features do |_t| String :key, null: false DateTime :created_at, null: false DateTime :updated_at, null: false end add_index :flipper_features, :key, unique: true - create_table :flipper_gates do |t| + create_table :flipper_gates do |_t| String :feature_key, null: false String :key, null: false String :value diff --git a/spec/flipper/adapters/active_record_spec.rb b/spec/flipper/adapters/active_record_spec.rb index c762c653d..bd780089d 100644 --- a/spec/flipper/adapters/active_record_spec.rb +++ b/spec/flipper/adapters/active_record_spec.rb @@ -11,10 +11,8 @@ subject { described_class.new } before(:all) do - ActiveRecord::Base.establish_connection({ - adapter: "sqlite3", - database: ":memory:", - }) + ActiveRecord::Base.establish_connection(adapter: 'sqlite3', + database: ':memory:') end before(:each) do diff --git a/spec/flipper/adapters/dalli_spec.rb b/spec/flipper/adapters/dalli_spec.rb index ceeb09dd3..d548700a3 100644 --- a/spec/flipper/adapters/dalli_spec.rb +++ b/spec/flipper/adapters/dalli_spec.rb @@ -5,8 +5,8 @@ RSpec.describe Flipper::Adapters::Dalli do let(:memory_adapter) { Flipper::Adapters::Memory.new } - let(:cache) { Dalli::Client.new(ENV["BOXEN_MEMCACHED_URL"] || '127.0.0.1:11211') } - let(:adapter) { Flipper::Adapters::Dalli.new(memory_adapter, cache) } + let(:cache) { Dalli::Client.new(ENV['BOXEN_MEMCACHED_URL'] || '127.0.0.1:11211') } + let(:adapter) { described_class.new(memory_adapter, cache) } let(:flipper) { Flipper.new(adapter) } subject { described_class.new(adapter, cache) } @@ -17,8 +17,8 @@ it_should_behave_like 'a flipper adapter' - describe "#remove" do - it "expires feature" do + describe '#remove' do + it 'expires feature' do feature = flipper[:stats] adapter.get(feature) adapter.remove(feature) @@ -26,8 +26,8 @@ end end - describe "#get_multi" do - it "warms uncached features" do + describe '#get_multi' do + it 'warms uncached features' do stats = flipper[:stats] search = flipper[:search] other = flipper[:other] @@ -40,13 +40,13 @@ adapter.get_multi([stats, search, other]) - expect(cache.get(described_class.key_for(search))[:boolean]).to eq("true") + expect(cache.get(described_class.key_for(search))[:boolean]).to eq('true') expect(cache.get(described_class.key_for(other))[:boolean]).to be(nil) end end - describe "#name" do - it "is dalli" do + describe '#name' do + it 'is dalli' do expect(subject.name).to be(:dalli) end end diff --git a/spec/flipper/adapters/instrumented_spec.rb b/spec/flipper/adapters/instrumented_spec.rb index fa7ee150d..f2d02a2b0 100644 --- a/spec/flipper/adapters/instrumented_spec.rb +++ b/spec/flipper/adapters/instrumented_spec.rb @@ -13,13 +13,13 @@ let(:gate) { feature.gate(:percentage_of_actors) } let(:thing) { flipper.actors(22) } - subject { - described_class.new(adapter, :instrumenter => instrumenter) - } + subject do + described_class.new(adapter, instrumenter: instrumenter) + end it_should_behave_like 'a flipper adapter' - it "forwards missing methods to underlying adapter" do + it 'forwards missing methods to underlying adapter' do adapter = Class.new do def foo :foo @@ -29,14 +29,14 @@ def foo expect(instrumented.foo).to eq(:foo) end - describe "#name" do - it "is instrumented" do + describe '#name' do + it 'is instrumented' do expect(subject.name).to be(:instrumented) end end - describe "#get" do - it "records instrumentation" do + describe '#get' do + it 'records instrumentation' do result = subject.get(feature) event = instrumenter.events.last @@ -49,8 +49,8 @@ def foo end end - describe "#enable" do - it "records instrumentation" do + describe '#enable' do + it 'records instrumentation' do result = subject.enable(feature, gate, thing) event = instrumenter.events.last @@ -64,8 +64,8 @@ def foo end end - describe "#disable" do - it "records instrumentation" do + describe '#disable' do + it 'records instrumentation' do result = subject.disable(feature, gate, thing) event = instrumenter.events.last @@ -79,8 +79,8 @@ def foo end end - describe "#add" do - it "records instrumentation" do + describe '#add' do + it 'records instrumentation' do result = subject.add(feature) event = instrumenter.events.last @@ -93,8 +93,8 @@ def foo end end - describe "#remove" do - it "records instrumentation" do + describe '#remove' do + it 'records instrumentation' do result = subject.remove(feature) event = instrumenter.events.last @@ -107,8 +107,8 @@ def foo end end - describe "#clear" do - it "records instrumentation" do + describe '#clear' do + it 'records instrumentation' do result = subject.clear(feature) event = instrumenter.events.last @@ -121,8 +121,8 @@ def foo end end - describe "#features" do - it "records instrumentation" do + describe '#features' do + it 'records instrumentation' do result = subject.features event = instrumenter.events.last diff --git a/spec/flipper/adapters/memoizable_spec.rb b/spec/flipper/adapters/memoizable_spec.rb index a208bb23e..fffa0da71 100644 --- a/spec/flipper/adapters/memoizable_spec.rb +++ b/spec/flipper/adapters/memoizable_spec.rb @@ -13,7 +13,7 @@ it_should_behave_like 'a flipper adapter' - it "forwards missing methods to underlying adapter" do + it 'forwards missing methods to underlying adapter' do adapter = Class.new do def foo :foo @@ -23,14 +23,14 @@ def foo expect(memoizable.foo).to eq(:foo) end - describe "#name" do - it "is instrumented" do + describe '#name' do + it 'is instrumented' do expect(subject.name).to be(:memoizable) end end - describe "#memoize=" do - it "sets value" do + describe '#memoize=' do + it 'sets value' do subject.memoize = true expect(subject.memoizing?).to eq(true) @@ -38,44 +38,44 @@ def foo expect(subject.memoizing?).to eq(false) end - it "clears the local cache" do + it 'clears the local cache' do subject.cache['some'] = 'thing' subject.memoize = true expect(subject.cache).to be_empty end end - describe "#memoizing?" do - it "returns true if enabled" do + describe '#memoizing?' do + it 'returns true if enabled' do subject.memoize = true expect(subject.memoizing?).to eq(true) end - it "returns false if disabled" do + it 'returns false if disabled' do subject.memoize = false expect(subject.memoizing?).to eq(false) end end - describe "#get" do - context "with memoization enabled" do + describe '#get' do + context 'with memoization enabled' do before do subject.memoize = true end - it "memoizes feature" do + it 'memoizes feature' do feature = flipper[:stats] result = subject.get(feature) expect(cache[feature.key]).to be(result) end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do feature = flipper[:stats] result = subject.get(feature) adapter_result = adapter.get(feature) @@ -84,30 +84,30 @@ def foo end end - describe "#get_multi" do - context "with memoization enabled" do + describe '#get_multi' do + context 'with memoization enabled' do before do subject.memoize = true end - it "memoizes feature" do - names = %i{stats shiny} + it 'memoizes feature' do + names = %i(stats shiny) features = names.map { |name| flipper[name] } results = subject.get_multi(features) features.each do |feature| - expect(cache[feature.key]).to_not be(nil) + expect(cache[feature.key]).not_to be(nil) expect(cache[feature.key]).to be(results[feature.key]) end end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do - names = %i{stats shiny} + it 'returns result' do + names = %i(stats shiny) features = names.map { |name| flipper[name] } result = subject.get_multi(features) adapter_result = adapter.get_multi(features) @@ -116,27 +116,27 @@ def foo end end - describe "#enable" do - context "with memoization enabled" do + describe '#enable' do + context 'with memoization enabled' do before do subject.memoize = true end - it "unmemoizes feature" do + it 'unmemoizes feature' do feature = flipper[:stats] gate = feature.gate(:boolean) - cache[feature.key] = {:some => 'thing'} + cache[feature.key] = { some: 'thing' } subject.enable(feature, gate, flipper.bool) expect(cache[feature.key]).to be_nil end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do feature = flipper[:stats] gate = feature.gate(:boolean) result = subject.enable(feature, gate, flipper.bool) @@ -146,27 +146,27 @@ def foo end end - describe "#disable" do - context "with memoization enabled" do + describe '#disable' do + context 'with memoization enabled' do before do subject.memoize = true end - it "unmemoizes feature" do + it 'unmemoizes feature' do feature = flipper[:stats] gate = feature.gate(:boolean) - cache[feature.key] = {:some => 'thing'} + cache[feature.key] = { some: 'thing' } subject.disable(feature, gate, flipper.bool) expect(cache[feature.key]).to be_nil end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do feature = flipper[:stats] gate = feature.gate(:boolean) result = subject.disable(feature, gate, flipper.bool) @@ -176,13 +176,13 @@ def foo end end - describe "#features" do - context "with memoization enabled" do + describe '#features' do + context 'with memoization enabled' do before do subject.memoize = true end - it "memoizes features" do + it 'memoizes features' do flipper[:stats].enable flipper[:search].disable result = subject.features @@ -190,92 +190,92 @@ def foo end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do expect(subject.features).to eq(adapter.features) end end end - describe "#add" do - context "with memoization enabled" do + describe '#add' do + context 'with memoization enabled' do before do subject.memoize = true end - it "unmemoizes the known features" do - cache[features_key] = {:some => 'thing'} + it 'unmemoizes the known features' do + cache[features_key] = { some: 'thing' } subject.add(flipper[:stats]) expect(cache).to be_empty end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do expect(subject.add(flipper[:stats])).to eq(adapter.add(flipper[:stats])) end end end - describe "#remove" do - context "with memoization enabled" do + describe '#remove' do + context 'with memoization enabled' do before do subject.memoize = true end - it "unmemoizes the known features" do - cache[features_key] = {:some => 'thing'} + it 'unmemoizes the known features' do + cache[features_key] = { some: 'thing' } subject.remove(flipper[:stats]) expect(cache).to be_empty end - it "unmemoizes the feature" do + it 'unmemoizes the feature' do feature = flipper[:stats] - cache[feature.key] = {:some => 'thing'} + cache[feature.key] = { some: 'thing' } subject.remove(feature) expect(cache[feature.key]).to be_nil end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do expect(subject.remove(flipper[:stats])).to eq(adapter.remove(flipper[:stats])) end end end - describe "#clear" do - context "with memoization enabled" do + describe '#clear' do + context 'with memoization enabled' do before do subject.memoize = true end - it "unmemoizes feature" do + it 'unmemoizes feature' do feature = flipper[:stats] - cache[feature.key] = {:some => 'thing'} + cache[feature.key] = { some: 'thing' } subject.clear(feature) expect(cache[feature.key]).to be_nil end end - context "with memoization disabled" do + context 'with memoization disabled' do before do subject.memoize = false end - it "returns result" do + it 'returns result' do feature = flipper[:stats] expect(subject.clear(feature)).to eq(adapter.clear(feature)) end diff --git a/spec/flipper/adapters/mongo_spec.rb b/spec/flipper/adapters/mongo_spec.rb index fb5f4be82..2dc834dbc 100644 --- a/spec/flipper/adapters/mongo_spec.rb +++ b/spec/flipper/adapters/mongo_spec.rb @@ -5,14 +5,15 @@ Mongo::Logger.logger.level = Logger::INFO RSpec.describe Flipper::Adapters::Mongo do - let(:host) { ENV["BOXEN_MONGODB_HOST"] || '127.0.0.1' } - let(:port) { ENV["BOXEN_MONGODB_PORT"] || 27017 } + subject { described_class.new(collection) } - let(:collection) { - Mongo::Client.new(["#{host}:#{port}"], :server_selection_timeout => 1, :database => 'testing')['testing'] - } + let(:host) { ENV['BOXEN_MONGODB_HOST'] || '127.0.0.1' } + let(:port) { ENV['BOXEN_MONGODB_PORT'] || 27017 } - subject { described_class.new(collection) } + let(:client) do + Mongo::Client.new(["#{host}:#{port}"], server_selection_timeout: 1, database: 'testing') + end + let(:collection) { client['testing'] } before do begin diff --git a/spec/flipper/adapters/operation_logger_spec.rb b/spec/flipper/adapters/operation_logger_spec.rb index 092bd0351..16d8c81a2 100644 --- a/spec/flipper/adapters/operation_logger_spec.rb +++ b/spec/flipper/adapters/operation_logger_spec.rb @@ -12,7 +12,7 @@ it_should_behave_like 'a flipper adapter' - it "forwards missing methods to underlying adapter" do + it 'forwards missing methods to underlying adapter' do adapter = Class.new do def foo :foo @@ -22,22 +22,22 @@ def foo expect(operation_logger.foo).to eq(:foo) end - describe "#get" do + describe '#get' do before do @feature = flipper[:stats] @result = subject.get(@feature) end - it "logs operation" do + it 'logs operation' do expect(subject.count(:get)).to be(1) end - it "returns result" do + it 'returns result' do expect(@result).to eq(adapter.get(@feature)) end end - describe "#enable" do + describe '#enable' do before do @feature = flipper[:stats] @gate = @feature.gate(:boolean) @@ -45,16 +45,16 @@ def foo @result = subject.enable(@feature, @gate, @thing) end - it "logs operation" do + it 'logs operation' do expect(subject.count(:enable)).to be(1) end - it "returns result" do + it 'returns result' do expect(@result).to eq(adapter.enable(@feature, @gate, @thing)) end end - describe "#disable" do + describe '#disable' do before do @feature = flipper[:stats] @gate = @feature.gate(:boolean) @@ -62,41 +62,41 @@ def foo @result = subject.disable(@feature, @gate, @thing) end - it "logs operation" do + it 'logs operation' do expect(subject.count(:disable)).to be(1) end - it "returns result" do + it 'returns result' do expect(@result).to eq(adapter.disable(@feature, @gate, @thing)) end end - describe "#features" do + describe '#features' do before do flipper[:stats].enable @result = subject.features end - it "logs operation" do + it 'logs operation' do expect(subject.count(:features)).to be(1) end - it "returns result" do + it 'returns result' do expect(@result).to eq(adapter.features) end end - describe "#add" do + describe '#add' do before do @feature = flipper[:stats] @result = subject.add(@feature) end - it "logs operation" do + it 'logs operation' do expect(subject.count(:add)).to be(1) end - it "returns result" do + it 'returns result' do expect(@result).to eq(adapter.add(@feature)) end end diff --git a/spec/flipper/adapters/pstore_spec.rb b/spec/flipper/adapters/pstore_spec.rb index 95332a24b..2ccf9993e 100644 --- a/spec/flipper/adapters/pstore_spec.rb +++ b/spec/flipper/adapters/pstore_spec.rb @@ -3,16 +3,16 @@ require 'flipper/spec/shared_adapter_specs' RSpec.describe Flipper::Adapters::PStore do - subject { - dir = FlipperRoot.join("tmp").tap { |d| d.mkpath } - pstore_file = dir.join("flipper.pstore") + subject do + dir = FlipperRoot.join('tmp').tap(&:mkpath) + pstore_file = dir.join('flipper.pstore') pstore_file.unlink if pstore_file.exist? described_class.new(pstore_file) - } + end it_should_behave_like 'a flipper adapter' - it "defaults path to flipper.pstore" do - expect(described_class.new.path).to eq("flipper.pstore") + it 'defaults path to flipper.pstore' do + expect(described_class.new.path).to eq('flipper.pstore') end end diff --git a/spec/flipper/adapters/read_only_spec.rb b/spec/flipper/adapters/read_only_spec.rb index 41128e501..e9ca750db 100644 --- a/spec/flipper/adapters/read_only_spec.rb +++ b/spec/flipper/adapters/read_only_spec.rb @@ -17,78 +17,76 @@ subject { described_class.new(adapter) } before do - Flipper.register(:admins) { |actor| + Flipper.register(:admins) do |actor| actor.respond_to?(:admin?) && actor.admin? - } + end - Flipper.register(:early_access) { |actor| + Flipper.register(:early_access) do |actor| actor.respond_to?(:early_access?) && actor.early_access? - } + end end after do Flipper.unregister_groups end - it "has name that is a symbol" do - expect(subject.name).to_not be_nil + it 'has name that is a symbol' do + expect(subject.name).not_to be_nil expect(subject.name).to be_instance_of(Symbol) end - it "has included the flipper adapter module" do + it 'has included the flipper adapter module' do expect(subject.class.ancestors).to include(Flipper::Adapter) end - it "returns correct default values for the gates if none are enabled" do - expect(subject.get(feature)).to eq({ - :boolean => nil, - :groups => Set.new, - :actors => Set.new, - :percentage_of_actors => nil, - :percentage_of_time => nil, - }) + it 'returns correct default values for the gates if none are enabled' do + expect(subject.get(feature)).to eq(boolean: nil, + groups: Set.new, + actors: Set.new, + percentage_of_actors: nil, + percentage_of_time: nil) end - it "can get feature" do - actor_22 = actor_class.new('22') + it 'can get feature' do + actor22 = actor_class.new('22') adapter.enable(feature, boolean_gate, flipper.boolean) adapter.enable(feature, group_gate, flipper.group(:admins)) - adapter.enable(feature, actor_gate, flipper.actor(actor_22)) + adapter.enable(feature, actor_gate, flipper.actor(actor22)) adapter.enable(feature, actors_gate, flipper.actors(25)) adapter.enable(feature, time_gate, flipper.time(45)) - expect(subject.get(feature)).to eq({ - :boolean => "true", - :groups => Set["admins"], - :actors => Set["22"], - :percentage_of_actors => "25", - :percentage_of_time => "45", - }) + expect(subject.get(feature)).to eq(boolean: 'true', + groups: Set['admins'], + actors: Set['22'], + percentage_of_actors: '25', + percentage_of_time: '45') end - it "can get features" do + it 'can get features' do expect(subject.features).to eq(Set.new) adapter.add(feature) - expect(subject.features).to eq(Set["stats"]) + expect(subject.features).to eq(Set['stats']) end - it "raises error on add" do + it 'raises error on add' do expect { subject.add(feature) }.to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) end - it "raises error on remove" do + it 'raises error on remove' do expect { subject.remove(feature) }.to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) end - it "raises on clear" do + it 'raises on clear' do expect { subject.clear(feature) }.to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) end - it "raises error on enable" do - expect { subject.enable(feature, boolean_gate, flipper.boolean) }.to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) + it 'raises error on enable' do + expect { subject.enable(feature, boolean_gate, flipper.boolean) } + .to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) end - it "raises error on disable" do - expect { subject.disable(feature, boolean_gate, flipper.boolean) }.to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) + it 'raises error on disable' do + expect { subject.disable(feature, boolean_gate, flipper.boolean) } + .to raise_error(Flipper::Adapters::ReadOnly::WriteAttempted) end end diff --git a/spec/flipper/adapters/redis_spec.rb b/spec/flipper/adapters/redis_spec.rb index fd11f4fe4..ed663580e 100644 --- a/spec/flipper/adapters/redis_spec.rb +++ b/spec/flipper/adapters/redis_spec.rb @@ -3,15 +3,13 @@ require 'flipper/spec/shared_adapter_specs' RSpec.describe Flipper::Adapters::Redis do - let(:client) { + let(:client) do options = {} - if ENV['BOXEN_REDIS_URL'] - options[:url] = ENV['BOXEN_REDIS_URL'] - end + options[:url] = ENV['BOXEN_REDIS_URL'] if ENV['BOXEN_REDIS_URL'] Redis.new(options) - } + end subject { described_class.new(client) } diff --git a/spec/flipper/adapters/sequel_spec.rb b/spec/flipper/adapters/sequel_spec.rb index 4c5592f93..7463450eb 100644 --- a/spec/flipper/adapters/sequel_spec.rb +++ b/spec/flipper/adapters/sequel_spec.rb @@ -1,7 +1,7 @@ require 'helper' require 'sequel' -Sequel::Model.db = Sequel.sqlite(':memory:') +Sequel::Model.db = Sequel.sqlite(':memory:') Sequel.extension :migration, :core_extensions require 'flipper/adapters/sequel' diff --git a/spec/flipper/api/action_spec.rb b/spec/flipper/api/action_spec.rb index 088d64cbc..4ee974f04 100644 --- a/spec/flipper/api/action_spec.rb +++ b/spec/flipper/api/action_spec.rb @@ -1,68 +1,66 @@ require 'helper' RSpec.describe Flipper::Api::Action do - let(:action_subclass) { + let(:action_subclass) do Class.new(described_class) do def noooope - raise "should never run this" + raise 'should never run this' end def get - [200, {}, "get"] + [200, {}, 'get'] end def post - [200, {}, "post"] + [200, {}, 'post'] end def put - [200, {}, "put"] + [200, {}, 'put'] end def delete - [200, {}, "delete"] + [200, {}, 'delete'] end end - } + end describe 'https verbs' do - it "won't run method that isn't whitelisted" do - fake_request = Struct.new(:request_method, :env, :session).new("NOOOOPE", {}, {}) + fake_request = Struct.new(:request_method, :env, :session).new('NOOOOPE', {}, {}) action = action_subclass.new(flipper, fake_request) - expect { + expect do action.run - }.to raise_error(Flipper::Api::RequestMethodNotSupported) + end.to raise_error(Flipper::Api::RequestMethodNotSupported) end - it "will run get" do - fake_request = Struct.new(:request_method, :env, :session).new("GET", {}, {}) + it 'will run get' do + fake_request = Struct.new(:request_method, :env, :session).new('GET', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "get"]) + expect(action.run).to eq([200, {}, 'get']) end - it "will run post" do - fake_request = Struct.new(:request_method, :env, :session).new("POST", {}, {}) + it 'will run post' do + fake_request = Struct.new(:request_method, :env, :session).new('POST', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "post"]) + expect(action.run).to eq([200, {}, 'post']) end - it "will run put" do - fake_request = Struct.new(:request_method, :env, :session).new("PUT", {}, {}) + it 'will run put' do + fake_request = Struct.new(:request_method, :env, :session).new('PUT', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "put"]) + expect(action.run).to eq([200, {}, 'put']) end - it "will run delete" do - fake_request = Struct.new(:request_method, :env, :session).new("DELETE", {}, {}) + it 'will run delete' do + fake_request = Struct.new(:request_method, :env, :session).new('DELETE', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "delete"]) + expect(action.run).to eq([200, {}, 'delete']) end end describe '#json_error_response' do - describe ":feature_not_found" do - + describe ':feature_not_found' do it 'locates and serializes error correctly' do action = action_subclass.new({}, {}) response = catch(:halt) do @@ -71,15 +69,12 @@ def delete status, headers, body = response parsed_body = JSON.parse(body[0]) - expect(headers["Content-Type"]).to eq("application/json") - expect(parsed_body["code"]).to eq(1) - expect(parsed_body["message"]).to eq("Feature not found.") - expect(parsed_body["more_info"]).to eq("https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference") + expect(headers['Content-Type']).to eq('application/json') + expect(parsed_body).to eql(api_not_found_response) end end describe ':group_not_registered' do - it 'locates and serializes error correctly' do action = action_subclass.new({}, {}) response = catch(:halt) do @@ -88,19 +83,18 @@ def delete status, headers, body = response parsed_body = JSON.parse(body[0]) - expect(headers["Content-Type"]).to eq("application/json") - expect(parsed_body["code"]).to eq(2) - expect(parsed_body["message"]).to eq("Group not registered.") - expect(parsed_body["more_info"]).to eq("https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference") + expect(headers['Content-Type']).to eq('application/json') + expect(parsed_body['code']).to eq(2) + expect(parsed_body['message']).to eq('Group not registered.') + expect(parsed_body['more_info']).to eq(api_error_code_reference_url) end end describe 'invalid error key' do - it 'raises descriptive error' do action = action_subclass.new({}, {}) catch(:halt) do - expect{ action.json_error_response(:invalid_error_key) }.to raise_error(KeyError) + expect { action.json_error_response(:invalid_error_key) }.to raise_error(KeyError) end end end diff --git a/spec/flipper/api/v1/actions/actors_gate_spec.rb b/spec/flipper/api/v1/actions/actors_gate_spec.rb index 84bdee825..39366c801 100644 --- a/spec/flipper/api/v1/actions/actors_gate_spec.rb +++ b/spec/flipper/api/v1/actions/actors_gate_spec.rb @@ -4,11 +4,11 @@ let(:app) { build_api(flipper) } describe 'enable' do - let(:actor) { Flipper::Api::Actor.new("1") } + let(:actor) { Flipper::Api::Actor.new('1') } before do flipper[:my_feature].disable_actor(actor) - post '/api/v1/features/my_feature/actors', { flipper_id: actor.flipper_id } + post '/api/v1/features/my_feature/actors', flipper_id: actor.flipper_id end it 'enables feature for actor' do @@ -19,16 +19,16 @@ it 'returns decorated feature with actor enabled' do gate = json_response['gates'].find { |gate| gate['key'] == 'actors' } - expect(gate['value']).to eq(["1"]) + expect(gate['value']).to eq(['1']) end end describe 'disable' do - let(:actor) { Flipper::Api::Actor.new("1") } + let(:actor) { Flipper::Api::Actor.new('1') } before do flipper[:my_feature].enable_actor(actor) - delete '/api/v1/features/my_feature/actors', { flipper_id: actor.flipper_id } + delete '/api/v1/features/my_feature/actors', flipper_id: actor.flipper_id end it 'disables feature' do @@ -51,7 +51,7 @@ it 'returns correct error response' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_flipper_id_is_missing_response) end end @@ -63,31 +63,31 @@ it 'returns correct error response' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_flipper_id_is_missing_response) end end describe 'enable nil flipper_id parameter' do before do flipper[:my_feature].enable - post '/api/v1/features/my_feature/actors', { flipper_id: nil } + post '/api/v1/features/my_feature/actors', flipper_id: nil end it 'returns correct error response' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_flipper_id_is_missing_response) end end describe 'disable nil flipper_id parameter' do before do flipper[:my_feature].enable - delete '/api/v1/features/my_feature/actors', { flipper_id: nil } + delete '/api/v1/features/my_feature/actors', flipper_id: nil end it 'returns correct error response' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_flipper_id_is_missing_response) end end @@ -98,7 +98,7 @@ it 'returns correct error response' do expect(last_response.status).to eq(404) - expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_not_found_response) end end @@ -109,7 +109,7 @@ it 'returns correct error response' do expect(last_response.status).to eq(404) - expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_not_found_response) end end end diff --git a/spec/flipper/api/v1/actions/feature_spec.rb b/spec/flipper/api/v1/actions/feature_spec.rb index b404419fc..629d60751 100644 --- a/spec/flipper/api/v1/actions/feature_spec.rb +++ b/spec/flipper/api/v1/actions/feature_spec.rb @@ -7,7 +7,6 @@ describe 'get' do context 'enabled feature' do - before do flipper[:my_feature].enable get 'api/v1/features/my_feature' @@ -42,8 +41,8 @@ 'key' => 'percentage_of_time', 'name' => 'percentage_of_time', 'value' => 0, - } - ] + }, + ], } expect(last_response.status).to eq(200) @@ -68,9 +67,9 @@ 'value' => false, }, { - 'key'=> 'groups', - 'name'=> 'group', - 'value'=> [], + 'key' => 'groups', + 'name' => 'group', + 'value' => [], }, { 'key' => 'actors', @@ -80,14 +79,14 @@ { 'key' => 'percentage_of_actors', 'name' => 'percentage_of_actors', - 'value'=> 0, + 'value' => 0, }, { 'key' => 'percentage_of_time', 'name' => 'percentage_of_time', 'value' => 0, - } - ] + }, + ], } expect(last_response.status).to eq(200) @@ -105,7 +104,7 @@ end it 'returns formatted error response body' do - expect(json_response).to eq({ "code" => 1, "message" => "Feature not found.", "more_info" => "https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference" }) + expect(json_response).to eq(api_not_found_response) end end end @@ -131,7 +130,7 @@ end it 'returns formatted error response body' do - expect(json_response).to eq({ "code" => 1, "message" => "Feature not found.", "more_info" => "https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference" }) + expect(json_response).to eq(api_not_found_response) end end end diff --git a/spec/flipper/api/v1/actions/features_spec.rb b/spec/flipper/api/v1/actions/features_spec.rb index c97be4ad0..e99d13518 100644 --- a/spec/flipper/api/v1/actions/features_spec.rb +++ b/spec/flipper/api/v1/actions/features_spec.rb @@ -15,39 +15,39 @@ it 'responds with correct attributes' do expected_response = { - "features" => [ + 'features' => [ { - "key" => "my_feature", - "state" => "on", - "gates" => [ + 'key' => 'my_feature', + 'state' => 'on', + 'gates' => [ { - "key"=> "boolean", - "name"=> "boolean", - "value" => true + 'key' => 'boolean', + 'name' => 'boolean', + 'value' => true, }, { - "key" => "groups", - "name" => "group", - "value" => [], + 'key' => 'groups', + 'name' => 'group', + 'value' => [], }, { - "key" => "actors", - "name" => "actor", - "value" => ["10"], + 'key' => 'actors', + 'name' => 'actor', + 'value' => ['10'], }, { - "key" => "percentage_of_actors", - "name" => "percentage_of_actors", - "value" => 0, + 'key' => 'percentage_of_actors', + 'name' => 'percentage_of_actors', + 'value' => 0, }, { - "key"=> "percentage_of_time", - "name"=> "percentage_of_time", - "value"=> 0, + 'key' => 'percentage_of_time', + 'name' => 'percentage_of_time', + 'value' => 0, }, ], }, - ] + ], } expect(last_response.status).to eq(200) expect(json_response).to eq(expected_response) @@ -61,7 +61,7 @@ it 'returns empty array for features key' do expected_response = { - "features" => [] + 'features' => [], } expect(last_response.status).to eq(200) expect(json_response).to eq(expected_response) @@ -72,7 +72,7 @@ describe 'post' do context 'succesful request' do before do - post 'api/v1/features', { name: 'my_feature' } + post 'api/v1/features', name: 'my_feature' end it 'responds 200 ' do @@ -82,33 +82,33 @@ it 'returns decorated feature' do expected_response = { - "key" => "my_feature", - "state" => "off", - "gates" => [ + 'key' => 'my_feature', + 'state' => 'off', + 'gates' => [ { - "key"=> "boolean", - "name"=> "boolean", - "value" => false, + 'key' => 'boolean', + 'name' => 'boolean', + 'value' => false, }, { - "key" => "groups", - "name" => "group", - "value" => [], + 'key' => 'groups', + 'name' => 'group', + 'value' => [], }, { - "key" => "actors", - "name" => "actor", - "value" => [], + 'key' => 'actors', + 'name' => 'actor', + 'value' => [], }, { - "key" => "percentage_of_actors", - "name" => "percentage_of_actors", - "value" => 0, + 'key' => 'percentage_of_actors', + 'name' => 'percentage_of_actors', + 'value' => 0, }, { - "key"=> "percentage_of_time", - "name"=> "percentage_of_time", - "value"=> 0, + 'key' => 'percentage_of_time', + 'name' => 'percentage_of_time', + 'value' => 0, }, ], } @@ -134,7 +134,12 @@ end it 'returns formatted error' do - expect(json_response).to eq({ 'code' => 5, 'message' => 'Required parameter name is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expected = { + 'code' => 5, + 'message' => 'Required parameter name is missing.', + 'more_info' => api_error_code_reference_url, + } + expect(json_response).to eq(expected) end end end diff --git a/spec/flipper/api/v1/actions/groups_gate_spec.rb b/spec/flipper/api/v1/actions/groups_gate_spec.rb index ef61f4ce6..fc44c2859 100644 --- a/spec/flipper/api/v1/actions/groups_gate_spec.rb +++ b/spec/flipper/api/v1/actions/groups_gate_spec.rb @@ -9,7 +9,7 @@ Flipper.register(:admins) do |actor| actor.respond_to?(:admin?) && actor.admin? end - post '/api/v1/features/my_feature/groups', { name: 'admins' } + post '/api/v1/features/my_feature/groups', name: 'admins' end it 'enables feature for group' do @@ -33,7 +33,7 @@ actor.respond_to?(:admin?) && actor.admin? end flipper[:my_feature].enable_group(:admins) - delete '/api/v1/features/my_feature/groups', { name: 'admins' } + delete '/api/v1/features/my_feature/groups', name: 'admins' end it 'disables feature for group' do @@ -52,24 +52,29 @@ describe 'non-existent feature' do before do - delete '/api/v1/features/my_feature/groups', { name: 'admins' } + delete '/api/v1/features/my_feature/groups', name: 'admins' end - it '404s with correct error response when feature does not exist' do + it '404s with correct error response when feature does not exist' do expect(last_response.status).to eq(404) - expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_not_found_response) end end describe 'group not registered' do before do flipper[:my_feature].disable - delete '/api/v1/features/my_feature/groups', { name: 'admins' } + delete '/api/v1/features/my_feature/groups', name: 'admins' end it '404s with correct error response when group not registered' do expect(last_response.status).to eq(404) - expect(json_response).to eq({ 'code' => 2, 'message' => 'Group not registered.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expected = { + 'code' => 2, + 'message' => 'Group not registered.', + 'more_info' => api_error_code_reference_url, + } + expect(json_response).to eq(expected) end end end diff --git a/spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb b/spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb index 4826fb380..9be9da1c2 100644 --- a/spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb +++ b/spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb @@ -6,7 +6,7 @@ describe 'enable' do before do flipper[:my_feature].disable - post '/api/v1/features/my_feature/percentage_of_actors', { percentage: '10' } + post '/api/v1/features/my_feature/percentage_of_actors', percentage: '10' end it 'enables gate for feature' do @@ -17,7 +17,6 @@ gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' } expect(gate['value']).to eq(10) end - end describe 'disable' do @@ -41,33 +40,33 @@ delete '/api/v1/features/my_feature/percentage_of_actors' end - it '404s with correct error response when feature does not exist' do + it '404s with correct error response when feature does not exist' do expect(last_response.status).to eq(404) - expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_not_found_response) end end describe 'out of range parameter percentage parameter' do before do flipper[:my_feature].disable - post '/api/v1/features/my_feature/percentage_of_actors', { percentage: '300' } + post '/api/v1/features/my_feature/percentage_of_actors', percentage: '300' end it '422s with correct error response when percentage parameter is invalid' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_positive_percentage_error_response) end end describe 'percentage parameter not an integer' do before do flipper[:my_feature].disable - post '/api/v1/features/my_feature/percentage_of_actors', { percentage: 'foo' } + post '/api/v1/features/my_feature/percentage_of_actors', percentage: 'foo' end it '422s with correct error response when percentage parameter is invalid' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_positive_percentage_error_response) end end @@ -79,7 +78,7 @@ it '422s with correct error response when percentage parameter is missing' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_positive_percentage_error_response) end end end diff --git a/spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb b/spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb index 25681c244..8d2fa91fa 100644 --- a/spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb +++ b/spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb @@ -6,7 +6,7 @@ describe 'enable' do before do flipper[:my_feature].disable - post '/api/v1/features/my_feature/percentage_of_time', { percentage: '10' } + post '/api/v1/features/my_feature/percentage_of_time', percentage: '10' end it 'enables gate for feature' do @@ -40,33 +40,33 @@ delete '/api/v1/features/my_feature/percentage_of_time' end - it '404s with correct error response when feature does not exist' do + it '404s with correct error response when feature does not exist' do expect(last_response.status).to eq(404) - expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_not_found_response) end end describe 'out of range parameter percentage parameter' do before do flipper[:my_feature].disable - post '/api/v1/features/my_feature/percentage_of_time', { percentage: '300' } + post '/api/v1/features/my_feature/percentage_of_time', percentage: '300' end it '422s with correct error response when percentage parameter is invalid' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_positive_percentage_error_response) end end describe 'percentage parameter not an integer' do before do flipper[:my_feature].disable - post '/api/v1/features/my_feature/percentage_of_time', { percentage: 'foo' } + post '/api/v1/features/my_feature/percentage_of_time', percentage: 'foo' end it '422s with correct error response when percentage parameter is invalid' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_positive_percentage_error_response) end end @@ -78,7 +78,7 @@ it '422s with correct error response when percentage parameter is missing' do expect(last_response.status).to eq(422) - expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' }) + expect(json_response).to eq(api_positive_percentage_error_response) end end end diff --git a/spec/flipper/dsl_spec.rb b/spec/flipper/dsl_spec.rb index 7d39bcc34..22c817df3 100644 --- a/spec/flipper/dsl_spec.rb +++ b/spec/flipper/dsl_spec.rb @@ -3,121 +3,121 @@ require 'flipper/adapters/memory' RSpec.describe Flipper::DSL do - subject { Flipper::DSL.new(adapter) } + subject { described_class.new(adapter) } let(:adapter) { Flipper::Adapters::Memory.new } - describe "#initialize" do - it "sets adapter" do + describe '#initialize' do + it 'sets adapter' do dsl = described_class.new(adapter) expect(dsl.adapter).not_to be_nil end - it "defaults instrumenter to noop" do + it 'defaults instrumenter to noop' do dsl = described_class.new(adapter) expect(dsl.instrumenter).to be(Flipper::Instrumenters::Noop) end - context "with overriden instrumenter" do - let(:instrumenter) { double('Instrumentor', :instrument => nil) } + context 'with overriden instrumenter' do + let(:instrumenter) { double('Instrumentor', instrument: nil) } - it "overrides default instrumenter" do - dsl = described_class.new(adapter, :instrumenter => instrumenter) + it 'overrides default instrumenter' do + dsl = described_class.new(adapter, instrumenter: instrumenter) expect(dsl.instrumenter).to be(instrumenter) end end end - describe "#feature" do - it_should_behave_like "a DSL feature" do + describe '#feature' do + it_should_behave_like 'a DSL feature' do let(:method_name) { :feature } - let(:instrumenter) { double('Instrumentor', :instrument => nil) } + let(:instrumenter) { double('Instrumentor', instrument: nil) } let(:feature) { dsl.send(method_name, :stats) } - let(:dsl) { Flipper::DSL.new(adapter, :instrumenter => instrumenter) } + let(:dsl) { described_class.new(adapter, instrumenter: instrumenter) } end end - describe "#preload" do - let(:instrumenter) { double('Instrumentor', :instrument => nil) } - let(:dsl) { Flipper::DSL.new(adapter, :instrumenter => instrumenter) } - let(:names) { %i{stats shiny} } + describe '#preload' do + let(:instrumenter) { double('Instrumentor', instrument: nil) } + let(:dsl) { described_class.new(adapter, instrumenter: instrumenter) } + let(:names) { %i(stats shiny) } let(:features) { dsl.preload(names) } - it "returns array of features" do + it 'returns array of features' do expect(features).to all be_instance_of(Flipper::Feature) end - it "sets names" do + it 'sets names' do expect(features.map(&:name)).to eq(names) end - it "sets adapter" do + it 'sets adapter' do features.each do |feature| expect(feature.adapter.name).to eq(dsl.adapter.name) end end - it "sets instrumenter" do + it 'sets instrumenter' do features.each do |feature| expect(feature.instrumenter).to eq(dsl.instrumenter) end end - it "memoizes the feature" do + it 'memoizes the feature' do features.each do |feature| expect(dsl.feature(feature.name)).to equal(feature) end end end - describe "#[]" do - it_should_behave_like "a DSL feature" do + describe '#[]' do + it_should_behave_like 'a DSL feature' do let(:method_name) { :[] } - let(:instrumenter) { double('Instrumentor', :instrument => nil) } + let(:instrumenter) { double('Instrumentor', instrument: nil) } let(:feature) { dsl.send(method_name, :stats) } - let(:dsl) { Flipper::DSL.new(adapter, :instrumenter => instrumenter) } + let(:dsl) { described_class.new(adapter, instrumenter: instrumenter) } end end - describe "#boolean" do - it_should_behave_like "a DSL boolean method" do + describe '#boolean' do + it_should_behave_like 'a DSL boolean method' do let(:method_name) { :boolean } end end - describe "#bool" do - it_should_behave_like "a DSL boolean method" do + describe '#bool' do + it_should_behave_like 'a DSL boolean method' do let(:method_name) { :bool } end end - describe "#group" do - context "for registered group" do + describe '#group' do + context 'for registered group' do before do - @group = Flipper.register(:admins) { } + @group = Flipper.register(:admins) {} end - it "returns group" do + it 'returns group' do expect(subject.group(:admins)).to eq(@group) end - it "always returns same instance for same name" do + it 'always returns same instance for same name' do expect(subject.group(:admins)).to equal(subject.group(:admins)) end end - context "for unregistered group" do - it "raises error" do - expect { + context 'for unregistered group' do + it 'raises error' do + expect do subject.group(:admins) - }.to raise_error(Flipper::GroupNotRegistered) + end.to raise_error(Flipper::GroupNotRegistered) end end end - describe "#actor" do - context "for a thing" do - it "returns actor instance" do + describe '#actor' do + context 'for a thing' do + it 'returns actor instance' do thing = Struct.new(:flipper_id).new(33) actor = subject.actor(thing) expect(actor).to be_instance_of(Flipper::Types::Actor) @@ -125,85 +125,85 @@ end end - context "for nil" do - it "raises argument error" do - expect { + context 'for nil' do + it 'raises argument error' do + expect do subject.actor(nil) - }.to raise_error(ArgumentError) + end.to raise_error(ArgumentError) end end - context "for something that is not actor wrappable" do - it "raises argument error" do - expect { + context 'for something that is not actor wrappable' do + it 'raises argument error' do + expect do subject.actor(Object.new) - }.to raise_error(ArgumentError) + end.to raise_error(ArgumentError) end end end - describe "#time" do + describe '#time' do before do @result = subject.time(5) end - it "returns percentage of time" do + it 'returns percentage of time' do expect(@result).to be_instance_of(Flipper::Types::PercentageOfTime) end - it "sets value" do + it 'sets value' do expect(@result.value).to eq(5) end - it "is aliased to percentage_of_time" do + it 'is aliased to percentage_of_time' do expect(@result).to eq(subject.percentage_of_time(@result.value)) end end - describe "#actors" do + describe '#actors' do before do @result = subject.actors(17) end - it "returns percentage of actors" do + it 'returns percentage of actors' do expect(@result).to be_instance_of(Flipper::Types::PercentageOfActors) end - it "sets value" do + it 'sets value' do expect(@result.value).to eq(17) end - it "is aliased to percentage_of_actors" do + it 'is aliased to percentage_of_actors' do expect(@result).to eq(subject.percentage_of_actors(@result.value)) end end - describe "#features" do - context "with no features enabled/disabled" do - it "defaults to empty set" do + describe '#features' do + context 'with no features enabled/disabled' do + it 'defaults to empty set' do expect(subject.features).to eq(Set.new) end end - context "with features enabled and disabled" do + context 'with features enabled and disabled' do before do subject[:stats].enable subject[:cache].enable subject[:search].disable end - it "returns set of feature instances" do + it 'returns set of feature instances' do expect(subject.features).to be_instance_of(Set) subject.features.each do |feature| expect(feature).to be_instance_of(Flipper::Feature) end - expect(subject.features.map(&:name).map(&:to_s).sort).to eq(['cache', 'search', 'stats']) + expect(subject.features.map(&:name).map(&:to_s).sort).to eq(%w(cache search stats)) end end end - describe "#enable/disable" do - it "enables and disables the feature" do + describe '#enable/disable' do + it 'enables and disables the feature' do expect(subject[:stats].boolean_value).to eq(false) subject.enable(:stats) expect(subject[:stats].boolean_value).to eq(true) @@ -213,35 +213,35 @@ end end - describe "#enable_actor/disable_actor" do - it "enables and disables the feature for actor" do + describe '#enable_actor/disable_actor' do + it 'enables and disables the feature for actor' do actor = Struct.new(:flipper_id).new(5) expect(subject[:stats].actors_value).to be_empty subject.enable_actor(:stats, actor) - expect(subject[:stats].actors_value).to eq(Set["5"]) + expect(subject[:stats].actors_value).to eq(Set['5']) subject.disable_actor(:stats, actor) expect(subject[:stats].actors_value).to be_empty end end - describe "#enable_group/disable_group" do - it "enables and disables the feature for group" do + describe '#enable_group/disable_group' do + it 'enables and disables the feature for group' do actor = Struct.new(:flipper_id).new(5) group = Flipper.register(:fives) { |actor| actor.flipper_id == 5 } expect(subject[:stats].groups_value).to be_empty subject.enable_group(:stats, :fives) - expect(subject[:stats].groups_value).to eq(Set["fives"]) + expect(subject[:stats].groups_value).to eq(Set['fives']) subject.disable_group(:stats, :fives) expect(subject[:stats].groups_value).to be_empty end end - describe "#enable_percentage_of_time/disable_percentage_of_time" do - it "enables and disables the feature for percentage of time" do + describe '#enable_percentage_of_time/disable_percentage_of_time' do + it 'enables and disables the feature for percentage of time' do expect(subject[:stats].percentage_of_time_value).to be(0) subject.enable_percentage_of_time(:stats, 6) expect(subject[:stats].percentage_of_time_value).to be(6) @@ -251,8 +251,8 @@ end end - describe "#enable_percentage_of_actors/disable_percentage_of_actors" do - it "enables and disables the feature for percentage of time" do + describe '#enable_percentage_of_actors/disable_percentage_of_actors' do + it 'enables and disables the feature for percentage of time' do expect(subject[:stats].percentage_of_actors_value).to be(0) subject.enable_percentage_of_actors(:stats, 6) expect(subject[:stats].percentage_of_actors_value).to be(6) @@ -263,7 +263,7 @@ end describe '#remove' do - it "removes the feature" do + it 'removes the feature' do subject.enable(:stats) expect { subject.remove(:stats) }.to change { subject.enabled?(:stats) }.to(false) diff --git a/spec/flipper/feature_check_context_spec.rb b/spec/flipper/feature_check_context_spec.rb index 6dc9d343b..26abf12c9 100644 --- a/spec/flipper/feature_check_context_spec.rb +++ b/spec/flipper/feature_check_context_spec.rb @@ -3,65 +3,65 @@ RSpec.describe Flipper::FeatureCheckContext do let(:feature_name) { :new_profiles } let(:values) { Flipper::GateValues.new({}) } - let(:thing) { Struct.new(:flipper_id).new("5") } - let(:options) { + let(:thing) { Struct.new(:flipper_id).new('5') } + let(:options) do { feature_name: feature_name, values: values, thing: thing, } - } + end - it "initializes just fine" do + it 'initializes just fine' do instance = described_class.new(options) expect(instance.feature_name).to eq(feature_name) expect(instance.values).to eq(values) expect(instance.thing).to eq(thing) end - it "requires feature_name" do + it 'requires feature_name' do options.delete(:feature_name) - expect { + expect do described_class.new(options) - }.to raise_error(KeyError) + end.to raise_error(KeyError) end - it "requires values" do + it 'requires values' do options.delete(:values) - expect { + expect do described_class.new(options) - }.to raise_error(KeyError) + end.to raise_error(KeyError) end - it "requires thing" do + it 'requires thing' do options.delete(:thing) - expect { + expect do described_class.new(options) - }.to raise_error(KeyError) + end.to raise_error(KeyError) end - it "knows actors_value" do - instance = described_class.new(options.merge(values: Flipper::GateValues.new({actors: Set["User:1"]}))) - expect(instance.actors_value).to eq(Set["User:1"]) + it 'knows actors_value' do + args = options.merge(values: Flipper::GateValues.new(actors: Set['User:1'])) + expect(described_class.new(args).actors_value).to eq(Set['User:1']) end - it "knows groups_value" do - instance = described_class.new(options.merge(values: Flipper::GateValues.new({groups: Set["admins"]}))) - expect(instance.groups_value).to eq(Set["admins"]) + it 'knows groups_value' do + args = options.merge(values: Flipper::GateValues.new(groups: Set['admins'])) + expect(described_class.new(args).groups_value).to eq(Set['admins']) end - it "knows boolean_value" do - instance = described_class.new(options.merge(values: Flipper::GateValues.new({boolean: true}))) + it 'knows boolean_value' do + instance = described_class.new(options.merge(values: Flipper::GateValues.new(boolean: true))) expect(instance.boolean_value).to eq(true) end - it "knows percentage_of_actors_value" do - instance = described_class.new(options.merge(values: Flipper::GateValues.new({percentage_of_actors: 14}))) - expect(instance.percentage_of_actors_value).to eq(14) + it 'knows percentage_of_actors_value' do + args = options.merge(values: Flipper::GateValues.new(percentage_of_actors: 14)) + expect(described_class.new(args).percentage_of_actors_value).to eq(14) end - it "knows percentage_of_time_value" do - instance = described_class.new(options.merge(values: Flipper::GateValues.new({percentage_of_time: 41}))) - expect(instance.percentage_of_time_value).to eq(41) + it 'knows percentage_of_time_value' do + args = options.merge(values: Flipper::GateValues.new(percentage_of_time: 41)) + expect(described_class.new(args).percentage_of_time_value).to eq(41) end end diff --git a/spec/flipper/feature_spec.rb b/spec/flipper/feature_spec.rb index d9d2671cf..d45bdcbb5 100644 --- a/spec/flipper/feature_spec.rb +++ b/spec/flipper/feature_spec.rb @@ -8,51 +8,49 @@ let(:adapter) { Flipper::Adapters::Memory.new } - describe "#initialize" do - it "sets name" do + describe '#initialize' do + it 'sets name' do feature = described_class.new(:search, adapter) expect(feature.name).to eq(:search) end - it "sets adapter" do + it 'sets adapter' do feature = described_class.new(:search, adapter) expect(feature.adapter).to eq(adapter) end - it "defaults instrumenter" do + it 'defaults instrumenter' do feature = described_class.new(:search, adapter) expect(feature.instrumenter).to be(Flipper::Instrumenters::Noop) end - context "with overriden instrumenter" do - let(:instrumenter) { double('Instrumentor', :instrument => nil) } + context 'with overriden instrumenter' do + let(:instrumenter) { double('Instrumentor', instrument: nil) } - it "overrides default instrumenter" do - feature = described_class.new(:search, adapter, { - :instrumenter => instrumenter, - }) + it 'overrides default instrumenter' do + feature = described_class.new(:search, adapter, instrumenter: instrumenter) expect(feature.instrumenter).to be(instrumenter) end end end - describe "#to_s" do - it "returns name as string" do + describe '#to_s' do + it 'returns name as string' do feature = described_class.new(:search, adapter) - expect(feature.to_s).to eq("search") + expect(feature.to_s).to eq('search') end end - describe "#to_param" do - it "returns name as string" do + describe '#to_param' do + it 'returns name as string' do feature = described_class.new(:search, adapter) - expect(feature.to_param).to eq("search") + expect(feature.to_param).to eq('search') end end - describe "#gate_for" do - context "with percentage of actors" do - it "returns percentage of actors gate" do + describe '#gate_for' do + context 'with percentage of actors' do + it 'returns percentage of actors gate' do percentage = Flipper::Types::PercentageOfActors.new(10) gate = subject.gate_for(percentage) expect(gate).to be_instance_of(Flipper::Gates::PercentageOfActors) @@ -60,8 +58,8 @@ end end - describe "#gates" do - it "returns array of gates" do + describe '#gates' do + it 'returns array of gates' do instance = described_class.new(:search, adapter) expect(instance.gates).to be_instance_of(Array) instance.gates.each do |gate| @@ -71,28 +69,28 @@ end end - describe "#gate" do - context "with symbol name" do - it "returns gate by name" do + describe '#gate' do + context 'with symbol name' do + it 'returns gate by name' do expect(subject.gate(:boolean)).to be_instance_of(Flipper::Gates::Boolean) end end - context "with string name" do - it "returns gate by name" do + context 'with string name' do + it 'returns gate by name' do expect(subject.gate('boolean')).to be_instance_of(Flipper::Gates::Boolean) end end - context "with name that does not exist" do - it "returns nil" do + context 'with name that does not exist' do + it 'returns nil' do expect(subject.gate(:poo)).to be_nil end end end - describe "#inspect" do - it "returns easy to read string representation" do + describe '#inspect' do + it 'returns easy to read string representation' do string = subject.inspect expect(string).to include('Flipper::Feature') expect(string).to include('name=:search') @@ -107,15 +105,15 @@ end end - describe "instrumentation" do + describe 'instrumentation' do let(:instrumenter) { Flipper::Instrumenters::Memory.new } - subject { - described_class.new(:search, adapter, :instrumenter => instrumenter) - } + subject do + described_class.new(:search, adapter, instrumenter: instrumenter) + end - it "is recorded for enable" do - thing = Flipper::Types::Actor.new(Struct.new(:flipper_id).new("1")) + it 'is recorded for enable' do + thing = Flipper::Types::Actor.new(Struct.new(:flipper_id).new('1')) gate = subject.gate_for(thing) subject.enable(thing) @@ -129,8 +127,8 @@ expect(event.payload[:result]).not_to be_nil end - it "always instruments flipper type instance for enable" do - thing = Struct.new(:flipper_id).new("1") + it 'always instruments flipper type instance for enable' do + thing = Struct.new(:flipper_id).new('1') gate = subject.gate_for(thing) subject.enable(thing) @@ -140,7 +138,7 @@ expect(event.payload[:thing]).to eq(Flipper::Types::Actor.new(thing)) end - it "is recorded for disable" do + it 'is recorded for disable' do thing = Flipper::Types::Boolean.new gate = subject.gate_for(thing) @@ -155,7 +153,7 @@ expect(event.payload[:result]).not_to be_nil end - user = Struct.new(:flipper_id).new("1") + user = Struct.new(:flipper_id).new('1') actor = Flipper::Types::Actor.new(user) boolean_true = Flipper::Types::Boolean.new(true) boolean_false = Flipper::Types::Boolean.new(false) @@ -185,8 +183,8 @@ end end - it "always instruments flipper type instance for disable" do - thing = Struct.new(:flipper_id).new("1") + it 'always instruments flipper type instance for disable' do + thing = Struct.new(:flipper_id).new('1') gate = subject.gate_for(thing) subject.disable(thing) @@ -197,7 +195,7 @@ expect(event.payload[:thing]).to eq(Flipper::Types::Actor.new(thing)) end - it "is recorded for remove" do + it 'is recorded for remove' do subject.remove event = instrumenter.events.last @@ -208,8 +206,8 @@ expect(event.payload[:result]).not_to be_nil end - it "is recorded for enabled?" do - thing = Flipper::Types::Actor.new(Struct.new(:flipper_id).new("1")) + it 'is recorded for enabled?' do + thing = Flipper::Types::Actor.new(Struct.new(:flipper_id).new('1')) gate = subject.gate_for(thing) subject.enabled?(thing) @@ -223,7 +221,7 @@ expect(event.payload[:result]).to eq(false) end - user = Struct.new(:flipper_id).new("1") + user = Struct.new(:flipper_id).new('1') actor = Flipper::Types::Actor.new(user) { nil => nil, @@ -241,176 +239,176 @@ end end - describe "#state" do - context "fully on" do + describe '#state' do + context 'fully on' do before do subject.enable end - it "returns :on" do + it 'returns :on' do expect(subject.state).to be(:on) end - it "returns true for on?" do + it 'returns true for on?' do expect(subject.on?).to be(true) end - it "returns false for off?" do + it 'returns false for off?' do expect(subject.off?).to be(false) end - it "returns false for conditional?" do + it 'returns false for conditional?' do expect(subject.conditional?).to be(false) end end - context "percentage of time set to 100" do + context 'percentage of time set to 100' do before do subject.enable_percentage_of_time 100 end - it "returns :on" do + it 'returns :on' do expect(subject.state).to be(:on) end - it "returns true for on?" do + it 'returns true for on?' do expect(subject.on?).to be(true) end - it "returns false for off?" do + it 'returns false for off?' do expect(subject.off?).to be(false) end - it "returns false for conditional?" do + it 'returns false for conditional?' do expect(subject.conditional?).to be(false) end end - context "percentage of actors set to 100" do + context 'percentage of actors set to 100' do before do subject.enable_percentage_of_actors 100 end - it "returns :on" do + it 'returns :on' do expect(subject.state).to be(:on) end - it "returns true for on?" do + it 'returns true for on?' do expect(subject.on?).to be(true) end - it "returns false for off?" do + it 'returns false for off?' do expect(subject.off?).to be(false) end - it "returns false for conditional?" do + it 'returns false for conditional?' do expect(subject.conditional?).to be(false) end end - context "fully off" do + context 'fully off' do before do subject.disable end - it "returns :off" do + it 'returns :off' do expect(subject.state).to be(:off) end - it "returns false for on?" do + it 'returns false for on?' do expect(subject.on?).to be(false) end - it "returns true for off?" do + it 'returns true for off?' do expect(subject.off?).to be(true) end - it "returns false for conditional?" do + it 'returns false for conditional?' do expect(subject.conditional?).to be(false) end end - context "partially on" do + context 'partially on' do before do subject.enable Flipper::Types::PercentageOfTime.new(5) end - it "returns :conditional" do + it 'returns :conditional' do expect(subject.state).to be(:conditional) end - it "returns false for on?" do + it 'returns false for on?' do expect(subject.on?).to be(false) end - it "returns false for off?" do + it 'returns false for off?' do expect(subject.off?).to be(false) end - it "returns true for conditional?" do + it 'returns true for conditional?' do expect(subject.conditional?).to be(true) end end end - describe "#enabled_groups" do - context "when no groups enabled" do - it "returns empty set" do + describe '#enabled_groups' do + context 'when no groups enabled' do + it 'returns empty set' do expect(subject.enabled_groups).to eq(Set.new) end end - context "when one or more groups enabled" do + context 'when one or more groups enabled' do before do - @staff = Flipper.register(:staff) { |thing| true } - @preview_features = Flipper.register(:preview_features) { |thing| true } - @not_enabled = Flipper.register(:not_enabled) { |thing| true } - @disabled = Flipper.register(:disabled) { |thing| true } + @staff = Flipper.register(:staff) { |_thing| true } + @preview_features = Flipper.register(:preview_features) { |_thing| true } + @not_enabled = Flipper.register(:not_enabled) { |_thing| true } + @disabled = Flipper.register(:disabled) { |_thing| true } subject.enable @staff subject.enable @preview_features subject.disable @disabled end - it "returns set of enabled groups" do + it 'returns set of enabled groups' do expect(subject.enabled_groups).to eq(Set.new([ - @staff, - @preview_features, - ])) + @staff, + @preview_features, + ])) end - it "does not include groups that have not been enabled" do + it 'does not include groups that have not been enabled' do expect(subject.enabled_groups).not_to include(@not_enabled) end - it "does not include disabled groups" do + it 'does not include disabled groups' do expect(subject.enabled_groups).not_to include(@disabled) end - it "is aliased to groups" do + it 'is aliased to groups' do expect(subject.enabled_groups).to eq(subject.groups) end end end - describe "#disabled_groups" do - context "when no groups enabled" do - it "returns empty set" do + describe '#disabled_groups' do + context 'when no groups enabled' do + it 'returns empty set' do expect(subject.disabled_groups).to eq(Set.new) end end - context "when one or more groups enabled" do + context 'when one or more groups enabled' do before do - @staff = Flipper.register(:staff) { |thing| true } - @preview_features = Flipper.register(:preview_features) { |thing| true } - @not_enabled = Flipper.register(:not_enabled) { |thing| true } - @disabled = Flipper.register(:disabled) { |thing| true } + @staff = Flipper.register(:staff) { |_thing| true } + @preview_features = Flipper.register(:preview_features) { |_thing| true } + @not_enabled = Flipper.register(:not_enabled) { |_thing| true } + @disabled = Flipper.register(:disabled) { |_thing| true } subject.enable @staff subject.enable @preview_features subject.disable @disabled end - it "returns set of groups that are not enabled" do + it 'returns set of groups that are not enabled' do expect(subject.disabled_groups).to eq(Set[ @not_enabled, @disabled, @@ -419,158 +417,156 @@ end end - describe "#groups_value" do - context "when no groups enabled" do - it "returns empty set" do + describe '#groups_value' do + context 'when no groups enabled' do + it 'returns empty set' do expect(subject.groups_value).to eq(Set.new) end end - context "when one or more groups enabled" do + context 'when one or more groups enabled' do before do - @staff = Flipper.register(:staff) { |thing| true } - @preview_features = Flipper.register(:preview_features) { |thing| true } - @not_enabled = Flipper.register(:not_enabled) { |thing| true } - @disabled = Flipper.register(:disabled) { |thing| true } + @staff = Flipper.register(:staff) { |_thing| true } + @preview_features = Flipper.register(:preview_features) { |_thing| true } + @not_enabled = Flipper.register(:not_enabled) { |_thing| true } + @disabled = Flipper.register(:disabled) { |_thing| true } subject.enable @staff subject.enable @preview_features subject.disable @disabled end - it "returns set of enabled groups" do + it 'returns set of enabled groups' do expect(subject.groups_value).to eq(Set.new([ - @staff.name.to_s, - @preview_features.name.to_s, - ])) + @staff.name.to_s, + @preview_features.name.to_s, + ])) end - it "does not include groups that have not been enabled" do + it 'does not include groups that have not been enabled' do expect(subject.groups_value).not_to include(@not_enabled.name.to_s) end - it "does not include disabled groups" do + it 'does not include disabled groups' do expect(subject.groups_value).not_to include(@disabled.name.to_s) end end end - describe "#actors_value" do - context "when no groups enabled" do - it "returns empty set" do + describe '#actors_value' do + context 'when no groups enabled' do + it 'returns empty set' do expect(subject.actors_value).to eq(Set.new) end end - context "when one or more actors are enabled" do + context 'when one or more actors are enabled' do before do - subject.enable Flipper::Types::Actor.new(Struct.new(:flipper_id).new("User:5")) - subject.enable Flipper::Types::Actor.new(Struct.new(:flipper_id).new("User:22")) + subject.enable Flipper::Types::Actor.new(Struct.new(:flipper_id).new('User:5')) + subject.enable Flipper::Types::Actor.new(Struct.new(:flipper_id).new('User:22')) end - it "returns set of actor ids" do - expect(subject.actors_value).to eq(Set.new(["User:5", "User:22"])) + it 'returns set of actor ids' do + expect(subject.actors_value).to eq(Set.new(['User:5', 'User:22'])) end end end - describe "#boolean_value" do - context "when not enabled or disabled" do - it "returns false" do + describe '#boolean_value' do + context 'when not enabled or disabled' do + it 'returns false' do expect(subject.boolean_value).to be(false) end end - context "when enabled" do + context 'when enabled' do before do subject.enable end - it "returns true" do + it 'returns true' do expect(subject.boolean_value).to be(true) end end - context "when disabled" do + context 'when disabled' do before do subject.disable end - it "returns false" do + it 'returns false' do expect(subject.boolean_value).to be(false) end end end - describe "#percentage_of_actors_value" do - context "when not enabled or disabled" do - it "returns nil" do + describe '#percentage_of_actors_value' do + context 'when not enabled or disabled' do + it 'returns nil' do expect(subject.percentage_of_actors_value).to be(0) end end - context "when enabled" do + context 'when enabled' do before do subject.enable Flipper::Types::PercentageOfActors.new(5) end - it "returns true" do + it 'returns true' do expect(subject.percentage_of_actors_value).to eq(5) end end - context "when disabled" do + context 'when disabled' do before do subject.disable end - it "returns nil" do + it 'returns nil' do expect(subject.percentage_of_actors_value).to be(0) end end end - describe "#percentage_of_time_value" do - context "when not enabled or disabled" do - it "returns nil" do + describe '#percentage_of_time_value' do + context 'when not enabled or disabled' do + it 'returns nil' do expect(subject.percentage_of_time_value).to be(0) end end - context "when enabled" do + context 'when enabled' do before do subject.enable Flipper::Types::PercentageOfTime.new(5) end - it "returns true" do + it 'returns true' do expect(subject.percentage_of_time_value).to eq(5) end end - context "when disabled" do + context 'when disabled' do before do subject.disable end - it "returns nil" do + it 'returns nil' do expect(subject.percentage_of_time_value).to be(0) end end end - describe "#gate_values" do - context "when no gates are set in adapter" do - it "returns default gate values" do - expect(subject.gate_values).to eq(Flipper::GateValues.new({ - :actors => Set.new, - :groups => Set.new, - :boolean => nil, - :percentage_of_actors => nil, - :percentage_of_time => nil, - })) + describe '#gate_values' do + context 'when no gates are set in adapter' do + it 'returns default gate values' do + expect(subject.gate_values).to eq(Flipper::GateValues.new(actors: Set.new, + groups: Set.new, + boolean: nil, + percentage_of_actors: nil, + percentage_of_time: nil)) end end - context "with gate values set in adapter" do + context 'with gate values set in adapter' do before do subject.enable Flipper::Types::Boolean.new(true) subject.enable Flipper::Types::Actor.new(Struct.new(:flipper_id).new(5)) @@ -579,84 +575,82 @@ subject.enable Flipper::Types::PercentageOfActors.new(25) end - it "returns gate values" do - expect(subject.gate_values).to eq(Flipper::GateValues.new({ - :actors => Set.new(["5"]), - :groups => Set.new(["admins"]), - :boolean => "true", - :percentage_of_time => "50", - :percentage_of_actors => "25", - })) + it 'returns gate values' do + expect(subject.gate_values).to eq(Flipper::GateValues.new(actors: Set.new(['5']), + groups: Set.new(['admins']), + boolean: 'true', + percentage_of_time: '50', + percentage_of_actors: '25')) end end end - describe "#enable_actor/disable_actor" do - context "with object that responds to flipper_id" do - it "updates the gate values to include the actor" do + describe '#enable_actor/disable_actor' do + context 'with object that responds to flipper_id' do + it 'updates the gate values to include the actor' do actor = Struct.new(:flipper_id).new(5) expect(subject.gate_values.actors).to be_empty subject.enable_actor(actor) - expect(subject.gate_values.actors).to eq(Set["5"]) + expect(subject.gate_values.actors).to eq(Set['5']) subject.disable_actor(actor) expect(subject.gate_values.actors).to be_empty end end - context "with actor instance" do - it "updates the gate values to include the actor" do + context 'with actor instance' do + it 'updates the gate values to include the actor' do actor = Struct.new(:flipper_id).new(5) instance = Flipper::Types::Actor.new(actor) expect(subject.gate_values.actors).to be_empty subject.enable_actor(instance) - expect(subject.gate_values.actors).to eq(Set["5"]) + expect(subject.gate_values.actors).to eq(Set['5']) subject.disable_actor(instance) expect(subject.gate_values.actors).to be_empty end end end - describe "#enable_group/disable_group" do - context "with symbol group name" do - it "updates the gate values to include the group" do + describe '#enable_group/disable_group' do + context 'with symbol group name' do + it 'updates the gate values to include the group' do actor = Struct.new(:flipper_id).new(5) group = Flipper.register(:five_only) { |actor| actor.flipper_id == 5 } expect(subject.gate_values.groups).to be_empty subject.enable_group(:five_only) - expect(subject.gate_values.groups).to eq(Set["five_only"]) + expect(subject.gate_values.groups).to eq(Set['five_only']) subject.disable_group(:five_only) expect(subject.gate_values.groups).to be_empty end end - context "with string group name" do - it "updates the gate values to include the group" do + context 'with string group name' do + it 'updates the gate values to include the group' do actor = Struct.new(:flipper_id).new(5) group = Flipper.register(:five_only) { |actor| actor.flipper_id == 5 } expect(subject.gate_values.groups).to be_empty - subject.enable_group("five_only") - expect(subject.gate_values.groups).to eq(Set["five_only"]) - subject.disable_group("five_only") + subject.enable_group('five_only') + expect(subject.gate_values.groups).to eq(Set['five_only']) + subject.disable_group('five_only') expect(subject.gate_values.groups).to be_empty end end - context "with group instance" do - it "updates the gate values for the group" do + context 'with group instance' do + it 'updates the gate values for the group' do actor = Struct.new(:flipper_id).new(5) group = Flipper.register(:five_only) { |actor| actor.flipper_id == 5 } expect(subject.gate_values.groups).to be_empty subject.enable_group(group) - expect(subject.gate_values.groups).to eq(Set["five_only"]) + expect(subject.gate_values.groups).to eq(Set['five_only']) subject.disable_group(group) expect(subject.gate_values.groups).to be_empty end end end - describe "#enable_percentage_of_time/disable_percentage_of_time" do - context "with integer" do - it "updates the gate values" do + describe '#enable_percentage_of_time/disable_percentage_of_time' do + context 'with integer' do + it 'updates the gate values' do expect(subject.gate_values.percentage_of_time).to be(0) subject.enable_percentage_of_time(56) expect(subject.gate_values.percentage_of_time).to be(56) @@ -665,18 +659,18 @@ end end - context "with string" do - it "updates the gate values" do + context 'with string' do + it 'updates the gate values' do expect(subject.gate_values.percentage_of_time).to be(0) - subject.enable_percentage_of_time("56") + subject.enable_percentage_of_time('56') expect(subject.gate_values.percentage_of_time).to be(56) subject.disable_percentage_of_time expect(subject.gate_values.percentage_of_time).to be(0) end end - context "with percentage of time instance" do - it "updates the gate values" do + context 'with percentage of time instance' do + it 'updates the gate values' do percentage = Flipper::Types::PercentageOfTime.new(56) expect(subject.gate_values.percentage_of_time).to be(0) subject.enable_percentage_of_time(percentage) @@ -687,9 +681,9 @@ end end - describe "#enable_percentage_of_actors/disable_percentage_of_actors" do - context "with integer" do - it "updates the gate values" do + describe '#enable_percentage_of_actors/disable_percentage_of_actors' do + context 'with integer' do + it 'updates the gate values' do expect(subject.gate_values.percentage_of_actors).to be(0) subject.enable_percentage_of_actors(56) expect(subject.gate_values.percentage_of_actors).to be(56) @@ -698,18 +692,18 @@ end end - context "with string" do - it "updates the gate values" do + context 'with string' do + it 'updates the gate values' do expect(subject.gate_values.percentage_of_actors).to be(0) - subject.enable_percentage_of_actors("56") + subject.enable_percentage_of_actors('56') expect(subject.gate_values.percentage_of_actors).to be(56) subject.disable_percentage_of_actors expect(subject.gate_values.percentage_of_actors).to be(0) end end - context "with percentage of actors instance" do - it "updates the gate values" do + context 'with percentage of actors instance' do + it 'updates the gate values' do percentage = Flipper::Types::PercentageOfActors.new(56) expect(subject.gate_values.percentage_of_actors).to be(0) subject.enable_percentage_of_actors(percentage) @@ -720,13 +714,13 @@ end end - describe "#enabled/disabled_gates" do + describe '#enabled/disabled_gates' do before do subject.enable_percentage_of_time 5 subject.enable_percentage_of_actors 5 end - it "can return enabled gates" do + it 'can return enabled gates' do expect(subject.enabled_gates.map(&:name).to_set).to eq(Set[ :percentage_of_actors, :percentage_of_time, @@ -738,7 +732,7 @@ ]) end - it "can return disabled gates" do + it 'can return disabled gates' do expect(subject.disabled_gates.map(&:name).to_set).to eq(Set[ :actor, :boolean, diff --git a/spec/flipper/gate_spec.rb b/spec/flipper/gate_spec.rb index 1215356a5..364d8e148 100644 --- a/spec/flipper/gate_spec.rb +++ b/spec/flipper/gate_spec.rb @@ -3,14 +3,14 @@ RSpec.describe Flipper::Gate do let(:feature_name) { :stats } - subject { + subject do described_class.new - } + end - describe "#inspect" do - context "for subclass" do - let(:subclass) { - Class.new(described_class) { + describe '#inspect' do + context 'for subclass' do + let(:subclass) do + Class.new(described_class) do def name :name end @@ -22,14 +22,14 @@ def key def data_type :set end - } - } + end + end - subject { + subject do subclass.new - } + end - it "includes attributes" do + it 'includes attributes' do string = subject.inspect expect(string).to include(subject.object_id.to_s) expect(string).to include('name=:name') diff --git a/spec/flipper/gate_values_spec.rb b/spec/flipper/gate_values_spec.rb index fe2059f27..5aab8c70e 100644 --- a/spec/flipper/gate_values_spec.rb +++ b/spec/flipper/gate_values_spec.rb @@ -4,15 +4,15 @@ RSpec.describe Flipper::GateValues do { nil => false, - "" => false, + '' => false, 0 => false, 1 => true, - "0" => false, - "1" => true, + '0' => false, + '1' => true, true => true, false => false, - "true" => true, - "false" => false, + 'true' => true, + 'false' => false, }.each do |value, expected| context "with #{value.inspect} boolean" do it "returns #{expected}" do @@ -23,11 +23,11 @@ { nil => 0, - "" => 0, + '' => 0, 0 => 0, 1 => 1, - "1" => 1, - "99" => 99, + '1' => 1, + '99' => 99, }.each do |value, expected| context "with #{value.inspect} percentage of time" do it "returns #{expected}" do @@ -38,24 +38,25 @@ { nil => 0, - "" => 0, + '' => 0, 0 => 0, 1 => 1, - "1" => 1, - "99" => 99, + '1' => 1, + '99' => 99, }.each do |value, expected| context "with #{value.inspect} percentage of actors" do it "returns #{expected}" do - expect(described_class.new(percentage_of_actors: value).percentage_of_actors).to be(expected) + expect(described_class.new(percentage_of_actors: value).percentage_of_actors) + .to be(expected) end end end { nil => Set.new, - "" => Set.new, + '' => Set.new, Set.new([1, 2]) => Set.new([1, 2]), - [1, 2] => Set.new([1, 2]) + [1, 2] => Set.new([1, 2]), }.each do |value, expected| context "with #{value.inspect} actors" do it "returns #{expected}" do @@ -66,9 +67,9 @@ { nil => Set.new, - "" => Set.new, + '' => Set.new, Set.new([:admins, :preview_features]) => Set.new([:admins, :preview_features]), - [:admins, :preview_features] => Set.new([:admins, :preview_features]) + [:admins, :preview_features] => Set.new([:admins, :preview_features]), }.each do |value, expected| context "with #{value.inspect} groups" do it "returns #{expected}" do @@ -77,58 +78,58 @@ end end - it "raises argument error for percentage of time value that cannot be converted to an integer" do - expect { - described_class.new(percentage_of_time: ["asdf"]) - }.to raise_error(ArgumentError, %Q(["asdf"] cannot be converted to an integer)) + it 'raises argument error for percentage of time value that cannot be converted to an integer' do + expect do + described_class.new(percentage_of_time: ['asdf']) + end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer)) end - it "raises argument error for percentage of actors value that cannot be converted to an integer" do - expect { - described_class.new(percentage_of_actors: ["asdf"]) - }.to raise_error(ArgumentError, %Q(["asdf"] cannot be converted to an integer)) + it 'raises argument error for percentage of actors value that cannot be converted to an int' do + expect do + described_class.new(percentage_of_actors: ['asdf']) + end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer)) end - it "raises argument error for actors value that cannot be converted to a set" do - expect { - described_class.new(actors: "asdf") - }.to raise_error(ArgumentError, %Q("asdf" cannot be converted to a set)) + it 'raises argument error for actors value that cannot be converted to a set' do + expect do + described_class.new(actors: 'asdf') + end.to raise_error(ArgumentError, %("asdf" cannot be converted to a set)) end - it "raises argument error for groups value that cannot be converted to a set" do - expect { - described_class.new(groups: "asdf") - }.to raise_error(ArgumentError, %Q("asdf" cannot be converted to a set)) + it 'raises argument error for groups value that cannot be converted to a set' do + expect do + described_class.new(groups: 'asdf') + end.to raise_error(ArgumentError, %("asdf" cannot be converted to a set)) end - describe "#[]" do - it "can read the boolean value" do + describe '#[]' do + it 'can read the boolean value' do expect(described_class.new(boolean: true)[:boolean]).to be(true) - expect(described_class.new(boolean: true)["boolean"]).to be(true) + expect(described_class.new(boolean: true)['boolean']).to be(true) end - it "can read the actors value" do + it 'can read the actors value' do expect(described_class.new(actors: Set[1, 2])[:actors]).to eq(Set[1, 2]) - expect(described_class.new(actors: Set[1, 2])["actors"]).to eq(Set[1, 2]) + expect(described_class.new(actors: Set[1, 2])['actors']).to eq(Set[1, 2]) end - it "can read the groups value" do + it 'can read the groups value' do expect(described_class.new(groups: Set[:admins])[:groups]).to eq(Set[:admins]) - expect(described_class.new(groups: Set[:admins])["groups"]).to eq(Set[:admins]) + expect(described_class.new(groups: Set[:admins])['groups']).to eq(Set[:admins]) end - it "can read the percentage of time value" do + it 'can read the percentage of time value' do expect(described_class.new(percentage_of_time: 15)[:percentage_of_time]).to eq(15) - expect(described_class.new(percentage_of_time: 15)["percentage_of_time"]).to eq(15) + expect(described_class.new(percentage_of_time: 15)['percentage_of_time']).to eq(15) end - it "can read the percentage of actors value" do + it 'can read the percentage of actors value' do expect(described_class.new(percentage_of_actors: 15)[:percentage_of_actors]).to eq(15) - expect(described_class.new(percentage_of_actors: 15)["percentage_of_actors"]).to eq(15) + expect(described_class.new(percentage_of_actors: 15)['percentage_of_actors']).to eq(15) end - it "returns nil for value that is not present" do - expect(described_class.new({})["not legit"]).to be(nil) + it 'returns nil for value that is not present' do + expect(described_class.new({})['not legit']).to be(nil) end end end diff --git a/spec/flipper/gates/actor_spec.rb b/spec/flipper/gates/actor_spec.rb index 6c99003c7..ea6669572 100644 --- a/spec/flipper/gates/actor_spec.rb +++ b/spec/flipper/gates/actor_spec.rb @@ -3,7 +3,7 @@ RSpec.describe Flipper::Gates::Actor do let(:feature_name) { :search } - subject { + subject do described_class.new - } + end end diff --git a/spec/flipper/gates/boolean_spec.rb b/spec/flipper/gates/boolean_spec.rb index ffa032dd4..4d69eedbf 100644 --- a/spec/flipper/gates/boolean_spec.rb +++ b/spec/flipper/gates/boolean_spec.rb @@ -3,71 +3,72 @@ RSpec.describe Flipper::Gates::Boolean do let(:feature_name) { :search } - subject { + subject do described_class.new - } + end def context(bool) Flipper::FeatureCheckContext.new( feature_name: feature_name, - values: Flipper::GateValues.new({boolean: bool}), - thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)), + values: Flipper::GateValues.new(boolean: bool), + thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)) ) end - describe "#enabled?" do - context "for true value" do - it "returns true" do + describe '#enabled?' do + context 'for true value' do + it 'returns true' do expect(subject.enabled?(true)).to eq(true) end end - context "for false value" do - it "returns false" do + context 'for false value' do + it 'returns false' do expect(subject.enabled?(false)).to eq(false) end end end - describe "#open?" do - context "for true value" do - it "returns true" do + describe '#open?' do + context 'for true value' do + it 'returns true' do expect(subject.open?(context(true))).to be(true) end end - context "for false value" do - it "returns false" do + context 'for false value' do + it 'returns false' do expect(subject.open?(context(false))).to be(false) end end end - describe "#protects?" do - it "returns true for boolean type" do + describe '#protects?' do + it 'returns true for boolean type' do expect(subject.protects?(Flipper::Types::Boolean.new(true))).to be(true) end - it "returns true for true" do + it 'returns true for true' do expect(subject.protects?(true)).to be(true) end - it "returns true for false" do + it 'returns true for false' do expect(subject.protects?(false)).to be(true) end end - describe "#wrap" do - it "returns boolean type for boolean type" do - expect(subject.wrap(Flipper::Types::Boolean.new(true))).to be_instance_of(Flipper::Types::Boolean) + describe '#wrap' do + it 'returns boolean type for boolean type' do + expect(subject.wrap(Flipper::Types::Boolean.new(true))) + .to be_instance_of(Flipper::Types::Boolean) end - it "returns boolean type for true" do + it 'returns boolean type for true' do expect(subject.wrap(true)).to be_instance_of(Flipper::Types::Boolean) expect(subject.wrap(true).value).to be(true) end - it "returns boolean type for true" do + it 'returns boolean type for true' do expect(subject.wrap(false)).to be_instance_of(Flipper::Types::Boolean) expect(subject.wrap(false).value).to be(false) end diff --git a/spec/flipper/gates/group_spec.rb b/spec/flipper/gates/group_spec.rb index 173cbda89..b94fc0581 100644 --- a/spec/flipper/gates/group_spec.rb +++ b/spec/flipper/gates/group_spec.rb @@ -3,62 +3,62 @@ RSpec.describe Flipper::Gates::Group do let(:feature_name) { :search } - subject { + subject do described_class.new - } + end def context(set) Flipper::FeatureCheckContext.new( feature_name: feature_name, - values: Flipper::GateValues.new({groups: set}), - thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new("5")), + values: Flipper::GateValues.new(groups: set), + thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new('5')) ) end - describe "#open?" do - context "with a group in adapter, but not registered" do + describe '#open?' do + context 'with a group in adapter, but not registered' do before do - Flipper.register(:staff) { |thing| true } + Flipper.register(:staff) { |_thing| true } end - it "ignores group" do + it 'ignores group' do thing = Struct.new(:flipper_id).new('5') expect(subject.open?(context(Set[:newbs, :staff]))).to be(true) end end - context "thing that does not respond to method in group block" do + context 'thing that does not respond to method in group block' do before do - Flipper.register(:stinkers) { |thing| thing.stinker? } + Flipper.register(:stinkers, &:stinker?) end - it "raises error" do - expect { + it 'raises error' do + expect do subject.open?(context(Set[:stinkers])) - }.to raise_error(NoMethodError) + end.to raise_error(NoMethodError) end end end - describe "#wrap" do - it "returns group instance for symbol" do + describe '#wrap' do + it 'returns group instance for symbol' do group = Flipper.register(:admins) {} expect(subject.wrap(:admins)).to eq(group) end - it "returns group instance for group instance" do + it 'returns group instance for group instance' do group = Flipper.register(:admins) {} expect(subject.wrap(group)).to eq(group) end end - describe "#protects?" do - it "returns true for group" do + describe '#protects?' do + it 'returns true for group' do group = Flipper.register(:admins) {} expect(subject.protects?(group)).to be(true) end - it "returns true for symbol" do + it 'returns true for symbol' do expect(subject.protects?(:admins)).to be(true) end end diff --git a/spec/flipper/gates/percentage_of_actors_spec.rb b/spec/flipper/gates/percentage_of_actors_spec.rb index 9f6600ad3..856b31a07 100644 --- a/spec/flipper/gates/percentage_of_actors_spec.rb +++ b/spec/flipper/gates/percentage_of_actors_spec.rb @@ -3,27 +3,27 @@ RSpec.describe Flipper::Gates::PercentageOfActors do let(:feature_name) { :search } - subject { + subject do described_class.new - } + end def context(integer, feature = feature_name, thing = nil) Flipper::FeatureCheckContext.new( feature_name: feature, - values: Flipper::GateValues.new({percentage_of_actors: integer}), - thing: thing || Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)), + values: Flipper::GateValues.new(percentage_of_actors: integer), + thing: thing || Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)) ) end - describe "#open?" do - context "when compared against two features" do + describe '#open?' do + context 'when compared against two features' do let(:percentage) { 0.05 } let(:percentage_as_integer) { percentage * 100 } let(:number_of_actors) { 100 } - let(:actors) { + let(:actors) do (1..number_of_actors).map { |n| Struct.new(:flipper_id).new(n) } - } + end let(:feature_one_enabled_actors) do gate = described_class.new @@ -35,11 +35,11 @@ def context(integer, feature = feature_name, thing = nil) actors.select { |actor| gate.open? context(percentage_as_integer, :name_two, actor) } end - it "does not enable both features for same set of actors" do + it 'does not enable both features for same set of actors' do expect(feature_one_enabled_actors).not_to eq(feature_two_enabled_actors) end - it "enables feature for accurate number of actors for each feature" do + it 'enables feature for accurate number of actors for each feature' do margin_of_error = 0.02 * number_of_actors # 2 percent margin of error expected_enabled_size = number_of_actors * percentage diff --git a/spec/flipper/gates/percentage_of_time_spec.rb b/spec/flipper/gates/percentage_of_time_spec.rb index 710b70f79..1efe1b199 100644 --- a/spec/flipper/gates/percentage_of_time_spec.rb +++ b/spec/flipper/gates/percentage_of_time_spec.rb @@ -3,7 +3,7 @@ RSpec.describe Flipper::Gates::PercentageOfTime do let(:feature_name) { :search } - subject { + subject do described_class.new - } + end end diff --git a/spec/flipper/instrumentation/log_subscriber_spec.rb b/spec/flipper/instrumentation/log_subscriber_spec.rb index 1012f8e23..afa6504c3 100644 --- a/spec/flipper/instrumentation/log_subscriber_spec.rb +++ b/spec/flipper/instrumentation/log_subscriber_spec.rb @@ -5,22 +5,22 @@ require 'flipper/instrumentation/log_subscriber' RSpec.describe Flipper::Instrumentation::LogSubscriber do - let(:adapter) { + let(:adapter) do memory = Flipper::Adapters::Memory.new - Flipper::Adapters::Instrumented.new(memory, :instrumenter => ActiveSupport::Notifications) - } - let(:flipper) { - Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications) - } + Flipper::Adapters::Instrumented.new(memory, instrumenter: ActiveSupport::Notifications) + end + let(:flipper) do + Flipper.new(adapter, instrumenter: ActiveSupport::Notifications) + end before do - Flipper.register(:admins) { |thing| + Flipper.register(:admins) do |thing| thing.respond_to?(:admin?) && thing.admin? - } + end @io = StringIO.new logger = Logger.new(@io) - logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" } + logger.formatter = proc { |_severity, _datetime, _progname, msg| "#{msg}\n" } described_class.logger = logger end @@ -30,25 +30,25 @@ let(:log) { @io.string } - context "feature enabled checks" do + context 'feature enabled checks' do before do clear_logs flipper[:search].enabled? end - it "logs feature calls with result after operation" do + it 'logs feature calls with result after operation' do feature_line = find_line('Flipper feature(search) enabled? false') expect(feature_line).to include('[ thing=nil ]') end - it "logs adapter calls" do + it 'logs adapter calls' do adapter_line = find_line('Flipper feature(search) adapter(memory) get') expect(adapter_line).to include('[ result={') expect(adapter_line).to include('} ]') end end - context "feature enabled checks with a thing" do + context 'feature enabled checks with a thing' do let(:user) { Flipper::Types::Actor.new(Struct.new(:flipper_id).new('1')) } before do @@ -56,13 +56,13 @@ flipper[:search].enabled?(user) end - it "logs thing for feature" do + it 'logs thing for feature' do feature_line = find_line('Flipper feature(search) enabled?') expect(feature_line).to include(user.inspect) end end - context "changing feature enabled state" do + context 'changing feature enabled state' do let(:user) { Flipper::Types::Actor.new(Struct.new(:flipper_id).new('1')) } before do @@ -70,24 +70,24 @@ flipper[:search].enable(user) end - it "logs feature calls with result in brackets" do + it 'logs feature calls with result in brackets' do feature_line = find_line('Flipper feature(search) enable true') expect(feature_line).to include("[ thing=#{user.inspect} gate_name=actor ]") end - it "logs adapter value" do + it 'logs adapter value' do adapter_line = find_line('Flipper feature(search) adapter(memory) enable') - expect(adapter_line).to include("[ result=") + expect(adapter_line).to include('[ result=') end end - context "getting all the features from the adapter" do + context 'getting all the features from the adapter' do before do clear_logs flipper.features end - it "logs adapter calls" do + it 'logs adapter calls' do adapter_line = find_line('Flipper adapter(memory) features') expect(adapter_line).to include('[ result=') end diff --git a/spec/flipper/instrumentation/metriks_subscriber_spec.rb b/spec/flipper/instrumentation/metriks_subscriber_spec.rb index db5a73698..b6a3a2ac7 100644 --- a/spec/flipper/instrumentation/metriks_subscriber_spec.rb +++ b/spec/flipper/instrumentation/metriks_subscriber_spec.rb @@ -3,13 +3,13 @@ require 'flipper/instrumentation/metriks' RSpec.describe Flipper::Instrumentation::MetriksSubscriber do - let(:adapter) { + let(:adapter) do memory = Flipper::Adapters::Memory.new - Flipper::Adapters::Instrumented.new(memory, :instrumenter => ActiveSupport::Notifications) - } - let(:flipper) { - Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications) - } + Flipper::Adapters::Instrumented.new(memory, instrumenter: ActiveSupport::Notifications) + end + let(:flipper) do + Flipper.new(adapter, instrumenter: ActiveSupport::Notifications) + end let(:user) { user = Struct.new(:flipper_id).new('1') } @@ -17,36 +17,36 @@ Metriks::Registry.default.clear end - context "for enabled feature" do - it "updates feature metrics when calls happen" do + context 'for enabled feature' do + it 'updates feature metrics when calls happen' do flipper[:stats].enable(user) - expect(Metriks.timer("flipper.feature_operation.enable").count).to be(1) + expect(Metriks.timer('flipper.feature_operation.enable').count).to be(1) flipper[:stats].enabled?(user) - expect(Metriks.timer("flipper.feature_operation.enabled").count).to be(1) - expect(Metriks.meter("flipper.feature.stats.enabled").count).to be(1) + expect(Metriks.timer('flipper.feature_operation.enabled').count).to be(1) + expect(Metriks.meter('flipper.feature.stats.enabled').count).to be(1) end end - context "for disabled feature" do - it "updates feature metrics when calls happen" do + context 'for disabled feature' do + it 'updates feature metrics when calls happen' do flipper[:stats].disable(user) - expect(Metriks.timer("flipper.feature_operation.disable").count).to be(1) + expect(Metriks.timer('flipper.feature_operation.disable').count).to be(1) flipper[:stats].enabled?(user) - expect(Metriks.timer("flipper.feature_operation.enabled").count).to be(1) - expect(Metriks.meter("flipper.feature.stats.disabled").count).to be(1) + expect(Metriks.timer('flipper.feature_operation.enabled').count).to be(1) + expect(Metriks.meter('flipper.feature.stats.disabled').count).to be(1) end end - it "updates adapter metrics when calls happen" do + it 'updates adapter metrics when calls happen' do flipper[:stats].enable(user) - expect(Metriks.timer("flipper.adapter.memory.enable").count).to be(1) + expect(Metriks.timer('flipper.adapter.memory.enable').count).to be(1) flipper[:stats].enabled?(user) - expect(Metriks.timer("flipper.adapter.memory.get").count).to be(1) + expect(Metriks.timer('flipper.adapter.memory.get').count).to be(1) flipper[:stats].disable(user) - expect(Metriks.timer("flipper.adapter.memory.disable").count).to be(1) + expect(Metriks.timer('flipper.adapter.memory.disable').count).to be(1) end end diff --git a/spec/flipper/instrumentation/statsd_subscriber_spec.rb b/spec/flipper/instrumentation/statsd_subscriber_spec.rb index 5539f23b9..db6a38629 100644 --- a/spec/flipper/instrumentation/statsd_subscriber_spec.rb +++ b/spec/flipper/instrumentation/statsd_subscriber_spec.rb @@ -7,13 +7,13 @@ RSpec.describe Flipper::Instrumentation::StatsdSubscriber do let(:statsd_client) { Statsd.new } let(:socket) { FakeUDPSocket.new } - let(:adapter) { + let(:adapter) do memory = Flipper::Adapters::Memory.new - Flipper::Adapters::Instrumented.new(memory, :instrumenter => ActiveSupport::Notifications) - } - let(:flipper) { - Flipper.new(adapter, :instrumenter => ActiveSupport::Notifications) - } + Flipper::Adapters::Instrumented.new(memory, instrumenter: ActiveSupport::Notifications) + end + let(:flipper) do + Flipper.new(adapter, instrumenter: ActiveSupport::Notifications) + end let(:user) { user = Struct.new(:flipper_id).new('1') } @@ -38,8 +38,8 @@ def assert_counter(metric) expect(result).not_to be_nil end - context "for enabled feature" do - it "updates feature metrics when calls happen" do + context 'for enabled feature' do + it 'updates feature metrics when calls happen' do flipper[:stats].enable(user) assert_timer 'flipper.feature_operation.enable' @@ -49,8 +49,8 @@ def assert_counter(metric) end end - context "for disabled feature" do - it "updates feature metrics when calls happen" do + context 'for disabled feature' do + it 'updates feature metrics when calls happen' do flipper[:stats].disable(user) assert_timer 'flipper.feature_operation.disable' @@ -60,7 +60,7 @@ def assert_counter(metric) end end - it "updates adapter metrics when calls happen" do + it 'updates adapter metrics when calls happen' do flipper[:stats].enable(user) assert_timer 'flipper.adapter.memory.enable' diff --git a/spec/flipper/instrumenters/memory_spec.rb b/spec/flipper/instrumenters/memory_spec.rb index 0990555ea..26f769308 100644 --- a/spec/flipper/instrumenters/memory_spec.rb +++ b/spec/flipper/instrumenters/memory_spec.rb @@ -2,18 +2,18 @@ require 'flipper/instrumenters/memory' RSpec.describe Flipper::Instrumenters::Memory do - describe "#initialize" do - it "sets events to empty array" do + describe '#initialize' do + it 'sets events to empty array' do instrumenter = described_class.new expect(instrumenter.events).to eq([]) end end - describe "#instrument" do - it "adds to events" do + describe '#instrument' do + it 'adds to events' do instrumenter = described_class.new name = 'user.signup' - payload = {:email => 'john@doe.com'} + payload = { email: 'john@doe.com' } block_result = :yielded result = instrumenter.instrument(name, payload) { block_result } diff --git a/spec/flipper/instrumenters/noop_spec.rb b/spec/flipper/instrumenters/noop_spec.rb index 07aecb0da..a6426ba5d 100644 --- a/spec/flipper/instrumenters/noop_spec.rb +++ b/spec/flipper/instrumenters/noop_spec.rb @@ -2,19 +2,19 @@ require 'flipper/instrumenters/noop' RSpec.describe Flipper::Instrumenters::Noop do - describe ".instrument" do - context "with name" do - it "yields block" do + describe '.instrument' do + context 'with name' do + it 'yields block' do yielded = false described_class.instrument(:foo) { yielded = true } expect(yielded).to eq(true) end end - context "with name and payload" do - it "yields block" do + context 'with name and payload' do + it 'yields block' do yielded = false - described_class.instrument(:foo, {:pay => :load}) { yielded = true } + described_class.instrument(:foo, pay: :load) { yielded = true } expect(yielded).to eq(true) end end diff --git a/spec/flipper/middleware/memoizer_spec.rb b/spec/flipper/middleware/memoizer_spec.rb index 8142323ae..38c8b22ce 100644 --- a/spec/flipper/middleware/memoizer_spec.rb +++ b/spec/flipper/middleware/memoizer_spec.rb @@ -8,29 +8,29 @@ include Rack::Test::Methods let(:memory_adapter) { Flipper::Adapters::Memory.new } - let(:adapter) { + let(:adapter) do Flipper::Adapters::OperationLogger.new(memory_adapter) - } - let(:flipper) { Flipper.new(adapter) } + end + let(:flipper) { Flipper.new(adapter) } after do flipper.adapter.memoize = nil end - RSpec.shared_examples_for "flipper middleware" do - it "delegates" do + RSpec.shared_examples_for 'flipper middleware' do + it 'delegates' do called = false - app = lambda { |env| + app = lambda do |_env| called = true [200, {}, nil] - } + end middleware = described_class.new app, flipper middleware.call({}) expect(called).to eq(true) end - it "disables local cache after body close" do - app = lambda { |env| [200, {}, []] } + it 'disables local cache after body close' do + app = ->(_env) { [200, {}, []] } middleware = described_class.new app, flipper body = middleware.call({}).last @@ -39,8 +39,8 @@ expect(flipper.adapter.memoizing?).to eq(false) end - it "clears local cache after body close" do - app = lambda { |env| [200, {}, []] } + it 'clears local cache after body close' do + app = ->(_env) { [200, {}, []] } middleware = described_class.new app, flipper body = middleware.call({}).last @@ -49,25 +49,29 @@ expect(flipper.adapter.cache).to be_empty end - it "clears the local cache with a successful request" do + it 'clears the local cache with a successful request' do flipper.adapter.cache['hello'] = 'world' get '/' expect(flipper.adapter.cache).to be_empty end - it "clears the local cache even when the request raises an error" do + it 'clears the local cache even when the request raises an error' do flipper.adapter.cache['hello'] = 'world' - get '/fail' rescue nil + begin + get '/fail' + rescue + nil + end expect(flipper.adapter.cache).to be_empty end - it "caches getting a feature for duration of request" do + it 'caches getting a feature for duration of request' do flipper[:stats].enable # clear the log of operations adapter.reset - app = lambda { |env| + app = lambda do |_env| flipper[:stats].enabled? flipper[:stats].enabled? flipper[:stats].enabled? @@ -75,7 +79,7 @@ flipper[:stats].enabled? flipper[:stats].enabled? [200, {}, []] - } + end middleware = described_class.new app, flipper middleware.call({}) @@ -84,8 +88,8 @@ end end - context "with flipper instance" do - let(:app) { + context 'with flipper instance' do + let(:app) do # ensure scoped for builder block, annoying... instance = flipper middleware = described_class @@ -93,21 +97,21 @@ Rack::Builder.new do use middleware, instance - map "/" do - run lambda {|env| [200, {}, []] } + map '/' do + run ->(_env) { [200, {}, []] } end - map "/fail" do - run lambda {|env| raise "FAIL!" } + map '/fail' do + run ->(_env) { raise 'FAIL!' } end end.to_app - } + end - include_examples "flipper middleware" + include_examples 'flipper middleware' end - context "with preload_all" do - let(:app) { + context 'with preload_all' do + let(:app) do # ensure scoped for builder block, annoying... instance = flipper middleware = described_class @@ -115,32 +119,32 @@ Rack::Builder.new do use middleware, instance, preload_all: true - map "/" do - run lambda {|env| [200, {}, []] } + map '/' do + run ->(_env) { [200, {}, []] } end - map "/fail" do - run lambda {|env| raise "FAIL!" } + map '/fail' do + run ->(_env) { raise 'FAIL!' } end end.to_app - } + end - include_examples "flipper middleware" + include_examples 'flipper middleware' - it "eagerly caches known features for duration of request" do + it 'eagerly caches known features for duration of request' do flipper[:stats].enable flipper[:shiny].enable # clear the log of operations adapter.reset - app = lambda { |env| + app = lambda do |_env| flipper[:stats].enabled? flipper[:stats].enabled? flipper[:shiny].enabled? flipper[:shiny].enabled? [200, {}, []] - } + end middleware = described_class.new app, flipper, preload_all: true middleware.call({}) @@ -150,15 +154,15 @@ expect(adapter.last(:get_multi).args).to eq([[flipper[:stats], flipper[:shiny]]]) end - it "caches unknown features for duration of request" do + it 'caches unknown features for duration of request' do # clear the log of operations adapter.reset - app = lambda { |env| + app = lambda do |_env| flipper[:other].enabled? flipper[:other].enabled? [200, {}, []] - } + end middleware = described_class.new app, flipper, preload_all: true middleware.call({}) @@ -168,57 +172,57 @@ end end - context "with preload specific" do - let(:app) { + context 'with preload specific' do + let(:app) do # ensure scoped for builder block, annoying... instance = flipper middleware = described_class Rack::Builder.new do - use middleware, instance, preload: %i{stats} + use middleware, instance, preload: %i(stats) - map "/" do - run lambda {|env| [200, {}, []] } + map '/' do + run ->(_env) { [200, {}, []] } end - map "/fail" do - run lambda {|env| raise "FAIL!" } + map '/fail' do + run ->(_env) { raise 'FAIL!' } end end.to_app - } + end - include_examples "flipper middleware" + include_examples 'flipper middleware' - it "eagerly caches specified features for duration of request" do + it 'eagerly caches specified features for duration of request' do # clear the log of operations adapter.reset - app = lambda { |env| + app = lambda do |_env| flipper[:stats].enabled? flipper[:stats].enabled? flipper[:shiny].enabled? flipper[:shiny].enabled? [200, {}, []] - } + end - middleware = described_class.new app, flipper, preload: %i{stats} + middleware = described_class.new app, flipper, preload: %i(stats) middleware.call({}) expect(adapter.count(:get_multi)).to be(1) expect(adapter.last(:get_multi).args).to eq([[flipper[:stats]]]) end - it "caches unknown features for duration of request" do + it 'caches unknown features for duration of request' do # clear the log of operations adapter.reset - app = lambda { |env| + app = lambda do |_env| flipper[:other].enabled? flipper[:other].enabled? [200, {}, []] - } + end - middleware = described_class.new app, flipper, preload: %i{stats} + middleware = described_class.new app, flipper, preload: %i(stats) middleware.call({}) expect(adapter.count(:get)).to be(1) @@ -226,10 +230,10 @@ end end - context "when an app raises an exception" do - it "resets memoize" do + context 'when an app raises an exception' do + it 'resets memoize' do begin - app = lambda { |env| raise } + app = ->(_env) { raise } middleware = described_class.new app, flipper middleware.call({}) rescue RuntimeError @@ -238,25 +242,25 @@ end end - context "with block that yields flipper instance" do - let(:app) { + context 'with block that yields flipper instance' do + let(:app) do # ensure scoped for builder block, annoying... instance = flipper middleware = described_class Rack::Builder.new do - use middleware, lambda { instance } + use middleware, -> { instance } - map "/" do - run lambda {|env| [200, {}, []] } + map '/' do + run ->(_env) { [200, {}, []] } end - map "/fail" do - run lambda {|env| raise "FAIL!" } + map '/fail' do + run ->(_env) { raise 'FAIL!' } end end.to_app - } + end - include_examples "flipper middleware" + include_examples 'flipper middleware' end end diff --git a/spec/flipper/registry_spec.rb b/spec/flipper/registry_spec.rb index 8d1bf3fda..5bfa4fa4b 100644 --- a/spec/flipper/registry_spec.rb +++ b/spec/flipper/registry_spec.rb @@ -2,123 +2,121 @@ require 'flipper/registry' RSpec.describe Flipper::Registry do - subject { Flipper::Registry.new(source) } + subject { described_class.new(source) } let(:source) { {} } - describe "#add" do - it "adds to source" do + describe '#add' do + it 'adds to source' do value = 'thing' subject.add(:admins, value) expect(source[:admins]).to eq(value) end - it "converts key to symbol" do + it 'converts key to symbol' do value = 'thing' subject.add('admins', value) expect(source[:admins]).to eq(value) end - it "raises exception if key already registered" do + it 'raises exception if key already registered' do subject.add(:admins, 'thing') - expect { + expect do subject.add('admins', 'again') - }.to raise_error(Flipper::Registry::DuplicateKey) + end.to raise_error(Flipper::Registry::DuplicateKey) end end - describe "#get" do - context "key registered" do + describe '#get' do + context 'key registered' do before do source[:admins] = 'thing' end - it "returns value" do + it 'returns value' do expect(subject.get(:admins)).to eq('thing') end - it "returns value if given string key" do + it 'returns value if given string key' do expect(subject.get('admins')).to eq('thing') end end - context "key not registered" do - it "raises key not found" do - expect { + context 'key not registered' do + it 'raises key not found' do + expect do subject.get(:admins) - }.to raise_error(Flipper::Registry::KeyNotFound) + end.to raise_error(Flipper::Registry::KeyNotFound) end end end - describe "#key?" do + describe '#key?' do before do - source[:admins] = "admins" + source[:admins] = 'admins' end - it "returns true if the key exists" do + it 'returns true if the key exists' do expect(subject.key?(:admins)).to eq true end - it "returns false if the key does not exists" do + it 'returns false if the key does not exists' do expect(subject.key?(:unknown_key)).to eq false end end - describe "#each" do + describe '#each' do before do source[:admins] = 'admins' source[:devs] = 'devs' end - it "iterates source keys and values" do + it 'iterates source keys and values' do results = {} subject.each do |key, value| results[key] = value end - expect(results).to eq({ - :admins => 'admins', - :devs => 'devs', - }) + expect(results).to eq(admins: 'admins', + devs: 'devs') end end - describe "#keys" do + describe '#keys' do before do source[:admins] = 'admins' source[:devs] = 'devs' end - it "returns the keys" do - expect(subject.keys.map(&:to_s).sort).to eq(['admins', 'devs']) + it 'returns the keys' do + expect(subject.keys.map(&:to_s).sort).to eq(%w(admins devs)) end - it "returns the keys as symbols" do + it 'returns the keys as symbols' do subject.keys.each do |key| expect(key).to be_instance_of(Symbol) end end end - describe "#values" do + describe '#values' do before do source[:admins] = 'admins' source[:devs] = 'devs' end - it "returns the values" do - expect(subject.values.map(&:to_s).sort).to eq(['admins', 'devs']) + it 'returns the values' do + expect(subject.values.map(&:to_s).sort).to eq(%w(admins devs)) end end - describe "enumeration" do + describe 'enumeration' do before do source[:admins] = 'admins' source[:devs] = 'devs' end - it "works" do + it 'works' do keys = [] values = [] @@ -127,17 +125,17 @@ values << value end - expect(keys.map(&:to_s).sort).to eq(['admins', 'devs']) - expect(values.sort).to eq(['admins', 'devs']) + expect(keys.map(&:to_s).sort).to eq(%w(admins devs)) + expect(values.sort).to eq(%w(admins devs)) end end - describe "#clear" do + describe '#clear' do before do source[:admins] = 'admins' end - it "clears the source" do + it 'clears the source' do subject.clear expect(source).to be_empty end diff --git a/spec/flipper/typecast_spec.rb b/spec/flipper/typecast_spec.rb index a5edba8d8..ff550c0ae 100644 --- a/spec/flipper/typecast_spec.rb +++ b/spec/flipper/typecast_spec.rb @@ -4,15 +4,15 @@ RSpec.describe Flipper::Typecast do { nil => false, - "" => false, + '' => false, 0 => false, 1 => true, - "0" => false, - "1" => true, + '0' => false, + '1' => true, true => true, false => false, - "true" => true, - "false" => false, + 'true' => true, + 'false' => false, }.each do |value, expected| context "#to_boolean for #{value.inspect}" do it "returns #{expected}" do @@ -23,11 +23,11 @@ { nil => 0, - "" => 0, + '' => 0, 0 => 0, 1 => 1, - "1" => 1, - "99" => 99, + '1' => 1, + '99' => 99, }.each do |value, expected| context "#to_integer for #{value.inspect}" do it "returns #{expected}" do @@ -38,9 +38,9 @@ { nil => Set.new, - "" => Set.new, + '' => Set.new, Set.new([1, 2]) => Set.new([1, 2]), - [1, 2] => Set.new([1, 2]) + [1, 2] => Set.new([1, 2]), }.each do |value, expected| context "#to_set for #{value.inspect}" do it "returns #{expected}" do @@ -49,15 +49,15 @@ end end - it "raises argument error for integer value that cannot be converted to an integer" do - expect { - described_class.to_integer(["asdf"]) - }.to raise_error(ArgumentError, %Q(["asdf"] cannot be converted to an integer)) + it 'raises argument error for integer value that cannot be converted to an integer' do + expect do + described_class.to_integer(['asdf']) + end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer)) end - it "raises argument error for set value that cannot be converted to a set" do - expect { - described_class.to_set("asdf") - }.to raise_error(ArgumentError, %Q("asdf" cannot be converted to a set)) + it 'raises argument error for set value that cannot be converted to a set' do + expect do + described_class.to_set('asdf') + end.to raise_error(ArgumentError, %("asdf" cannot be converted to a set)) end end diff --git a/spec/flipper/types/actor_spec.rb b/spec/flipper/types/actor_spec.rb index e622ec69a..6abec0b9f 100644 --- a/spec/flipper/types/actor_spec.rb +++ b/spec/flipper/types/actor_spec.rb @@ -2,13 +2,13 @@ require 'flipper/types/actor' RSpec.describe Flipper::Types::Actor do - subject { + subject do thing = thing_class.new('2') described_class.new(thing) - } + end - let(:thing_class) { - Class.new { + let(:thing_class) do + Class.new do attr_reader :flipper_id def initialize(flipper_id) @@ -18,37 +18,37 @@ def initialize(flipper_id) def admin? true end - } - } + end + end - describe ".wrappable?" do - it "returns true if actor" do + describe '.wrappable?' do + it 'returns true if actor' do thing = thing_class.new('1') actor = described_class.new(thing) expect(described_class.wrappable?(actor)).to eq(true) end - it "returns true if responds to flipper_id" do + it 'returns true if responds to flipper_id' do thing = thing_class.new(10) expect(described_class.wrappable?(thing)).to eq(true) end - it "returns false if nil" do + it 'returns false if nil' do expect(described_class.wrappable?(nil)).to be(false) end end - describe ".wrap" do - context "for actor" do - it "returns actor" do + describe '.wrap' do + context 'for actor' do + it 'returns actor' do actor = described_class.wrap(subject) expect(actor).to be_instance_of(described_class) expect(actor).to be(subject) end end - context "for other thing" do - it "returns actor" do + context 'for other thing' do + it 'returns actor' do thing = thing_class.new('1') actor = described_class.wrap(thing) expect(actor).to be_instance_of(described_class) @@ -56,57 +56,58 @@ def admin? end end - it "initializes with thing that responds to id" do + it 'initializes with thing that responds to id' do thing = thing_class.new('1') actor = described_class.new(thing) expect(actor.value).to eq('1') end - it "raises error when initialized with nil" do - expect { + it 'raises error when initialized with nil' do + expect do described_class.new(nil) - }.to raise_error(ArgumentError) + end.to raise_error(ArgumentError) end - it "raises error when initalized with non-wrappable object" do + it 'raises error when initalized with non-wrappable object' do unwrappable_thing = Struct.new(:id).new(1) - expect { + expect do described_class.new(unwrappable_thing) - }.to raise_error(ArgumentError, "#{unwrappable_thing.inspect} must respond to flipper_id, but does not") + end.to raise_error(ArgumentError, + "#{unwrappable_thing.inspect} must respond to flipper_id, but does not") end - it "converts id to string" do + it 'converts id to string' do thing = thing_class.new(2) actor = described_class.new(thing) expect(actor.value).to eq('2') end - it "proxies everything to thing" do + it 'proxies everything to thing' do thing = thing_class.new(10) actor = described_class.new(thing) expect(actor.admin?).to eq(true) end - it "exposes thing" do + it 'exposes thing' do thing = thing_class.new(10) actor = described_class.new(thing) expect(actor.thing).to be(thing) end - describe "#respond_to?" do - it "returns true if responds to method" do + describe '#respond_to?' do + it 'returns true if responds to method' do thing = thing_class.new('1') actor = described_class.new(thing) expect(actor.respond_to?(:value)).to eq(true) end - it "returns true if thing responds to method" do + it 'returns true if thing responds to method' do thing = thing_class.new(10) actor = described_class.new(thing) expect(actor.respond_to?(:admin?)).to eq(true) end - it "returns false if does not respond to method and thing does not respond to method" do + it 'returns false if does not respond to method and thing does not respond to method' do thing = thing_class.new(10) actor = described_class.new(thing) expect(actor.respond_to?(:frankenstein)).to eq(false) diff --git a/spec/flipper/types/boolean_spec.rb b/spec/flipper/types/boolean_spec.rb index 02b0259e3..d82f433f0 100644 --- a/spec/flipper/types/boolean_spec.rb +++ b/spec/flipper/types/boolean_spec.rb @@ -2,23 +2,23 @@ require 'flipper/types/boolean' RSpec.describe Flipper::Types::Boolean do - it "defaults value to true" do - boolean = Flipper::Types::Boolean.new + it 'defaults value to true' do + boolean = described_class.new expect(boolean.value).to be(true) end - it "allows overriding default value" do - boolean = Flipper::Types::Boolean.new(false) + it 'allows overriding default value' do + boolean = described_class.new(false) expect(boolean.value).to be(false) end - it "returns true for nil value" do - boolean = Flipper::Types::Boolean.new(nil) + it 'returns true for nil value' do + boolean = described_class.new(nil) expect(boolean.value).to be(true) end - it "typecasts value" do - boolean = Flipper::Types::Boolean.new(1) + it 'typecasts value' do + boolean = described_class.new(1) expect(boolean.value).to be(true) end end diff --git a/spec/flipper/types/group_spec.rb b/spec/flipper/types/group_spec.rb index e6036972b..df95b444f 100644 --- a/spec/flipper/types/group_spec.rb +++ b/spec/flipper/types/group_spec.rb @@ -2,85 +2,85 @@ require 'flipper/types/group' RSpec.describe Flipper::Types::Group do - let(:fake_context) { double("FeatureCheckContext") } + let(:fake_context) { double('FeatureCheckContext') } subject do - Flipper.register(:admins) { |actor| actor.admin? } + Flipper.register(:admins, &:admin?) end - describe ".wrap" do - context "with group instance" do - it "returns group instance" do + describe '.wrap' do + context 'with group instance' do + it 'returns group instance' do expect(described_class.wrap(subject)).to eq(subject) end end - context "with Symbol group name" do - it "returns group instance" do + context 'with Symbol group name' do + it 'returns group instance' do expect(described_class.wrap(subject.name)).to eq(subject) end end - context "with String group name" do - it "returns group instance" do + context 'with String group name' do + it 'returns group instance' do expect(described_class.wrap(subject.name.to_s)).to eq(subject) end end end - it "initializes with name" do - group = Flipper::Types::Group.new(:admins) - expect(group).to be_instance_of(Flipper::Types::Group) + it 'initializes with name' do + group = described_class.new(:admins) + expect(group).to be_instance_of(described_class) end - describe "#name" do - it "returns name" do + describe '#name' do + it 'returns name' do expect(subject.name).to eq(:admins) end end - describe "#match?" do - let(:admin_actor) { double('Actor', :admin? => true) } - let(:non_admin_actor) { double('Actor', :admin? => false) } + describe '#match?' do + let(:admin_actor) { double('Actor', admin?: true) } + let(:non_admin_actor) { double('Actor', admin?: false) } - it "returns true if block matches" do + it 'returns true if block matches' do expect(subject.match?(admin_actor, fake_context)).to eq(true) end - it "returns false if block does not match" do + it 'returns false if block does not match' do expect(subject.match?(non_admin_actor, fake_context)).to eq(false) end - it "returns true for truthy block results" do - group = Flipper::Types::Group.new(:examples) do |actor| + it 'returns true for truthy block results' do + group = described_class.new(:examples) do |actor| actor.email =~ /@example\.com/ end - expect(group.match?(double('Actor', :email => "foo@example.com"), fake_context)).to be_truthy + expect(group.match?(double('Actor', email: 'foo@example.com'), fake_context)).to be_truthy end - it "returns false for falsey block results" do - group = Flipper::Types::Group.new(:examples) do |actor| + it 'returns false for falsey block results' do + group = described_class.new(:examples) do |_actor| nil end expect(group.match?(double('Actor'), fake_context)).to be_falsey end - it "can yield without context as block argument" do + it 'can yield without context as block argument' do context = Flipper::FeatureCheckContext.new( feature_name: :my_feature, values: Flipper::GateValues.new({}), - thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)), + thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)) ) group = Flipper.register(:group_with_context) { |actor| actor } yielded_actor = group.match?(admin_actor, context) expect(yielded_actor).to be(admin_actor) end - it "can yield with context as block argument" do + it 'can yield with context as block argument' do context = Flipper::FeatureCheckContext.new( feature_name: :my_feature, values: Flipper::GateValues.new({}), - thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)), + thing: Flipper::Types::Actor.new(Struct.new(:flipper_id).new(1)) ) group = Flipper.register(:group_with_context) { |actor, context| [actor, context] } yielded_actor, yielded_context = group.match?(admin_actor, context) diff --git a/spec/flipper/types/percentage_spec.rb b/spec/flipper/types/percentage_spec.rb index baacadb4d..6d6a826a3 100644 --- a/spec/flipper/types/percentage_spec.rb +++ b/spec/flipper/types/percentage_spec.rb @@ -2,45 +2,45 @@ require 'flipper/types/percentage_of_actors' RSpec.describe Flipper::Types::Percentage do - subject { + subject do described_class.new(5) - } + end it_should_behave_like 'a percentage' - describe ".wrap" do - context "with percentage instance" do - it "returns percentage instance" do + describe '.wrap' do + context 'with percentage instance' do + it 'returns percentage instance' do expect(described_class.wrap(subject)).to eq(subject) end end - context "with Integer" do - it "returns percentage instance" do + context 'with Integer' do + it 'returns percentage instance' do expect(described_class.wrap(subject.value)).to eq(subject) end end - context "with String" do - it "returns percentage instance" do + context 'with String' do + it 'returns percentage instance' do expect(described_class.wrap(subject.value.to_s)).to eq(subject) end end end - describe "#eql?" do - it "returns true for same class and value" do + describe '#eql?' do + it 'returns true for same class and value' do expect(subject.eql?(described_class.new(subject.value))).to eq(true) end - it "returns false for different value" do + it 'returns false for different value' do expect(subject.eql?(described_class.new(subject.value + 1))).to eq(false) end - it "returns false for different class" do + it 'returns false for different class' do expect(subject.eql?(Object.new)).to eq(false) end - it "is aliased to ==" do + it 'is aliased to ==' do expect((subject == described_class.new(subject.value))).to eq(true) end end diff --git a/spec/flipper/ui/action_spec.rb b/spec/flipper/ui/action_spec.rb index 7bcbb9b0f..388ace6e7 100644 --- a/spec/flipper/ui/action_spec.rb +++ b/spec/flipper/ui/action_spec.rb @@ -1,59 +1,59 @@ require 'helper' RSpec.describe Flipper::UI::Action do - let(:action_subclass) { + let(:action_subclass) do Class.new(described_class) do def noooope - raise "should never run this" + raise 'should never run this' end def get - [200, {}, "get"] + [200, {}, 'get'] end def post - [200, {}, "post"] + [200, {}, 'post'] end def put - [200, {}, "put"] + [200, {}, 'put'] end def delete - [200, {}, "delete"] + [200, {}, 'delete'] end end - } + end it "won't run method that isn't whitelisted" do - fake_request = Struct.new(:request_method, :env, :session).new("NOOOOPE", {}, {}) + fake_request = Struct.new(:request_method, :env, :session).new('NOOOOPE', {}, {}) action = action_subclass.new(flipper, fake_request) - expect { + expect do action.run - }.to raise_error(Flipper::UI::RequestMethodNotSupported) + end.to raise_error(Flipper::UI::RequestMethodNotSupported) end - it "will run get" do - fake_request = Struct.new(:request_method, :env, :session).new("GET", {}, {}) + it 'will run get' do + fake_request = Struct.new(:request_method, :env, :session).new('GET', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "get"]) + expect(action.run).to eq([200, {}, 'get']) end - it "will run post" do - fake_request = Struct.new(:request_method, :env, :session).new("POST", {}, {}) + it 'will run post' do + fake_request = Struct.new(:request_method, :env, :session).new('POST', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "post"]) + expect(action.run).to eq([200, {}, 'post']) end - it "will run put" do - fake_request = Struct.new(:request_method, :env, :session).new("PUT", {}, {}) + it 'will run put' do + fake_request = Struct.new(:request_method, :env, :session).new('PUT', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "put"]) + expect(action.run).to eq([200, {}, 'put']) end - it "will run delete" do - fake_request = Struct.new(:request_method, :env, :session).new("DELETE", {}, {}) + it 'will run delete' do + fake_request = Struct.new(:request_method, :env, :session).new('DELETE', {}, {}) action = action_subclass.new(flipper, fake_request) - expect(action.run).to eq([200, {}, "delete"]) + expect(action.run).to eq([200, {}, 'delete']) end end diff --git a/spec/flipper/ui/actions/actors_gate_spec.rb b/spec/flipper/ui/actions/actors_gate_spec.rb index c10ffad3f..948acca5b 100644 --- a/spec/flipper/ui/actions/actors_gate_spec.rb +++ b/spec/flipper/ui/actions/actors_gate_spec.rb @@ -1,107 +1,111 @@ require 'helper' RSpec.describe Flipper::UI::Actions::ActorsGate do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "GET /features/:feature/actors" do + describe 'GET /features/:feature/actors' do before do - get "features/search/actors" + get 'features/search/actors' end - it "responds with success" do + it 'responds with success' do expect(last_response.status).to be(200) end - it "renders add new actor form" do + it 'renders add new actor form' do expect(last_response.body).to include('
') end end - describe "POST /features/:feature/actors" do - context "enabling an actor" do - let(:value) { "User:6" } + describe 'POST /features/:feature/actors' do + context 'enabling an actor' do + let(:value) { 'User:6' } before do - post "features/search/actors", - {"value" => value, "operation" => "enable", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/actors', + { 'value' => value, 'operation' => 'enable', 'authenticity_token' => token }, + 'rack.session' => session end - it "adds item to members" do - expect(flipper[:search].actors_value).to include("User:6") + it 'adds item to members' do + expect(flipper[:search].actors_value).to include('User:6') end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end context 'value contains whitespace' do - let(:value) { " User:6 " } + let(:value) { ' User:6 ' } - it "adds item without whitespace" do - expect(flipper[:search].actors_value).to include("User:6") + it 'adds item without whitespace' do + expect(flipper[:search].actors_value).to include('User:6') end end - context "for an invalid actor value" do - context "empty value" do - let(:value) { "" } + context 'for an invalid actor value' do + context 'empty value' do + let(:value) { '' } - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search/actors?error=%22%22+is+not+a+valid+actor+value.") + expect(last_response.headers['Location']).to eq('/features/search/actors?error=%22%22+is+not+a+valid+actor+value.') end + # rubocop:enable Metrics/LineLength end - context "nil value" do + context 'nil value' do let(:value) { nil } - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search/actors?error=%22%22+is+not+a+valid+actor+value.") + expect(last_response.headers['Location']).to eq('/features/search/actors?error=%22%22+is+not+a+valid+actor+value.') end + # rubocop:enable Metrics/LineLength end end end - context "disabling an actor" do - let(:value) { "User:6" } + context 'disabling an actor' do + let(:value) { 'User:6' } before do - flipper[:search].enable_actor Flipper::UI::Actor.new("User:6") - post "features/search/actors", - {"value" => value, "operation" => "disable", "authenticity_token" => token}, - "rack.session" => session + flipper[:search].enable_actor Flipper::UI::Actor.new('User:6') + post 'features/search/actors', + { 'value' => value, 'operation' => 'disable', 'authenticity_token' => token }, + 'rack.session' => session end - it "removes item from members" do - expect(flipper[:search].actors_value).not_to include("User:6") + it 'removes item from members' do + expect(flipper[:search].actors_value).not_to include('User:6') end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end context 'value contains whitespace' do - let(:value) { " User:6 " } + let(:value) { ' User:6 ' } - it "removes item whitout whitespace" do - expect(flipper[:search].actors_value).not_to include("User:6") + it 'removes item whitout whitespace' do + expect(flipper[:search].actors_value).not_to include('User:6') end end end diff --git a/spec/flipper/ui/actions/add_feature_spec.rb b/spec/flipper/ui/actions/add_feature_spec.rb index 173d4fa1b..af7ed1fde 100644 --- a/spec/flipper/ui/actions/add_feature_spec.rb +++ b/spec/flipper/ui/actions/add_feature_spec.rb @@ -1,43 +1,43 @@ require 'helper' RSpec.describe Flipper::UI::Actions::AddFeature do - describe "GET /features/new with feature_creation_enabled set to true" do + describe 'GET /features/new with feature_creation_enabled set to true' do before do @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled Flipper::UI.feature_creation_enabled = true - get "/features/new" + get '/features/new' end after do Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled end - it "responds with success" do + it 'responds with success' do expect(last_response.status).to be(200) end - it "renders template" do + it 'renders template' do expect(last_response.body).to include('') end end - describe "GET /features/new with feature_creation_enabled set to false" do + describe 'GET /features/new with feature_creation_enabled set to false' do before do @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled Flipper::UI.feature_creation_enabled = false - get "/features/new" + get '/features/new' end after do Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled end - it "returns 403" do + it 'returns 403' do expect(last_response.status).to be(403) end - it "renders feature creation disabled template" do - expect(last_response.body).to include("Feature creation is disabled.") + it 'renders feature creation disabled template' do + expect(last_response.body).to include('Feature creation is disabled.') end end end diff --git a/spec/flipper/ui/actions/boolean_gate_spec.rb b/spec/flipper/ui/actions/boolean_gate_spec.rb index 03dedf4bd..33910ed0d 100644 --- a/spec/flipper/ui/actions/boolean_gate_spec.rb +++ b/spec/flipper/ui/actions/boolean_gate_spec.rb @@ -1,55 +1,55 @@ require 'helper' RSpec.describe Flipper::UI::Actions::BooleanGate do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "POST /features/:feature/boolean" do - context "with enable" do + describe 'POST /features/:feature/boolean' do + context 'with enable' do before do flipper.disable :search - post "features/search/boolean", - {"action" => "Enable", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/boolean', + { 'action' => 'Enable', 'authenticity_token' => token }, + 'rack.session' => session end - it "enables the feature" do + it 'enables the feature' do expect(flipper.enabled?(:search)).to be(true) end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end end - context "with disable" do + context 'with disable' do before do flipper.enable :search - post "features/search/boolean", - {"action" => "Disable", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/boolean', + { 'action' => 'Disable', 'authenticity_token' => token }, + 'rack.session' => session end - it "disables the feature" do + it 'disables the feature' do expect(flipper.enabled?(:search)).to be(false) end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end end end diff --git a/spec/flipper/ui/actions/feature_spec.rb b/spec/flipper/ui/actions/feature_spec.rb index 4b899ce36..1732a0648 100644 --- a/spec/flipper/ui/actions/feature_spec.rb +++ b/spec/flipper/ui/actions/feature_spec.rb @@ -1,74 +1,74 @@ require 'helper' RSpec.describe Flipper::UI::Actions::Feature do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "DELETE /features/:feature" do + describe 'DELETE /features/:feature' do before do flipper.enable :search - delete "/features/search", - {"authenticity_token" => token}, - "rack.session" => session + delete '/features/search', + { 'authenticity_token' => token }, + 'rack.session' => session end - it "removes feature" do - expect(flipper.features.map(&:key)).not_to include("search") + it 'removes feature' do + expect(flipper.features.map(&:key)).not_to include('search') end - it "redirects to features" do + it 'redirects to features' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features") + expect(last_response.headers['Location']).to eq('/features') end end - describe "POST /features/:feature with _method=DELETE" do + describe 'POST /features/:feature with _method=DELETE' do before do flipper.enable :search - post "/features/search", - {"_method" => "DELETE", "authenticity_token" => token}, - "rack.session" => session + post '/features/search', + { '_method' => 'DELETE', 'authenticity_token' => token }, + 'rack.session' => session end - it "removes feature" do - expect(flipper.features.map(&:key)).not_to include("search") + it 'removes feature' do + expect(flipper.features.map(&:key)).not_to include('search') end - it "redirects to features" do + it 'redirects to features' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features") + expect(last_response.headers['Location']).to eq('/features') end end - describe "GET /features/:feature" do + describe 'GET /features/:feature' do before do - get "/features/search" + get '/features/search' end - it "responds with success" do + it 'responds with success' do expect(last_response.status).to be(200) end - it "renders template" do - expect(last_response.body).to include("search") - expect(last_response.body).to include("Enable") - expect(last_response.body).to include("Disable") - expect(last_response.body).to include("Actors") - expect(last_response.body).to include("Groups") - expect(last_response.body).to include("Percentage of Time") - expect(last_response.body).to include("Percentage of Actors") + it 'renders template' do + expect(last_response.body).to include('search') + expect(last_response.body).to include('Enable') + expect(last_response.body).to include('Disable') + expect(last_response.body).to include('Actors') + expect(last_response.body).to include('Groups') + expect(last_response.body).to include('Percentage of Time') + expect(last_response.body).to include('Percentage of Actors') end end end diff --git a/spec/flipper/ui/actions/features_spec.rb b/spec/flipper/ui/actions/features_spec.rb index ad127766f..c71464286 100644 --- a/spec/flipper/ui/actions/features_spec.rb +++ b/spec/flipper/ui/actions/features_spec.rb @@ -1,47 +1,47 @@ require 'helper' RSpec.describe Flipper::UI::Actions::Features do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "GET /features" do + describe 'GET /features' do before do flipper[:stats].enable flipper[:search].enable - get "/features" + get '/features' end - it "responds with success" do + it 'responds with success' do expect(last_response.status).to be(200) end - it "renders template" do - expect(last_response.body).to include("stats") - expect(last_response.body).to include("search") + it 'renders template' do + expect(last_response.body).to include('stats') + expect(last_response.body).to include('search') end end - describe "POST /features" do - let(:feature_name) { "notifications_next" } + describe 'POST /features' do + let(:feature_name) { 'notifications_next' } before do @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled Flipper::UI.feature_creation_enabled = feature_creation_enabled - post "/features", - {"value" => feature_name, "authenticity_token" => token}, - "rack.session" => session + post '/features', + { 'value' => feature_name, 'authenticity_token' => token }, + 'rack.session' => session end after do @@ -51,48 +51,52 @@ context 'feature_creation_enabled set to true' do let(:feature_creation_enabled) { true } - it "adds feature" do - expect(flipper.features.map(&:key)).to include("notifications_next") + it 'adds feature' do + expect(flipper.features.map(&:key)).to include('notifications_next') end - it "redirects to feature" do + it 'redirects to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/notifications_next") + expect(last_response.headers['Location']).to eq('/features/notifications_next') end context 'feature name contains whitespace' do - let(:feature_name) { " notifications_next " } + let(:feature_name) { ' notifications_next ' } - it "adds feature without whitespace" do - expect(flipper.features.map(&:key)).to include("notifications_next") + it 'adds feature without whitespace' do + expect(flipper.features.map(&:key)).to include('notifications_next') end end - context "for an invalid feature name" do - context "empty feature name" do - let(:feature_name) { "" } + context 'for an invalid feature name' do + context 'empty feature name' do + let(:feature_name) { '' } - it "does not add feature" do + it 'does not add feature' do expect(flipper.features.map(&:key)).to eq([]) end - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/new?error=%22%22+is+not+a+valid+feature+name.") + expect(last_response.headers['Location']).to eq('/features/new?error=%22%22+is+not+a+valid+feature+name.') end + # rubocop:enable Metrics/LineLength end - context "nil feature name" do + context 'nil feature name' do let(:feature_name) { nil } - it "does not add feature" do + it 'does not add feature' do expect(flipper.features.map(&:key)).to eq([]) end - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/new?error=%22%22+is+not+a+valid+feature+name.") + expect(last_response.headers['Location']).to eq('/features/new?error=%22%22+is+not+a+valid+feature+name.') end + # rubocop:enable Metrics/LineLength end end end @@ -100,16 +104,16 @@ context 'feature_creation_enabled set to false' do let(:feature_creation_enabled) { false } - it "does not add feature" do - expect(flipper.features.map(&:key)).to_not include("notifications_next") + it 'does not add feature' do + expect(flipper.features.map(&:key)).not_to include('notifications_next') end - it "returns 403" do + it 'returns 403' do expect(last_response.status).to be(403) end - it "renders feature creation disabled template" do - expect(last_response.body).to include("Feature creation is disabled.") + it 'renders feature creation disabled template' do + expect(last_response.body).to include('Feature creation is disabled.') end end end diff --git a/spec/flipper/ui/actions/file_spec.rb b/spec/flipper/ui/actions/file_spec.rb index 61eab7d88..c5f0923ff 100644 --- a/spec/flipper/ui/actions/file_spec.rb +++ b/spec/flipper/ui/actions/file_spec.rb @@ -1,42 +1,42 @@ require 'helper' RSpec.describe Flipper::UI::Actions::File do - describe "GET /images/logo.png" do + describe 'GET /images/logo.png' do before do get '/images/logo.png' end - it "responds with 200" do + it 'responds with 200' do expect(last_response.status).to be(200) end end - describe "GET /css/application.css" do + describe 'GET /css/application.css' do before do get '/css/application.css' end - it "responds with 200" do + it 'responds with 200' do expect(last_response.status).to be(200) end end - describe "GET /fonts/bootstrap/glyphicons-halflings-regular.eot" do + describe 'GET /fonts/bootstrap/glyphicons-halflings-regular.eot' do before do get '/fonts/bootstrap/glyphicons-halflings-regular.eot' end - it "responds with 200" do + it 'responds with 200' do expect(last_response.status).to be(200) end end - describe "GET /octicons/octicons.eot" do + describe 'GET /octicons/octicons.eot' do before do get '/octicons/octicons.eot' end - it "responds with 200" do + it 'responds with 200' do expect(last_response.status).to be(200) end end diff --git a/spec/flipper/ui/actions/gate_spec.rb b/spec/flipper/ui/actions/gate_spec.rb index a06bf0910..c6bed7072 100644 --- a/spec/flipper/ui/actions/gate_spec.rb +++ b/spec/flipper/ui/actions/gate_spec.rb @@ -1,37 +1,39 @@ require 'helper' RSpec.describe Flipper::UI::Actions::Gate do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "POST /features/:feature/non-existent-gate" do + describe 'POST /features/:feature/non-existent-gate' do before do - post "/features/search/non-existent-gate", - {"authenticity_token" => token}, - "rack.session" => session + post '/features/search/non-existent-gate', + { 'authenticity_token' => token }, + 'rack.session' => session end - it "responds with redirect" do + it 'responds with redirect' do expect(last_response.status).to be(302) end - it "escapes error message" do - expect(last_response.headers["Location"]).to eq("/features/search?error=%22non-existent-gate%22+gate+does+not+exist+therefore+it+cannot+be+updated.") + # rubocop:disable Metrics/LineLength + it 'escapes error message' do + expect(last_response.headers['Location']).to eq('/features/search?error=%22non-existent-gate%22+gate+does+not+exist+therefore+it+cannot+be+updated.') end + # rubocop:enable Metrics/LineLength - it "renders error in template" do + it 'renders error in template' do follow_redirect! expect(last_response.body).to match(/non-existent-gate.*gate does not exist/) end diff --git a/spec/flipper/ui/actions/groups_gate_spec.rb b/spec/flipper/ui/actions/groups_gate_spec.rb index 881094156..6f6c61b15 100644 --- a/spec/flipper/ui/actions/groups_gate_spec.rb +++ b/spec/flipper/ui/actions/groups_gate_spec.rb @@ -1,129 +1,135 @@ require 'helper' RSpec.describe Flipper::UI::Actions::GroupsGate do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "GET /features/:feature/groups" do + describe 'GET /features/:feature/groups' do before do - Flipper.register(:admins) { |user| user.admin? } - get "features/search/groups" + Flipper.register(:admins, &:admin?) + get 'features/search/groups' end after do Flipper.unregister_groups end - it "responds with success" do + it 'responds with success' do expect(last_response.status).to be(200) end - it "renders add new group form" do + it 'renders add new group form' do expect(last_response.body).to include('') end end - describe "POST /features/:feature/groups" do - let(:group_name) { "admins" } + describe 'POST /features/:feature/groups' do + let(:group_name) { 'admins' } before do - Flipper.register(:admins) { |user| user.admin? } + Flipper.register(:admins, &:admin?) end after do Flipper.unregister_groups end - context "enabling a group" do + context 'enabling a group' do before do - post "features/search/groups", - {"value" => group_name, "operation" => "enable", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/groups', + { 'value' => group_name, 'operation' => 'enable', 'authenticity_token' => token }, + 'rack.session' => session end - it "adds item to members" do - expect(flipper[:search].groups_value).to include("admins") + it 'adds item to members' do + expect(flipper[:search].groups_value).to include('admins') end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end context 'group name contains whitespace' do - let(:group_name) { " admins " } + let(:group_name) { ' admins ' } - it "adds item without whitespace" do - expect(flipper[:search].groups_value).to include("admins") + it 'adds item without whitespace' do + expect(flipper[:search].groups_value).to include('admins') end end - context "for an unregistered group" do - context "unknown group name" do - let(:group_name) { "not_here" } + context 'for an unregistered group' do + context 'unknown group name' do + let(:group_name) { 'not_here' } - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search/groups?error=The+group+named+%22not_here%22+has+not+been+registered.") + expect(last_response.headers['Location']).to eq('/features/search/groups?error=The+group+named+%22not_here%22+has+not+been+registered.') end + # rubocop:enable Metrics/LineLength end - context "empty group name" do - let(:group_name) { "" } + context 'empty group name' do + let(:group_name) { '' } - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search/groups?error=The+group+named+%22%22+has+not+been+registered.") + expect(last_response.headers['Location']).to eq('/features/search/groups?error=The+group+named+%22%22+has+not+been+registered.') end + # rubocop:enable Metrics/LineLength end - context "nil group name" do + context 'nil group name' do let(:group_name) { nil } - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search/groups?error=The+group+named+%22%22+has+not+been+registered.") + expect(last_response.headers['Location']).to eq('/features/search/groups?error=The+group+named+%22%22+has+not+been+registered.') end + # rubocop:enable Metrics/LineLength end end end - context "disabling a group" do - let(:group_name) { "admins" } + context 'disabling a group' do + let(:group_name) { 'admins' } before do flipper[:search].enable_group :admins - post "features/search/groups", - {"value" => group_name, "operation" => "disable", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/groups', + { 'value' => group_name, 'operation' => 'disable', 'authenticity_token' => token }, + 'rack.session' => session end - it "removes item from members" do - expect(flipper[:search].groups_value).not_to include("admins") + it 'removes item from members' do + expect(flipper[:search].groups_value).not_to include('admins') end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end context 'group name contains whitespace' do - let(:group_name) { " admins " } + let(:group_name) { ' admins ' } - it "removes item without whitespace" do - expect(flipper[:search].groups_value).not_to include("admins") + it 'removes item without whitespace' do + expect(flipper[:search].groups_value).not_to include('admins') end end end diff --git a/spec/flipper/ui/actions/home_spec.rb b/spec/flipper/ui/actions/home_spec.rb index d5fac68bd..639613622 100644 --- a/spec/flipper/ui/actions/home_spec.rb +++ b/spec/flipper/ui/actions/home_spec.rb @@ -1,16 +1,16 @@ require 'helper' RSpec.describe Flipper::UI::Actions::Home do - describe "GET /" do + describe 'GET /' do before do flipper[:stats].enable flipper[:search].enable - get "/" + get '/' end - it "responds with redirect" do + it 'responds with redirect' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features") + expect(last_response.headers['Location']).to eq('/features') end end end diff --git a/spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb b/spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb index 0bc0b8485..9b65a8dc0 100644 --- a/spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb +++ b/spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb @@ -1,54 +1,56 @@ require 'helper' RSpec.describe Flipper::UI::Actions::PercentageOfActorsGate do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "POST /features/:feature/percentage_of_actors" do - context "with valid value" do + describe 'POST /features/:feature/percentage_of_actors' do + context 'with valid value' do before do - post "features/search/percentage_of_actors", - {"value" => "24", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/percentage_of_actors', + { 'value' => '24', 'authenticity_token' => token }, + 'rack.session' => session end - it "enables the feature" do + it 'enables the feature' do expect(flipper[:search].percentage_of_actors_value).to be(24) end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end end - context "with invalid value" do + context 'with invalid value' do before do - post "features/search/percentage_of_actors", - {"value" => "555", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/percentage_of_actors', + { 'value' => '555', 'authenticity_token' => token }, + 'rack.session' => session end - it "does not change value" do + it 'does not change value' do expect(flipper[:search].percentage_of_actors_value).to be(0) end - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search?error=Invalid+percentage+of+actors+value%3A+value+must+be+a+positive+number+less+than+or+equal+to+100%2C+but+was+555") + expect(last_response.headers['Location']).to eq('/features/search?error=Invalid+percentage+of+actors+value%3A+value+must+be+a+positive+number+less+than+or+equal+to+100%2C+but+was+555') end + # rubocop:enable Metrics/LineLength end end end diff --git a/spec/flipper/ui/actions/percentage_of_time_gate_spec.rb b/spec/flipper/ui/actions/percentage_of_time_gate_spec.rb index cc091cb34..bc54fd0df 100644 --- a/spec/flipper/ui/actions/percentage_of_time_gate_spec.rb +++ b/spec/flipper/ui/actions/percentage_of_time_gate_spec.rb @@ -1,54 +1,56 @@ require 'helper' RSpec.describe Flipper::UI::Actions::PercentageOfTimeGate do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "POST /features/:feature/percentage_of_time" do - context "with valid value" do + describe 'POST /features/:feature/percentage_of_time' do + context 'with valid value' do before do - post "features/search/percentage_of_time", - {"value" => "24", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/percentage_of_time', + { 'value' => '24', 'authenticity_token' => token }, + 'rack.session' => session end - it "enables the feature" do + it 'enables the feature' do expect(flipper[:search].percentage_of_time_value).to be(24) end - it "redirects back to feature" do + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search") + expect(last_response.headers['Location']).to eq('/features/search') end end - context "with invalid value" do + context 'with invalid value' do before do - post "features/search/percentage_of_time", - {"value" => "555", "authenticity_token" => token}, - "rack.session" => session + post 'features/search/percentage_of_time', + { 'value' => '555', 'authenticity_token' => token }, + 'rack.session' => session end - it "does not change value" do + it 'does not change value' do expect(flipper[:search].percentage_of_time_value).to be(0) end - it "redirects back to feature" do + # rubocop:disable Metrics/LineLength + it 'redirects back to feature' do expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/search?error=Invalid+percentage+of+time+value%3A+value+must+be+a+positive+number+less+than+or+equal+to+100%2C+but+was+555") + expect(last_response.headers['Location']).to eq('/features/search?error=Invalid+percentage+of+time+value%3A+value+must+be+a+positive+number+less+than+or+equal+to+100%2C+but+was+555') end + # rubocop:enable Metrics/LineLength end end end diff --git a/spec/flipper/ui/decorators/feature_spec.rb b/spec/flipper/ui/decorators/feature_spec.rb index bd293aadb..77326cec1 100644 --- a/spec/flipper/ui/decorators/feature_spec.rb +++ b/spec/flipper/ui/decorators/feature_spec.rb @@ -7,85 +7,85 @@ let(:flipper) { build_flipper } let(:feature) { flipper[:some_awesome_feature] } - subject { + subject do described_class.new(feature) - } + end - describe "#initialize" do - it "sets the feature" do + describe '#initialize' do + it 'sets the feature' do expect(subject.feature).to be(feature) end end - describe "#pretty_name" do - it "capitalizes each word separated by underscores" do + describe '#pretty_name' do + it 'capitalizes each word separated by underscores' do expect(subject.pretty_name).to eq('Some Awesome Feature') end end - describe "#as_json" do + describe '#as_json' do before do @result = subject.as_json end - it "returns Hash" do + it 'returns Hash' do expect(@result).to be_instance_of(Hash) end - it "includes id" do + it 'includes id' do expect(@result['id']).to eq('some_awesome_feature') end - it "includes pretty name" do + it 'includes pretty name' do expect(@result['name']).to eq('Some Awesome Feature') end - it "includes state" do + it 'includes state' do expect(@result['state']).to eq('off') end - it "includes gates" do - gates = subject.gates.map { |gate| + it 'includes gates' do + gates = subject.gates.map do |gate| value = subject.gate_values[gate.key] Flipper::UI::Decorators::Gate.new(gate, value).as_json - } + end expect(@result['gates']).to eq(gates) end end - describe "#<=>" do - let(:on) { + describe '#<=>' do + let(:on) do flipper.enable(:on_a) described_class.new(flipper[:on_a]) - } + end - let(:on_b) { + let(:on_b) do flipper.enable(:on_b) described_class.new(flipper[:on_b]) - } + end - let(:conditional) { + let(:conditional) do flipper.enable_percentage_of_time :conditional_a, 5 described_class.new(flipper[:conditional_a]) - } + end - let(:off) { + let(:off) do described_class.new(flipper[:off_a]) - } + end - it "sorts :on before :conditional" do + it 'sorts :on before :conditional' do expect((on <=> conditional)).to be(-1) end - it "sorts :on before :off" do + it 'sorts :on before :off' do expect((on <=> conditional)).to be(-1) end - it "sorts :conditional before :off" do + it 'sorts :conditional before :off' do expect((on <=> conditional)).to be(-1) end - it "sorts on key for identical states" do + it 'sorts on key for identical states' do expect((on <=> on_b)).to be(-1) end end diff --git a/spec/flipper/ui/decorators/gate_spec.rb b/spec/flipper/ui/decorators/gate_spec.rb index f46fb2c35..993a86040 100644 --- a/spec/flipper/ui/decorators/gate_spec.rb +++ b/spec/flipper/ui/decorators/gate_spec.rb @@ -9,38 +9,38 @@ let(:feature) { flipper[:some_awesome_feature] } let(:gate) { feature.gate(:boolean) } - subject { + subject do described_class.new(gate, false) - } + end - describe "#initialize" do - it "sets gate" do + describe '#initialize' do + it 'sets gate' do expect(subject.gate).to be(gate) end - it "sets value" do + it 'sets value' do expect(subject.value).to eq(false) end end - describe "#as_json" do + describe '#as_json' do before do @result = subject.as_json end - it "returns Hash" do + it 'returns Hash' do expect(@result).to be_instance_of(Hash) end - it "includes key" do + it 'includes key' do expect(@result['key']).to eq('boolean') end - it "includes pretty name" do + it 'includes pretty name' do expect(@result['name']).to eq('boolean') end - it "includes value" do + it 'includes value' do expect(@result['value']).to be(false) end end diff --git a/spec/flipper/ui/util_spec.rb b/spec/flipper/ui/util_spec.rb index 7dda247f0..6f3fb7340 100644 --- a/spec/flipper/ui/util_spec.rb +++ b/spec/flipper/ui/util_spec.rb @@ -2,15 +2,15 @@ require 'flipper/ui/util' RSpec.describe Flipper::UI::Util do - describe "#blank?" do - context "with a string" do - it "returns true if blank" do + describe '#blank?' do + context 'with a string' do + it 'returns true if blank' do expect(described_class.blank?(nil)).to be(true) expect(described_class.blank?('')).to be(true) expect(described_class.blank?(' ')).to be(true) end - it "returns false if not blank" do + it 'returns false if not blank' do expect(described_class.blank?('nope')).to be(false) end end diff --git a/spec/flipper/ui_spec.rb b/spec/flipper/ui_spec.rb index cf167f351..ea268d11c 100644 --- a/spec/flipper/ui_spec.rb +++ b/spec/flipper/ui_spec.rb @@ -1,128 +1,128 @@ require 'helper' RSpec.describe Flipper::UI do - let(:token) { + let(:token) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) Rack::Protection::AuthenticityToken.random_token else - "a" + 'a' end - } - let(:session) { + end + let(:session) do if Rack::Protection::AuthenticityToken.respond_to?(:random_token) - {:csrf => token} + { csrf: token } else - {"_csrf_token" => token} + { '_csrf_token' => token } end - } + end - describe "Initializing middleware with flipper instance" do + describe 'Initializing middleware with flipper instance' do let(:app) { build_app(flipper) } - it "works" do + it 'works' do flipper.enable :some_great_feature - get "/features" + get '/features' expect(last_response.status).to be(200) - expect(last_response.body).to include("some_great_feature") + expect(last_response.body).to include('some_great_feature') end end - describe "Initializing middleware lazily with a block" do - let(:app) { - build_app(lambda { flipper }) - } + describe 'Initializing middleware lazily with a block' do + let(:app) do + build_app(-> { flipper }) + end - it "works" do + it 'works' do flipper.enable :some_great_feature - get "/features" + get '/features' expect(last_response.status).to be(200) - expect(last_response.body).to include("some_great_feature") + expect(last_response.body).to include('some_great_feature') end end - describe "Request method unsupported by action" do - it "raises error" do - expect { + describe 'Request method unsupported by action' do + it 'raises error' do + expect do head '/features' - }.to raise_error(Flipper::UI::RequestMethodNotSupported) + end.to raise_error(Flipper::UI::RequestMethodNotSupported) end end - describe "Inspecting the built Rack app" do - it "returns a String" do + describe 'Inspecting the built Rack app' do + it 'returns a String' do expect(build_app(flipper).inspect).to be_a(String) end end # See https://github.com/jnunemaker/flipper/issues/80 - it "can route features with names that match static directories" do - post "features/refactor-images/actors", - {"value" => "User:6", "operation" => "enable", "authenticity_token" => token}, - "rack.session" => session + it 'can route features with names that match static directories' do + post 'features/refactor-images/actors', + { 'value' => 'User:6', 'operation' => 'enable', 'authenticity_token' => token }, + 'rack.session' => session expect(last_response.status).to be(302) - expect(last_response.headers["Location"]).to eq("/features/refactor-images") + expect(last_response.headers['Location']).to eq('/features/refactor-images') end - it "should not have an application_breadcrumb_href by default" do - expect(Flipper::UI.application_breadcrumb_href).to be(nil) + it 'does not have an application_breadcrumb_href by default' do + expect(described_class.application_breadcrumb_href).to be(nil) end - context "with application_breadcrumb_href not set" do + context 'with application_breadcrumb_href not set' do before do - @original_application_breadcrumb_href = Flipper::UI.application_breadcrumb_href - Flipper::UI.application_breadcrumb_href = nil + @original_application_breadcrumb_href = described_class.application_breadcrumb_href + described_class.application_breadcrumb_href = nil end after do - Flipper::UI.application_breadcrumb_href = @original_application_breadcrumb_href + described_class.application_breadcrumb_href = @original_application_breadcrumb_href end it 'does not add App breadcrumb' do - get "/features" - expect(last_response.body).to_not include('App') + get '/features' + expect(last_response.body).not_to include('App') end end - context "with application_breadcrumb_href set" do + context 'with application_breadcrumb_href set' do before do - @original_application_breadcrumb_href = Flipper::UI.application_breadcrumb_href - Flipper::UI.application_breadcrumb_href = "/myapp" + @original_application_breadcrumb_href = described_class.application_breadcrumb_href + described_class.application_breadcrumb_href = '/myapp' end after do - Flipper::UI.application_breadcrumb_href = @original_application_breadcrumb_href + described_class.application_breadcrumb_href = @original_application_breadcrumb_href end it 'does add App breadcrumb' do - get "/features" + get '/features' expect(last_response.body).to include('App') end end - context "with application_breadcrumb_href set to full url" do + context 'with application_breadcrumb_href set to full url' do before do - @original_application_breadcrumb_href = Flipper::UI.application_breadcrumb_href - Flipper::UI.application_breadcrumb_href = "https://myapp.com/" + @original_application_breadcrumb_href = described_class.application_breadcrumb_href + described_class.application_breadcrumb_href = 'https://myapp.com/' end after do - Flipper::UI.application_breadcrumb_href = @original_application_breadcrumb_href + described_class.application_breadcrumb_href = @original_application_breadcrumb_href end it 'does add App breadcrumb' do - get "/features" + get '/features' expect(last_response.body).to include('App') end end - it "should set feature_creation_enabled to true by default" do - expect(Flipper::UI.feature_creation_enabled).to be(true) + it 'sets feature_creation_enabled to true by default' do + expect(described_class.feature_creation_enabled).to be(true) end - context "with feature_creation_enabled set to true" do + context 'with feature_creation_enabled set to true' do before do - @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled - Flipper::UI.feature_creation_enabled = true + @original_feature_creation_enabled = described_class.feature_creation_enabled + described_class.feature_creation_enabled = true end it 'has the add_feature button' do @@ -131,24 +131,23 @@ end after do - Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled + described_class.feature_creation_enabled = @original_feature_creation_enabled end end - context "with feature_creation_enabled set to false" do + context 'with feature_creation_enabled set to false' do before do - @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled - Flipper::UI.feature_creation_enabled = false + @original_feature_creation_enabled = described_class.feature_creation_enabled + described_class.feature_creation_enabled = false end it 'does not have the add_feature button' do get '/features' - expect(last_response.body).to_not include('Add Feature') + expect(last_response.body).not_to include('Add Feature') end after do - Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled + described_class.feature_creation_enabled = @original_feature_creation_enabled end end - end diff --git a/spec/flipper_spec.rb b/spec/flipper_spec.rb index de7fba35f..00c39f657 100644 --- a/spec/flipper_spec.rb +++ b/spec/flipper_spec.rb @@ -1,109 +1,109 @@ require 'helper' RSpec.describe Flipper do - describe ".new" do - it "returns new instance of dsl" do - instance = Flipper.new(double('Adapter')) + describe '.new' do + it 'returns new instance of dsl' do + instance = described_class.new(double('Adapter')) expect(instance).to be_instance_of(Flipper::DSL) end end - describe ".group_exists" do - it "returns true if the group is already created" do - group = Flipper.register('admins') { |actor| actor.admin? } - expect(Flipper.group_exists?(:admins)).to eq(true) + describe '.group_exists' do + it 'returns true if the group is already created' do + group = described_class.register('admins', &:admin?) + expect(described_class.group_exists?(:admins)).to eq(true) end - it "returns false when the group is not yet registered" do - expect(Flipper.group_exists?(:non_existing)).to eq(false) + it 'returns false when the group is not yet registered' do + expect(described_class.group_exists?(:non_existing)).to eq(false) end end - describe ".groups_registry" do - it "returns a registry instance" do - expect(Flipper.groups_registry).to be_instance_of(Flipper::Registry) + describe '.groups_registry' do + it 'returns a registry instance' do + expect(described_class.groups_registry).to be_instance_of(Flipper::Registry) end end - describe ".groups_registry=" do - it "sets groups_registry registry" do + describe '.groups_registry=' do + it 'sets groups_registry registry' do registry = Flipper::Registry.new - Flipper.groups_registry = registry - expect(Flipper.instance_variable_get("@groups_registry")).to eq(registry) + described_class.groups_registry = registry + expect(described_class.instance_variable_get('@groups_registry')).to eq(registry) end end - describe ".register" do - it "adds a group to the group_registry" do + describe '.register' do + it 'adds a group to the group_registry' do registry = Flipper::Registry.new - Flipper.groups_registry = registry - group = Flipper.register(:admins) { |actor| actor.admin? } + described_class.groups_registry = registry + group = described_class.register(:admins, &:admin?) expect(registry.get(:admins)).to eq(group) end - it "adds a group to the group_registry for string name" do + it 'adds a group to the group_registry for string name' do registry = Flipper::Registry.new - Flipper.groups_registry = registry - group = Flipper.register('admins') { |actor| actor.admin? } + described_class.groups_registry = registry + group = described_class.register('admins', &:admin?) expect(registry.get(:admins)).to eq(group) end - it "raises exception if group already registered" do - Flipper.register(:admins) { } + it 'raises exception if group already registered' do + described_class.register(:admins) {} - expect { - Flipper.register(:admins) { } - }.to raise_error(Flipper::DuplicateGroup, "Group :admins has already been registered") + expect do + described_class.register(:admins) {} + end.to raise_error(Flipper::DuplicateGroup, 'Group :admins has already been registered') end end - describe ".unregister_groups" do - it "clear group registry" do - expect(Flipper.groups_registry).to receive(:clear) - Flipper.unregister_groups + describe '.unregister_groups' do + it 'clear group registry' do + expect(described_class.groups_registry).to receive(:clear) + described_class.unregister_groups end end - describe ".group" do - context "for registered group" do + describe '.group' do + context 'for registered group' do before do - @group = Flipper.register(:admins) { } + @group = described_class.register(:admins) {} end - it "returns group" do - expect(Flipper.group(:admins)).to eq(@group) + it 'returns group' do + expect(described_class.group(:admins)).to eq(@group) end - it "returns group with string key" do - expect(Flipper.group('admins')).to eq(@group) + it 'returns group with string key' do + expect(described_class.group('admins')).to eq(@group) end end - context "for unregistered group" do - it "raises group not registered error" do - expect { - Flipper.group(:cats) - }.to raise_error(Flipper::GroupNotRegistered, 'Group :cats has not been registered') + context 'for unregistered group' do + it 'raises group not registered error' do + expect do + described_class.group(:cats) + end.to raise_error(Flipper::GroupNotRegistered, 'Group :cats has not been registered') end end end - describe ".groups" do - it "returns array of group instances" do - admins = Flipper.register(:admins) { |actor| actor.admin? } - preview_features = Flipper.register(:preview_features) { |actor| actor.preview_features? } - expect(Flipper.groups).to eq(Set[ + describe '.groups' do + it 'returns array of group instances' do + admins = described_class.register(:admins, &:admin?) + preview_features = described_class.register(:preview_features, &:preview_features?) + expect(described_class.groups).to eq(Set[ admins, preview_features, ]) end end - describe ".group_names" do - it "returns array of group names" do - Flipper.register(:admins) { |actor| actor.admin? } - Flipper.register(:preview_features) { |actor| actor.preview_features? } - expect(Flipper.group_names).to eq(Set[ + describe '.group_names' do + it 'returns array of group names' do + described_class.register(:admins, &:admin?) + described_class.register(:preview_features, &:preview_features?) + expect(described_class.group_names).to eq(Set[ :admins, :preview_features, ]) diff --git a/spec/helper.rb b/spec/helper.rb index 83000b8cc..b1bc283d6 100644 --- a/spec/helper.rb +++ b/spec/helper.rb @@ -1,4 +1,4 @@ -$:.unshift(File.expand_path('../../lib', __FILE__)) +$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__)) require 'pp' require 'pathname' @@ -13,7 +13,7 @@ require 'flipper-ui' require 'flipper-api' -Dir[FlipperRoot.join("spec/support/**/*.rb")].each { |f| require f } +Dir[FlipperRoot.join('spec/support/**/*.rb')].each { |f| require f } RSpec.configure do |config| config.before(:example) do @@ -27,64 +27,66 @@ end RSpec.shared_examples_for 'a percentage' do - it "initializes with value" do + it 'initializes with value' do percentage = described_class.new(12) expect(percentage).to be_instance_of(described_class) end - it "converts string values to integers when initializing" do + it 'converts string values to integers when initializing' do percentage = described_class.new('15') expect(percentage.value).to eq(15) end - it "has a value" do + it 'has a value' do percentage = described_class.new(19) expect(percentage.value).to eq(19) end - it "raises exception for value higher than 100" do - expect { + it 'raises exception for value higher than 100' do + expect do described_class.new(101) - }.to raise_error(ArgumentError, "value must be a positive number less than or equal to 100, but was 101") + end.to raise_error(ArgumentError, + 'value must be a positive number less than or equal to 100, but was 101') end - it "raises exception for negative value" do - expect { + it 'raises exception for negative value' do + expect do described_class.new(-1) - }.to raise_error(ArgumentError, "value must be a positive number less than or equal to 100, but was -1") + end.to raise_error(ArgumentError, + 'value must be a positive number less than or equal to 100, but was -1') end end RSpec.shared_examples_for 'a DSL feature' do - it "returns instance of feature" do + it 'returns instance of feature' do expect(feature).to be_instance_of(Flipper::Feature) end - it "sets name" do + it 'sets name' do expect(feature.name).to eq(:stats) end - it "sets adapter" do + it 'sets adapter' do expect(feature.adapter.name).to eq(dsl.adapter.name) end - it "sets instrumenter" do + it 'sets instrumenter' do expect(feature.instrumenter).to eq(dsl.instrumenter) end - it "memoizes the feature" do + it 'memoizes the feature' do expect(dsl.send(method_name, :stats)).to equal(feature) end - it "raises argument error if not string or symbol" do - expect { + it 'raises argument error if not string or symbol' do + expect do dsl.send(method_name, Object.new) - }.to raise_error(ArgumentError, /must be a String or Symbol/) + end.to raise_error(ArgumentError, /must be a String or Symbol/) end end -RSpec.shared_examples_for "a DSL boolean method" do - it "returns boolean with value set" do +RSpec.shared_examples_for 'a DSL boolean method' do + it 'returns boolean with value set' do result = subject.send(method_name, true) expect(result).to be_instance_of(Flipper::Types::Boolean) expect(result.value).to be(true) diff --git a/spec/integration_spec.rb b/spec/integration_spec.rb index c825104c7..f3f94a2be 100644 --- a/spec/integration_spec.rb +++ b/spec/integration_spec.rb @@ -4,7 +4,7 @@ RSpec.describe Flipper do let(:adapter) { Flipper::Adapters::Memory.new } - let(:flipper) { Flipper.new(adapter) } + let(:flipper) { described_class.new(adapter) } let(:feature) { flipper[:search] } let(:actor_class) { Struct.new(:flipper_id) } @@ -12,11 +12,19 @@ let(:admin_group) { flipper.group(:admins) } let(:dev_group) { flipper.group(:devs) } - let(:admin_thing) { double 'Non Flipper Thing', :flipper_id => 1, :admin? => true, :dev? => false } - let(:dev_thing) { double 'Non Flipper Thing', :flipper_id => 10, :admin? => false, :dev? => true } + let(:admin_thing) do + double 'Non Flipper Thing', flipper_id: 1, admin?: true, dev?: false + end + let(:dev_thing) do + double 'Non Flipper Thing', flipper_id: 10, admin?: false, dev?: true + end - let(:admin_truthy_thing) { double 'Non Flipper Thing', :flipper_id => 1, :admin? => "true-ish", :dev? => false } - let(:admin_falsey_thing) { double 'Non Flipper Thing', :flipper_id => 1, :admin? => nil, :dev? => false } + let(:admin_truthy_thing) do + double 'Non Flipper Thing', flipper_id: 1, admin?: 'true-ish', dev?: false + end + let(:admin_falsey_thing) do + double 'Non Flipper Thing', flipper_id: 1, admin?: nil, dev?: false + end let(:pitt) { actor_class.new(1) } let(:clooney) { actor_class.new(10) } @@ -25,149 +33,149 @@ let(:five_percent_of_time) { flipper.time(5) } before do - Flipper.register(:admins) { |thing| thing.admin? } - Flipper.register(:devs) { |thing| thing.dev? } + described_class.register(:admins, &:admin?) + described_class.register(:devs, &:dev?) end - describe "#enable" do - context "with no arguments" do + describe '#enable' do + context 'with no arguments' do before do @result = feature.enable end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "enables feature for all" do + it 'enables feature for all' do expect(feature.enabled?).to eq(true) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with a group" do + context 'with a group' do before do @result = feature.enable(admin_group) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "enables feature for non flipper thing in group" do + it 'enables feature for non flipper thing in group' do expect(feature.enabled?(admin_thing)).to eq(true) end - it "does not enable feature for non flipper thing in other group" do + it 'does not enable feature for non flipper thing in other group' do expect(feature.enabled?(dev_thing)).to eq(false) end - it "enables feature for flipper actor in group" do + it 'enables feature for flipper actor in group' do expect(feature.enabled?(flipper.actor(admin_thing))).to eq(true) end - it "does not enable for flipper actor not in group" do + it 'does not enable for flipper actor not in group' do expect(feature.enabled?(flipper.actor(dev_thing))).to eq(false) end - it "does not enable feature for all" do + it 'does not enable feature for all' do expect(feature.enabled?).to eq(false) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with an actor" do + context 'with an actor' do before do @result = feature.enable(pitt) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "enables feature for actor" do + it 'enables feature for actor' do expect(feature.enabled?(pitt)).to eq(true) end - it "does not enable feature for other actors" do + it 'does not enable feature for other actors' do expect(feature.enabled?(clooney)).to eq(false) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with a percentage of actors" do + context 'with a percentage of actors' do before do @result = feature.enable(five_percent_of_actors) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "enables feature for actor within percentage" do - enabled = (1..100).select { |i| + it 'enables feature for actor within percentage' do + enabled = (1..100).select do |i| thing = actor_class.new(i) feature.enabled?(thing) - }.size + end.size expect(enabled).to be_within(2).of(5) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with a percentage of time" do + context 'with a percentage of time' do before do @gate = feature.gate(:percentage_of_time) @result = feature.enable(five_percent_of_time) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "enables feature for time within percentage" do - allow(@gate).to receive_messages(:rand => 0.04) + it 'enables feature for time within percentage' do + allow(@gate).to receive_messages(rand: 0.04) expect(feature.enabled?).to eq(true) end - it "does not enable feature for time not within percentage" do - allow(@gate).to receive_messages(:rand => 0.10) + it 'does not enable feature for time not within percentage' do + allow(@gate).to receive_messages(rand: 0.10) expect(feature.enabled?).to eq(false) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with argument that has no gate" do - it "raises error" do + context 'with argument that has no gate' do + it 'raises error' do thing = Object.new - expect { + expect do feature.enable(thing) - }.to raise_error(Flipper::GateNotFound, "Could not find gate for #{thing.inspect}") + end.to raise_error(Flipper::GateNotFound, "Could not find gate for #{thing.inspect}") end end end - describe "#disable" do - context "with no arguments" do + describe '#disable' do + context 'with no arguments' do before do # ensures that time gate is stubbed with result that would be true for pitt @gate = feature.gate(:percentage_of_time) - allow(@gate).to receive_messages(:rand => 0.04) + allow(@gate).to receive_messages(rand: 0.04) feature.enable admin_group feature.enable pitt @@ -176,229 +184,229 @@ @result = feature.disable end - it "returns true" do + it 'returns true' do expect(@result).to be(true) end - it "disables feature" do + it 'disables feature' do expect(feature.enabled?).to eq(false) end - it "disables for individual actor" do + it 'disables for individual actor' do expect(feature.enabled?(pitt)).to eq(false) end - it "disables actor in group" do + it 'disables actor in group' do expect(feature.enabled?(admin_thing)).to eq(false) end - it "disables actor in percentage of actors" do - enabled = (1..100).select { |i| + it 'disables actor in percentage of actors' do + enabled = (1..100).select do |i| thing = actor_class.new(i) feature.enabled?(thing) - }.size + end.size expect(enabled).to be(0) end - it "disables percentage of time" do + it 'disables percentage of time' do expect(feature.enabled?(pitt)).to eq(false) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with a group" do + context 'with a group' do before do feature.enable dev_group feature.enable admin_group @result = feature.disable(admin_group) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "disables the feature for non flipper thing in the group" do + it 'disables the feature for non flipper thing in the group' do expect(feature.enabled?(admin_thing)).to eq(false) end - it "does not disable feature for non flipper thing in other groups" do + it 'does not disable feature for non flipper thing in other groups' do expect(feature.enabled?(dev_thing)).to eq(true) end - it "disables feature for flipper actor in group" do + it 'disables feature for flipper actor in group' do expect(feature.enabled?(flipper.actor(admin_thing))).to eq(false) end - it "does not disable feature for flipper actor in other groups" do + it 'does not disable feature for flipper actor in other groups' do expect(feature.enabled?(flipper.actor(dev_thing))).to eq(true) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with an actor" do + context 'with an actor' do before do feature.enable pitt feature.enable clooney @result = feature.disable(pitt) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "disables feature for actor" do + it 'disables feature for actor' do expect(feature.enabled?(pitt)).to eq(false) end - it "does not disable feature for other actors" do + it 'does not disable feature for other actors' do expect(feature.enabled?(clooney)).to eq(true) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with a percentage of actors" do + context 'with a percentage of actors' do before do @result = feature.disable(flipper.actors(0)) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "disables feature" do - enabled = (1..100).select { |i| + it 'disables feature' do + enabled = (1..100).select do |i| thing = actor_class.new(i) feature.enabled?(thing) - }.size + end.size expect(enabled).to be(0) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with a percentage of time" do + context 'with a percentage of time' do before do @gate = feature.gate(:percentage_of_time) @result = feature.disable(flipper.time(0)) end - it "returns true" do + it 'returns true' do expect(@result).to eq(true) end - it "disables feature for time within percentage" do - allow(@gate).to receive_messages(:rand => 0.04) + it 'disables feature for time within percentage' do + allow(@gate).to receive_messages(rand: 0.04) expect(feature.enabled?).to eq(false) end - it "disables feature for time not within percentage" do - allow(@gate).to receive_messages(:rand => 0.10) + it 'disables feature for time not within percentage' do + allow(@gate).to receive_messages(rand: 0.10) expect(feature.enabled?).to eq(false) end - it "adds feature to set of features" do + it 'adds feature to set of features' do expect(flipper.features.map(&:name)).to include(:search) end end - context "with argument that has no gate" do - it "raises error" do + context 'with argument that has no gate' do + it 'raises error' do thing = Object.new - expect { + expect do feature.disable(thing) - }.to raise_error(Flipper::GateNotFound, "Could not find gate for #{thing.inspect}") + end.to raise_error(Flipper::GateNotFound, "Could not find gate for #{thing.inspect}") end end end - describe "#enabled?" do - context "with no arguments" do - it "defaults to false" do + describe '#enabled?' do + context 'with no arguments' do + it 'defaults to false' do expect(feature.enabled?).to eq(false) end end - context "with no arguments, but boolean enabled" do + context 'with no arguments, but boolean enabled' do before do feature.enable end - it "returns true" do + it 'returns true' do expect(feature.enabled?).to eq(true) end end - context "for actor in enabled group" do + context 'for actor in enabled group' do before do feature.enable admin_group end - it "returns true" do + it 'returns true' do expect(feature.enabled?(flipper.actor(admin_thing))).to eq(true) expect(feature.enabled?(admin_thing)).to eq(true) end - it "returns true for truthy block values" do + it 'returns true for truthy block values' do expect(feature.enabled?(flipper.actor(admin_truthy_thing))).to eq(true) end end - context "for actor in disabled group" do - it "returns false" do + context 'for actor in disabled group' do + it 'returns false' do expect(feature.enabled?(flipper.actor(dev_thing))).to eq(false) expect(feature.enabled?(dev_thing)).to eq(false) end - it "returns false for falsey block values" do + it 'returns false for falsey block values' do expect(feature.enabled?(flipper.actor(admin_falsey_thing))).to eq(false) end end - context "for enabled actor" do + context 'for enabled actor' do before do feature.enable pitt end - it "returns true" do + it 'returns true' do expect(feature.enabled?(pitt)).to eq(true) end end - context "for not enabled actor" do - it "returns false" do + context 'for not enabled actor' do + it 'returns false' do expect(feature.enabled?(clooney)).to eq(false) end - it "returns true if boolean enabled" do + it 'returns true if boolean enabled' do feature.enable expect(feature.enabled?(clooney)).to eq(true) end end - context "for enabled percentage of time" do + context 'for enabled percentage of time' do before do # ensure percentage of time returns percentage that makes five percent # of time true @gate = feature.gate(:percentage_of_time) - allow(@gate).to receive_messages(:rand => 0.04) + allow(@gate).to receive_messages(rand: 0.04) feature.enable five_percent_of_time end - it "returns true" do + it 'returns true' do expect(feature.enabled?).to eq(true) expect(feature.enabled?(nil)).to eq(true) expect(feature.enabled?(pitt)).to eq(true) @@ -406,24 +414,24 @@ end end - context "for not enabled percentage of time" do + context 'for not enabled percentage of time' do before do # ensure percentage of time returns percentage that makes five percent # of time false @gate = feature.gate(:percentage_of_time) - allow(@gate).to receive_messages(:rand => 0.10) + allow(@gate).to receive_messages(rand: 0.10) feature.enable five_percent_of_time end - it "returns false" do + it 'returns false' do expect(feature.enabled?).to eq(false) expect(feature.enabled?(nil)).to eq(false) expect(feature.enabled?(pitt)).to eq(false) expect(feature.enabled?(admin_thing)).to eq(false) end - it "returns true if boolean enabled" do + it 'returns true if boolean enabled' do feature.enable expect(feature.enabled?).to eq(true) expect(feature.enabled?(nil)).to eq(true) @@ -432,20 +440,20 @@ end end - context "for a non flipper thing" do + context 'for a non flipper thing' do before do feature.enable admin_group end - it "returns true if in enabled group" do + it 'returns true if in enabled group' do expect(feature.enabled?(admin_thing)).to eq(true) end - it "returns false if not in enabled group" do + it 'returns false if not in enabled group' do expect(feature.enabled?(dev_thing)).to eq(false) end - it "returns true if boolean enabled" do + it 'returns true if boolean enabled' do feature.enable expect(feature.enabled?(admin_thing)).to eq(true) expect(feature.enabled?(dev_thing)).to eq(true) @@ -453,7 +461,7 @@ end end - context "enabling multiple groups, disabling everything, then enabling one group" do + context 'enabling multiple groups, disabling everything, then enabling one group' do before do feature.enable(admin_group) feature.enable(dev_group) @@ -461,11 +469,11 @@ feature.enable(admin_group) end - it "enables feature for object in enabled group" do + it 'enables feature for object in enabled group' do expect(feature.enabled?(admin_thing)).to eq(true) end - it "does not enable feature for object in not enabled group" do + it 'does not enable feature for object in not enabled group' do expect(feature.enabled?(dev_thing)).to eq(false) end end diff --git a/spec/support/fake_udp_socket.rb b/spec/support/fake_udp_socket.rb index ad06797f2..40367d23c 100644 --- a/spec/support/fake_udp_socket.rb +++ b/spec/support/fake_udp_socket.rb @@ -5,7 +5,7 @@ def initialize @buffer = [] end - def send(message, *rest) + def send(message, *_rest) @buffer.push [message] end diff --git a/spec/support/spec_helpers.rb b/spec/support/spec_helpers.rb index c4d7a5258..d6ec9e809 100644 --- a/spec/support/spec_helpers.rb +++ b/spec/support/spec_helpers.rb @@ -9,9 +9,9 @@ def self.included(base) end def build_app(flipper) - Flipper::UI.app(flipper) { |builder| - builder.use Rack::Session::Cookie, secret: "test" - } + Flipper::UI.app(flipper) do |builder| + builder.use Rack::Session::Cookie, secret: 'test' + end end def build_api(flipper) @@ -27,7 +27,35 @@ def build_memory_adapter end def json_response - JSON.load(last_response.body) + JSON.parse(last_response.body) + end + + def api_error_code_reference_url + 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' + end + + def api_not_found_response + { + 'code' => 1, + 'message' => 'Feature not found.', + 'more_info' => api_error_code_reference_url, + } + end + + def api_flipper_id_is_missing_response + { + 'code' => 4, + 'message' => 'Required parameter flipper_id is missing.', + 'more_info' => api_error_code_reference_url, + } + end + + def api_positive_percentage_error_response + { + 'code' => 3, + 'message' => 'Percentage must be a positive number less than or equal to 100.', + 'more_info' => api_error_code_reference_url, + } end end diff --git a/test/adapters/active_record_test.rb b/test/adapters/active_record_test.rb index 583a0eab3..bd54437a1 100644 --- a/test/adapters/active_record_test.rb +++ b/test/adapters/active_record_test.rb @@ -8,10 +8,8 @@ class ActiveRecordTest < MiniTest::Test prepend Flipper::Test::SharedAdapterTests - ActiveRecord::Base.establish_connection({ - adapter: "sqlite3", - database: ":memory:", - }) + ActiveRecord::Base.establish_connection(adapter: 'sqlite3', + database: ':memory:') def setup @adapter = Flipper::Adapters::ActiveRecord.new diff --git a/test/adapters/mongo_test.rb b/test/adapters/mongo_test.rb index bbdb504f1..bdf504f00 100644 --- a/test/adapters/mongo_test.rb +++ b/test/adapters/mongo_test.rb @@ -7,8 +7,12 @@ class MongoTest < MiniTest::Test def setup host = '127.0.0.1' port = '27017' - logger = Logger.new("/dev/null") - collection = Mongo::Client.new(["#{host}:#{port}"], server_selection_timeout: 1, database: 'testing', logger: logger)['testing'] + logger = Logger.new('/dev/null') + client = Mongo::Client.new(["#{host}:#{port}"], + server_selection_timeout: 1, + database: 'testing', + logger: logger) + collection = client['testing'] begin collection.drop collection.create diff --git a/test/adapters/pstore_test.rb b/test/adapters/pstore_test.rb index 3fb89e8d1..71ab76fa6 100644 --- a/test/adapters/pstore_test.rb +++ b/test/adapters/pstore_test.rb @@ -5,13 +5,13 @@ class PstoreTest < MiniTest::Test prepend Flipper::Test::SharedAdapterTests def setup - dir = FlipperRoot.join("tmp").tap { |d| d.mkpath } - pstore_file = dir.join("flipper.pstore") + dir = FlipperRoot.join('tmp').tap(&:mkpath) + pstore_file = dir.join('flipper.pstore') pstore_file.unlink if pstore_file.exist? @adapter = Flipper::Adapters::PStore.new(pstore_file) end def test_defaults_path_to_flipper_pstore - assert_equal Flipper::Adapters::PStore.new.path, "flipper.pstore" + assert_equal Flipper::Adapters::PStore.new.path, 'flipper.pstore' end end diff --git a/test/adapters/redis_test.rb b/test/adapters/redis_test.rb index b626c9542..e1d1f5a86 100644 --- a/test/adapters/redis_test.rb +++ b/test/adapters/redis_test.rb @@ -5,7 +5,7 @@ class RedisTest < MiniTest::Test prepend Flipper::Test::SharedAdapterTests def setup - client = Redis.new({}).tap { |c| c.flushdb } - @adapter = Flipper::Adapters::Redis.new(client) + client = Redis.new({}).tap(&:flushdb) + @adapter = Flipper::Adapters::Redis.new(client) end end diff --git a/test/adapters/sequel_test.rb b/test/adapters/sequel_test.rb index a8f42a89a..93e83e4b4 100644 --- a/test/adapters/sequel_test.rb +++ b/test/adapters/sequel_test.rb @@ -1,7 +1,7 @@ require 'test_helper' require 'sequel' -Sequel::Model.db = Sequel.sqlite(':memory:') +Sequel::Model.db = Sequel.sqlite(':memory:') Sequel.extension :migration, :core_extensions require 'flipper/adapters/sequel' diff --git a/test/generators/flipper/active_record_generator_test.rb b/test/generators/flipper/active_record_generator_test.rb index 832ac4bbe..5be316f41 100644 --- a/test/generators/flipper/active_record_generator_test.rb +++ b/test/generators/flipper/active_record_generator_test.rb @@ -5,12 +5,12 @@ class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase tests Flipper::Generators::ActiveRecordGenerator - destination File.expand_path("../../../../tmp", __FILE__) + destination File.expand_path('../../../../tmp', __FILE__) setup :prepare_destination def test_generates_migration run_generator - assert_migration "db/migrate/create_flipper_tables.rb", <<-EOM + assert_migration 'db/migrate/create_flipper_tables.rb', <<-EOM class CreateFlipperTables < ActiveRecord::Migration def self.up create_table :flipper_features do |t| diff --git a/test/test_helper.rb b/test/test_helper.rb index 0ec44d524..d80df34c1 100644 --- a/test/test_helper.rb +++ b/test/test_helper.rb @@ -1,6 +1,6 @@ require 'flipper' require 'minitest/autorun' require 'minitest/unit' -Dir["./lib/flipper/test/*.rb"].each { |f| require(f) } +Dir['./lib/flipper/test/*.rb'].each { |f| require(f) } FlipperRoot = Pathname(__FILE__).dirname.join('..').expand_path