view_models 2.0.1 → 3.0.0

data/lib/view_models/helpers/collection.rb

@@ -0,0 +1,113 @@
+module ViewModels
+  
+  # Helpers you can include in just about anything to get convenient access to view model functionality
+  #
+  module Helpers
+    
+    # Mapping helpers install collection_view_model_for and view_model_for, which you can use with instances
+    # to conveniently instantiate a view model for it
+    #
+    module Mapping
+      
+      # Construct a view_model for a collection.
+      #
+      # @todo Think about moving it into view_model_for, or renaming it view_models_for.
+      #
+      def collection_view_model_for array_or_pagination, context = self
+        Collection.new array_or_pagination, context
+      end
+      
+      # 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
+        
+        # Delegate collection relevant methods to the collection.
+        # @todo Why is as_json not yet loaded in Enumerable.instance_methods 
+        # when this file is loaded in the spec, require active_support is installed before view_models are loaded
+        # Load Order ? Rails Blagic?
+        #
+        self.delegate *[Enumerable.instance_methods, :length, :size, :empty?, :each, :exit, :as_json, { :to => :@collection }].flatten
+        
+        #
+        #
+        def initialize collection, context
+          @collection, @context = collection, context
+        end
+        
+        # Renders a list (in the broadest sense of the word).
+        #
+        # @param [Hash] options The options for the list
+        # @option options :collection the collection to iterate over (default: The collection of the collection view_model to iterate over)
+        # @option options :context context to render in (default: The original context given to the collection view_model to render in)
+        # @option options :template_name the template to render for each model element (default: list_item as the default element template)
+        # @option options :separator the separator between each element (default: nil separator in html)
+        #
+        def list options = {}          
+          render_partial :list, template_locals(:list_item, options)
+        end
+        
+        # Renders a collection.
+        #
+        # @note The only difference between a list and a collection is the enclosing list type. While list uses ol, the collection uses ul.
+        #
+        # @param [Hash] options The options for the collection
+        # @option options :collection the collection to iterate over (default: The collection of the collection view_model to iterate over)
+        # @option options :context the context to render in (default: The original context given to the collection view_model to render in)
+        # @option options :template_name the template to render for each model element (default: Uses :collection_item as the default element template)
+        # @option options :separator => separator between each element (default: nil separator in html)
+        #
+        def collection options = {}          
+          render_partial :collection, template_locals(:collection_item, options)
+        end
+        
+        # Renders a table.
+        #
+        # Note: Each item represents a table row.
+        #
+        # @param [Hash] options The options for the table
+        # @option options :collection the collection to iterate over (default: The collection of the collection view_model to iterate over)
+        # @option options :context the context to render in (default: The original context given to the collection view_model to render in)
+        # @option options :template_name the template to render for each model element (default: Uses :table_row as the default element template)
+        # @option options :separator => separator between each element (default: nil separator in html)
+        #
+        def table options = {}          
+          render_partial :table, template_locals(:table_row, options)
+        end
+        
+        # Renders a pagination.
+        #
+        # @param [Hash] options The options for the collection
+        # @option options :collection the collection to iterate over (default: The collection of the collection view_model to iterate over)
+        # @option options :context the context to render in (default: The original context given to the collection view_model to render in)
+        # @option options :template_name the template to render for each model element (default: Uses :collection_item as the default element template)
+        # @option options :separator => separator between each element (default: | separator in html)
+        #
+        def pagination options = {}          
+          render_partial :pagination, template_locals(:pagination, {:separator => '|'}.merge(options))
+        end
+        
+        private
+          
+          # Helper method that renders a partial in the context of the context instance.
+          #
+          # @note 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
+          
+          # Helper method that constructs locals for render_partial
+          #
+          def template_locals template_name, supersed_options 
+            { :collection => @collection, :template_name => template_name, :separator => nil }.merge supersed_options
+          end
+          
+      end
+      
+    end
+  end
+end

