view_models 1.5.2

data/rails/init.rb

@@ -0,0 +1,18 @@
+require 'extensions/active_record'
+require 'extensions/model_reader'
+
+require 'view_models'
+require 'view_models/render_options'
+require 'view_models/controller_extractor'
+require 'view_models/path_store'
+require 'view_models/base'
+require 'view_models/view'
+
+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

@@ -0,0 +1,269 @@
+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 'helpers/rails'
+ActionView::Base.send :include, ViewModels::Helpers::Rails
+
+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 'action_controller'
+require 'action_controller/test_process'
+
+class TestController < ActionController::Base; end
+
+describe 'Integration' do
+  
+  before(:each) do
+    begin
+      @controller          = TestController.new
+      @controller.class.view_paths = ['spec/integration/views']
+      
+      @logger              = stub :logger, :null_object => true
+      @controller.logger   = @logger
+      
+      @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
+      @model               = SubSubclass.new
+      @model.id            = :some_id
+      @view_model          = ViewModels::SubSubclass.new @model, @view
+    # rescue Exception => e
+    #   puts e.message
+    #   puts e.backtrace
+    end
+  end
+  
+  before(:all) { puts "\n#{self.send(:description_args)[0]}:" }
+  
+  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
+  
+  describe 'controller context' do
+    it 'should work' do
+      controller = ActionController::Base.new
+      
+      lambda {
+        ViewModels::SubSubclass.new @model, controller
+      }.should_not raise_error
+    end
+  end
+  
+  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 == "<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 == "<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 == "<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 == "<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 == '_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 == '_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 'controller_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
+        
+        @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, @view
+        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

data/spec/integration/models/sub_subclass.rb

@@ -0,0 +1,14 @@
+class SubSubclass
+  
+  attr_accessor :id
+  
+  attr_reader :some_untouched_attribute, :some_filtered_attribute, :some_doubly_doubled_attribute, :some_mangled_attribute
+  
+  def initialize
+    @some_untouched_attribute      = :some_value
+    @some_filtered_attribute       = '<script>filter me</script>'
+    @some_doubly_doubled_attribute = 'blah'
+    @some_mangled_attribute        = 'abcd'
+  end
+  
+end

data/spec/integration/models/subclass.rb

@@ -0,0 +1,3 @@
+class Subclass
+  
+end

data/spec/integration/view_models/project.rb

@@ -0,0 +1,14 @@
+class ViewModels::Project < ViewModels::Base
+  
+  helper :all
+  
+  # helper ActionView::Helpers::CaptureHelper
+  
+  helper ViewModels::Helpers::Rails
+  helper ViewModels::Helpers::View
+  
+  # def output_buffer= b
+  #   view.output_buffer = b
+  # end
+  
+end

data/spec/integration/view_models/sub_subclass.rb

@@ -0,0 +1,42 @@
+class ViewModels::SubSubclass < ViewModels::Subclass
+  
+  controller_method :logger
+  
+  model_reader :some_untouched_attribute
+  model_reader :some_filtered_attribute, :filter_through => :h
+  model_reader :some_doubly_doubled_attribute, :filter_through => [:doubled]*2
+  model_reader :some_mangled_attribute, :filter_through => [:reverse, :cutoff, :doubled, :upcase]
+  
+  # h as we know it.
+  #
+  def h v
+    CGI.escape v
+  end
+  
+  # Multiplies the text by 2.
+  #
+  def doubled text
+    text*2
+  end
+  
+  # Cuts off the last 2 characters. Or all, if less than size 2.
+  #
+  def cutoff text
+    text[0..-2]
+  end
+  
+  def reverse text
+    text.reverse
+  end
+  
+  def upcase text
+    text.upcase
+  end
+  
+  # Captures the block as a string.
+  #
+  def capture_block &block
+    capture &block
+  end
+  
+end

data/spec/integration/view_models/subclass.rb

@@ -0,0 +1 @@
+class ViewModels::Subclass < ViewModels::Project; end

data/spec/integration/views/view_models/collection/_collection.html.erb

@@ -0,0 +1 @@
+<ul class="collection"><%- collection.each do |item| -%><%- view_model = view_model_for item -%><li><%- options = template_format ? { :format => template_format } : {} -%><%= view_model.render_as template_name, options -%></li><%= separator unless item == collection.last %><%- end -%></ul>

data/spec/integration/views/view_models/collection/_collection.text.erb

@@ -0,0 +1,6 @@
+<%- collection.each do |item| -%>
+<%- view_model = view_model_for item -%>
+<%- options = (template_format ? { :format => template_format } : {}) -%>
+<%= view_model.render_as template_name, options -%>
+<%= separator unless item == collection.entries.last -%>
+<%- end -%>

data/spec/integration/views/view_models/collection/_list.html.erb

@@ -0,0 +1 @@
+<ol class="collection"><%- collection.each do |item| -%><%- view_model = view_model_for item -%><li><%- options = (template_format ? { :format => template_format } : {}) -%><%= view_model.render_as template_name, options -%></li><%= separator unless item == collection.last %><%- end -%></ol>

data/spec/integration/views/view_models/collection/_list.text.erb

@@ -0,0 +1,6 @@
+<% collection.each do |item| -%>
+<% view_model = view_model_for item -%>
+<%- options = (template_format ? { :format => template_format } : {}) -%>
+<%= view_model.render_as template_name, options -%>
+<%= separator || '\n' unless item == collection.entries.last -%>
+<% end -%>

data/spec/integration/views/view_models/sub_subclass/_capture_in_template.erb

@@ -0,0 +1,2 @@
+<%- @actor = capture do -%>A Pirate!<% end -%>
+Capturing: <%= @actor -%>

data/spec/integration/views/view_models/sub_subclass/_capture_in_view_model.erb

@@ -0,0 +1,3 @@
+Capturing: <%- view_model.capture_block do -%>
+<%= "A Pirate!" -%>
+<%- end -%>

data/spec/integration/views/view_models/sub_subclass/_collection_example.html.erb

@@ -0,0 +1,3 @@
+<%- ary = [SubSubclass.new, SubSubclass.new] -%>
+<%- cvm = collection_view_model_for ary -%>
+<%= cvm.collection -%>

data/spec/integration/views/view_models/sub_subclass/_collection_example.text.erb

@@ -0,0 +1,3 @@
+<%- ary = [SubSubclass.new, SubSubclass.new] -%>
+<%- cvm = collection_view_model_for ary -%>
+<%= cvm.collection -%>

data/spec/integration/views/view_models/sub_subclass/_collection_item.html.erb

@@ -0,0 +1 @@
+_collection_item.html.erb

data/spec/integration/views/view_models/sub_subclass/_collection_item.text.erb

@@ -0,0 +1 @@
+_collection_item.text.erb

data/spec/integration/views/view_models/sub_subclass/_exists.erb

@@ -0,0 +1 @@
+_exists.erb<%= " with #{local_name}" if defined?(local_name) %>

data/spec/integration/views/view_models/sub_subclass/_exists.html.erb

@@ -0,0 +1 @@
+_exists.html.erb<%= " with #{local_name}" if defined?(local_name) %>

data/spec/integration/views/view_models/sub_subclass/_exists.text.erb

@@ -0,0 +1 @@
+_exists.text.erb<%= " with #{local_name}" if defined?(local_name) %>

data/spec/integration/views/view_models/sub_subclass/_exists_in_both.erb

@@ -0,0 +1 @@
+in sub subclass

data/spec/integration/views/view_models/sub_subclass/_inner.also_explicit.erb

@@ -0,0 +1 @@
+_inner.also_explicit.erb

data/spec/integration/views/view_models/sub_subclass/_inner.nesting.erb

@@ -0,0 +1 @@
+_inner.nesting.erb

data/spec/integration/views/view_models/sub_subclass/_list_example.html.erb

@@ -0,0 +1,3 @@
+<%- ary = [SubSubclass.new, SubSubclass.new] -%>
+<%- cvm = collection_view_model_for ary -%>
+<%= cvm.list -%>

data/spec/integration/views/view_models/sub_subclass/_list_example.text.erb

@@ -0,0 +1,3 @@
+<%- ary = [SubSubclass.new, SubSubclass.new] -%>
+<%- cvm = collection_view_model_for ary -%>
+<%= cvm.list -%>

data/spec/integration/views/view_models/sub_subclass/_list_item.html.erb

@@ -0,0 +1 @@
+_list_item.html.erb

data/spec/integration/views/view_models/sub_subclass/_list_item.text.erb

@@ -0,0 +1 @@
+_list_item.text.erb

