cells 3.11.3 → 4.0.0.beta1

data/lib/cell/rails3_0_strategy.rb

@@ -1,82 +0,0 @@
-# This file contains VersionStrategies for the Cell and Cells module for Rails 3.0.
-module Cell
-  Layouts = AbstractController::Layouts
-
-  # Methods to be included in Cell::Rails in 3.0 context, where there's no view inheritance.
-  module VersionStrategy
-    extend ActiveSupport::Concern
-
-    class MissingTemplate < ActionView::ActionViewError
-      def initialize(message, possible_paths)
-        super(message + " and possible paths #{possible_paths}")
-      end
-    end
-
-
-    module ClassMethods
-      def helper_modules
-        [_helpers, _routes.url_helpers]
-      end
-
-      # Return the default view path for +state+. Override this if you cell has a differing naming style.
-      def view_for_state(state)
-        "#{cell_name}/#{state}"
-      end
-
-      # Returns all possible view paths for +state+ by invoking #view_for_state on all classes up
-      # the inheritance chain.
-      def find_class_view_for_state(state)
-        return [view_for_state(state)] if superclass.abstract?
-
-        superclass.find_class_view_for_state(state) << view_for_state(state)
-      end
-
-      def cell_name
-        controller_path
-      end
-    end
-
-  private
-    # Computes all possible paths for +state+ by traversing up the inheritance chain.
-    def possible_paths_for_state(state)
-      self.class.find_class_view_for_state(state).reverse!
-    end
-
-    # Climbs up the inheritance chain, looking for a view for the current +state+.
-    def find_family_view_for_state(state)
-      exception       = nil
-      possible_paths  = possible_paths_for_state(state)
-
-      possible_paths.each do |template_path|
-        begin
-          template = find_template(template_path)
-          return template if template
-        rescue ::ActionView::MissingTemplate => exception
-        end
-      end
-
-      raise MissingTemplate.new(exception.message, possible_paths)
-    end
-
-    def process_opts_for(opts, state)
-      lookup_context.formats = opts.delete(:format) if opts[:format]
-
-      opts[:template] = find_family_view_for_state(opts.delete(:view) || state)
-    end
-  end
-end
-
-
-module Cells
-  module Engines
-    module VersionStrategy
-      def registered_engines
-        ::Rails.application.railties.engines
-      end
-
-      def existent_directories_for(path)
-        path.to_a.select { |d| File.directory?(d) }
-      end
-    end
-  end
-end

data/lib/cell/rails3_1_strategy.rb

@@ -1,40 +0,0 @@
-# This file contains VersionStrategies for the Cell and Cells module for Rails >= 3.1.
-module Cell
-  Layouts = AbstractController::Layouts
-
-  # Methods to be included in Cell::Rails in 3.1 context.
-  module VersionStrategy
-    extend ActiveSupport::Concern
-
-    include AbstractController::UrlFor  # must be included before _routes is set in Railstie. # TODO: remove that.
-
-
-    module ClassMethods
-      def helper_modules
-        [_routes.url_helpers, _routes.mounted_helpers, _helpers]
-      end
-    end
-
-  private
-    def process_opts_for(opts, state)
-      opts[:action] = opts[:view] || state
-
-      lookup_context.formats = [opts.delete(:format)] if opts[:format]
-    end
-  end
-end
-
-
-module Cells
-  module Engines
-    module VersionStrategy
-      def registered_engines
-        ::Rails.application.railties.engines
-      end
-
-      def existent_directories_for(path)
-        path.existent_directories
-      end
-    end
-  end
-end

data/lib/cell/rails4_0_strategy.rb

@@ -1,39 +0,0 @@
-module Cell
-  Layouts = AbstractController::Layouts
-
-  # Methods to be included in Cell::Rails in 3.1 context.
-  module VersionStrategy
-    extend ActiveSupport::Concern
-
-    include AbstractController::UrlFor  # must be included before _routes is set in Railstie. # TODO: remove that.
-
-
-    module ClassMethods
-      def helper_modules
-        [_routes.url_helpers, _routes.mounted_helpers, _helpers]
-      end
-    end
-
-  private
-    def process_opts_for(opts, state)
-      opts[:action] = opts[:view] || state
-
-      lookup_context.formats = [opts.delete(:format)] if opts[:format]
-    end
-  end
-end
-
-
-module Cells
-  module Engines
-    module VersionStrategy
-      def registered_engines
-        ::Rails::Engine::Railties.engines
-      end
-
-      def existent_directories_for(path)
-        path.existent_directories
-      end
-    end
-  end
-end

data/lib/cell/rails4_1_strategy.rb

