brita 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5bb6a00b2f18b8868b43eb4b22803ed179bc63c
-  data.tar.gz: ff737c18910108bc92517f19f0b7a3fdc14aa0e7
+  metadata.gz: 0033a36642e9f1880486826abbdd52952eea56bc
+  data.tar.gz: 982111b429409984ed67b8a141658f7ef6f43e2c
 SHA512:
-  metadata.gz: fc412bdc2c69093bf76631f2498949c60a7d377640bdbc06bba4d6ae91f77ce97029c9a892aa295361ddd999badc6c63dfff1ebfd69f54e35b0552a4d1c70f10
-  data.tar.gz: 30830b49f18d75cac7d2249fb9a09e671c4caa1b38ecf3f1a73e3b7514cc2f7049b4ebf77e7f240b147a6ea1d5206f60aa49a9fef4ef29190bbbb78874d8cb5f
+  metadata.gz: 12d55c83c7311586ebfcc2c8d7b0e4ce79b3e9bd0a172f8deeaa59b81430ff4db5e2f51aff4447368b74ecbbc36c5c2a7f7303e33e493c7e20c3f161afb349ea
+  data.tar.gz: 6c804bfa625e895ee3107bea30fa93441405ad29ff2aab523e260c13e85c519afaea64fc0294a742c35b0d58f1abd2b9c9894247e3a9a3422b580b625ae3bc5d

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/procore/brita.svg?branch=master)](https://travis-ci.org/procore/brita)
 
-A tool to build your own filters!
+A tool to build your own filters and sorts with Rails and Active Record!
 
 ## Developer Usage
 Include Brita in your controllers, and define some filters.
@@ -109,6 +109,48 @@ class PostsController < ApplicationController
 end
 ```
 
+### Filter on Ranges
+Some parameter types support ranges. Ranges are expected to be a string with the bounding values separated by `...`
+
+For example `?filters[price]=3...50` would return records with a price between 3 and 50.
+
+The following types support ranges
+* int
+* decimal
+* boolean
+* date
+* time
+* datetime
+
+### Filter on JSON Array
+`int` type filters support sending the values as an array in the URL Query parameters. For example `?filters[id]=[1,2]`. This is a way to keep payloads smaller for GET requests. When URI encoded this will become `filters%5Bid%5D=%5B1,2%5D` which is much smaller the standard format of `filters%5Bid%5D%5B%5D=1&&filters%5Bid%5D%5B%5D=2`.
+
+On the server side, the params will be received as:
+```ruby
+# JSON array encoded result
+"filters"=>{"id"=>"[1,2]"}
+
+# standard array format
+"filters"=>{"id"=>["1", "2"]}
+```
+
+Note that this feature cannot currently be wrapped in an array and should not be used in combination with sending array parameters individually.
+ * `?filters[id][]=[1,2]` => invalid
+ * `?filters[id][]=[1,2]&filters[id][]=3` => invalid
+ * `?filters[id]=[1,2]&filters[id]=3` => valid but only 3 is passed through to the server
+ * `?filters[id]=[1,2]` => valid
+
+#### A note on encoding for JSON Array feature
+JSON arrays contain the reserved characters "`,`" and "`[`" and "`]`". When encoding a JSON array in the URL there are two different ways to handle the encoding. Both ways are supported by Rails.
+For example, lets look at the following filter with a JSON array `?filters[id]=[1,2]`:
+ * `?filters%5Bid%5D=%5B1,2%5D`
+ * `?filters%5Bid%5D%3D%5B1%2C2%5D`
+
+In both cases Rails will correctly decode to the expected result of
+```ruby
+{ "filters" => { "id" => "[1,2]" } }
+```
+
 ### Sort Types
 Every sort must have a type, so that Brita knows what to do with it. The current valid sort types are:
 * int - Sort on an integer column
@@ -187,8 +229,33 @@ Or install it yourself as:
 $ gem install brita
 ```
 
+## Without Rails
+
+We have some future plans to remove the rails dependency so that other frameworks such as Sinatra could leverage this gem.
+
 ## Contributing
-Contribution directions go here.
+
+Running tests:
+```bash
+$ bundle exec rake test
+```
 
 ## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+
+## About Procore
+
+<img
+  src="https://www.procore.com/images/procore_logo.png"
+  alt="Procore Logo"
+  width="250px"
+/>
+
+The Procore Gem is maintained by Procore Technologies.
+
+Procore - building the software that builds the world.
+
+Learn more about the #1 most widely used construction management software at
+[procore.com](https://www.procore.com/)

data/Rakefile

@@ -6,7 +6,7 @@ end
 
 require "bundler/gem_tasks"
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
 require "rdoc/task"

data/lib/brita.rb

@@ -5,6 +5,7 @@ require "brita/sort"
 require "brita/subset_comparator"
 require "brita/type_validator"
 require "brita/parameter"
+require "brita/value_parser"
 require "brita/scope_handler"
 require "brita/where_handler"
 require "brita/validators/valid_int_validator"

data/lib/brita/filter.rb

@@ -13,7 +13,7 @@ module Brita
       raise "unknown filter type: #{type}" unless type_validator.valid_type?
     end
 
-    def validation(_)
+    def validation(_sort)
       type_validator.validate
     end
 
@@ -51,6 +51,10 @@ module Brita
 
     private
 
+    def parameterize(value)
+      ValueParser.new(value: value, options: parameter.parse_options).parse
+    end
+
     def not_processable?(value)
       value.nil? && default.nil?
     end
@@ -65,20 +69,6 @@ module Brita
       end
     end
 
-    def parameterize(value)
-      if supports_ranges? && value.to_s.include?("...")
-        Range.new(*value.split("..."))
-      elsif type == :boolean
-        if Rails.version.starts_with?("5")
-          ActiveRecord::Type::Boolean.new.cast(value)
-        else
-          ActiveRecord::Type::Boolean.new.type_cast_from_user(value)
-        end
-      else
-        value
-      end
-    end
-
     def valid_scope_params?(scope_params)
       scope_params.is_a?(Array) && scope_params.all? { |symbol| symbol.is_a?(Symbol) }
     end

data/lib/brita/parameter.rb

@@ -9,8 +9,12 @@ module Brita
       @internal_name = internal_name
     end
 
-    def supports_ranges?
-      ![:string, :text, :scope].include?(type)
+    def parse_options
+      {
+        supports_boolean: supports_boolean?,
+        supports_ranges: supports_ranges?,
+        supports_json: supports_json?
+      }
     end
 
     def handler
@@ -20,5 +24,19 @@ module Brita
         WhereHandler.new(self)
       end
     end
+
+    private
+
+    def supports_ranges?
+      ![:string, :text, :scope].include?(type)
+    end
+
+    def supports_json?
+      type == :int
+    end
+
+    def supports_boolean?
+      type == :boolean
+    end
   end
 end

data/lib/brita/sort.rb

@@ -63,7 +63,7 @@ module Brita
     def validation(sort)
       {
         inclusion: { in: SubsetComparator.new(sort) },
-        allow_nil: true,
+        allow_nil: true
       }
     end
 

data/lib/brita/validators/valid_int_validator.rb

@@ -11,6 +11,10 @@ class ValidIntValidator < ActiveModel::EachValidator
   end
 
   def integer_array?(value)
+    if value.is_a?(String)
+      value = Brita::ValueParser.new(value: value).array_from_json
+    end
+
     value.is_a?(Array) && value.any? && value.all? { |v| integer_or_range?(v) }
   end
 

data/lib/brita/value_parser.rb

@@ -0,0 +1,61 @@
+module Brita
+  class ValueParser
+    attr_accessor :value, :supports_boolean, :supports_json, :supports_ranges
+    def initialize(value:, options: {})
+      @value = value
+      @supports_boolean = options.fetch(:supports_boolean, false)
+      @supports_ranges = options.fetch(:supports_ranges, false)
+      @supports_json = options.fetch(:supports_json, false)
+    end
+
+    def parse
+      @_result ||=
+        if parse_as_range?
+          range_value
+        elsif parse_as_boolean?
+          boolean_value
+        elsif parse_as_json?
+          array_from_json
+        else
+          value
+        end
+    end
+
+    def array_from_json
+      result = JSON.parse(value)
+      if result.is_a?(Array)
+        result
+      else
+        value
+      end
+    rescue JSON::ParserError
+      value
+    end
+
+    private
+
+    def parse_as_range?
+      supports_ranges && value.to_s.include?("...")
+    end
+
+    def range_value
+      Range.new(*value.split("..."))
+    end
+
+    def parse_as_json?
+      supports_json && value.is_a?(String)
+    end
+
+    def parse_as_boolean?
+      supports_boolean
+    end
+
+    def boolean_value
+      if Rails.version.starts_with?("5")
+        ActiveRecord::Type::Boolean.new.cast(value)
+      else
+        ActiveRecord::Type::Boolean.new.type_cast_from_user(value)
+      end
+    end
+  end
+end

data/lib/brita/version.rb

@@ -1,3 +1,3 @@
 module Brita
-  VERSION = "0.9.3".freeze
+  VERSION = "0.10.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brita
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Procore Technologies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +114,7 @@ files:
 - lib/brita/subset_comparator.rb
 - lib/brita/type_validator.rb
 - lib/brita/validators/valid_int_validator.rb
+- lib/brita/value_parser.rb
 - lib/brita/version.rb
 - lib/brita/where_handler.rb
 - lib/tasks/filterable_tasks.rake
@@ -123,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Summary of Brita.