rack-reducer 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e9d87cd9c12373fb42f37eedb4246d6296009faab5bb5f1831236a4c200b0f
-  data.tar.gz: cb1e793d45ba3e71f588b22df0469358a40f56ab3167d8dc734b105306a841f0
+  metadata.gz: 3658ebc181adebd904bdb3da749349c92686b173a168dc5f73a5ef1f968ff7bf
+  data.tar.gz: eef09ce59406c0341c95977d3967be1e402be4288cf63af7ed5e6604375bc438
 SHA512:
-  metadata.gz: ebb52de791e396e475cbfb76040645120e4892f12d9fc9f3b7901d86a9b52adf2d7314b6795472640fb5a3eb2c1f44b49191a823457a9b94588fea129a530870
-  data.tar.gz: c373da2d40a7e3da1b281408636c38107430a7583155f3923539e8db7ce85c09cffd2b1233fc867dc1f56dd94e86281dd7820a9131d5ed544f1dd3439def249b
+  metadata.gz: 4ccd88dd529cfcbc6c71fff712f509509030d1ba74a705ae6e41b74b9e93146198cfa3ec5820407bec3221c8256146630221ae040e80e64aad89467625c25e1f
+  data.tar.gz: c170a6b2a71b8df5f46e9faf57bd74074e79c1189a18ea0fd07404dc1a97dd206b4a7f855f715ec4fc9d30f7ff1607bd3f5816d0b72603d1c376efd030ea90b6

data/README.md

@@ -13,7 +13,7 @@ Add `rack-reducer` to your Gemfile:
 gem 'rack-reducer', require: 'rack/reducer'
 ```
 
-Rack::Reducer has zero dependencies beyond Rack itself.
+Rack::Reducer has no dependencies beyond Rack itself.
 
 Use
 ------------------------------------------
@@ -33,6 +33,7 @@ data. Here’s how you might use it in a Rails controller:
 ```ruby
 # app/controllers/artists_controller.rb
 class ArtistsController < ApplicationController
