flexi-json 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 831ab0ef38dfd154ec606fe74ab9c8600ff434b25a9db6cec199176835292081
-  data.tar.gz: 6b48b8cba93525b3b905a59baceda79e48df3b0165dcddafc2c27a1d38ba8d22
+  metadata.gz: b10a91e8b4e687fdd0c69e73b8a53d6f1e66e96361fe08259c7244aec87e638b
+  data.tar.gz: 2f7a7dd6d9acc9069c3c1884ff98736041113889c8cd35efa5c94bd7f6acd48e
 SHA512:
-  metadata.gz: d09892eb341686fedd577f716dac6c326ed92df32a04fc8bb98aee39b029a2afecb575bd0943bfb7adfdcb5f4742ff8472484ac53602b25c75aff769b97f3a1d
-  data.tar.gz: d676046637dd8a87ea6b3ab842e70cfcde82fb784a425b6d0c41b4e7acc980c2a9711c48df06dbc7d01e86df5f9950ae3c936c13d8fdb8b44af2fe69946f8fc5
+  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

@@ -1,4 +1,4 @@
-[![Github Actions](https://github.com/GD-Personal/flexi-json/actions/workflows/main.yml/badge.svg)](https://github.com/GD-Personal/flexi-json/actions/workflows/main.yml) [![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://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)
 
 # flexi-json
 
@@ -25,24 +25,39 @@ bundle install
 ```ruby
 require 'flexi/json'
 
-# File path to the JSON data
-Flexi::Json::Run.new("some/path/to/file.json").search("john")
+# 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"]>]>
+
+# 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")
+
+# Search for data
+flexi_json.search("john")
 
 # Or filter it by your chosen key e.g first_name
-Flexi::Json::Run.new("some/path/to/file.json").search("john", "first_name")
-Flexi::Json::Run.new("some/path/to/file.json").search("john", "first_name,email")
+flexi_json.search("john", "first_name")
+flexi_json.search("john", "first_name,email")
 
 # Find duplicate emails
-Flexi::Json::Run.new("some/path/to/file.json").find_duplicates("email")
-Flexi::Json::Run.new("some/path/to/file.json").find_duplicates("email,full_name")
+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 support for accepting a dataset url rather than just a local file path
-- Add support for accepting raw json data
 - Add CRUD support to the dataset
-- Optimise the search function by implimenting indeces
+- Optimise the search function by implementing indeces 
 - Optimise the loader by chunking the data
 
 ## Contributing

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/loader.rb

@@ -1,19 +1,40 @@
+require "net/http"
+require "uri"
+
 module Flexi
   module Json
     class Loader
-      def initialize(data_file_path)
-        @data_file_path = data_file_path
+      def initialize(data)
+        @data = data
+      end
+
+      def load_data
+        loaded_data = load_from_local_file || load_from_raw_json || load_from_url || []
+        loaded_data.map { |result| Dataset.new(result.transform_keys(&:to_sym)) }
+      end
+
+      private
+
+      def load_from_raw_json(raw_json = nil)
+        data = JSON.parse(raw_json || @data)
+        data.is_a?(Array) ? data : [data]
+      rescue JSON::ParserError, TypeError
+        nil
+      end
+
+      def load_from_local_file
+        data = File.read(@data)
+        load_from_raw_json(data)
+      rescue Errno::ENOENT, TypeError
+        nil
       end
 
-      def load_data(output = $stdout)
-        file = File.read(@data_file_path)
-        JSON.parse(file).map { |result| Dataset.new(result) }
-      rescue Errno::ENOENT
-        output.puts("Dataset file not found at #{@data_file_path}!")
-        []
-      rescue JSON::ParserError
-        output.puts("Invalid JSON!")
-        []
+      def load_from_url
+        uri = URI.parse(@data)
+        response = Net::HTTP.get_response(uri)
+        response.is_a?(Net::HTTPSuccess) ? load_from_raw_json(response.body) : nil
+      rescue URI::InvalidURIError, Errno::ECONNREFUSED
+        nil
       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)
@@ -22,17 +27,17 @@ module Flexi
         return [] if filtered_fields.empty?
 
         grouped_data = @data.group_by do |d|
-          filtered_fields.map { |f| d.attributes[f].to_s.downcase }
+          filtered_fields.map { |f| d.attributes[f.to_sym].to_s.downcase }
         end
         grouped_data.each do |key, value|
           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.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/flexi/json.rb

@@ -10,16 +10,21 @@ module Flexi::Json
 
   class Run
     # Your code goes here...
-    def initialize(data, options = {})
-      @json_data = Flexi::Json::Loader.new(data).load_data
+    def initialize(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,113 @@
 --- !ruby/object:Gem::Specification
 name: flexi-json
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerda Decio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
-dependencies: []
+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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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:
@@ -25,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
@@ -36,9 +135,10 @@ 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/blob/main/CHANGELOG
+  changelog_uri: https://github.com/GD-Personal/flexi-json/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -47,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:
   - - ">="