reality-facets 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 943e935de008b8a29ef6a1b73342e4f87e4526d7
-  data.tar.gz: 675f3d593911cbca6b8c94b24fe54118bfaf2013
+  metadata.gz: d17f63aa3fd221512dc2cf8fb3305c70a33f18df
+  data.tar.gz: 0e66691871d7376d787d10eed9bf6d84f28ed982
 SHA512:
-  metadata.gz: a76f2d59374464b3c86311951ce66cd8a33575b29e8d379a4fbdc32530832e9ca169bd7b85e57a6a0a66c62249d4b37a7b791a2731c319417f7a729671e18989
-  data.tar.gz: 00a56c862ea83d52db49a307e66f4aca086dfb402bd2f49d7a9f4b711bb2009adc8c62ea14b481bd87fa499b6e105d6a4e2063f1730fa85f490e334969c0e62c
+  metadata.gz: b39725276dde3d9d2cd95068d597525f5e9c92e9836087f8af4bdae090d642f230c8699c99b957278cc6dd4fcfc34a9088a97fd1bc9cbf6e5f8b9693aa79b3ba
+  data.tar.gz: f06caabcc236eb7899f1eac6aa95fd11535689d14eefc4a6dd337996b7dfdab85365ea0ab4c0b40b69243f4ee6e21bf9505ed8ff4301a65dfda70e64859f126f

data/lib/reality/facets/facet.rb

@@ -27,6 +27,7 @@ module Reality #nodoc
         @facet_container = facet_container
         @required_facets = []
         @suggested_facets = []
+        @model_extension_instances = {}
         facet_container.send :register_facet, self
         super(options, &block)
         facet_container.target_manager.targets.each do |target|
@@ -51,13 +52,18 @@ module Reality #nodoc
         end
       end
 
+      def enhanced?(model_class)
+        !!@model_extension_instances[model_class]
+      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(<<-RUBY)
+        if @model_extension_instances[model_class].nil?
+          extension_name = "#{::Reality::Naming.pascal_case(self.key)}#{model_class.name.gsub(/^.*\:\:([^\:]+)/, '\1')}Facet"
+          definitions = target_manager.container.facet_definitions
+          definitions.class_eval(<<-RUBY)
 class #{extension_name} < Reality.base_element(:container_key => :#{target.inverse_access_method})
   def facet_key
     :#{self.key}
@@ -79,21 +85,21 @@ class #{extension_name} < Reality.base_element(:container_key => :#{target.inver
     self.#{target.inverse_access_method}
   end
 end
-        RUBY
-        extension_instance = definitions.const_get(extension_name)
-        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
+          RUBY
+          @model_extension_instances[model_class] = definitions.const_get(extension_name)
 
-          def facet_#{self.key}
-            Reality::Facets.error("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
+          target.extension_module.class_eval <<-RUBY
+            def #{self.key}
+              self.facet_#{self.key}
+            end
+  
+            def facet_#{self.key}
+              Reality::Facets.error("Attempted to access '#{self.key}' facet for model '#{model_class.name}' when facet disabled.") unless #{self.key}?
+              @facet_#{self.key} ||= #{@model_extension_instances[model_class].name}.new(self)
+            end
+          RUBY
+        end
+        @model_extension_instances[model_class].class_eval(&block) if block_given?
       end
     end
   end

data/lib/reality/facets/facet_container.rb

@@ -19,17 +19,29 @@ module Reality #nodoc
         base.class_eval 'module FacetDefinitions; end'
       end
 
-      def facet?(key)
-        facet_by_name?(key)
+      # An array of modules that should be mixed in to every extension object
+      def facet_extensions
+        facet_extension_list.dup
       end
 
-      def facet_by_name?(key)
-        !!facet_map[key.to_s]
+      # Add a ruby module that will be applied to all extension objects
+      def facet_extension(extension)
+        Facets.error("Attempting to define facet extension #{extension} after facet manager is locked") if locked?
+        facet_extension_list << extension
+        target_manager.lock!
       end
 
-      def facet_by_name(key)
-        facet = facet_map[key.to_s]
-        Facets.error("Unknown facet '#{key}'") unless facet
+      def facet?(name)
+        facet_by_name?(name)
+      end
+
+      def facet_by_name?(name)
+        !!facet_map[name.to_s]
+      end
+
+      def facet_by_name(name)
+        facet = facet_map[name.to_s]
+        Facets.error("Unknown facet '#{name}'") unless facet
         facet
       end
 
@@ -48,6 +60,15 @@ module Reality #nodoc
         facet_map.values
       end
 
+      def lock!
+        @locked = true
+        apply_facet_extensions
+      end
+
+      def locked?
+        !!(@locked ||= nil)
+      end
+
       def target_manager
         @target_manager ||= Reality::Facets::TargetManager.new(self)
       end
@@ -73,35 +94,35 @@ module Reality #nodoc
         results
       end
 
-      def activate_facet(object, facet_key)
-        return if object.facet_enabled?(facet_key)
+      def activate_facet(object, facet_name)
+        return if object.facet_enabled?(facet_name)
 
-        facet = facet_by_name(facet_key)
+        facet = facet_by_name(facet_name)
         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}!")
