view_models 1.5.5 → 1.5.6

data/TODO.textile

@@ -0,0 +1,4 @@
+h1. Next up
+
+* Explore possibilities to include Modules in hierarchical rendering.
+* Encapsule the rather bloated hierarchical rendering in a HierarchicalRendering object that mediates the whole rendering process.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 5
-:patch: 5
+:patch: 6
 :major: 1

data/lib/experimental/README.textile

@@ -0,0 +1,32 @@
+h1. module ModulesInRenderHierarchy
+
+Why would we need that?
+
+h2. Situation
+
+We have a music platform. There we have public profiles, and private profiles. And of each type a band, and a venue profile.
+
+Public / Private have different functionality, and also Band / Venue.
+
+The chose class structure looks like this:
+
+@Public::Base < Project@, @Private::Base < Project@
+@Public::Band < Public::Base@, @Public::Venue < Public::Base@, @Private::Band < Private::Base@, @Private::Venue < Private::Base@
+
+To not have duplicate code, we include the functionality for Bands and Venues by using @include BandFunctionality@ and @include VenueFunctionality@.
+
+h2. Problem
+
+When rendering using the hierarchical rendering, we look up the templates as follows:
+
+(For ViewModels::Public::Band#render_as :example, :format => :html)
+# @views/view_models/public/band/_example.html.erb@
+# @views/view_models/public/base/_example.html.erb@
+# @views/view_models/project/_example.html.erb@
+
+So the example template is taken from the @public/band@ directory. Why not from a @functionality/band@ directory (assuming the module is named @Functionality::Band@). The reason for this is that the current (v1.5.4) hierarchical rendering process uses superclass, which hops over Modules, rather than using ancestors, which wouldn't.
+
+h2. Solution
+
+#. Either override superclass, with all associated problems
+#. Or refit the whole hierarchical rendering into a HierarchicalRendering Class. (Preferred)

data/lib/experimental/modules_in_render_hierarchy.rb

@@ -0,0 +1,21 @@
+module ModulesInRenderHierarchy
+  
+  def self.included klass
+    klass.extend ClassMethods
+    klass.metaclass.alias_method_chain :include, :superclass_override
+  end
+  
+  module ClassMethods
+    def include_with_superclass_override mod
+      original_superclass = superclass
+      self.send :include_without_superclass_override, mod
+      mod.metaclass.send :define_method, :superclass do
+        original_superclass
+      end
+      metaclass.send :define_method, :superclass do
+        mod
+      end
+    end
+  end
+  
+end

data/lib/view_models/base.rb

@@ -93,7 +93,7 @@ module ViewModels
         #
         # TODO Think about raising the MissingTemplateError here.
         #
-        def next
+        def next_in_render_hierarchy
           superclass
         end
         
@@ -121,7 +121,7 @@ module ViewModels
         def template_path view, options
           raise_template_error_with options.error_message if inheritance_chain_ends?
           
-          template_path_from(view, options) || self.next.template_path(view, options)
+          template_path_from(view, options) || self.next_in_render_hierarchy.template_path(view, options)
         end
         
         # Accesses the view to find a suitable template path.

data/rails/init.rb

@@ -1,3 +1,5 @@
+# require 'experimental/modules_in_render_hierarchy'
+
 require 'extensions/active_record'
 require 'extensions/model_reader'
 
@@ -12,7 +14,5 @@ require 'helpers/view'
 require 'helpers/rails'
 require 'helpers/collection'
 
-# 
-# ActionController::Base.send :helper, ViewModels::Helpers::Rails
 ActionController::Base.send :include, ViewModels::Helpers::Rails
 ActionView::Base.send       :include, ViewModels::Helpers::Rails

data/spec/integration/integration_spec.rb

@@ -1,5 +1,7 @@
 require File.join(File.dirname(__FILE__), '../spec_helper')
 
+# require File.join(File.dirname(__FILE__), '../../lib/experimental/modules_in_render_hierarchy')
+
 require File.join(File.dirname(__FILE__), 'models/subclass')
 require File.join(File.dirname(__FILE__), 'models/sub_subclass')
 
@@ -10,6 +12,7 @@ require 'view_models/base'
 require File.join(File.dirname(__FILE__), 'view_models/project')
 require File.join(File.dirname(__FILE__), 'view_models/subclass')
 require File.join(File.dirname(__FILE__), 'view_models/sub_subclass')
+require File.join(File.dirname(__FILE__), 'view_models/module_for_rendering')
 
 require 'action_controller'
 require 'action_controller/test_process'
@@ -46,6 +49,18 @@ describe 'Integration' do
   
   before(:all) { puts "\n#{self.send(:description_args)[0]}:" }
   
+  # context 'experimental inclusion of module in render hierarchy' do
+  #   before(:each) do
+  #     ViewModels::Base.send :include, ModulesInRenderHierarchy
+  #     @view_model.class.send :include, ModuleForRendering
+  #   end
+  #   describe 'render_as' do
+  #     it 'should description' do
+  #       @view_model.render_as(:not_found_in_sub_subclass_but_in_module).should == '_not_found_in_sub_subclass_but_in_module.erb'
+  #     end
+  #   end
+  # end
+  
   describe 'ActiveRecord Extensions' do
     before(:each) do
       @view_model.extend ViewModels::Extensions::ActiveRecord

data/spec/integration/view_models/module_for_rendering.rb

@@ -0,0 +1,7 @@
+module ModuleForRendering
+  
+  def module_method
+    "Hello!"
+  end
+  
+end

data/spec/integration/views/view_models/module_for_rendering/_not_found_in_sub_subclass_but_in_module.erb

@@ -0,0 +1 @@
+_not_found_in_sub_subclass_but_in_module.erb

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 5
-  - 5
-  version: 1.5.5
+  - 6
+  version: 1.5.6
 platform: ruby
 authors: 
 - Florian Hanke
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-03 00:00:00 +01:00
+date: 2010-03-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,6 +61,7 @@ files:
 - MIT-LICENSE
 - README.textile
 - Rakefile
+- TODO.textile
 - VERSION.yml
 - generators/view_models/USAGE
 - generators/view_models/templates/README
@@ -78,6 +79,8 @@ files:
 - generators/view_models/templates/views/view_models/collection/_table.html.haml
 - generators/view_models/templates/views/view_models/collection/_table.text.erb
 - generators/view_models/view_models_generator.rb
+- lib/experimental/README.textile
+- lib/experimental/modules_in_render_hierarchy.rb
 - lib/extensions/active_record.rb
 - lib/extensions/model_reader.rb
 - lib/extensions/view.rb
@@ -94,6 +97,7 @@ files:
 - spec/integration/integration_spec.rb
 - spec/integration/models/sub_subclass.rb
 - spec/integration/models/subclass.rb
+- spec/integration/view_models/module_for_rendering.rb
 - spec/integration/view_models/project.rb
 - spec/integration/view_models/sub_subclass.rb
 - spec/integration/view_models/subclass.rb
@@ -101,6 +105,7 @@ files:
 - spec/integration/views/view_models/collection/_collection.text.erb
 - spec/integration/views/view_models/collection/_list.html.erb
 - spec/integration/views/view_models/collection/_list.text.erb
+- spec/integration/views/view_models/module_for_rendering/_not_found_in_sub_subclass_but_in_module.erb
 - spec/integration/views/view_models/sub_subclass/_capture_in_template.erb
 - spec/integration/views/view_models/sub_subclass/_capture_in_view_model.erb
 - spec/integration/views/view_models/sub_subclass/_collection_example.html.erb
@@ -169,6 +174,7 @@ test_files:
 - spec/integration/integration_spec.rb
 - spec/integration/models/sub_subclass.rb
 - spec/integration/models/subclass.rb
+- spec/integration/view_models/module_for_rendering.rb
 - spec/integration/view_models/project.rb
 - spec/integration/view_models/sub_subclass.rb
 - spec/integration/view_models/subclass.rb