rash 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 +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +58 -0
- data/Rakefile +46 -0
- data/VERSION +1 -0
- data/lib/rash.rb +37 -0
- data/spec/rash_spec.rb +70 -0
- data/spec/spec.opts +1 -0
- data/spec/spec_helper.rb +9 -0
- metadata +85 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Tom Cocca
|
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,58 @@
|
|
1
|
+
= rash
|
2
|
+
|
3
|
+
Rash is an extension to Hashie ( http://github.com/intridea/hashie )
|
4
|
+
|
5
|
+
Rash subclasses Hashie::Mash to convert all keys in the hash to underscore
|
6
|
+
|
7
|
+
The purpose of this is when working w/ Java (or any other apis) that return hashes (including nested) that have camelCased keys
|
8
|
+
|
9
|
+
You will now be able to access those keys through underscored key names (camelCase still available)
|
10
|
+
|
11
|
+
== Usage
|
12
|
+
|
13
|
+
@rash = Hashie::Rash.new({
|
14
|
+
"varOne" => 1,
|
15
|
+
"two" => 2,
|
16
|
+
:three => 3,
|
17
|
+
:varFour => 4,
|
18
|
+
"fiveHumpHumps" => 5,
|
19
|
+
:nested => {
|
20
|
+
"NestedOne" => "One",
|
21
|
+
:two => "two",
|
22
|
+
"nested_three" => "three"
|
23
|
+
},
|
24
|
+
"nestedTwo" => {
|
25
|
+
"nested_two" => 22,
|
26
|
+
:nestedThree => 23
|
27
|
+
}
|
28
|
+
})
|
29
|
+
|
30
|
+
@rash.var_one # => 1
|
31
|
+
@rash.two # => 2
|
32
|
+
@rash.three # => 3
|
33
|
+
@rash.var_four # => 4
|
34
|
+
@rash.five_hump_humps # => 5
|
35
|
+
@rash.nested.nested_one # => "One"
|
36
|
+
@rash.nested.two # => "two"
|
37
|
+
@rash.nested.nested_three # => "three"
|
38
|
+
@rash.nested_two.nested_two # => 22
|
39
|
+
@rash.nested_two # => 23
|
40
|
+
|
41
|
+
== Note on Patches/Pull Requests
|
42
|
+
|
43
|
+
* Fork the project.
|
44
|
+
* Make your feature addition or bug fix.
|
45
|
+
* Add tests for it. This is important so I don't break it in a
|
46
|
+
future version unintentionally.
|
47
|
+
* Commit, do not mess with rakefile, version, or history.
|
48
|
+
(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)
|
49
|
+
* Send me a pull request. Bonus points for topic branches.
|
50
|
+
|
51
|
+
== Copyright
|
52
|
+
|
53
|
+
Copyright (c) 2010 Tom Coccca. See LICENSE for details.
|
54
|
+
|
55
|
+
=== Acknowledgements
|
56
|
+
|
57
|
+
http://github.com/intridea for Hashie
|
58
|
+
http://github.com/mislav for contributions to Rash
|
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 = "rash"
|
8
|
+
gem.summary = %Q{simple extension to Hashie::Mash for rubyified keys}
|
9
|
+
gem.description = %Q{simple extension to Hashie::Mash for rubyified keys, all keys are converted to underscore to eliminate horrible camelCasing}
|
10
|
+
gem.email = "tom.cocca@gmail.com"
|
11
|
+
gem.homepage = "http://github.com/tcocca/rash"
|
12
|
+
gem.authors = ["tcocca"]
|
13
|
+
gem.add_dependency "hashie", ">= 0.3.1"
|
14
|
+
gem.add_development_dependency "rspec", ">= 1.2.9"
|
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 = "rash #{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/rash.rb
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'hashie'
|
3
|
+
|
4
|
+
module Hashie
|
5
|
+
class Rash < Mash
|
6
|
+
|
7
|
+
protected
|
8
|
+
|
9
|
+
def convert_key(key) #:nodoc:
|
10
|
+
underscore_string(key.to_s)
|
11
|
+
end
|
12
|
+
|
13
|
+
# converts a camel_cased string to a underscore string
|
14
|
+
# Same way ActiveSupport does string.underscore
|
15
|
+
def underscore_string(str)
|
16
|
+
str.to_s.gsub(/::/, '/').
|
17
|
+
gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
|
18
|
+
gsub(/([a-z\d])([A-Z])/,'\1_\2').
|
19
|
+
tr("-", "_").
|
20
|
+
downcase
|
21
|
+
end
|
22
|
+
|
23
|
+
def convert_value(val, duping=false) #:nodoc:
|
24
|
+
obj = super
|
25
|
+
obj = self.class.new(obj) if Hashie::Mash === obj
|
26
|
+
obj
|
27
|
+
end
|
28
|
+
|
29
|
+
def initializing_reader(key)
|
30
|
+
ck = convert_key(key)
|
31
|
+
regular_writer(ck, self.class.new) unless key?(ck)
|
32
|
+
regular_reader(ck)
|
33
|
+
end
|
34
|
+
|
35
|
+
end
|
36
|
+
|
37
|
+
end
|
data/spec/rash_spec.rb
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
|
2
|
+
|
3
|
+
describe Hashie::Rash do
|
4
|
+
subject {
|
5
|
+
Hashie::Rash.new({
|
6
|
+
"varOne" => 1,
|
7
|
+
"two" => 2,
|
8
|
+
:three => 3,
|
9
|
+
:varFour => 4,
|
10
|
+
"fiveHumpHumps" => 5,
|
11
|
+
:nested => {
|
12
|
+
"NestedOne" => "One",
|
13
|
+
:two => "two",
|
14
|
+
"nested_three" => "three"
|
15
|
+
},
|
16
|
+
"nestedTwo" => {
|
17
|
+
"nested_two" => 22,
|
18
|
+
:nestedThree => 23
|
19
|
+
}
|
20
|
+
})
|
21
|
+
}
|
22
|
+
|
23
|
+
it { should be_a(Hashie::Mash) }
|
24
|
+
|
25
|
+
it "should create a new rash where all the keys are underscored instead of camelcased" do
|
26
|
+
subject.var_one.should == 1
|
27
|
+
subject.two.should == 2
|
28
|
+
subject.three.should == 3
|
29
|
+
subject.var_four.should == 4
|
30
|
+
subject.five_hump_humps.should == 5
|
31
|
+
subject.nested.should be_a(Hashie::Rash)
|
32
|
+
subject.nested.nested_one.should == "One"
|
33
|
+
subject.nested.two.should == "two"
|
34
|
+
subject.nested.nested_three.should == "three"
|
35
|
+
subject.nested_two.should be_a(Hashie::Rash)
|
36
|
+
subject.nested_two.nested_two.should == 22
|
37
|
+
subject.nested_two.nested_three.should == 23
|
38
|
+
end
|
39
|
+
|
40
|
+
it "should allow camelCased accessors" do
|
41
|
+
subject.varOne.should == 1
|
42
|
+
subject.varOne = "once"
|
43
|
+
subject.varOne.should == "once"
|
44
|
+
subject.var_one.should == "once"
|
45
|
+
end
|
46
|
+
|
47
|
+
it "should allow camelCased accessors on nested hashes" do
|
48
|
+
subject.nested.nestedOne.should == "One"
|
49
|
+
subject.nested.nestedOne = "once"
|
50
|
+
subject.nested.nested_one.should == "once"
|
51
|
+
end
|
52
|
+
|
53
|
+
it "should merge well with a Mash" do
|
54
|
+
subject.update Hashie::Mash.new(
|
55
|
+
:nested => {:fourTimes => "a charm"},
|
56
|
+
:nested3 => {:helloWorld => "hi"}
|
57
|
+
)
|
58
|
+
|
59
|
+
subject.nested.four_times.should == "a charm"
|
60
|
+
subject.nested.fourTimes.should == "a charm"
|
61
|
+
subject.nested3.hello_world.should == "hi"
|
62
|
+
subject.nested3.helloWorld.should == "hi"
|
63
|
+
end
|
64
|
+
|
65
|
+
it "should allow initializing reader" do
|
66
|
+
subject.nested3!.helloWorld = "hi"
|
67
|
+
subject.nested3.hello_world.should == "hi"
|
68
|
+
end
|
69
|
+
|
70
|
+
end
|
data/spec/spec.opts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,85 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rash
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- tcocca
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2010-08-26 00:00:00 -04:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: hashie
|
17
|
+
type: :runtime
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: 0.3.1
|
24
|
+
version:
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: rspec
|
27
|
+
type: :development
|
28
|
+
version_requirement:
|
29
|
+
version_requirements: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 1.2.9
|
34
|
+
version:
|
35
|
+
description: simple extension to Hashie::Mash for rubyified keys, all keys are converted to underscore to eliminate horrible camelCasing
|
36
|
+
email: tom.cocca@gmail.com
|
37
|
+
executables: []
|
38
|
+
|
39
|
+
extensions: []
|
40
|
+
|
41
|
+
extra_rdoc_files:
|
42
|
+
- LICENSE
|
43
|
+
- README.rdoc
|
44
|
+
files:
|
45
|
+
- .document
|
46
|
+
- .gitignore
|
47
|
+
- LICENSE
|
48
|
+
- README.rdoc
|
49
|
+
- Rakefile
|
50
|
+
- VERSION
|
51
|
+
- lib/rash.rb
|
52
|
+
- spec/rash_spec.rb
|
53
|
+
- spec/spec.opts
|
54
|
+
- spec/spec_helper.rb
|
55
|
+
has_rdoc: true
|
56
|
+
homepage: http://github.com/tcocca/rash
|
57
|
+
licenses: []
|
58
|
+
|
59
|
+
post_install_message:
|
60
|
+
rdoc_options:
|
61
|
+
- --charset=UTF-8
|
62
|
+
require_paths:
|
63
|
+
- lib
|
64
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: "0"
|
69
|
+
version:
|
70
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: "0"
|
75
|
+
version:
|
76
|
+
requirements: []
|
77
|
+
|
78
|
+
rubyforge_project:
|
79
|
+
rubygems_version: 1.3.5
|
80
|
+
signing_key:
|
81
|
+
specification_version: 3
|
82
|
+
summary: simple extension to Hashie::Mash for rubyified keys
|
83
|
+
test_files:
|
84
|
+
- spec/rash_spec.rb
|
85
|
+
- spec/spec_helper.rb
|