view_models 1.5.2

data/spec/lib/helpers/collection_spec.rb

@@ -0,0 +1,196 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+describe ViewModels::Helpers::Rails::Collection do
+  
+  before(:each) do
+    @collection = stub :collection
+    @context    = stub :context
+    @collection_view_model = ViewModels::Helpers::Rails::Collection.new @collection, @context
+  end
+  
+  describe "list" do
+    it "should call render_partial and return the rendered result" do
+      @collection_view_model.stub! :render_partial => :result
+      
+      @collection_view_model.list.should == :result
+    end
+    it "should call render_partial with the right parameters" do
+      default_options = {
+        :collection => @collection,
+        :template_name => :list_item,
+        :separator => nil
+      }
+      
+      @collection_view_model.should_receive(:render_partial).once.with :list, default_options
+      
+      @collection_view_model.list
+    end
+    it "should override the default options if specific options are given" do
+      specific_options = {
+        :collection => :a,
+        :template_name => :c,
+        :separator => :d
+      }
+      
+      @collection_view_model.should_receive(:render_partial).once.with :list, specific_options
+      
+      @collection_view_model.list specific_options
+    end
+  end
+  
+  describe "collection" do
+    it "should call render_partial and return the rendered result" do
+      @collection_view_model.stub! :render_partial => :result
+      
+      @collection_view_model.collection.should == :result
+    end
+    it "should call render_partial with the right parameters" do
+      default_options = {
+        :collection => @collection,
+        :template_name => :collection_item,
+        :separator => nil
+      }
+      @collection_view_model.should_receive(:render_partial).once.with :collection, default_options
+      
+      @collection_view_model.collection
+    end
+    it "should override the default options if specific options are given" do
+      specific_options = {
+        :collection => :a,
+        :template_name => :c,
+        :separator => :d
+      }
+      
+      @collection_view_model.should_receive(:render_partial).once.with :collection, specific_options
+      
+      @collection_view_model.collection specific_options
+    end
+  end
+  
+  describe "table" do
+    it "should call render_partial and return the rendered result" do
+      @collection_view_model.stub! :render_partial => :result
+      
+      @collection_view_model.table.should == :result
+    end
+    it "should call render_partial with the right parameters" do
+      default_options = {
+        :collection => @collection,
+        :template_name => :table_row,
+        :separator => nil
+      }
+      
+      @collection_view_model.should_receive(:render_partial).once.with :table, default_options
+      
+      @collection_view_model.table
+    end
+    it "should override the default options if specific options are given" do
+      specific_options = {
+        :collection => :a,
+        :template_name => :c,
+        :separator => :d
+      }
+      
+      @collection_view_model.should_receive(:render_partial).once.with :table, specific_options
+      
+      @collection_view_model.table(specific_options)
+    end
+  end
+  
+  describe "pagination" do
+    it "should call render_partial and return the rendered result" do
+      @collection_view_model.stub! :render_partial => :result
+      
+      @collection_view_model.pagination.should == :result
+    end
+    it "should call render_partial with the right parameters" do
+      default_options = {
+        :collection => @collection,
+        :separator => '|'
+      }
+      @collection_view_model.should_receive(:render_partial).once.with :pagination, default_options
+      
+      @collection_view_model.pagination
+    end
+    it "should override the default options if specific options are given" do
+      specific_options = {
+        :collection => :a,
+        :separator => :c
+      }
+      @collection_view_model.should_receive(:render_partial).once.with :pagination, specific_options
+      
+      @collection_view_model.pagination specific_options
+    end
+  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 "delegation" do
+    describe "enumerable" do
+      Enumerable.instance_methods.map(&:to_sym).each do |method|
+        it "should delegate #{method} to the collection" do
+          @collection.should_receive(method).once
+          
+          @collection_view_model.send method
+        end
+      end
+    end
+    describe "array" do
+      describe "length" do
+        it "should delegate to #length of the collection" do
+          @collection.should_receive(:length).once
+          
+          @collection_view_model.length
+        end
+        it "should return the length of the collection" do
+          @collection.should_receive(:length).and_return :this_length
+          
+          @collection_view_model.length.should == :this_length
+        end
+        it "should alias size" do
+          @collection.should_receive(:size).and_return :this_length
+          
+          @collection_view_model.size.should == :this_length
+        end
+      end
+      describe "empty?" do
+        it "should delegate to #empty? of the collection" do
+          @collection.should_receive(:empty?).once
+          
+          @collection_view_model.empty?
+        end
+        it "should return whatever #empty? of the collection returns" do
+          @collection.should_receive(:empty?).and_return :true_or_false
+          
+          @collection_view_model.empty?.should == :true_or_false
+        end
+      end
+      describe "each" do
+        it "should delegate to #each of the collection" do
+          proc = stub :proc
+          
+          @collection.should_receive(:each).with(proc).once
+          
+          @collection_view_model.each proc
+        end
+      end
+    end
+  end
+  
+end

