property_hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a962a8ddb439844dcd8888cc1d6d197529768cc6212e996bdf66e50a2da84668
+  data.tar.gz: 6ae8c2e6d9cff7b2d37eaff146ceef0f2764dde54e4fda0dfbdc1184151431cd
+SHA512:
+  metadata.gz: 47256ffb191c3ea8e8cd6fc9fe7176606e790019c8480c1eb3a904b14af4d83e5872ae72055cedc72d4d272bb2aef82ec4cb70270e2fd014c9aafa58c94daaaa
+  data.tar.gz: 3bcb799e0cef185fefdb01e0f89ca0f0a50f6c9ec948ce1644b7bbc0bf7007ce70a64ac89dd69c5fe521769244dbb8fcdd9849c97e3c49e43134e2e032cc3b40

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.2', '3.1', '3.0', '2.7', '2.6', '2.5', '2.4' ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.gitignore

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

data/.rspec

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

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 sshaw
+
+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,62 @@
+# PropertyHash
+
+![PropertyHash CI Status](https://github.com/sshaw/property_hash/workflows/CI/badge.svg "PropertyHash CI Status")
+
+Access a nested Ruby Hash using Java-style properties as keys.
+
+## Usage
+
+```rb
+require "property_hash"
+require "pp"
+
+h = {
+  :a => {
+    :b => 1,
+    :c => { :d => "DEEEE" },
+    :x => 888,
+    :y => [9999]
+  },
+  :b => {
+    :zeee => 888
+  }
+}
+
+ph = PropertyHash.new(h)
+
+p ph["a.c.d"]  # DEEEE
+p ph["b.zeee"] # 888
+
+ph["a.c.x"] = "X"
+
+pp ph.keys    # ["a.b", "a.c.d", "a.x", "a.y", "b.zeee", "a.c.x"]
+pp ph.values  # [1, "DEEEE", 888, [9999], 888, "X"]
+
+ph.each { |k, v| p k }
+pp ph.to_h  # h but with :a => { :c => { :x => "X" } }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "property_hash"
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install property_hash
+
+## See Also
+
+- [JavaProperties](https://github.com/jnbt/java-properties)
+- [Localio](https://github.com/mrmans0n/localio)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "property_hash"
+
+# 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/lib/property_hash.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class PropertyHash
+  include Enumerable
+
+  KEY_DELIMITER = "."
+  VERSION = "0.0.1"
+
+  def initialize(hash, use_symbols = true)
+    @hash = hash.dup
+    @keys = keys_as_properties(@hash)
+    @use_symbols = use_symbols || false
+  end
+
+  def each
+    return to_enum(:each) unless block_given?
+    @keys.each { |key| yield([key, self[key]]) }
+  end
+
+  def keys
+    @keys.dup
+  end
+
+  def values
+    map(&:last)
+  end
+
+  def to_h
+    @hash.dup
+  end
+
+  alias to_hash to_h
+
+  def []=(key, value)
+    keys = property_key(key)
+    hash_to_set = @hash
+
+    keys[0..-2].each do |key|
+      if hash_to_set.include?(key)
+        hash_to_set = hash_to_set[key]
+      else
+        hash_to_set = hash_to_set[key] = {}
+      end
+    end
+
+    @keys << key
+
+    hash_to_set[keys[-1]] = value
+  end
+
+  def [](key)
+    keys = property_key(key)
+
+    begin
+      # FIXME: Does not support mixed keys
+      v = @hash.dig(*keys)
+      return v unless v.nil? && @use_symbols
+
+      keys.map!(&:to_sym)
+      @hash.dig(*keys)
+    rescue TypeError
+      # From dig. Ignore, value does not exist
+    end
+  end
+
+  private
+
+  def keys_as_properties(hash)
+    props = []
+
+    hash.each do |k, v|
+      if v.is_a?(Hash)
+        props.concat(property_flatten(k.to_s, v))
+      else
+        props << k.to_s
+      end
+    end
+
+    props
+  end
+
+  def property_key(value)
+    keys = value.to_s.split(KEY_DELIMITER)
+    keys.map!(&:to_sym) if @use_symbols
+    keys
+  end
+
+  def property_flatten(root, h)
+    h.map do |k, v|
+      prop = [root, k]
+      prop = property_flatten(prop.join(KEY_DELIMITER), v) if v.is_a?(Hash)
+      prop.join(KEY_DELIMITER)
+    end
+  end
+end

data/property_hash.gemspec

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), "lib/property_hash")
+
+Gem::Specification.new do |spec|
+  spec.name          = "property_hash"
+  spec.version       = PropertyHash::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Access a nested Ruby Hash using Java-style properties as keys.}
+  spec.description =<<-DESC
+    Access a nested Ruby Hash using Java-style properties as keys.
+
+    For example: {:a => {:b => 123}} can be accessed as "a.b" and setting "a.b.c" => 456
+    will create {:a => {:b => { :c => 456 }}}.
+  DESC
+  spec.homepage      = "https://github.com/sshaw/property_hash"
+  spec.license       = "MIT"
+
+  # 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["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/sshaw/property_hash"
+    # spec.metadata["changelog_uri"] = ""
+  end
+
+  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.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0", "<5.16"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: property_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+description: |2
+      Access a nested Ruby Hash using Java-style properties as keys.
+
+      For example: {:a => {:b => 123}} can be accessed as "a.b" and setting "a.b.c" => 456
+      will create {:a => {:b => { :c => 456 }}}.
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/property_hash.rb
+- property_hash.gemspec
+homepage: https://github.com/sshaw/property_hash
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/property_hash
+  source_code_uri: https://github.com/sshaw/property_hash
+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.3
+signing_key: 
+specification_version: 4
+summary: Access a nested Ruby Hash using Java-style properties as keys.
+test_files: []