rack-reducer 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f873c82d2086af18eb08d88accb164a6694ff5be7c88f468db013ba068ae009
-  data.tar.gz: e0ebf95f94eedc38f61da779e578844c0d7645f725871713af73759ce9817ef2
+  metadata.gz: 89560b1f9fb58a56452e6e9cbba2a9dd5e0159b938c804628750549da310c543
+  data.tar.gz: f7e9667193f0e4e6e5b413ceec8506919f784604d5be97746239688f3074ab8b
 SHA512:
-  metadata.gz: 18b2af15129314633b9c3e29a5045bf4cf7927e8b6cae72b4cb160129e0edc55b4f231312481098ba654d30d3b0e464fd9c3b272f1dd2d736622e43d4d866fce
-  data.tar.gz: be9d27ca83200a17a6462f0f637d7c95ad1c55d17327e606c60c1733d8e52b6b6790d57a5b70732261d393a6ba3fa91740e2ccc0bd6fca5b9ea8df746944cf6c
+  metadata.gz: fa641c8d24f2bd6a52f523e447c43d1714c92db33175750b4728512bcdca9f5668a018a4be1b5a504fb3ad0188ace6e5e3911503c6a06d48cbf3d9a64aecf489
+  data.tar.gz: d60cbdae9d7d225024680262be9be5b8b92a923ad224452dfd7e383410e75d5ee717ac3842b9f0ed95ebb8b3789ef36bc3880794b62577f1162a6d67816df77b

data/README.md

