view_models 1.5.7 → 2.0.0.ruby19

data/lib/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '/view_models')

data/lib/padrino/README.textile

@@ -0,0 +1,3 @@
+h1. View Models for Padrino
+
+This is the Padrino specific folder of the view models.

data/lib/padrino/init.rb

@@ -0,0 +1,10 @@
+this = File.dirname __FILE__
+
+require File.join(this, '/../shared/init')
+
+ViewModels::Helpers::Mapping
+
+require File.join(this, '/lib/view_models/base')
+require File.join(this, '/lib/helpers/collection')
+
+require File.join(this, '/lib/padrino/view_models')

data/lib/padrino/lib/helpers/collection.rb

@@ -0,0 +1,27 @@
+module ViewModels
+  module Helpers
+    module Mapping
+      
+      # The Collection view_model helper has the purpose of presenting presentable collections.
+      # * Render as list
+      # * Render as table
+      # * Render as collection
+      # * Render a pagination
+      #
+      class Collection
+        private
+          
+          # Helper method that renders a partial in the context of the context instance.
+          #
+          # Example:
+          #   If the collection view_model helper has been instantiated in the context
+          #   of a controller, render will be called in the controller.
+          #
+          def render_partial name, locals
+            @context.instance_eval { render "view_models/collection/_#{name}", :locals => locals }
+          end
+      end
+      
+    end
+  end
+end

data/lib/padrino/lib/padrino/view_models.rb

@@ -0,0 +1,19 @@
+module Padrino
+  module ViewModels
+    
+    class << self
+      def registered app
+        app.send :include, ::ViewModels::Helpers::Mapping
+        
+        Padrino.set_load_paths File.join(app.root, "/view_models")
+        
+        Padrino.require_dependencies File.join(app.root, "/view_models.rb")
+        # FIXME Needs to require in a specific order.
+        #
+        Padrino.require_dependencies File.join(app.root, "/view_models/**/*.rb")
+      end
+      alias :included :registered
+    end
+    
+  end
+end

data/lib/padrino/lib/view_models/base.rb

@@ -0,0 +1,65 @@
+# Base Module for Padrino ViewModels.
+#
+module ViewModels
+  
+  # Base class from which all view_models inherit.
+  #
+  class Base
+    
+    # Make helper and helper_method available
+    #
+    # TODO Rewrite Padrino style.
+    #
+    # include ActionController::Helpers
+    
+    class << self
+      
+      # Alias the context_method to the padrino-centric app_method.
+      #
+      alias app_method context_method
+      
+      # Sets the view format and tries to render the given options.
+      #
+      # Note: Also caches [path, name, format] => template path.
+      #
+      def render renderer, options
+        # options.format! view
+        renderer.instance_variable_set(:@_content_type, options.format || :html)
+        path_store.cached options do
+          path = template_path renderer, options
+          options.file = path
+          renderer.send :render, path.to_s, options.to_render_options
+        end
+      end
+      
+      # FIXME Need to use padrino register for this.
+      #
+      alias_method :register, :include
+      
+      protected
+        
+        # Accesses the view to find a suitable template path.
+        #
+        # Returns nil if a template cannot be found.
+        #
+        def template_path_from renderer, options
+          template = renderer.send :resolve_template, tentative_template_path(options)
+          # TODO!
+          #
+          template && template.first.to_s # was .path
+        rescue Padrino::Rendering::TemplateNotFound => t
+          nil
+        end
+        
+    end
+    
+    alias app context
+    
+    protected
+      
+      def renderer
+        app
+      end
+      
+  end
+end

data/lib/rails2/README.textile

@@ -0,0 +1,3 @@
+h1. View Models for Rails
+
+This is the Rails specific folder of the view models.

data/lib/rails2/init.rb

@@ -0,0 +1,18 @@
+# require 'experimental/modules_in_render_hierarchy'
+
+this = File.dirname __FILE__
+
+require File.join(this, '/lib/view_models')
+require File.join(this, '/../shared/init')
+require File.join(this, '/lib/view_models/base')
+require File.join(this, '/lib/view_models/view')
+
+require File.join(this, '/lib/helpers/view')
+require File.join(this, '/lib/helpers/collection')
+
+# TODO How was the view models generator included?
+#
+# require File.join(this, '/generators/view_models/view_models_generator')
+
+ActionController::Base.send :include, ViewModels::Helpers::Mapping
+ActionView::Base.send       :include, ViewModels::Helpers::Mapping