data/lib/{shared/lib/view_models → view_models}/helpers/mapping.rb

@@ -2,16 +2,20 @@ module ViewModels
   module Helpers
     module Mapping
       
+      # module attribute used for specific mapping
+      #
       mattr_accessor :specific_view_model_mapping
       self.specific_view_model_mapping = {}
       
+      # module attribute for the default view models prefix
+      #
+      mattr_accessor :default_prefix
+      self.default_prefix = 'ViewModels::'
+      
       # Create a new view_model instance for the given model instance
       # with the given arguments.
-      #
-      # Note: Will emit an ArgumentError if the view model class doesn't support 2 arguments.
-      #
-      # Padrino: context is an app instance.
-      # Rails 2: context is either a view instance or a controller instance.
+      # @raise [ArgumentError] if the view model class doesn't support 2 arguments.
+      # @note context is either a view instance or a controller instance.
       #
       def view_model_for model, context = self
         view_model_class_for(model).new model, context
@@ -19,12 +23,7 @@ module ViewModels
       
       # Get the view_model class for the given model instance.
       #
-      # Note: ViewModels are usually of class ViewModels::<ModelClassName>.
-      #       (As returned by default_view_model_class_for)
-      #       Override specific_mapping if you'd like to install your own.
-      #
-      # OR:   Override default_view_model_class_for(model) if
-      #       you'd like to change the default.
+      # @note ViewModels are usually of class ViewModels::<ModelClassName>. (As returned by default_view_model_class_for). Override specific_mapping if you'd like to install your own. Or Override default_view_model_class_for(model) if you'd like to change the default.
       #
       def view_model_class_for model
         specific_view_model_class_for(model) || default_view_model_class_for(model)
@@ -38,10 +37,8 @@ module ViewModels
       # Override this method if you'd like to change the _default_
       # model-to-view_model class mapping.
       #
-      # Note: Will emit a NameError if a corresponding ViewModels constant cannot be loaded.
+      # @raise [NameError] if a corresponding ViewModels constant cannot be loaded.
       #
-      mattr_accessor :default_prefix
-      self.default_prefix = 'ViewModels::'
       def default_view_model_class_for model
         (default_prefix + model.class.name).constantize
       end
@@ -51,7 +48,7 @@ module ViewModels
       # Override this method, if you want to return a specific
       # view model class for the given model.
       #
-      # Note: Will emit a NameError if a corresponding ViewModels constant cannot be loaded.
+      # @raise [NameError] if a corresponding ViewModels constant cannot be loaded.
       #
       def specific_view_model_class_for model
         specific_view_model_mapping[model.class]

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

@@ -1,15 +1,19 @@
 module ViewModels
   module Helpers
+    
     # Module for conveniently including common view_helpers into a view_model
     #
     module View
       
-      # Include hook.
+      # Include hook for the view
       #
       def self.included view_model
         view_model.send :include, *all_view_helpers
       end
       