data/spec/lib/helpers/rails_spec.rb

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+describe ViewModels::Helpers::Rails do
+  include ViewModels::Helpers::Rails
+  
+  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::Rails::Collection
+    end
+    it "should pass any parameters directly through" do
+      collection = stub :collection
+      context = stub :context
+      ViewModels::Helpers::Rails::Collection.should_receive(:new).with(collection, context).once
+      collection_view_model_for collection, context
+    end
+  end
+  
+  describe "view_model_for" do
+    it "should just pass the params through to the view_model" do
+      class SomeModelClazz; end
+      class ViewModels::SomeModelClazz < ViewModels::Base; end
+      context = stub :context
+      self.stub! :default_view_model_class_for => ViewModels::SomeModelClazz
+      model = SomeModelClazz.new
+      
+      ViewModels::SomeModelClazz.should_receive(:new).once.with model, context
+      
+      view_model_for model, context
+    end
+    describe "specific_view_model_mapping" do
+      it "should return an empty hash by default" do
+        specific_view_model_mapping.should == {}
+      end
+      it "should raise an ArgumentError on an non-mapped model" do
+        # TODO really clear enough that one should provide a ViewModel with an initializer with 2 params?
+        #
+        class SomeViewModelClass; end
+        specific_view_model_mapping[String] = SomeViewModelClass
+        lambda {
+          view_model_for("Some String")
+        }.should raise_error(ArgumentError, "wrong number of arguments (2 for 0)")
+      end
+    end
+    describe "no specific mapping" do
+      it "should raise on an non-mapped model" do
+        # TODO really clear enough that the view model class is missing?
+        #
+        lambda {
+          view_model_for(42)
+        }.should raise_error(NameError, "uninitialized constant ViewModels::Fixnum")
+      end
+      it "should return a default view_model instance" do
+        class SomeModelClazz; end
+        class ViewModels::SomeModelClazz < ViewModels::Base; end
+        view_model_for(SomeModelClazz.new).should be_instance_of ViewModels::SomeModelClazz
+      end
+    end
+    describe "with specific mapping" do
+      class SomeModelClazz; end
+      class ViewModels::SomeSpecificClazz < ViewModels::Base; end
+      before(:each) do
+        self.should_receive(:specific_view_model_mapping).any_number_of_times.and_return SomeModelClazz => ViewModels::SomeSpecificClazz
+      end
+      it "should return a specifically mapped view_model instance" do
+        view_model_for(SomeModelClazz.new).should be_instance_of ViewModels::SomeSpecificClazz
+      end
+      it "should not call #default_view_model_class_for" do
+        mock(self).should_receive(:default_view_model_class_for).never
+        view_model_for SomeModelClazz.new
+      end
+    end
+  end
+  
+  describe "default_view_model_class_for" do
+    it "should return a class with ViewModels:: prepended" do
+      class Gaga; end # The model.
+      class ViewModels::Gaga < ViewModels::Base; end
+      default_view_model_class_for(Gaga.new).should == ViewModels::Gaga
+    end
+    it "should raise a NameError if the Presenter class does not exist" do
+      class Brrzt; end # Just the model.
+      lambda {
+        default_view_model_class_for(Brrzt.new)
+      }.should raise_error(NameError, "uninitialized constant ViewModels::Brrzt")
+    end
+  end
+  
+end

data/spec/lib/helpers/view_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+require 'helpers/view'
+
+describe ViewModels::Helpers::View do
+  
+  class TestClass; end
+  
+  describe "including it" do
+    it "should include all the view helpers" do
+      in_the TestClass do
+        include ViewModels::Helpers::View
+      end
+      
+      TestClass.should include(ActionView::Helpers)
+      TestClass.should include(ERB::Util)
+    end
+  end
+
+end

