strict_open_struct 0.0.1

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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f58b827f4e82e5e0040523c40ec0578c82468319
4
+ data.tar.gz: 3055dd189141a68ae81d639eb461239908726dbe
5
+ SHA512:
6
+ metadata.gz: ce49ec0361161ab61ea143f9b4be9ade8f4b60b225464dc8aa8c18fc00d1376971d0d3a12b95e46ed6ec2c965e55a8c8fc79f7647d4fc989a5d3d185c7d7d308
7
+ data.tar.gz: 7dde80b12614ef34b271065df8e8af88f3765795eb9fbae61c83190dc8191c054c92f1fe6f3a756ff402a08e539e493878ff0d7dfb056a9ac249ee70a394298d
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in strict_open_struct.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 Preferral
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,32 @@
1
+ # StrictOpenStruct
2
+
3
+ A thin layer on top of OpenStruct that raises an exception when you access undefined keys rather than returning nil.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'strict_open_struct', github: 'Preferral/strict_open_struct'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ ## Usage
18
+
19
+ Use it just like you would use OpenStruct, but if you try to access a key that has not been defined, an exception will be raised.
20
+
21
+ ```ruby
22
+ data = StrictOpenStruct.new(first_name: 'Adam', last_name: 'Adamson')
23
+ data.firs_name # Typo --- raises exception instead of returning nil
24
+ ```
25
+
26
+ ## Contributing
27
+
28
+ 1. Fork it ( https://github.com/[my-github-username]/strict_open_struct/fork )
29
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
30
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
31
+ 4. Push to the branch (`git push origin my-new-feature`)
32
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,7 @@
1
+ require "bundler/gem_tasks"
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new do |t|
5
+ t.libs << "test"
6
+ t.test_files = FileList['test/*_test.rb']
7
+ end
@@ -0,0 +1,18 @@
1
+ require 'ostruct'
2
+
3
+ class StrictOpenStruct
4
+
5
+ def initialize(*args)
6
+ @open_struct = OpenStruct.new(*args)
7
+ end
8
+
9
+ # Raises NoMethodError unless the underlying OpenStruct
10
+ # responds to the method or the method is a setter
11
+ def method_missing(method_name, *args, &block)
12
+ if @open_struct.respond_to?(method_name) || method_name =~ /=$/
13
+ @open_struct.send(method_name, *args, &block)
14
+ else
15
+ fail NoMethodError, "undefined method `#{method_name}' for #{self}"
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,23 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "strict_open_struct"
7
+ spec.version = "0.0.1"
8
+ spec.authors = ["Nathan Wenneker"]
9
+ spec.email = ["nathan@preferral.com"]
10
+ spec.summary = %q{Thin layer on top of OpenStruct to raise exceptions for undefined keys.}
11
+ spec.homepage = "https://github.com/Preferral/strict_open_struct"
12
+ spec.license = "MIT"
13
+
14
+ spec.files = `git ls-files -z`.split("\x0")
15
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
16
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
17
+ spec.require_paths = ["lib"]
18
+
19
+ spec.required_ruby_version = '>= 2.0' # Might work a little farther back, but doesn't support earliest implementations of OpenStruct
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.7"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ end
@@ -0,0 +1,37 @@
1
+ require 'strict_open_struct'
2
+ require 'minitest/spec'
3
+ require 'minitest/autorun'
4
+
5
+ describe StrictOpenStruct do
6
+
7
+ it 'lets you access keys set at initialization' do
8
+ sos = StrictOpenStruct.new(first_name: 'Adam', 'last_name' => 'Adamson')
9
+ assert_equal sos.first_name, 'Adam'
10
+ assert_equal sos.last_name, 'Adamson'
11
+ end
12
+
13
+ it 'lets you access keys set later' do
14
+ sos = StrictOpenStruct.new
15
+ sos.first_name = 'Adam'
16
+ assert_equal sos.first_name, 'Adam'
17
+ end
18
+
19
+ it 'lets you access methods defined in a subclass' do
20
+ class SubStrictOpenStruct < StrictOpenStruct
21
+ def first_name
22
+ 'Adam'
23
+ end
24
+ end
25
+
26
+ ssos = SubStrictOpenStruct.new
27
+ assert_equal ssos.first_name, 'Adam'
28
+ end
29
+
30
+ it 'raises an exception if you access an undefined key' do
31
+ assert_raises NoMethodError do
32
+ StrictOpenStruct.new.blah
33
+ end
34
+ end
35
+
36
+ end
37
+
metadata ADDED
@@ -0,0 +1,82 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: strict_open_struct
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Nathan Wenneker
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-09-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description:
42
+ email:
43
+ - nathan@preferral.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - Gemfile
50
+ - LICENSE.txt
51
+ - README.md
52
+ - Rakefile
53
+ - lib/strict_open_struct.rb
54
+ - strict_open_struct.gemspec
55
+ - test/basic_test.rb
56
+ homepage: https://github.com/Preferral/strict_open_struct
57
+ licenses:
58
+ - MIT
59
+ metadata: {}
60
+ post_install_message:
61
+ rdoc_options: []
62
+ require_paths:
63
+ - lib
64
+ required_ruby_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '2.0'
69
+ required_rubygems_version: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ requirements: []
75
+ rubyforge_project:
76
+ rubygems_version: 2.4.8
77
+ signing_key:
78
+ specification_version: 4
79
+ summary: Thin layer on top of OpenStruct to raise exceptions for undefined keys.
80
+ test_files:
81
+ - test/basic_test.rb
82
+ has_rdoc: