reality-facets 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f23339993cae2804cb73979adf965189ab5cbe37
+  data.tar.gz: 70a5504ae8d6988cb6074bd6afdf32747ab21335
+SHA512:
+  metadata.gz: ad45c2f079f665cd67328bb204052187d15f8c23215726f609193502c4510bea1b23c73f22e77e4018f976fb72484c679c2e370d122b928716f09dd5c419e8e0
+  data.tar.gz: d0701c1806a08070ef1de14144449bd9350c3ae5209b18a52d9fdffdbd199767aea986d4eea5db01c5acc99f9539bc1764e6942bf1b17f20590766a12c35ea53

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,9 @@
+*.iml
+/*.ipr
+/*.iws
+/.rakeTasks
+/Gemfile.lock
+/patch.diff
+/pkg
+/rdoc
+/tmp

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,8 @@
+# reality-facets
+
+[![Build Status](https://secure.travis-ci.org/realityforge/reality-facets.png?branch=master)](http://travis-ci.org/realityforge/reality-facets)
+
+A basic toolkit for binding facets or extensions to 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 and then extending the standard
+model with "facet" information that extended the model in a specific context.

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/facets.rb

@@ -0,0 +1,25 @@
+#
+# 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.
+#
+
+require 'erb'
+
+require 'reality/core'
+require 'reality/naming'
+require 'reality/orderedhash'
+
+require 'reality/facets/core'
+require 'reality/facets/target_manager'
+require 'reality/facets/faceted_model'
+require 'reality/facets/facet'
+require 'reality/facets/facet_container'

data/lib/reality/facets/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 Facets #nodoc
+    Reality::Logging.configure(Facets, ::Logger::WARN)
+  end
+end

data/lib/reality/facets/facet.rb

@@ -0,0 +1,80 @@
+#
+# 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 Facets #nodoc
+
+    class Facet < Reality::BaseElement
+      attr_reader :facet_container
+      attr_reader :key
+      attr_accessor :required_facets
+      attr_accessor :suggested_facets
+
+      def initialize(facet_container, key, options = {}, &block)
+        options = options.dup
+        @key = key
+        @facet_container = facet_container
+        @required_facets = []
+        @suggested_facets = []
+        facet_container.send :register_facet, self
+        super(options, &block)
+        facet_container.target_manager.targets.each do |target|
+          target.extension_module.class_eval <<-RUBY
+            def #{self.key}?
+              !!(@#{self.key}_facet_enabled ||= false)
+            end
+
+            private
+
+            def _enable_facet_#{self.key}!
+              @#{self.key}_facet_enabled = true
+              (@enabled_facets ||= []) << :#{self.key}
+            end
+
+            def _disable_facet_#{self.key}!
+              @#{self.key}_facet_enabled = false
+              @facet_#{self.key} = nil
+              (@enabled_facets ||= []).delete(:#{self.key})
+            end
+          RUBY
+        end
+      end
+
+      def enhance(model_class, &block)
+        target_manager = facet_container.target_manager
+        target = target_manager.target_by_model_class(model_class)
+
+        extension_name = "#{::Reality::Naming.pascal_case(self.key)}#{model_class.name.gsub(/^.*\:\:([^\:]+)/, '\1')}Facet"
+        definitions = target_manager.container.facet_definitions
+        definitions.class_eval("class #{extension_name} < Reality.base_element(:container_key => :#{target.inverse_access_method}); end")
+        extension_instance = definitions.const_get(extension_name)
+        extension_instance.class_eval("def parent; self.#{target.inverse_access_method}; end")
+        extension_instance.class_eval(&block) if block_given?
+
+        model_extension = target.extension_module
+        model_extension.class_eval <<-RUBY
+          def #{self.key}
+            self.facet_#{self.key}
+          end
+
+          def facet_#{self.key}
+            raise "Attempted to access '#{self.key}' facet for model '#{model_class.name}' when facet disabled." unless #{self.key}?
+            @facet_#{self.key} ||= #{extension_instance.name}.new(self)
+          end
+        RUBY
+      end
+    end
+  end
+end
+

data/lib/reality/facets/facet_container.rb

@@ -0,0 +1,143 @@
+#
+# 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 Facets #nodoc
+    module FacetContainer
+      def self.extended(base)
+        base.class_eval 'module FacetDefinitions; end'
+      end
+
+      def facet?(key)
+        facet_by_name?(key)
+      end
+
+      def facet_by_name?(key)
+        !!facet_map[key.to_s]
+      end
+
+      def facet_by_name(key)
+        facet = facet_map[key.to_s]
+        Facets.error("Unknown facet '#{key}'") unless facet
+        facet
+      end
+
+      def facet(definition, options = {}, &block)
+        Facets.error("Unknown definition form '#{definition.inspect}'") unless (definition.is_a?(Symbol) || (definition.is_a?(Hash) && 1 == definition.size))
+        key = (definition.is_a?(Hash) ? definition.keys[0] : definition).to_sym
+        required_facets = definition.is_a?(Hash) ? definition.values[0] : []
+        Reality::Facets::Facet.new(self, key, {:required_facets => required_facets}.merge(options), &block)
+      end
+
+      def facet_keys
+        facet_map.keys
+      end
+
+      def facets
+        facet_map.values
+      end
+
+      def target_manager
+        @target_manager ||= Reality::Facets::TargetManager.new(self)
+      end
+
+      def facet_definitions
+        self.const_get(:FacetDefinitions)
+      end
+
+      def activate_facet(object, facet_key)
+        return if object.facet_enabled?(facet_key)
+
+        facet = facet_by_name(facet_key)
+        facet.required_facets.each do |required_facet_key|
+          activate_facet(object, required_facet_key)
+        end
+        facet.suggested_facets.each do |suggested_facet_key|
+          activate_facet(object, suggested_facet_key)
+        end
+        object.send(:"_enable_facet_#{facet_key}!")
+
+        each_contained_model_object(object) do |child|
+          activate_facet(child, facet_key)
+        end
+      end
+
+      def deactivate_facet(object, facet_key)
+        return unless object.facet_enabled?(facet_key)
+        each_contained_model_object(object) do |child|
+          deactivate_facet(child, facet_key)
+        end
+
+        facets.each do |facet|
+          if facet.required_facets.include?(facet_key)
+            deactivate_facet(object, facet.key)
+          end
+        end
+        object.send(:"_disable_facet_#{facet_key}!")
+      end
+
+      def extension_point(object, action)
+        # noinspection RubyNestedTernaryOperatorsInspection
+        name = object.respond_to?(:qualified_name) ? object.qualified_name : object.respond_to?(:name) ? object.name : object.to_s
+        if object.respond_to?(action, true)
+          Facets.debug "Running '#{action}' hook on #{object.class} #{name}"
+          object.send(action)
+        end
+        object.enabled_facets.each do |facet_key|
+          # Need to check for the magic facet_X method rather than X method directly as
+          # sometimes there is a global method of the same name.
+          method_name = "facet_#{facet_key}"
+          extension_object = object.respond_to?(method_name) ? object.send(method_name) : nil
+          if extension_object && extension_object.respond_to?(action, true)
+            Facets.debug "Running '#{action}' hook on #{facet_key} facet of #{object.class} #{name}"
+            extension_object.send(action)
+          end
+        end
+        each_contained_model_object(object) do |child|
+          extension_point(child, action)
+        end
+      end
+
+      private
+
+      def each_contained_model_object(object)
+        top_target = target_manager.target_by_model_class(object.class)
+        # noinspection RubyArgCount
+        target_manager.targets_by_container(top_target.key).each do |target|
+          next unless handle_sub_feature?(object, target.key)
+          elements = object.send(target.access_method) || []
+          elements = elements.is_a?(Array) ? elements : [elements]
+          elements.each do |child|
+            yield child
+          end
+        end
+      end
+
+      def handle_sub_feature?(object, sub_feature_key)
+        true
+      end
+
+      def register_facet(facet)
+        target_manager.lock_targets
+        Facets.error("Attempting to redefine facet #{facet.key}") if facet_map[facet.key.to_s]
+        facet_map[facet.key.to_s] = facet
+      end
+
+      # Map a facet key to a map. The map maps types to extension classes
+      def facet_map
+        @facets ||= Reality::OrderedHash.new
+      end
+    end
+  end
+end