+        object.send(:"_enable_facet_#{facet_name}!")
 
         each_contained_model_object(object) do |child|
-          activate_facet(child, facet_key)
+          activate_facet(child, facet_name)
         end
       end
 
-      def deactivate_facet(object, facet_key)
-        return unless object.facet_enabled?(facet_key)
+      def deactivate_facet(object, facet_name)
+        return unless object.facet_enabled?(facet_name)
         each_contained_model_object(object) do |child|
-          deactivate_facet(child, facet_key)
+          deactivate_facet(child, facet_name)
         end
 
         facets.each do |facet|
-          if facet.required_facets.include?(facet_key)
+          if facet.required_facets.include?(facet_name)
             deactivate_facet(object, facet.key)
           end
         end
-        object.send(:"_disable_facet_#{facet_key}!")
+        object.send(:"_disable_facet_#{facet_name}!")
       end
 
       def extension_point(object, action)
@@ -111,13 +132,13 @@ module Reality #nodoc
           Facets.debug "Running '#{action}' hook on #{object.class} #{name}"
           object.send(action)
         end
-        object.enabled_facets.each do |facet_key|
+        object.enabled_facets.each do |facet_name|
           # 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}"
+          method_name = "facet_#{facet_name}"
           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}"
+            Facets.debug "Running '#{action}' hook on #{facet_name} facet of #{object.class} #{name}"
             extension_object.send(action)
           end
         end
@@ -145,8 +166,27 @@ module Reality #nodoc
         true
       end
 
+      def apply_facet_extensions
+        facet_extension_list.each do |extension|
+          facet_map.values.each do |facet|
+            target_manager.targets.each do |target|
+              if facet.enhanced?(target.model_class)
+                facet.enhance(target.model_class) do
+                  include extension
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def facet_extension_list
+        @facet_extensions ||= []
+      end
+
       def register_facet(facet)
-        target_manager.lock_targets
+        target_manager.lock!
+        Facets.error("Attempting to define facet #{facet.key} after facet manager is locked") if locked?
         Facets.error("Attempting to redefine facet #{facet.key}") if facet_map[facet.key.to_s]
         facet_map[facet.key.to_s] = facet
       end

data/lib/reality/facets/target_manager.rb

@@ -75,6 +75,7 @@ module Reality #nodoc
 
       def initialize(container)
         @container = container
+        @locked = false
       end
 
       def is_target_valid?(key)
@@ -107,6 +108,7 @@ module Reality #nodoc
       end
 
       def apply_extension(model)
+        container.lock!
         self.target_by_model_class(model.class).apply_extension_to(model)
       end
 
@@ -118,19 +120,23 @@ module Reality #nodoc
         target_map.values.select { |target| target.container_key == container_key }
       end
 
