philtre 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554f9586dbea206ed2c4d498f846c0fb135aa29b
-  data.tar.gz: f8ba5129e7b77a349803a24028834dfe537dbd4e
+  metadata.gz: c75bbf7d7dfed6ed3cd5afb6f4477f48b613e8e2
+  data.tar.gz: 8d4dd4dc4075865c44baa7872a03ff6dbf21fed1
 SHA512:
-  metadata.gz: 6d2b3db1dc47dedbee316e3c78df9d2c305f47e3f05a5bf711f27d7014f4f418758762f84d367009e452a733bacd9f552c6c5b4c2ff75417cf8f5fe9c052bdaa
-  data.tar.gz: 618d2eacbd24c67eb5552551fb28d77ad1c18ae5f5e586f056b3e5dba3ef36f489498a7c99dccaf14c832de7e80670386cc54ee3b734c58413fdffeb98a07167
+  metadata.gz: dcb1f7273340067c4d12faa431406a8b1f9f8658730d1516cdb1bf9568b95033f71e6631c497c6dcef1854193cecba2d18754a06406e5546cc0cff41cedd975d
+  data.tar.gz: 057199f52f8ec5b894020acb67e618ccfe952e450b374e8e29d68163e587ba8aa756376d8f5ba11e0bc3961634968a2fa273db3ac142d7df9b9dc4600f7179b1

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - jruby-9.0.5.0
+  - jruby-9.1.0.0
+  - rbx-2
 script: bundle exec rspec spec

data/AUTHORS

@@ -0,0 +1,2 @@
+John Anderson
+Damir Roso - idea nil parameter values

data/History.txt

@@ -0,0 +1,7 @@
+== 0.1.1
+* drop support for ruby-2.0.0
+* add customisable parameter filtering
+* null and not_null predicates
+
+== 0.1.0
+* initial release

data/README.md

@@ -1,4 +1,4 @@
-# philtre [![Gem Version](https://badge.fury.io/rb/philtre.png)](http://badge.fury.io/rb/philtre) [![Build Status](https://travis-ci.org/djellemah/philtre.png?branch=master)](https://travis-ci.org/djellemah/philtre)
+# philtre [![Gem Version](https://badge.fury.io/rb/philtre.svg)](http://badge.fury.io/rb/philtre) [![Build Status](https://travis-ci.org/djellemah/philtre.svg?branch=master)](https://travis-ci.org/djellemah/philtre)
 
 It's the [Sequel](http://sequel.jeremyevans.net) equivalent for Ransack, Metasearch, Searchlogic. If
 this doesn't make you fall in love, I don't know what will :-p
@@ -75,6 +75,8 @@ There are a range of predefined predicates, mostly borrowed from the other searc
   not_blank
   like_all
   like_any
+  null
+  not_null
 ```
 
 ## Custom Predicates
@@ -104,8 +106,8 @@ Now you can pass the filter_parameter hash ```{tagged_by_id: 45}```.
 
 The result of a predicate block should be a ```Sequel::SQL::Expression``` (ie
 one of Sequel's hash expressions in the simplest case) which will work instead
-of its named placeholder. That is, if the placeholder is inside a SELECT
-clause it worked work to give in an ORDER BY.
+of its named placeholder. So for example, if the placeholder is inside a SELECT
+clause it wouldn't work to give it an ORDER BY expression.
 
 2) You could also inherit from ```Philtre::Filter``` and override
 ```#predicates```. And optionally override ```Philtre.new``` (which is just a
@@ -163,7 +165,7 @@ is canonical in that all the other possibilities use it.
 
 ## Highly Advanced Usage
 
-Sometimes method chaining gets ugly. So you can say
+Sometimes method chaining gets ugly. So you can install gem ripar, then you can say
 
 ``` ruby
   store_id_range = 20..90
@@ -174,9 +176,10 @@ Sometimes method chaining gets ugly. So you can say
   end
 ```
 
