tonsser_hash_utils 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21216e909e28b7232940d8f26b5cf3f6d446ad60
+  data.tar.gz: d1abc94b1c4648912a2cd6c7a454b7fbf121a8df
+SHA512:
+  metadata.gz: 755fe94450976b16c5d2dd99f3191e6929ef6d7f0b734132fa0876afcb78e5a5f8a6de5b94da3dafb9d0dd85fa4586bb44a9eeb66266932f1e543e32b7ba09b1
+  data.tar.gz: 68a2949f62b74399490ee90880c55212bd4c758116bc7c83b416d0dad52ed00c37d9dfc3b32b78e19fac007d6225457803e4d4e78356a08d2678fcbe7b6d449b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Pedersen
+
+MIT License
+
+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,31 @@
+# TonsserHashUtils
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tonsser_hash_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tonsser_hash_utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tonsser_hash_utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/deep_hash.rb

@@ -0,0 +1,24 @@
+# This class is useful for checking for keys within nested hashes
+#
+# Turns
+#
+#   params[:foo] && params[:foo][:bar] && params[:foo][:bar][:baz]
+#
+# into
+#
+#   DeepHash.new(params).dig(:foo, :bar, :baz)
+class DeepHash
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def dig(*keys)
+    keys.inject(@hash) do |location, key|
+      if location.nil?
+        nil
+      else
+        location[key]
+      end
+    end
+  end
+end

data/lib/hash_builder.rb

@@ -0,0 +1,40 @@
+# This class simplifies the creation of potentially deeply nested hashes
+# It turns code like this:
+#
+#   hash = {
+#     one: {
+#       two: {
+#         three: {
+#           four: :foo
+#         }
+#       }
+#     }
+#   }
+#
+# Into this:
+#
+#   hash = HashBuilder.new
+#   hash.one.two.three.four = :foo
+#
+# The underlaying hash can be retrieved with `#as_json`.
+#
+# NOTE: Its good practice to also implement respond_to_missing? when
+# overriding method_missing, but for some reason that makes the tests fail.
+class HashBuilder
+  def initialize
+    @hash = {}
+  end
+
+  def as_json
+    @hash.as_json
+  end
+
+  def method_missing(name, *args)
+    if match = name.to_s.match(/(?<key>.*?)=$/)
+      @hash[match[:key].to_sym] = args.first
+    else
+      @hash[name] = HashBuilder.new if @hash[name].blank?
+      @hash[name]
+    end
+  end
+end

data/lib/hash_merger.rb

@@ -0,0 +1,35 @@
+# This class will deep merge two hashes to create one new hash
+# with all keys and values from both. If there are duplicate keys
+# the latter one wins.
+# If some common keys point to arrays, those arrays will be merged
+# as well. This is different from Hash#deep_merge, and the reason for
+# having this class.
+#
+# Note that this class uses recursion, which might be dangerous
+# in Ruby due to lack of tail call elimination. Recursion is
+# however the easiest way to do stuff like this.
+class HashMerger
+  def initialize(start)
+    @start = start
+  end
+
+  def merge_with(new)
+    do_merge(new, @start.dup)
+  end
+
+  private
+
+  def do_merge(hash, acc)
+    hash.inject(acc) do |acc, (key, value)|
+      acc[key] = if value.is_a?(Hash)
+                   do_merge(value, acc[key].dup || {})
+                 elsif value.is_a?(Array)
+                   (acc[key] || []) + value
+                 else
+                   value
+                 end
+
+      acc
+    end
+  end
+end

data/lib/hash_with_quick_access.rb

@@ -0,0 +1,59 @@
+class HashWithQuickAccess
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def method_missing(key)
+    if has_key(key)
+      fetch_possibly_decorated_value(key)
+    else
+      raise KeyError.new("key :#{key} was not found")
+    end
+  end
+
+  def respond_to?(method_name, include_private = false)
+    has_key(method_name) || super
+  end
+
+  def keys
+    @hash.keys.map(&:to_sym)
+  end
+
+  def [](key)
+    send(key)
+  end
+
+  private
+
+  def fetch_possibly_decorated_value(key)
+    obj = @hash.fetch(key) { @hash.fetch(key.to_s) }
+
+    if should_be_decorated(obj)
+      decorate(obj)
+    else
+      obj
+    end
+  end
+
+  def should_be_decorated(obj)
+    (obj.is_a?(Array) && obj[0].is_a?(Hash)) || obj.is_a?(Hash)
+  end
+
+  def decorate(obj)
+    if obj.is_a?(Array)
+      obj.map { |o| HashWithQuickAccess.new(o) }
+    elsif obj.is_a?(Hash)
+      HashWithQuickAccess.new(obj)
+    end
+  end
+
+  def has_key(key)
+    all_keys.include?(key)
+  end
+
+  def all_keys
+    @hash.keys.flat_map do |key|
+      [key, key.to_sym]
+    end
+  end
+end

