cells 3.10.1 → 3.11.0

data/lib/cell/test_case.rb

@@ -96,7 +96,7 @@ module Cell
       #     assert_select html, "h1", "The latest and greatest!"
       def render_cell(name, state, *args)
         # DISCUSS: should we allow passing a block here, just as in controllers?
-        @subject_cell = ::Cell::Rails.create_cell_for(name, @controller, *args)
+        @subject_cell = ::Cell::Rails.cell_for(name, @controller, *args)
         @view_assigns = extract_state_ivars_for(@subject_cell) do
           @last_invoke = @subject_cell.render_state(state, *args)
         end
@@ -110,7 +110,7 @@ module Cell
       # Example:
       #   assert_equal "Doo Dumm Dumm..." cell(:bassist).play
       def cell(name, *args, &block)
-        Cell::Rails.create_cell_for(name, @controller, *args).tap do |cell|
+        Cell::Rails.cell_for(name, @controller, *args).tap do |cell|
           cell.instance_eval &block if block_given?
         end
       end
@@ -150,7 +150,7 @@ module Cell
       @last_invoke = self.class.controller_class.new(@controller).render_state(state, *args)
     end
 
-    if Cell.rails4_0? or Cell.rails4_1?
+    if Cell.rails_version.~("4.0", "4.1")
       include ActiveSupport::Testing::ConstantLookup
       def self.determine_default_controller_class(name) # FIXME: fix that in Rails 4.x.
         determine_constant_from_test_name(name) do |constant|

data/lib/cell/view_model.rb

