view_models 2.0.1 → 3.0.0

data/lib/shared/README.textile

@@ -1,3 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

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

data/lib/shared/lib/view_models/extensions/active_record.rb

@@ -1,27 +0,0 @@
-# Makes certain AR Model methods available to the view model.
-#
-# Useful when the model is an AR Model.
-#
-# TODO Split into id delegations and AR/AC specific stuff.
-#
-module ViewModels
-  module Extensions
-    module ActiveRecord
-      
-      # id and param are simply delegated to the model.
-      #
-      # This makes it possible to use the view_model
-      # for e.g. url generation:
-      # * edit_user_path(view_model)
-      #
-      delegate :id, :to_param, :to => :model
-      
-      # Delegate to the action controller record identifier.
-      #
-      def dom_id
-        ActionController::RecordIdentifier.dom_id model
-      end
-      
-    end
-  end
-end

data/lib/shared/lib/view_models/helpers/collection.rb

@@ -1,110 +0,0 @@
-module ViewModels
-  module Helpers
-    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.
-        #
-        self.delegate *[Enumerable.instance_methods, :length, :size, :empty?, :each, :exit, { :to => :@collection }].flatten
-        
-        #
-        #
-        def initialize collection, context
-          @collection, @context = collection, context
-        end
-        
-        # Renders a list (in the broadest sense of the word).
-        #
-        # Options:
-        #   collection => collection to iterate over
-        #   context => context to render in
-        #   template_name => template to render for each model element
-        #   separator => separator between each element
-        # By default, uses:
-        #   * The collection of the collection view_model to iterate over.
-        #   * The original context given to the collection view_model to render in.
-        #   * Uses :list_item as the default element template.
-        #   * Uses a nil separator in html.
-        #
-        def list options = {}
-          default_options = { :collection => @collection, :template_name => :list_item, :separator => nil }
-          
-          render_partial :list, default_options.merge(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.
-        #
-        # Options:
-        #   collection => collection to iterate over
-        #   context => context to render in
-        #   template_name => template to render for each model element
-        #   separator => separator between each element
-        # By default, uses:
-        #   * The collection of the collection view_model to iterate over.
-        #   * Uses :collection_item as the default element template.
-        #   * Uses a nil separator.
-        #
-        def collection options = {}
-          default_options = { :collection => @collection, :template_name => :collection_item, :separator => nil }
-          
-          render_partial :collection, default_options.merge(options)
-        end
-        
-        # Renders a table.
-        #
-        # Note: Each item represents a table row.
-        #
-        # Options:
-        #   collection => collection to iterate over
-        #   context => context to render in
-        #   template_name => template to render for each model element
-        #   separator => separator between each element
-        # By default, uses:
-        #   * The collection of the collection view_model to iterate over.
-        #   * Uses :table_row as the default element template.
-        #   * Uses a nil separator.
-        #
-        def table options = {}
-          default_options = { :collection => @collection, :template_name => :table_row, :separator => nil }
-          
-          render_partial :table, default_options.merge(options)
-        end
-        
-        # Renders a pagination.
-        #
-        # Options:
-        #   collection => collection to iterate over
-        #   context => context to render in
-        #   separator => separator between pages
-        # By default, uses:
-        #   * The collection of the collection view_model to iterate over.
-        #   * Uses | as separator.
-        #
-        def pagination options = {}
-          default_options = { :collection => @collection, :separator => '|' }
-          
-          render_partial :pagination, default_options.merge(options)
-        end
-      end
-      
-    end
-  end
-end

data/spec/padrino/integration/integration_spec.rb

@@ -1,287 +0,0 @@
-require File.join(File.dirname(__FILE__), '../spec_helper')
-
-require File.join(File.dirname(__FILE__), 'models/subclass')
-require File.join(File.dirname(__FILE__), 'models/sub_subclass')
-
-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')
-
-class TestApp < Padrino::Application
-  
-end
-
-TestApp.helpers ViewModels::Helpers::Mapping
-
-describe 'Integration' do
-  
-  before(:each) do
-    begin
-      # @controller          = TestController.new
-      # @controller.class.view_paths = ['rails/spec/integration/views']
-      #
-      # 
-      # @request             = ActionController::TestRequest.new
-      # @response            = ActionController::TestResponse.new
-      # @controller.request  = @request
-      # @controller.response = @response
-      # 
-      # # TODO Make separate contexts, one where the controller has rendered, one where it has not.
-      # #
-      # # Let the Controller generate a view instance.
-      # #
-      # # @controller.process @request, @response
-      # 
-      # @view                = ActionView::Base.new @controller.class.view_paths, {}, @controller
-      
-      @app = stub :app
-      TestApp.new(@app) do |some_app|
-        @context = some_app
-      end
-      
-      @logger                         = stub :logger, :null_object => true
-      Thread.current[:padrino_logger] = @logger
-      
-      @model      = SubSubclass.new
-      @model.id   = :some_id
-      @view_model = ViewModels::SubSubclass.new @model, @context
-    end
-  end
-  
-  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
-  
-  # TODO Not ActiveRecord Extensions.
-  #
-  describe 'ActiveRecord Extensions' do
-    before(:each) do
-      @view_model.extend ViewModels::Extensions::ActiveRecord
-    end
-    it 'should delegate the id' do
-      @view_model.id.should == :some_id
-    end
-    # it 'should delegate the id' do
-    #   @view_model.dom_id.should == 'sub_subclass_some_id'
-    # end
-  end
-  
-  describe 'view_model_for' do
-    context 'view model' do
-      it 'should be available' do
-        lambda { @view_model.view_model_for @model }.should_not raise_error
-      end
-      it 'should return the right one' do
-        @view_model.view_model_for(@model).should be_kind_of(ViewModels::SubSubclass)
-      end
-    end
-  end
-  describe 'view_model_class_for' do
-    context 'view model' do
-      it 'should be available' do
-        lambda { @view_model.view_model_class_for @model }.should_not raise_error
-      end
-      it 'should return the right class' do
-        @view_model.view_model_class_for(@model).should == ViewModels::SubSubclass
-      end
-    end
-  end
-  
-  # describe 'capture in view model method' do
-  #   context 'template' do
-  #     it 'should capture the content of the block' do
-  #       @view_model.render_as(:capture_in_template).should == 'Capturing: A Pirate!'
-  #     end
-  #   end
-  #   context 'in view model' do
-  #     it 'should capture the content of the block' do
-  #       @view_model.render_as(:capture_in_view_model).should == 'Capturing: A Pirate!'
-  #     end
-  #   end
-  # end
-  
-  # TODO Write similar.
-  # describe 'app context' do
-  #   it 'should work' do
-  #     controller = ActionController::Base.new
-  #     
-  #     lambda {
-  #       ViewModels::SubSubclass.new @model, controller
-  #     }.should_not raise_error
-  #   end
-  # end
-  
-  # TODO Write anew.
-  # describe 'view_model_for inclusion in view' do
-  #   it 'should be included' do
-  #     view = ActionView::Base.new
-  #     
-  #     lambda {
-  #       view.view_model_for @model
-  #     }.should_not raise_error
-  #   end
-  # end
-  
-  describe 'collection rendering' do
-    context 'default format' do
-      it 'should render a html list' do
-        @view_model.render_as(:list_example).should == "\n\n<ol class=\"collection\"><li>_list_item.html.erb</li><li>_list_item.html.erb</li></ol>"
-      end
-      it 'should render a html collection' do
-        @view_model.render_as(:collection_example).should == "\n\n<ul class=\"collection\"><li>_collection_item.html.erb</li><li>_collection_item.html.erb</li></ul>"
-      end
-    end
-    context 'format html' do
-      it 'should render a html list' do
-        @view_model.render_as(:list_example, :format => :html).should == "\n\n<ol class=\"collection\"><li>_list_item.html.erb</li><li>_list_item.html.erb</li></ol>"
-      end
-      it 'should render a html collection' do
-        @view_model.render_as(:collection_example, :format => :html).should == "\n\n<ul class=\"collection\"><li>_collection_item.html.erb</li><li>_collection_item.html.erb</li></ul>"
-      end
-    end
-    context 'format text' do
-      it 'should render a text list' do
-        @view_model.render_as(:list_example, :format => :text).should == "\n\n_list_item.text.erb\\n_list_item.text.erb"
-      end
-      it 'should render a text collection' do
-        @view_model.render_as(:collection_example, :format => :text).should == "\n\n_collection_item.text.erb_collection_item.text.erb"
-      end
-    end
-  end
-  
-  describe 'model attributes' do
-    it 'should pass through unfiltered attributes' do
-      @view_model.some_untouched_attribute.should == :some_value
-    end
-    it 'should filter some attributes' do
-      @view_model.some_filtered_attribute.should == '%3Cscript%3Efilter+me%3C%2Fscript%3E'
-    end
-    it 'should filter some attributes multiple times' do
-      @view_model.some_doubly_doubled_attribute.should == 'blahblahblahblah'
-    end
-    it 'should filter some attributes multiple times correctly' do
-      @view_model.some_mangled_attribute.should == 'DCBDCB'
-    end
-  end
-  
-  describe 'app_method' do
-    it 'should delegate to the context' do
-      @view_model.logger.should == @logger
-    end
-  end
-  
-  describe "render_template" do
-    it "should render the right template" do
-      @view_model.render_template(:show).should == 'show.html.erb'
-    end
-    it "should render the right template with format" do
-      @view_model.render_template(:show, :format => :text).should == 'show.text.erb'
-    end
-  end
-  
-  describe 'render_as' do
-    describe 'render_the alias' do
-      it 'should also render' do
-        @view_model.render_the(:part_that_is_dependent_on_the_view_model).should == '_part_that_is_dependent_on_the_view_model.erb'
-      end
-    end
-    describe "explicit partial rendering" do
-      it "should render the right partial" do
-        # If one wants explicit template rendering, he needs to work more.
-        # Let's be opinionated here :)
-        #
-        @view_model.render_as(:partial => 'view_models/sub_subclass/inner', :format => :nesting).should == '_inner.nesting.erb'
-      end
-    end
-    describe "nesting" do
-      it "should render the right nested template, with an explicitly defined format (see template)" do
-        @view_model.render_as(:outer, :format => :explicit).should == '_inner.also_explicit.erb'
-      end
-      it "should render the right nested template, respecting the already defined format" do
-        @view_model.render_as(:outer, :format => :nesting).should == '_inner.nesting.erb'
-      end
-    end
-    describe 'template inheritance' do
-      it 'should raise ViewModels::MissingTemplateError if template is not found' do
-        lambda { @view_model.render_as(:this_template_does_not_exist_at_allllll) }.should raise_error(ViewModels::MissingTemplateError, "No template '_this_template_does_not_exist_at_allllll' with default format found.")
-      end
-      it 'should raise ViewModels::MissingTemplateError if template is not found, with specific path' do
-        lambda { @view_model.render_as(:partial => 'view_models/sub_subclass/this_template_does_not_exist_at_allllll') }.should raise_error(ViewModels::MissingTemplateError, "No template 'view_models/sub_subclass/_this_template_does_not_exist_at_allllll' with default format found.")
-      end
-      it 'should raise ViewModels::MissingTemplateError if template is not found, with format' do
-        lambda { @view_model.render_as(:this_template_does_not_exist_at_allllll, :format => :gaga) }.should raise_error(ViewModels::MissingTemplateError, "No template '_this_template_does_not_exist_at_allllll' with format gaga found.")
-      end
-      it "should use its own template" do
-        @view_model.render_as(:exists).should == '_exists.html.erb' # The default
-      end
-      it "should use the subclass' template" do
-        @view_model.render_as(:no_sub_subclass).should == '_no_sub_subclass.erb'
-      end
-    end
-    describe 'format' do
-      it 'should render html' do
-        @view_model.render_as(:exists, :format => nil).should == '_exists.html.erb' # the default
-      end
-      it 'should render erb' do
-        @view_model.render_as(:exists, :format => '').should == '_exists.erb'
-      end
-      it 'should render text' do
-        @view_model.render_as(:exists, :format => :text).should == '_exists.text.erb'
-      end
-      it 'should render html' do
-        @view_model.render_as(:exists, :format => :html).should == '_exists.html.erb'
-      end
-    end
-    describe 'locals' do
-      it 'should render html' do
-        @view_model.render_as(:exists, :locals => { :local_name => :some_local }).should == '_exists.html.erb with some_local'
-      end
-      it 'should render html' do
-        @view_model.render_as(:exists, :format => nil, :locals => { :local_name => :some_local }).should == '_exists.html.erb with some_local'
-      end
-      it 'should render text' do
-        @view_model.render_as(:exists, :format => '', :locals => { :local_name => :some_local }).should == '_exists.erb with some_local'
-      end
-      it 'should render text' do
-        @view_model.render_as(:exists, :format => :text, :locals => { :local_name => :some_local }).should == '_exists.text.erb with some_local'
-      end
-      it 'should render html' do
-        @view_model.render_as(:exists, :format => :html, :locals => { :local_name => :some_local }).should == '_exists.html.erb with some_local'
-      end
-    end
-    describe 'memoizing' do
-      it 'should memoize and not generate always a new path' do
-        @view_model.class.should_receive(:generate_template_path_from).once.and_return "view_models/sub_subclass/_not_found_in_sub_subclass"
-        
-        @view_model.render_as :not_found_in_sub_subclass
-        @view_model.render_as :not_found_in_sub_subclass
-        @view_model.render_as :not_found_in_sub_subclass
-        @view_model.render_as :not_found_in_sub_subclass
-        @view_model.render_as :not_found_in_sub_subclass
-      end
-      it 'should render the right one' do
-        @view_model.render_as :exists_in_both
-        @view_model.render_as(:exists_in_both).should == 'in sub subclass'
-        
-        other_view_model = ViewModels::Subclass.new Subclass.new, @context
-        other_view_model.render_as :exists_in_both
-        other_view_model.render_as(:exists_in_both).should == 'in subclass'
-        
-        @view_model.render_as :exists_in_both
-        @view_model.render_as(:exists_in_both).should == 'in sub subclass'
-      end
-    end
-  end
-  
-end