reality-generators 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7679877e032f2d62e74287861197e3bd37f398c6
+  data.tar.gz: 61eb90fff98fb5be6bf5d44294053130a59b1f37
+SHA512:
+  metadata.gz: 00a7962634b8441945b234bc75b4359143de2997656ada6452216d2df037b6609c6c3b0b1c76e491e676c653de1355d80d79ff9cdb585826c687b0e7633df3ec
+  data.tar.gz: 9d21cb01a34549f6293a40df37bae961dfd5cd5242df5f8996ca4ffb299a644421f2a6d28cd6a7aa9d5df576b693f2570fdd56d9184a35f46b8caec039fead09

data/.gitattributes

@@ -0,0 +1,6 @@
+* -text
+*.rb text -crlf -binary
+*.rdoc text -crlf -binary
+*.textile text -crlf -binary
+*.txt text -crlf -binary
+*.erb text -crlf -binary

data/.gitignore

@@ -0,0 +1,8 @@
+*.iml
+/*.ipr
+/*.iws
+/.rakeTasks
+/Gemfile.lock
+/patch.diff
+/pkg
+/rdoc

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.1
+  - jruby-19mode
+jdk:
+  - oraclejdk7
+git:
+  depth: 10
+before_install:
+  - gem update bundler

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How to Contribute
+
+Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+
+* Fork it
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Commit your changes (`git commit -am 'Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create new Pull Request
+
+Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+
+## How to speed the merging of pull requests
+
+* Describe your changes in the CHANGELOG.
+* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Make commits of logical units.
+* Ensure your commit messages help others understand what you are doing and why.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Maintain the same code style.
+* Maintain the same level of test coverage or improve it.
+
+## Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '= 0.9.2.2'

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,61 @@
+# reality-generators
+
+[![Build Status](https://secure.travis-ci.org/realityforge/reality-generators.png?branch=master)](http://travis-ci.org/realityforge/reality-generators)
+
+A basic toolkit for abstracting the generation of files from model objects. These classes
+were extracted from several existing toolkits, primarily [Domgen](https://github.com/realityforge/domgen).
+All of these toolkits have mechanisms for constructing model objects that were then passed to
+the generators framework that generated one or more files from the model object.
+
+The framework consists of the following elements:
+
+## TemplateSets
+
+A `TemplateSet` is a named container for templates. It also declares dependencies on other `TemplateSet`
+instances and provides a description.
+
+## Templates
+
+Templates are the basic element of the framework. They take a model object and emit one or more files
+from the model object. There are different types of templates based on the technology used to perform
+the generation. These templates types included in the base framework include;
+
+* `ErbTemplate` - Output is generated using an `ERB` template. The model object is supplied as an instance
+  method in the templates context.
+* `RubyTemplate` - Output is generated by loading a ruby file to define a module and calling a method 
+  supplying the model object as a parameter. The method returns the file contents as a string.
+
+Templates are typically defined as rules such as; all models of a particular type, matching a particular
+criteria should generate files using template X. Templates typically configure these other characteristics
+but these vary based on the particular template type but commonly include:
+
+* `target` - A short name that selects the type of model objects against which template should
+  run. See below for more details.
+* `guard` - A snippet of ruby code that is evaluated to determine whether the template should run
+  on a particular model object instance.
+* `facets` - A list of `facets` that must be enabled on the model object instance for the template
+  to be applied. This is in effect a standardized `guard`. Almost all templates will define a list
+  of required `facets` but very few will supply a custom `guard` so that the `facets` attribute 
+  is just shorthand for a common pattern.
+* `output_filename_pattern` - A ruby string that is evaluated to determine the output filename for
+  a particular model object instance. This is only applicable for templates that generate a single file.
+* `target` - A short name that selects the type of model objects against which template should
+  run. See below for more details.
+* `template_filename` - The filename of the file that template loads if it loads one. 
+
+## Targets
+
+Targets define the type of model objects that a template can be applied to. The target type is defined
+using a `Symbol` or `String` and not a classname and these are typically short, semantic names that make
+sense in the host framework. i.e. Targets names may include concepts such as `:entity`, `:attribute`
+`:component` etc. It is typically the responsibility of the host framework to ensure that the correct
+model objects are passed to the template.
+
+The target name is also used as the name under which the model object is bound. This is used when evaluating
+`output_filename_pattern` or `guard` as well as in templates like `erb` templates.
+
+## Helpers
+
+A `Helper` is simply a module that is mixed into the rendering context when evaluating attributes such
+as `output_filename_pattern` or `guard` as well as in templates like `erb` templates. Helpers are a useful
+mechanism for extracting complex or duplicated code from multiple templates.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+desc 'Default Task'
+task :default => [:test, :build]
+
+desc 'Test Task'
+Rake::TestTask.new do |t|
+  files = FileList['test/helper.rb', 'test/**/test_*.rb']
+  t.loader = :rake
+  t.test_files = files
+  t.libs << '.'
+  t.warning = true
+end

data/lib/reality/generators/core.rb

@@ -0,0 +1,19 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality #nodoc
+  module Generators #nodoc
+    Reality::Logging.configure(Generators, ::Logger::WARN)
+  end
+end

data/lib/reality/generators/erb_template.rb

