flexi-json 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f80c4f6ead357e1dfb161b0dc6cca110858e7698b4f8cd875bc40e16d0cade14
-  data.tar.gz: a66e1baae920f9e1e2c0a6ab2d448e35a71a1a8d337519ad5cd625cda6eefa69
+  metadata.gz: b10a91e8b4e687fdd0c69e73b8a53d6f1e66e96361fe08259c7244aec87e638b
+  data.tar.gz: 2f7a7dd6d9acc9069c3c1884ff98736041113889c8cd35efa5c94bd7f6acd48e
 SHA512:
-  metadata.gz: a47e6dfe5515d08453ff79d78b224b0c4037450bc3c808e28d214b65c783fc57a46bd7282a4689c692de80fecb23fda6ff582b65988b432116de415a684a9898
-  data.tar.gz: da908945d06dd9a524587ec7665a14e061db30241defca07e882b7a7bac9d3943e2461a283034bba46c099a04bf29ce207218896ddeb940f924965a59fea55cb
+  metadata.gz: 1f793341d32d74087ce18d669f0df367e1503a081a4e227cb8dbda80e8e3a64fdc02b9bd7324b69738bde9b86aeb6f70c287ea75db0bd3accafff23ea08216b5
+  data.tar.gz: dbd6b4bf1f222c4fb657ab346057ae975073397b7c5a4d84c32f0589b02e9c905be510ae6ea10c49b19515a312f19ef950bc64e0573268f80172ca185e8fa896

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# Version: 0.3.0 -  2024-09-22
+
+* [#10](https://github.com/GD-Personal/flexi-json/pull/10): Release 0.2.0
+* [#11](https://github.com/GD-Personal/flexi-json/pull/11): v0.3.0 - Advanced search 
+
+
+# Version: 0.2.0 - 2024-09-21
+
+* [#1](https://github.com/GD-Personal/flexi-json/pull/1): Add support for different data input to the loader
+* [#2](https://github.com/GD-Personal/flexi-json/pull/2): Add the github_changelog_generator gem
+* [#3](https://github.com/GD-Personal/flexi-json/pull/3): Update changelog workflow
+* [#4](https://github.com/GD-Personal/flexi-json/pull/4): Add token
+* [#5](https://github.com/GD-Personal/flexi-json/pull/5): Add token
+* [#6](https://github.com/GD-Personal/flexi-json/pull/6): Rename json_data to datasets
+
+
 ## CHANGELOG
 
 ## [0.1.0] - 2024-09-20

data/README.md

@@ -30,6 +30,7 @@ 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"]>]>
 
 # 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")
@@ -46,6 +47,13 @@ flexi_json.find_duplicates("email")
 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)
+# => [#<Flexi::Json::Dataset:0x0000ffffa0f5f668 @address="Sydney Australia", @attributes={:name=>"John", :address=>"Sydney Australia"}, @name="John", @searchable_fields=["name", "address"]>]
+```
+
 ## TODOS
 - Improve search filter by specifying fields to filter from
 - Add CRUD support to the dataset

data/changelog_config.yml

@@ -0,0 +1,29 @@
+changelog_type: 'commit_message' # or 'pull_request'
+header_prefix: 'Version:'
+commit_changelog: true
+comment_changelog: true
+include_unlabeled_changes: true
+unlabeled_group_title: 'Unlabeled Changes'
+pull_request_title_regex: '^Release'
+version_regex: 'v?([0-9]{1,2})+[.]+([0-9]{1,2})+[.]+([0-9]{1,2})\s\(\d{1,2}-\d{1,2}-\d{4}\)'
+exclude_labels:
+  - bot
+  - dependabot
+  - ci
+group_config:
+  - title: Bug Fixes
+    labels:
+      - bug
+      - bugfix
+  - title: Code Improvements
+    labels:
+      - improvements
+      - enhancement
+  - title: New Features
+    labels:
+      - feature
+  - title: Documentation Updates
+    labels:
+      - docs
+      - documentation
+      - doc

data/lib/flexi/json/dataset.rb

@@ -1,3 +1,4 @@
+require "debug"
 module Flexi
   module Json
     class Dataset
@@ -5,7 +6,6 @@ module Flexi
 
       def initialize(attributes = {})
         @attributes = attributes
-
         @attributes.each do |key, value|
           validate_key(key)
           set_instance_variable(key, value)
@@ -13,15 +13,20 @@ module Flexi
         end
       end
 
-      # Returns true if any of the client's fields match the search query
-      def matches?(query, fields = searchable_fields)
-        valid_fields = fields&.select { |field| searchable_fields.include?(field) } || searchable_fields
+      def matches?(query, fields = searchable_fields, options: Searcher::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
 
         return false if valid_fields.empty?
 
-        valid_fields.any? do |field|
-          value = send(field)
-          value.to_s.downcase.include?(query.to_s.downcase)
+        matching_method = options[:matched_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
         end
       end
 

data/lib/flexi/json/searcher.rb

@@ -3,7 +3,12 @@ require "json"
 module Flexi
   module Json
     class Searcher
-      attr_reader :data
+      attr_reader :data, :result
+
+      DEFAULT_MATCH_OPTIONS = {
+        matched_all: false,
+        exact_match: false
+      }.freeze
 
       def initialize(data)
         @data = data
@@ -11,7 +16,7 @@ module Flexi
       end
 
       def search(query, fields = nil)
-        @data.select { |data| data.matches?(query, fields) }
+        @result = @data.select { |data| data.matches?(query, fields) }
       end
 
       def find_duplicates(keys)
@@ -28,11 +33,11 @@ module Flexi
           duplicates[key] = value if value.size > 1
         end
 
-        duplicates.values.flatten
+        @result = duplicates.values.flatten
       end
 
       # Displays results to the console
-      def display_results(results, output = $stdout)
+      def display_results(results = @result, output = $stdout)
         if results.empty?
           output.puts "No data found."
         else

data/lib/flexi/json/version.rb

@@ -2,6 +2,6 @@
 
 module Flexi
   module Json
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/flexi/json.rb

@@ -11,15 +11,20 @@ module Flexi::Json
   class Run
     # Your code goes here...
     def initialize(data)
-      @json_data = Flexi::Json::Loader.new(data).load_data
+      datasets = Flexi::Json::Loader.new(data).load_data
+      @searcher = Flexi::Json::Searcher.new(datasets)
     end
 
     def search(query = "", fields = nil)
-      Flexi::Json::Searcher.new(@json_data).search(query, fields)
+      @searcher.search(query, fields)
     end
 
     def find_duplicates(keys)
-      Flexi::Json::Searcher.new(@json_data).find_duplicates(keys)
+      @searcher.find_duplicates(keys)
+    end
+
+    def display_results
+      @searcher.display_results
     end
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: flexi-json
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerda Decio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.4
 - !ruby/object:Gem::Dependency
-  name: github_changelog_generator
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.4
+        version: 1.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.4
+        version: 1.9.2
 description: A versatile Ruby gem designed for manipulating JSON data. With functionalities
   for searching, generating new JSON, and transforming existing structures.
 email:
@@ -95,6 +123,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- changelog_config.yml
 - lib/flexi/json.rb
 - lib/flexi/json/dataset.rb
 - lib/flexi/json/loader.rb
@@ -106,6 +135,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/GD-Personal/flexi-json/issues
   homepage_uri: https://github.com/GD-Personal/flexi-json
   source_code_uri: https://github.com/GD-Personal/flexi-json
   changelog_uri: https://github.com/GD-Personal/flexi-json/blob/main/CHANGELOG.md
@@ -117,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="