view_models 2.0.1 → 3.0.0

data/lib/init.rb

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

data/lib/padrino/README.textile

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

data/lib/padrino/init.rb

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

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

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

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

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

data/lib/rails2/TODO.textile

@@ -1,5 +0,0 @@
-h1. Next up
-
-* Encapsule the rather bloated hierarchical rendering in a HierarchicalRendering object that mediates the whole rendering process.
-
---* Explore possibilities to include Modules in hierarchical rendering.--

data/lib/rails2/generators/view_models/USAGE

@@ -1,6 +0,0 @@
-Usage:
-  script/generate view_models <view model class name>
-  script/generate view_models User
-  
-  script/generate view_models <view model class name> <partials for render_as, separated by space>
-  script/generate view_models User compact extensive list_item table_item

data/lib/rails2/generators/view_models/templates/README

@@ -1 +0,0 @@
-View Model generated. Have fun!

data/lib/rails2/generators/view_models/templates/spec/view_model_spec.rb

@@ -1,7 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-describe ViewModels::<%= class_name %> do
-  
-  
-  
-end

data/lib/rails2/generators/view_models/templates/view_models/view_model.rb

@@ -1,5 +0,0 @@
-class ViewModels::<%= class_name %> < ViewModels::Project
-  
-  # model_reader :icon, :filter_through => [:h]
-  
-end

data/lib/rails2/generators/view_models/templates/views/view_models/collection/_collection.html.erb

@@ -1 +0,0 @@
-<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/lib/rails2/generators/view_models/templates/views/view_models/collection/_collection.text.erb

@@ -1,6 +0,0 @@
-<%- 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/lib/rails2/generators/view_models/templates/views/view_models/collection/_list.html.erb

@@ -1 +0,0 @@
-<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/lib/rails2/generators/view_models/templates/views/view_models/collection/_list.text.erb

@@ -1,6 +0,0 @@
-<% 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/lib/rails2/generators/view_models/templates/views/view_models/collection/_pagination.text.erb

@@ -1,3 +0,0 @@
-<%- if collection.page_count > 1 -%>
-  <%= "Page #{collection.page} of #{collection.page_count}." -%>
-<%- end -%>

data/lib/rails2/generators/view_models/templates/views/view_models/collection/_table.text.erb

@@ -1,10 +0,0 @@
-<%- width = 66 -%>
-<%= '-'*width %>
-<% collection.each do |item| -%>
-<% view_model = view_model_for(item, self) -%>
-<%- result = view_model.render_as(template_name) -%>
-<%= '|' + "%-#{width}s"%(result[0,width]) + '|' -%>
-<%- p ('|' + "%-#{width}s"%(result[0,width]) + '|') %>
-<%= separator || ">#{'-'*(width-2)}<" unless item == collection.entries.last %>
-<% end -%>
-<%= '-'*width %>

data/lib/rails2/generators/view_models/view_models_generator.rb

@@ -1,47 +0,0 @@
-class ViewModelsGenerator < Rails::Generator::NamedBase
-  def manifest
-    record do |m|
-      
-      # Check for class naming collisions.
-      #
-      m.class_collisions "ViewModels::#{class_name}"
-      
-      # ViewModels
-      #
-      m.directory 'app/view_models'
-      m.template "view_models/view_model.rb", "app/view_models/#{file_name}.rb"
-      
-      # Specs
-      #
-      m.directory "spec/app/view_models"
-      m.template "spec/view_model_spec.rb", "spec/app/view_models/#{file_name}_spec.rb"
-      
-      # Views
-      #
-      m.directory "app/views/view_models"
-      m.directory "app/views/view_models/#{file_name}"
-      actions << 'list_item' if actions.empty?
-      actions.each do |action|
-        m.template "views/_empty.html.haml", "app/views/view_models/#{file_name}/_#{action}.html.haml"
-      end
-      
-      # Copy collection views.
-      #
-      m.directory "app/views/view_models/collection"
-      m.file "views/view_models/collection/_collection.html.haml", "app/views/view_models/collection/_collection.html.haml"
-      m.file "views/view_models/collection/_collection.text.erb",  "app/views/view_models/collection/_collection.text.erb"
-      m.file "views/view_models/collection/_list.html.haml",       "app/views/view_models/collection/_list.html.haml"
-      m.file "views/view_models/collection/_list.text.erb",        "app/views/view_models/collection/_list.text.erb"
-      m.file "views/view_models/collection/_pagination.html.haml", "app/views/view_models/collection/_pagination.html.haml"
-      m.file "views/view_models/collection/_pagination.text.erb",  "app/views/view_models/collection/_pagination.text.erb"
-      m.file "views/view_models/collection/_table.html.haml",      "app/views/view_models/collection/_table.html.haml"
-      m.file "views/view_models/collection/_table.text.erb",       "app/views/view_models/collection/_table.text.erb"
-      
-      # Show README.
-      #
-      m.readme "README"
-      
-    end
-  end
-
-end

data/lib/rails2/init.rb

@@ -1,18 +0,0 @@
-# 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/experimental/README.textile

@@ -1,32 +0,0 @@
-h1. module ModulesInRenderHierarchy
-
-Why would we need that?
-
-h2. Situation
-
-We have a music platform. There we have public profiles, and private profiles. And of each type a band, and a venue profile.
-
-Public / Private have different functionality, and also Band / Venue.
-
-The chose class structure looks like this:
-
-@Public::Base < Project@, @Private::Base < Project@
-@Public::Band < Public::Base@, @Public::Venue < Public::Base@, @Private::Band < Private::Base@, @Private::Venue < Private::Base@
-
-To not have duplicate code, we include the functionality for Bands and Venues by using @include BandFunctionality@ and @include VenueFunctionality@.
-
-h2. Problem
-
-When rendering using the hierarchical rendering, we look up the templates as follows:
-
-(For ViewModels::Public::Band#render_as :example, :format => :html)
-# @views/view_models/public/band/_example.html.erb@
-# @views/view_models/public/base/_example.html.erb@
-# @views/view_models/project/_example.html.erb@
-
-So the example template is taken from the @public/band@ directory. Why not from a @functionality/band@ directory (assuming the module is named @Functionality::Band@). The reason for this is that the current (v1.5.4) hierarchical rendering process uses superclass, which hops over Modules, rather than using ancestors, which wouldn't.
-
-h2. Solution
-
-#. Either override superclass, with all associated problems
-#. Or refit the whole hierarchical rendering into a HierarchicalRendering Class. (Preferred)

data/lib/rails2/lib/experimental/modules_in_render_hierarchy.rb

@@ -1,21 +0,0 @@
-module ModulesInRenderHierarchy
-
-  def self.included klass
-    klass.extend ClassMethods
-    klass.metaclass.alias_method_chain :include, :superclass_override
-  end
-
-  module ClassMethods
-    def include_with_superclass_override mod
-      original_superclass = superclass
-      self.send :include_without_superclass_override, mod
-      mod.metaclass.send :define_method, :superclass do
-        original_superclass
-      end
-      metaclass.send :define_method, :superclass do
-        mod
-      end
-    end
-  end
-
-end

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

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

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

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

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