-      def lock_targets
-        @targets_locked = true
+      def lock!
+        @locked = true
+      end
+
+      def locked?
+        !!@locked
       end
 
       def reset_targets
         target_map.clear
-        @targets_locked = false
+        @locked = false
       end
 
       private
 
       def register_target(target)
-        Reality::Facets.error("Attempting to define target #{target.key} when targets have been locked.") if (@targets_locked ||= false)
+        Reality::Facets.error("Attempting to define target #{target.key} when targets have been locked.") if locked?
         Reality::Facets.error("Attempting to redefine target #{target.key}") if target_map[target.key]
         target_map[target.key] = target
       end

data/reality-facets.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name               = %q{reality-facets}
-  s.version            = '1.5.0'
+  s.version            = '1.6.0'
   s.platform           = Gem::Platform::RUBY
 
   s.authors            = ['Peter Donald']

data/test/facets/test_facet.rb

@@ -31,10 +31,10 @@ class Reality::Facets::TestFacet < Reality::TestCase
                                              :access_method => :comps,
                                              :inverse_access_method => :comp)
 
-    Reality::Facets::Facet.new(TestFacetContainer, :gwt)
+    facet_gwt = Reality::Facets::Facet.new(TestFacetContainer, :gwt)
     Reality::Facets::Facet.new(TestFacetContainer, :gwt_rpc, :required_facets => [:gwt])
 
-    Reality::Facets::Facet.new(TestFacetContainer, :imit, :suggested_facets => [:gwt_rpc]) do |f|
+    facet_imit = Reality::Facets::Facet.new(TestFacetContainer, :imit, :suggested_facets => [:gwt_rpc]) do |f|
       f.enhance(Project) do
         def name
           "Gwt#{project.name}"
@@ -47,6 +47,11 @@ class Reality::Facets::TestFacet < Reality::TestCase
     assert_equal true, TestFacetContainer.facet_by_name?(:gwt_rpc)
     assert_equal true, TestFacetContainer.facet_by_name?(:imit)
 
+    assert_equal false, facet_gwt.enhanced?(Project)
+    assert_equal false, facet_gwt.enhanced?(Component)
+    assert_equal true, facet_imit.enhanced?(Project)
+    assert_equal true, facet_imit.enhanced?(Component)
+
     project = Project.new(:MyProject) do |p|
       p.enable_facets(:imit)
       p.component(:MyComponent)
@@ -86,4 +91,61 @@ class Reality::Facets::TestFacet < Reality::TestCase
     assert_equal component, component.imit.comp
     assert_equal component, component.imit.parent
   end
+
+  class Component2 < Reality.base_element(:name => true, :container_key => :project, :pre_config_code => 'Reality::TestCase::TestFacetContainer.target_manager.apply_extension(self)')
+  end
+
+  class Project2 < Reality.base_element(:name => true, :pre_config_code => 'Reality::TestCase::TestFacetContainer.target_manager.apply_extension(self)')
+    def component(name, options = {}, &block)
+      component_map[name.to_s] = Component2.new(self, name, options, &block)
+    end
+
+    def components
+      component_map.values
+    end
+
+    def component_map
+      @component_map ||= {}
+    end
+  end
+
+  module MyExtensionModule
+    def hello_message
+      'yo'
+    end
+  end
+
+  def test_common_extension_modules
+
+    assert_equal false, TestFacetContainer.facet_by_name?(:gwt)
+
+    TestFacetContainer.target_manager.target(Project2, :project)
+    TestFacetContainer.target_manager.target(Component2,
+                                             :component,
+                                             :project)
+
+
+    assert_equal [], TestFacetContainer.facet_extensions
+    TestFacetContainer.facet_extension(MyExtensionModule)
+    assert_equal [MyExtensionModule], TestFacetContainer.facet_extensions
+
+    Reality::Facets::Facet.new(TestFacetContainer, :gwt) do |f|
+      f.enhance(Project2) do
+        def name
+          "Gwt#{project.name}"
+        end
+      end
+    end
+
+    project = Project2.new(:MyProject) do |p|
+      p.enable_facets(:gwt)
+      p.component(:MyComponent)
+    end
+    component = project.components[0]
+
+    assert_equal true, project.gwt?
+    assert_equal 'GwtMyProject', project.gwt.name
+    assert_equal 'yo', project.gwt.hello_message
+    assert_equal false, component.respond_to?(:gwt)
+  end
 end

