demeter 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. data/LICENSE.txt +202 -0
  2. data/README +49 -0
  3. data/Rakefile +39 -0
  4. data/TODO.txt +3 -0
  5. data/lib/demeter.rb +27 -0
  6. data/spec/demeter_spec.rb +217 -0
  7. metadata +61 -0
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README ADDED
@@ -0,0 +1,49 @@
1
+ = Demeter
2
+
3
+ A simple way to apply the Law of Demeter to your objects.
4
+
5
+ == Usuage
6
+
7
+ The usuage is very straightforward. You only need to extend one module and use one method.
8
+
9
+ == Example
10
+
11
+ ------------------------------------
12
+ require 'demeter'
13
+ class Customer
14
+ attr_accessor :name
15
+ end
16
+
17
+ class Manager
18
+ attr_accessor :type
19
+ end
20
+
21
+ class Account
22
+ extend Demeter
23
+ attr_accessor :customer, :manager
24
+ demeter :customer, :manager
25
+ end
26
+
27
+ c = Customer.new
28
+ c.name = "Emerson"
29
+
30
+ m = Manager.new
31
+ m.type = "General"
32
+
33
+ a = Account.new
34
+ a.customer = c
35
+ a.manager = m
36
+ puts a.customer_name
37
+ puts a.manager_type
38
+ ------------------------------------
39
+ It should print "Emerson" at console
40
+ And should print "General" at console
41
+
42
+ == Credits
43
+ Author: Emerson Macedo
44
+ email: emerleite at gmail dot com
45
+ twitter: emerleite
46
+ github: github dot com slash emerleite
47
+
48
+ == Licence
49
+ See LICENCE.txt
data/Rakefile ADDED
@@ -0,0 +1,39 @@
1
+ require "spec/rake/spectask"
2
+ require "rake/gempackagetask"
3
+
4
+ spec = Gem::Specification.new do |s|
5
+ s.name = %q{demeter}
6
+ s.version = "1.0.2"
7
+ s.authors = ['Emerson Macedo']
8
+ s.email = ['emerleite@gmail.com']
9
+ s.date = %q{2009-11-11}
10
+ s.homepage = 'http://github.com/emerleite/demeter'
11
+
12
+ s.summary = %q{An easy way to apply law of demeter to your objects}
13
+ s.description = %q{An easy way to apply law of demeter to your objects}
14
+ s.require_paths = ["lib"]
15
+ s.rubygems_version = %q{1.3.5}
16
+
17
+ s.files = ['Rakefile',
18
+ 'README',
19
+ 'LICENSE.txt',
20
+ 'TODO.txt',
21
+ 'lib/demeter.rb',
22
+ 'spec/demeter_spec.rb',
23
+ ]
24
+ end
25
+
26
+ Rake::GemPackageTask.new(spec) do |pkg|
27
+ pkg.need_zip = true
28
+ pkg.need_tar = true
29
+ end
30
+
31
+ Spec::Rake::SpecTask.new do |t|
32
+ t.libs << 'lib'
33
+ t.spec_files = FileList['spec/*_spec.rb']
34
+ t.rcov = true
35
+ t.rcov_opts = %w{--exclude spec,rcov}
36
+ t.fail_on_error = false
37
+ end
38
+
39
+ task :default => [:spec]
data/TODO.txt ADDED
@@ -0,0 +1,3 @@
1
+ - Allow more than one level of demeter
2
+ - Create acessors when not yet created
3
+ - Rdoc
data/lib/demeter.rb ADDED
@@ -0,0 +1,27 @@
1
+ module Demeter
2
+ def self.demeter_objects
3
+ @@demeter_objects
4
+ end
5
+
6
+ def self.extended(base)
7
+ @@demeter_objects = @@demeter_objects ||= Hash.new
8
+ @@demeter_objects[base.to_s.to_sym] = Array.new
9
+ base.send(:include, DemeterMethods)
10
+ end
11
+
12
+ def demeter(*symbols)
13
+ symbols.each do |symbol|
14
+ @@demeter_objects[self.to_s.to_sym] << symbol
15
+ end
16
+ end
17
+
18
+ module DemeterMethods
19
+ def method_missing(method, *args)
20
+ message_split = method.to_s.split("_")
21
+ raise NoMethodError if Demeter.demeter_objects[self.class.to_s.to_sym].select { |object| message_split.first.to_sym == object }.length == 0
22
+ object = self.send(message_split.first)
23
+ message_split.delete message_split.first
24
+ object.send(message_split.join("_"))
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,217 @@
1
+ require 'spec'
2
+ require 'lib/demeter'
3
+
4
+ describe Demeter do
5
+ before do
6
+ AClass = Class.new
7
+ AClass.send(:extend, Demeter)
8
+
9
+ Person = Class.new
10
+ Animal = Class.new
11
+ end
12
+
13
+ it 'Should provide demeter class method when module extended' do
14
+ AClass.respond_to?(:demeter).should be_true
15
+ end
16
+
17
+ it 'Should receive an object when demeter' do
18
+ AClass.demeter :some_object
19
+ end
20
+
21
+ it 'Should get value for name when invoke person_name' do
22
+ Person.send(:attr_accessor, :name)
23
+
24
+ AClass.send(:attr_accessor, :person)
25
+ AClass.demeter :person
26
+ instance = AClass.new
27
+
28
+ person = Person.new
29
+ person.name = "emerson"
30
+
31
+ instance.person = person
32
+ instance.person_name.should be_eql("emerson")
33
+
34
+ person2 = Person.new
35
+ person2.name = "patricia"
36
+
37
+ instance.person = person2
38
+ instance.person_name.should be_eql("patricia")
39
+ end
40
+
41
+ it 'Should get value for gender when invoke person_gender' do
42
+ Person.send(:attr_accessor, :gender)
43
+
44
+ AClass.send(:attr_accessor, :person)
45
+ AClass.demeter :person
46
+ instance = AClass.new
47
+
48
+ person = Person.new
49
+ person.gender = "male"
50
+
51
+ instance.person = person
52
+ instance.person_gender.should be_eql("male")
53
+
54
+ person2 = Person.new
55
+ person2.gender = "female"
56
+
57
+ instance.person = person2
58
+ instance.person_gender.should be_eql("female")
59
+ end
60
+
61
+ it 'Should allow attribute with undescore' do
62
+ Person.send(:attr_accessor, :phone_number)
63
+ Person.send(:attr_accessor, :three_undescore_method)
64
+
65
+ AClass.send(:attr_accessor, :person)
66
+ AClass.demeter :person
67
+ instance = AClass.new
68
+
69
+ person = Person.new
70
+ person.phone_number = 99999999
71
+ person.three_undescore_method = "nothing"
72
+
73
+ instance.person = person
74
+ instance.person_phone_number.should be_eql(99999999)
75
+ instance.person_three_undescore_method.should be_eql("nothing")
76
+ end
77
+
78
+ it 'Should raise error if object is not demetered' do
79
+ Person.send(:attr_accessor, :phone_number)
80
+
81
+ AClass.send(:attr_accessor, :person)
82
+ AClass.demeter :animal
83
+ instance = AClass.new
84
+
85
+ person = Person.new
86
+ person.phone_number = 99999999
87
+
88
+ instance.person = person
89
+ lambda {instance.person_phone_number}.should raise_error(NoMethodError)
90
+ end
91
+
92
+ it 'Should demeter 2 attribute objects' do
93
+
94
+ Animal.send(:attr_accessor, :name)
95
+
96
+ Person.send(:attr_accessor, :phone_number)
97
+
98
+ AClass.send(:attr_accessor, :person)
99
+ AClass.send(:attr_accessor, :animal)
100
+ AClass.demeter :person
101
+ AClass.demeter :animal
102
+
103
+ instance = AClass.new
104
+
105
+ person = Person.new
106
+ person.phone_number = 99999999
107
+
108
+ animal = Animal.new
109
+ animal.name = "marley"
110
+
111
+ instance.person = person
112
+ instance.animal = animal
113
+ instance.person_phone_number.should be_eql(99999999)
114
+ instance.animal_name.should be_eql("marley")
115
+ end
116
+
117
+ it 'Should allow to extend Demeter in 2 classes' do
118
+ Animal.send(:attr_accessor, :name)
119
+
120
+ Person.send(:attr_accessor, :phone_number)
121
+
122
+ AClass.send(:attr_accessor, :person)
123
+ AClass.send(:attr_accessor, :animal)
124
+ AClass.demeter :person
125
+ AClass.demeter :animal
126
+
127
+ ASecondClass = AClass
128
+
129
+ instance = AClass.new
130
+
131
+ person = Person.new
132
+ person.phone_number = 99999999
133
+
134
+ animal = Animal.new
135
+ animal.name = "marley"
136
+
137
+ instance.person = person
138
+ instance.animal = animal
139
+ instance.person_phone_number.should be_eql(99999999)
140
+ instance.animal_name.should be_eql("marley")
141
+
142
+ instance2 = ASecondClass.new
143
+
144
+ person2 = Person.new
145
+ person2.phone_number = 88888888
146
+
147
+ animal2 = Animal.new
148
+ animal2.name = "fox"
149
+
150
+ instance2.person = person2
151
+ instance2.animal = animal2
152
+ instance2.person_phone_number.should be_eql(88888888)
153
+ instance2.animal_name.should be_eql("fox")
154
+ end
155
+
156
+ it 'Should demeter 2 attributes with one call' do
157
+ Animal.send(:attr_accessor, :name)
158
+
159
+ Person.send(:attr_accessor, :phone_number)
160
+
161
+ AClass.send(:attr_accessor, :person)
162
+ AClass.send(:attr_accessor, :animal)
163
+ AClass.demeter :person, :animal
164
+
165
+ instance = AClass.new
166
+
167
+ person = Person.new
168
+ person.phone_number = 99999999
169
+
170
+ animal = Animal.new
171
+ animal.name = "marley"
172
+
173
+ instance.person = person
174
+ instance.animal = animal
175
+ instance.person_phone_number.should be_eql(99999999)
176
+ instance.animal_name.should be_eql("marley")
177
+ end
178
+
179
+ it 'Should get value when instance attribute have diferent name' do
180
+ Person.class_eval do
181
+ define_method :initialize do |name|
182
+ @a_name = name
183
+ end
184
+ define_method :name do
185
+ @a_name
186
+ end
187
+ end
188
+
189
+ AClass.send(:attr_accessor, :person)
190
+ AClass.demeter :person
191
+ instance = AClass.new
192
+
193
+ person = Person.new "emerson"
194
+
195
+ instance.person = person
196
+ instance.person_name.should be_eql("emerson")
197
+ end
198
+
199
+ it 'Should allow override the demeter method' do
200
+ Person.send(:attr_accessor, :name)
201
+
202
+ AClass.send(:attr_accessor, :person)
203
+ AClass.demeter :person
204
+ AClass.class_eval do
205
+ define_method :person_name do
206
+ "name overrided"
207
+ end
208
+ end
209
+ instance = AClass.new
210
+
211
+ person = Person.new
212
+ person.name = "emerson"
213
+
214
+ instance.person = person
215
+ instance.person_name.should be_eql("name overrided")
216
+ end
217
+ end
metadata ADDED
@@ -0,0 +1,61 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: demeter
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.2
5
+ platform: ruby
6
+ authors:
7
+ - Emerson Macedo
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-11-11 00:00:00 -02:00
13
+ default_executable:
14
+ dependencies: []
15
+
16
+ description: An easy way to apply law of demeter to your objects
17
+ email:
18
+ - emerleite@gmail.com
19
+ executables: []
20
+
21
+ extensions: []
22
+
23
+ extra_rdoc_files: []
24
+
25
+ files:
26
+ - Rakefile
27
+ - README
28
+ - LICENSE.txt
29
+ - TODO.txt
30
+ - lib/demeter.rb
31
+ - spec/demeter_spec.rb
32
+ has_rdoc: true
33
+ homepage: http://github.com/emerleite/demeter
34
+ licenses: []
35
+
36
+ post_install_message:
37
+ rdoc_options: []
38
+
39
+ require_paths:
40
+ - lib
41
+ required_ruby_version: !ruby/object:Gem::Requirement
42
+ requirements:
43
+ - - ">="
44
+ - !ruby/object:Gem::Version
45
+ version: "0"
46
+ version:
47
+ required_rubygems_version: !ruby/object:Gem::Requirement
48
+ requirements:
49
+ - - ">="
50
+ - !ruby/object:Gem::Version
51
+ version: "0"
52
+ version:
53
+ requirements: []
54
+
55
+ rubyforge_project:
56
+ rubygems_version: 1.3.5
57
+ signing_key:
58
+ specification_version: 3
59
+ summary: An easy way to apply law of demeter to your objects
60
+ test_files: []
61
+