flipper 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b07936734df32fbd0331822a97059e76ee9919db287e1073c15b338afc5924
-  data.tar.gz: 221fbb5002318b366d022365b7597f23094d2b50215e9545d3e1c2435faa03ec
+  metadata.gz: c5ccee45a49e10626a3168f1d4ac5b833a7a353be908044a9e056a8a38977e11
+  data.tar.gz: e4835d28c5db82466369bd78a002454c882e1c731ff171e352bbee3b53df1102
 SHA512:
-  metadata.gz: 4529f945a2c71a3c776940cc091e48280e5088e080c203d478aca91e94e52855d4b5c912bae8aad2b7ca95248f42cabf62599a67f307fc98c34faf46c6361bf1
-  data.tar.gz: 3fed3febaf673456551dea59b13b01777f9f59f9ee267424547b495b4d7f06a7cc5c50521431ef29260585c01f93e05f2c1c30c4e55d5833cfb1cb40fccfb7c3
+  metadata.gz: efc365c24401b44a56f0c3818dd3d85868b89859ec22ee9119e3ac2764043a90d966d5a4a079e3aab231f07df017017cea09ab1f351edcdaa90a97837ee38614
+  data.tar.gz: 42e748dfb24633faca15dde30f1062b349e29c72bbf014382a22a9ad06cea214ea4fa679fc5e69d4e4b8e259a1c98863e9a29bf1f302fcee319a3729f8ee85a5

data/.github/workflows/ci.yml

@@ -1,10 +1,8 @@
 name: CI
-on:
-  push:
-    branches: [master]
-  pull_request:
+on: [push, pull_request]
 jobs:
-  build:
+  test:
+    name: Test on ruby ${{ matrix.ruby }} and rails ${{ matrix.rails }}
     runs-on: ubuntu-latest
     services:
       redis:
@@ -18,8 +16,8 @@ jobs:
     strategy:
       matrix:
         ruby: ['2.5', '2.6', '2.7']
+        rails: ['5.2', '6.0.0', '6.1.0']
     env:
-      RAILS_VERSION: 6.0.0
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
       CI: true
@@ -36,10 +34,10 @@ jobs:
         uses: actions/cache@v1
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
-            ${{ runner.os }}-gem-
-      - name: Set up Ruby
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -47,11 +45,14 @@ jobs:
         run: sudo apt-get -yqq install libpq-dev
       - name: Install bundler
         run: gem install bundler
-      - name: Run bundler
-        run: bundle install --jobs 4 --retry 3
-      - name: Run Rake
-        run: bundle exec rake
-      - name: Run Examples
+      - name: Run Rake with Rails ${{ matrix.rails }}
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+      - name: Run Examples with Rails ${{ matrix.rails }}
         env:
           FLIPPER_CLOUD_TOKEN: ${{ secrets.FLIPPER_CLOUD_TOKEN }}
+          RAILS_VERSION: ${{ matrix.rails }}
         run: script/examples

data/Changelog.md

