fetch_in 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mccraig mccraig of the clan mccraig
+
+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.rdoc

@@ -0,0 +1,48 @@
+= fetch_in
+
+adds fetch_in and store_in methods to Hash and Array which allow for easy fetching 
+and storing of values in nested associative structures
+
+=== fetch_in
+
+fetch values from nested associative structures without worrying about testing
+for nils
+
+ h={:foo=>[{:bar=>1}]}
+ h.fetch_in(:foo, 0, :bar)
+ => 1
+ h.fetch_in(:bar, 0, :foo)
+ => nil
+
+=== store_in
+
+store values in a nested associative structure, automatically creating new levels
+in the structure if required
+
+ h={}
+ h.store_in(:foo, :bar, 2)
+ h
+ =>{:foo=>{:bar=>2}}
+
+ h=[]
+ h.store_in(1,2,3)
+ h
+ =>[nil,[nil,nil,3]]
+
+== Install
+
+ gem install fetch_in
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 mccraig mccraig of the clan mccraig. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fetch_in"
+    gem.summary = %Q{simple value fetching in nested associative structures}
+    gem.description = %Q{fetch values from nested associative structures without worring about nils, a la clojure's get-in}
+    gem.email = "mccraigmccraig@googlemail.com"
+    gem.homepage = "http://github.com/mccraigmccraig/fetch_in"
+    gem.authors = ["mccraig mccraig of the clan mccraig"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rr", ">= 0.10.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fetch_in #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/fetch_in.rb

@@ -0,0 +1,35 @@
+module FetchIn
+  def fetch_in(*keys)
+    keys.reduce(self) do |result,key|
+      return nil if !result
+      result[key]
+    end
+  end
+
+  # store_in stores a value in a nested associative structure
+  # new levels in the structure are created as required, by the supplied Proc.
+  # if no Proc is supplied, new levels are created with the same class as
+  # the previous level
+  def store_in(*keys_and_value, &proc)
+    proc ||= lambda{|rx_key_stack| rx_key_stack[-1][0].class.new}
+    keys = keys_and_value[0..-2]
+    value = keys_and_value[-1]
+
+    # find or create the last associative receiver in the chain to the value
+    last_rx = keys[0..-2].reduce([self,[]]) do |(rx,rx_key_stack),key|
+      rx_key_stack = rx_key_stack << [rx,key]
+      rx[key] = proc.call(rx_key_stack) if !rx[key]
+      [rx[key], rx_key_stack]
+    end[0]
+
+    # set the value
+    last_rx[keys[-1]]=value
+  end
+end
+
+class Hash
+  include FetchIn
+end
+class Array
+  include FetchIn
+end

data/spec/fetch_in_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FetchIn" do
+  describe "fetch_in" do
+    it "should fetch from a single level array" do
+      [1].fetch_in(0).should == 1
+    end
+
+    it "should fetch nil if out of bounds of array" do
+      [1].fetch_in(1).should == nil
+    end
+
+    it "should fetch from a single level hash" do
+      {:foo=>:bar}.fetch_in(:foo).should == :bar
+    end
+
+    it "should fetch nil if no matching key in hash" do
+      {:foo=>:bar}.fetch_in(:bar).should == nil
+    end
+
+    it "should fetch from a two level hash" do
+      {:foo=>{:bar=>:baz}}.fetch_in(:foo, :bar).should == :baz
+    end
+
+    it "should fetch nil if no matching key in two level hash" do
+      {:foo=>{:bar=>:baz}}.fetch_in(:foo, :baz).should == nil
+    end
+
+    it "should fetch from a two level array" do
+      [[5]].fetch_in(0,0).should == 5
+    end
+
+    it "should fetch nil if no matching index in two level array" do
+      [[5]].fetch_in(0,1).should == nil
+    end
+    
+    it "should fetch from mixed array and hash nestings" do
+      {:foo=>[nil,[nil,{:bar=>5}]]}.fetch_in(:foo,1,1,:bar).should == 5
+    end
+  end
+
+  describe "store_in" do
+    it "should store in a single level array" do
+      a=[]
+      a.store_in(2,5)
+      a.should==[nil,nil,5]
+    end
+
+    it "should store in a two level array" do
+      a=[nil,[nil,3]]
+      a.store_in(1,2,4)
+      a.should == [nil,[nil,3,4]]
+    end
+    
+    it "should create new nested arrays" do
+      a = [nil]
+      a.store_in(1,2,3)
+      a.should == [nil,[nil,nil,3]]
+    end
+
+    it "should store in a single level hash" do
+      h={}
+      h.store_in(:foo,5)
+      h.should == {:foo=>5}
+    end
+
+    it "should store in a two level hash" do
+      h={:foo=>{:bar=>10}}
+      h.store_in(:foo, :baz, 5)
+      h.should == {:foo=>{:bar=>10, :baz=>5}}
+    end
+
+    it "should create new nested hashes" do
+      h={:foo=>{:bar=>10}}
+      h.store_in(:foo, :baz, :goo, 5)
+      h.should == {:foo=>{:bar=>10, :baz=>{:goo=>5}}}
+    end
+    
+    it "should store in mixed array hash structure" do
+      s=[nil,{:foo=>[1,2]}]
+      s.store_in(1,:foo,2,3)
+      s.should == [nil,{:foo=>[1,2,3]}]
+    end
+
+    it "should create new array levels after the type of the last level" do
+      s=[nil,{:foo=>[1,2]}]
+      s.store_in(1,:foo,2,2,3)
+      s.should == [nil,{:foo=>[1,2,[nil,nil,3]]}]
+    end
+
+    it "should create new hash levels after the type of the last level" do
+      s=[nil,{:foo=>[1,2,{:bar=>5}]}]
+      s.store_in(1,:foo,2,:baz,:goo,7)
+      s.should == [nil,{:foo=>[1,2,{:bar=>5,:baz=>{:goo=>7}}]}]
+    end
+
+    it "should allow a block to create new levels" do
+      s=[]
+      s.store_in(1,2,3){|rx_key_stack| {}}
+      s.should == [nil,{2=>3}]
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'fetch_in'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: fetch_in
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mccraig mccraig of the clan mccraig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 5
+        version: 0.10.5
+  type: :development
+  version_requirements: *id002
+description: fetch values from nested associative structures without worring about nils, a la clojure's get-in
+email: mccraigmccraig@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fetch_in.rb
+- spec/fetch_in_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mccraigmccraig/fetch_in
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: simple value fetching in nested associative structures
+test_files: 
+- spec/fetch_in_spec.rb
+- spec/spec_helper.rb