hash-proxy 0.0.1

data/.bnsignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use hash-proxy

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 / 2012-06-07
+
+* First release of hash-proxy

data/README.md

@@ -0,0 +1,66 @@
+hash-proxy
+===========
+
+An object that proxies method calls to a Hash object as hash key lookups.
+Handles nested hashes and arrays.
+
+Features
+--------
+
+* Treat Hash as an object
+
+Examples
+--------
+
+    require 'hash-proxy'
+    hash = {foo: 'bar', baz: [{key: 'value', key2: 2, key3: [1,2,3]}, {key: 'value2', key2: 22, key3: [4,5,6]}], bip: 'bop'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.baz.key3.should == [4,5,6]
+
+Requirements
+------------
+
+* No dependencies
+
+Install
+-------
+
+* gem install hash-proxy
+
+Motivation
+----------
+
+Used to wrap responses from JSON returning web services to avoid having to write
+a bunch of useless objects that have to be updated constantly to match changes and/or
+mistakes in the API.
+
+Author
+------
+
+Original author: Douglas A. Seifert (doug@dseifert.net)
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2012 Douglas A. Seifert
+
+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/Rakefile

@@ -0,0 +1,22 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'spec:run'
+task 'gem:release' => 'spec:run'
+
+Bones {
+  name     'hash-proxy'
+  authors  'Douglas A. Seifert'
+  email    'doug@dseifert.net'
+  url      'https://github.com/dseifert/hash-proxy'
+  depend_on 'bones', :development => true
+  depend_on 'bones-rspec', :development => true
+  depend_on 'bones-git', :development => true
+}
+
+require 'bones/plugins/rspec'
+require 'bones/plugins/git'

data/lib/hash_proxy.rb

@@ -0,0 +1,60 @@
+
+module HashProxy
+
+  # :stopdoc:
+  LIBPATH = ::File.expand_path('..', __FILE__) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  VERSION = ::File.read(PATH + 'version.txt').strip
+  # :startdoc:
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+    if block_given?
+      begin
+        $LOAD_PATH.unshift LIBPATH
+        rv = yield
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
+    if block_given?
+      begin
+        $LOAD_PATH.unshift PATH
+        rv = yield
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module HashProxy
+
+HashProxy.require_all_libs_relative_to(__FILE__)
+

data/lib/hash_proxy/null_object.rb

@@ -0,0 +1,14 @@
+module HashProxy
+  class NullObject
+    def to_a; []; end
+    def to_s; ""; end
+    def to_f; 0.0; end
+    def to_i; 0; end
+    def nil?; true; end
+    def blank?; true; end
+    def empty?; true; end
+    def method_missing(*args)
+      self
+    end
+  end
+end

data/lib/hash_proxy/proxy.rb

@@ -0,0 +1,34 @@
+module HashProxy
+  class Proxy
+    NO_OBJECT = NullObject.new
+    EQUALS = '='.freeze
+
+    def initialize(hash, options = {})
+      @hash = hash
+      @converted = {}
+    end
+
+    def method_missing(name, *args)
+      name_str = name.to_s
+      if name_str.end_with?(EQUALS)
+        @converted[name_str[0..-2]] = convert_value(args.first)
+      else
+        # Move the value from the original hash to the converted hash.
+        # Support both symbol or string keys
+        @converted[name_str] ||= convert_value(@hash.delete(name) || @hash.delete(name_str))
+      end
+    end
+
+    def convert_value(value)
+      case value
+      when Array
+        value.map! {|array_value| convert_value(array_value)}
+        value
+      when Hash
+        Proxy.new(value)
+      else
+        value || NO_OBJECT
+      end
+    end
+  end
+end

data/spec/hash_proxy_spec.rb

@@ -0,0 +1,54 @@
+
+require File.expand_path('../spec_helper', __FILE__)
+
+describe HashProxy do
+  it "turns hash keys into method calls" do
+    hash = {foo: 'bar', baz: 'bip'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.foo.should eq('bar')
+    proxy.baz.should eq('bip')
+  end
+
+  it "handles nested hashes" do
+    hash = {foo: {bar: 'barvalue', baz: 'bazvalue'}, bip: 'bipvalue'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.foo.bar.should eq('barvalue')
+    proxy.foo.baz.should eq('bazvalue')
+    proxy.bip.should eq('bipvalue')
+  end
+
+  it "handles string keys" do
+    hash = {'foo' => 'bar', 'baz' => 'bip'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.foo.should eq('bar')
+    proxy.baz.should eq('bip')
+  end
+
+  it "handles simple arrays" do
+    hash = {'foo' => 'bar', 'arr1' => [1,2,3], 'baz' => 'bip'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.arr1.should eq([1,2,3])
+  end
+
+  it "handles complicated arrays" do
+    hash = {'foo' => 'bar', 'arr1' => [{'subkey' => 'subkeyval', 'more' => 'moreval'}, 3, {'subkey' => 'subkeyval2', 'more' => 'moreval2'}], 'baz' => 'bip'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.arr1.first.subkey.should eq('subkeyval')
+    proxy.arr1.last.subkey.should eq('subkeyval2')
+    proxy.arr1[1].should eq(3)
+  end
+
+  it "should not convert values if nothing is referenced" do
+    hash = {'foo' => 'bar', 'arr1' => [1,2,3], 'baz' => 'bip'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.should_not_receive(:convert_value)
+  end
+
+  it "should convert values if they are referenced" do
+    hash = {foo: 'bar', baz: 'bip'}
+    proxy = HashProxy::Proxy.new(hash)
+    proxy.should_receive(:convert_value).once.with('bar').and_return('bar')
+    proxy.foo.should eq('bar')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+
+require 'rubygems'
+require 'rspec'
+
+require File.expand_path('../../lib/hash_proxy', __FILE__)
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_framework = :mocha
+  # config.mock_framework = :flexmock
+  # config.mock_framework = :rr
+end
+

data/version.txt

@@ -0,0 +1 @@
+0.0.1

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: hash-proxy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Douglas A. Seifert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bones
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: bones-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: bones-git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bones
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: ! 'An object that proxies method calls to a Hash object as hash key lookups.
+
+  Handles nested hashes and arrays.'
+email: doug@dseifert.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+files:
+- .bnsignore
+- .gitignore
+- .rvmrc
+- History.txt
+- README.md
+- Rakefile
+- lib/hash_proxy.rb
+- lib/hash_proxy/null_object.rb
+- lib/hash_proxy/proxy.rb
+- spec/hash_proxy_spec.rb
+- spec/spec_helper.rb
+- version.txt
+homepage: https://github.com/dseifert/hash-proxy
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: hash-proxy
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An object that proxies method calls to a Hash object as hash key lookups.
+test_files: []