data/spec/lib/view_models/base_spec.rb

@@ -0,0 +1,102 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+require 'view_models/base'
+
+describe ViewModels::Base do
+  
+  describe "readers" do
+    describe "model" do
+      before(:each) do
+        @model      = stub :model
+        @view_model = ViewModels::Base.new @model, nil
+      end
+      it "should have a reader" do
+        @view_model.model.should == @model
+      end
+    end
+    describe "controller" do
+      before(:each) do
+        @context    = stub :controller
+        @view_model = ViewModels::Base.new nil, @context
+      end
+      it "should have a reader" do
+        @view_model.controller.should == @context
+      end
+    end
+  end
+  
+  describe "context recognition" do
+    describe "context is a view" do
+      before(:each) do
+        @view = stub :view, :controller => 'controller'
+        @view_model = ViewModels::Base.new nil, @view
+      end
+      it "should get the controller from the view" do
+        @view_model.controller.should == 'controller'
+      end
+    end
+    describe "context is a controller" do
+      before(:each) do
+        @controller = stub :controller
+        @view_model = ViewModels::Base.new nil, @controller
+      end
+      it "should just use it for the controller" do
+        @view_model.controller.should == @controller
+      end
+    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
+    end
+    it "should be an instance of Module on Base" do
+      ViewModels::Base.master_helper_module.should be_instance_of(Module)
+    end
+  end
+  
+  describe ".controller_method" do
+    it "should set up delegate calls to the controller" do
+      ViewModels::Base.should_receive(:delegate).once.with(:method1, :method2, :to => :controller)
+      
+      ViewModels::Base.controller_method :method1, :method2
+    end
+  end
+  
+  describe ".helper" do
+    it "should include the helper" do
+      helper_module = Module.new
+      
+      ViewModels::Base.should_receive(:include).once.with helper_module
+      
+      ViewModels::Base.helper helper_module
+    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
+      
+      helper_module = Module.new
+      master_helper_module.should_receive(:include).once.with helper_module
+      
+      ViewModels::Base.helper helper_module
+    end
+  end
+  
+  describe "#logger" do
+    it "should delegate to the controller" do
+      controller = stub :controller
+      view_model = ViewModels::Base.new nil, controller
+      
+      controller.should_receive(:logger).once
+      
+      in_the view_model do
+        logger
+      end
+    end
+  end
+  
+end

data/spec/lib/view_models/view_spec.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '../../spec_helper')
+
+require 'view_models/view'
+
+describe ViewModels::View do
+  
+  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+
+require 'spec'
+
+require 'active_support'
+require 'action_controller'
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require File.join(File.dirname(__FILE__), '../init')
+
+require 'spec_helper_extensions'
+include SpecHelperExtensions

data/spec/spec_helper_extensions.rb