+
   # Step 1: Create a reducer
   ArtistReducer = Rack::Reducer.create(
     Artist.all,
@@ -70,6 +71,10 @@ This example app would handle requests as follows:
 [{ "name": "James Blake", "genre": "electronic" }]
 ```
 
+API Documentation
+---------------------------
+https://www.rubydoc.info/gems/rack-reducer
+
 Framework-specific Examples
 ---------------------------
 These examples apply Rack::Reducer in different frameworks and ORMs. The
@@ -81,7 +86,7 @@ This example uses [Sinatra][sinatra] to handle requests, and [Sequel][sequel]
 as an ORM.
 
 ```ruby
-# sinatra_functional_style.rb
+# config.ru
 class SinatraExample < Sinatra::Base
   DB = Sequel.connect ENV['DATABASE_URL']
 
@@ -135,7 +140,6 @@ env['rack.reduction'], then calls the next app in the middleware stack. You can
 change the `env` key by passing a new name as option to `use`:
 
 ```ruby
-# config.ru
 use Rack::Reducer::Midleware, key: 'custom.key', dataset: ARTISTS, filters: [
   # an array of lambdas
 ]
@@ -179,11 +183,10 @@ filter, and skip running the filter altogether when the keyword argments aren't
 present.
 
 But sometimes you'll want to run a filter with a default value, even when the
-required params are missing.  The code below will order by `params[:sort]` when
+required params are missing. The code below will order by `params[:sort]` when
 it exists, and by name otherwise.
 
 ```ruby
-# app/controllers/artists_controller.rb
 class ArtistsController < ApplicationController
   ArtistReducer = Rack::Reducer.create(
     Artist.all,
@@ -218,7 +221,6 @@ class ArtistsController < ApplicationController
 end
 ```
 
-
 How Rack::Reducer Works
 --------------------------------------
 Rack::Reducer takes a dataset, an array of lambdas, and a params hash.

data/lib/rack/reducer/reduction.rb

@@ -12,6 +12,9 @@ module Rack
       def initialize(dataset, *filters)
         @dataset = dataset
         @filters = filters
+        @default_filters = filters.select do |filter|
+          filter.required_argument_names.empty?
+        end
       end
 
       # Run +@filters+ against the params argument
@@ -19,10 +22,17 @@ module Rack
       #   a Rack-compatible params hash
       # @return +@dataset+ with the matching filters applied
       def apply(params)
-        return @dataset if !params || params.empty?
+        if !params || params.empty?
+          return @dataset if @default_filters.empty?
+
+          filters = @default_filters
+          symbolized_params = {}
+        else
+          filters = @filters
+          symbolized_params = params.to_unsafe_h.symbolize_keys
+        end
 
-        symbolized_params = params.to_unsafe_h.symbolize_keys
-        @filters.reduce(@dataset) do |data, filter|
+        filters.reduce(@dataset) do |data, filter|
           next data unless filter.satisfies?(symbolized_params)
 
           data.instance_exec(

data/lib/rack/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   module Reducer
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/spec/benchmarks.rb

@@ -25,18 +25,27 @@ conditional_app = lambda do |env|
   if (name = params['name'])
     @artists = @artists.grep(:name, "%#{name}%", case_insensitive: true)
   end
+  if env['DEFAULTS']
+    @artists = @artists.order(:name)
+  end
   Rack::Response.new(@artists).finish
 end
 
 TestReducer = Rack::Reducer.create(
+  DB[:artists],
+  ->(genre:) { where(genre: genre.to_s) },
+  ->(name:) { grep(:name, "%#{name}%", case_insensitive: true) }
+)
+TestReducerWithDefaults = Rack::Reducer.create(
   DB[:artists],
   ->(genre:) { where(genre: genre.to_s) },
   ->(name:) { grep(:name, "%#{name}%", case_insensitive: true) },
+  ->(sort: 'name') { order(sort.to_sym) }
 )
 
 reducer_app = lambda do |env|
   params = Rack::Request.new(env).params
-  @artists = TestReducer.apply(params)
+  @artists = env['DEFAULTS'] ? TestReducerWithDefaults.apply(params) : TestReducer.apply(params)
   Rack::Response.new(@artists).finish
 end
 
@@ -44,7 +53,8 @@ Benchmark.ips do |bm|
   env = {
     'REQUEST_METHOD' => 'GET',
     'PATH_INFO' => '/',
-    'rack.input' => StringIO.new('')
+    'rack.input' => StringIO.new(''),
+    'DEFAULTS' => false
   }
 
   query = {
@@ -67,5 +77,13 @@ Benchmark.ips do |bm|
     reducer_app.call env.dup
   end
 
+  bm.report('Conditionals (defaults)') do
+    conditional_app.call env.merge('DEFAULTS' => true)
+  end
+
+  bm.report('Reducer (defaults)') do
+    reducer_app.call env.merge('DEFAULTS' => true)
+  end
+
   bm.compare!
 end

data/spec/fixtures.rb

@@ -17,7 +17,7 @@ module Fixtures
     ->(name:) {
       select { |item| item[:name].match(/#{name}/i) }
     },
-    ->(sort:) {
+    ->(sort: 'name') {
       sort_by { |item| item[sort.to_sym] }
     },
     ->(releases:) {

data/spec/rails_spec.rb

@@ -1,36 +1,53 @@
 require 'spec_helper'
 require_relative 'fixtures'
-require 'action_controller/railtie'
-require 'securerandom'
 
-class RailsApp < Rails::Application
-  routes.append do
-    get "/", to: "artists#index"
-    get "/query", to: "artists#query"
-  end
+Process.respond_to?(:fork) && RSpec.describe('in a Rails app') do
+  BuildRailsApp = lambda do
+    require 'action_controller/railtie'
+    require 'securerandom'
+    app = Class.new(Rails::Application) do
+      routes.append do
+        get "/", to: "artists#index"
+        get "/query", to: "artists#query"
+      end
 
-  config.api_only = true
-  config.eager_load = true
-  config.secret_key_base = SecureRandom.hex(64)
-end
+      config.api_only = true
+      config.eager_load = true
+      config.secret_key_base = SecureRandom.hex(64)
+    end
+
+    ArtistsController = Class.new(ActionController::API) do
+      def index
+        @artists = Fixtures::ArtistReducer.apply(params)
+        render json: @artists
+      end
+
+      def query
+        @artists = Fixtures::ArtistReducer.apply(request.query_parameters)
+        render json: @artists
+      end
+    end
 
-class ArtistsController < ActionController::API
-  def index
-    @artists = Fixtures::ArtistReducer.apply(params)
-    render json: @artists
+    app.initialize!
   end
 
-  def query
-    @artists = Fixtures::ArtistReducer.apply(request.query_parameters)
-    render json: @artists
+  let(:app) { BuildRailsApp.call }
+
+  it 'works with ActionController::Parameters' do
+    pid = Process.fork do
+      get('/') { |res| expect(res.status).to eq(200) }
+    end
+    Process.wait pid
   end
-end
 
-RSpec.describe RailsApp do
-  let(:app) { RailsApp.initialize! }
+  it 'works with request.query_parameters' do
+    pid = Process.fork do
+      get('/query') { |res| expect(res.status).to eq(200) }
+    end
+    Process.wait(pid)
+  end
 
-  it 'works with ActionController::Parameters and a plain hash' do
-    get('/') { |res| expect(res.status).to eq(200) }
-    get('/query') { |res| expect(res.status).to eq(200) }
+  it 'does not load ActiveSupport into global scope b/c of this spec' do
+    expect { ''.blank? }.to raise_error(NoMethodError)
   end
 end

data/spec/reducer_spec.rb

@@ -64,10 +64,17 @@ RSpec.describe Rack::Reducer do
     expect(Fixtures::ArtistReducer.apply(nil)).to be_truthy
   end
 
-  it 'can sort' do
-    get '/artists?order=genre' do |response|
+  it 'applies default filters' do
+    get '/artists' do |response|
+      name = response.json[0]['name']
+      expect(name).to eq('Björk')
+    end
+  end
+
+  it 'can override default params' do
+    get '/artists?sort=genre' do |response|
       genre = response.json[0]['genre']
-      expect(genre).to eq('alternative')
+      expect(genre).to eq('alt-soul')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-reducer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Chris Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-30 00:00:00.000000000 Z
+date: 2019-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack