key_tree 0.5.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee519ff161881da7c9d53d57fe1e762a9e89df557e5f5bb4d3df58e5de1731dd
-  data.tar.gz: 84b2e06bf6c70acfed4f466a72da5222b9fba028cf551fa7d82a3bbce90351a0
+  metadata.gz: efcddf672d03cea0d0be86a2bf3dd9fdd64b072410a941622172dda485e41455
+  data.tar.gz: 361648de4ff9c43340b149716bc8beb1ff46960ee48e5dc0b00717c60b017c53
 SHA512:
-  metadata.gz: 4d644e3a3d63f34f6edbc0fbc17a2c8f26499d2fe508e186274698b2ff733100f97e5efe62ce2bb4e7c1b35f07282fe5994447e1f7171c57f0cd8408798bbbf8
-  data.tar.gz: 6dd6f1e13e04bd7a8cbe8cce7d9b36a9ff76ac05c3ffc3fffa5bd12a38fc620f115ff94c37e913b6683aa2980d3c4ddd871b16cebfa622d71a3413fa6a2adf1d
+  metadata.gz: 28cda54bf66db156d0c723613f94b94a6535947821dbfc896f00a5f2c8861f8680bc5a23fb6198b97c804ddf8ee0d25654b73e45b174c7319059187fc1394b0e
+  data.tar.gz: d0cb7b5c81e267909a7d861d8f1961e0e94e13a839e16aad13f736626d8be6953db87804d2d99ca7af5395a048d164ef0fd8e981cbf891d05af2c2b964186acb

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+%YAML 1.1
+---
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+...

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 /vendor
 Gemfile.lock
+coverage

data/.rubocop.yml

@@ -1,3 +1,9 @@
+%YAML 1.1
+---
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/*_spec.rb'
@@ -6,7 +12,12 @@ Style/BlockDelimiters:
   Exclude:
     - 'spec/*_spec.rb'
 
-# Rubocop 0.56 causes false positives
-# https://github.com/bbatsov/rubocop/issues/5887
-Lint/SplatKeywordArguments:
-  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+...

data/CHANGELOG.md

@@ -0,0 +1,222 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Older releases uses an ad-hoc release notes format, and follow at the end.
+
+
+## [Unreleased]
+
+
+## [0.8.0]
+
+This release bumps minimum Ruby version to 2.6, and adds support for Ruby version 3.
+
+### Added
+
+- Supports Ruby version 3.
+
+### Changed
+
+- Updated dependencies.
+
+
+## [0.7.0] - 2019-07-16
+
+### Changed
+
+- Removed leftover private methods from `KeyTree::Forest`, `#tree_with_key`
+  and `#trees_with_key`
+- Removed `KeyTree::Tree#fetch_default` method and simplified `#[]`
+
+
+[Unreleased]: https://github.com/notCalle/PROJECT/compare/v0.8.0..HEAD
+[0.8.0]: https://github.com/notCalle/PROJECT/compare/v0.7.0..v0.8.0
+[0.7.0]: https://github.com/notCalle/PROJECT/compare/v0.6.1..v0.7.0
+[0.6.1]: https://github.com/notCalle/PROJECT/releases/tag/v0.6.1
+
+
+# Release Notes
+
+## v0.6.1 – 2018-05-31
+
+### New methods
+
+  * `KeyTree::Tree#fetch_default(key, default) { block }`
+
+  * Using `KeyTree::Refine::DeepHash`
+    * `Hash#deep_key_pathify`
+
+### Bug fixes
+
+Default processing for forests was broken.
+
+  * 7ff646ff Fix Forest#fetch default vs KeyError processing
+  * 62f6fd73 Add default aware fetch method
+  * 00f0b163 Manage deep_fetch KeyError generation on our own
+
+#### Handle incoming key pathish keys
+
+When a `Hash` had keys that looked like key paths, they were not correctly
+converted to nested hashes with symbol keys.
+
+  * c23df1dd Change key transform for incoming hashes
+  * 09b526c8 Add new hash refinement for key_path-ification
+
+## v0.6.0 – 2018-05-30
+
+### Major changes
+
+  * Updated to Ruby ~> 2.3
+  * Added refinements module for `to_key_*` conversions in core classes
+  * `KeyTree::Tree` rewritten from scratch, to use a refinements
+    to an internal `Hash` structure instead of subclassing `Hash`
+
+### New methods
+
+  * `KeyTree::Forest#key_paths`
+  * `KeyTree::Forest#to_key_forest`
+  * `KeyTree::Forest#to_key_wood`
+  * `KeyTree::Path#===`
+  * `KeyTree::Path#to_key_path`
+  * `KeyTree::Tree#delete(key_path)`
+  * `KeyTree::Tree#delete!(key_path)`
+  * `KeyTree::Tree#store(key_path, new_value)`
+  * `KeyTree::Tree#store!(key_path, new_value)`
+  * `KeyTree::Tree#to_key_tree`
+  * `KeyTree::Tree#to_key_wood`
+
+  * Using `KeyTree::Refinements`
+    * `Array#to_key_forest`
+    * `Array#to_key_path`
+    * `Array#to_key_wood`
+    * `Hash#to_key_tree`
+    * `Hash#to_key_wood`
+    * `String#to_key_path`
+    * `Symbol#to_key_path`
+
+  * Using `KeyTree::Refine::DeepHash`
+    * `Hash#deep`
+    * `Hash#deep_delete(key_path)`
+    * `Hash#deep_fetch(key_path, default, &default_proc)`
+    * `Hash#deep_merge(other)`
+    * `Hash#deep_merge!(other)`
+    * `Hash#deep_store(key_path, new_value)`
+    * `Hash#deep_transform_keys(&block)`
+    * `Hash#deep_transform_keys!(&block)`
+
+### Removed methods
+
+  * `KeyTree::Tree` no longer inherits `Hash`, but most of the
+    inherited methods didn't work properly anyway
+
+## v0.5.3 – 2018-05-25
+
+### Bug fixes
+
+#### Fix forest default values
+Previous release broke default value propagation for forests.
+
+  * c0eccde4 Update forest specs vs default values
+  * 35367fd1 Consider Tree default values for Forest#[]
+  * 7e10dda5 Add method to find trees with default values
+  * 57a320ac Revert "Use proper method to retreive values from trees"
+  * 8173775d Make tree_with_key methods private
+
+## v0.5.2 – 2018-05-19
+
+### Bug fixes
+
+#### Conform to Hash#fetch API
+`Tree#fetch` confused its block argument with `#default_proc`, but they
+have different arguments, so that didn't work out well.
+
+  * 0bd0a6e8 Use proper method to retreive values from trees
+  * 14128a6a Conform to Hash#fetch API
+
+## v0.5.1 – 2018-05-19
+
+### New methods
+
+  * `KeyTree::Tree#default_key?(key)`
+  * `KeyTree::Tree#format(fmtstr)`
+  * `KeyTree::Tree#to_h(string_keys: false)`
+  * `KeyTree::Tree#to_json`
+  * `KeyTree::Tree#to_yaml`
+
+### Bug fixes
+
+#### Make forests aware of default values in trees
+
+Ensure that forests pick up default values from a tree.
+
+  * ebd1cb06 Return trees and forests untouched
+  * 3451a430 Propagate default_proc in fetch
+  * e121a4c4 Consider trees to have a key if #default_key?
+  * 50bc56ec Detect if a default_proc yields a key value
+
+### New features
+
+#### Key tree content exporters
+
+Support for exporting the contents of a key tree to Hash, JSON, and YAML.
+Also includes a convenience string formatter, that fills format strings
+with values from a `Tree`.
+
+  * 9b5f05f0 Make exported hash key format selectable
+  * e3434d7e Add custom format method
+  * fa6a9b16 Serialize the contents of a tree to json or yaml
+  * 3fc6466b Convert a tree back into nested hashes
+  * e5aecd8b Split symbols into key paths
+
+## v0.5.0 – 2018-04-17
+
+### Changed methods
+
+  * `KeyTree.load(type, serialization, prefix: nil)`
+  * `KeyTree::Forest#[key] { |key, original, incoming| }`
+  * `KeyTree::Forest#fetch(key) { |key, original, incoming| }`
+  * `KeyTree::Forest#flatten { |key, original, incoming| }`
+  * `KeyTree::Tree#merge { |key, original, incoming| }`
+  * `KeyTree::Tree#merge! { |key, original, incoming| }`
+
+### New methods
+
+  * `KeyTree::Loader.fallback(loader)`
+
+### New features
+
+#### Merge value selection
+Improve merge related methods in `KeyTree::Tree`, and `KeyTree::Forest`
+to take a `Hash#merge` style block argument, to allow control of the result when a key i present on both sides of a merge operation.
+
+  * 083b25c Add merge value selector to Forest#[]
+  * e813e55 Add merge value selection to Forest#fetch
+  * 581bc82 Add method to get list of trees with key
+  * 0f66f03 Pass merge value selector via Forest#flatten
+  * df9b80e Pass any merge selection block to super
+
+#### Key prefix for file loading
+When a key file has a name like `prefix@name.ext`, the `prefix` part will be prepended to all keys loaded from the file.
+
+  * fbe333a Changed call syntax for KeyTree.load
+  * 595902c Load keytree with prefix from files with @ in name
+  * d23a7e1 Allow prepending a prefix when loading keys
+
+#### Fallback for KeyTree loaders
+Allow a fallback class for handling loading of file types where no loader is specified, e.g. to ignore all files with unrecognized extension for `KeyTree.load_all`.
+
+  * a9d096c Add tree loader fallback
+
+### Bug fixes
+
+#### Proper breadth first flattening
+
+  * ff327f2 Use tree enumarator for Forest#key? and #prefix?
+  * 74fa15d Rewrite Forest#[]
+  * 177de08 Use tree enumerator in Forest#[]
+  * d161fe1 Use tree enumerator in Forest#flatten
+  * b0c94df Add breadth-first enumerator for trees
+  * 3468f28 Remove forest vs tree sorting nonsense

data/Gemfile

@@ -1,12 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-begin
-  require 'git-version-bump'
-rescue LoadError
-  gem 'git-version-bump', '~> 0.15'
-else
-  # Specify your gem's dependencies in key_tree.gemspec
-  gemspec
-end
+# Specify your gem's dependencies in key_tree.gemspec
+gemspec

data/README.md

@@ -1,10 +1,15 @@
-[![Gem Version](https://badge.fury.io/rb/key_tree.svg)](https://badge.fury.io/rb/key_tree) [![Maintainability](https://api.codeclimate.com/v1/badges/ac48756e80007e0cd6f9/maintainability)](https://codeclimate.com/github/notCalle/ruby-keytree/maintainability)
+[![Gem Version](https://badge.fury.io/rb/key_tree.svg)](https://badge.fury.io/rb/key_tree)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ac48756e80007e0cd6f9/maintainability)](https://codeclimate.com/github/notCalle/ruby-keytree/maintainability)
+[![codecov](https://codecov.io/gh/notCalle/ruby-keytree/branch/master/graph/badge.svg)](https://codecov.io/gh/notCalle/ruby-keytree)
+[![Ruby](https://github.com/notCalle/ruby-keytree/actions/workflows/ruby.yml/badge.svg)](https://github.com/notCalle/ruby-keytree/actions/workflows/ruby.yml)
 
 # KeyTree
 
 KeyTree manages trees of hashes, and (possibly nested) forests of such trees,
 allowing access to values by key path.
 
+See the [changelog](CHANGELOG.md) for recent changes.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'key_tree'
@@ -7,8 +8,8 @@ require 'key_tree'
 # 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 'pry'
+Pry.start
 
-require 'irb'
-IRB.start(__FILE__)
+# require 'irb'
+# IRB.start(__FILE__)

data/bin/setup

@@ -4,6 +4,5 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-bundle update
 
 # Do any other automated setup that you need to do here

data/key_tree.gemspec

@@ -1,17 +1,30 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'key_tree/version'
 
+dev_deps = {
+  'bundler' => '~> 2.2',
+  'codecov' => '~> 0.5.0',
+  'pry' => '~> 0.14.0',
+  'rake' => '~> 13.0',
+  'rspec' => '~> 3.10',
+  'rubocop' => '~> 1.15',
+  'rubocop-rake' => '~> 0.5.1',
+  'rubocop-rspec' => '~> 2.3',
+  'ruby-prof' => '>= 1.4',
+  'simplecov' => '~> 0.21.0'
+}
+
 Gem::Specification.new do |spec|
   spec.name          = 'key_tree'
   spec.version       = KeyTree::VERSION
-  spec.date          = KeyTree::DATE
   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'
 
@@ -22,10 +35,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'git-version-bump', '~> 0.15'
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.6', '< 4.0'
+
+  spec.add_dependency 'git-version-bump', '~> 0.17.0'
 
-  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'
+  dev_deps.each { |d| spec.add_development_dependency(*d) }
 end

data/lib/key_tree.rb

@@ -1,7 +1,9 @@
-require 'key_tree/version'
-require 'key_tree/tree'
+# frozen_string_literal: true
+
 require 'key_tree/forest'
 require 'key_tree/loader'
+require 'key_tree/refinements'
+require 'key_tree/tree'
 
 # Manage a tree of keys
 #
@@ -13,86 +15,84 @@ require 'key_tree/loader'
 #   -> 2
 #
 module KeyTree
-  def self.[](contents = {})
-    case contents
-    when Tree, Forest
-      contents
-    when Hash
-      Tree[contents]
-    when Array
-      Forest[*contents]
-    else
-      raise ArgumentError, "can't load #{contents.class} into a KeyTree"
+  using Refinements
+
+  class << self
+    def [](contents = {})
+      contents.to_key_wood
     end
-  end
 
-  # Load a KeyTree from some external serialization
-  #
-  # load +type+: +serialization+
-  # load +key_prefix+, +type+: +serialization+
-  #
-  # +type+ is upcased to form a class name that should provide a
-  # +.load+ class method (like YAML or JSON does).
-  #
-  # If a +key_prefix+ is given, it will be prepended to the loaded data.
-  #
-  # Examples:
-  #   load(:yaml, "---\na: 1\n")
-  # => {"a" => 1}
-  #
-  #   load(:yaml, "---\nb: 2\n", prefix: 'a')
-  # => {"a.b" => 2}
-  #
-  def self.load(type, serialization, prefix: nil)
-    type = type.to_sym unless type.nil?
-    loader = Loader[type]
-    contents = loader.load(serialization)
-    contents = { prefix => contents } unless prefix.nil?
+    # Load a KeyTree from some external serialization
+    #
+    # load +type+: +serialization+
+    # load +key_prefix+, +type+: +serialization+
+    #
+    # +type+ is upcased to form a class name that should provide a
+    # +.load+ class method (like YAML or JSON does).
+    #
+    # If a +key_prefix+ is given, it will be prepended to the loaded data.
+    #
+    # Examples:
+    #   load(:yaml, "---\na: 1\n")
+    # => {"a" => 1}
+    #
+    #   load(:yaml, "---\nb: 2\n", prefix: 'a')
+    # => {"a.b" => 2}
+    #
+    def load(type, serialization, prefix: nil)
+      type = type.to_sym unless type.nil?
+      loader = Loader[type]
+      contents = loader.load(serialization)
+      contents = { prefix => contents } unless prefix.nil?
 
-    self[contents].with_meta_data do |meta_data|
-      meta_data << { load: { type: type, loader: loader } }
-      meta_data << { load: { prefix: prefix } } unless prefix.nil?
+      contents.to_key_wood.with_meta_data do |meta_data|
+        meta_data << { load: { type: type, loader: loader } }
+        meta_data << { load: { prefix: prefix } } unless prefix.nil?
+      end
     end
-  end
 
-  # Open an external file and load contents into a KeyTree
-  # When the file basename begins with 'prefix@', the prefix
-  # is prepended to all keys in the filee.
-  def self.open(file_name)
-    type = File.extname(file_name)[/[^.]+/]
-    prefix = File.basename(file_name)[/(.+)@/, 1]
+    # Open an external file and load contents into a KeyTree
+    # When the file basename begins with 'prefix@', the prefix
+    # is prepended to all keys in the filee.
+    def open(file_name)
+      type = File.extname(file_name)[/[^.]+/]
+      prefix = File.basename(file_name)[/(.+)@/, 1]
 
-    keytree = File.open(file_name, mode: 'rb:utf-8') do |file|
-      load_from_file(file, type, prefix)
+      keytree = File.open(file_name, mode: 'rb:utf-8') do |file|
+        load_from_file(file, type, prefix)
+      end
+
+      return keytree unless block_given?
+
+      yield keytree
     end
 
-    return keytree unless block_given?
-    yield(keytree)
-  end
+    # Open all files in a directory and load their contents into
+    # a Forest of Trees, optionally following symlinks, and recursing.
+    def open_all(dir_name, follow_links: false, recurse: false)
+      Dir.children(dir_name).reduce(KeyTree::Forest.new) do |result, file|
+        path = File.join(dir_name, file)
+        next result if File.symlink?(path) && !follow_links
 
-  # Open all files in a directory and load their contents into
-  # a Forest of Trees, optionally following symlinks, and recursing.
-  def self.open_all(dir_name, follow_links: false, recurse: false)
-    Dir.children(dir_name).reduce(KeyTree::Forest.new) do |result, file|
-      path = File.join(dir_name, file)
-      next result if File.symlink?(path) && !follow_links
-      stat = File.stat(path)
-      # rubocop:disable Security/Open
-      next result << open(path) if stat.file?
-      # rubocop:enable Security/Open
-      next result unless recurse && stat.directory?
-      result << open_all(path, follow_links: follow_links, recurse: true)
+        stat = File.stat(path)
+        # rubocop:disable Security/Open
+        next result << open(path) if stat.file?
+        # rubocop:enable Security/Open
+        next result unless recurse && stat.directory?
+
+        result << open_all(path, follow_links: follow_links, recurse: true)
+      end
     end
-  end
 
-  private_class_method
+    private
 
-  def self.load_from_file(file, type, prefix)
-    load(type, file.read, prefix: prefix).with_meta_data do |meta_data|
-      file_path = file.path
-      meta_data << { file: { path: file_path,
-                             name: File.basename(file_path),
-                             dir: File.dirname(file_path) } }
+    def load_from_file(file, type, prefix)
+      load(type, file.read, prefix: prefix).with_meta_data do |meta_data|
+        file_path = file.path
+        meta_data << { file: { path: file_path,
+                               name: File.basename(file_path),
+                               dir: File.dirname(file_path) } }
+      end
     end
   end
 end