reality-model 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: beecc5c47e720929fb5b7c533c1d50600e8925fb
4
+ data.tar.gz: 9b08872922ff1cdcbf412dc4e5681f2aff2b6798
5
+ SHA512:
6
+ metadata.gz: 20ed9a594e568ed7bb43fbecb1741f8b4d004db5d5baa3252ef9eb0884d8041e4ad5343605f63dc2a95a311dca79ad4584585f2ffa9237124291fdae43be6325
7
+ data.tar.gz: edbddfbe1eb5f7dd92ec980d7424cf761fd0e86406bf38c8daaa9baafabc6d5a22e9dc9d5c9f9ee4608a55af8a53f6f3ba5381cc323b4c94065c3192c7301b79
data/.gitattributes ADDED
@@ -0,0 +1,6 @@
1
+ * -text
2
+ *.rb text -crlf -binary
3
+ *.rdoc text -crlf -binary
4
+ *.textile text -crlf -binary
5
+ *.txt text -crlf -binary
6
+ *.erb text -crlf -binary
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ *.iml
2
+ /*.ipr
3
+ /*.iws
4
+ /.rakeTasks
5
+ /Gemfile.lock
6
+ /patch.diff
7
+ /pkg
8
+ /rdoc
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.3.1
data/.travis.yml ADDED
@@ -0,0 +1,11 @@
1
+ language: ruby
2
+ sudo: false
3
+ rvm:
4
+ - 2.3.1
5
+ - jruby-19mode
6
+ jdk:
7
+ - oraclejdk7
8
+ git:
9
+ depth: 10
10
+ before_install:
11
+ - gem update bundler
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,26 @@
1
+ # How to Contribute
2
+
3
+ Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
4
+
5
+ * Fork it
6
+ * Create your feature branch (`git checkout -b my-new-feature`)
7
+ * Commit your changes (`git commit -am 'Add some feature'`)
8
+ * Push to the branch (`git push origin my-new-feature`)
9
+ * Create new Pull Request
10
+
11
+ Pester us if we don't get your Pull Requests merged in a timely fashion. :)
12
+
13
+ ## How to speed the merging of pull requests
14
+
15
+ * Describe your changes in the CHANGELOG.
16
+ * Give yourself some credit in the appropriate place (usually the CHANGELOG).
17
+ * Make commits of logical units.
18
+ * Ensure your commit messages help others understand what you are doing and why.
19
+ * Check for unnecessary whitespace with `git diff --check` before committing.
20
+ * Maintain the same code style.
21
+ * Maintain the same level of test coverage or improve it.
22
+
23
+ ## Additional Resources
24
+
25
+ * [General GitHub documentation](http://help.github.com/)
26
+ * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ gem 'rake', '= 0.9.2.2'
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,9 @@
1
+ # reality-model
2
+
3
+ [![Build Status](https://secure.travis-ci.org/realityforge/reality-model.png?branch=master)](http://travis-ci.org/realityforge/reality-model)
4
+
5
+ This library provides basic classes used to setup a domain model using ruby classes. The
6
+ domain model primarily consists of model elements container within other model elements.
7
+ The library has been extracted from the nine different projects and consolidated using a
8
+ single model.
9
+
data/Rakefile ADDED
@@ -0,0 +1,18 @@
1
+ require 'bundler'
2
+ Bundler::GemHelper.install_tasks
3
+
4
+ require 'rake'
5
+ require 'rubygems/package_task'
6
+ require 'rake/testtask'
7
+
8
+ desc 'Default Task'
9
+ task :default => [:test, :build]
10
+
11
+ desc 'Test Task'
12
+ Rake::TestTask.new do |t|
13
+ files = FileList['test/helper.rb', 'test/**/test_*.rb']
14
+ t.loader = :rake
15
+ t.test_files = files
16
+ t.libs << '.'
17
+ t.warning = true
18
+ end
@@ -0,0 +1,19 @@
1
+ #
2
+ # Licensed under the Apache License, Version 2.0 (the "License");
3
+ # you may not use this file except in compliance with the License.
4
+ # You may obtain a copy of the License at
5
+ #
6
+ # http://www.apache.org/licenses/LICENSE-2.0
7
+ #
8
+ # Unless required by applicable law or agreed to in writing, software
9
+ # distributed under the License is distributed on an "AS IS" BASIS,
10
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
+ # See the License for the specific language governing permissions and
12
+ # limitations under the License.
13
+ #
14
+
15
+ module Reality #nodoc
16
+ module Model #nodoc
17
+ Reality::Logging.configure(Reality::Model, ::Logger::WARN)
18
+ end
19
+ end
@@ -0,0 +1,202 @@
1
+ #
2
+ # Licensed under the Apache License, Version 2.0 (the "License");
3
+ # you may not use this file except in compliance with the License.
4
+ # You may obtain a copy of the License at
5
+ #
6
+ # http://www.apache.org/licenses/LICENSE-2.0
7
+ #
8
+ # Unless required by applicable law or agreed to in writing, software
9
+ # distributed under the License is distributed on an "AS IS" BASIS,
10
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
+ # See the License for the specific language governing permissions and
12
+ # limitations under the License.
13
+ #
14
+
15
+ module Reality #nodoc
16
+ module Model #nodoc
17
+
18
+ # A descriptor describing a base type in the system model.
19
+ class ModelElement
20
+ def initialize(repository, key, container_key, options)
21
+ Reality::Options.check(options, [:model_classname, :custom_initialize, :id_method, :access_method, :inverse_access_method], Reality::Model, 'create model element')
22
+ @repository = repository
23
+ @key = key.to_sym
24
+ @model_classname = (options[:model_classname] || Reality::Naming.pascal_case(key)).to_sym
25
+
26
+ @custom_initialize = options[:custom_initialize].nil? ? false : !!options[:custom_initialize]
27
+
28
+ @id_method = (options[:id_method] || repository.default_id_method).to_sym
29
+ @access_method = (options[:access_method] || Reality::Naming.pluralize(@key)).to_sym
30
+ @inverse_access_method = (options[:inverse_access_method] || @key).to_sym
31
+ @container_key = container_key.nil? ? nil : container_key.to_sym
32
+
33
+ {
34
+ :key => @key,
35
+ :id_method => @id_method,
36
+ :access_method => @access_method,
37
+ :inverse_access_method => @inverse_access_method,
38
+ }.each_pair do |attribute_name, value|
39
+ unless Reality::Naming.underscore?(value)
40
+ Reality::Model.error("Model Element '#{qualified_key}' has a #{attribute_name} '#{value}' that does not use the underscore naming pattern (i.e. The #{attribute_name} should be '#{Reality::Naming.underscore(value)}').")
41
+ end
42
+ end
43
+
44
+ unless Reality::Naming.pascal_case?(@model_classname)
45
+ Reality::Model.error("Model Element '#{qualified_key}' has a model_classname '#{@model_classname}' that does not use the pascal case naming pattern (i.e. The model_classname should be '#{Reality::Naming.pascal_case(@model_classname)}').")
46
+ end
47
+
48
+ if @container_key && !repository.model_element_by_key?(@container_key)
49
+ Reality::Model.error("Model Element '#{qualified_key}' defines container as '#{@container_key}' but no such model element exists.")
50
+ end
51
+
52
+ @repository.send(:register_model_element, self)
53
+
54
+ yield self if block_given?
55
+ end
56
+
57
+ attr_reader :repository
58
+ attr_reader :key
59
+ attr_reader :container_key
60
+ attr_reader :model_classname
61
+ attr_reader :id_method
62
+ attr_reader :access_method
63
+ attr_reader :inverse_access_method
64
+
65
+ def custom_initialize?
66
+ @custom_initialize
67
+ end
68
+
69
+ def qualified_key
70
+ "#{repository.key}.#{self.key}"
71
+ end
72
+
73
+ def model
74
+ self.repository.model_container.const_get(self.model_classname)
75
+ end
76
+
77
+ private
78
+
79
+ def define_ruby_class(model_container)
80
+ model_container.class_eval(build_model_code)
81
+ end
82
+
83
+ def build_model_code
84
+ # @formatter:off
85
+ code = <<-RUBY
86
+ class #{self.model_classname}
87
+ attr_reader :#{self.id_method}
88
+ RUBY
89
+ container = self.container_key.nil? ? nil : self.repository.model_element_by_key(self.container_key)
90
+ unless self.container_key.nil?
91
+ code += <<-RUBY
92
+ attr_reader :#{container.inverse_access_method}
93
+ RUBY
94
+ end
95
+ code += <<-RUBY
96
+
97
+ def #{self.custom_initialize? ? 'perform_init' : 'initialize'}(#{self.container_key.nil? ? '' : "#{container.inverse_access_method}, "}#{self.id_method}, options = {}, &block)
98
+ @#{self.id_method} = #{self.id_method}
99
+ RUBY
100
+ if self.container_key.nil?
101
+ code += <<-RUBY
102
+ #{self.repository.instance_container}.send(:register_#{self.inverse_access_method}, self)
103
+ RUBY
104
+ else
105
+ code += <<-RUBY
106
+ @#{container.inverse_access_method} = #{container.inverse_access_method}
107
+ @#{container.inverse_access_method}.send(:register_#{self.inverse_access_method}, self)
108
+ RUBY
109
+ end
110
+ if self.repository.faceted?
111
+ code += <<-RUBY
112
+ #{self.repository.facet_container}.target_manager.apply_extension(self)
113
+ RUBY
114
+ end
115
+ code += <<-RUBY
116
+ #{self.repository.log_container}.info "#{self.model_classname} '\#{#{self.id_method}}' definition started."
117
+ pre_init if respond_to?(:pre_init, true)
118
+ self.options = options
119
+ yield self if block_given?
120
+ post_init if respond_to?(:post_init, true)
121
+ #{self.repository.log_container}.info "#{self.model_classname} '\#{#{self.id_method}}' definition completed."
122
+ end
123
+ RUBY
124
+
125
+ repository.model_elements_by_container(self.key).each do |child|
126
+ code += build_child_accessor_code(child)
127
+ end
128
+
129
+ code += <<-RUBY
130
+
131
+ public
132
+
133
+ def options=(options)
134
+ options.each_pair do |k, v|
135
+ keys = k.to_s.split('.')
136
+ target = self
137
+ keys[0, keys.length - 1].each do |target_accessor_key|
138
+ target = target.send target_accessor_key.to_sym
139
+ end
140
+ begin
141
+ target.send "\#{keys.last}=", v
142
+ rescue NoMethodError
143
+ raise "Attempted to configure property \\"\#{keys.last}\\" on #{self.model_classname} but property does not exist."
144
+ end
145
+ end
146
+ end
147
+ end
148
+ RUBY
149
+
150
+ code
151
+ end
152
+
153
+ def build_child_accessor_code(child)
154
+ # @formatter:off
155
+ code = <<-RUBY
156
+
157
+ public
158
+
159
+ RUBY
160
+ unless child.custom_initialize?
161
+ code += <<-RUBY
162
+ def #{child.inverse_access_method}(#{child.id_method}, options = {}, &block)
163
+ #{child.repository.model_container}::#{child.model_classname}.new(#{child.container_key.nil? ? '' : 'self, '}#{child.id_method}, options, &block)
164
+ end
165
+
166
+ RUBY
167
+ end
168
+ code += <<-RUBY
169
+ def #{child.inverse_access_method}_by_#{child.id_method}?(#{child.id_method})
170
+ !!#{child.inverse_access_method}_map[#{child.id_method}.to_s]
171
+ end
172
+
173
+ def #{child.inverse_access_method}_by_#{child.id_method}(#{child.id_method})
174
+ #{child.inverse_access_method} = #{child.inverse_access_method}_map[#{child.id_method}.to_s]
175
+ raise "No #{child.key} with #{child.id_method} '\#{#{child.id_method}}' defined." unless #{child.inverse_access_method}
176
+ #{child.inverse_access_method}
177
+ end
178
+
179
+ def #{child.access_method}
180
+ #{child.inverse_access_method}_map.values
181
+ end
182
+
183
+ def #{child.access_method}?
184
+ !#{child.inverse_access_method}_map.empty?
185
+ end
186
+
187
+ private
188
+
189
+ def register_#{child.inverse_access_method}(#{child.inverse_access_method})
190
+ #{child.repository.log_container}.error("Attempting to register duplicate #{child.inverse_access_method} definition with #{child.id_method} '\#{#{child.id_method}}'") if #{child.inverse_access_method}_by_#{child.id_method}?(#{child.inverse_access_method}.#{child.id_method})
191
+ #{child.inverse_access_method}_map[#{child.inverse_access_method}.#{child.id_method}.to_s] = #{child.inverse_access_method}
192
+ end
193
+
194
+ def #{child.inverse_access_method}_map
195
+ @#{child.inverse_access_method}_map ||= Reality::OrderedHash.new
196
+ end
197
+ RUBY
198
+ # @formatter:on
199
+ end
200
+ end
201
+ end
202
+ end
@@ -0,0 +1,131 @@
1
+ #
2
+ # Licensed under the Apache License, Version 2.0 (the "License");
3
+ # you may not use this file except in compliance with the License.
4
+ # You may obtain a copy of the License at
5
+ #
6
+ # http://www.apache.org/licenses/LICENSE-2.0
7
+ #
8
+ # Unless required by applicable law or agreed to in writing, software
9
+ # distributed under the License is distributed on an "AS IS" BASIS,
10
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
+ # See the License for the specific language governing permissions and
12
+ # limitations under the License.
13
+ #
14
+
15
+ module Reality #nodoc
16
+ module Model #nodoc
17
+
18
+ class Repository
19
+ # A symbolic name for the system model
20
+ attr_reader :key
21
+ # The ruby module in which all the model classes will be defined
22
+ attr_reader :model_container
23
+ # The ruby module where the log methods are defined
24
+ attr_reader :log_container
25
+ # The ruby module where the facet manager is defined if any. This will be nil if faceted? returns false.
26
+ attr_reader :facet_container
27
+ # The ruby module in which all the top level instances will be stored.
28
+ attr_reader :instance_container
29
+ # The default name of the method that used as the key or identity field for model. This can
30
+ # be overriden at a model element level.
31
+ attr_reader :default_id_method
32
+
33
+ def initialize(key, model_container, options = {})
34
+ Reality::Options.check(options, [:log_container, :facet_container, :instance_container, :default_id_method], Reality::Model, 'create repository')
35
+
36
+ @key = key
37
+ @model_container = model_container
38
+ @log_container = options[:log_container] || model_container
39
+ @facet_container = options[:facet_container]
40
+ @instance_container = options[:instance_container] || model_container
41
+ @default_id_method = (options[:default_id_method] || :name).to_sym
42
+ @locked = false
43
+ if block_given?
44
+ yield self
45
+ lock!
46
+ end
47
+ end
48
+
49
+ def faceted?
50
+ !@facet_container.nil?
51
+ end
52
+
53
+ def model_element_keys
54
+ model_element_map.keys
55
+ end
56
+
57
+ def model_elements
58
+ model_element_map.values
59
+ end
60
+
61
+ def model_element_by_key?(key)
62
+ !!model_element_map[key.to_s]
63
+ end
64
+
65
+ def model_element_by_key(key)
66
+ model_element = model_element_map[key.to_s]
67
+ Reality::Model.error("Can not find model element '#{key}' in repository '#{self.key}'.") unless model_element
68
+ model_element
69
+ end
70
+
71
+ def model_element(key, container_key = nil, options = {})
72
+ ModelElement.new(self, key, container_key, options)
73
+ end
74
+
75
+ def model_elements_by_container(container_key)
76
+ model_element_map.values.select { |model_element| model_element.container_key == container_key }
77
+ end
78
+
79
+ # This method is called when the repository is finalized, after which no changes can be made.
80
+ def lock!
81
+ Reality::Model.error("Attempting to lock repository '#{key}' when repository is already locked.") if locked?
82
+ @locked = true
83
+ define_ruby_classes
84
+ define_facet_targets
85
+ define_top_level_instance_accessors
86
+ end
87
+
88
+ def locked?
89
+ @locked
90
+ end
91
+
92
+ private
93
+
94
+ def define_top_level_instance_accessors
95
+ unless self.instance_container.nil?
96
+ self.model_elements.select{|model_element| model_element.container_key.nil?}.each do |model_element|
97
+ self.instance_container.instance_eval(model_element.send(:build_child_accessor_code, model_element))
98
+ end
99
+ end
100
+ end
101
+
102
+ def define_ruby_classes
103
+ self.model_elements.each do |model_element|
104
+ model_element.send(:define_ruby_class, self.model_container)
105
+ end
106
+ end
107
+
108
+ def define_facet_targets
109
+ if self.faceted?
110
+ self.model_elements.each do |model_element|
111
+ self.facet_container.target_manager.target(model_element.model,
112
+ model_element.key,
113
+ model_element.container_key,
114
+ :access_method => model_element.access_method,
115
+ :inverse_access_method => model_element.inverse_access_method)
116
+ end
117
+ end
118
+ end
119
+
120
+ def register_model_element(model_element)
121
+ Reality::Model.error("Attempting to define model element '#{model_element.qualified_key}' when repository is locked.") if locked?
122
+ Reality::Model.error("Attempting to redefine model element '#{model_element.qualified_key}'") if model_element_map[model_element.key.to_s]
123
+ model_element_map[model_element.key.to_s] = model_element
124
+ end
125
+
126
+ def model_element_map
127
+ @model_element_map ||= {}
128
+ end
129
+ end
130
+ end
131
+ end