data/lib/rails2/lib/helpers/collection.rb

@@ -0,0 +1,27 @@
+module ViewModels
+  module Helpers
+    module Mapping
+      
+      # The Collection view_model helper has the purpose of presenting presentable collections.
+      # * Render as list
+      # * Render as table
+      # * Render as collection
+      # * Render a pagination
+      #
+      class Collection
+        private
+          
+          # Helper method that renders a partial in the context of the context instance.
+          #
+          # Example:
+          #   If the collection view_model helper has been instantiated in the context
+          #   of a controller, render will be called in the controller.
+          #
+          def render_partial name, locals
+            @context.instance_eval { render :partial => "view_models/collection/#{name}", :locals => locals }
+          end
+      end
+      
+    end
+  end
+end

data/lib/rails2/lib/view_models.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '/../../shared/lib/view_models')

data/lib/rails2/lib/view_models/base.rb

@@ -0,0 +1,99 @@
+# Base Module for Rails 2 ViewModels.
+#
+module ViewModels
+  
+  # Base class from which all view_models inherit.
+  #
+  class Base
+    
+    # Make helper and helper_method available
+    #
+    include ActionController::Helpers
+    
+    # This is really only needed because some Rails helpers access
+    # @controller directly.
+    # It's really bad.
+    #
+    # TODO Make it call super.
+    # 
+    def initialize model, controller_or_view
+      @model                 = model
+      @context = @controller = ContextExtractor.new(controller_or_view).extract
+    end
+    
+    class << self
+      
+      # Alias the context_method to the rails-centric controller_method.
+      #
+      alias controller_method context_method
+      
+      # Wrapper for add_template_helper in ActionController::Helpers, also
+      # includes given helper in the view_model
+      #
+      # TODO extract into module
+      #
+      unless instance_methods.include?('old_add_template_helper')
+        alias old_add_template_helper add_template_helper
+        def add_template_helper helper_module
+          include helper_module
+          old_add_template_helper helper_module
+        end
+      end
+      
+      # Sets the view format and tries to render the given options.
+      #
+      # Note: Also caches [path, name, format] => template path.
+      #
+      def render renderer, options
+        options.format! renderer
+        path_store.cached options do
+          options.file = template_path renderer, options
+          renderer.render_with options
+        end
+      end
+      
+      protected
+        
+        # Accesses the view to find a suitable template path.
+        #
+        def template_path_from renderer, options
+          template = renderer.find_template tentative_template_path(options)
+          
+          template && template.path
+        end
+        
+    end # class << self
+    
+    # Delegate context methods.
+    #
+    context_method :form_authenticity_token, :protect_against_forgery?, :request_forgery_protection_token
+    
+    # Make all the dynamically generated routes (restful routes etc.)
+    # available in the view_model
+    #
+    ActionController::Routing::Routes.install_helpers self
+    
+    protected
+      
+      alias controller context
+      
+      # CaptureHelper needs this.
+      #
+      attr_accessor :output_buffer
+      
+      # Returns a view instance for render_xxx.
+      #
+      # TODO Try getting a view instance from the controller.
+      #
+      def renderer
+        # view = if controller.response.template
+        #   controller.response.template
+        # else
+          View.new controller, master_helper_module
+        # end
+        
+        # view.extend Extensions::View
+      end
+      
+  end
+end

data/lib/{view_models → rails2/lib/view_models}/view.rb

@@ -3,10 +3,14 @@ module ViewModels
   #
   class View < ActionView::Base
     
+    # Shut up, opinionated funkers.
+    #
+    alias singleton_class metaclass unless instance_methods.include?('singleton_class')
+    
     # Include the helpers from the view model.
     #
     def initialize controller, master_helper_module
-      metaclass.send :include, master_helper_module
+      singleton_class.send :include, master_helper_module
       super controller.class.view_paths, {}, controller
     end
     

data/lib/shared/README.textile

