like_query 0.4.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42bb5eb12ee63b8398022ef122ba11cf6a1ac0d829634bf22840929531520991
-  data.tar.gz: 8ca2b2a0551eb5280a45356247b0d8e7a5b59e575785026028e8cc4e180d935d
+  metadata.gz: 243756b108021b5385001f7ac4c20f3d7ece0588aa91bad0f72a58b38f72c4be
+  data.tar.gz: 4978917f31f305fb13f5185b1826d97ed986f656bf9b9a676cc4079a127b06df
 SHA512:
-  metadata.gz: 658922e73b8902256681c8a5d9d781a804cbef9a9e4cb97984df46c8a7ecf17c3828ebf564790dc1b7152e2b87eaac2cf4c74a80f74269aab360d8b46b6cb809
-  data.tar.gz: ee8bf66baa16c8efba21193d69a434d14f3823e055bdfc00aa3ff6644b2890905baa544f696ff82f9143ce0f9a96924c9d1c1bd8934df4e796e66a4f3e23de61
+  metadata.gz: f02df34b624b4eedd1c985d44d22d07b838672c47e9f6bf65fc7aae5ee5ac35ca8ded9a48628b67955dbede7f1da786705bbbe417aba101f954b87d5c55a54c2
+  data.tar.gz: d610aee369a628a1a05630f1e4d09f76c72c69e59f035af572e4958dd99ed1603f06f2c8e9beea2417b5432bd2a267d285fd4b0e317ff3c86456f08f3ad40ca5

data/README.md

@@ -116,6 +116,13 @@ Book.like('author.name:marc', [{author: [:name]}])
 # => find books where author.name includes "marc"
 ```
 
+LikeQuery raises a error if invalid column name is given, vor example:
+
+```ruby
+Book.like('title2:history', [:title, :price])
+# => raises a error like column «title2» is not present within available columns: «title, price»
+```
+
 There is a helper for allowing the user translating the column names:
 
 ```ruby

data/lib/like_query/formatter.rb

@@ -1,6 +1,9 @@
 module LikeQuery
   class Formatter
 
+    COLUMN_REGEX_CASE_SENSITIVE = /^[a-z_\.0-9]+(?=:)/
+    COLUMN_REGEX_CASE_INSENSITIVE = /^[a-zA-Z_\.0-9]+(?=:)/
+
     #== Translate columns for more convenient usage
     # second parameter is always a Array of Arrays
     # Example:
@@ -9,7 +12,7 @@ module LikeQuery
     def self.translate_columns(search_string, column_translations, case_sensitive: true)
       search_string.split(' ').map do |str|
 
-        reg = (case_sensitive ? /^[a-z_\.]+(?=:)/ : /^[a-zA-Z_\.]+(?=:)/)
+        reg = (case_sensitive ? COLUMN_REGEX_CASE_SENSITIVE : COLUMN_REGEX_CASE_INSENSITIVE)
 
         column = if case_sensitive
                    str.match(reg)

data/lib/like_query/model_extensions.rb

@@ -15,12 +15,13 @@ module LikeQuery
 
       queries = []
       associations = []
+      available_column_keys = []
       @like_query_schema = schema
 
       search_string.split(' ').each do |s|
 
         f_str = format_string_element(s)
-
+        #exception_on_unknown_column(f_str, schema)
         q = []
 
         (schema.first.is_a?(Array) ? schema.first : schema).each do |p|
@@ -38,9 +39,11 @@ module LikeQuery
               raise "Unknown association: :#{k}" unless assoc.present?
               associations.push(k.to_sym) unless associations.include?(k.to_sym)
               if v.is_a?(Symbol) || v.is_a?(String)
+                available_column_keys.push([k.to_s, v.to_s].join('.'))
                 q.push(query_string(v, f_str, assoc))
               elsif v.is_a?(Array)
                 v.each do |_v|
+                  available_column_keys.push([k.to_s, _v.to_s].join('.'))
                   q.push(query_string(_v, f_str, assoc))
                 end
               else
@@ -49,12 +52,18 @@ module LikeQuery
             end
 
           else
+            available_column_keys.push(p.to_s)
             q.push(query_string(p, f_str))
 
           end
 
         end
 
+        # raise error
+        if f_str[:column] && !available_column_keys.include?(f_str[:column])
+          raise "column «#{f_str[:column]}» is not present within available columns: «#{available_column_keys.join(', ')}»"
+        end
+
         __q = q.compact
         queries.push("(#{__q.join(' OR ')})") if __q.present?
       end
@@ -101,7 +110,7 @@ module LikeQuery
 
     def format_string_element(str)
 
-      column = str.match(/^[a-z_\.]+(?=:)/)
+      column = str.match(LikeQuery::Formatter::COLUMN_REGEX_CASE_SENSITIVE)
       _str = (column ? str.match(/(?<=:)[\s\S]+/) : str).to_s
       match_number = _str.match(/^(\d+(?:\.\d+)?)$/)
       match_range = _str.match(/^(\d+(?:\.\d+)?)(\.\.)(\d+(?:\.\d+)?)$/)
@@ -155,6 +164,22 @@ module LikeQuery
       end
     end
 
+    # def exception_on_unknown_column(search, schema)
+    #   return unless search[:column]
+    #
+    #   keys = []
+    #
+    #   (schema.first.is_a?(Array) ? schema.first : schema).each do |p|
+    #     if p.is_a?(Hash)
+    #       p.each do |k, v|
+    #         if v.is_a?(Array)
+    #           else
+    #         end
+    #       end
+    #     end
+    #   end
+    # end
+
     def dbg(label)
 
       return unless @debug_like_query

data/lib/like_query/version.rb

@@ -1,3 +1,3 @@
 module LikeQuery
-  VERSION = "0.4.2"
+  VERSION = "1.0.0"
 end

data/lib/like_query/view_helpers.rb

@@ -1,9 +1,9 @@
 module LikeQuery
   module ViewHelpers
-    def mark(string, column = nil, find: @mark_string)
+    def like_query_mark(string, column = nil, find: @mark_string)
       res = string.to_s
       find.split(' ').each do |word|
-        _col = word.match(/^[a-z_\.]+(?=:)/)
+        _col = word.match(LikeQuery::Formatter::COLUMN_REGEX_CASE_SENSITIVE)
         if !column || !_col || _col.to_s == column.to_s
           _word = (_col ? word.match(/(?<=:)[\s\S]+/) : word).to_s
           res = Translighterate.highlight(res, _word)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: like_query
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors:
 - christian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails