philtre-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf689090e57a974c0eeb8c7e1c975def2021a4b2
+  data.tar.gz: 94dc25ac6aca1555d86a91663bc252fcaffb9d04
+SHA512:
+  metadata.gz: b1d170e78c1757a486a6fcb19776a00bd7c18581dc1c4ee0008841b06514fa560abda0cc08ccdc2c840433cfe938fa5a1ce62cd33c3b461d7152ff2bc3331c46
+  data.tar.gz: 886ea0681ac1133b0b2e34ab67d19c2545d1563c84170b7a7be9779ec3c6248bf05ce99220867db781e93d96a9a3a43ba5ba6b0efc94b3f879b1917e67a2f800

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-gemset
+.ruby-version
+*.sublime-project
+*.sublime-workspace
+.floo
+.flooignore

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in philtre-rails.gemspec
+gemspec
+
+if (local_philtre = Pathname("#{ENV['HOME']}/projects/philtre")).exist?
+  gem 'philtre', path: local_philtre
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Anderson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# philtre-rails [![Gem Version](https://badge.fury.io/rb/philtre-rails.png)](http://badge.fury.io/rb/philtre-rails)
+
+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
+
+Parse the predicates on the end of field names, and round-trip the
+search fields between incoming params, controller and views.
+
+Start with the docs for [philtre](http://github.com/djellemah/philtre) and
+then look here for rails integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'philtre-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install philtre-rails
+
+## Usage
+
+### Filter form
+
+Your controller would have something like this (you could also use the more
+common ```@filter``` and ```@results``` as well if you like):
+
+``` ruby
+helper_method def filter
+  @filter ||= Philtre.new philtre_params
+end
+
+helper_method def results
+  # where Result is a Sequel::Model subclass, or actually any kind of dataset.
+  @results ||= filter.apply Result
+end
+```
+
+Note that by default your parameters will be in ```params[:philtre]```, for
+which ```philtre_params``` is a convenience accessor.
+
+And your filter form would look something like this:
+
+``` haml
+.filter
+  = form_for philtre.for_form, url: params.slice(:controller,:action), method: 'get' do |f|
+    = f.hidden_field :order
+    = f.text_field :title_like, placeholder: 'Fancy Title'
+    = f.select :birth_year, (Date.today.year-90 .. Date.today.year).map( &:to_s), include_blank: 'Year'
+    = f.submit 'Filter', name: nil, class: 'btn'
+```
+
+The ```for_form``` method is clunky. But ```ActiveModel``` seems to only use the result of ```to_model```
+for naming and route generation, and then reverts to the object for the actual values.
+I'm hoping I'm wrong, or they had a good reason to do it that way...
+
+Don't forget the ```:order``` field. It will be important to hold the ordering state once you hook up ordering links.
+
+Speaking of which...
+
+### Basic Ordering links
+
+``` haml
+%table.results
+  %thead
+    %tr
+      %th.party= order_by filter, :party
+      %th.station= order_by filter, :station, label: 'Voting Station'
+      %th.ra.votes= order_by filter, :votes, order_link_class: MyOrderLink
+
+  -# not really ordering, but someone might find this useful
+  %tbody
+    - results.each do |result|
+      %tr
+        %td.party= result.party
+        %td.station= result.station
+        %td.ra.votes= result.votes
+```
+
+### Custom Ordering links
+
+1) You can specify the ```order_link_class``` parameter to ```order_by```.
+
+The ```OrderLink``` class defines:
+
+* the icons (ie little chunks of html) that are displayed next to the order links
+
+* the CSS class for the <a...> tag
+
+* the ordering name which shows up in the filter parameters.
+
+For example:
+
+```ruby
+class MyOrderLink < PhiltreRails::OrderLink
+  def icon
+    if active
+      expr.descending ? '^' : 'v'
+    else
+      # optionally have a no-order icon
+      '-'
+    end
+  end
+end
+```
+
+2) If you don't want to specify ```:order_link_class``` repeatedly, you can also
+replace the ```default_order_link_class``` method in a helper.
+
+## Specs
+
+Nothing fancy. Just:
+
+    $ rspec spec
+
+## Contributing
+
+1. Fork it ( https://github.com/djellemah/philtre-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/TODO

@@ -0,0 +1,8 @@
+philtre-rails:
+ ☐ report bug for ActiveModel?
+
+＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
+Archive:
+ ✔ specs @done (14-08-18 12:53) @project(philtre-rails)
+ ✔ railties so it can just be included @done (14-08-18 11:27) @project(philtre-rails)
+ ✔ place to put sort headers @done (14-08-18 11:27) @project(philtre-rails)

data/lib/philtre-rails/order_link.rb

@@ -0,0 +1,35 @@
+module PhiltreRails
+  # Used by order_by helper to generate ordering links.
+  class OrderLink
+    # expr is a Sequel::SQL::OrderedExpression
+    def initialize( expr, active: false )
+      @expr = expr
+      @active = active
+    end
+
+    attr_reader :expr, :active
+
+    # appended to the label
+    def icon
+      if active
+        expr.descending ? '▼' : '▲'
+      end
+    end
+
+    # class of the generated <a...>
+    def css_class
+      if active
+        expr.descending ? 'descending' : 'ascending'
+      end
+    end
+
+    # this value ends up in the order array of the parameter hash
+    def name
+      if active
+        expr.descending ? "#{expr.expression}_desc" : "#{expr.expression}_asc"
+      else
+        expr.expression
+      end.to_s
+    end
+  end
+end

data/lib/philtre-rails/philtre_model.rb

@@ -0,0 +1,38 @@
+require 'ostruct'
+require 'philtre/filter.rb'
+
+class Philtre::Filter
+  # These define the interface as used by the views.
+  # So this class is available for custom predicates.
+  class Model < OpenStruct
+    extend ActiveModel::Naming
+
+    # Name this as 'filter', so the parameters come back from the form as that.
+    def self.model_name; ActiveModel::Name.new(Philtre); end
+
+    # Rest of ActiveModel compliance, because
+    #  include ActiveModel::Model
+    # messes with initialize, which breaks OpenStruct
+    def persisted?; false; end
+    def to_key; nil; end
+    def to_param; nil; end
+    def errors; @errors ||= ActiveModel::Errors.new(self); end
+    def to_partial_path; self.class.model_name.param_key; end
+    def to_model; self; end
+  end
+
+  # TODO If your model does not act like an Active Model object, then you
+  # should define :to_model yourself returning a proxy object that wraps your
+  # object with Active Model compliant methods.
+  #
+  # 07-May-2014 Nice idea, except that (at least from 4.0.2) rails uses to_model only in some
+  # cases to get naming, and the original object gets passed to the FormBuilder.
+  # Which is a bit stoopid.
+  def to_model
+    raise "Use for_form, you can't pass #{self} directly into a form_for call."
+  end
+
+  def for_form
+    Model.new filter_parameters.reject{|k,v| v.blank?}
+  end
+end

data/lib/philtre-rails/philtre_view_helpers.rb

@@ -0,0 +1,45 @@
+# http://api.rubyonrails.org/classes/Rails/Railtie.html
+module PhiltreRails
+  module PhiltreViewHelpers
+    # There is a nicer way to do this, but it means monkey-patching Array.
+    # Which upsets some folks.
+    def unify_array( ary )
+      case ary.size
+      when 0; nil
+      when 1; ary.first
+      else; ary
+      end
+    end
+
+    # can be overridden
+    def default_order_link_class
+      OrderLink
+    end
+
+    # Heavily modified from SearchLogic.
+    def order_by( filter, *fields, label: fields.first.to_s.titleize, order_link_class: default_order_link_class )
+      return label if filter.nil?
+
+      # current ordering from the filter
+      # each expr is a Sequel::SQL::Expression
+      exprs = Hash[ filter.order_expressions ]
+
+      # Invert each ordering for the generated link. Current sort order will be displayed.
+      order_links = fields.map do |field|
+        if exprs[field]
+          order_link_class.new exprs[field].invert, active: true
+        else
+          order_link_class.new Sequel.asc(field)
+        end
+      end
+
+      # filter params must have order in the right format
+      filter_params = filter.filter_parameters.dup
+      filter_params[:order] = unify_array( order_links.map( &:name ) )
+
+      params_hash = {filter.class::Model.model_name.param_key.to_sym => filter_params}
+      link_text = raw( [label, order_links.first.andand.icon].compact.join(' ') )
+      link_to link_text, params_hash, {class: order_links.first.andand.css_class}
+    end
+  end
+end

data/lib/philtre-rails/railtie.rb

@@ -0,0 +1,37 @@
+# http://api.rubyonrails.org/classes/Rails/Railtie.html
+module PhiltreRails
+  class Railtie < Rails::Railtie
+    initializer "philtre-rails.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        send :define_method, :philtre_params do
+          params[Philtre::Filter::Model.model_name.param_key.to_sym]
+        end
+      end
+    end
+
+    initializer "philtre-rails.configure_rails_initialization" do |app|
+      # not sure about this?
+      # Sequel.extension :core_extensions
+
+      # and the code to do filtering and Sequel::Dataset manipulation
+      require 'philtre.rb'
+      require 'philtre/sequel_extensions.rb'
+    end
+
+    initializer "philtre-rails.active_model" do |app|
+      require 'philtre-rails/philtre_model.rb'
+    end
+
+    initializer "philtre-rails.view_helpers" do
+      require 'philtre-rails/order_link.rb'
+      require 'philtre-rails/philtre_view_helpers.rb'
+      ActionView::Base.send :include, PhiltreViewHelpers
+    end
+
+    config.to_prepare do
+      # Called once in production, on each request during development
+      # Seems to be fine without it.
+      # require 'philtre_model.rb'
+    end
+  end
+end

data/lib/philtre-rails/version.rb

@@ -0,0 +1,3 @@
+module PhiltreRails
+  VERSION = "0.0.1"
+end

data/lib/philtre-rails.rb

@@ -0,0 +1,2 @@
+# optionally hook in to rails. In case this goes back to philtre
+require 'philtre-rails/railtie' if defined?(Rails)

data/philtre-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'philtre-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "philtre-rails"
+  spec.version       = PhiltreRails::VERSION
+  spec.authors       = ["John Anderson"]
+  spec.email         = ["panic@semiosix.com"]
+  spec.summary       = %q{Filtering for Sequel on rails}
+  spec.description   = %q{The Sequel equivalent for Ransack, Metasearch, Searchlogic}
+  spec.homepage      = "http://github.com/djellemah/philtre-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "philtre"
+  spec.add_dependency "activemodel"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'faker'
+end

data/spec/philtre_model_spec.rb

@@ -0,0 +1,60 @@
+require 'rspec'
+require 'faker'
+require 'active_model'
+
+require 'philtre/filter.rb'
+
+require_relative '../lib/philtre-rails/philtre_model.rb'
+
+# spec/support/active_model_lint.rb
+# adapted from rspec-rails:
+# http://github.com/rspec/rspec-rails/blob/master/spec/rspec/rails/mocks/mock_model_spec.rb
+shared_examples_for "ActiveModel" do
+  require 'minitest'
+  require 'active_model/lint'
+
+  # needed by MiniTest::Assertions
+  def assertions; @assertions ||= 0 end
+  def assertions=( rhs ); @assertions = rhs end
+
+  include MiniTest::Assertions
+
+  include ActiveModel::Lint::Tests
+
+  ActiveModel::Lint::Tests
+    .public_instance_methods
+    .grep(/^test/)
+    .each do |test_method|
+      example test_method.to_s.gsub('_',' ') do
+        send test_method
+      end
+    end
+
+  # needed for MiniTest::Assertions
+  def model; subject end
+end
+
+describe Philtre::Filter do
+
+  describe '#to_model' do
+    subject{ Philtre::Filter.new( one: 1, two: 2 ) }
+
+    it 'should raise exception' do
+      ->{subject.to_model}.should raise_error(/use for_form/i)
+    end
+  end
+
+  describe '#for_form' do
+    subject{ Philtre::Filter.new( one: 1, two: 2 ).for_form }
+
+    it_should_behave_like("ActiveModel")
+
+    it 'nil for not present' do
+      subject.three.should be_nil
+    end
+
+    it 'value for present' do
+      subject.two.should == 2
+    end
+  end
+end

data/spec/philtre_view_helpers_spec.rb

@@ -0,0 +1,79 @@
+require_relative '../lib/philtre-rails/philtre_view_helpers.rb'
+require_relative '../lib/philtre-rails/order_link.rb'
+
+describe PhiltreRails::PhiltreViewHelpers do
+  def subject
+    @subject ||= begin
+      obj = Object.new.extend( described_class )
+      class << obj
+        def raw(str); str end
+        def link_to(text, params, html_options)
+          html_options.merge(href: params.inspect)
+          html_attrs = html_options.map{|k,v| %Q{#{k}="#{v}"}}.join(' ')
+          %Q{<a #{html_attrs}>#{text}</a>}
+        end
+      end
+      obj
+    end
+  end
+
+  describe '#order_by' do
+    def filter
+      @filter ||= Philtre::Filter.new order: [:first, :second]
+    end
+
+    it 'returns label for no filter' do
+      subject.order_by( nil, :first ).should == 'First'
+    end
+
+    it 'inverts no order' do
+      link_str = subject.order_by( filter, :first )
+      link_str.should =~ />First.*?</
+      link_str.should =~ /class="descending/
+    end
+
+    it 'inverts ascending order' do
+      filter = self.filter.clone(:order => :first_asc)
+      link_str = subject.order_by( filter, :first )
+      link_str.should =~ />First.*?</
+      link_str.should =~ /class="descending/
+    end
+
+    it 'inverts descending order' do
+      filter = self.filter.clone(:order => :first_desc)
+      link_str = subject.order_by( filter, :first )
+      link_str.should =~ />First.*?</
+      link_str.should =~ /class="ascending/
+    end
+
+    describe 'OrderLink' do
+      class CustomOrderLink < PhiltreRails::OrderLink
+        def css_class
+          if active
+            expr.descending ? 'going_down' : 'going_up'
+          end
+        end
+      end
+
+      it 'uses custom order link' do
+        link_str = subject.order_by filter, :first, order_link_class: CustomOrderLink
+        link_str.should =~ />First.*?</
+        link_str.should =~ /class="going_down/
+      end
+
+      it 'changes default order link' do
+        # don't modify the class definition
+        subject = self.subject.clone
+        class << subject
+          def default_order_link_class
+            CustomOrderLink
+          end
+        end
+
+        link_str = subject.order_by  filter, :first, order_link_class: CustomOrderLink
+        link_str.should =~ />First.*?</
+        link_str.should =~ /class="going_down/
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: philtre-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: philtre
+  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: activemodel
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: The Sequel equivalent for Ransack, Metasearch, Searchlogic
+email:
+- panic@semiosix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- lib/philtre-rails.rb
+- lib/philtre-rails/order_link.rb
+- lib/philtre-rails/philtre_model.rb
+- lib/philtre-rails/philtre_view_helpers.rb
+- lib/philtre-rails/railtie.rb
+- lib/philtre-rails/version.rb
+- philtre-rails.gemspec
+- spec/philtre_model_spec.rb
+- spec/philtre_view_helpers_spec.rb
+homepage: http://github.com/djellemah/philtre-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Filtering for Sequel on rails
+test_files:
+- spec/philtre_model_spec.rb
+- spec/philtre_view_helpers_spec.rb