@@ -0,0 +1,3 @@
+h1. View Models for Padrino AND Rails
+
+This is shared folder which contains code and resources both for Padrino AND Rails.

data/lib/shared/init.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '/lib/view_models/extensions/active_record')
+require File.join(File.dirname(__FILE__), '/lib/view_models/extensions/model_reader')
+
+require File.join(File.dirname(__FILE__), '/lib/view_models')
+require File.join(File.dirname(__FILE__), '/lib/view_models/path_store')
+require File.join(File.dirname(__FILE__), '/lib/view_models/render_options')
+require File.join(File.dirname(__FILE__), '/lib/view_models/context_extractor')
+require File.join(File.dirname(__FILE__), '/lib/view_models/base')
+
+require File.join(File.dirname(__FILE__), '/lib/view_models/helpers/mapping')
+require File.join(File.dirname(__FILE__), '/lib/view_models/helpers/collection')

data/lib/shared/lib/view_models.rb

@@ -0,0 +1,4 @@
+require 'active_support'
+
+module ViewModels; end
+module ViewModels; module Helpers; end; end

data/lib/{view_models → shared/lib/view_models}/base.rb

@@ -11,22 +11,14 @@ module ViewModels
   #
   class Base
     
-    # Model and Controller are accessible from outside.
-    #
-    # TODO but they actually shouldn't be. Try to migrate into protected area.
-    #
-    attr_reader :model, :controller
-    
-    # Make helper and helper_method available
-    #
-    include ActionController::Helpers
-    
     # Create a view_model. To create a view_model, you need to have a model (to present) and a context.
-    # The context is usually a view or a controller, but doesn't need to be.
+    # The context is usually a view, a controller, or an app, but doesn't need to be.
+    # 
+    # TODO Include this.
     # 
-    def initialize model, context
-      @model = model
-      @controller = ControllerExtractor.new(context).extract
+    def initialize model, app_or_controller_or_view
+      @model   = model
+      @context = ContextExtractor.new(app_or_controller_or_view).extract
     end
     
     class << self
@@ -42,51 +34,31 @@ module ViewModels
         super
       end
       
-      # Installs the model_reader Method for filtered
-      # model method delegation.
-      #
-      include Extensions::ModelReader
-      
-      # Delegates method calls to the controller.
+      # Delegates method calls to the context.
       #
       # Examples:
-      #   controller_method :current_user
-      #   controller_method :current_user, :current_profile  # multiple methods to be delegated
+      #   context_method :current_user
+      #   context_method :current_user, :current_profile  # multiple methods to be delegated
       #
       # In the view_model:
       #   self.current_user
       # will call
-      #   controller.current_user
+      #   context.current_user
       #
-      def controller_method *methods
-        delegate *methods << { :to => :controller }
+      def context_method *methods
+        delegate *methods << { :to => :context }
       end
       
-      # Wrapper for add_template_helper in ActionController::Helpers, also
-      # includes given helper in the view_model
-      #
-      # TODO extract into module
-      #
-      alias old_add_template_helper add_template_helper
-      def add_template_helper helper_module
-        include helper_module
-        old_add_template_helper helper_module
-      end
-      
-      # Sets the view format and tries to render the given options.
-      #
-      # Note: Also caches [path, name, format] => template path.
+      # Installs the model_reader Method for filtered
+      # model method delegation.
       #
-      def render view, options
-        options.format! view
-        path_store.cached options do
-          options.file = template_path view, options
-          view.render_with options
-        end
-      end
+      include Extensions::ModelReader
       
       protected
         
+        # Hierarchical rendering.
+        #
+        
         # Returns the next view model class in the render hierarchy.
         #
         # Note: Just returns the superclass.
@@ -96,13 +68,11 @@ module ViewModels
         def next_in_render_hierarchy
           superclass
         end
-        
         # Just raises a fitting template error.
         #
         def raise_template_error_with message
           raise MissingTemplateError.new "No template #{message} found."
         end
-        
         # Check if the view lookup inheritance chain has ended.
         #
         # Raises a MissingTemplateError if yes.
@@ -111,6 +81,10 @@ module ViewModels
            self == ViewModels::Base
         end
         
+        
+        # Template finding
+        #
+        
         # Returns a template path for the view with the given options.
         #
         # If no template is found, traverses up the inheritance chain.