data/lib/tonsser_hash_utils/version.rb

@@ -0,0 +1,3 @@
+module TonsserHashUtils
+  VERSION = "1.0"
+end

data/lib/tonsser_hash_utils.rb

@@ -0,0 +1,9 @@
+require "tonsser_hash_utils/version"
+
+require File.dirname(__FILE__) + "/hash_with_quick_access"
+require File.dirname(__FILE__) + "/deep_hash"
+require File.dirname(__FILE__) + "/hash_builder"
+require File.dirname(__FILE__) + "/hash_merger"
+
+module TonsserHashUtils
+end

data/spec/lib/deep_hash_spec.rb

@@ -0,0 +1,24 @@
+require "deep_hash"
+
+describe DeepHash, "#dig" do
+  it "returns the value if its there" do
+    hash = DeepHash.new({
+      foo: {
+        bar: {
+          baz: {
+            qux: "value"
+          }
+        }
+      }
+    })
+
+    expect(hash.dig(:foo, :bar, :baz)).to eq({ qux: "value" })
+    expect(hash.dig(:foo, :bar, :baz, :qux)).to eq "value"
+  end
+
+  it "returns nil if the chain of keys fails along the way" do
+    hash = DeepHash.new({})
+
+    expect(hash.dig(:foo, :bar, :baz)).to be_nil
+  end
+end

data/spec/lib/hash_builder_spec.rb

@@ -0,0 +1,29 @@
+require "active_support/all"
+require "hash_builder"
+
+describe HashBuilder do
+  it "quickly assigns stuff to a hash" do
+    hash = HashBuilder.new
+    hash.foo = :foo
+    hash.bar = :bar
+
+    expect(hash.foo).to eq :foo
+    expect(hash.bar).to eq :bar
+  end
+
+  it "converts the hash to json" do
+    hash = HashBuilder.new
+    hash.foo = :foo
+    hash.bar = :bar
+
+    expect(hash.as_json).to eq({"foo"=>"foo", "bar"=>"bar"})
+  end
+
+  it "allows easy creation of nested hashes" do
+    hash = HashBuilder.new
+    hash.one.two.three.four = :foo
+
+    expect(hash.one.two.three.four).to eq :foo
+    expect(hash.as_json).to eq({"one"=>{"two"=>{"three"=>{"four"=>"foo"}}}})
+  end
+end

data/spec/lib/hash_merger_spec.rb

@@ -0,0 +1,146 @@
+require "hash_merger"
+
+describe HashMerger do
+  it "deep merges hashes" do
+    a = {
+      foo: {
+        bar: {
+          baz: "one"
+        },
+        yo: "yo"
+      },
+      yo: "yo"
+    }
+
+    b = {
+      foo: {
+        bar: {
+          qux: "two"
+        }
+      },
+      dog: "dog"
+    }
+
+    merged = HashMerger.new(a).merge_with(b)
+
+    expect(merged).to eq({
+      foo: {
+        bar: {
+          baz: "one",
+          qux: "two",
+        },
+        yo: "yo"
+      },
+      yo: "yo",
+      dog: "dog",
+    })
+
+    expect(a).to eq({
+      foo: {
+        bar: {
+          baz: "one"
+        },
+        yo: "yo"
+      },
+      yo: "yo"
+    })
+
+    expect(b).to eq({
+      foo: {
+        bar: {
+          qux: "two"
+        }
+      },
+      dog: "dog"
+    })
+  end
+
+  it "deep merges arrays" do
+    a = {
+      foo: {
+        bar: ["one"]
+      }
+    }
+
+    b = {
+      foo: {
+        bar: ["two"]
+      }
+    }
+
+    merged = HashMerger.new(a).merge_with(b)
+
+    expect(merged).to eq({
+      foo: {
+        bar: ["one", "two"]
+      }
+    })
+
+    expect(a).to eq({
+      foo: { bar: ["one"] }
+    })
+
+    expect(b).to eq({
+      foo: { bar: ["two"] }
+    })
+  end
+
+  it "merges hashes with mixed types" do
+    a = {
+      foo: {
+        bar: {
+          baz: "one"
+        },
+        array: [1,2],
+        yo: "yo"
+      },
+      yo: "yo"
+    }
+
+    b = {
+      foo: {
+        bar: {
+          qux: "two"
+        },
+        array: [3,4]
+      },
+      dog: "dog"
+    }
+
+    merged = HashMerger.new(a).merge_with(b)
+
+    expect(merged).to eq({
+      foo: {
+        bar: {
+          baz: "one",
+          qux: "two",
+        },
+        array: [1,2,3,4],
+        yo: "yo"
+      },
+      yo: "yo",
+      dog: "dog",
+    })
+
+    expect(a).to eq({
+      foo: {
+        bar: {
+          baz: "one"
+        },
+        array: [1,2],
+        yo: "yo"
+      },
+      yo: "yo"
+    })
+
+    expect(b).to eq({
+      foo: {
+        bar: {
+          qux: "two"
+        },
+        array: [3,4]
+      },
+      dog: "dog"
+    })
+  end
+end