@@ -1,40 +0,0 @@
-# This file contains VersionStrategies for the Cell and Cells module for Rails >= 3.1.
-module Cell
-  Layouts = ActionView::Layouts
-
-  # Methods to be included in Cell::Rails in 3.1 context.
-  module VersionStrategy
-    extend ActiveSupport::Concern
-
-    include AbstractController::UrlFor  # must be included before _routes is set in Railstie. # TODO: remove that.
-
-
-    module ClassMethods
-      def helper_modules
-        [_routes.url_helpers, _routes.mounted_helpers, _helpers]
-      end
-    end
-
-  private
-    def process_opts_for(opts, state)
-      opts[:action] = opts[:view] || state
-
-      lookup_context.formats = [opts.delete(:format)] if opts[:format]
-    end
-  end
-end
-
-
-module Cells
-  module Engines
-    module VersionStrategy
-      def registered_engines
-        ::Rails::Engine::Railties.new
-      end
-
-      def existent_directories_for(path)
-        path.existent_directories
-      end
-    end
-  end
-end

data/lib/cell/rendering.rb

@@ -1,109 +0,0 @@
-module Cell
-  module Rendering
-    extend ActiveSupport::Concern
-
-    # Invoke the state method for +state+ which usually renders something nice.
-    def render_state(state, *args)
-      process(state, *args)
-    end
-
-    # Renders the view for the current state and returns the markup.
-    # Don't forget to return the markup itself from the state method.
-    #
-    # === Options
-    # +:view+::   Specifies the name of the view file to render. Defaults to the current state name.
-    # +:layout+:: Renders the state wrapped in the layout. Layouts reside in <tt>app/cells/layouts</tt>.
-    # +:locals+:: Makes the named parameters available as variables in the view.
-    # +:text+::   Just renders plain text.
-    # +:inline+:: Renders an inline template as state view. See ActionView::Base#render for details.
-    # +:file+::   Specifies the name of the file template to render.
-    # +:nothing+:: Doesn't invoke the rendering process.
-    # +:state+::  Instantly invokes another rendering cycle for the passed state and returns. You may pass arbitrary state-args to the called state.
-    # +:format+:: Sets a different template format, e.g. +:json+. Use this option with caution as it currently modifies the global format variable. This might lead to unexpected subsequent render behaviour due to a design flaw in Rails.
-    #
-    # Example:
-    #  class MusicianCell < ::Cell::Base
-    #    def sing
-    #      # ... laalaa
-    #      render
-    #    end
-    #
-    # renders the view <tt>musician/sing.html</tt>.
-    #
-    #    def sing
-    #      # ... laalaa
-    #      render :view => :shout, :layout => 'metal'
-    #    end
-    #
-    # renders <tt>musician/shout.html</tt> and wrap it in <tt>app/cells/layouts/metal.html.erb</tt>.
-    #
-    # === #render is explicit!
-    # You can also alter the markup from #render. Just remember to return it.
-    #
-    #   def sing
-    #     render + render + render
-    #   end
-    #
-    # will render three concated views.
-    #
-    # === Partials?
-    #
-    # In Cells we abandoned the term 'partial' in favor of plain 'views' - we don't need to distinguish
-    # between both terms. A cell view is both, a view and a kind of partial as it represents only a fragment
-    # of the page.
-    #
-    # Just use <tt>:view</tt> and enjoy.
-    #
-    # === Using states instead of helpers
-    #
-    # Sometimes it's useful to not only render a view but also invoke the associated state. This is
-    # especially helpful when replacing helpers. Do that with <tt>render :state</tt>.
-    #
-    #   def show_cheap_item(item)
-    #     render if item.price <= 1
-    #   end
-    #
-    # A view could use this state in place of an odd helper.
-    #
-    #   - @items.each do |item|
-    #     = render({:state => :show_cheap_item}, item)
-    #
-    # This calls the state method which in turn will render its view - if the item isn't too expensive.
-    def render(*args)
-      render_view_for(self.action_name, *args)
-    end
-
-  private
-    # Renders the view belonging to the given state. Will raise ActionView::MissingTemplate
-    # if it can't find a view.
-    def render_view_for(state, *args)
-      opts = args.first.is_a?(::Hash) ? args.shift : {}
-
-      return "" if opts[:nothing]
-
-      if opts[:state]
-        opts[:text] = render_state(opts.delete(:state), *args)
-      elsif (opts.keys & [:text, :inline, :file]).blank?
-        process_opts_for(opts, state)
-      end
-
-      render_to_string(opts).html_safe # ActionView::Template::Text doesn't do that for us.
-    end
-
-
-    module ClassMethods
-      # Main entry point for #render_cell.
-      def render_cell_for(name, state, *args)
-        cell = cell_for(name, *args)
-        yield cell if block_given?
-
-        render_cell_state(cell, state, *args)
-      end
-
-    private
-      def render_cell_state(cell, state, *args)
-        cell.render_state(state, *args)
-      end
-    end
-  end
-end

