tree_reject 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1ffe46be0f2a714ce8f7c6411dca2cce60394f61e309f00f3ecbf21fdca46bf
+  data.tar.gz: 5b85c983a4d6f86f71ed1cdf372feb4c5d0d0ff7df247ac3b98c2617ff783a73
+SHA512:
+  metadata.gz: 31c899b6343cf3c0db651d90fbc545b03757053827f8993fbbbabcfebb59a19de3179879280d88266bc463388cd2bf06738e5f55d4dd4fb3c7dd3d450630491e
+  data.tar.gz: 1aca2595815757c63e752892d88fe69d161c81a0ee7476f77d72684486c503ef9c20c93981e0add37626f9b82b1a677c5346a87a6e04f85422209e0a93500778

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+  - 'vendor/**/*'
+  - 'gemfiles/vendor/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

data/.ruby-gemset

@@ -0,0 +1 @@
+tree_reject

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.12.4
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+
+## Unreleased
+
+## 0.1.0 - 2019-03-28
+### Added
+- Initial version

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+
+source 'https://rubygems.org'
+
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in tree_reject.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Salsify, Inc
+
+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,97 @@
+# tree_reject
+
+[![Build Status](https://travis-ci.org/salsify/tree_reject.svg?branch=master)](https://travis-ci.org/salsify/tree_reject)
+
+
+`tree_reject` is a Ruby gem that removes deeply nested keys from Ruby Hashes or hash-like objects.
+
+For example if you have the Hash:
+
+```ruby
+hash = {
+  a: {
+    aa: {
+      aaa: 'aaa',
+      aab: 'aab'
+    }
+  },
+  b: {
+    ba: 'ba'
+  }
+}
+```
+
+and `tree_reject` the Hash:
+```ruby
+{
+  a: {
+    aa: :aaa
+  }
+}
+```
+
+your new hash will be:
+```ruby
+{
+  a: {
+    aa: {
+      aab: 'aab'
+    }
+  }, 
+  b: {
+    ba: 'ba'
+  }
+} 
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tree_reject'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tree_reject
+
+## Usage
+
+`tree_reject` extends Ruby's built-in `Hash`:
+
+```ruby
+my_hash.tree_reject(ignored_keys)
+```
+
+It is also available for objects that support `to_h`.
+
+```ruby
+TreeReject.tree_reject(my_hash_like, ignored_keys)
+```
+
+## 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/salsify/tree_reject.## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tree_reject'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle update
+
+overcommit --install

data/lib/tree_reject.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'tree_reject/version'
+
+module TreeReject
+  extend self
+
+  module TreeRejectHash
+    def tree_reject(ignorned_keys)
+      TreeReject.tree_reject(self, ignorned_keys)
+    end
+  end
+
+  # returns a new map with the ignored keys removed
+  # ignored_keys must be an array of IKItems
+  # IKItem is the type <Symbol | Array<IkItem> | Hash<Symbol, IKItem>>
+  # keys are only removed if their path in the trees match
+  def tree_reject(map, ignored_keys)
+    ignored_leaves = extract_leaves(ignored_keys)
+    ignored_subtrees = extract_subtrees(ignored_keys, ignored_leaves)
+
+    map.to_h.each_with_object({}) do |(k, v), cleaned|
+      if ignored_leaves.include?(k)
+        next
+      elsif v.is_a?(Hash) || v.respond_to?(:attributes)
+        cleaned_v = tree_reject(v.to_h, ignored_subtrees[k])
+        cleaned[k] = cleaned_v unless cleaned_v == {}
+      elsif !v.nil?
+        cleaned[k] = v
+      end
+    end
+  end
+
+  private
+
+  # extract the top level leaves from the ignored_keys tree structure
+  def extract_leaves(ignored_keys)
+    [ignored_keys].flatten.reject { |ignored_key| ignored_key.is_a?(Hash) }
+  end
+
+  # extract the top level subtrees from the ignored_keys tree structure, skipping ones included ignored_leaves
+  def extract_subtrees(ignored_keys, ignored_leaves)
+    [ignored_keys].flatten.select { |ignored_key| ignored_key.is_a?(Hash) }.inject({}) do |h, ignored_subtree|
+      ignored_subtree.each_pair do |k, v|
+        next if ignored_leaves.include?(k)
+
+        if h.key?(k)
+          h[k] << v
+        else
+          h[k] = [v]
+        end
+      end
+      h
+    end
+  end
+end
+
+Hash.send(:include, TreeReject::TreeRejectHash)

data/lib/tree_reject/version.rb

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

data/tree_reject.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tree_reject/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tree_reject'
+  spec.version       = TreeReject::VERSION
+  spec.authors       = ['Salsify, Inc']
+  spec.email         = ['engineering@salsify.com']
+
+  spec.summary       = 'Remove deeply nested keys from hash.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/salsify/tree_reject'
+
+  spec.license       = 'MIT'
+
+
+  # Set 'allowed_push_post' to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'overcommit'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.60.0'
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: tree_reject
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salsify, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+description: Remove deeply nested keys from hash.
+email:
+- engineering@salsify.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tree_reject.rb
+- lib/tree_reject/version.rb
+- tree_reject.gemspec
+homepage: https://github.com/salsify/tree_reject
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Remove deeply nested keys from hash.
+test_files: []