@@ -2,6 +2,7 @@ Rack::Reducer
 ==========================================
 [![Build Status](https://travis-ci.org/chrisfrank/rack-reducer.svg?branch=master)](https://travis-ci.org/chrisfrank/rack-reducer)
 [![Maintainability](https://api.codeclimate.com/v1/badges/675e7a654c7e11c24b9f/maintainability)](https://codeclimate.com/github/chrisfrank/rack-reducer/maintainability)
+[![Version](https://img.shields.io/gem/v/rack-reducer.svg)](https://rubygems.org/gems/rack-reducer)
 
 Declaratively filter data via URL params, in any Rack app, with any ORM.
 
@@ -34,8 +35,8 @@ data. Here’s how you might use it in a Rails controller:
 # app/controllers/artists_controller.rb
 class ArtistsController < ApplicationController
 
-  # Step 1: Create a reducer
-  ArtistReducer = Rack::Reducer.create(
+  # Step 1: Instantiate a reducer
+  ArtistReducer = Rack::Reducer.new(
     Artist.all,
     ->(name:) { where('lower(name) like ?', "%#{name.downcase}%") },
     ->(genre:) { where(genre: genre) },
@@ -91,7 +92,7 @@ class SinatraExample < Sinatra::Base
   DB = Sequel.connect ENV['DATABASE_URL']
 
   # dataset is a Sequel::Dataset, so filters use Sequel query methods
-  ArtistReducer = Rack::Reducer.create(
+  ArtistReducer = Rack::Reducer.new(
     DB[:artists],
     ->(genre:) { where(genre: genre) },
     ->(name:) { grep(:name, "%#{name}%", case_insensitive: true) },
@@ -155,7 +156,7 @@ more sense to keep your reducers in your models instead.
 class Artist < ApplicationRecord
   # filters get instance_exec'd against the dataset you provide -- in this case
   # it's `self.all` -- so filters can use query methods, scopes, etc
-  Reducer = Rack::Reducer.create(
+  Reducer = Rack::Reducer.new(
     self.all,
     ->(name:) { by_name(name) },
     ->(genre:) { where(genre: genre) },
@@ -188,7 +189,7 @@ it exists, and by name otherwise.
 
 ```ruby
 class ArtistsController < ApplicationController
-  ArtistReducer = Rack::Reducer.create(
+  ArtistReducer = Rack::Reducer.new(
     Artist.all,
     ->(genre:) { where(genre: genre) },
     ->(sort: 'name') { order(sort.to_sym) }
@@ -203,8 +204,8 @@ end
 
 Calling Rack::Reducer as a function
 -------------------------------------------
-For a slight performance penalty (~5%), you can skip creating a reducer via
-`::create` and just call Rack::Reducer as a function. This can be useful when
+For a slight performance penalty (~5%), you can skip instantiating a reducer via
+`::new` and just call Rack::Reducer as a function. This can be useful when
 prototyping, mostly because you don't need to think about naming anything.
 
 ```ruby
@@ -271,7 +272,7 @@ instead if you want to handle parameterless requests at top speed.
 ```ruby
 # app/controllers/artists_controller.rb
 class ArtistController < ApplicationController
-  # ArtistReducer = Rack::Reducer.create(...etc etc)
+  # ArtistReducer = Rack::Reducer.new(...etc etc)
 
   def index
     @artists = ArtistReducer.apply(request.query_parameters)
@@ -292,6 +293,11 @@ It is Rails-only, but it supports more than just ActiveRecord.
 For Sinatra, Simon Courtois has a [Sinatra port of has_scope][sin_has_scope].
 It depends on ActiveRecord.
 
+Contributors
+---------------
+Thank you @danielpuglisi, @nicolasleger, @jeremyshearer, and @shanecav84 for
+helping improve Rack::Reducer!
+
 Contributing
 -------------------------------
 ### Bugs

data/lib/rack/reducer.rb

@@ -1,21 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'reducer/reduction'
+require_relative 'reducer/refinements'
 require_relative 'reducer/middleware'
-require_relative 'reducer/warnings'
 
 module Rack
-  # Declaratively filter data via URL params, in any Rack app.
-  module Reducer
-    # Create a Reduction object that can filter +dataset+ via +#apply+.
+  # Declaratively filter data via URL params, in any Rack app, with any ORM.
+  class Reducer
+    using Refinements
+
+    class << self
+      # make ::create an alias of ::new, for compatibility with v1
+      alias create new
+
+      # Call Rack::Reducer as a function instead of creating a named reducer
+      def call(params, dataset:, filters:)
+        new(dataset, *filters).apply(params)
+      end
+    end
+
+    # Instantiate a Reducer that can filter `dataset` via `#apply`.
     # @param [Object] dataset an ActiveRecord::Relation, Sequel::Dataset,
     #   or other class with chainable methods
     # @param [Array<Proc>] filters  An array of lambdas whose keyword arguments
     #   name the URL params you will use as filters
-    # @return Rack::Reducer::Reduction
     # @example Create a reducer and use it in a Sinatra app
     #   DB = Sequel.connect(ENV['DATABASE_URL'])
-    #   MyReducer = Rack::Reducer.create(
+    #
+    #   MyReducer = Rack::Reducer.new(
     #     DB[:artists],
     #     lambda { |name:| where(name: name) },
     #     lambda { |genre:| where(genre: genre) },
@@ -25,63 +36,47 @@ module Rack
     #     @artists = MyReducer.apply(params)
     #     @artists.to_json
     #   end
-    def self.create(dataset, *filters)
-      Reduction.new(dataset, *filters)
+    def initialize(dataset, *filters)
+      @dataset = dataset
+      @filters = filters
+      @default_filters = filters.select do |filter|
+        filter.required_argument_names.empty?
+      end
     end
 
-    # Filter a dataset without creating a Reducer first.
-    # Note that this approach is a bit slower and less memory-efficient than
-    # creating a Reducer via ::create. Use ::create when you can.
-    #
-    # @param params [Hash] Rack-compatible URL params
-    # @param dataset [Object] A dataset, e.g. one of your App's models
-    # @param filters [Array<Proc>] An array of lambdas with keyword arguments
-    # @example Call Rack::Reducer as a function in a Sinatra app
-    #   get '/artists' do
-    #     @artists = Rack::Reducer.call(params, dataset: Artist.all, filters: [
-    #       lambda { |name:| where(name: name) },
-    #       lambda { |genre:| where(genre: genre) },
-    #     ])
-    #   end
-    def self.call(params, dataset:, filters:)
-      Reduction.new(dataset, *filters).apply(params)
-    end
+    # Run `@filters` against `url_params`
+    # @param [Hash, ActionController::Parameters, nil] url_params
+    #   a Rack-compatible params hash
+    # @return `@dataset` with the matching filters applied
+    def apply(url_params)
+      if url_params.empty?
+        # Return early with the unfiltered dataset if no default filters exist
+        return @dataset if @default_filters.empty?
+
+        # Run only the default filters
+        filters, params = @default_filters, EMPTY_PARAMS
+      else
+        # This request really does want filtering; run a full reduction
+        filters, params = @filters, url_params.to_unsafe_h.symbolize_keys
+      end
 
-    # Mount Rack::Reducer as middleware
-    # @deprecated
-    #   Rack::Reducer.new will become an alias of ::create in v2.0.
-    #   To mount middleware that will still work in 2.0, write
-    #   "use Rack::Reducer::Middleware" instead of "use Rack::Reducer"
-    def self.new(app, options = {})
-      warn "#{caller(1..1).first}}\n#{Warnings[:new]}"
-      Middleware.new(app, options)
+      reduce(params, filters)
     end
 
-    # Extend Rack::Reducer to get +reduce+ and +reduces+ as class-methods
-    #
-    # @example Make an "Artists" model reducible
-    #   class Artist < SomeORM::Model
-    #     extend Rack::Reducer
-    #     reduces self.all, filters: [
-    #       lambda { |name:| where(name: name) },
-    #       lambda { |genre:| where(genre: genre) },
-    #     ]
-    #   end
-    #   Artist.reduce(params)
-    #
-    # @deprecated
-    #   Rack::Reducer's mixin-style is deprecated and may be removed in 2.0.
-    #   To keep using Rack::Reducer in your models, create a Reducer constant.
-    #     class MyModel < ActiveRecord::Base
-    #       MyReducer = Rack::Reducer.create(dataset, *filter_functions)
-    #     end
-    #     MyModel::MyReducer.call(params)
-    def reduces(dataset, filters:)
-      warn "#{caller(1..1).first}}\n#{Warnings[:reduces]}"
-      reducer = Reduction.new(dataset, *filters)
-      define_singleton_method :reduce do |params|
-        reducer.apply(params)
+    private
+
+    def reduce(params, filters)
+      filters.reduce(@dataset) do |data, filter|
+        next data unless filter.satisfies?(params)
+
+        data.instance_exec(
+          **params.slice(*filter.all_argument_names),
+          &filter
+        )
       end
     end
+
+    EMPTY_PARAMS = {}.freeze
+    private_constant :EMPTY_PARAMS
   end
 end

data/lib/rack/reducer/middleware.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require 'rack/request'
-require_relative 'reduction'
 
 module Rack
-  module Reducer
+  class Reducer
     # Mount Rack::Reducer as middleware
     # @example A microservice that filters artists
     #   ArtistService = Rack::Builder.new do
@@ -23,10 +22,10 @@ module Rack
       def initialize(app, options = {})
         @app = app
         @key = options[:key] || 'rack.reduction'
-        @reducer = Rack::Reducer.create(options[:dataset], *options[:filters])
+        @reducer = Rack::Reducer.new(options[:dataset], *options[:filters])
       end
 
-      # Call the next app in the middleware stack, with env[key] set
+      # Call the next app in the middleware stack, with `env[key]` set
       # to the ouput of a reduction
       def call(env)
         params = Rack::Request.new(env).params

data/lib/rack/reducer/refinements.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Rack
-  module Reducer
-    # refine Proc and hash in this scope only
+  class Reducer
+    # Refine a few core classes in Rack::Reducer's scope only
     module Refinements
       refine Proc do
         def required_argument_names
@@ -37,6 +37,12 @@ module Rack
 
         alias_method :to_unsafe_h, :to_h
       end
+
+      refine NilClass do
+        def empty?
+          true
+        end
+      end
     end
 
     private_constant :Refinements

data/lib/rack/reducer/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rack
-  module Reducer
-    VERSION = '1.1.2'
+  class Reducer
+    VERSION = '2.0.0'
   end
 end

data/spec/fixtures.rb

@@ -17,14 +17,11 @@ module Fixtures
     ->(name:) {
       select { |item| item[:name].match(/#{name}/i) }
     },
-    ->(sort: 'name') {
-      sort_by { |item| item[sort.to_sym] }
-    },
     ->(releases:) {
       select { |item| item[:release_count].to_i == releases.to_i }
     },
   ]
 
-  ArtistReducer = Rack::Reducer.create(DB[:artists], *FILTERS)
+  ArtistReducer = Rack::Reducer.new(DB[:artists], *FILTERS)
 end
 

data/spec/middleware_spec.rb

@@ -4,10 +4,10 @@ require_relative 'fixtures'
 RSpec.describe Rack::Reducer::Middleware do
   using SpecRefinements
   module AppFactory
-    def self.create(key: nil, middleware_class: Rack::Reducer::Middleware)
+    def self.create(key: nil)
       Rack::Builder.new do
         use(
-          middleware_class,
+          Rack::Reducer::Middleware,
           dataset: Fixtures::DB[:artists],
           filters: Fixtures::FILTERS,
           key: key
@@ -44,20 +44,4 @@ RSpec.describe Rack::Reducer::Middleware do
       end
     end
   end
-
-  describe 'using Rack::Reducer instead of Rack::Reducer::Middleware' do
-    before do
-      @warnings = []
-      allow(Rack::Reducer).to receive(:warn) do |msg|
-        @warnings << msg
-      end
-    end
-
-    let(:app) { AppFactory.create(middleware_class: Rack::Reducer) }
-
-    it 'emits a deprecation warning' do
-      get('/')
-      expect(@warnings.last).to include('alias of ::create')
-    end
-  end
 end

data/spec/reducer_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require_relative 'fixtures'
 
-RSpec.describe Rack::Reducer do
+RSpec.describe 'Rack::Reducer' do
   using SpecRefinements
 
   let(:app) do
@@ -64,17 +64,31 @@ RSpec.describe Rack::Reducer do
     expect(Fixtures::ArtistReducer.apply(nil)).to be_truthy
   end
 
-  it 'applies default filters' do
-    get '/artists' do |response|
-      name = response.json[0]['name']
-      expect(name).to eq('Björk')
+  describe 'with default filters' do
+    let(:app) do
+      sort = ->(sort: 'name') { sort_by { |item| item[sort.to_sym] }  }
+      filters = Fixtures::FILTERS + [sort]
+      reducer = Rack::Reducer.new(Fixtures::DB[:artists], *filters)
+
+      lambda do |env|
+        req = Rack::Request.new(env)
+        res = reducer.apply(req.params).to_json
+        [200, { 'Content-Type' => 'application/json' }, [res]]
+      end
+    end
+
+    it 'applies default filters' do
+      get '/artists' do |response|
+        name = response.json[0]['name']
+        expect(name).to eq('Björk')
+      end
     end
-  end
 
-  it 'can override default params' do
-    get '/artists?sort=genre' do |response|
-      genre = response.json[0]['genre']
-      expect(genre).to eq('alt-soul')
+    it 'overrides default filters with values from params' do
+      get '/artists?sort=genre' do |response|
+        genre = response.json[0]['genre']
+        expect(genre).to eq('alt-soul')
+      end
     end
   end
 
@@ -91,22 +105,8 @@ RSpec.describe Rack::Reducer do
     end
   end
 
-  describe 'mixin-style' do
-    before { @warnings = [] }
-
-    let(:model) do
-      dataset = Fixtures::DB[:artists].dup
-      allow(dataset).to(receive(:warn)) { |msg| @warnings << msg }
-      dataset.extend Rack::Reducer
-      dataset.reduces dataset, filters: Fixtures::FILTERS
-      dataset
-    end
-
-    it 'is still supported, but with a deprecation warning' do
-      params = { 'genre' => 'electronic', 'name' => 'blake' }
-      expect(model.reduce(params).count).to eq(1)
-      expect(@warnings.first).to include('mixin-style is deprecated')
-    end
+  it 'aliases ::create and ::new' do
+    expect(Rack::Reducer.create({}, -> { 'hi' })).to be_a(Rack::Reducer)
   end
 
   it 'accepts nested params' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-reducer
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -222,10 +222,8 @@ files:
 - README.md
 - lib/rack/reducer.rb
 - lib/rack/reducer/middleware.rb
-- lib/rack/reducer/reduction.rb
 - lib/rack/reducer/refinements.rb
 - lib/rack/reducer/version.rb
-- lib/rack/reducer/warnings.rb
 - spec/benchmarks.rb
 - spec/fixtures.rb
 - spec/middleware_spec.rb

data/lib/rack/reducer/reduction.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'refinements'
-
-module Rack
-  module Reducer
-    # call `reduce` on a params hash, filtering data via lambdas with
-    # matching keyword arguments
-    class Reduction
-      using Refinements # define Proc#required_argument_names, #satisfies?, etc
-
-      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
-      # @param [Hash, ActionController::Parameters, nil] params
-      #   a Rack-compatible params hash
-      # @return +@dataset+ with the matching filters applied
-      def apply(params)
-        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
-
-        filters.reduce(@dataset) do |data, filter|
-          next data unless filter.satisfies?(symbolized_params)
-
-          data.instance_exec(
-            **symbolized_params.slice(*filter.all_argument_names),
-            &filter
-          )
-        end
-      end
-    end
-  end
-end

data/lib/rack/reducer/warnings.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Rack
-  module Reducer
-    module Warnings
-      MESSAGES = {
-        new: [
-          'Rack::Reducer.new will become an alias of ::create in v2.',
-          'To mount middleware that will still work in 2.0, write',
-          '"use Rack::Reducer::Middleware" instead of "use Rack::Reducer"',
-        ],
-        reduces: [
-          'Rack::Reducer’s mixin-style is deprecated and may be removed in v2.',
-          'To keep using Rack::Reducer in your models, use a Reducer constant.',
-          'class MyModel',
-          '  MyReducer = Rack::Reducer.create(dataset, *filter_functions)',
-          'end',
-          'MyModel::MyReducer.call(params)',
-        ]
-      }.freeze
-
-      def self.[](key)
-        MESSAGES.fetch(key, []).join("\n")
-      end
-    end
-  end
-end