@@ -1,3 +1,12 @@
+## 0.22.0
+
+## Additions/Changes
+
+* Enable log subscriber by default in Rails (https://github.com/jnunemaker/flipper/pull/525)
+* Remove memoizer from API and UI (https://github.com/jnunemaker/flipper/pull/527). If you are using the UI or API without configuring the default instance of Flipper, you'll need to enable memoization if you want it. For examples, see the examples/ui and examples/api directories.
+* Fix SQL reserved word use in get_all for ActiveRecord and Sequel (https://github.com/jnunemaker/flipper/pull/536).
+* Handle spaces in names gracefully in UI (https://github.com/jnunemaker/flipper/pull/541).
+
 ## 0.21.0
 
 ### Additions/Changes

data/Gemfile

@@ -19,6 +19,7 @@ gem 'minitest-documentation'
 gem 'webmock', '~> 3.0'
 gem 'climate_control'
 gem 'redis-namespace'
+gem 'webrick'
 
 group(:guard) do
   gem 'guard', '~> 2.15'

data/README.md

@@ -157,6 +157,7 @@ A few miscellaneous docs with more info for the hungry.
 | pic | @mention | area |
 |---|---|---|
 | ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64) | [@jnunemaker](https://github.com/jnunemaker) | most things |
+| ![@bkeepers](https://avatars3.githubusercontent.com/u/173?s=64) | [@bkeepers](https://github.com/bkeepers) | most things |
 | ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) | api |
 | ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64) | [@thetimbanks](https://github.com/thetimbanks) | ui |
 | ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64) | [@lazebny](https://github.com/lazebny) | docker |

data/docs/api/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 ```ruby
 # config/routes.rb
 YourRailsApp::Application.routes.draw do
-  mount Flipper::Api.app(flipper) => '/flipper/api'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
 end
 ```
 
@@ -34,8 +34,8 @@ There can be more than one router in your application. Make sure if you choose a
 *bad:*
 ```ruby
 YourRailsApp::Application.routes.draw do
-  mount Flipper::UI.app(flipper) => '/flipper'
-  mount Flipper::Api.app(flipper) => '/flipper/api'
+  mount Flipper::UI.app(Flipper) => '/flipper'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
 end
 ```
 
@@ -44,8 +44,8 @@ In this case any requests to /flipper\* will be routed to Flipper::UI - includin
 *good:*
 ```ruby
 YourRailsApp::Application.routes.draw do
-  mount Flipper::Api.app(flipper) => '/flipper/api'
-  mount Flipper::UI.app(flipper) => '/flipper'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
+  mount Flipper::UI.app(Flipper) => '/flipper'
 end
 ````
 For more advanced mounting techniques and for suggestions on how to mount in a non-Rails application, it is recommend that you review the [`Flipper::UI` usage documentation](https://github.com/jnunemaker/flipper/blob/master/docs/ui/README.md#usage) as the same approaches apply to `Flipper::Api`.

data/examples/api/basic.ru

@@ -0,0 +1,19 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/basic.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/basic.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+# You can uncomment this to get some default data:
+# Flipper.enable :logging
+
+run Flipper::Api.app

data/examples/api/custom_memoized.ru

@@ -0,0 +1,37 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/custom_memoized.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/custom_memoized.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "active_support/notifications"
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+adapter = Flipper::Adapters::Instrumented.new(
+  Flipper::Adapters::PStore.new,
+  instrumenter: ActiveSupport::Notifications,
+)
+flipper = Flipper.new(adapter)
+
+ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
+  name, start, finish, id, data = args
+  case name
+  when "adapter_operation.flipper"
+    p data[:adapter_name] => data[:operation]
+  end
+})
+
+# You can uncomment this to get some default data:
+# flipper[:logging].enable_percentage_of_time 5
+
+run Flipper::Api.app(flipper) { |builder|
+  builder.use Flipper::Middleware::SetupEnv, flipper
+  builder.use Flipper::Middleware::Memoizer, preload: true
+}

data/examples/api/memoized.ru

@@ -0,0 +1,43 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/memoized.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/memoized.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "active_support/notifications"
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+Flipper.configure do |config|
+  config.adapter {
+    Flipper::Adapters::Instrumented.new(
+      Flipper::Adapters::PStore.new,
+      instrumenter: ActiveSupport::Notifications,
+    )
+  }
+end
+
+ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
+  name, start, finish, id, data = args
+  case name
+  when "adapter_operation.flipper"
+    p data[:adapter_name] => data[:operation]
+  end
+})
+
+Flipper.register(:admins) { |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+}
+
+# You can uncomment this to get some default data:
+# Flipper.enable :logging
+
+run Flipper::Api.app { |builder|
+  builder.use Flipper::Middleware::Memoizer, preload: true
+}

data/lib/flipper/middleware/memoizer.rb

@@ -15,7 +15,7 @@ module Flipper
       #   use Flipper::Middleware::Memoizer
       #
       #   # using with preload_all features
-      #   use Flipper::Middleware::Memoizer, preload_all: true
+      #   use Flipper::Middleware::Memoizer, preload: true
       #
       #   # using with preload specific features
       #   use Flipper::Middleware::Memoizer, preload: [:stats, :search, :some_feature]

data/lib/flipper/railtie.rb

@@ -5,7 +5,8 @@ module Flipper
         env_key: "flipper",
         memoize: true,
         preload: true,
-        instrumenter: ActiveSupport::Notifications
+        instrumenter: ActiveSupport::Notifications,
+        log: true
       )
     end
 
@@ -29,6 +30,13 @@ module Flipper
       end
     end
 
+    initializer "flipper.log", after: :load_config_initializers do |app|
+      config = app.config.flipper
+      if config.log && config.instrumenter == ActiveSupport::Notifications
+        require "flipper/instrumentation/log_subscriber"
+      end
+    end
+
     initializer "flipper.identifier" do
       ActiveSupport.on_load(:active_record) do
         ActiveRecord::Base.include Flipper::Identifier

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.21.0'.freeze
+  VERSION = '0.22.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -37,6 +37,9 @@ files:
 - docs/http/README.md
 - docs/images/banner.jpg
 - docs/read-only/README.md
+- examples/api/basic.ru
+- examples/api/custom_memoized.ru
+- examples/api/memoized.ru
 - examples/basic.rb
 - examples/configuring_default.rb
 - examples/dsl.rb