hash_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b474a91f66ef7115da2bd73b98c436c6409301e332de18ed2439d4262e3cda6
+  data.tar.gz: 3314e15480623ee8e9a984b0054835bea8c1d77d48cc885eedf653dfa4346ba6
+SHA512:
+  metadata.gz: d92a9ec50b0032e3b8a675336d70ec3a5e238905ce71e990750997691bf776104f80d083be7cd59b32c1f59c08c2333f6f4f7ddd2970b9e8e03fb1af16c1965b
+  data.tar.gz: e2bfbd59bcbede4045e7aaae6b68a837cec99395ef00562732af9819581b981d9fde25c3b7c3d3e777c5f86fac931754760fa74e5d2dc7c0d8a90dd674b5b331

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore auto-generated main file
+/main
+
+# Ignore Gemfile.lock. See https://stackoverflow.com/questions/4151495/should-gemfile-lock-be-included-in-gitignore
+/Gemfile.lock
+
+# Put your personal ignore files in /home/clr/.config/git/ignore

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.6

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.3

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 hash_tree.gemspec
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# HashTree
+
+The `HashTree` module contains the Set and Map classes that implements a tree where each node acts as a hash over child nodes. `HashTree::Set` stores the key internally while `HashTree::Map` use an external key
+
+`HashTree` is still work-in-progress
+
+## Usage
+
+Basic usage. Read the source for full(er) documentation
+
+```ruby
+require 'hash_tree'
+
+class MyNode < HashTree::Set
+  attr_reader :name
+end
+
+# Create a root node
+root = MyNode.new(nil, "ROOT")
+
+# Build hierarchy through constructor
+child1 = MyNode.new(root, "CHILD1")
+child11 = MyNode.new(child1, "CHILD11")
+
+# Build hierarchy using #attach
+child2 = MyNode.new(root, "CHILD2")
+child1.attach(child12)
+
+# Parent object
+root.parent   # -> nil
+child1.parent # -> root
+
+# Lookup value
+puts child1["CHILD1"] # -> "CHILD1"
+
+# Check if key exists
+child1.key?("CHILD11") # -> true
+child1.key?("no key")  # -> false
+
+# Get the root object
+child11.root # -> root
+
+# List of parents up to the root element
+child11.parents # -> [child1, root]
+
+# List of ancestors from the root down to parent
+child11.ancestors # -> [root, child1]
+
+# String of dot-separated keys leading from the root down to self
+child11.path # -> "CHILD1.CHILD11"
+
+# Recursively lookup element by string dot-separated keys
+root.dot("CHILD1.CHILD11") -> child11
+```
+
+## Implementation
+
+`HashTree` caches properties to avoid repetitive recursive lookups in `#parents`, `#ancestors` etc. The cache is reset every time a node is attached to or detached from a parent
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_tree
+
+## 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/clrgit/hash_tree.

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hash_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/hash_tree.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hash_tree/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_tree"
+  spec.version       = HashTree::VERSION
+  spec.authors       = ["Claus Rasmussen"]
+  spec.email         = ["claus.l.rasmussen@gmail.com"]
+
+  spec.summary       = %q{A tree implemented as nested hashes}
+  spec.description   = %q{HashTree::Set and HashTree::Map provides simple tree
+                          operations. It is still very much work-in-progress }
+  spec.homepage      = "https://github.com/clrgit/hash_tree"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+# if spec.respond_to?(:metadata)
+#   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+#
+#   spec.metadata["homepage_uri"] = spec.homepage
+#   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+#   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+# else
+#   raise "RubyGems 2.0 or newer is required to protect against " \
+#     "public gem pushes."
+# end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "indented_io"
+end

data/lib/hash_tree.rb