@@ -0,0 +1,48 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality #nodoc
+  module Generators #nodoc
+
+    class ErbTemplate < Reality::Generators::SingleFileOutputTemplate
+      def initialize(template_set, facets, target, template_key, output_filename_pattern, helpers, options = {})
+        super(template_set, facets, target, template_key, output_filename_pattern, helpers, options)
+        @template = nil
+      end
+
+      def template_filename
+        template_key
+      end
+
+      protected
+
+      def render_to_string(context_binding)
+        self.erb_instance.result(context_binding)
+      end
+
+      def template_extension
+        'erb'
+      end
+
+      def erb_instance
+        unless @template
+          Generators.error("Unable to locate file #{template_filename} for template #{name}") unless File.exist?(template_filename)
+          @template = ERB.new(IO.read(template_filename), nil, '-')
+          @template.filename = template_filename
+        end
+        @template
+      end
+    end
+  end
+end

data/lib/reality/generators/render_context.rb

@@ -0,0 +1,47 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality #nodoc
+  module Generators
+    class RenderContext
+      def initialize
+        @helpers = []
+        @variables = {}
+      end
+
+      def add_helper(module_type)
+        @helpers << module_type
+      end
+
+      def set_local_variable(key, value)
+        @variables[key] = value
+      end
+
+      def context_binding
+        clazz = Class.new
+        @helpers.each do |helper|
+          clazz.send :include, helper
+        end
+        context = clazz.new
+        @variables.each_pair do |k, v|
+          context.instance_eval "def #{k}; @#{k}; end"
+          context.instance_variable_set "@#{k}".to_sym, v
+        end
+        context.instance_eval do
+          return binding
+        end
+      end
+    end
+  end
+end

data/lib/reality/generators/ruby_template.rb

@@ -0,0 +1,62 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality #nodoc
+  module Generators #nodoc
+
+    # A module where all ruby templates are defined
+    module RubyTemplates
+    end
+
+    class RubyTemplate < Reality::Generators::SingleFileOutputTemplate
+      def initialize(template_set, facets, target, template_key, output_filename_pattern, helpers, options = {})
+        super(template_set, facets, target, template_key, output_filename_pattern, helpers, options)
+        @template = nil
+      end
+
+      def template_filename
+        template_key
+      end
+
+      protected
+
+      def template_extension
+        'rb'
+      end
+
+      def render_to_string(context_binding)
+        context_binding.eval("#{ruby_instance.name}.generate(#{target.to_s.gsub(/^.*\./, '')})")
+      end
+
+      def ruby_instance
+        unless @template
+          Generators.error("Unable to locate file #{template_filename} for template #{name}") unless File.exist?(template_filename)
+
+          template_name = Reality::Naming.pascal_case(template_filename.gsub(/.*\/([^\/]+)\/templates\/(.+)\.rb$/, '\1_\2').gsub('.', '_').gsub('/', '_'))
+
+          Generators::RubyTemplates.class_eval "module #{template_name}\n end"
+          template = Generators::RubyTemplates.const_get(template_name)
+          template.class_eval <<-CODE
+            class << self
+              #{IO.read(template_filename)}
+            end
+          CODE
+
+          @template = template
+        end
+        @template
+      end
+    end
+  end
+end

data/lib/reality/generators/target_manager.rb

@@ -0,0 +1,100 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality #nodoc
+  module Generators #nodoc
+
+    # A descriptor describing a type in the system that a template can be generated from.
+    class Target
+      def initialize(target_manager, key, container_key, options)
+        @target_manager = target_manager
+        @key = key.to_sym
+        @facet_key = options[:facet_key]
+        @qualified_key = (@facet_key.nil? ? @key : "#{@facet_key}.#{@key}").to_sym
+        @access_method = options[:access_method] || Reality::Naming.pluralize(@key)
+        @container_key = container_key.nil? ? nil : container_key.to_sym
+
+        if @container_key && !target_manager.target_by_key?(@container_key)
+          raise "Target '#{key}' defines container as '#{@container_key}' but no such target exists."
+        end
+
+        @target_manager.send(:register_target, self)
+      end
+
+      attr_reader :target_manager
+      attr_reader :qualified_key
+      attr_reader :key
+      attr_reader :container_key
+      attr_reader :access_method
+      attr_reader :facet_key
+
+      def standard?
+        facet_key.nil?
+      end
+    end
+
+    class TargetManager
+      attr_reader :container
+
+      def initialize(container)
+        @container = container
+      end
+
+      def is_target_valid?(key)
+        target_map.keys.include?(key)
+      end
+
+      def target_keys
+        target_map.keys
+      end
+
+      def targets
+        target_map.values
+      end
+
+      def target_by_key?(key)
+        !!target_map[key]
+      end
+
+      def target_by_key(key)
+        target = target_map[key.to_sym]
+        raise "Can not find target with key '#{key}'" unless target
+        target
+      end
+
+      def target(key, container_key = nil, options = {})
+        Target.new(self, key, container_key, options)
+      end
+
+      def targets_by_container(container_key)
+        target_map.values.select { |target| target.container_key == container_key }
+      end
+
+      def reset_targets
+        target_map.clear
+      end
+
+      private
+
+      def register_target(target)
+        raise "Attempting to redefine target #{target.qualified_key}" if target_map[target.qualified_key]
+        target_map[target.qualified_key] = target
+      end
+
+      def target_map
+        @target_map ||= {}
+      end
+    end
+  end
+end