might 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16724ee40371d468bd5a932a35a100ae39bff05b
-  data.tar.gz: 1211d23fcfb3043dc2da35000d0c500da5b5c2bf
+  metadata.gz: 15a3ffb400a36a96c6479bd3717c94622b064437
+  data.tar.gz: fb6e300fedf6060ec38e7d2dab644a9faf8673cb
 SHA512:
-  metadata.gz: 1f218d738eab33a02c2b62072fe1cb23cce557ccca6752386892877d41c33f96cabcd35b50161d6d6894b12ae8cd950ea7277a4e362b35ddf8a90f1b8e38684a
-  data.tar.gz: eae9d9eb274fc4a539db1457e2f990adcedc73c1d4b2c8aa649c5345bb2e266653a17bb7e2cb91baae3b0406f52356e0ded177d44baa069dc793aec3ad0d529e
+  metadata.gz: b2325e15a768c3726bb4a7d06ccdc7550999eb769fa9bc0f575828b88f2625826cacba54f76c97c74aadb7176a7628d1cfcf66f9899a6eb0c6019b603b4f8061
+  data.tar.gz: bcf3c17a88edeb04959dc1818e3951539b65c3bdf06b4fa1d85830bb4e2fe0a760299ab351ec6e9ea5e7300672832d283dcfa2491c5cd60f3a4a4f82803a674a

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+**0.6.0**
+
+  * Implement public API for registering predicates
+
 **0.5.0**
 
-  *  Introduce Might::FilterParameters as subclass of Setq
+  *  Introduce `Might::FilterParameters` as subclass of Set
 
 **0.4.0**
 

data/README.md

@@ -219,6 +219,18 @@ Predicate      | Opposite Predicate | Meaning
 `present`      | `blank`            | field is present (not null and not a blank string)
 `null`         | `not_null`         | field is null
 
+You may want to implement custom predicate. First of all you should implement predicate for [Ransack gem](https://github.com/activerecord-hackery/ransack/).
+This process [documented here](https://github.com/activerecord-hackery/ransack/wiki/custom-predicates).
+Then you have to register predicate.
+
+```ruby
+# Predicate for a singular value (such as a string)
+Might::FilterPredicates.register('is_upper_case', on: :value)
+
+# Predicate for an array
+Might::FilterPredicates.register('includes', on: :array)
+```
+
 
 ### Configuring sorting
 

data/lib/might/filter_parameter_definition.rb

@@ -35,7 +35,7 @@ module Might
       @as = options.fetch(:as, name).to_s
       @name = name.to_s
       @on = options[:on]
-      @predicates = Array(options.fetch(:predicates, FilterPredicates::ALL)).map(&:to_s)
+      @predicates = Array(options.fetch(:predicates, FilterPredicates.all)).map(&:to_s)
       @coerce = options.fetch(:coerce, ->(v) { v })
       @validations = options.fetch(:validates, {})
     end

data/lib/might/filter_parameters_extractor.rb

@@ -52,7 +52,7 @@ module Might
     attr_reader :parameters_definition, :app
 
     def name_and_predicate(name_with_predicate)
-      predicate = FilterPredicates::ALL.detect { |p| name_with_predicate.end_with?("_#{p}") }
+      predicate = FilterPredicates.all.detect { |p| name_with_predicate.end_with?("_#{p}") }
       [
         name_with_predicate.chomp("_#{predicate}"),
         predicate
@@ -69,7 +69,7 @@ module Might
     end
 
     def type_cast_value(name, value)
-      if name.end_with?(*FilterPredicates::ON_ARRAY)
+      if name.end_with?(*FilterPredicates.array)
         value.split(',')
       else
         value

data/lib/might/filter_predicates.rb

@@ -1,5 +1,9 @@
 module Might
   # Contains contains with all supported predicates
+  # You can register your own predicates. Predicates should perform on array or on singular value:
+  #
+  #   Might::FilterPredicates.register('includes', on: :array)
+  #   Might::FilterPredicates.register('is_upper_case', on: :value)
   #
   module FilterPredicates
     NOT_EQ = 'not_eq'.freeze
@@ -29,25 +33,64 @@ module Might
     NOT_CONT_ANY = 'not_cont_any'.freeze
     CONT_ANY = 'cont_any'.freeze
 
-    ON_VALUE = [
-      NOT_EQ, EQ,
-      DOES_NOT_MATCH, MATCHES,
-      GT, LT,
-      GTEQ, LTEQ,
-      NOT_CONT, CONT,
-      NOT_START, START,
-      DOES_NOT_END, ENDS,
-      NOT_TRUE, TRUE,
-      NOT_FALSE, FALSE,
-      BLANK, PRESENT,
-      NOT_NULL, NULL
-    ].freeze
+    @predicates_on_value = Set.new([
+                                     NOT_EQ, EQ,
+                                     DOES_NOT_MATCH, MATCHES,
+                                     GT, LT,
+                                     GTEQ, LTEQ,
+                                     NOT_CONT, CONT,
+                                     NOT_START, START,
+                                     DOES_NOT_END, ENDS,
+                                     NOT_TRUE, TRUE,
+                                     NOT_FALSE, FALSE,
+                                     BLANK, PRESENT,
+                                     NOT_NULL, NULL
+                                   ])
+    @predicates_on_array = Set.new([
+                                     NOT_IN, IN,
+                                     NOT_CONT_ANY, CONT_ANY
+                                   ])
+
+    # Registers predicate on singular value or on array
+    # @param predicate [String, Symbol]
+    # @param on [:array, :value]
+    # @return [Might::FilterPredicates]
+    #
+    def register(predicate, on:)
+      case on
+      when :value
+        @predicates_on_value.add(predicate.to_s)
+      when :array
+        @predicates_on_array.add(predicate.to_s)
+      else
+        fail ArgumentError, 'on must be :array, or :value'
+      end
+      self
+    end
+    module_function :register
+
+    # Returns predicates for array
+    # @return [Set<String>]
+    #
+    def array
+      @predicates_on_array.dup
+    end
+    module_function :array
 
-    ON_ARRAY = [
-      NOT_IN, IN,
-      NOT_CONT_ANY, CONT_ANY
-    ].freeze
+    # Returns predicates for values
+    # @return [Set<String>]
+    #
+    def value
+      @predicates_on_value.dup
+    end
+    module_function :value
 
-    ALL = ON_VALUE + ON_ARRAY
+    # Returns all predicates
+    # @return [Set<String>]
+    #
+    def all
+      @predicates_on_value + @predicates_on_array
+    end
+    module_function :all
   end
 end

data/lib/might/version.rb

@@ -1,4 +1,4 @@
 #
 module Might
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: might
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Tema Bolshakov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport