cells-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1b105374e1d4806e75407a1f21a42c91684f527
-  data.tar.gz: fd6284c358c047a3902a5853d6bc5e82d4dd1453
+  metadata.gz: 4702ce8ee285649f10ba8b66f422ef18de70de17
+  data.tar.gz: 4cf37c137a196505c9ce67e309bcd3667a2b20a7
 SHA512:
-  metadata.gz: a1fd0680441e28d413d6e4d7f46c49f5c77bf515f9e0734451cf3fcb3ed1a4449177c899b4624f8651a0ecb1fcbdf5e482d4605e8988996af8becd39475a6467
-  data.tar.gz: 8aa156d200e0ee1781b5ac451b7e610f3f29581cdaee41f015f8fb92dfd75e31755590d2c395f4b52bdc861b4c6b1331a11a5c73b6a845c6489d7fe2647c44c6
+  metadata.gz: 4607ac2a54c333168cd171470fe8c672421e78b3221a7c597b7380af86ee63ec7e0b854c43549451eb2d3a4cf0790ed6fce8c162e2b81666d4ed7dafb87dc7d5
+  data.tar.gz: e3e3d5d3ec884b042d9841cffe05f2e544336d898ce5aad826be10783747c42219b0bbce13fa51ea02d3711b3720933d8d99679112e94b2c37de5574f8705a0f

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.0.3
+
+* `Cell::Helper::AssetHelper` is now always included and fixes https://github.com/apotonick/cells/issues/214 (hopefully).
+
 ## 0.0.2
 
 * Moved all Rails files from `cells` to `cells-rails`.

data/README.md

@@ -6,7 +6,7 @@
 
 * html_safe
 * controller in context
-* TODO: asset helpers
+* asset helpers Cell::Helper::AssetHelper automatically included
 
 
 ## Installation

data/lib/cell/helper/asset_helper.rb

@@ -0,0 +1,54 @@
+module Cell
+  module Helper
+    # Delegate all asset-related helpers to the global helpers instance.
+    # This is the cleanest solution to leverage Rails' asset management and
+    # doesn't pollute your cell with weird asset modules from Rails.
+    module AssetHelper
+      # Extend if we forgot anything.
+      # This delegates asset helpers to the global Rails helper instance.
+
+      # http://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html
+      %w{
+        javascript_include_tag
+        stylesheet_link_tag
+
+        asset_path
+        asset_url
+        image_tag
+        audio_path
+        audio_url
+        compute_asset_extname
+        compute_asset_host
+        compute_asset_path
+        font_path
+        font_url
+        image_path
+        image_url
+        javascript_path
+        javascript_url
+        path_to_asset
+        path_to_audio
+        path_to_font
+        path_to_image
+        path_to_javascript
+        path_to_stylesheet
+        path_to_video
+        stylesheet_path
+        stylesheet_url
+        url_to_asset
+        url_to_audio
+        url_to_font
+        url_to_image
+        url_to_javascript
+        url_to_stylesheet
+        url_to_video
+        video_path
+        video_url
+      }.each do |method|
+        define_method(method) do |*args|
+          ::ActionController::Base.helpers.send(method, *args)
+        end
+      end
+    end # AssetHelper
+  end
+end

data/lib/cell/rails.rb

@@ -0,0 +1,110 @@
+module Cell
+  def self.rails_version
+    Gem::Version.new(ActionPack::VERSION::STRING)
+  end
+
+  # These methods are automatically added to all controllers and views.
+  module RailsExtensions
+    module ActionController
+      def cell(name, model=nil, options={}, constant=::Cell::ViewModel, &block)
+        options[:context] ||= {}
+        options[:context][:controller] = self
+
+        constant.cell(name, model, options, &block)
+      end
+
+      def concept(name, model=nil, options={}, &block)
+        cell(name, model, options, ::Cell::Concept, &block)
+      end
+    end
+
+    module ActionView
+      # Returns the cell instance for +name+. You may pass arbitrary options to your
+      # cell.
+      #
+      #   = cell(:song, title: "Creeping Out Sara").(:show)
+      def cell(name, *args, &block)
+        controller.cell(name, *args, &block)
+      end
+
+      # # See Cells::Rails::ActionController#render_cell.
+      # def render_cell(name, state, *args, &block)
+      #   ::Cell::Rails.render_cell(name, state, controller, *args, &block)
+      # end
+
+      def concept(name, *args, &block)
+        controller.concept(name, *args, &block)
+      end
+    end
+
+    # Gets included into Cell::ViewModel in a Rails environment.
+    module ViewModel
+      extend ActiveSupport::Concern
+
+      # DISCUSS: who actually uses forgery protection with cells? it is not working since 4, anyway?
+      # include ActionController::RequestForgeryProtection
+      included do
+        extend Uber::Delegates
+        delegates :parent_controller, :session, :params, :request, :config, :env, :url_options
+        # forgery protection.
+        delegates :parent_controller, :protect_against_forgery?, :form_authenticity_token, :request_forgery_protection_token
+      end
+
+      def call(*)
+        super.html_safe
+      end
+
+      def parent_controller
+        context[:controller]
+      end
+      alias_method :controller, :parent_controller
+
+      def perform_caching?
+        ::ActionController::Base.perform_caching
+      end
+
+      def cache_store  # we want to use DI to set a cache store in cell/rails.
+        ::ActionController::Base.cache_store
+      end
+
+      module ClassMethods
+        def expand_cache_key(key)
+          ::ActiveSupport::Cache.expand_cache_key(key, :cells)
+        end
+      end
+    end
+
+    # In Rails, there are about 10 different implementations of #url_for. Rails doesn't like the idea of objects, so they
+    # have helpers in modules. Those module are now included sequentially into other modules and/or classes. While they
+    # get included, they might or might not include methods, depending on the including module/class
+    # (example here: https://github.com/rails/rails/blob/cad20f720c4c6e04584253cd0a23f22b3d43ab0f/actionpack/lib/action_dispatch/routing/url_for.rb#L87).
+    #
+    # The outcome is that several module override #url_for, and if you're lucky, this works. If you're not, then #url_for breaks
+    # due to a raise in one of its basic implementations, introduced in 3.x, fixed in 4.0 and then re-introduced in 4.2
+    #
+    # This is extremely frustrating as no one in Rails core seems to tackle this problem and introduces a url object instead
+    # of this module madness. I have to constantly test and fix it in Cells. With the module below, I'll stop doing this.
+    #
+    # Either Rails works with Cells and we fix this in form of a URL object that gets passed into the cell (I'm happy with
+    # a global object here, too! Wow!) or URL helpers will stop working in Cells and a lot of people will be unhappy.
+    #
+    # Anyway, this is the reason we need this patch module. If you have trouble with URLs in Cells, then please ask Rails to
+    # fix their implementation. Thank you.
+    module HelpersAreShit
+      def url_for(options = nil) # from ActionDispatch:R:UrlFor.
+        case options
+          when nil
+            _routes.url_for(url_options.symbolize_keys)
+          when Hash
+            _routes.url_for(options.symbolize_keys.reverse_merge!(url_options))
+          when String
+            options
+          when Array
+            polymorphic_url(options, options.extract_options!)
+          else
+            polymorphic_url(options)
+        end
+      end
+    end
+  end
+end

data/lib/cell/railtie.rb

