handy_hash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a1d894869671094bd915172b9938eadb13ef9db
+  data.tar.gz: 8579d3708287239cee019e5920b4b19242a47153
+SHA512:
+  metadata.gz: 26c57a7b27463c18c15c94e919be0a4e7108f2f98ef7a939194b684090ab785996764d492c27141d69797e7a7ae7cd39facf7c78ea4c92136979091408dfbbd2
+  data.tar.gz: 355f5a1cf674d69089ce9ac64b8a1e7304ce596b213aa22d9f624d02bbe1df8ae8879296ee06f1e9b9d231b9f84700283def68ecfe9af20ff015c77e7171f7b2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in handy_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 schebannyj
+
+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,150 @@
+# HandyHash
+
+`HandyHash` - это небольшая обертка для `Hash`, которая может быть весьма удобна в некоторых случаях.
+
+Возможности:
+
+- доступ к данным через методы-геттеры (см. Использование)
+- рекурсивный `freeze`
+- рекурсивное слияние + специальный DSL для описания слияния (см. Использование)
+
+## Установка
+
+Добавить в Gemfile слудющую строку:
+
+```ruby
+gem 'handy_hash'
+```
+
+Запустить:
+
+    $ bundle
+
+Или установить гем вручную:
+
+    $ gem install handy_hash
+
+## Использование
+
+Инициализация:
+
+```ruby
+  data = HandyHash.new(
+    host_name: 'www.myapp.com',
+    some_lib: {
+      path: '/lib/some_lib',
+      init_opts: {
+        flags: 3465873,
+        secret: "78396nxry837d"
+      },
+      methods: %w(one two)
+    }
+  )
+```
+
+Получать значения можно разными способами.
+
+Как из обычного хэша (работает как `HashWithIndifferentAccess`):
+
+```ruby
+  data[:host_name]                      # => "www.myapp.com"
+  data["some_lib"][:init_opts]          # => {"flags" => 3465873, "secret" => "78396nxry837d"}
+  data["some_lib"]["init_opts"][:flags] # => 3465873
+```
+
+В этом случае никакой проверки на присутствие элемента не производится:
+
+```ruby
+  data[:foo]        # => nil
+  data[:foo][:bar]  # => NoMethodError: undefined method `[]' for nil:NilClass
+```
+
+Можно получать значения, используя геттеры:
+
+```ruby
+  data.host_name                  # => "www.myapp.com"
+  data.some_lib.init_opts         # => {"flags" => 3465873, "secret" => "78396nxry837d"}
+  data.some_lib.init_opts[:flags] # => 3465873
+  data.some_lib.init_opts.secret  # => "78396nxry837d"
+```
+
+В этом случае можно "безопасно" спускаться на любую глубину, не опасаясь возникновения исключения:
+
+```ruby
+  data.foo.present?         # => false
+  data.foo.bar.baz.present? # => false
+  data.foo.bar[:baz]        # => nil
+```
+
+Есть возможность принудительно вызвать исключение приотсутствии определенного элемента:
+
+```ruby
+  data.some_lib.path! # => "/lib/some_lib"
+  data.foo!.bar       # => HandyHash::ValueMissingError: value missing: "foo"
+```
+
+В качестве аргумента можно передать значение по умолчанию:
+
+```ruby
+  data.some_lib.init_opts.flags(0) # => 3465873
+  data.foo.bar.baz(666)            # => 666
+```
+
+Если ключ хэша соответствует названию какого-то существующего метода объекта `HandyHash` (например, `methods`, `hash`, `patch` и т.д.), то необходимо оборачивать метод знаком `_`:
+
+```ruby
+  data.some_lib._methods_ # => ["one", "two"]
+```
+
+### Слияние (переопределение значений)
+
+Слияние производится с помощью метода `#patch`, который возвращает новый объект `HandyHash` с новыми значениями. Значения в исходном объекте не меняются.
+
+Слияние производится рекурсивно во всех нижележащих `Hash`-объектах.
+
+Выполнить слияние можно, передав методу `#patch` объект `Hash`:
+
+```ruby
+  new_data = data.patch(
+    some_lib: {
+      path: '/lib/other_path'
+    },
+    foo: :bar
+  )
+  new_data.some_lib.path # => '/lib/other_path'
+  new_data.foo           # => :bar
+```
+
+Можно с помощью DSL:
+
+```ruby
+  new_data = data.patch{
+    some_lib {
+      path '/lib/other_path'
+    }
+    foo :bar
+  }
+  new_data.some_lib.path # => '/lib/other_path'
+  new_data.foo           # => :bar
+```
+
+Для экономии строк при изменениях значений на глубоких уровнях иерархии можно использовать цепочки методов:
+
+```ruby
+  new_data = data.patch{
+    some_lib.init_opts.secret 'abc'
+    foo.bar.baz 123
+  }
+  new_data.some_lib.init_opts.secret # => "abc"
+  new_data.foo.bar.baz               # => 123
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stp-che/handy_hash.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/handy_hash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'handy_hash'
+
+Gem::Specification.new do |spec|
+  spec.name          = "handy_hash"
+  spec.version       = HandyHash::VERSION
+  spec.authors       = ["schebannyj"]
+  spec.email         = ["stp.eternal@gmail.com"]
+
+  spec.summary       = %q{HandyHash is a Hash that supply handy ways for accessing data and merging.}
+  spec.description   = %q{HandyHash is a Hash object that supply handy ways for accessing data and merging.}
+  spec.homepage      = "https://github.com/stp-che/handy_hash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 5.0"  
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/handy_hash.rb

@@ -0,0 +1,128 @@
+require 'active_support/all'
+
+class HandyHash < HashWithIndifferentAccess
+  VERSION = '0.1.0'
+
+  class ValueMissingError < StandardError; end
+
+  def initialize(value=nil)
+    if value
+      value.each do |k, v|
+        self[k] = __wrap v
+      end
+    end
+  end
+
+  def freeze
+    super
+    each{|_, v| v.freeze unless v.frozen?}
+  end
+
+  def []=(k,v)
+    super k, __wrap(v)
+  end
+
+  def patch(hash=nil, &block)
+    change_set = [].tap do |ch|
+      ch << __wrap(hash) if hash
+      ch << Builder.new(&block).data if block_given?
+    end
+    Patch.(self, *change_set)
+  end
+
+  def method_missing(m, *args, &block)
+    if m =~ /\Ato_ary\Z/ || m =~ /\=$/ || args.size > 1 || block_given?
+      super
+    else
+      m = m.to_s
+      if m[-1] == '!'
+        m = m.to_s.sub!(/!$/, '')
+        required = true
+      end
+      if m =~ /\A_(.+)_\Z/
+        m = $1 
+      end
+      __fetch_value m, required: required, default: args.first
+    end
+  end
+
+  private
+
+  def __fetch_value(key, required: false, default: nil)
+    self[key] || default || (required ? raise(ValueMissingError, "value missing: \"#{key}\"") : HandyHash.Nil)
+  end
+
+  def __wrap(v)
+    v.kind_of?(Hash) && !v.kind_of?(HandyHash) ? HandyHash.new(v) : v
+  end
+
+  class << self
+    def Nil
+      @Nil ||= new.tap(&:freeze)
+    end
+  end
+
+  # @api private
+  class Patch
+    class << self
+      def call(orig_data, *change_set)
+        change_set.inject(orig_data){|data, changes| deep_merge(data, changes) }
+      end
+
+      private
+
+      def deep_merge(h1, h2)
+        HandyHash.new({}).tap do |d|
+          h1.each{|k,v|
+            unless h2.key?(k)
+              d[k] = v
+            else
+              if v.kind_of?(Hash) && h2[k].kind_of?(Hash)
+                d[k] = call(v, h2[k])
+              else
+                d[k] = h2[k]
+              end
+            end
+          }
+          h2.each{|k,v|
+            next if h1.key?(k)
+            d[k] = v
+          }
+        end
+      end
+    end
+  end
+
+  # @api private
+  class Builder
+    def initialize(&block)
+      @content = {}
+      instance_eval &block if block_given?
+    end
+
+    def method_missing(m, *args, &block)
+      if m =~ /\Ato_ary\Z/ || m =~ /\=$/ || args.size > 1
+        super
+      else
+        m = m.to_s
+        if m =~ /\A_(.+)_\Z/
+          m = $1 
+        end
+        if args.empty?
+          @content[m] = Builder.new(&block)
+        else
+          @content[m] = args.first
+        end
+      end
+    end
+
+    def data
+      HandyHash.new.tap do |d|
+        @content.each do |k, v|
+          d[k] = v.kind_of?(Builder) ? v.data : v
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: handy_hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- schebannyj
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: HandyHash is a Hash object that supply handy ways for accessing data
+  and merging.
+email:
+- stp.eternal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- handy_hash.gemspec
+- lib/handy_hash.rb
+homepage: https://github.com/stp-che/handy_hash
+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.4.8
+signing_key: 
+specification_version: 4
+summary: HandyHash is a Hash that supply handy ways for accessing data and merging.
+test_files: []