data/spec/lib/hash_with_quick_access_spec.rb

@@ -0,0 +1,62 @@
+require "hash_with_quick_access"
+
+describe HashWithQuickAccess do
+  it "gives you quick access to hashes or arrays nested in other hashes" do
+    hash = HashWithQuickAccess.new({
+      name: "Mikkel Hansen",
+      books: [
+        { name: "Fight Club" },
+      ],
+      job: {
+        title: "Programmer",
+      },
+    })
+
+    expect(hash.name).to eq "Mikkel Hansen"
+    expect(hash.books.first.name).to eq "Fight Club"
+    expect(hash.job.title).to eq "Programmer"
+  end
+
+  it "only wraps values if they are hashes" do
+    hash = HashWithQuickAccess.new({
+      books: [
+        "Fight Club"
+      ],
+    })
+
+    expect(hash.books.first).to eq "Fight Club"
+  end
+
+  it "gives a useful error when asking for key that doesn't exist" do
+    hash = HashWithQuickAccess.new({})
+
+    expect {
+      hash.foo.bar.baz
+    }.to raise_error(KeyError, "key :foo was not found")
+  end
+
+  it "lets you get at the keys" do
+    hash = HashWithQuickAccess.new({
+      name: "Mikkel Hansen",
+      books: [],
+    })
+
+    expect(hash.keys).to eq [:name, :books]
+  end
+
+  it "allows lookups when the keys are strings" do
+    hash = HashWithQuickAccess.new({ "name" => 1 })
+
+    expect(hash.name).to eq 1
+  end
+
+  it "lets you use the standard hash #[] method" do
+    hash = HashWithQuickAccess.new({
+      job: {
+        title: "Programmer",
+      },
+    })
+
+    expect(hash[:job][:title]).to eq "Programmer"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/tonsser_hash_utils.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tonsser_hash_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tonsser_hash_utils"
+  spec.version       = TonsserHashUtils::VERSION
+  spec.authors       = ["David Pedersen"]
+  spec.email         = ["david@tonsser.com"]
+  spec.summary       = %q{A collection of classes for dealing with hashes}
+  spec.description   = %q{}
+  spec.homepage      = "http://github.com/tonsser/tonsser_hash_utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+
+  spec.add_runtime_dependency "activesupport", "~> 4.2.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: tonsser_hash_utils
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- David Pedersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: ''
+email:
+- david@tonsser.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/deep_hash.rb
+- lib/hash_builder.rb
+- lib/hash_merger.rb
+- lib/hash_with_quick_access.rb
+- lib/tonsser_hash_utils.rb
+- lib/tonsser_hash_utils/version.rb
+- spec/lib/deep_hash_spec.rb
+- spec/lib/hash_builder_spec.rb
+- spec/lib/hash_merger_spec.rb
+- spec/lib/hash_with_quick_access_spec.rb
+- spec/spec_helper.rb
+- tonsser_hash_utils.gemspec
+homepage: http://github.com/tonsser/tonsser_hash_utils
+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.5
+signing_key: 
+specification_version: 4
+summary: A collection of classes for dealing with hashes
+test_files:
+- spec/lib/deep_hash_spec.rb
+- spec/lib/hash_builder_spec.rb
+- spec/lib/hash_merger_spec.rb
+- spec/lib/hash_with_quick_access_spec.rb
+- spec/spec_helper.rb