@@ -0,0 +1,78 @@
+require "rails/railtie"
+require "cell/rails"
+
+module Cell
+  class Railtie < Rails::Railtie
+
+    config.cells = ActiveSupport::OrderedOptions.new
+
+    initializer("cells.attach_router") do |app|
+      ViewModel.class_eval do
+        include app.routes.url_helpers # TODO: i hate this, make it better in Rails.
+      end
+    end
+
+    # ruthlessly stolen from the zurb-foundation gem.
+    initializer "cells.update_asset_paths" do |app|
+      Array(app.config.cells.with_assets).each do |cell_class|
+        # puts "@@@@@ #{cell_class.camelize.constantize.prefixes}"
+        app.config.assets.paths += cell_class.camelize.constantize.prefixes # Song::Cell.prefixes
+      end
+    end
+
+    initializer "cells.rails_extensions" do |app|
+      ActiveSupport.on_load(:action_controller) do
+        self.class_eval do
+          include ::Cell::RailsExtensions::ActionController
+        end
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        self.class_eval do
+          include ::Cell::RailsExtensions::ActionView
+        end
+      end
+
+      require "cell/rails/collection"
+      require "cell/rails/constant_for"
+
+      Cell::Collection.send :include, Cell::RailsExtension::Collection
+      Cell::ViewModel.send :include, Cell::RailsExtension::ConstantFor
+    end
+
+    initializer "cells.include_default_helpers" do
+      # include asset helpers (image_path, font_path, ect)
+      ViewModel.class_eval do
+        include ActionView::Helpers::FormHelper # includes ActionView::Helpers::UrlHelper, ActionView::Helpers::FormTagHelper
+        include ::Cell::RailsExtensions::HelpersAreShit
+
+        require "cell/helper/asset_helper"
+        include Cell::Helper::AssetHelper
+
+        # set VM#cache_store, etc.
+        include RailsExtensions::ViewModel
+      end
+    end
+
+    # TODO: allow to turn off this.
+    initializer "cells.include_template_module", after: "cells.include_default_helpers" do
+      # yepp, this is happening. saves me a lot of coding in each extension.
+      ViewModel.send(:include, Cell::Erb) if Cell.const_defined?(:Erb, false)
+      ViewModel.send(:include, Cell::Haml) if Cell.const_defined?(:Haml, false)
+      ViewModel.send(:include, Cell::Hamlit) if Cell.const_defined?(:Hamlit, false)
+      ViewModel.send(:include, Cell::Slim) if Cell.const_defined?(:Slim, false)
+    end
+    #   ViewModel.template_engine = app.config.app_generators.rails.fetch(:template_engine, "erb").to_s
+
+    initializer("cells.development") do |app|
+      if Rails.env == "development"
+        require "cell/development"
+        ViewModel.send(:include, Development)
+      end
+    end
+
+    rake_tasks do
+      load "tasks/cells.rake"
+    end
+  end
+end

data/lib/cells/rails.rb

@@ -1,13 +1,8 @@
 require "cells/rails/version"
 require "cells"
 
-require "cell/rails/collection"
-require "cell/rails/constant_for"
-
-Cell::Collection.send :include, Cell::RailsExtension::Collection
-Cell::ViewModel.send :include, Cell::RailsExtension::ConstantFor
-
 require "cell/caching/notification"
+require "cell/rails"
 require "cell/railtie"
 
 module Cell

data/lib/cells/rails/version.rb

@@ -1,5 +1,5 @@
 module Cells
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/rails/generators/cell/cell_generator.rb

@@ -0,0 +1,43 @@
+module Rails
+  module Generators
+    class CellGenerator < NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :parent, type: :string, desc: 'The parent class for the generated cell'
+      class_option :e, type: :string, desc: 'The template engine'
+
+      check_class_collision suffix: 'Cell'
+
+      argument :actions, type: :array, default: [], banner: 'action action2'
+
+      def create_cell_file
+        template 'cell.rb.erb', File.join('app/cells', class_path, "#{file_name}_cell.rb")
+      end
+
+      def create_view_files
+        states.each do |state|
+          @state = state
+          @path = File.join('app/cells', class_path, file_name,  "#{state}.#{template_engine}")
+          template "view.#{template_engine}", @path
+        end
+      end
+
+      hook_for :test_framework
+
+      private
+
+      def parent_class_name
+        options[:parent] || 'Cell::ViewModel'
+      end
+
+      # The show state is included by default
+      def states
+        (['show'] + actions).uniq
+      end
+
+      def template_engine
+        (options[:e] || Rails.application.config.app_generators.rails[:template_engine] || 'erb').to_s
+      end
+    end
+  end
+end

data/lib/rails/generators/cell/templates/cell.rb.erb

@@ -0,0 +1,8 @@
+class <%= class_name %>Cell < <%= parent_class_name %>
+<% states.each do |state| -%>
+  def <%= state %>
+    render
+  end
+
+<% end -%>
+end

data/lib/rails/generators/cell/templates/view.erb

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

data/lib/rails/generators/cell/templates/view.haml

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

data/lib/rails/generators/cell/templates/view.slim

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

data/lib/rails/generators/concept/concept_generator.rb

@@ -0,0 +1,38 @@
+module Rails
+  module Generators
+    class ConceptGenerator < NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :e, type: :string, desc: 'The template engine'
+      argument :actions, type: :array, default: [], banner: 'action action2'
+
+      check_class_collision suffix: 'Concept'
+
+
+      def create_concept
+        template 'concept.rb.erb', File.join('app/concepts', class_path, file_name, 'cell.rb')
+      end
+
+      def create_views
+        states.each do |state|
+          @state = state
+          @path = File.join('app/concepts', class_path, file_name, 'views', "#{state}.#{template_engine}")
+          template "view.#{template_engine}", @path
+        end
+      end
+
+      hook_for :test_framework
+
+      private
+
+      def template_engine
+        (options[:e] || Rails.application.config.app_generators.rails[:template_engine] || 'erb').to_s
+      end
+
+      # The show state is included by default
+      def states
+        (['show'] + actions).uniq
+      end
+    end
+  end
+end

data/lib/rails/generators/concept/templates/concept.rb.erb

@@ -0,0 +1,7 @@
+class <%= class_name %>::Cell < Cell::Concept
+<% states.each do |state| -%>
+  def <%= state %>
+    render
+  end
+<% end -%>
+end

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

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

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

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

data/lib/rails/generators/concept/templates/view.slim

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

data/lib/rails/generators/test_unit/cell/cell_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators/test_unit'
+
+module TestUnit # :nodoc:
+  module Generators # :nodoc:
+    class CellGenerator < Base # :nodoc:
+      source_root File.expand_path('../templates', __FILE__)
+      argument :actions, type: :array, default: []
+      check_class_collision suffix: 'CellTest'
+
+      def create_test_file
+        template 'unit_test.rb.erb', File.join('test/cells', class_path, "#{file_name}_cell_test.rb")
+      end
+
+      private
+
+      def states
+        (['show'] + actions).uniq
+      end
+    end
+  end
+end

data/lib/rails/generators/test_unit/cell/templates/unit_test.rb.erb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class <%= class_name %>CellTest < Cell::TestCase
+<% states.each do |state| -%>
+  test "<%= state %>" do
+    html = cell("<%= file_name %>").(:<%= state %>)
+    assert html.match /<p>/
+  end
+
+<% end %>
+end

data/lib/rails/generators/test_unit/concept/concept_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators/test_unit'
+
+module TestUnit # :nodoc:
+  module Generators # :nodoc:
+    class ConceptGenerator < Base # :nodoc:
+      source_root File.expand_path('../templates', __FILE__)
+      argument :actions, type: :array, default: []
+      check_class_collision suffix: 'ConceptTest'
+
+      def create_test_file
+        template 'unit_test.rb.erb', File.join('test/concepts', class_path, file_name, 'cell_test.rb')
+      end
+
+      private
+
+      def states
+        (['show'] + actions).uniq
+      end
+    end
+  end
+end

data/lib/rails/generators/test_unit/concept/templates/unit_test.rb.erb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class <%= class_name %>ConceptTest < Cell::TestCase
+<% states.each do |state| -%>
+  test "<%= state %>" do
+    html = concept("<%= file_name %>/cell").(:<%= state %>)
+    assert html.match /<p>/
+  end
+
+<% end %>
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cells-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nick Sutterer
@@ -123,12 +123,29 @@ files:
 - Rakefile
 - cells-rails.gemspec
 - lib/cell/caching/notification.rb
+- lib/cell/helper/asset_helper.rb
+- lib/cell/rails.rb
 - lib/cell/rails/collection.rb
 - lib/cell/rails/constant_for.rb
+- lib/cell/railtie.rb
 - lib/cell/test_case.rb
 - lib/cell/translation.rb
 - lib/cells/rails.rb
 - lib/cells/rails/version.rb
+- lib/rails/generators/cell/cell_generator.rb
+- lib/rails/generators/cell/templates/cell.rb.erb
+- lib/rails/generators/cell/templates/view.erb
+- lib/rails/generators/cell/templates/view.haml
+- lib/rails/generators/cell/templates/view.slim
+- lib/rails/generators/concept/concept_generator.rb
+- lib/rails/generators/concept/templates/concept.rb.erb
+- lib/rails/generators/concept/templates/view.erb
+- lib/rails/generators/concept/templates/view.haml
+- lib/rails/generators/concept/templates/view.slim
+- lib/rails/generators/test_unit/cell/cell_generator.rb
+- lib/rails/generators/test_unit/cell/templates/unit_test.rb.erb
+- lib/rails/generators/test_unit/concept/concept_generator.rb
+- lib/rails/generators/test_unit/concept/templates/unit_test.rb.erb
 homepage: http://trailblazer.to
 licenses: []
 metadata: {}