flexi-json 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b10a91e8b4e687fdd0c69e73b8a53d6f1e66e96361fe08259c7244aec87e638b
-  data.tar.gz: 2f7a7dd6d9acc9069c3c1884ff98736041113889c8cd35efa5c94bd7f6acd48e
+  metadata.gz: 6d23543bb36512b335987eb6c12815956d98b170f2148fbbf12b92454064a96c
+  data.tar.gz: 8872ba4b925901cdeee8dcf27e5a409ca3784366dcf64ad370e60cdfe919bc54
 SHA512:
-  metadata.gz: 1f793341d32d74087ce18d669f0df367e1503a081a4e227cb8dbda80e8e3a64fdc02b9bd7324b69738bde9b86aeb6f70c287ea75db0bd3accafff23ea08216b5
-  data.tar.gz: dbd6b4bf1f222c4fb657ab346057ae975073397b7c5a4d84c32f0589b02e9c905be510ae6ea10c49b19515a312f19ef950bc64e0573268f80172ca185e8fa896
+  metadata.gz: 7acf01abdf37decc0f5d5d8a230da8b91f542d0dbb6c81efb90d5f229a1245b58764c0ba05fe0aa59b72348e3ef26b3b5484fc12f8700b108a49f3a0a4481c74
+  data.tar.gz: b6d8d236da0e37f0a9fd8a3785403363f5fc783820ea1ba351d7cf2647ec4f5666b24928ccd68a2eac6e0be94d4a41e707deb9acc948402acb8f91d4050a28dd

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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

@@ -1,4 +1,7 @@
-[![Gem Version](https://badge.fury.io/rb/flexi-json.svg)](https://badge.fury.io/rb/flexi-json) [![Github Actions](https://github.com/GD-Personal/flexi-json/actions/workflows/ci.yml/badge.svg)](https://github.com/GD-Personal/flexi-json/actions) [![Maintainability](https://api.codeclimate.com/v1/badges/bd14f8a5a0c7575d2ac2/maintainability)](https://codeclimate.com/github/GD-Personal/flexi-json/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/bd14f8a5a0c7575d2ac2/test_coverage)](https://codeclimate.com/github/GD-Personal/flexi-json/test_coverage)
+[![Gem Version](https://img.shields.io/gem/v/flexi-json.svg)](https://rubygems.org/gems/flexi-json)
+[![Github Actions](https://github.com/GD-Personal/flexi-json/actions/workflows/ci.yml/badge.svg)](https://github.com/GD-Personal/flexi-json/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bd14f8a5a0c7575d2ac2/maintainability)](https://codeclimate.com/github/GD-Personal/flexi-json/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/bd14f8a5a0c7575d2ac2/test_coverage)](https://codeclimate.com/github/GD-Personal/flexi-json/test_coverage)
 
 # flexi-json
 
@@ -25,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 a local file
+flexi_json = Flexi::Json.new("some/path/to/file.json")
 
-# 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 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")
@@ -54,8 +58,16 @@ 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"]>]
 ```
 
+## Configuration
+```ruby
+Flexi::Json.configure do |config|
+  config.exact_match_search = true
+  config.match_all_fields = true
+end
+```
+
 ## TODOS
-- Improve search filter by specifying fields to filter from
+- Generate results in json, csv, txt, or output in the console
 - Add CRUD support to the dataset
 - Optimise the search function by implementing indeces 
 - Optimise the loader by chunking the data

data/lib/flexi/json/configuration.rb

@@ -0,0 +1,26 @@
+require "singleton"
+module Flexi
+  module Json
+    class ConfigError < StandardError; end
+
+    class Configuration
+      include Singleton
+
+      attr_accessor :exact_match_search, :match_all_fields
+
+      class << self
+        def default_match_options
+          {
+            match_all: @match_all_fields || false,
+            exact_match: @exact_match_search || false
+          }.freeze
+        end
+      end
+
+      def initialize
+        @exact_match_search = false
+        @match_all_fields = false
+      end
+    end
+  end
+end

data/lib/flexi/json/dataset.rb

@@ -1,4 +1,3 @@
-require "debug"
 module Flexi
   module Json
     class Dataset
@@ -13,13 +12,13 @@ module Flexi
         end
       end
 
-      def matches?(query, fields = searchable_fields, options: Searcher::DEFAULT_MATCH_OPTIONS)
+      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
 
         return false if valid_fields.empty?
 
-        matching_method = options[:matched_all] ? :all? : :any?
+        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]

data/lib/flexi/json/searcher.rb

@@ -5,11 +5,6 @@ module Flexi
     class Searcher
       attr_reader :data, :result
 
-      DEFAULT_MATCH_OPTIONS = {
-        matched_all: false,
-        exact_match: false
-      }.freeze
-
       def initialize(data)
         @data = data
         @result = []

data/lib/flexi/json/version.rb

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

data/lib/flexi/json.rb

@@ -1,30 +1,36 @@
 # frozen_string_literal: true
 
+require_relative "json/configuration"
 require_relative "json/dataset"
 require_relative "json/loader"
 require_relative "json/searcher"
 require_relative "json/version"
 
 module Flexi::Json
-  class Error < StandardError; end
+  class << self
+    attr_writer :configuration
 
-  class Run
-    # Your code goes here...
-    def initialize(data)
-      datasets = Flexi::Json::Loader.new(data).load_data
-      @searcher = Flexi::Json::Searcher.new(datasets)
+    # Access or initialize the configuration object
+    def configuration
+      @configuration ||= Flexi::Json::Configuration.instance
     end
 
-    def search(query = "", fields = nil)
-      @searcher.search(query, fields)
+    # Configure block for setting custom configurations
+    def configure
+      yield(configuration)
     end
 
-    def find_duplicates(keys)
-      @searcher.find_duplicates(keys)
+    def new(data)
+      datasets = Flexi::Json::Loader.new(data).load_data
+      @searcher = Flexi::Json::Searcher.new(datasets)
     end
+  end
 
-    def display_results
-      @searcher.display_results
-    end
+  def search(query = "", fields = nil)
+    @searcher.search(query, fields)
+  end
+
+  def find_duplicates(keys)
+    @searcher.find_duplicates(keys)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexi-json
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gerda Decio
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -125,6 +125,7 @@ files:
 - Rakefile
 - changelog_config.yml
 - lib/flexi/json.rb
+- lib/flexi/json/configuration.rb
 - lib/flexi/json/dataset.rb
 - lib/flexi/json/loader.rb
 - lib/flexi/json/searcher.rb
@@ -139,7 +140,7 @@ metadata:
   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
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
-signing_key:
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: A ruby gem designed for manipulating JSON data.
 test_files: []