doure 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 699a3e3244c2fe33d075967a17478c02b176e9b8
-  data.tar.gz: 837ef221bb0e702fac32a3a7a6c6429b561a1da9
+SHA256:
+  metadata.gz: 1e7be98ed2e9fdd3c91182ac61d8a81089bb9e112849e6bc24579c2a6e3d1063
+  data.tar.gz: e5441b9cab833029ef3f08b8027a9cc46be1d27d8b3d4be0aae7c4e163a82971
 SHA512:
-  metadata.gz: 36b4859bbe22a9baf42ad38da0c49dd49c8e52309d880886fb5e985d69886cee9f68ed8e0e2864cad5208786cd8690a85345ee494b17c6e25bf0fb6fb1ef6eeb
-  data.tar.gz: 788e22ff0aa88d28892f3aa3cce3c6b0651f685a88e02dd43f87ff9d3b7605b22a97f83a13558fa5010cb06b53466902ba9b8f3371917aed018a34be54668e3d
+  metadata.gz: 678dcc5b765633a84bdc73771698c3d5fc722f87b67b9b1175063762fc9f11a81d6d17fe4df46ed7f522112760aecdf9917641785fca43fcd08831c4f9f7c8b2
+  data.tar.gz: 1096d1763f9bfa55d6a1a5202bd68efa349908a71f6fb60b4eb66e4d2a28e68d6af76794b774b45e88b45d774c99ddbe28a80482f85cf40c9b50baf00f6b68c0

data/README.md

@@ -1,16 +1,23 @@
 # Doure
 
-Doure is a minimal abstraction to write parameterized filters for ActiveRecord models. It allows you to write named filters that accept one parameter, and use those later with `filter`, ex:
+Doure is a minimal abstraction to write parameterized filters for ActiveRecord models. It allows you to write named filters that accept one parameter, and use those later with `doure_filter`, ex:
 
 ```ruby
+class Post < ApplicationRecord
+  include Doure::Filterable
+
+  filter_class PostFilter
+end
+
 class PostFilter < Doure::Filter
   cont_filter(:title)
   filter(:author_role_in) { |s, v| s.joins(:author).where(authors: { role: v }) }
 end
 
-Post.filter(title_cont: "Dev", author_role_in: ["editor", "admin"])
+Post.doure_filter(title_cont: "Dev", author_role_in: ["editor", "admin"])
 ```
 
+This allows for a simple implementation of search features in a controller, by passing the "search" parameters (like a `q` parameter) directly to `#doure_filter`.
 
 ## Installation
 
@@ -36,7 +43,7 @@ Given you have an ActiveRecord model, you need to extend the filterable module a
 # app/models/post.rb
 
 class Post < ApplicationRecord
-  extend Doure::Filterable
+  include Doure::Filterable
   
   filter_class PostFilter
 end