@@ -0,0 +1,141 @@
+
+require "indented_io"
+
+# Simple tree of hashes
+#
+# TODO
+#   o each
+#   o traverse
+#   o #ancestors and #parents as enumerators
+#   o HashTree::Set, HashTree::Map, HashTree::Array
+#   o Semantics of <=>: strictly partial so it returns nil on no common path?
+#   o Drop <=> ?
+#   o Implement #common to return common path of two elements
+#   o modularize?
+#
+module HashTree
+  class Error < StandardError; end
+
+  # The base Node type for HashTree implementations. It is not supposed to be called
+  # from user-code
+  class Node
+    # Parent node. nil for the root node
+    attr_reader :parent
+
+    # Hash from key to child node
+    attr_reader :children
+
+    def initialize(parent, key)
+      @children = {}
+      parent&.do_attach(key, self)
+    end
+    
+    # Attach a child to self
+    #
+    # Implementation is in #do_attach to share code with HashTree::Set#attach
+    # that only takes one parameters
+    def attach(key, child) do_attach(key, child) end
+
+    # Detach a child from self
+    def detach(key, ignore_not_attached: false)
+      @children.key?(key) or raise Error, "Non-existing child key: #{key.inspect}"
+      child = children[key]
+      ignore_not_attached || child.parent or raise Error, "Child is not attached"
+      child.instance_variable_set(:@parent, nil)
+      @children.delete(key)
+      child.send(:clear_cached_properties)
+    end
+
+    # Lookup node by key
+    def [](key) @children[key] end
+
+    # Returns true iff key is included in children
+    def key?(key) @children.key?(key) end
+
+    # The root object or self if parent is nil
+    def root() @root ||= parents.last || self end
+
+    # List of parents up to the root element. If include_self is true, also
+    # include self as the first element
+    def parents(include_self = false)
+      (include_self ? [self] : []) + (@parents ||= (parent&.parents(true) || []))
+    end
+
+    # List of parents from the root element down to parent. If include_self is
+    # true, also include self as the last element
+    def ancestors(include_self = false)
+      (@ancestors ||= parents(false).reverse) + (include_self ? [self] : [])
+    end
+
+    # Recursively lookup object by dot-separated list of keys
+    #
+    # Note that for this to work, keys may not contain a dots ('.')
+    def dot(path)
+      path.split(".").inject(self) { |a,e| 
+        a[e] or raise Error, "Can't lookup '#{e}' in #{a.path.inspect}" 
+      }
+    end
+
+  protected
+    # Attach a child node to self
+    def do_attach(key, child)
+      !@children.key?(key) or raise Error, "Duplicate child key: #{key.inspect}"
+      !child.parent or raise Error, "Child is already attached"
+      child.instance_variable_set(:@parent, self)
+      @children[key] = child
+      child.send(:clear_cached_properties)
+    end
+
+  private
+    # Recursively clear cached properties like @parents in each node in the
+    # tree. Should be called whenever the node is attached or detached from a
+    # tree
+    #
+    # Note that to speed up the process, it stops recursing when a node has no
+    # cached properties. This is using the fact that the cached properties are
+    # themselves constructed recursively so that iff a node has a cached
+    # property, then all its parents will also cache it
+    def clear_cached_properties()
+      if@root || @parents || @ancestors || @path
+        @root = nil
+        @parents = nil
+        @ancestors = nil
+        @path = nil
+        children.values.each { |c| c.clear_cached_properties }
+      end
+    end
+  end
+
+  class Set < Node
+    alias node_attach attach
+
+    # Key of this node
+    attr_reader :key
+
+    def initialize(parent, key)
+      super(parent, @key = key)
+    end
+
+    def attach(child) do_attach(child.key, child) end
+
+    # Unique dot-separated list of keys leading from the root object to 
+    # self. Note that the root object is not included in the path so that
+    #
+    #   obj.parent.nil? || obj.root.dot(obj.path) == obj
+    #
+    # is always true
+    #
+    # Note that for this to work, keys may not contain a dots ('.')
+    def path() @path ||= ancestors(true)[1..-1].join(".") end
+
+    # A set node is rendered as its key
+    def to_s() key.to_s end
+  end
+
+  class Map < Node
+    # A map node is rendered as its object_id
+    def to_s() object_id.to_s end
+  end
+end
+
+

data/lib/hash_tree/version.rb

@@ -0,0 +1,3 @@
+module HashTree
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: hash_tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Claus Rasmussen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: indented_io
+  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'
+description: "HashTree::Set and HashTree::Map provides simple tree\n                          operations.
+  It is still very much work-in-progress "
+email:
+- claus.l.rasmussen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hash_tree.gemspec
+- lib/hash_tree.rb
+- lib/hash_tree/version.rb
+homepage: https://github.com/clrgit/hash_tree
+licenses: []
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A tree implemented as nested hashes
+test_files: []