flexi-json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 831ab0ef38dfd154ec606fe74ab9c8600ff434b25a9db6cec199176835292081
+  data.tar.gz: 6b48b8cba93525b3b905a59baceda79e48df3b0165dcddafc2c27a1d38ba8d22
+SHA512:
+  metadata.gz: d09892eb341686fedd577f716dac6c326ed92df32a04fc8bb98aee39b029a2afecb575bd0943bfb7adfdcb5f4742ff8472484ac53602b25c75aff769b97f3a1d
+  data.tar.gz: d676046637dd8a87ea6b3ab842e70cfcde82fb784a425b6d0c41b4e7acc980c2a9711c48df06dbc7d01e86df5f9950ae3c936c13d8fdb8b44af2fe69946f8fc5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## CHANGELOG
+
+## [0.1.0] - 2024-09-20
+
+- The first release of flexi-json gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 iamgeeeee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+[![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)
+
+# flexi-json
+
+`Flexi::Json` is a versatile Ruby gem designed for manipulating JSON data. With functionalities for searching, generating new JSON, and transforming existing structures.
+
+## Installation
+
+You can install the gem using RubyGems:
+```
+gem install flexi-json
+```
+
+or add it to your Gemfile
+```
+gem 'flexi-json'
+```
+
+and then run:
+```
+bundle install
+```
+
+## Usage
+```ruby
+require 'flexi/json'
+
+# File path to the JSON data
+Flexi::Json::Run.new("some/path/to/file.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")
+
+# 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")
+```
+
+## 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 loader by chunking the data
+
+## Contributing
+Contributions are welcome! If you have suggestions for improvements or new features, feel free to fork the repository and create a pull request. Please ensure your code adheres to the project's coding standards and includes tests for new features.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GD-Personal/flexi-json. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/GD-Personal/flexi-json/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec lint]
+
+desc "Run StandardRB linter and automatically fix issues"
+task :lint do
+  sh "bundle exec standardrb --fix"
+end
+
+desc "Run bundle-audit to check for gems' vulnerabilities"
+task :audit do
+  sh "bundle exec bundle-audit check --update"
+end

data/lib/flexi/json/dataset.rb

@@ -0,0 +1,60 @@
+module Flexi
+  module Json
+    class Dataset
+      attr_reader :attributes
+
+      def initialize(attributes = {})
+        @attributes = attributes
+
+        @attributes.each do |key, value|
+          validate_key(key)
+          set_instance_variable(key, value)
+          define_accessor_methods(key)
+        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
+
+        return false if valid_fields.empty?
+
+        valid_fields.any? do |field|
+          value = send(field)
+          value.to_s.downcase.include?(query.to_s.downcase)
+        end
+      end
+
+      def searchable_fields
+        @searchable_fields ||= attributes.keys.map(&:to_s)
+      end
+
+      private
+
+      # 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)
+      end
+
+      # Prevent overriding critical Ruby methods
+      def dangerous_method?(key)
+        %w[initialize object_id method_missing to_s send class].include?(key.to_s)
+      end
+
+      def validate_key(key)
+        raise "Invalid key: #{key}" unless valid_key?(key)
+      end
+
+      def set_instance_variable(key, value)
+        instance_variable_set(:"@#{key}", value)
+      end
+
+      def define_accessor_methods(key)
+        self.class.class_eval do
+          define_method(key) { instance_variable_get(:"@#{key}") } unless method_defined?(key)
+          define_method(:"#{key}=") { |val| instance_variable_set(:"@#{key}", val) } unless method_defined?(:"#{key}=")
+        end
+      end
+    end
+  end
+end

data/lib/flexi/json/loader.rb

@@ -0,0 +1,20 @@
+module Flexi
+  module Json
+    class Loader
+      def initialize(data_file_path)
+        @data_file_path = data_file_path
+      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!")
+        []
+      end
+    end
+  end
+end

data/lib/flexi/json/searcher.rb

@@ -0,0 +1,47 @@
+require "json"
+
+module Flexi
+  module Json
+    class Searcher
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+        @result = []
+      end
+
+      def search(query, fields = nil)
+        @data.select { |data| data.matches?(query, fields) }
+      end
+
+      def find_duplicates(keys)
+        duplicates = {}
+        fields = keys.gsub(/\s+/, "").strip.split(",")
+        filtered_fields = fields.select { |field| @data.first&.searchable_fields&.include?(field) }
+
+        return [] if filtered_fields.empty?
+
+        grouped_data = @data.group_by do |d|
+          filtered_fields.map { |f| d.attributes[f].to_s.downcase }
+        end
+        grouped_data.each do |key, value|
+          duplicates[key] = value if value.size > 1
+        end
+
+        duplicates.values.flatten
+      end
+
+      # Displays results to the console
+      def display_results(results, output = $stdout)
+        if results.empty?
+          output.puts "No data found."
+        else
+          results.each do |result|
+            output.puts result.attributes.map { |k, v| "#{k}: #{v}" }.join(", ")
+          end
+          output.puts "Found #{results.size} result(s)!"
+        end
+      end
+    end
+  end
+end

data/lib/flexi/json/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Flexi
+  module Json
+    VERSION = "0.1.0"
+  end
+end

data/lib/flexi/json.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "json/dataset"
+require_relative "json/loader"
+require_relative "json/searcher"
+require_relative "json/version"
+
+module Flexi::Json
+  class Error < StandardError; end
+
+  class Run
+    # Your code goes here...
+    def initialize(data, options = {})
+      @json_data = Flexi::Json::Loader.new(data).load_data
+    end
+
+    def search(query = "", fields = nil)
+      Flexi::Json::Searcher.new(@json_data).search(query, fields)
+    end
+
+    def find_duplicates(keys)
+      Flexi::Json::Searcher.new(@json_data).find_duplicates(keys)
+    end
+  end
+end

data/sig/flexi/json.rbs

@@ -0,0 +1,6 @@
+module Flexi
+  module Json
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: flexi-json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerda Decio
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-20 00:00:00.000000000 Z
+dependencies: []
+description: A versatile Ruby gem designed for manipulating JSON data. With functionalities
+  for searching, generating new JSON, and transforming existing structures.
+email:
+- contact@gerdadecio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/flexi/json.rb
+- lib/flexi/json/dataset.rb
+- lib/flexi/json/loader.rb
+- lib/flexi/json/searcher.rb
+- lib/flexi/json/version.rb
+- sig/flexi/json.rbs
+homepage: https://github.com/GD-Personal/flexi-json
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: A ruby gem designed for manipulating JSON data.
+test_files: []