data/spec/integration/views/view_models/sub_subclass/_outer.explicit.erb

@@ -0,0 +1 @@
+<%= view_model.render_as(:inner, :format => :also_explicit) -%>

data/spec/integration/views/view_models/sub_subclass/_outer.nesting.erb

@@ -0,0 +1 @@
+<%= view_model.render_as :inner -%>

data/spec/integration/views/view_models/sub_subclass/_part_that_is_dependent_on_the_view_model.erb

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

data/spec/integration/views/view_models/sub_subclass/show.html.erb

@@ -0,0 +1 @@
+show.html.erb

data/spec/integration/views/view_models/sub_subclass/show.text.erb

@@ -0,0 +1 @@
+show.text.erb

data/spec/integration/views/view_models/subclass/_exists_in_both.erb

@@ -0,0 +1 @@
+in subclass

data/spec/integration/views/view_models/subclass/_no_sub_subclass.erb

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

data/spec/integration/views/view_models/subclass/_not_found_in_sub_subclass.erb

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

data/spec/lib/extensions/active_record_spec.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+describe ViewModels::Extensions::ActiveRecord do
+  
+  describe "to_param" do
+    before(:each) do
+      @model      = stub :model
+      @view_model = ViewModels::Base.new @model, nil
+      @view_model.extend ViewModels::Extensions::ActiveRecord
+    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 to ActionController::RecordIdentifier" do
+      ActionController::RecordIdentifier.should_receive(:dom_id).once
+      
+      @view_model.dom_id
+    end
+    
+  end
+  
+end

data/spec/lib/extensions/model_reader_spec.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+require 'extensions/model_reader'
+
+describe ViewModels::Extensions::ModelReader do
+
+  class ModelReaderModel < Struct.new(:some_model_value); end
+  
+  describe ".model_reader" do
+    before(:each) do
+      @model = ModelReaderModel.new
+      @view_model = ViewModels::Base.new(@model, nil)
+      class << @view_model
+        def a(s); s << 'a' end
+        def b(s); s << 'b' end
+      end
+      @model.some_model_value = '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.some_model_value.should == 'sabaa'
+    end
+    it "should pass through the model value if no filters are installed" do
+      @view_model.class.model_reader :some_model_value
+    
+      @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.some_model_value.should == 'sabaa'
+    end
+    it "should handle a single filter" do
+      @view_model.class.model_reader :some_model_value, :filter_through => :a
+    
+      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
+    
+      lambda { @view_model.some_model_value }.should_not raise_error
+    end
+  end
+  
+  describe 'FilteredDelegationInstaller' do
+    before(:each) do
+      @model = ModelReaderModel.new
+    end
+    context 'with filters' do
+      before(:each) do
+        @options = ViewModels::Extensions::ModelReader::Options.new :some_attribute_name, :filter_through => [:filter1, :filter2]
+        @installer = ViewModels::Extensions::ModelReader::FilteredDelegationInstaller.new @model, @options
+      end
+      it 'should have a correct filter definition' do
+        @installer.reader_definition_for(:some_attribute).should == 'def some_attribute; filter2(filter1(model.some_attribute)); end'
+      end
+    end
+    context 'without filters' do
+      before(:each) do
+        @options = ViewModels::Extensions::ModelReader::Options.new :some_attribute_name
+        @installer = ViewModels::Extensions::ModelReader::FilteredDelegationInstaller.new @model, @options
+      end
+      it 'should have a correct filter definition' do
+        @installer.reader_definition_for(:some_attribute).should == 'def some_attribute; model.some_attribute; end'
+      end
+    end
+  end
+  
+  describe 'Options' do
+    context 'without filters' do
+      before(:each) do
+        @options = ViewModels::Extensions::ModelReader::Options.new :some_attribute_name
+      end
+      describe 'split' do
+        it 'should return the right values' do
+          @options.to_a.should == [[:some_attribute_name], []]
+        end
+      end
+    end
+    context 'with filters' do
+      before(:each) do
+        @options = ViewModels::Extensions::ModelReader::Options.new :some_attribute_name, :filter_through => [:filter1, :filter2]
+      end
+      describe 'split' do
+        it 'should return the right values, with flipped options' do
+          @options.to_a.should == [[:some_attribute_name], [:filter2, :filter1]]
+        end
+      end
+    end
+  end
+  
+end