rack-reducer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0be5dfa4acf3c9a2c7755c67f2bbc15a2126b5d3
-  data.tar.gz: 6bd09c026cd5e5b9fb1d8ac0425d2e525afb3a36
+SHA256:
+  metadata.gz: d400c7b68a3ecf7da56af02f7f5e86ab18177ff306d6871a10ef8f9e7bcb7109
+  data.tar.gz: ff1b1f50ccb165d041a04fced63adbd946d8976f06460ce83c30b66c91599c17
 SHA512:
-  metadata.gz: e03f7c4766706254c287c7dbb0b664cf29d8c3b7d1e210189d4c17a9cd3a013c579d4e5ee2d0cda56cbf146e639d7515aff3092cb6832621e058375316a2d692
-  data.tar.gz: 15c82a76f5a7218393656ddb4abfaa5584bc11b483326452d08ff16a4a9c3efdecbd07ed810af51401a03b07a95dadd89b76199dfc4564afb04c1f4db9a7b2ec
+  metadata.gz: 0dadfa90dce4dfd009c5dab96bc6c32557863a8413cf7888a10fe0f5af9d1479c2a93c29b79ea501abaa89dafa0de1daf95ac2665bae2534884d3c9a8cd4bf17
+  data.tar.gz: da77f4e36e9a979be6a52d37a996f10636935dc9097dc47dc22cb972d5e59a5634b327dcae60d7c9573a4e62b6b9fa789dbd0511459724a15103a619b49ccc63

data/README.md

@@ -39,7 +39,8 @@ Rack::Reducer can help. It maps incoming URL params to an array of filter
 functions you define, applies only the applicable filters, and returns your
 filtered data.
 
-You can use Rack::Reducer in your choice of two styles: mixin or functional.
+You can use Rack::Reducer in your choice of two styles: **mixin** or
+**functional**.
 
 ### Mixin style
 Call `Model.reduce(params)` in your controllers...
@@ -151,8 +152,8 @@ class SinatraFunctionalApp < Sinatra::Base
   }
 
   get '/artists' do
-    @artists = Rack::Reducer.call(params, QUERY).to_a
-    @artists.to_json
+    @artists = Rack::Reducer.call(params, QUERY)
+    @artists.to_a.to_json
   end
 end
 ```

data/lib/rack/reducer.rb

@@ -4,7 +4,21 @@ require_relative 'reducer/middleware'
 module Rack
   # Use request params to apply filters to a dataset
   module Reducer
-    # Call Rack::Reducer as a function
+    # Filter a dataset
+    # @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
+    #   ArtistReducer = {
+    #     dataset: Artist,
+    #     filters: [
+    #       lambda { |name:| where(name: name) },
+    #       lambda { |genre:| where(genre: genre) },
+    #     ]
+    #   }
+    #   get '/artists' do
+    #     @artists = Rack::Reducer.call(params, ArtistReducer)
+    #   end
     def self.call(params, dataset:, filters:)
       Reduction.new(
         params: params,
@@ -18,26 +32,25 @@ module Rack
       Middleware.new(app, options)
     end
 
-    # Extend Rack::Reducer to get `reduce` and `reduces` as class-methods
+    # 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
     #
-    # class Artist < SomeORM::Model
-    #   extend Rack::Reducer
-    #   reduces self.all, filters: [
-    #     lambda { |name:| where(name: name) },
-    #     lambda { |genre:| where(genre: genre) },
-    #   ]
-    # end
-    def reduce(params)
-      Reduction.new(
-        params: params,
-        filters: @rack_reducer_filters,
-        dataset: @rack_reducer_dataset
-      ).reduce
-    end
-
+    #   Artist.reduce(params)
     def reduces(dataset, filters:)
-      @rack_reducer_dataset = dataset
-      @rack_reducer_filters = filters
+      define_singleton_method :reduce do |params|
+        Reduction.new(
+          params: params,
+          filters: filters,
+          dataset: dataset,
+        ).reduce
+      end
     end
   end
 end

data/lib/rack/reducer/parser.rb

@@ -1,6 +1,6 @@
 module Rack
   module Reducer
-    # convert params from Sinatra, Rails, Roda, etc into a symbol hash
+    # Convert params from Sinatra, Rails, Roda, etc into a symbol hash.
     module Parser
       def self.call(data)
         data.is_a?(Hash) ? symbolize(data) : hashify(data)
@@ -12,13 +12,15 @@ module Rack
         end
       end
 
-      # turns out a Rails params hash is not really a hash
-      # it's safe to call .to_unsafe_hash here, because params
-      # are automatically sanitized by the lambda keywords
+      # Turns out a Rails params hash is not really a hash.
+      # It's safe to call .to_unsafe_hash here, because params
+      # are automatically sanitized by the lambda keywords.
       def self.hashify(data)
         fn = %i[to_unsafe_h to_h].find { |name| data.respond_to?(name) }
         symbolize(data.send(fn))
       end
     end
+
+    private_constant :Parser
   end
 end

data/lib/rack/reducer/reduction.rb

@@ -20,16 +20,14 @@ module Rack
       end
 
       def reduce
-        @props[:filters].reduce(@props[:dataset], &method(:apply_filter))
-      end
-
-      private
+        @props[:filters].reduce(@props[:dataset]) do |data, filter|
+          next data unless filter.satisfies?(@params)
 
-      def apply_filter(data, filter)
-        return data unless filter.satisfies?(@params)
-
-        data.instance_exec(@params.slice(*filter.all_argument_names), &filter)
+          data.instance_exec(@params.slice(*filter.all_argument_names), &filter)
+        end
       end
     end
+
+    private_constant :Reduction
   end
 end

data/lib/rack/reducer/refinements.rb

@@ -26,5 +26,7 @@ module Rack
         end
       end
     end
+
+    private_constant :Refinements
   end
 end

data/lib/rack/reducer/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Reducer
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
   end
 end

data/spec/sinatra_functional_spec.rb

@@ -8,8 +8,8 @@ class SinatraFunctional < Sinatra::Base
   end
 
   get '/artists' do
-    @artists = Rack::Reducer.call(params, SEQUEL_QUERY).to_a
-    @artists.to_json
+    @artists = Rack::Reducer.call(params, SEQUEL_QUERY)
+    @artists.to_a.to_json
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chris Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -317,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Dynamically filter data via URL params, in any Rack app.