data/test/facets/test_facet_container.rb

@@ -7,6 +7,9 @@ class Reality::Facets::TestFacetContainer < Reality::TestCase
   class Component2 < Reality.base_element(:name => true)
   end
 
+  module MyExtensionModule
+  end
+
   def test_basic_operation
 
     assert_equal false, TestFacetContainer.facet_by_name?(:gwt)
@@ -36,6 +39,10 @@ class Reality::Facets::TestFacetContainer < Reality::TestCase
     assert_equal %w(gwt), TestFacetContainer.facet_keys
     assert_equal 1, TestFacetContainer.facets.size
 
+    assert_equal [], TestFacetContainer.facet_extensions
+    TestFacetContainer.facet_extension(MyExtensionModule)
+    assert_equal [MyExtensionModule], TestFacetContainer.facet_extensions
+
     assert_facet_error("Unknown facet 'gwt_rpc'") { TestFacetContainer.facet_by_name(:gwt_rpc) }
 
     assert_equal TestFacetContainer, TestFacetContainer.facet_by_name(:gwt).facet_container

data/test/facets/test_faceted_model.rb

@@ -276,4 +276,18 @@ class Reality::Facets::TestFacetedModel < Reality::TestCase
     assert_equal true, attribute1.jpa.hook2?
     assert_equal true, attribute2.jpa.hook2?
   end
+
+  def test_facet_container_locking
+    TestFacetContainer.target_manager.target(Repository, :repository)
+
+    TestFacetContainer.facet(:json)
+
+    assert_equal 1, TestFacetContainer.facets.size
+
+    Repository.new(:MyRepo) do |r|
+      TestFacetContainer.target_manager.apply_extension(r)
+    end
+
+    assert_facet_error('Attempting to define facet gwt after facet manager is locked') { TestFacetContainer.facet(:gwt) }
+  end
 end

data/test/facets/test_target_manager.rb

@@ -193,4 +193,36 @@ class Reality::Facets::TestTargetManager < Reality::TestCase
 
     assert_equal [:json], fragment1.enabled_facets
   end
+
+  class Project2 < Reality.base_element(:name => true)
+  end
+
+  def test_apply_extension_with_multiple_enhances
+    TestFacetContainer.target_manager.target(Project2, :project)
+
+    TestFacetContainer.facet(:gwt) do |f|
+      f.enhance(Project2) do
+        def name
+          "Gwt#{project.name}"
+        end
+      end
+      f.enhance(Project2) do
+        def name2
+          "Gwt2#{project.name}"
+        end
+      end
+    end
+
+    project = Project2.new(:MyProject)
+    assert_equal false, project.respond_to?(:facet_enabled?)
+    assert_equal false, project.respond_to?(:parent)
+
+    TestFacetContainer.target_manager.apply_extension(project)
+
+    assert_equal true, project.respond_to?(:facet_enabled?)
+    project.enable_facets(:gwt)
+
+    assert_equal 'GwtMyProject', project.gwt.name
+    assert_equal 'Gwt2MyProject', project.gwt.name2
+  end
 end

data/test/helper.rb

@@ -13,7 +13,9 @@ class Reality::TestCase < Minitest::Test
     class << self
 
       def reset
+        @locked = false
         facet_map.clear
+        facet_extension_list.clear
         target_manager.reset_targets
         TestFacetContainer::FacetDefinitions.constants.each do |constant|
           TestFacetContainer::FacetDefinitions.send(:remove_const, constant)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reality-facets
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reality-core