+      # The common view helpers
+      # @return [Array] an array of common view helpers
+      #
       def self.all_view_helpers
         [
           ActionView::Helpers,

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

@@ -8,8 +8,13 @@ module ViewModels
   #
   class PathStore
     
+    # The view model class attribute
+    #
     attr_reader :view_model_class
     
+    # Initialize the path store
+    # @param [ViewModel] view_model_class The view model class
+    #
     def initialize view_model_class
       @view_model_class = view_model_class
       @name_path_mapping = {}
@@ -31,7 +36,7 @@ module ViewModels
     
     # Prepare the key for the next storing procedure.
     #
-    # Note: If this is nil, the store will not save the path.
+    # @note If this is nil, the store will not save the path.
     #
     def prepare key
       @key = key

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

@@ -1,8 +1,6 @@
 module ViewModels
   
   # Container object for render options.
-  #
-  # TODO Make a rails exclusive.
   # 
   module RenderOptions
     
@@ -10,8 +8,15 @@ module ViewModels
     #
     class Base
       
+      # The different attributes used to generate render options
+      #
       attr_accessor :path, :name, :prefix, :file, :view_model, :format
       
+      # Initialize Render Options
+      # @param [String] prefix The prefix for rendering
+      # @param [String] name The template name
+      # @param [Hash] options The render options as a hash
+      #
       def initialize prefix, name, options
         @prefix = prefix
         @options = options
@@ -24,16 +29,25 @@ module ViewModels
       def error_message
         "'#{error_path}#{name}' with #{error_format}"
       end
+      
+      # The error path, always returns a string
+      # @return [String] The error path
+      #
       def error_path
         path = self.path
         path ? "#{path}/" : ""
       end
+      
+      # The format when trying to render
+      # @return [String] the render format
+      #
       def error_format
         format = self.format
         format ? "format #{format}" : "default format"
       end
       
       # Used when rendering.
+      # @return [Hash] The render options
       #
       def to_render_options
         @options[:locals] ||= {}
@@ -41,7 +55,8 @@ module ViewModels
         @options.reverse_merge :file => file
       end
       
-      # TODO Rails specific.
+      # @todo Rails specific.
+      # @param [ActionView] view The view to render
       #
       def format! view
         view.template_format = @format if @format
@@ -55,7 +70,7 @@ module ViewModels
       
       private
         
-        # TODO rewrite
+        # @todo rewrite
         #
         def template_name= template_name
           template_name.to_s.include?('/') ? specific_path(template_name) : incomplete_path(template_name)

data/lib/view_models/version.rb

@@ -0,0 +1,5 @@
+module ViewModels
+  # The current version of the gem
+  #
+  VERSION = '3.0.0'.freeze
+end

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

@@ -5,7 +5,8 @@ module ViewModels
     
     # Shut up, opinionated funkers.
     #
-    alias singleton_class metaclass unless instance_methods.include?('singleton_class')
+    alias singleton_class metaclass unless instance_methods.include?(:singleton_class) || instance_methods.include?('singleton_class')    
+    
     
     # Include the helpers from the view model.
     #
@@ -19,12 +20,12 @@ module ViewModels
     def render_with options
       render options.to_render_options
     end
-
-    # Finds the template in the view paths at the given path, with its format.
+    
+    # Rails 3 calls it with 2 arguments
     #
-    def find_template path
-      view_paths.find_template path, template_format rescue nil
+    def find_template path, second=nil
+      lookup_context.find_template path rescue nil
     end
-    
+
   end
 end

data/spec/{rails2/lib → lib}/view_models/base_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '/../../spec_helper')
+require 'spec_helper'
 
 describe ViewModels::Base do
   
@@ -53,16 +53,49 @@ describe ViewModels::Base do
     end
   end
   
+  describe "to_param" do
+    before(:each) do
+      @model      = stub :model
+      @view_model = ViewModels::Base.new @model, nil
+    end
+    it "should delegate to_param to the model" do
+      @model.should_receive(:to_param).once
+      
+      @view_model.to_param
+    end
+    
+    it "should delegate id to the model" do
+      @model.should_receive(:id).once
+      
+      @view_model.id
+    end
+    
+    it "should delegate dom_id with no args to ActionController::RecordIdentifier" do
+      ActionController::RecordIdentifier.should_receive(:dom_id).once
+      
+      @view_model.dom_id
+    end
+    
+    it "should delegate dom_id with args to the context" do
+      @context = mock('context')
+      @view_model.stub! :context => @context
+      @context.should_receive(:dom_id).with('arg1', 'arg2').once
+      
+      @view_model.dom_id('arg1', 'arg2')
+    end
+    
+  end
+  
   describe ".master_helper_module" do
     before(:each) do
       class ViewModels::SpecificMasterHelperModule < ViewModels::Base; end
     end
     it "should be a class specific inheritable accessor" do
