choc_mool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b51016959207b8119d08dd726ff8286f519b8e1
+  data.tar.gz: 803774c6a55941e08260af5a2708182a0176a5bb
+SHA512:
+  metadata.gz: 2b249fdc25bacde3927a17718aa720710287c788768636e168511ce0e41d4d4d533830a7344a6592453e19e31f24bfedad20c43467d6f6b6e43bfc5fd1acd9f2
+  data.tar.gz: 7ac0db273e306aa1b10af80fa8504d40f2c70280a4cb9040175043e227ca0abcde332a5f4d8d70974e952803212b3d77f07473a4ecdcc92de56adc789f04e989

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode
+script: 'rake'
+branches:
+  only:
+    - master
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark G
+
+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,91 @@
+# ChocMool
+
+Wraps a hash, allowing easy access to deeply nested values.
+
+## Installation
+
+```ruby
+gem 'choc_mool'
+```
+
+## Usage
+
+```ruby
+hash = {one: {two: {three: :four}}}
+data = ChocMool.new(hash)
+
+data.fetch(:one, :two, :three)
+# => :four
+```
+
+#### using a regex
+
+```ruby
+hash = {one: 'two, three'}
+data = ChocMool.new(hash)
+
+data.using(/^(.*),/).fetch(:one)
+# => 'two'
+```
+
+#### using dot notation
+
+```ruby
+hash = {one: {two: {three: :four}}}
+data = ChocMool.new(hash)
+
+data.fetch('one.two.three')
+# => :four
+
+data.fetch(:one, 'two.three')
+# => :four
+```
+
+#### accessing attributes
+
+A common use for ChocMool is to easily access deeply nested data returned from APIs.
+The API data is converted to hash from XML or JSON then wrapped by ChocMool.
+
+XML cannot be represented directly by a hash, thus libraries that convert
+the XML -> hash can expose this data.
+
+ChocMool supports accessing these values when they are accessed via
+`#attributes` on the corresponding key (as provided by [Nori](https://github.com/savonrb/nori)).
+
+```ruby
+xml = "<one two='three'>four</one>"
+hash = Nori.new.parse(xml)
+data = ChocMool.new(hash)
+
+data.fetch(:one, '@two')
+# => 'three'
+
+data.fetch(:one)
+# => 'four'
+```
+
+#### accessing arrays
+
+```ruby
+hash = {one: [:two, :three]}
+data = ChocMool.new(hash)
+
+data.fetch(:one, 1)
+# => :three
+
+data.fetch_each(:one) { |value| puts value }
+# => :two
+# => :three
+
+data.fetch_each_with_index(:one) { |value, index| puts "#{index}: #{value}" }
+# => 0: :two
+# => 1: :three
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ["--color"]
+end
+
+task default: :spec

data/choc_mool.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'choc_mool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'choc_mool'
+  spec.version       = ChocMool::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Mark G']
+  spec.email         = ['rtec88@gmail.com']
+  spec.description   = 'Deep dive hash accessor'
+  spec.summary       = spec.description
+  spec.homepage      = 'http://github.com/attack/choc_mool'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.11'
+  spec.add_development_dependency 'pry'
+end

data/lib/choc_mool.rb

@@ -0,0 +1,108 @@
+require_relative 'choc_mool/version'
+
+class ChocMool
+  attr_reader :hash, :regex
+
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def using(regex)
+    @regex = regex
+    self
+  end
+
+  def fetch(*paths)
+    paths = _expand(paths)
+
+    if hash
+      result = fetch_value_or_attribute(paths)
+    else
+      result = nil
+    end
+
+    result = _apply_regex(result)
+    result = _cleanup(result)
+
+    result
+  end
+
+  def each(*paths, &block)
+    path = fetch(*paths)
+    if path
+      path.each do |result|
+        result_payload = ChocMool.new(result)
+        block.call(result_payload)
+      end
+    end
+  end
+
+  def each_with_index(*paths, &block)
+    fetch(*paths).each_with_index do |result, index|
+      result_payload = ChocMool.new(result)
+      block.call(result_payload, index)
+    end
+  end
+
+  def fetch_each(*paths, &block)
+    each(*paths, &block)
+  end
+
+  def fetch_each_with_index(*paths, &block)
+    each_with_index(*paths, &block)
+  end
+
+  private
+
+  def _expand(paths)
+    paths.map do |path|
+      if path.respond_to?(:split)
+        path.split('.')
+      else
+        path
+      end
+    end.flatten
+  end
+
+  def fetch_value_or_attribute(paths)
+    result = paths.inject(hash) do |result, path|
+      fetch_value(result, path) || fetch_attribute(result, path) || break
+    end
+  end
+
+  def fetch_value(result, path)
+    if result.respond_to? :fetch
+      fetch_native(result, path) || fetch_symbol(result, path) || fetch_string(result, path)
+    end
+  end
+
+  def fetch_native(result, path)
+    result.fetch(path, nil)
+  end
+
+  def fetch_symbol(result, path)
+    result.fetch(path.to_sym, nil) if path.respond_to?(:to_sym)
+  end
+
+  def fetch_string(result, path)
+    result.fetch(path.to_s, nil) if path.respond_to?(:to_s)
+  end
+
+  def fetch_attribute(result, path)
+    if path.to_s.start_with?('@') && result.respond_to?(:attributes)
+      result.attributes.fetch(path.slice(1..-1))
+    end
+  end
+
+  def _apply_regex(result)
+    if @regex && @regex.is_a?(Regexp) && matched = result.to_s.match(@regex)
+      result = matched[1] if matched[1]
+    end
+    @regex = nil
+    result
+  end
+
+  def _cleanup(result)
+    result.respond_to?(:strip) ? result.strip : result
+  end
+end

data/lib/choc_mool/version.rb

@@ -0,0 +1,3 @@
+class ChocMool
+  VERSION = '0.0.1'
+end

data/spec/choc_mool_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+describe ChocMool do
+  describe '#fetch' do
+    it 'returns the value for the key provided' do
+      hash = {one: 1}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one) ).to eq 1
+    end
+
+    it 'returns nil when the key cannot be found' do
+      hash = {}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one) ).to be_nil
+    end
+
+    it 'traverses multiple levels to get the value' do
+      hash = {one: {two: {three: 3}}}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one, :two, :three) ).to eq 3
+    end
+
+    it 'returns nil when any level cannot be found' do
+      hash = {one: {two: {three: {four: 4}}}}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one, :too, :three) ).to be_nil
+    end
+
+    it 'returns nil when the starting value is nil' do
+      hash = nil
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one) ).to be_nil
+    end
+
+    it 'returns a stripped result' do
+      hash = {one: ' one '}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one) ).to eq 'one'
+    end
+
+    it "returns the value for the key provided, even when using string keys" do
+      hash = {:one => 1}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch('one') ).to eq 1
+    end
+
+    it "returns the value for the key provided, even when using symbol keys" do
+      hash = {'one' => 1}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one) ).to eq 1
+    end
+
+    it "traverses multiple levels using dot syntax" do
+      hash = {:one => {:two => {:three => 3}}}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch('one.two.three') ).to eq 3
+    end
+
+    it "traverses multiple levels using mixed dot syntax" do
+      hash = {:one => {:two => {:three => 3}}}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.fetch(:one, 'two.three') ).to eq 3
+    end
+
+    context 'when the data is accessed via an attribute' do
+      it 'returns the value of the key' do
+        hash = {one: {'@two' => 2}}
+        choc_mool = ChocMool.new(hash)
+        expect( choc_mool.fetch(:one, '@two') ).to eq 2
+      end
+
+      it 'returns the value accessed via :attributes' do
+        class StringWithAttributes < String
+          attr_accessor :attributes
+        end
+        value_with_attributes = StringWithAttributes.new('one')
+        value_with_attributes.attributes = {'two' => 2}
+        hash = {one: value_with_attributes}
+        choc_mool = ChocMool.new(hash)
+        expect( choc_mool.fetch(:one, '@two') ).to eq 2
+      end
+    end
+
+    context 'when the data is accessed via an index' do
+      it 'returns the value at that index' do
+        hash = {one: [2]}
+        choc_mool = ChocMool.new(hash)
+        expect( choc_mool.fetch(:one, 0) ).to eq 2
+      end
+    end
+  end
+
+  describe '#fetch_each' do
+    it 'returns an instance for each result found at the key' do
+      hash = {one: [{two: 2}, {two: 2}]}
+      choc_mool = ChocMool.new(hash)
+
+      expect { |b|
+        choc_mool.fetch_each(:one, &b)
+      }.to yield_successive_args(ChocMool, ChocMool)
+    end
+
+    it 'returns an instance for each result found at the key' do
+      hash = {one: [{two: 2}, {two: 2}]}
+      choc_mool = ChocMool.new(hash)
+
+      choc_mool.fetch_each(:one) do |value|
+        expect( value.fetch(:two) ).to eq 2
+      end
+    end
+
+    it 'raises an error when result is not an array' do
+      hash = {one: 1}
+      choc_mool = ChocMool.new(hash)
+
+      expect {
+        choc_mool.fetch_each(:one){ |p| nil }
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe '#fetch_each_with_index' do
+    it 'returns an instance for each result found at the key' do
+      hash = {one: [{two: 2}, {two: 2}]}
+      choc_mool = ChocMool.new(hash)
+
+      i = 0
+      choc_mool.fetch_each_with_index(:one) do |value, index|
+        expect( value.fetch(:two) ).to eq 2
+        expect( index ).to eq i
+        i += 1
+      end
+    end
+
+    it 'raises an error when result is not an array' do
+      hash = {one: 1}
+      choc_mool = ChocMool.new(hash)
+
+      expect {
+        choc_mool.fetch_each_with_index(:one){ |p| nil }
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe '#using' do
+    it 'applies the regex to the fetched result' do
+      hash = {one: 'two, three'}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.using(/^(.*),/).fetch(:one) ).to eq 'two'
+    end
+
+    it 'does nothing if valid regex does not exist' do
+      hash = {one: 'two, three'}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.using(:invalid_regex).fetch(:one) ).to eq 'two, three'
+    end
+
+    it 'does nothing if regex does not capture proper result' do
+      hash = {one: 'two, three'}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.using(/^.*,.*$/).fetch(:one) ).to eq 'two, three'
+    end
+
+    it 'forgets the regex' do
+      hash = {one: 'two, three'}
+      choc_mool = ChocMool.new(hash)
+      expect( choc_mool.using(/^(.*),/).fetch(:one) ).to eq 'two'
+      expect( choc_mool.fetch(:one) ).to eq 'two, three'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'pry'
+
+require_relative '../lib/choc_mool'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: choc_mool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark G
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Deep dive hash accessor
+email:
+- rtec88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- choc_mool.gemspec
+- lib/choc_mool.rb
+- lib/choc_mool/version.rb
+- spec/choc_mool_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/attack/choc_mool
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Deep dive hash accessor
+test_files:
+- spec/choc_mool_spec.rb
+- spec/spec_helper.rb
+has_rdoc: