fetch_in 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 mccraig mccraig of the clan mccraig
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,48 @@
1
+ = fetch_in
2
+
3
+ adds fetch_in and store_in methods to Hash and Array which allow for easy fetching
4
+ and storing of values in nested associative structures
5
+
6
+ === fetch_in
7
+
8
+ fetch values from nested associative structures without worrying about testing
9
+ for nils
10
+
11
+ h={:foo=>[{:bar=>1}]}
12
+ h.fetch_in(:foo, 0, :bar)
13
+ => 1
14
+ h.fetch_in(:bar, 0, :foo)
15
+ => nil
16
+
17
+ === store_in
18
+
19
+ store values in a nested associative structure, automatically creating new levels
20
+ in the structure if required
21
+
22
+ h={}
23
+ h.store_in(:foo, :bar, 2)
24
+ h
25
+ =>{:foo=>{:bar=>2}}
26
+
27
+ h=[]
28
+ h.store_in(1,2,3)
29
+ h
30
+ =>[nil,[nil,nil,3]]
31
+
32
+ == Install
33
+
34
+ gem install fetch_in
35
+
36
+ == Note on Patches/Pull Requests
37
+
38
+ * Fork the project.
39
+ * Make your feature addition or bug fix.
40
+ * Add tests for it. This is important so I don't break it in a
41
+ future version unintentionally.
42
+ * Commit, do not mess with rakefile, version, or history.
43
+ (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)
44
+ * Send me a pull request. Bonus points for topic branches.
45
+
46
+ == Copyright
47
+
48
+ Copyright (c) 2010 mccraig mccraig of the clan mccraig. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,46 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "fetch_in"
8
+ gem.summary = %Q{simple value fetching in nested associative structures}
9
+ gem.description = %Q{fetch values from nested associative structures without worring about nils, a la clojure's get-in}
10
+ gem.email = "mccraigmccraig@googlemail.com"
11
+ gem.homepage = "http://github.com/mccraigmccraig/fetch_in"
12
+ gem.authors = ["mccraig mccraig of the clan mccraig"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.9"
14
+ gem.add_development_dependency "rr", ">= 0.10.5"
15
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
16
+ end
17
+ Jeweler::GemcutterTasks.new
18
+ rescue LoadError
19
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
20
+ end
21
+
22
+ require 'spec/rake/spectask'
23
+ Spec::Rake::SpecTask.new(:spec) do |spec|
24
+ spec.libs << 'lib' << 'spec'
25
+ spec.spec_files = FileList['spec/**/*_spec.rb']
26
+ end
27
+
28
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
29
+ spec.libs << 'lib' << 'spec'
30
+ spec.pattern = 'spec/**/*_spec.rb'
31
+ spec.rcov = true
32
+ end
33
+
34
+ task :spec => :check_dependencies
35
+
36
+ task :default => :spec
37
+
38
+ require 'rake/rdoctask'
39
+ Rake::RDocTask.new do |rdoc|
40
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
41
+
42
+ rdoc.rdoc_dir = 'rdoc'
43
+ rdoc.title = "fetch_in #{version}"
44
+ rdoc.rdoc_files.include('README*')
45
+ rdoc.rdoc_files.include('lib/**/*.rb')
46
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
data/lib/fetch_in.rb ADDED
@@ -0,0 +1,35 @@
1
+ module FetchIn
2
+ def fetch_in(*keys)
3
+ keys.reduce(self) do |result,key|
4
+ return nil if !result
5
+ result[key]
6
+ end
7
+ end
8
+
9
+ # store_in stores a value in a nested associative structure
10
+ # new levels in the structure are created as required, by the supplied Proc.
11
+ # if no Proc is supplied, new levels are created with the same class as
12
+ # the previous level
13
+ def store_in(*keys_and_value, &proc)
14
+ proc ||= lambda{|rx_key_stack| rx_key_stack[-1][0].class.new}
15
+ keys = keys_and_value[0..-2]
16
+ value = keys_and_value[-1]
17
+
18
+ # find or create the last associative receiver in the chain to the value
19
+ last_rx = keys[0..-2].reduce([self,[]]) do |(rx,rx_key_stack),key|
20
+ rx_key_stack = rx_key_stack << [rx,key]
21
+ rx[key] = proc.call(rx_key_stack) if !rx[key]
22
+ [rx[key], rx_key_stack]
23
+ end[0]
24
+
25
+ # set the value
26
+ last_rx[keys[-1]]=value
27
+ end
28
+ end
29
+
30
+ class Hash
31
+ include FetchIn
32
+ end
33
+ class Array
34
+ include FetchIn
35
+ end
@@ -0,0 +1,103 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "FetchIn" do
4
+ describe "fetch_in" do
5
+ it "should fetch from a single level array" do
6
+ [1].fetch_in(0).should == 1
7
+ end
8
+
9
+ it "should fetch nil if out of bounds of array" do
10
+ [1].fetch_in(1).should == nil
11
+ end
12
+
13
+ it "should fetch from a single level hash" do
14
+ {:foo=>:bar}.fetch_in(:foo).should == :bar
15
+ end
16
+
17
+ it "should fetch nil if no matching key in hash" do
18
+ {:foo=>:bar}.fetch_in(:bar).should == nil
19
+ end
20
+
21
+ it "should fetch from a two level hash" do
22
+ {:foo=>{:bar=>:baz}}.fetch_in(:foo, :bar).should == :baz
23
+ end
24
+
25
+ it "should fetch nil if no matching key in two level hash" do
26
+ {:foo=>{:bar=>:baz}}.fetch_in(:foo, :baz).should == nil
27
+ end
28
+
29
+ it "should fetch from a two level array" do
30
+ [[5]].fetch_in(0,0).should == 5
31
+ end
32
+
33
+ it "should fetch nil if no matching index in two level array" do
34
+ [[5]].fetch_in(0,1).should == nil
35
+ end
36
+
37
+ it "should fetch from mixed array and hash nestings" do
38
+ {:foo=>[nil,[nil,{:bar=>5}]]}.fetch_in(:foo,1,1,:bar).should == 5
39
+ end
40
+ end
41
+
42
+ describe "store_in" do
43
+ it "should store in a single level array" do
44
+ a=[]
45
+ a.store_in(2,5)
46
+ a.should==[nil,nil,5]
47
+ end
48
+
49
+ it "should store in a two level array" do
50
+ a=[nil,[nil,3]]
51
+ a.store_in(1,2,4)
52
+ a.should == [nil,[nil,3,4]]
53
+ end
54
+
55
+ it "should create new nested arrays" do
56
+ a = [nil]
57
+ a.store_in(1,2,3)
58
+ a.should == [nil,[nil,nil,3]]
59
+ end
60
+
61
+ it "should store in a single level hash" do
62
+ h={}
63
+ h.store_in(:foo,5)
64
+ h.should == {:foo=>5}
65
+ end
66
+
67
+ it "should store in a two level hash" do
68
+ h={:foo=>{:bar=>10}}
69
+ h.store_in(:foo, :baz, 5)
70
+ h.should == {:foo=>{:bar=>10, :baz=>5}}
71
+ end
72
+
73
+ it "should create new nested hashes" do
74
+ h={:foo=>{:bar=>10}}
75
+ h.store_in(:foo, :baz, :goo, 5)
76
+ h.should == {:foo=>{:bar=>10, :baz=>{:goo=>5}}}
77
+ end
78
+
79
+ it "should store in mixed array hash structure" do
80
+ s=[nil,{:foo=>[1,2]}]
81
+ s.store_in(1,:foo,2,3)
82
+ s.should == [nil,{:foo=>[1,2,3]}]
83
+ end
84
+
85
+ it "should create new array levels after the type of the last level" do
86
+ s=[nil,{:foo=>[1,2]}]
87
+ s.store_in(1,:foo,2,2,3)
88
+ s.should == [nil,{:foo=>[1,2,[nil,nil,3]]}]
89
+ end
90
+
91
+ it "should create new hash levels after the type of the last level" do
92
+ s=[nil,{:foo=>[1,2,{:bar=>5}]}]
93
+ s.store_in(1,:foo,2,:baz,:goo,7)
94
+ s.should == [nil,{:foo=>[1,2,{:bar=>5,:baz=>{:goo=>7}}]}]
95
+ end
96
+
97
+ it "should allow a block to create new levels" do
98
+ s=[]
99
+ s.store_in(1,2,3){|rx_key_stack| {}}
100
+ s.should == [nil,{2=>3}]
101
+ end
102
+ end
103
+ end
data/spec/spec.opts ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,9 @@
1
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
2
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
3
+ require 'fetch_in'
4
+ require 'spec'
5
+ require 'spec/autorun'
6
+
7
+ Spec::Runner.configure do |config|
8
+ config.mock_with :rr
9
+ end
metadata ADDED
@@ -0,0 +1,100 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fetch_in
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 1
8
+ - 0
9
+ version: 0.1.0
10
+ platform: ruby
11
+ authors:
12
+ - mccraig mccraig of the clan mccraig
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2010-04-22 00:00:00 +01:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: rspec
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ segments:
28
+ - 1
29
+ - 2
30
+ - 9
31
+ version: 1.2.9
32
+ type: :development
33
+ version_requirements: *id001
34
+ - !ruby/object:Gem::Dependency
35
+ name: rr
36
+ prerelease: false
37
+ requirement: &id002 !ruby/object:Gem::Requirement
38
+ requirements:
39
+ - - ">="
40
+ - !ruby/object:Gem::Version
41
+ segments:
42
+ - 0
43
+ - 10
44
+ - 5
45
+ version: 0.10.5
46
+ type: :development
47
+ version_requirements: *id002
48
+ description: fetch values from nested associative structures without worring about nils, a la clojure's get-in
49
+ email: mccraigmccraig@googlemail.com
50
+ executables: []
51
+
52
+ extensions: []
53
+
54
+ extra_rdoc_files:
55
+ - LICENSE
56
+ - README.rdoc
57
+ files:
58
+ - .document
59
+ - .gitignore
60
+ - LICENSE
61
+ - README.rdoc
62
+ - Rakefile
63
+ - VERSION
64
+ - lib/fetch_in.rb
65
+ - spec/fetch_in_spec.rb
66
+ - spec/spec.opts
67
+ - spec/spec_helper.rb
68
+ has_rdoc: true
69
+ homepage: http://github.com/mccraigmccraig/fetch_in
70
+ licenses: []
71
+
72
+ post_install_message:
73
+ rdoc_options:
74
+ - --charset=UTF-8
75
+ require_paths:
76
+ - lib
77
+ required_ruby_version: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ segments:
82
+ - 0
83
+ version: "0"
84
+ required_rubygems_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ segments:
89
+ - 0
90
+ version: "0"
91
+ requirements: []
92
+
93
+ rubyforge_project:
94
+ rubygems_version: 1.3.6
95
+ signing_key:
96
+ specification_version: 3
97
+ summary: simple value fetching in nested associative structures
98
+ test_files:
99
+ - spec/fetch_in_spec.rb
100
+ - spec/spec_helper.rb