hash-walker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9e3ee3459b9576580bacf2afe1ae761ff8fa5c1
+  data.tar.gz: fe55a7f74e7afcc372a55356c098c4909e9604f0
+SHA512:
+  metadata.gz: 488f8cab2d0f644d98319895092139ff07fb6bb8dc8fb65b81b17373d794a10a408ebd7e5219edf313355e3016daa495ec18a6414b9c1600360784d83c752460
+  data.tar.gz: 456a4df0c4c0a6b1e1e333ef043a8f0e1c9106761caafb54b892ba6e5a50a0ee8bbaf8e83e933505da466e703aaaebc5253c6bb23ffd9bbd4378120fc57c53bf

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+hash-walker

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gal Steinitz
+
+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,137 @@
+# HashWalker
+
+Walk a hash like a hash walker would.
+
+A ruby DSL for walking through hashes. Its the reverse of XmlBuilder or jbuilder. Works with symbol or string keys.
+
+[![Build Status](https://secure.travis-ci.org/al-jazeera-america/hash-walker.png?branch=master)](http://travis-ci.org/al-jazeera-america/hash-walker) [![Code Climate](https://codeclimate.com/github/galori/hash-walker.png)](https://codeclimate.com/al-jazeera-america/hash-walker`)
+
+## Usage
+
+given this hash:
+
+```ruby
+    hash = {
+      :host => 'ruby-lang.org',
+      :protocol => 'http://',
+      :headers => {:user_agent => 'safari'},
+      :cache => {'strategy' => {'type' => 'lazy'}}
+    }
+```
+
+you would traverse it with the following ruby DSL:
+
+```ruby
+    HashWalker.walk(hash) do
+      cache do
+        strategy do
+          puts type
+        end
+      end
+    end
+```
+
+### Arrays
+
+given this hash:
+
+```ruby
+    hash = { stories: [
+        {:title => 'a', :url => 'http://some-url/a'},
+        {:title => 'b', :url => 'http://some-url/b'},
+        {:title => 'c', :url => 'http://some-url/c'}
+    ]}
+```
+
+you would traverse it with the following ruby DSL:
+
+```ruby
+    HashWalker.walk(hash) do
+      stories do
+        puts title
+        puts url
+      end
+    end
+```
+
+### Non existant keys
+
+Non existant keys are skipped gracefully
+
+```ruby
+    hash = { :set1 => { :a => 1, :b => 1 }}
+```
+
+you would traverse it with the following ruby DSL:
+
+```ruby
+    HashWalker.walk(hash) do
+      set1 do
+        puts a
+      end
+
+      set2 do
+        puts a
+      end
+    end
+```
+
+you would get this output:
+
+```ruby
+  1
+```
+
+
+## Contributing
+
+Clone and send a pull request, preferably with a test.
+Run the tests using `rake`
+
+* TODO: map vs. join? at least test it
+* TODO: ability to reach out to parent (parent. something?)
+* TODO: ability to reach out to siblings?
+* TODO: Top level arrays/ (are they valid JSON and valid HAshes?)
+* TODO: accept JSON or HASH or HTTParty response
+* TODO: HTTParty adapter.   httparty_response.walk()
+* TODO: Adapter for other libaries? VCR? Mechanize? REGEXP? Nokogiri?
+* TODO: return a value from the entire outer bloc
+* TODO: test more stuff at the top level / outer block level.
+* TODO: top level array? (then its not a hash)
+* TODO: support for objects and enumerables along with Hash's and Arrays
+* TODO: access to key names
+* TODO: generate the DSL based on an existing hash (like a VCR cassette?)
+* TODO: don't look for Hash's and Array's, look for objects that act like Hash's and act like Arrays. (objects and enumarbles?)
+* TODO: Create an operator? (possibly using superators?) For example, a tilde unary operator is possible:
+
+so instead of
+
+```ruby
+   HashWalker::Walk(my_hash) do
+     stories do
+       puts title
+     end
+   end
+```
+
+we could do
+
+```ruby
+   ~my_hash do
+     stories do
+       puts title
+     end
+   end
+```
+
+or
+
+we could do
+
+```ruby
+   my_hash ~~~ do
+     stories do
+       puts title
+     end
+   end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hash-walker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_walker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash-walker"
+  spec.version       = HashWalker::VERSION
+  spec.authors       = ["Gal Steinitz"]
+  spec.email         = ["gal@steinitz.com"]
+  spec.summary       = %q{Walk a hash like a hash walker would}
+  spec.description   = %q{a Ruby DSL for walking through a Hash and processing it}
+  spec.homepage      = "https://github.com/al-jazeera-america/hash-walker"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency 'activesupport'
+end

data/lib/hash_walker.rb

@@ -0,0 +1,15 @@
+require "hash_walker/version"
+require "hash_walker/walker"
+require "hash_walker/walk"
+require "hash_walker/stepper"
+require "hash_walker/stepper_base"
+require "hash_walker/stepper/hash"
+require "hash_walker/stepper/array"
+
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/object/try"
+
+module HashWalker
+
+end

data/lib/hash_walker/stepper.rb

@@ -0,0 +1,3 @@
+class Stepper
+
+end

data/lib/hash_walker/stepper/array.rb

@@ -0,0 +1,10 @@
+class Stepper::Array < Stepper::Base
+
+  def step!
+    @hash_fragment.map do |entry|
+      walker = HashWalker::Walker.new(:hash => entry, :block => @block)
+      walker.walk!
+    end
+  end
+
+end

data/lib/hash_walker/stepper/hash.rb

@@ -0,0 +1,3 @@
+class Stepper::Hash < Stepper::Base
+
+end

data/lib/hash_walker/stepper_base.rb

@@ -0,0 +1,14 @@
+class Stepper::Base
+
+  attr_accessor :hash_fragment, :block
+
+  def step!
+    if @block
+      walker = HashWalker::Walker.new(:hash => @hash_fragment, :block => @block)
+      walker.walk!
+    else
+      @hash_fragment
+    end
+  end
+
+end

data/lib/hash_walker/version.rb

@@ -0,0 +1,3 @@
+module HashWalker
+  VERSION = "1.0.0"
+end

data/lib/hash_walker/walk.rb

@@ -0,0 +1,8 @@
+module HashWalker
+
+  def self.walk(hash,&blocky)
+    walker = HashWalker::Walker.new(:hash => hash, :block => blocky)
+    walker.walk!
+  end
+
+end

data/lib/hash_walker/walker.rb

@@ -0,0 +1,41 @@
+module HashWalker
+  class Walker
+
+    def initialize(options)
+      @hash_fragment = options[:hash]
+      @hash_fragment = @hash_fragment.with_indifferent_access if @hash_fragment.is_a? Hash
+      @block = options[:block]
+    end
+
+    def walk!
+      instance_eval(&@block)
+    end
+
+    def value
+      @hash_fragment.respond_to?('keys') && @hash_fragment[@attribute_name]
+    end
+
+    def next_step_is_array?
+      (@hash_fragment.is_a?(Hash) && value.is_a?(Array))
+    end
+
+    def get_stepper
+      next_step_is_array? ? Stepper::Array : Stepper::Hash
+    end
+
+    def take_one_step
+      stepper = get_stepper.new
+      stepper.hash_fragment = value
+      stepper.block = @block
+      stepper.step!
+    end
+
+    def method_missing(*args,&block)
+      @attribute_name = args[0]
+      @block = block
+
+      take_one_step
+    end
+
+  end
+end

data/spec/hash_walker_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe HashWalker do
+  it 'should have a version number' do
+    HashWalker::VERSION.should_not be_nil
+  end
+
+  describe 'the DSL' do
+    let(:hash) {
+      hash = {
+          :host => 'ruby-lang.org',
+          :protocol => 'http://',
+          :headers => {:user_agent => 'safari'},
+          :cache => {:strategy => {:type => 'lazy'}}
+      }
+    }
+    it 'access to top level attributes of the hash' do
+      HashWalker.walk(hash) do
+        host.should == 'ruby-lang.org'
+      end
+    end
+
+    it 'allow walking into a key' do
+      expect {
+        HashWalker.walk(hash) do
+          headers do
+            raise 'this line was executed!'
+          end
+        end
+      }.to raise_error('this line was executed!')
+    end
+
+    it 'should allow walking into a key and then provide access to its attributes' do
+      HashWalker.walk(hash) do
+        headers do
+          user_agent.should == 'safari'
+        end
+      end
+    end
+
+    it 'should allow walking down two levels of keys' do
+      expect {
+        HashWalker.walk(hash) do
+          cache do
+            strategy do
+              raise "We're down two levels!"
+            end
+          end
+        end
+      }.to raise_error("We're down two levels!")
+    end
+
+    it 'should allow walking down two levels of keys and reading attributes' do
+      HashWalker.walk(hash) do
+        cache do
+          strategy do
+            type.should == 'lazy'
+          end
+        end
+      end
+    end
+
+    it 'should work with strings as keys' do
+      hash = {'string_key' => 'String Value'}
+      HashWalker.walk(hash) do
+        string_key.should == 'String Value'
+      end
+    end
+
+    it 'should work with strings as symbols' do
+      hash = {:string_key => 'String Value'}
+      HashWalker.walk(hash) do
+        string_key.should == 'String Value'
+      end
+    end
+
+    it 'should do something with a block on a value' do
+      hash = {:a => 'b'}
+      dummy = double('dummy')
+      dummy.should_receive(:block_was_run)
+      HashWalker.walk(hash) do
+        a do
+          dummy.block_was_run
+        end
+      end
+    end
+
+    it 'should iterate through arrays' do
+      hash = {:stories => [{:a => 1},{:a => 2},{:a => 3}]}
+      dummy = double('dummy')
+      dummy.should_receive(:set_a_value).with(1).ordered
+      dummy.should_receive(:set_a_value).with(2).ordered
+      dummy.should_receive(:set_a_value).with(3).ordered
+
+      HashWalker.walk(hash) do
+        stories do
+          dummy.set_a_value(a)
+        end
+      end
+    end
+
+    it 'should iterate through arrays and return an array of the results like .map' do
+      hash = {:stories => [{:a => 1},{:a => 2},{:a => 3}]}
+      HashWalker.walk(hash) do
+        stories do
+          a
+        end.should == [1,2,3]
+      end
+    end
+
+    it 'should skip missing keys or attributes without raising an error' do
+      hash = {:stories => 'something'}
+      expect {
+        HashWalker.walk(hash) do
+          stories do
+            some_non_existant_key
+          end
+        end
+      }.not_to raise_error
+    end
+  end
+end
+
+
+# TODO: map vs. join? at least test it
+# TODO: ability to reach out to parent (parent. something?)
+# TODO: ability to reach out to siblings?
+# TODO: Top level arrays/ (are they valid JSON and valid HAshes?)
+# TODO: accept JSON or HASH or HTTParty response
+# TODO: HTTParty adapter.   httparty_response.walk()
+# TODO: Adapter for other libaries? VCR? Mechanize? REGEXP? Nokogiri?
+# TODO: return a value from the entire outer bloc
+# TODO: test more stuff at the top level / outer block level
+# TODO: access to key names
+# TODO: generate the DSL based on an existing hash (like a VCR cassette?)
+# TODO: option to raise an error or not raise an error if referencing a non-existant key
+# TODO: don't look for Hash's and Array's, look for objects that act like Hash's and act like Arrays. (objects and enumarbles?)

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hash_walker'
+
+RSpec.configure do |config|
+  config.backtrace_exclusion_patterns = []
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: hash-walker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gal Steinitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a Ruby DSL for walking through a Hash and processing it
+email:
+- gal@steinitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash-walker.gemspec
+- lib/hash_walker.rb
+- lib/hash_walker/stepper.rb
+- lib/hash_walker/stepper/array.rb
+- lib/hash_walker/stepper/hash.rb
+- lib/hash_walker/stepper_base.rb
+- lib/hash_walker/version.rb
+- lib/hash_walker/walk.rb
+- lib/hash_walker/walker.rb
+- spec/hash_walker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/al-jazeera-america/hash-walker
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Walk a hash like a hash walker would
+test_files:
+- spec/hash_walker_spec.rb
+- spec/spec_helper.rb