-Notice that values outside the block are accessible inside, _without_
-the need for a block parameter. This uses Ripar under the cover and indirects
-the binding lookup, so may result in errors that you won't expect.
+Notice that values outside the block are accessible inside, _without_ the need
+for a block parameter. This uses [Ripar](https://github.com/djellemah/ripar/)
+under the cover and indirects the binding lookup, so may result in errors that
+you won't expect.
 
 ## Specs
 

data/lib/philtre/filter.rb

@@ -28,11 +28,12 @@ module Philtre
     def initialize( filter_parameters = nil, &custom_predicate_block )
       # This must be a new instance of Hash, because sometimes
       # HashWithIndifferentAccess is passed in, which breaks things in here.
+
       # Don't use symbolize_keys because that creates a dependency on ActiveSupport
+      # have to iterate anyway to convert keys to symbols
       @filter_parameters =
       if filter_parameters
-        # preserve 2.0 compatibility
-        filter_parameters.inject({}){|ha,(k,v)| ha[k.to_sym] = v; ha}
+        filter_parameters.each_with_object(Hash.new){|(k,v),ha| ha[k.to_sym] = v}
       else
         {}
       end
@@ -67,12 +68,22 @@ module Philtre
 
     alias apply call
 
+    # called by valued_parameters to generate the set of expressions. This
+    # returns true for a value that show up in the set of expressions, false
+    # otherwise.
+    #
+    # Intended to be overridden if necessary.
+    def valued_parameter?( key, value )
+      value.is_a?(Array) || !value.blank?
+    end
+
     # Values in the parameter list which are not blank, and not
     # an ordering. That is, parameters which will be used to generate
     # the filter expression.
     def valued_parameters
-      filter_parameters.select do |key,value|
-        key.to_sym != :order && (value.is_a?(Array) || !value.blank?)
+      @valued_parameters ||= filter_parameters.select do |key,value|
+        # :order is special, it must always be excluded
+        key.to_sym != :order && valued_parameter?(key,value)
       end
     end
 
@@ -164,6 +175,7 @@ module Philtre
       @order_expressions = nil
       @order_hash = nil
       @order_clause = nil
+      @valued_parameters = nil
     end
 
     def clone( extra_parameters = {} )

data/lib/philtre/grinder.rb

@@ -1,4 +1,8 @@
-require 'ripar'
+begin
+  require 'ripar'
+rescue LoadError
+  "silently move on cos it's not critical and we'll just not add those bits"
+end
 
 require 'philtre/filter.rb'
 require 'philtre/place_holder.rb'

data/lib/philtre/predicate_splitter.rb

@@ -17,7 +17,7 @@ module Philtre
     # split suffix from the key and store the two values as name and op
     # return truthy if successful
     def split_key( suffix )
-      rv = @key =~ /(.*?)_?(#{suffix})$/
+      rv = @key =~ /\A(?:(.*?)_)?(#{suffix})\z/
       @field, @op = $1, $2
       rv
     end

data/lib/philtre/predicates.rb

@@ -60,12 +60,15 @@ module Philtre
     alias [] call
 
     def predicate_names
-      DefaultPredicates.instance_methods
+      # ruby-2.3 no longer stores methods in order of definition. So sort by
+      # longest so that we don't get false positives from shorter predicates
+      # that are substrings of longer predicates, eg blank matching
+      # thing_not_blank.
+      DefaultPredicates.instance_methods.sort_by{|name| -name.length}
     end
 
     # Define the set of default predicates.
     DefaultPredicates = PredicateDsl.new do
-      # longer suffixes first, so they match first in define_name_predicate
       not_eq           {|expr, val| ~Sequel.expr( expr => val)       }
 
       def not_like( expr, val )
@@ -78,13 +81,15 @@ module Philtre
         Sequel.~(blank expr, val)
       end
 
+      null {|expr,_| Sequel.expr(expr => nil)}
+      not_null {|expr,_| Sequel.~(Sequel.expr(expr => nil))}
+
       def blank(expr, _)
         is_nil = Sequel.expr(expr => nil)
         is_empty = Sequel.expr(expr => '')
         Sequel.| is_nil, is_empty
       end
 
-      # and now the shorter suffixes
       eq               {|expr, val|  Sequel.expr( expr => val)       }
       gt               {|expr, val|    expr >  val                   }
       gte( :gteq )     {|expr, val|    expr >= val                   }
@@ -103,7 +108,7 @@ module Philtre
       end
     end
 
-    # make the available to Predicates instances.
+    # make them available to Predicate instances.
     include DefaultPredicates
   end
 end

data/lib/philtre/sequel_extensions.rb

@@ -1,19 +1,21 @@
 # TODO docs for this
-class Sequel::Dataset
-  include Ripar
+if defined? Ripar
+  class Sequel::Dataset
+    include Ripar
 
-  # make the roller understand dataset method
-  def roller
-    rv = super
-    class << rv
-      def to_dataset; riven end
+    # make the roller understand dataset method
+    def roller
+      rv = super
+      class << rv
+        def to_dataset; riven end
+      end
+      rv
     end
-    rv
-  end
 
-  # roll the block and return the resulting dataset immediately
-  def rolled( &blk )
-    roller.rive &blk
+    # roll the block and return the resulting dataset immediately
+    def rolled( &blk )
+      roller.rive &blk
+    end
   end
 end
 

data/lib/philtre/version.rb

@@ -1,3 +1,3 @@
 module Philtre #:nodoc:
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/philtre.gemspec

@@ -20,11 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'sequel'
   spec.add_dependency 'fastandand'
-  spec.add_dependency 'ripar', '~> 0.0.3'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'sqlite3'
 end

data/spec/dataset_spec.rb

@@ -1,6 +1,4 @@
-require 'rspec'
-require 'faker'
-require 'sequel'
+require_relative 'spec_helper.rb'
 
 require_relative '../lib/philtre/grinder.rb'
 require_relative '../lib/philtre/sequel_extensions.rb'
@@ -29,29 +27,36 @@ describe Sequel::Dataset do
 
   it 'passes apply_unknown'
 
-  describe '#roller' do
-    it 'result has to_dataset' do
-      rlr = subject.roller do
-        where title: 'Exalted Fromaginess'
-      end
+  describe 'fancy stuff' do
+
+    describe '#roller' do
+      it 'result has to_dataset' do
+        pending "Ripar optionally not loaded" unless defined? Ripar
+
+        rlr = subject.roller do
+          where title: 'Exalted Fromaginess'
+        end
 
-      # This depends on Ripar, so it's a bit fragile
-      rlr.should respond_to(:__class__)
-      rlr.__class__.should == Ripar::Roller
+        # This depends on Ripar, so it's a bit fragile
+        rlr.should respond_to(:__class__)
+        rlr.__class__.should == Ripar::Roller
 
-      rlr.should_not respond_to(:datset)
-      rlr.should respond_to(:to_dataset)
+        rlr.should_not respond_to(:datset)
+        rlr.should respond_to(:to_dataset)
+      end
     end
-  end
 
-  describe '#rolled' do
-    it 'gives back a rolled dataset' do
-      rlr = subject.rolled do
-        where title: 'Exalted Fromaginess'
+    describe '#rolled' do
+      it 'gives back a rolled dataset' do
+        pending "Ripar optionally not loaded" unless defined? Ripar
+
+        rlr = subject.rolled do
+          where title: 'Exalted Fromaginess'
+        end
+        rlr.should be_a(Sequel::Dataset)
+        rlr.should_not respond_to(:datset)
+        rlr.should_not respond_to(:to_dataset)
       end
-      rlr.should be_a(Sequel::Dataset)
-      rlr.should_not respond_to(:datset)
-      rlr.should_not respond_to(:to_dataset)
     end
   end
 end

data/spec/filter_spec.rb

@@ -1,6 +1,4 @@
-require 'rspec'
-require 'faker'
-
+require_relative 'spec_helper.rb'
 require_relative '../lib/philtre/filter.rb'
 
 # for blank?
@@ -114,7 +112,7 @@ describe Philtre::Filter do
       @dataset.order( *filter.order_clause ).sql.should =~ /order by things desc$/i
     end
 
-    it 'respecs asc' do
+    it 'respects asc' do
       filter = described_class.new one: 1, two: 2, order: 'things_desc'
       @dataset.order( *filter.order_clause ).sql.should =~ /order by things desc$/i
     end
@@ -131,7 +129,7 @@ describe Philtre::Filter do
   end
 
   describe '#predicates' do
-    EASY_PREDICATES = %i[gt gte gteq lt lte lteq eq not_eq matches like not_like]
+    EASY_PREDICATES = %i[gt gte gteq lt lte lteq eq not_eq matches like not_like not_null null]
     TRICKY_PREDICATES = %i[like_all like_any not_blank blank]
 
     it 'creates predicates' do
@@ -201,17 +199,34 @@ describe Philtre::Filter do
     end
 
     it 'not_blank' do
-      field = Sequel.expr Faker::Lorem.word
+      field = Faker::Lorem.word
       expr = described_class.predicates.call :"#{field}_not_blank", Faker::Lorem.word
 
       expr.op.should == :AND
+      is_not_null, not_equals_empty = expr.args
 
       # the not-nil part
-      expr.args.first.op.should == :'IS NOT'
+      is_not_null.op.should == :'IS NOT'
 
       # the not empty string part
-      expr.args.last.op.should == :'!='
-      expr.args.last.args.last.should == ''
+      not_equals_empty.op.should == :'!='
+      not_equals_empty.args.last.should == ''
+    end
+
+    it 'blank' do
+      field = Faker::Lorem.word
+      expr = described_class.predicates.call :"#{field}_blank", Faker::Lorem.word
+
+      expr.op.should == :OR
+
+      is_null, equals_empty = expr.args
+
+      # the null part
+      is_null.op.should == :'IS'
+
+      # the empty string part
+      equals_empty.op.should == :'='
+      equals_empty.args.last.should == ''
     end
   end
 
@@ -406,11 +421,21 @@ describe Philtre::Filter do
       sql.should =~ /select \* from planks where \(title = '\w+'\)$/i
     end
 
-    it 'excludes nil values' do
+    it 'excludes nil values by default' do
       filter.filter_parameters[:name] = nil
       sql = filter.apply(@dataset).sql
       sql.should =~ /select \* from planks where \(title = '\w+'\)$/i
     end
+
+    it 'can customise value exclusion' do
+      def filter.valued_parameter?(key,value)
+        key != :order
+      end
+
+      filter.filter_parameters[:name] = nil
+      sql = filter.apply(@dataset).sql
+      sql.should =~ /SELECT \* FROM planks WHERE \(\(name IS NULL\) AND \(title = '\w+'\)\)/
+    end
   end
 
   describe '#empty?' do

data/spec/grinder_spec.rb

@@ -1,7 +1,4 @@
-require 'rspec'
-require 'faker'
-require 'sequel'
-require 'ripar'
+require_relative 'spec_helper.rb'
 
 require_relative '../lib/philtre.rb'
 
@@ -161,6 +158,8 @@ describe Philtre::Grinder do
   end
 
   it 'handles rollers' do
+    pending "Ripar optionally not loaded" unless defined? Ripar
+
     grinder = Philtre::Grinder.new Philtre::Filter.new(person_id: 212728)
     tds = ds.roller do
       where linkage: other_ds.where( :person_id.lieu )
@@ -172,9 +171,9 @@ describe Philtre::Grinder do
   end
 
   it 'handles Models' do
-    Sequel::Model.db = Sequel.sqlite
+    Sequel::Model.db = Sequel.mock
     class Ods < Sequel::Model(:ods); end
     Philtre::Grinder.new( Philtre::Filter.new ).transform(Ods).should be_a(Sequel::Dataset)
-    Philtre::Grinder.new( Philtre::Filter.new ).transform(Ods).sql.should =~ /SELECT \* FROM .ods./
+    Philtre::Grinder.new( Philtre::Filter.new ).transform(Ods).sql.should =~ /SELECT \* FROM ods/
   end
 end

data/spec/predicate_splitter_spec.rb

@@ -1,7 +1,6 @@
-require 'rspec'
-require 'faker'
-
+require_relative 'spec_helper.rb'
 require_relative '../lib/philtre/predicate_splitter.rb'
+require_relative '../lib/philtre/predicates.rb'
 
 # for blank?
 Sequel.extension :blank
@@ -28,6 +27,7 @@ describe Philtre::PredicateSplitter do
 
     describe 'unsuccessful' do
       let(:splitter){ Philtre::PredicateSplitter.new 'birth_year', 'fifteeen' }
+
       it 'returns false' do
         splitter.split_key( :like ).should be_falsey
       end
@@ -44,11 +44,31 @@ describe Philtre::PredicateSplitter do
     end
 
     describe 'custom predicate' do
-      let(:splitter){ Philtre::PredicateSplitter.new( 'custom_predicate', 'fifteeen' ) }
-      it 'accepts the whole thing' do
+      it 'accepts the whole thing, undeterred by _' do
+        splitter = Philtre::PredicateSplitter.new 'custom_predicate', 'fifteeen'
         (splitter === :custom_predicate).should === 0
       end
     end
+
+    describe "'ware the false matches, laddie" do
+      Philtre::Predicates::DefaultPredicates.instance_methods.each do |suffix|
+        word = Faker::Lorem.words(rand(1..3)) * '_'
+
+        let(:suffix){suffix}
+        let(:word){word}
+
+        it "#{word}#{suffix} unsplit" do
+          splitter = Philtre::PredicateSplitter.new "#{word}#{suffix}", 'blabla'
+          splitter.split_key(suffix).should be_falsey
+        end
+
+        it "#{word}_#{suffix} split" do
+          splitter = Philtre::PredicateSplitter.new "#{word}_#{suffix}", 'unbla'
+          splitter.split_key suffix
+          splitter.field.should == word.to_sym
+        end
+      end
+    end
   end
 end
 

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'faker'
+require 'sequel'
+
+# turn off the "old syntax" warnings
+RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

data/tasks/console.rake

@@ -3,7 +3,7 @@ task :console do
   ARGV.shift()
   ENV['RUBYLIB'] ||= ''
   ENV['RUBYLIB'] += ":#{File.expand_path('.')}/lib/philtre"
-  exec "pry -r philtre -I ./lib -I ."
+  exec "pry -r sequel -r philtre -I ./lib -I ."
 end
 
 task :pry => :console

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philtre
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2016-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ripar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Encode various filtering operations in http parameter hashes
 email:
 - panic@semiosix.com
@@ -131,7 +103,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- AUTHORS
 - Gemfile
+- History.txt
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -152,6 +126,7 @@ files:
 - spec/filter_spec.rb
 - spec/grinder_spec.rb
 - spec/predicate_splitter_spec.rb
+- spec/spec_helper.rb
 - tasks/console.rake
 homepage: http://github.com/djellemah/philtre
 licenses:
@@ -173,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: http parameter-hash friendly filtering for Sequel
@@ -182,3 +157,4 @@ test_files:
 - spec/filter_spec.rb
 - spec/grinder_spec.rb
 - spec/predicate_splitter_spec.rb
+- spec/spec_helper.rb