green_garden 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29297ca3243831dc70447d9b91b78d14c2ae20203bd292695fe4d37d0787acf4
+  data.tar.gz: 57fade0f5a6e74d1fe9a0c249813e985f0b88644cea1183b8c8f52c307d98c88
+SHA512:
+  metadata.gz: 3ce61bc3721aecfadef1fa3ce6c2e900312e8fe4dd951a88247260225491f8c54049ca65af0493228f92fe91034858e6822c1933ba031aea56c36666a8c69540
+  data.tar.gz: c31cd052017305ddfa509e4612adf011f3f50e5832e5ab775325a3103ff3de162fd390fa2a993d97445cbc66b41cbb628531e703052c16a0bb73e148afa633f9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# .DS_STORE danished!
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.6.6
+before_install: gem install bundler -v 2.1.4
+deploy:
+  provider: rubygems
+  api_key: "9cecfe4c096bd8443684cc6b09274e57"
+  on:
+    tags: true
+    branch: master
+    gem: green_garden
+    gemspec: green_garden.gemspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nardonykolyszyn@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in green_garden.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "rspec-expectations", "~> 3.9"
+
+gem "rspec-json_expectations", "~> 2.2"
+
+gem "rspec-collection_matchers", "~> 1.2"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    green_garden (0.1.1)
+      colorize (~> 0.8.1)
+      dry-cli (~> 0.6.0)
+      oj (~> 3.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dry-cli (0.6.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    oj (3.10.14)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-collection_matchers (1.2.0)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-json_expectations (2.2.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  green_garden!
+  pry (~> 0.13.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-collection_matchers (~> 1.2)
+  rspec-expectations (~> 3.9)
+  rspec-json_expectations (~> 2.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nardo Nykolyszyn
+
+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,102 @@
+# GreenGarden
+
+[![Build Status](https://travis-ci.org/nardonykolyszyn/green_garden.svg?branch=master)](https://travis-ci.org/nardonykolyszyn/green_garden)
+
+*The land of green trees, where the magic happens and everything is possible, welcome to* **Green Garden** 🌳✨
+-------------------------------------
+
+**Why this name?**
+
+These Trees are not regular ones, here is where the magic occurs, and where mysterious creatures called "Bugs" are on the prowl, be careful, and enjoy this new adventure. 🧙
+
+**Purpose**
+
+Green Garden was created with the purpose to teach algorithms by using multidimensional data-structures such as Hashes and Graphs.
+
+**Capabilities**
+
+*Before raising the blessed sword, get up that stick!*
+
+Green Garden allows provides a powerful CLI tool to perform a set of operations with trees, additionally it's a Ruby gem that can be easily installed in your Rails or Ruby application.
+
+- Compare two JSON files
+
+**Coming soon**
+- *[Label large datasets](https://whatis.techtarget.com/definition/data-labeling)*
+- *Order datasets by a variety of options*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'green_garden'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install green_garden
+
+## Usage
+
+```bash
+  $ green_garden diff data/chicago.json data/seattle.json
+```
+
+> It returns "true" if both datasets are equal and "false" if not.
+
+**Show current version**
+
+```bash
+  $ green_garden --version
+```
+
+**Show help**
+
+```bash
+  $ green_garden --help
+```
+
+## Performance
+
+OJ was implemented to load heavy JSON files, feel free to use any big dataset you have, I guarantee you that there will not be any problem comparing them, recursive approach won't waste memory in unnecesary and repetitive operations.
+
+**Fuzzing**
+
+1. Download this sample dataset (https://github.com/lutangar/cities.json/blob/master/cities.json) [SIZE: 13MB]
+
+2. Run
+
+```bash
+  $ green_garden diff cities.json cities.json
+```
+--------------------------------
+
+![Gif](https://media.giphy.com/media/Pitv6kOoR0XpsUUiJG/giphy.gif)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/green_garden. 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/[USERNAME]/green_garden/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GreenGarden project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/green_garden/blob/master/CODE_OF_CONDUCT.md).
+
+# Author
+
+*Nardo Nykolyszyn* - nardonykolyszyn (at) gmail

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "green_garden"
+require "pry"
+
+# Initialize REPL
+Pry.start(__FILE__)

data/bin/green_garden

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dry/cli"
+require "green_garden"
+require "colorize"
+
+module GreenGarden
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        desc "Show current version"
+
+        def call(*)
+          puts GreenGarden::VERSION
+        end
+      end
+
+      class Tree < Dry::CLI::Command
+        desc "Compare two datasets in (JSON) format"
+
+        argument :dataset_one, required: true, type: :string
+        argument :dataset_two, required: true, type: :string
+
+        example [
+          "data/chicago.json data/seattle.json"
+        ]
+
+        def call(dataset_one:, dataset_two:)
+          begin
+            datasets_diff = GreenGarden::Tree.diff_between(dataset_one, dataset_two)
+
+            puts (datasets_diff ? "Datasets are equal".green : "Datasets are different".red)
+          rescue GreenGarden::Tree::DatasetNotFound
+            puts "Trees could not be loaded, please check files paths".red
+          end
+        end
+      end
+
+      # Register available options
+
+      register "version", Version, aliases: %w[v -v --version]
+      register "diff", Tree
+    end
+  end
+end
+
+# Initialize CLI
+Dry::CLI.new(GreenGarden::CLI::Commands).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/green_garden.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/green_garden/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'green_garden'
+  spec.version       = GreenGarden::VERSION
+  spec.authors       = %w[Nardo\ Nykolyszyn]
+  spec.email         = %w[nardonykolyszyn@gmail.com]
+
+  spec.summary       = 'The definitive gem to handle Trees in Ruby'
+  spec.description   = 'Green Garden is the definitive Ruby gem to handle common Trees operations by using fancy code argued on Tree Traversal theorem.'
+  spec.homepage      = 'https://github.com/nardonykolyszyn/green_garden.git'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nardonykolyszyn/green_garden.git'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = %w[lib]
+
+  spec.executables << 'green_garden'
+
+  ## Dependencies
+
+  # Development
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+
+  # Production
+  spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'dry-cli', '~> 0.6.0'
+  spec.add_dependency 'oj', '~> 3.10'
+end

data/lib/green_garden.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'green_garden/comparer'
+require 'green_garden/graph'
+require 'green_garden/loader'
+require 'green_garden/models/activity_tracker'
+require 'green_garden/version'
+
+module GreenGarden
+  class Tree
+    extend Loader
+    extend Graph
+    extend Comparer
+    class DatasetNotFound < StandardError
+      def initialize(msg = 'Dataset could not be loaded, please check file path')
+        super
+      end
+    end
+    class << self
+      def diff_between(tree_one, tree_two)
+        tree_one = load_json(tree_one)
+        tree_two = load_json(tree_two)
+
+        activity_one = travel_graph(tree_one, GreenGarden::ActivityTracker.new)
+        activity_two = travel_graph(tree_two, GreenGarden::ActivityTracker.new)
+
+        compare_activities(activity_one, activity_two)
+      rescue Errno::ENOENT
+        raise DatasetNotFound
+      end
+    end
+  end
+end

data/lib/green_garden/comparer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module GreenGarden
+  module Comparer
+    def compare_activities(activity_one, activity_two)
+      (activity_one.shifts == activity_two.shifts) &&
+        (activity_one.parent_nodes == activity_two.parent_nodes) &&
+        (activity_one.children_nodes == activity_two.children_nodes)
+    end
+  end
+end

data/lib/green_garden/graph.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Trees can be treated as graphs that perform very well for multidimensional operations
+module GreenGarden
+  module Graph
+    # Pass any Tree you want to travel into
+    # Additionally you will need to pass a new activity_tracker to record information
+    def travel_graph(graph, current_activity)
+      graph.each do |node, children|
+        # Activity Tracker traits:
+        # shifts => Number of needed shifts to walk through the Tree.
+        # parent_nodes => All parent_nodes with their respective children structure type.
+        # children_nodes => Values of children items
+        current_activity.shifts += 1
+        current_activity.parent_nodes[node] = children.class
+        current_activity.children_nodes << record_children_as(children)
+
+        # When children exist we assume this node is a Hash otherwise it will be an Array.
+        if children.is_a?(Hash)
+          travel_graph(children, current_activity)
+        elsif children.is_a?(Array)
+          children.each { |child| travel_graph(child, current_activity) if child.is_a?(Hash) }
+        end
+      end
+      current_activity
+    end
+
+    def record_children_as(children)
+      case children.class
+      when String
+        children
+      when Array
+        children.flatten.map(&:values)
+      when Hash
+        children.values
+      end
+    end
+  end
+end

data/lib/green_garden/loader.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+# This modules provides a fast and non-disruptive way to load heavy JSON files
+# Oj helps to carry on with this task by providing an optimized parsing and marshalling interface
+module GreenGarden
+  module Loader
+    def load_json(file_path, read_mode = 'r')
+      File.open(file_path, read_mode) { |f| Oj.load(f.read) }
+    end
+  end
+end

data/lib/green_garden/models/activity_tracker.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GreenGarden
+  class ActivityTracker < Struct.new(:shifts, :parent_nodes, :children_nodes)
+    def initialize(*)
+      super
+      self.shifts ||= 0
+      self.parent_nodes ||= {}
+      self.children_nodes ||= []
+    end
+  end
+end

data/lib/green_garden/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GreenGarden
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: green_garden
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nardo Nykolyszyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Green Garden is the definitive Ruby gem to handle common Trees operations
+  by using fancy code argued on Tree Traversal theorem.
+email:
+- nardonykolyszyn@gmail.com
+executables:
+- green_garden
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/green_garden
+- bin/setup
+- green_garden.gemspec
+- lib/green_garden.rb
+- lib/green_garden/comparer.rb
+- lib/green_garden/graph.rb
+- lib/green_garden/loader.rb
+- lib/green_garden/models/activity_tracker.rb
+- lib/green_garden/version.rb
+homepage: https://github.com/nardonykolyszyn/green_garden.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nardonykolyszyn/green_garden.git
+  source_code_uri: https://github.com/nardonykolyszyn/green_garden.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: The definitive gem to handle Trees in Ruby
+test_files: []