flexi-json 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e8c41b6f187468d64f2d6d3321f7557a5ec17410a69508b8cc1391560ab81be
-  data.tar.gz: 5b7aeb733149ae14bce5481878566a99b4a971232900285153278f11d74decf8
+  metadata.gz: 067cc7f0c8adc0d54bc8910ff6e67425c2c14c4f4bf49051e12f0ce103b31abf
+  data.tar.gz: 555b479c6e2662d3a5a78378c933bd2f4685f7d04d7ce1134301258a557b27c3
 SHA512:
-  metadata.gz: 717ae733016f7913d3ef4d2d8d065fbded43304ff3f62b45ede49abf1aed3de63144202fd17bd8e12e4fa0bde1b9c22067027a6f66f873201ce5f30434f9843d
-  data.tar.gz: f08b3a2418807a5afce6e2b2c30db6e142829ff2c6fbe11968376f0612e8d6cc5a92315a8e98b377fb49c983d3229ca40ec0d3102982d488f0c4ff8e857d84ca
+  metadata.gz: fa132fb46b6ebf35818dce444ac95ba9648da13ba9dea057f5d3084c6a6daa6ac753afb79cef3863bd56da7cdd1741514a9d6c5de9df108475d44db69e110dc4
+  data.tar.gz: 0307bae70965e8e846fb6abfa5050d3065a9f0a8563117a44d228a1d54adf4f5d2d3f99aefa0daadf6ed31fe8927cdd0e2c757dab3f4f2baf2fae263532e3a1b

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# Version: 0.4.2 (23-09-2024)
+
+* [#25](https://github.com/GD-Personal/flexi-json/pull/25): A bug from [v0.4.0](https://github.com/GD-Personal/flexi-json/releases/tag/v0.4.0) was introduced where the advanced search function don't work properly when the options. 
+
+# Version: 0.4.1 (22-09-2024)
+
+* [0270c44](https://github.com/GD-Personal/flexi-json/commit/0270c44d7ffabd88ed0b69b09f1e98910257d99b): Update the readme and changelog
+
+
+# Version: 0.4.0 -  2024-09-22
+
+* [#15](https://github.com/GD-Personal/flexi-json/pull/15): Add a configuration and renamed matched_all to match_all.
+
 # Version: 0.3.0 -  2024-09-22
 
 * [#10](https://github.com/GD-Personal/flexi-json/pull/10): Release 0.2.0

data/README.md

@@ -28,18 +28,19 @@ bundle install
 ```ruby
 require 'flexi/json'
 
-# Load a json data from a local file
-flexi_json = Flexi::Json::Run.new("some/path/to/file.json")
-
 # Load a raw json data
-flexi_json = Flexi::Json::Run.new("{\"name\":\"John\",\"address\":\"Sydney Australia\"}")
-# => <Flexi::Json::Run:0x0000ffffa0f5fc58 @datasets=[#<Flexi::Json::Dataset:0x0000ffffa0f5f668 @address="Sydney Australia", @attributes={:name=>"John", :address=>"Sydney Australia"}, @name="John", @searchable_fields=["name", "address"]>]>
+flexi_json = Flexi::Json.new("{\"name\":\"John\",\"address\":\"Sydney Australia\"}")
+# => <Flexi::Json:0x0000ffffa0f5fc58 @datasets=[#<Flexi::Json::Dataset:0x0000ffffa0f5f668 @address="Sydney Australia", @attributes={:name=>"John", :address=>"Sydney Australia"}, @name="John", @searchable_fields=["name", "address"]>]>
 
-# Load a json data from aurl
-flexi_json = Flexi::Json::Run.new("https://raw.githubusercontent.com/GD-Personal/flexi-json/main/spec/data/dataset.json")
+# Load a json data from a local file
+flexi_json = Flexi::Json.new("some/path/to/file.json")
+
+# Load a json data from a url
+flexi_json = Flexi::Json.new("https://raw.githubusercontent.com/GD-Personal/flexi-json/main/spec/data/dataset.json")
 
 # Search for data
 flexi_json.search("john")
+# => [#<Flexi::Json::Dataset:0x0000ffffa0f5f668 @address="Sydney Australia", @attributes={:name=>"John", :address=>"Sydney Australia"}, @name="John", @searchable_fields=["name", "address"]>]
 
 # Or filter it by your chosen key e.g first_name
 flexi_json.search("john", "first_name")
@@ -52,8 +53,11 @@ flexi_json.find_duplicates("email,full_name")
 
 ## Advanced search
 ```ruby
-options = {matched_all: true, exact_match: false}
-flexi_json.search({first_name: "john", address: "sydney"}, options)
+search_query = {first_name: "john", address: "sydney"}
+flexi_json.search(
+  search_query, 
+  options: {matched_all: true, exact_match: false}
+)
 # => [#<Flexi::Json::Dataset:0x0000ffffa0f5f668 @address="Sydney Australia", @attributes={:name=>"John", :address=>"Sydney Australia"}, @name="John", @searchable_fields=["name", "address"]>]
 ```
 

data/lib/flexi/json/dataset.rb

@@ -12,20 +12,22 @@ module Flexi
         end
       end
 
-      def matches?(query, fields = searchable_fields, options: Flexi::Json::Configuration.default_match_options)
-        validateable_fields = query.is_a?(Hash) ? query.keys.map(&:to_s) : fields
-        valid_fields = validateable_fields&.select { |field| searchable_fields.include?(field) } || searchable_fields
+      def matches?(query, fields = nil, options: nil)
+        options ||= Flexi::Json::Configuration.default_match_options
+
+        valid_fields = validateable_fields(query, fields)&.select do |field|
+          searchable_fields.include?(field)
+        end || searchable_fields
 
         return false if valid_fields.empty?
 
         matching_method = options[:match_all] ? :all? : :any?
         valid_fields.public_send(matching_method) do |field|
           search_query = query.is_a?(Hash) ? query[field.to_sym] : query
-          if options[:exact_match]
-            attributes[field.to_sym].to_s.downcase == search_query.to_s.downcase
-          else
-            attributes[field.to_sym].to_s.downcase.include?(search_query.to_s.downcase)
-          end
+          attribute_value = attributes[field.to_sym].to_s.downcase
+          query_value = search_query.to_s.downcase
+
+          options[:exact_match] ? attribute_value == query_value : attribute_value.include?(query_value)
         end
       end
 
@@ -35,6 +37,16 @@ module Flexi
 
       private
 
+      def validateable_fields(query, fields)
+        if query.is_a?(Hash)
+          query.keys.map(&:to_s)
+        elsif fields.is_a?(String)
+          fields.delete(" ").split(",")
+        elsif fields.is_a?(Array)
+          [fields || searchable_fields].flatten
+        end
+      end
+
       # Method to validate that a key is a valid method name and not dangerous
       def valid_key?(key)
         key.match?(/\A[a-z_][a-zA-Z0-9_]*\z/) && !dangerous_method?(key)

data/lib/flexi/json/searcher.rb

@@ -10,8 +10,8 @@ module Flexi
         @result = []
       end
 
-      def search(query, fields = nil)
-        @result = @data.select { |data| data.matches?(query, fields) }
+      def search(query, fields = nil, options: nil)
+        @result = @data.select { |data| data.matches?(query, fields, options: options) }
       end
 
       def find_duplicates(keys)

data/lib/flexi/json/version.rb

@@ -2,6 +2,6 @@
 
 module Flexi
   module Json
-    VERSION = "0.4.0"
+    VERSION = "0.4.2"
   end
 end

data/lib/flexi/json.rb

@@ -10,30 +10,25 @@ module Flexi::Json
   class << self
     attr_writer :configuration
 
-    # Access or initialize the configuration object
     def configuration
       @configuration ||= Flexi::Json::Configuration.instance
     end
 
-    # Configure block for setting custom configurations
     def configure
       yield(configuration)
     end
-  end
 
-  class Run
-    # Your code goes here...
-    def initialize(data)
+    def new(data)
       datasets = Flexi::Json::Loader.new(data).load_data
       @searcher = Flexi::Json::Searcher.new(datasets)
     end
+  end
 
-    def search(query = "", fields = nil)
-      @searcher.search(query, fields)
-    end
+  def search(query = "", fields = nil, options: nil)
+    @searcher.search(query, fields, options: options)
+  end
 
-    def find_duplicates(keys)
-      @searcher.find_duplicates(keys)
-    end
+  def find_duplicates(keys)
+    @searcher.find_duplicates(keys)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexi-json
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Gerda Decio