@@ -118,24 +92,20 @@ module ViewModels
         # Raises a MissingTemplateError if none is found during
         # inheritance chain traversal.
         #
-        def template_path view, options
+        def template_path renderer, options
           raise_template_error_with options.error_message if inheritance_chain_ends?
           
-          template_path_from(view, options) || self.next_in_render_hierarchy.template_path(view, options)
+          template_path_from(renderer, options) || self.next_in_render_hierarchy.template_path(renderer, options)
         end
         
-        # Accesses the view to find a suitable template path.
-        #
-        def template_path_from view, options
-          template = view.find_template tentative_template_path(options)
-          
-          template && template.path
-        end
+        # ...
         
         # Return as render path either a stored path or a newly generated one.
         #
         # If nothing or nil is passed, the store is ignored.
         #
+        # TODO Think about using the built-in Padrino template store.
+        #
         def tentative_template_path options
           path_store[options.path_key] || generate_template_path_from(options)
         end
@@ -168,22 +138,17 @@ module ViewModels
           @view_model_path || @view_model_path = self.name.underscore
         end
         
-    end # class << self
-    
-    # Delegate controller methods.
-    #
-    controller_method :logger, :form_authenticity_token, :protect_against_forgery?, :request_forgery_protection_token
+    end
     
-    # Make all the dynamically generated routes (restful routes etc.)
-    # available in the view_model
+    # Delegate context methods.
     #
-    ActionController::Routing::Routes.install_helpers self
+    context_method :logger
     
     # Renders the given partial in the view_model's view root in the format given.
     #
     # Example:
-    #   app/views/view_models/this/view_model/_partial.haml
-    #   app/views/view_models/this/view_model/_partial.text.erb
+    #   views/view_models/this/view_model/_partial.haml
+    #   views/view_models/this/view_model/_partial.text.erb
     #
     # The following options are supported: 
     # * :format - Calling view_model.render_as('partial') will render the haml
@@ -194,7 +159,7 @@ module ViewModels
     # * If no format is given, it will render the default format, which is (currently) html.
     #
     def render_as name, options = {}
-      render RenderOptions::Partial.new(name, options)
+      render_internal RenderOptions::Partial.new(name, options)
     end
     # render_the is used for small parts.
     #
@@ -208,8 +173,8 @@ module ViewModels
     # Renders the given template in the view_model's view root in the format given.
     #
     # Example:
-    #   app/views/view_models/this/view_model/template.haml
-    #   app/views/view_models/this/view_model/template name.text.erb
+    #   views/view_models/this/view_model/template.haml
+    #   views/view_models/this/view_model/template name.text.erb
     #
     # The following options are supported: 
     # * :format - Calling view_model.render_template('template') will render the haml
@@ -220,38 +185,29 @@ module ViewModels
     # * If no format is given, it will render the default format, which is (currently) html.
     #
     def render_template name, options = {}
-      render RenderOptions::Template.new(name, options)
+      render_internal RenderOptions::Template.new(name, options)
     end
     
     protected
       
-      # CaptureHelper needs this.
+      # Model and Context (Controller) are accessible from a view model.
+      #
+      # If you really need to call
+      #   view_model.model.bla
+      # in a view, I urge you to reconsider. But feel free to make
+      # the methods model, controller, context public.
       #
-      attr_accessor :output_buffer
+      attr_reader :model, :context
       
       # Internal render method that uses the options to get a view instance
       # and then referring to its class for rendering.
       #
-      def render options
+      def render_internal options
         options.view_model = self
         
         determine_and_set_format options
-        
-        self.class.render view_instance, options
-      end
-      
-      # Returns a view instance for render_xxx.
-      #
-      # TODO Try getting a view instance from the controller.
-      #
-      def view_instance
-        # view = if controller.response.template
-        #   controller.response.template
-        # else
-          View.new controller, master_helper_module
-        # end
-        
-        # view.extend Extensions::View
+                
+        self.class.render renderer, options
       end
       
       # Determines what format to use for rendering.
@@ -263,6 +219,5 @@ module ViewModels
       def determine_and_set_format options
         options.format = @template_format = options.format || @template_format
       end
-      
   end
 end