data/lib/cells/rails.rb

@@ -1,86 +0,0 @@
-# These Methods are automatically added to all Controllers and Views when
-# the cells plugin is loaded.
-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.
-      #
-      # Example:
-      #
-      #   @box = render_cell(:posts, :latest, :user => current_user)
-      #
-      # If you need the cell instance before it renders, you can pass a block receiving the cell.
-      #
-      # Example:
-      #
-      #   @box = render_cell(:comments, :top5) do |cell|
-      #     cell.markdown! if config.parse_comments?
-      #   end
-      def render_cell(name, state, *args, &block)
-        ::Cell::Rails.render_cell_for(name, state, self, *args, &block)
-      end
-
-      # Expires the cached cell state view, similar to ActionController::expire_fragment.
-      # Usually, this method is used in Sweepers.
-      # Beside the obvious first two args <tt>cell_name</tt> and <tt>state</tt> you can pass
-      # in additional cache key <tt>args</tt> and cache store specific <tt>opts</tt>.
-      #
-      # Example:
-      #
-      #  class ListSweeper < ActionController::Caching::Sweeper
-      #   observe List, Item
-      #
-      #   def after_save(record)
-      #     expire_cell_state :my_listing, :display_list
-      #   end
-      #
-      # 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)
-        key = cell_class.state_cache_key(state, args)
-        cell_class.expire_cache_key(key, opts)
-      end
-    end
-
-    module ActionView
-      # Returns the cell instance for +name+. You may pass arbitrary options to your
-      # cell.
-      #
-      #   = cell(:song, :title => "Creeping Out Sara").render(:show)
-      def cell_for(name, *args, &block)
-        controller.cell_for(name, *args, &block)
-      end
-      alias_method :cell, :cell_for # DISCUSS: make this configurable?
-
-      # See Cells::Rails::ActionController#render_cell.
-      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
-
-# Add extended ActionController behaviour.
-ActionController::Base.class_eval do
-  include ::Cells::Rails::ActionController
-end
-
-# Add extended ActionView behaviour.
-ActionView::Base.class_eval do
-  include ::Cells::Rails::ActionView
-end

data/lib/cells/railtie.rb

@@ -1,38 +0,0 @@
-require "rails/railtie"
-
-module Cells
-  class Railtie < ::Rails::Railtie
-    config.cells = ActiveSupport::OrderedOptions.new
-
-
-    initializer "cells.attach_router" do |app|
-      Cell::Base.class_eval do
-        include app.routes.url_helpers # TODO: i hate this, make it better in Rails.
-      end
-    end
-
-    initializer "cells.setup_engines_view_paths" do |app|
-      Cells::Engines.append_engines_view_paths_for(app.config.action_controller)
-    end
-
-    # ruthlessly stolen from the zurb-foundation gem.
-    add_paths_block = lambda do |app|
-      (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
-
-    # Standard initializer
-    initializer 'cells.update_asset_paths', &add_paths_block
-
-    # run at assets:precompile even when `config.assets.initialize_on_precompile = false`
-    initializer 'cells.update_asset_paths', :group => :assets, &add_paths_block
-
-
-    rake_tasks do
-      load "cells/cells.rake"
-    end
-  end
-end

data/lib/cells/version.rb

@@ -1,3 +0,0 @@
-module Cells
-  VERSION = '3.11.3'
-end

data/lib/generators/USAGE

@@ -1,30 +0,0 @@
-Description:
-  Stubs out a new cell and its views. Pass the cell name, either
-  CamelCased or under_scored, and a list of views as arguments.
-
-  This generates a cell class in app/cells and view templates in
-  app/cells/cell_name/ directory.
-
-Examples:
-
-  rails g cell ShoppingCart index
-
-  This will create these cell assets:
-    Cell:
-      app/cells/shopping_cart_cell.rb
-    Views:
-      app/cells/shopping_cart/index.html.erb
-    Test:
-      test/cells/shopping_cart_cell_test.rb
-
-
-  rails g cell main_menu display sort -e haml -t rspec
-
-  This will create these cell assets:
-    Cell:
-      app/cells/main_menu_cell.rb
-    Views:
-      app/cells/main_menu/display.html.haml
-      app/cells/main_menu/sort.html.haml
-    Spec:
-      spec/cells/main_menu_cell_spec.rb