classy_filter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d39815c9e5cc38bad174755097ce7e62140800e77123b509ffcc0d9194cade0
+  data.tar.gz: bffc8a05381de967fd6b051025431413c639820988f71b364f0a7af240516fa1
+SHA512:
+  metadata.gz: 4ecdba44e99129941af52a39b8cb2d11c3917ed427a060c0372292e502a3324a046ea13d4d96a56ffcb9bc7211a0184d8d16d457c2bb1a06bc71aca9114c24ee
+  data.tar.gz: 45473de6711f8e184a051c74c437394f9905bb5a3c3c6797e776dbbb69ffe83a265f25d49db3f5126c89f53ce1b6d30fd8574c649a71e1f176857b4b3cd08b47

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in classy_filter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    classy_filter (0.1.1)
+      sequel (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sequel (5.9.0)
+    sqlite3 (1.3.13)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  classy_filter!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,92 @@
+# ClassyFilter
+
+ClassyFilter is a customizeable class-based filtering library. Currently it's only build for Sequel, but there are plans to expand!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'classy_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install classy_filter
+
+## Usage
+
+### Writing a filter
+
+To begin using this gem, you must first define your filter class, deriving it from `ClassyFilter::Base`. In this class, you'd specify your filter fields, extra predicates and coercions (should you need those).
+
+Let's begin with an example. Assuming you have a table named `people` with this structure:
+
+| name          | type          |
+| ----          | ----          |
+| first_name    | varchar(1023) |
+| last_name     | varchar(1023) |
+| date_of_birth | date          |
+| trust_level   | integer       |
+
+You could write a filter like this:
+
+```ruby
+class MyFilter < ClassyFilter::Base
+  filter_field :first_name # (1)
+  filter_field :last_name_prefix, attribute: :last_name, predicate: :starts_with_i # (2)
+  filter_field :dob_after, attribute: :date_of_birth, predicate: :gteq, coercion: :integer # (3)
+  filter_field :rough_trust, attribute: :trust_level, predicate: :gt_10x, coercion: :integer # (4)
+  
+  predicate :gt_10x, ->(dataset, attr, input) { dataset.where { |r| Sequel[attr] > input } } # (5)
+end
+```
+
+Let's walk through this filter line by line.
+
+Line `(1)` shows us how to define a very basic filter. This definition lets our filter accept the `first_name` parameter
+and perform simple filtering by equality or inclusion.
+
+Line `(2)` shows us how to define a filter with a custom predicate and parameter name. Our filter will accept the
+`last_name_prefix` parameter and filter by the `last_name column`, using `ILIKE` to do it.
+
+Line `(3)` shows us how to define a filter not just with a custom predicate, but also with a coercion. Before performing
+the filtering, our filter will attempt to coerce the `dob_after` parameter into an `Integer`.
+
+Line `(5)` shows us a custom predicate (that's used on the line `(4)`). A predicate is defined using the
+`ClassyFilter::Base.predicate` method that accepts the predicate name and a proc that receives the dataset, the
+attribute name and the parameter value.
+
+You can see all existing predicates [here](/lib/classy_filter/predicates.rb) and all existing coercions
+[here.](lib/classy_filter/coercions.rb)
+
+### Performing the filtering
+
+This one is actually quite easy. Assuming we have a database named `DB` and receive a hash named `params` from somewhere
+(say, the URL query string), we can use our filter as follows:
+
+```ruby
+ds = DB[:people]
+MyFilter.new(params).call(ds)
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `pry -rclassy_filter` for an interactive prompt that will allow you to experiment.
+
+## TODO
+
+❗ Add collection (array/hash) coercions  
+❗ Move the Sequel implementation out of the gem  
+⬜ Try to find out a way to simplify predicates definitions  
+⬜ More tests. Never enough tests.  
+❓ Add a better coercion library. Dry-rb? Or maybe Hashie?  
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/art-solopov/classy_filter.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/classy_filter.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "classy_filter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "classy_filter"
+  spec.version       = ClassyFilter::VERSION
+  spec.authors       = ["Artemiy Solopov"]
+  spec.email         = ["art-solopov@yandex.ru"]
+
+  spec.summary       = %q{A cutomizeable class-based filtering/searching library for Sequel}
+  spec.description   = spec.summary
+  spec.homepage      = "https://gitlab.com/art-solopov/classy_filter"
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'sequel', '~> 5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sqlite3', '~> 1.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/classy_filter.rb

@@ -0,0 +1,43 @@
+require 'classy_filter/version'
+require 'classy_filter/predicates'
+require 'classy_filter/coercions'
+require 'classy_filter/class_methods'
+
+module ClassyFilter
+  Field = Struct.new(:param_name, :attribute, :predicate, :coercion)
+
+  class Base
+    extend Forwardable
+
+    extend ClassMethods
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = params.transform_keys(&:to_s)
+    end
+
+    def call(dataset)
+      filter_fields.reduce(dataset) do |ds, (value, field)|
+        value = coercions_module.coerce(value, field.coercion) if field.coercion
+        attribute = field.attribute || field.param_name
+        predicates_module.send(field.predicate, ds, attribute, value)
+      end
+    end
+
+    private
+
+    def_delegator :"self.class", :filter_fields, :all_filter_fields
+    def_delegator :"self.class", :predicates_module
+    def_delegator :"self.class", :coercions_module
+
+    def filter_fields
+      all_filter_fields
+        .to_a
+        .lazy
+        .map { |ff| [params[ff.param_name.to_s], ff] }
+        .reject { |param, _| param.nil? }
+        .reject { |param, _| param.is_a?(String) && param.empty? }
+    end
+  end
+end

data/lib/classy_filter/class_methods.rb

@@ -0,0 +1,44 @@
+module ClassyFilter
+  module ClassMethods
+    attr_reader :filter_fields
+
+    def filter_field(param_name, attribute: nil,
+                     predicate: :eq_in, coercion: nil)
+      @filter_fields ||= []
+      @filter_fields << Field.new(param_name, attribute,
+                                  predicate, coercion)
+    end
+
+    def predicate(name, body)
+      predicates_module.define_method(name, &body)
+    end
+
+    def coercion(name, body)
+      coercions_module.define_method(name, &body)
+      coercions_module.private(name)
+    end
+
+    def predicates_module
+      @predicates_module || ClassyFilter::Predicates
+    end
+
+    def coercions_module
+      @coercions_module || ClassyFilter::Coercions
+    end
+
+    protected
+
+    def build_predicates_module!(base)
+      @predicates_module = Module.new do
+        extend base.predicates_module
+        extend self
+      end
+    end
+
+    private
+
+    def inherited(subclass)
+      subclass.build_predicates_module!(self)
+    end
+  end
+end

data/lib/classy_filter/coercions.rb

@@ -0,0 +1,50 @@
+module ClassyFilter
+  module Coercions
+    extend self
+
+    def coerce(value, coercion)
+      case coercion
+      when Symbol then send(coercion, value)
+      when ->(x) { x.respond_to?(:call) } then coercion.call(value)
+      end
+    end
+
+    private
+
+    # Scalar conversions
+    # Those are methods that receive a value and return
+    # the coerced value
+
+    def integer(value)
+      Integer(value)
+    end
+
+    def float(value)
+      Float(value)
+    end
+
+    def boolean(value)
+      case value
+      when true, 'true', 'TRUE', 1, '1' then true
+      when false, 'false', 'FALSE', 0, '0' then false
+      end
+    end
+
+    def date(value)
+      case value
+      when Date then value
+      when Array then Date.new(*value)
+      else Date.parse(value.to_s)
+      end
+    end
+
+    def timestamp(value)
+      case value
+      when Time then value
+      when DateTime then value.to_time
+      when Array then Time.new(*value)
+      else DateTime.parse(value.to_s).to_time
+      end
+    end
+  end
+end

data/lib/classy_filter/predicates.rb

@@ -0,0 +1,52 @@
+module ClassyFilter
+  module Predicates
+    extend self
+
+    def eq_in(ds, attribute, input)
+      ds.where(attribute => input)
+    end
+
+    alias eq eq_in
+    alias :in eq_in
+
+    # TODO: think about refactoring
+
+    def gt(ds, attribute, input)
+      ds.where { |_r| sequel_col(ds, attribute) > input }
+    end
+
+    def lt(ds, attribute, input)
+      ds.where { |_r| sequel_col(ds, attribute) < input }
+    end
+
+    def gteq(ds, attribute, input)
+      ds.where { |_r| sequel_col(ds, attribute) >= input }
+    end
+
+    def lteq(ds, attribute, input)
+      ds.where { |_r| sequel_col(ds, attribute) <= input }
+    end
+
+    def starts_with(ds, attribute, input)
+      ds.where { |_r| Sequel.like(sequel_col(ds, attribute), input + '%') }
+    end
+
+    def starts_with_i(ds, attribute, input)
+      ds.where { |_r| Sequel.ilike(sequel_col(ds, attribute), input + '%') }
+    end
+
+    def contains(ds, attribute, input)
+      ds.where { |_r| Sequel.like(sequel_col(ds, attribute), "%#{input}%") }
+    end
+
+    def contains_i(ds, attribute, input)
+      ds.where { |_r| Sequel.ilike(sequel_col(ds, attribute), "%#{input}%") }
+    end
+
+    private
+
+    def sequel_col(ds, attribute)
+      Sequel[ds.first_source_table][attribute.to_sym]
+    end
+  end
+end

data/lib/classy_filter/version.rb

@@ -0,0 +1,3 @@
+module ClassyFilter
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: classy_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Artemiy Solopov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: A cutomizeable class-based filtering/searching library for Sequel
+email:
+- art-solopov@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- classy_filter.gemspec
+- lib/classy_filter.rb
+- lib/classy_filter/class_methods.rb
+- lib/classy_filter/coercions.rb
+- lib/classy_filter/predicates.rb
+- lib/classy_filter/version.rb
+homepage: https://gitlab.com/art-solopov/classy_filter
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A cutomizeable class-based filtering/searching library for Sequel
+test_files: []