key_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3adbed28729cba5c2b3878930ca08c02d9f0fb187ed678d198c0d590bb9f20b7
+  data.tar.gz: 3ecaaa1c9e9df660af725ba6ed901337e886486b862fbd42ba9195db102422df
+SHA512:
+  metadata.gz: cce5c2541a1195967488358d71d2e666a3a0b4a968bf85430a1d26bbf401e2cc3b9d58f62e95ec74886980558304affafc221fecfc6a907c3410d6e2f09f1a5f
+  data.tar.gz: e32567fbee972c5f12547c9445ab1be6a78fe4e2245053f70d938bececd1a7143a897b34cd6533c7f3e41b2d82aa3c8e356cc49a67aae33e6c735925047b747e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/vendor

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

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 calle@discord.bofh.se. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in key_tree.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    key_tree (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  key_tree!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Calle Englund
+
+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,43 @@
+# KeyTree
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/key_tree`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'key_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install key_tree
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/key_tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 KeyTree project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/key_tree/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+desc 'Run RuboCop'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options << '--display-cop-names'
+end
+
+desc 'Run RSpec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'key_tree'
+
+# 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(__FILE__)

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/key_tree.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'key_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'key_tree'
+  spec.version       = KeyTree::VERSION
+  spec.authors       = ['Calle Englund']
+  spec.email         = ['calle@discord.bofh.se']
+
+  spec.summary       = 'Manage trees of keys'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/notcalle/ruby-keytree'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+end

data/lib/key_tree/path.rb

@@ -0,0 +1,95 @@
+module KeyTree
+  #
+  # Representation of the key path to a value in a key tree
+  #
+  class Path < Array
+    #
+    # KeyTree::Path[+key_or_path+, ...]
+    #
+    # Make a new key path from one or more keys or paths
+    #
+    def self.[](*keys_or_paths)
+      keys_or_paths.reduce(Path.new) do |result, key_or_path|
+        result << Path.new(key_or_path)
+      end
+    end
+
+    #
+    # KeyTree::Path.new(+key_or_path+)
+    #
+    # Make a new key path from a dot separated string, single symbol,
+    # or array of strings or symbols.
+    #
+    # Example:
+    #   KeyTree::Path.new("a.b.c")
+    #   => ["a", "b", "c"]
+    #
+    def initialize(key_or_path = [])
+      case key_or_path
+      when String
+        initialize(key_or_path.split('.'))
+      when Symbol
+        append(key_or_path)
+      when Array
+        key_or_path.each { |key| append(key.to_sym) }
+      else
+        raise ArgumentError, 'key path must be String, Symbol or Array of those'
+      end
+    end
+
+    def to_s
+      join('.')
+    end
+
+    def inspect
+      %("#{self}")
+    end
+
+    def <<(other)
+      case other
+      when Path
+        other.reduce(self) do |result, key|
+          result.append(key)
+        end
+      else
+        self << Path[other]
+      end
+    end
+
+    def +(other)
+      dup << other
+    end
+
+    # drop(+prefix+)
+    #
+    #   Returns a key path without the leading prefix
+    #
+    # drop(+n+)
+    #
+    #   Returns a key path without the first n elements
+    #
+    def drop(prefix)
+      case prefix
+      when Path
+        return self unless prefix?(other)
+        drop(other.length)
+      else
+        super(prefix)
+      end
+    end
+
+    # Is +other+ a prefix?
+    #
+    def prefix?(other)
+      return false if other.length > length
+      key_enum = each
+      other.all? { |other_key| key_enum.next == other_key }
+    end
+
+    # Would +other+ conflict?
+    #
+    def conflict?(other)
+      prefix?(other) || other.prefix?(self) if self != other
+    end
+  end
+end

data/lib/key_tree/tree.rb

@@ -0,0 +1,44 @@
+require 'key_tree/path'
+
+module KeyTree
+  # A tree of key-value lookup tables (hashes)
+  class Tree < Hash
+    #
+    # KeyTree::Tree.new(+hash+)
+    #
+    # Initialize a new KeyTree from nested Hash:es
+    #
+    def self.[](hash = {})
+      keytree = Tree.new
+      hash.each do |key, value|
+        keytree[key] = value
+      end
+      keytree
+    end
+
+    def [](key_or_path)
+      super(Path[key_or_path])
+    end
+
+    def fetch(key_or_path, *args, **kvargs, &proc)
+      super(Path[key_or_path], *args, **kvargs, &proc)
+    end
+
+    def values_at(*keys)
+      super(keys.map { |key_or_path| Path[key_or_path] })
+    end
+
+    def []=(key_or_path, new_value)
+      path = Path[key_or_path]
+
+      each_key { |key| delete(key) if path.conflict?(key) }
+
+      case new_value
+      when Hash
+        new_value.each { |suffix, value| super(path + suffix, value) }
+      else
+        super(path, new_value)
+      end
+    end
+  end
+end

data/lib/key_tree/version.rb

@@ -0,0 +1,3 @@
+module KeyTree
+  VERSION = '0.1.0'.freeze
+end

data/lib/key_tree.rb

@@ -0,0 +1,22 @@
+require 'key_tree/version'
+require 'key_tree/tree'
+
+# Manage a tree of keys
+#
+# Example:
+#   kt=KeyTree[a: 1, b: { c: 2 }]
+#   kt["a"]
+#   -> 1
+#   kt["b.c"]
+#   -> 2
+#
+module KeyTree
+  def self.[](contents = {})
+    case contents
+    when Hash
+      KeyTree::Tree[contents]
+    else
+      raise ArgumentError, "can't load #{contents.class} into a KeyTree"
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: key_tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calle Englund
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Manage trees of keys
+email:
+- calle@discord.bofh.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- key_tree.gemspec
+- lib/key_tree.rb
+- lib/key_tree/path.rb
+- lib/key_tree/tree.rb
+- lib/key_tree/version.rb
+homepage: https://github.com/notcalle/ruby-keytree
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Manage trees of keys
+test_files: []