@@ -64,7 +71,7 @@ You can also use the additional argument `:as` to `filter` (or any of the other
 ```ruby
 class PostFilter < Doure::Filter
   filter(:is_visible, as: :boolean) { |s, v|
-    # 'v' is a boolean here even if used as `Post.filter(is_visible: 'true')` 
+    # 'v' is a boolean here even if used as `Post.doure_filter(is_visible: 'true')` 
     s.where(active: v) 
   }
 end
@@ -100,26 +107,26 @@ end
 
 Some of the most commonly used filters are already provided. The name of the resulting filter is always <filter_name>_<prefix>, for example "title_cont" for a filter like "cont_filter(:title)". In particular the provided filters are:
 
-- `cont_filter(name)`: Implements `ILIKE '%#{value}%'`. Ex: `Post.filter(title_cont: 'dev')`
-- `eq_filter(name)`: Implements equality. Ex: `Post.filter(id_eq: 12)`
-- `not_eq_filter(name)`: Non-equality. Ex: `Post.filter(id_not_eq: 12)`
-- `present_filter(name)`: This is a boolean filter by default. Implements equality / non-equality against NULL. Ex: `Post.filter(slug_present: false)`
--  Numerical comparators, `gt_filter, lt_filter, gteq_filter, lteq_filter`: Implements numerical comparators, the passed value is left as-is. Ex: `Post.filter(views_count_gt: 10)` 
+- `cont_filter(name)`: Implements `ILIKE '%#{value}%'`. Ex: `Post.doure_filter(title_cont: 'dev')`
+- `eq_filter(name)`: Implements equality. Ex: `Post.doure_filter(id_eq: 12)`
+- `not_eq_filter(name)`: Non-equality. Ex: `Post.doure_filter(id_not_eq: 12)`
+- `present_filter(name)`: This is a boolean filter by default. Implements equality / non-equality against NULL. Ex: `Post.doure_filter(slug_present: false)`
+-  Numerical comparators, `gt_filter, lt_filter, gteq_filter, lteq_filter`: Implements numerical comparators, the passed value is left as-is. Ex: `Post.doure_filter(views_count_gt: 10)` 
 
 
 ### Using Model#filter
 
 The `#filter` method is chainable with other scopes, for example:
 
-`Post.where(category_id: 12).filter(title_cont: "Dev")`
+`Post.where(category_id: 12).doure_filter(title_cont: "Dev")`
 
 Or with named scopes you have declared in the model:
 
-`Post.not_deleted.visible.filter(title_cont: "Dev", category_id_eq: '88')`
+`Post.not_deleted.visible.doure_filter(title_cont: "Dev", category_id_eq: '88')`
 
 The expected use case for Doure is to implement search features. Since it's a common scenario to use `Model#filter` passing a hash of values coming from a view form, the hash will usually have most of their keys with nil values or empty strings. In order to not give incorrect results, then, `nil` and the empty string (`""`) values are ignored by default. For example:
 
-`Post.filter(title_cont: "", is_visible: "f")`
+`Post.doure_filter(title_cont: "", is_visible: "f")`
 
 Will only apply the `is_visible` filter but not the `title_cont`.  
 

data/doure.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 4.0.0"
-  spec.add_dependency "activesupport", ">= 4.0.0"
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency "activerecord", ">= 6.0.0"
+  spec.add_dependency "activesupport", ">= 6.0.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/doure.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/class/attribute'
+require 'active_support/concern'
+require 'active_support/core_ext/hash/indifferent_access'
+
 require "doure/version"
 
 require 'doure/filter'
 require 'doure/filterable'
 
+
 module Doure
   # Your code goes here...
 end

data/lib/doure/filter.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Doure
   class Filter
     class_attribute :mapping
     self.mapping = ActiveSupport::HashWithIndifferentAccess.new
+    VALID_CASTINGS = %i(boolean date datetime)
+    InvalidCasting = Class.new(StandardError)
 
     class << self
       def inherited(subclass)
@@ -47,8 +51,7 @@ module Doure
     def apply(params = {})
       params.each do |key, value|
         if !value.nil? && value != "" && mapping.key?(key)
-          casted_value = mapping[key][0].key?(:as) ? cast_value(mapping[key][0][:as], value) : value
-          @scope = mapping[key][1].call(@scope, casted_value)
+          @scope = instance_exec(@scope, cast_value(mapping[key][0], value), &mapping[key][1])
         end
       end
 
@@ -57,8 +60,10 @@ module Doure
 
     private
 
-    def cast_value(type, value)
-      case type
+    def cast_value(opts, value)
+      raise InvalidCasting, "Invalid casting type #{opts[:as]}" if opts[:as] && !VALID_CASTINGS.include?(opts[:as])
+
+      case opts[:as]
         when :boolean
           ActiveRecord::Type::Boolean.new.cast(value)
         when :date

data/lib/doure/filterable.rb

@@ -1,12 +1,23 @@
+# frozen_string_literal: true
+
 module Doure
   module Filterable
-    def filter_class(klass)
-      @filter_class = klass
+    NoFilter = Class.new(StandardError)
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def filter_class(klass)
+        self.doure_filter_klass = klass
+      end
     end
 
-    def filter(params = {})
-      @filter_class or raise "No filter model specified"
-      @filter_class.new(self).apply(params)
+    included do
+      cattr_accessor :doure_filter_klass
+
+      scope :doure_filter, lambda { |params = {}|
+        doure_filter_klass || raise(NoFilter, "No filter model specified")
+        doure_filter_klass.new(self).apply(params)
+      }
     end
   end
-end
+end

data/lib/doure/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Doure
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doure
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Roger Campos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2021-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 description: Minimal abstraction to write parameterized filters for ActiveRecord models
 email:
 - roger@rogercampos.com
@@ -117,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Minimal abstraction to write parameterized filters for ActiveRecord models