@@ -0,0 +1,151 @@
+# no helper_method calls
+# no instance variables
+# no locals
+# options are automatically made instance methods via constructor.
+# call "helpers" in class
+
+# TODO: warn when using ::property but not passing in model in constructor.
+
+class Cell::ViewModel < Cell::Rails
+  abstract!
+
+  include Cell::OptionsConstructor
+  #include ActionView::Helpers::UrlHelper
+  include ActionView::Context # this includes CompiledTemplates, too.
+  # properties :title, :body
+  attr_reader :model
+
+
+
+  module Helpers
+    # DISCUSS: highest level API method. add #cell here.
+    def collection(name, controller, array, method=:show)
+      # FIXME: this is the problem in Concept cells, we don't wanna call Cell::Rails.cell_for here.
+      array.collect { |model| cell_for(name, controller, model).call(method) }.join("\n").html_safe
+    end
+
+    # TODO: this should be in Helper or something. this should be the only entry point from controller/view.
+    def cell(name, controller, *args, &block) # classic Rails fuzzy API.
+      if args.first.is_a?(Hash) and array = args.first[:collection]
+        return collection(name, controller, array)
+      end
+
+      cell_for(name, controller, *args, &block)
+    end
+  end
+  extend Helpers # FIXME: do we really need ViewModel::cell/::collection ?
+
+
+  class << self
+    def property(*names)
+      delegate *names, :to => :model
+    end
+
+    include Helpers
+  end
+
+  def cell(name, *args)
+    self.class.cell(name, parent_controller, *args)
+  end
+
+
+  def initialize(*args)
+    super
+    _prepare_context # happens in AV::Base at the bottom.
+  end
+
+  def render(options={})
+    if options.is_a?(Hash)
+      options.reverse_merge!(:view => state_for_implicit_render)
+    else
+      options = {:view => options.to_s}
+    end
+
+    super
+  end
+
+  def call(state=:show)
+    # it is ok to call to_s.html_safe here as #call is a defined rendering method.
+    # DISCUSS: IN CONCEPT: render( view: implicit_state)
+    render_state(state).to_s.html_safe
+  end
+
+private
+  def view_context
+    self
+  end
+
+  def state_for_implicit_render()
+    caller[1].match(/`(\w+)/)[1]
+  end
+
+  # def implicit_state
+  #   controller_path.split("/").last
+  # end
+
+
+  # FIXME: this module is to fix a design flaw in Rails 4.0. the problem is that AV::UrlHelper mixes in the wrong #url_for.
+  # if we could mix in everything else from the helper except for the #url_for, it would be fine.
+  module LinkToHelper
+    include ActionView::Helpers::TagHelper
+
+    def link_to(name = nil, options = nil, html_options = nil, &block)
+      html_options, options, name = options, name, block if block_given?
+      options ||= {}
+
+      html_options = convert_options_to_data_attributes(options, html_options)
+
+      url = url_for(options)
+      html_options['href'] ||= url
+
+      content_tag(:a, name || url, html_options, &block)
+    end
+
+    def convert_options_to_data_attributes(options, html_options)
+      if html_options
+        html_options = html_options.stringify_keys
+        html_options['data-remote'] = 'true' if link_to_remote_options?(options) || link_to_remote_options?(html_options)
+
+        disable_with = html_options.delete("disable_with")
+        confirm = html_options.delete('confirm')
+        method  = html_options.delete('method')
+
+        if confirm
+          message = ":confirm option is deprecated and will be removed from Rails 4.1. " \
+                    "Use 'data: { confirm: \'Text\' }' instead."
+          ActiveSupport::Deprecation.warn message
+
+          html_options["data-confirm"] = confirm
+        end
+
+        add_method_to_attributes!(html_options, method) if method
+
+        if disable_with
+          message = ":disable_with option is deprecated and will be removed from Rails 4.1. " \
+                    "Use 'data: { disable_with: \'Text\' }' instead."
+          ActiveSupport::Deprecation.warn message
+
+          html_options["data-disable-with"] = disable_with
+        end
+
+        html_options
+      else
+        link_to_remote_options?(options) ? {'data-remote' => 'true'} : {}
+      end
+    end
+
+    def link_to_remote_options?(options)
+      if options.is_a?(Hash)
+        options.delete('remote') || options.delete(:remote)
+      end
+    end
+  end
+
+  # FIXME: fix that in rails core.
+  if Cell.rails_version.~("4.0", "4.1")
+    include LinkToHelper
+  else
+    include ActionView::Helpers::UrlHelper
+  end
+
+end

data/lib/cells.rb

@@ -1,63 +1,3 @@
-# = Cells
-#
-# Cells are view components for Rails. Being lightweight controllers with actions and views, cells are the
-# answer to <tt>DoubleRenderError</tt>s and the long awaited ability to render actions within actions.
-#
-# == Directory structure
-#
-# Cells live in +app/cells/+ and have a similar file layout as controllers.
-#
-#   app/
-#     cells/
-#       shopping_cart_cell.rb
-#       shopping_cart/
-#         status.html.erb
-#         product_list.haml
-#       layouts/
-#         box.html.erb
-#
-# == Cell nesting
-#
-# Is is good practice to split up complex cell views into multiple states or views. Remember, you can always use
-# <tt>render :view => ...</tt> and <tt>render :state => ...</tt> in your views.
-#
-# Following this, you stick to encapsulation and save your code from getting inscrutable, as it happens in most
-# controller views, partials, and so called "helpers".
-#
-# Given the following setup:
-#
-#   class ShoppingCartCell < Cell::Base
-#     def cart
-#       @items = items_in_cart
-#       render
-#     end
-#
-#     def order_button
-#       render
-#     end
-#
-# You could now render the "Order!" button in the +cart.haml+ view.
-#
-#   - for item in @items
-#     = @item.title
-#
-#   render :state => :order_button
-#
-# which is more than just a partial, as you may execute additional code in the state method.
-#
-# == View inheritance
-#
-# Unlike controllers, Cells can form a class hierarchy. Even views are inherited, which is pretty useful
-# when overriding only small parts of the view.
-#
-# So if you'd need a special "Order!" button with sparkling stars on christmas, your cell would go like this.
-#
-#   class XmasCartCell < ShoppingCartCell
-#   end
-#
-# Beside your new class you'd provide a star-sprangled button view in +xmas_cart/order_button.haml+.
-# When rendering the +cart+ state, the states as well as the "missing" views are inherited from ancesting cells,
-# this is pretty DRY and object-oriented, isn't it?
 module Cells
   # Setup your special needs for Cells here. Use this to add new view paths.
   #

data/lib/cells/rails.rb

@@ -4,10 +4,16 @@ module Cells
   module Rails
     module ActionController
       def cell_for(name, *args, &block)
+        return Cell::Rails::ViewModel.cell(name, self, *args, &block) if args.first.is_a?(Hash) and args.first[:collection] # FIXME: we only want this feature in view models for now.
         ::Cell::Base.cell_for(name, self, *args, &block)
       end
       alias_method :cell, :cell_for # DISCUSS: make this configurable?
 
+      def concept_for(name, *args, &block)
+        return Cell::Concept.cell(name, self, *args, &block)
+      end
+      alias_method :concept, :concept_for
+
       # Renders the cell state and returns the content. You may pass options here, too. They will be
       # around in @opts.
       #
@@ -42,11 +48,6 @@ module Cells
       #
       # will expire the view for state <tt>:display_list</tt> in the cell <tt>MyListingCell</tt>.
       def expire_cell_state(cell_class, state, args={}, opts=nil)
-        if cell_class.is_a?(Symbol)
-          ActiveSupport::Deprecation.warn "Please pass the cell class into #expire_cell_state, as in expire_cell_state(DirectorCell, :count, :user_id => 1)"
-          cell_class = Cell::Rails.class_from_cell_name(cell_class)
-        end
-
         key = cell_class.state_cache_key(state, args)
         cell_class.expire_cache_key(key, opts)
       end
@@ -66,6 +67,10 @@ module Cells
       def render_cell(name, state, *args, &block)
         ::Cell::Rails.render_cell_for(name, state, controller, *args, &block)
       end
+
+      def concept(name, *args, &block)
+        controller.concept_for(name, *args, &block)
+      end
     end
   end
 end

data/lib/cells/railtie.rb

@@ -7,14 +7,10 @@ module Cells
 
     initializer "cells.attach_router" do |app|
       Cell::Base.class_eval do
-        include app.routes.url_helpers
+        include app.routes.url_helpers # TODO: i hate this, make it better in Rails.
       end
     end
 
-    initializer "cells.setup_view_paths" do |app|
-      Cell::Base.setup_view_paths!
-    end
-
     initializer "cells.setup_engines_view_paths" do |app|
       Cells::Engines.append_engines_view_paths_for(app.config.action_controller)
     end
@@ -24,6 +20,7 @@ module Cells
       (app.config.cells.with_assets or []).each do |name|
         # FIXME: this doesn't take engine cells into account.
         app.config.assets.paths << "#{app.root}/app/cells/#{name}/assets"
+        app.config.assets.paths << "#{app.root}/app/concepts/#{name}/assets" # TODO: find out type.
       end
     end
 

data/lib/cells/version.rb

@@ -1,3 +1,3 @@
 module Cells
-  VERSION = '3.10.1'
+  VERSION = '3.11.0'
 end

data/lib/generators/erb/concept_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/trailblazer/view_generator'
+
+module Erb
+  module Generators
+    class ConceptGenerator < ::Trailblazer::Generators::ViewGenerator
+
+      source_root File.expand_path('../../templates/concept', __FILE__)
+
+    private
+      def handler
+        :erb
+      end
+    end
+  end
+end
+
+

data/lib/generators/haml/concept_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/trailblazer/view_generator'
+
+module Haml
+  module Generators
+    class ConceptGenerator < ::Trailblazer::Generators::ViewGenerator
+
+      source_root File.expand_path('../../templates/concept', __FILE__)
+
+    private
+      def handler
+        :haml
+      end
+    end
+  end
+end
+
+

data/lib/generators/rails/concept_generator.rb

@@ -0,0 +1,16 @@
+require 'generators/trailblazer/base'
+
+module Rails
+  module Generators
+    class ConceptGenerator < ::Trailblazer::Generators::Cell
+      source_root File.expand_path('../../templates/concept', __FILE__)
+
+      def create_cell_file
+        template 'cell.rb', "#{base_path}/cell.rb"
+      end
+
+      hook_for(:template_engine)
+      hook_for(:test_framework)
+    end
+  end
+end

data/lib/generators/templates/concept/cell.rb

@@ -0,0 +1,9 @@
+class <%= class_name %>::Cell < <%= options.base_cell_class %>
+  include Concept
+
+<% for action in actions -%>
+  def <%= action %>
+    render
+  end
+<% end -%>
+end

data/lib/generators/templates/concept/view.erb

@@ -0,0 +1,7 @@
+<h1>
+  <%= class_name %>#<%= @state %>
+</h1>
+
+<p>
+  Find me in <%= @path %>
+</p>

data/lib/generators/templates/concept/view.haml

@@ -0,0 +1,4 @@
+%h1
+  <%= class_name %>#<%= @state %>
+%p
+  Find me in <%= @path %>

data/lib/generators/trailblazer/base.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module Trailblazer
+  module Generators
+    class Cell < ::Rails::Generators::NamedBase
+      class_option :template_engine
+      class_option :test_framework
+      class_option :base_cell_class, :type => :string, :default => "Cell::Rails"
+      class_option :base_cell_path
+
+      argument :actions, :type => :array, :default => [:show], :banner => "action action"
+
+    private
+      def base_path
+        path = (options[:base_cell_path] || 'app/concepts').to_s
+        File.join(path, class_path, file_name)
+      end
+    end
+  end
+end

data/lib/generators/trailblazer/view_generator.rb

@@ -0,0 +1,18 @@
+module Trailblazer
+  module Generators
+    class ViewGenerator < Cell # Trailblazer::Generators::Cell
+      def create_views
+        for state in actions do
+          @state  = state
+          @path   = File.join(base_path, "views/#{state}.#{handler}")  #base_path defined in Cells::Generators::Base.
+          template "view.#{handler}", @path
+        end
+      end
+
+    private
+      def handler
+        raise "Please implement #handler in your view generator and return something like `:erb`."
+      end
+    end
+  end
+end

data/test/app/cells/bassist_cell.rb

@@ -9,7 +9,7 @@ class BassistCell < Cell::Rails
   end
 
   def provoke
-    controller.config.relative_url_root = "" if Cell.rails3_0?
+    controller.config.relative_url_root = "" if Cell.rails_version.~ 3.0
 
     render
   end

data/test/app/cells/record/views/layout.haml

@@ -0,0 +1,2 @@
+%p
+  = yield