-      ViewModels::SpecificMasterHelperModule.master_helper_module = :some_value
-      ViewModels::SpecificMasterHelperModule.master_helper_module.should == :some_value
+      ViewModels::SpecificMasterHelperModule._helpers = :some_value
+      ViewModels::SpecificMasterHelperModule._helpers.should == :some_value
     end
     it "should be an instance of Module on Base" do
-      ViewModels::Base.master_helper_module.should be_instance_of(Module)
+      ViewModels::Base._helpers.should be_instance_of(Module)
     end
   end
   
@@ -84,7 +117,7 @@ describe ViewModels::Base do
     end
     it "should include the helper in the master helper module" do
       master_helper_module = Module.new
-      ViewModels::Base.should_receive(:master_helper_module).and_return master_helper_module
+      ViewModels::Base.should_receive(:_helpers).and_return master_helper_module
       
       helper_module = Module.new
       master_helper_module.should_receive(:include).once.with helper_module

data/spec/{rails2/lib → lib/view_models}/extensions/model_reader_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '/../../spec_helper')
+require 'spec_helper'
 
 describe ViewModels::Extensions::ModelReader do
 
@@ -25,7 +25,7 @@ describe ViewModels::Extensions::ModelReader do
       @view_model.some_model_value.should == 's'
     end
     it "should call filters in a given pattern" do
-      @view_model.class.model_reader [:some_model_value], :filter_through => [:a, :b, :a, :a]
+      @view_model.class.model_reader :some_model_value, :filter_through => [:a, :b, :a, :a]
     
       @view_model.some_model_value.should == 'sabaa'
     end
@@ -34,8 +34,8 @@ describe ViewModels::Extensions::ModelReader do
     
       lambda { @view_model.some_model_value }.should_not raise_error
     end
-    it "should handle an array of readers" do
-      @view_model.class.model_reader [:some_model_value, :some_other_model_value], :filter_through => :a
+    it "should handle multiple readers" do
+      @view_model.class.model_reader :some_model_value, :some_other_model_value, :filter_through => :a
     
       lambda { @view_model.some_model_value }.should_not raise_error
     end

data/spec/{shared/lib → lib/view_models}/helpers/collection_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../../spec_helper')
+require 'spec_helper'
 
 describe ViewModels::Helpers::Mapping::Collection do
   include ViewModels::Helpers::Mapping
@@ -9,6 +9,24 @@ describe ViewModels::Helpers::Mapping::Collection do
     @collection_view_model = ViewModels::Helpers::Mapping::Collection.new @collection, @context
   end
   
+  describe "render_partial" do
+    it "should call instance eval on the context" do
+      @context.should_receive(:instance_eval).once
+      
+      @collection_view_model.send :render_partial, :some_name, :some_params
+    end
+    it "should render the partial in the 'context' context" do
+      @context.should_receive(:render).once
+      
+      @collection_view_model.send :render_partial, :some_name, :some_params
+    end
+    it "should call render partial on context with the passed through parameters" do
+      @context.should_receive(:render).once.with(:partial => 'view_models/collection/some_name', :locals => { :a => :b })
+      
+      @collection_view_model.send :render_partial, :some_name, { :a => :b }
+    end
+  end
+  
   describe "collection_view_model_for" do
     it "should return kind of a ViewModels::Collection" do
       collection_view_model_for([]).should be_kind_of ViewModels::Helpers::Mapping::Collection
@@ -119,6 +137,7 @@ describe ViewModels::Helpers::Mapping::Collection do
     it "should call render_partial with the right parameters" do
       default_options = {
         :collection => @collection,
+        :template_name => :pagination,
         :separator => '|'
       }
       @collection_view_model.should_receive(:render_partial).once.with :pagination, default_options
@@ -128,6 +147,7 @@ describe ViewModels::Helpers::Mapping::Collection do
     it "should override the default options if specific options are given" do
       specific_options = {
         :collection => :a,
+        :template_name => :b,
         :separator => :c
       }
       @collection_view_model.should_receive(:render_partial).once.with :pagination, specific_options