@@ -0,0 +1,13 @@
+module SpecHelperExtensions
+
+  # Used to test private methods.
+  #
+  # The idea is to replace instance.send :private_method.
+  # Now it is rather like:
+  # We have the scenario we are in the given instance.
+  #
+  def in_the(instance, &block)
+    instance.instance_eval(&block)
+  end
+  
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: view_models
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 5
+  - 2
+  version: 1.5.2
+platform: ruby
+authors: 
+- Florian Hanke
+- Kaspar Schiess
+- Niko Dittmann
+- Andreas Schacke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-01 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "The view models gem adds the missing R (Representation) to Rails' MVC. It provides simple proxy functionality for your models and thus helps you keep the model and view representations of a model separate, as it should be. Also, you can define helper methods on the (view) model instead of globally to keep them focused, more quickly understood and more easily testable. View Models also introduce hierarchical rendering for your hierarchical models. If the account view is not defined for the subclass FemaleUser, it checks if it is defined for User, for example, to see when there is no specific view, if there is a general view. So, in other words: Polymorphism not just in the model, but also in the view."
+email: florian.hanke@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
+- generators/view_models/USAGE
+- generators/view_models/templates/README
+- generators/view_models/templates/spec/view_model_spec.rb
+- generators/view_models/templates/view_models/view_model.rb
+- generators/view_models/templates/views/_empty.html.haml
+- generators/view_models/templates/views/view_models/collection/_collection.html.erb
+- generators/view_models/templates/views/view_models/collection/_collection.html.haml
+- generators/view_models/templates/views/view_models/collection/_collection.text.erb
+- generators/view_models/templates/views/view_models/collection/_list.html.erb
+- generators/view_models/templates/views/view_models/collection/_list.html.haml
+- generators/view_models/templates/views/view_models/collection/_list.text.erb
+- generators/view_models/templates/views/view_models/collection/_pagination.html.haml
+- generators/view_models/templates/views/view_models/collection/_pagination.text.erb
+- 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/extensions/active_record.rb
+- lib/extensions/model_reader.rb
+- lib/extensions/view.rb
+- lib/helpers/collection.rb
+- lib/helpers/rails.rb
+- lib/helpers/view.rb
+- lib/view_models.rb
+- lib/view_models/base.rb
+- lib/view_models/controller_extractor.rb
+- lib/view_models/path_store.rb
+- lib/view_models/render_options.rb
+- lib/view_models/view.rb
+- rails/init.rb
+- spec/integration/integration_spec.rb
+- spec/integration/models/sub_subclass.rb
+- spec/integration/models/subclass.rb
+- spec/integration/view_models/project.rb
+- spec/integration/view_models/sub_subclass.rb
+- spec/integration/view_models/subclass.rb
+- spec/integration/views/view_models/collection/_collection.html.erb
+- 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/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
+- spec/integration/views/view_models/sub_subclass/_collection_example.text.erb
+- spec/integration/views/view_models/sub_subclass/_collection_item.html.erb
+- spec/integration/views/view_models/sub_subclass/_collection_item.text.erb
+- spec/integration/views/view_models/sub_subclass/_exists.erb
+- spec/integration/views/view_models/sub_subclass/_exists.html.erb
+- spec/integration/views/view_models/sub_subclass/_exists.text.erb
+- spec/integration/views/view_models/sub_subclass/_exists_in_both.erb
+- spec/integration/views/view_models/sub_subclass/_inner.also_explicit.erb
+- spec/integration/views/view_models/sub_subclass/_inner.nesting.erb
+- spec/integration/views/view_models/sub_subclass/_list_example.html.erb
+- spec/integration/views/view_models/sub_subclass/_list_example.text.erb
+- spec/integration/views/view_models/sub_subclass/_list_item.html.erb
+- spec/integration/views/view_models/sub_subclass/_list_item.text.erb
+- spec/integration/views/view_models/sub_subclass/_outer.explicit.erb
+- spec/integration/views/view_models/sub_subclass/_outer.nesting.erb
+- spec/integration/views/view_models/sub_subclass/_part_that_is_dependent_on_the_view_model.erb
+- spec/integration/views/view_models/sub_subclass/show.html.erb
+- spec/integration/views/view_models/sub_subclass/show.text.erb
+- spec/integration/views/view_models/subclass/_exists_in_both.erb
+- spec/integration/views/view_models/subclass/_no_sub_subclass.erb
+- spec/integration/views/view_models/subclass/_not_found_in_sub_subclass.erb
+- spec/lib/extensions/active_record_spec.rb
+- spec/lib/extensions/model_reader_spec.rb
+- spec/lib/helpers/collection_spec.rb
+- spec/lib/helpers/rails_spec.rb
+- spec/lib/helpers/view_spec.rb
+- spec/lib/view_models/base_spec.rb
+- spec/lib/view_models/view_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_extensions.rb
+has_rdoc: true
+homepage: http://floere.github.com/view_models
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A model proxy for Rails views. Helps you keep the representation of a model and the model itself separate.
+test_files: 
+- spec/integration/integration_spec.rb
+- spec/integration/models/sub_subclass.rb
+- spec/integration/models/subclass.rb
+- spec/integration/view_models/project.rb
+- spec/integration/view_models/sub_subclass.rb
+- spec/integration/view_models/subclass.rb
+- spec/lib/extensions/active_record_spec.rb
+- spec/lib/extensions/model_reader_spec.rb
+- spec/lib/helpers/collection_spec.rb
+- spec/lib/helpers/rails_spec.rb
+- spec/lib/helpers/view_spec.rb
+- spec/lib/view_models/base_spec.rb
+- spec/lib/view_models/view_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_extensions.rb