philtre 0.0.0 → 0.0.1

data/spec/grinder_spec.rb

@@ -0,0 +1,180 @@
+require 'rspec'
+require 'faker'
+require 'sequel'
+require 'ripar'
+
+require_relative '../lib/philtre.rb'
+
+Sequel.extension :blank
+Sequel.extension :core_extensions
+
+describe Philtre::Grinder do
+  def ds
+    @ds ||= Sequel.mock[:t].filter( :name.lieu, :title.lieu ).order( :birth_year.lieu )
+  end
+
+  def other_ds
+    @other_ds ||= Sequel.mock[:ods]
+  end
+
+  def grinder
+    @grinder ||= Philtre::Grinder.new
+  end
+
+  it 'shows placeholders' do
+    ds.sql.should =~ /\$name/
+    ds.sql.should =~ /\$title/
+    ds.sql.should =~ /\$birth_year/
+  end
+
+  it 'shows comments' do
+    ds.sql.should =~ %r{\$name/\*\S+\*/}
+    ds.sql.should =~ %r{\$title/\*\S+\*/}
+    ds.sql.should =~ %r{\$birth_year/\*\S+\*/}
+  end
+
+  describe '#places' do
+    it 'collects placeholders' do
+      nds = grinder.transform ds, apply_unknown: false
+      grinder.places.flat_map{|k,v| v.keys}.should == %i[name title birth_year]
+    end
+
+    it 'fails before transform' do
+      ->{grinder.places}.should raise_error(/Call transform.*place/)
+    end
+  end
+
+  describe '#unknown' do
+    it 'fails before transform' do
+      ->{grinder.unknown}.should raise_error(/Call transform.*not.*filter/)
+    end
+
+    it 'has a list of unknowns' do
+      grinder = Philtre::Grinder.new Philtre::Filter.new( location: 'Spain', name: 'Bartholemew del Pince-Nez', :order => 'name_desc')
+      nds = grinder.transform ds, apply_unknown: true
+      grinder.unknown.should == %i[location]
+    end
+  end
+
+  it 'removes empty expressions' do
+    nds = grinder.transform ds, apply_unknown: false
+    nds.sql.should_not =~ /name/
+    nds.sql.should_not =~ /title/
+    nds.sql.should_not =~ /birth_year/
+  end
+
+  it 'removes empty clauses' do
+    nds = grinder.transform ds, apply_unknown: false
+    nds.sql.should_not =~ /where/i
+    nds.sql.should_not =~ /order by/i
+  end
+
+  it 'raises on unknown filter expressions' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new(blah: Faker::Name.name)
+    ->{ grinder.transform( ds, apply_unknown: false ) }.should raise_error(/unknown value/)
+  end
+
+  it 'raises on unknown order expressions' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new( :troll => :name.asc )
+    ->{ grinder.transform( ds, apply_unknown: false ) }.should raise_error(/unknown value/)
+  end
+
+  it 'substitutes expressions' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new( title: 'Jonathan Wrinklebottom' )
+    nds = grinder.transform ds, apply_unknown: false
+    nds.sql.should =~ /title = ['"`]Jonathan Wrinklebottom['"`]/i
+  end
+
+  it 'substitutes field names' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new( replace_this: 'Marna von Pffefferhaus' )
+    nds = grinder.transform( ds.filter( :replace_this.lieu(:with_other) ), apply_unknown: false )
+    nds.sql.should =~ /with_other = ['"`]Marna von Pffefferhaus['"`]/i
+  end
+
+  it 'handles order/where name clashes' do
+    ods = ds.order( :name.lieu )
+    grinder = Philtre::Grinder.new Philtre::Filter.new( name: 'Fannie Rosebottom', :order => 'name_desc')
+    nds = grinder.transform ods, apply_unknown: false
+    nds.sql.should == %q{SELECT * FROM t WHERE ((name = 'Fannie Rosebottom')) ORDER BY name DESC}
+  end
+
+  describe 'select placeholder' do
+    it 'remove empty' do
+      mds = ds.select(:name.lieu,:title,:age).where(:title_gt.lieu)
+      grinder = Philtre::Grinder.new Philtre::Filter.new( title_gt: 'sir', name: '')
+      nds = grinder.transform mds, apply_unknown: false
+      nds.sql.should == %q{SELECT title, age FROM t WHERE ((title > 'sir'))}
+    end
+
+    it 'keep non-empty' do
+      mds = ds.select(:name.lieu,:title,:age).where(:title_gt.lieu)
+      grinder = Philtre::Grinder.new Philtre::Filter.new( title_gt: 'sir', name: 'Klaas Arendse')
+      nds = grinder.transform mds, apply_unknown: false
+      nds.sql.should == %q{SELECT name, title, age FROM t WHERE ((name = 'Klaas Arendse') AND (title > 'sir'))}
+    end
+  end
+
+  it 'handles subselects' do
+    mds = Sequel.mock.from(ds.select(Sequel.lit 'sum(age) as age')).filter( :age.lieu )
+    mds.sql.should =~ /age/
+    nds = grinder.transform mds, apply_unknown: false
+    nds.sql.should =~ %r{^SELECT \* FROM \(SELECT}
+    nds.sql.should =~ /t1/
+  end
+
+  it 'applies extra parameters to the dataset after the placeholders' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new( location: 'Spain', name: 'Bartholemew del Pince-Nez', :order => 'name_desc')
+    nds = grinder.transform ds, apply_unknown: true
+    grinder.unknown.should_not be_empty
+    nds.sql.should =~ /Spain/
+  end
+
+  it 'ordering survives application of extra parameters' do
+    skip 'in Grinder#transform ordering parameters are stripped out by filter.subset'
+    grinder = Philtre::Grinder.new Philtre::Filter.new( name: 'Finky Steetchas', :order => ['name_desc', 'dunno'])
+    nds = grinder.transform ds, apply_unknown: true
+    grinder.unknown.should_not be_empty
+  end
+
+  describe 'subset stack' do
+    def ds
+      @ds ||=
+      begin
+        subselect = Sequel.mock[:sub].select(:id)
+        Sequel.mock[:t].filter( :name.lieu, :title.lieu, person_id: subselect ).order( :birth_year.lieu )
+      end
+    end
+
+    it 'gets back to where after a subselect' do
+      grinder = Philtre::Grinder.new Philtre::Filter.new(person_id: 42)
+      nds = grinder.transform ds
+      nds.sql.should =~ /person_id IN/
+      nds.sql.should =~ /person_id\s*=\s*42/
+    end
+  end
+
+  it 'handle sub-datasets' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new(person_id: 212728)
+    tds = ds.filter( linkage: other_ds.where( :person_id.lieu ) )
+    nds = grinder.transform tds
+    nds.sql.should =~ /FROM\s+ods\s+WHERE\s*\(\s*person_id\s*=\s*212728\s*\)/
+  end
+
+  it 'handles rollers' do
+    grinder = Philtre::Grinder.new Philtre::Filter.new(person_id: 212728)
+    tds = ds.roller do
+      where linkage: other_ds.where( :person_id.lieu )
+    end
+    tds.__class__.should == Ripar::Roller
+
+    nds = grinder.transform tds
+    nds.sql.should =~ /FROM\s+ods\s+WHERE\s*\(\s*person_id\s*=\s*212728\s*\)/
+  end
+
+  it 'handles Models' do
+    Sequel::Model.db = Sequel.sqlite
+    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./
+  end
+end

data/spec/predicate_splitter_spec.rb

@@ -0,0 +1,54 @@
+require 'rspec'
+require 'faker'
+
+require_relative '../lib/philtre/predicate_splitter.rb'
+
+# for blank?
+Sequel.extension :blank
+
+describe Philtre::PredicateSplitter do
+  describe '#split_key' do
+    describe 'successful' do
+      let(:splitter){ Philtre::PredicateSplitter.new( 'birth_year_like', 'fifteeen' ) }
+
+      it 'returns true' do
+        splitter.split_key( :like ).should be_truthy
+      end
+
+      it 'keeps field as symbol' do
+        splitter.split_key :like
+        splitter.field.should == :birth_year
+      end
+
+      it 'keeps op as symbol' do
+        splitter.split_key :like
+        splitter.op.should == :like
+      end
+    end
+
+    describe 'unsuccessful' do
+      let(:splitter){ Philtre::PredicateSplitter.new 'birth_year', 'fifteeen' }
+      it 'returns false' do
+        splitter.split_key( :like ).should be_falsey
+      end
+
+      it 'keeps key as symbol' do
+        splitter.split_key :like
+        splitter.field.should == :birth_year
+      end
+
+      it 'op is nil' do
+        splitter.split_key :like
+        splitter.op.should be_nil
+      end
+    end
+
+    describe 'custom predicate' do
+      let(:splitter){ Philtre::PredicateSplitter.new( 'custom_predicate', 'fifteeen' ) }
+      it 'accepts the whole thing' do
+        (splitter === :custom_predicate).should === 0
+      end
+    end
+  end
+end
+

data/tasks/console.rake

@@ -0,0 +1,10 @@
+desc "pry with libs"
+task :console do
+  ARGV.shift()
+  ENV['RUBYLIB'] ||= ''
+  ENV['RUBYLIB'] += ":#{File.expand_path('.')}/lib/philtre"
+  exec "pry -r philtre -I ./lib -I ."
+end
+
+task :pry => :console
+task :irb => :pry

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: philtre
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - John Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastandand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +80,49 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: If this doesn't make you fall in love, I don't know what will.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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'
+- !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
 executables: []
@@ -46,14 +130,30 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO
 - lib/philtre.rb
+- lib/philtre/core_extensions.rb
+- lib/philtre/empty_expression.rb
+- lib/philtre/filter.rb
+- lib/philtre/grinder.rb
+- lib/philtre/place_holder.rb
+- lib/philtre/predicate_dsl.rb
+- lib/philtre/predicate_splitter.rb
+- lib/philtre/predicates.rb
+- lib/philtre/sequel_extensions.rb
 - lib/philtre/version.rb
 - philtre.gemspec
-homepage: https://github.com/djellemah/philtre
+- spec/dataset_spec.rb
+- spec/filter_spec.rb
+- spec/grinder_spec.rb
+- spec/predicate_splitter_spec.rb
+- tasks/console.rake
+homepage: http://github.com/djellemah/philtre
 licenses:
 - MIT
 metadata: {}
@@ -76,5 +176,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: The Sequel equivalent for Ransack, Metasearch, Searchlogic
-test_files: []
+summary: http parameter-hash friendly filtering for Sequel
+test_files:
+- spec/dataset_spec.rb
+- spec/filter_spec.rb
+- spec/grinder_spec.rb
+- spec/predicate_splitter_spec.rb