cells 4.0.0.rc1 → 4.0.0

data/lib/cell.rb

@@ -29,6 +29,7 @@ require "cell/abstract"
 require "cell/util"
 require "cell/view_model"
 require "cell/concept"
+require "cell/escaped"
 
 
 require "cell/railtie" if defined?(Rails)

data/lib/cell/concept.rb

@@ -1,19 +1,26 @@
-class Cell::Concept < Cell::ViewModel
-  abstract!
-  self.view_paths = ["app/concepts"]
+module Cell
+  class Concept < Cell::ViewModel
+    abstract!
+    self.view_paths = ["app/concepts"]
 
-  # TODO: this should be in Helper or something. this should be the only entry point from controller/view.
-  class << self
-    def class_from_cell_name(name)
-      name.classify.constantize
-    end
+    # TODO: this should be in Helper or something. this should be the only entry point from controller/view.
+    class << self
+      def class_from_cell_name(name)
+        name.classify.constantize
+      end
 
-    def controller_path
-      @controller_path ||= util.underscore(name.sub(/::Cell/, ''))
+      def controller_path
+        @controller_path ||= util.underscore(name.sub(/::Cell/, ''))
+      end
     end
-  end
 
-  alias_method :concept, :cell # the #cell helper to instantiate cells in cells.
+    alias_method :concept, :cell # Concept#concept does exactly what #cell does: delegate to class builder.
 
-  self_contained!
+    # Get nested cell in instance.
+    def cell(name, model=nil, options={})
+      ViewModel.cell(name, model, options.merge(controller: parent_controller)) # #cell calls need to be delegated to ViewModel.
+    end
+
+    self_contained!
+  end
 end

data/lib/cell/escaped.rb

@@ -0,0 +1,27 @@
+module Cell::ViewModel::Escaped
+  def self.included(includer)
+    includer.extend Property
+  end
+
+  module Property
+    def property(name, *args)
+      super.tap do # super defines #title
+        mod = Module.new do
+          define_method(name) do |options={}|
+            value = super() # call the original #title.
+            return value unless value.is_a?(String)
+            return value if options[:escape] == false
+            escape!(value)
+          end
+        end
+        include mod
+      end
+    end
+  end # Property
+
+  # Can be used as a helper in the cell, too.
+  # Feel free to override and use a different escaping implementation.
+  def escape!(string)
+    ::ERB::Util.html_escape(string)
+  end
+end

data/lib/cell/rails.rb

@@ -41,6 +41,10 @@ module Cell
         delegates :parent_controller, :session, :params, :request, :config, :env, :url_options
       end
 
+      def protect_against_forgery? # TODO: implement forgery protection with ActionController.
+        false
+      end
+
       def call(*)
         super.html_safe
       end

data/lib/cell/railtie.rb

@@ -50,9 +50,9 @@ module Cell
     # 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)
-      ViewModel.send(:include, Cell::Haml) if Cell.const_defined?(:Haml)
-      ViewModel.send(:include, Cell::Slim) if Cell.const_defined?(:Slim)
+      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::Slim) if Cell.const_defined?(:Slim, false)
     end
     #   ViewModel.template_engine = app.config.app_generators.rails.fetch(:template_engine, 'erb').to_s
 

data/lib/cell/version.rb

@@ -1,3 +1,3 @@
 module Cell
-  VERSION = "4.0.0.rc1"
+  VERSION = "4.0.0"
 end

data/test/concept_test.rb

@@ -63,12 +63,19 @@ class ConceptTest < MiniTest::Spec
     it { Cell::Concept.cell("record/cell/song").show.must_equal "Lalala" }
   end
 
-  describe "#cell (in cell state)" do
+
+  class RecordCell < Cell::ViewModel
+    def description
+      "Record! A Tribute To Rancid, with #{@options[:tracks]} songs! [#{parent_controller}]"
+    end
+  end
+
+  describe "#cell (in state)" do
     # test with controller, but remove tests when we don't need it anymore.
-    it { Cell::Concept.cell("record/cell", nil, controller: Object).cell("record/cell", nil, tracks: 24).(:description).must_equal "A Tribute To Rancid, with 24 songs! [Object]" }
+    it { Cell::Concept.cell("record/cell", nil, controller: Object).cell("concept_test/record", nil, tracks: 24).(:description).must_equal "Record! A Tribute To Rancid, with 24 songs! [Object]" }
     it { Cell::Concept.cell("record/cell", nil, controller: Object).concept("record/cell", nil, tracks: 24).(:description).must_equal "A Tribute To Rancid, with 24 songs! [Object]" }
     # concept(.., collection: ..)
-    it("xx")  { Cell::Concept.cell("record/cell", nil, controller: Object).
+    it { Cell::Concept.cell("record/cell", nil, controller: Object).
       concept("record/cell", collection: [1,2], tracks: 24, method: :description).must_equal "A Tribute To Rancid, with 24 songs! [Object]A Tribute To Rancid, with 24 songs! [Object]" }
   end
 end

data/test/property_test.rb

@@ -0,0 +1,41 @@
+require "test_helper"
+
+class PropertyTest < MiniTest::Spec
+  class SongCell < Cell::ViewModel
+    property :title
+
+    def title
+      super + "</b>"
+    end
+  end
+
+  let (:song) { Struct.new(:title).new("<b>She Sells And Sand Sandwiches") }
+  # ::property creates automatic accessor.
+  it { SongCell.(song).title.must_equal "<b>She Sells And Sand Sandwiches</b>" }
+end
+
+
+class EscapedPropertyTest < MiniTest::Spec
+  class SongCell < Cell::ViewModel
+    include Escaped
+    property :title
+    property :artist
+
+    def title(*)
+      "#{super}</b>" # super + "</b>" still escapes, but this is Rails.
+    end
+
+    def raw_title
+      title(escape: false)
+    end
+  end
+
+  let (:song) { Struct.new(:title, :artist).new("<b>She Sells And Sand Sandwiches", Object) }
+
+  # ::property escapes, everywhere.
+  it { SongCell.(song).title.must_equal "&lt;b&gt;She Sells And Sand Sandwiches</b>" }
+  # no escaping for non-strings.
+  it { SongCell.(song).artist.must_equal Object }
+  # no escaping when escape: false
+  it { SongCell.(song).raw_title.must_equal "<b>She Sells And Sand Sandwiches</b>" }
+end

data/test/rails4.2/app/cells/form_for_cell.rb

@@ -2,10 +2,6 @@ class FormForCell < Cell::ViewModel
   include ActionView::RecordIdentifier
   include ActionView::Helpers::FormHelper
 
-  def protect_against_forgery?
-    false
-  end
-
   def show
     render
   end

data/test/rails4.2/app/cells/formtastic_cell.rb

@@ -3,10 +3,6 @@ class FormtasticCell < Cell::ViewModel
   include ActionView::Helpers::FormHelper
   include Formtastic::Helpers::FormHelper
 
-  def protect_against_forgery?
-    false
-  end
-
   def show
     render
   end

data/test/rails4.2/app/cells/simple_form_cell.rb

@@ -6,10 +6,6 @@ class SimpleFormCell < Cell::ViewModel
   # include ActiveSupport::Configurable
   # include ActionController::RequestForgeryProtection # FIXME: this does NOT activate any protection.
 
-  def protect_against_forgery?
-    false
-  end
-
   def show
     render
   end

data/test/rails4.2/app/cells/song/with_escaped.erb

@@ -0,0 +1 @@
+<b><%= title %></b>

data/test/rails4.2/app/cells/song_cell.rb

@@ -1,8 +1,14 @@
 class SongCell < Cell::ViewModel
+  include Escaped
+  property :title
+
   def show
     "happy"
   end
 
+  def with_escaped
+    render
+  end
   # include ActionView::Helpers::AssetUrlHelper
   # include Sprockets::Rails::Helper
 

data/test/rails4.2/app/controllers/songs_controller.rb

@@ -14,4 +14,12 @@ class SongsController < ApplicationController
   def edit
     render text: cell(:song).video_path(1)
   end
+
+  def with_image_tag
+    render text: cell(:song).image_tag("logo.png")
+  end
+
+  def with_escaped
+    render layout: false
+  end
 end

data/test/rails4.2/app/models/song.rb

@@ -1,4 +1,4 @@
-class Song
+class Song < OpenStruct
   require "active_model"
   include ActiveModel::Conversion
   extend ActiveModel::Naming

data/test/rails4.2/app/views/songs/with_escaped.html.erb

@@ -0,0 +1 @@
+<h1>Yeah!</h1><%= cell(:song, Song.new(title: "<script>")).(:with_escaped) %>

data/test/rails4.2/config/routes.rb

@@ -3,4 +3,7 @@ Rails.application.routes.draw do
   root to: "index#index"
 
   resources :songs
+
+  get "songs/with_image_tag"
+  get "songs/with_escaped"
 end

data/test/rails4.2/test/integration/controller_test.rb

@@ -3,10 +3,14 @@ require "test_helper"
 class ControllerTest < ActionController::TestCase
   tests SongsController
 
-  # TODO: test url stuff in Song#show.
   it do
     get :index
     response.body.must_equal "happy"
   end
 
+  # HTML escaping.
+  it do
+    get :with_escaped
+    response.body.must_equal "<h1>Yeah!</h1><b>&lt;script&gt;</b>" # only the property is escaped.
+  end
 end

data/test/rails4.2/test/integration/url_helper_test.rb

@@ -33,4 +33,15 @@ class UrlTest < ActionDispatch::IntegrationTest
   #   visit "/songs/1/edit"
   #   page.text.must_equal "http://www.example.com/songs/1"
   # end
+
+
+end
+
+class AssetsHelperTest < ActionController::TestCase
+  tests SongsController
+
+  it do
+    get :with_image_tag
+    response.body.must_equal "<img src=\"/images/logo.png\" alt=\"Logo\" />"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cells
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc1
+  version: 4.0.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -126,7 +126,7 @@ files:
 - lib/cell/caching/notification.rb
 - lib/cell/concept.rb
 - lib/cell/development.rb
-- lib/cell/engines.rb
+- lib/cell/escaped.rb
 - lib/cell/layout.rb
 - lib/cell/partial.rb
 - lib/cell/prefixes.rb
@@ -210,6 +210,7 @@ files:
 - test/layout_test.rb
 - test/partial_test.rb
 - test/prefixes_test.rb
+- test/property_test.rb
 - test/public_test.rb
 - test/rails4.2/.gitignore
 - test/rails4.2/Gemfile
@@ -224,6 +225,7 @@ files:
 - test/rails4.2/app/cells/simple_form/show.erb
 - test/rails4.2/app/cells/simple_form_cell.rb
 - test/rails4.2/app/cells/song/song.css
+- test/rails4.2/app/cells/song/with_escaped.erb
 - test/rails4.2/app/cells/song_cell.rb
 - test/rails4.2/app/controllers/application_controller.rb
 - test/rails4.2/app/controllers/concerns/.keep
@@ -238,6 +240,7 @@ files:
 - test/rails4.2/app/views/index/index.html.erb
 - test/rails4.2/app/views/layouts/application.html.erb
 - test/rails4.2/app/views/songs/show.html.erb
+- test/rails4.2/app/views/songs/with_escaped.html.erb
 - test/rails4.2/bin/bundle
 - test/rails4.2/bin/rails
 - test/rails4.2/bin/rake
@@ -289,11 +292,6 @@ files:
 - test/rails4.2/lib/assets/.keep
 - test/rails4.2/lib/tasks/.keep
 - test/rails4.2/log/.keep
-- test/rails4.2/public/404.html
-- test/rails4.2/public/422.html
-- test/rails4.2/public/500.html
-- test/rails4.2/public/favicon.ico
-- test/rails4.2/public/robots.txt
 - test/rails4.2/test/integration/asset_pipeline_test.rb
 - test/rails4.2/test/integration/controller_test.rb
 - test/rails4.2/test/integration/form_for_test.rb
@@ -323,9 +321,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/lib/cell/engines.rb

@@ -1,61 +0,0 @@
-module Cell
-  # Now <tt>Rails::Engine</tt>s can contribute to Cells view paths.
-  # By default, any 'app/cells' found inside any Engine is automatically included into Cells view paths.
-  #
-  # You can customize the view paths changing/appending to the <tt>'app/cell_views'</tt> path configuration:
-  #
-  #   module MyAwesome
-  #     class Engine < Rails::Engine
-  #       # loads views from 'cell/views' and NOT from 'app/cells'
-  #       config.paths.add 'app/cell_views', :with => 'cell/views'
-  #
-  #       # appends 'lib/my_cells_view_path' to this Railtie view path contribution
-  #       config.paths['app/cell_views'] << 'lib/my_cells_view_path'
-  #     end
-  #   end
-  #
-  # You can manually specify which Engines will be added to Cell view paths
-  #
-  #   Cell::Base.config.view_path_engines = [MyAwesome::Engine]
-  #
-  # And even disable the automatic loading
-  #
-  #   Cell::Base.config.view_path_engines = false
-  #
-  # You can programatically append a Rails::Engine to Cell view path
-  #
-  #   Cells.setup do |config|
-  #     config.append_engine_view_path!(MyEngine::Engine)
-  #   end
-  #
-  module Engines
-    extend VersionStrategy  # adds #registered_engines and #existent_directories_for.
-
-    # Appends all <tt>Rails::Engine</tt>s cell-views path to Cell::Base#view_paths
-    #
-    # All <tt>Rails::Engine</tt>s specified at <tt>config.view_path_engines</tt> will have its cell-views path appended to Cell::Base#view_paths
-    #
-    # Defaults <tt>config.view_path_engines</tt> to all loaded <tt>Rails::Engine</tt>s.
-    #
-    def self.append_engines_view_paths_for(config)
-      return if config.view_path_engines == false
-
-      engines = config.view_path_engines || registered_engines  #::Rails::Application::Railties.engines
-      engines.each {|engine| append_engine_view_path!(engine) }
-    end
-
-    # Appends a <tt>Rails::Engine</tt> cell-views path to @Cell::Base@
-    #
-    # The <tt>Rails::Engine</tt> cell-views path is obtained from the <tt>paths['app/cell_views']</tt> configuration.
-    # All existing directories specified at cell-views path will be appended do Cell::Base#view_paths
-    #
-    # Defaults <tt>paths['app/cell_views']</tt> to 'app/cells'
-    #
-    def self.append_engine_view_path!(engine)
-      return unless engine.is_a?(::Rails::Engine) # In Rails 4.1, this could be a Rails::Railtie, which doesn't make sense.
-
-      engine.paths['app/cell_views'] || engine.paths.add('app/cell_views', :with => 'app/cells')
-      Cell::Rails.append_view_path(existent_directories_for(engine.paths["app/cell_views"]))
-    end
-  end
-end

data/test/rails4.2/public/404.html

@@ -1,67 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>The page you were looking for doesn't exist (404)</title>
-  <meta name="viewport" content="width=device-width,initial-scale=1">
-  <style>
-  body {
-    background-color: #EFEFEF;
-    color: #2E2F30;
-    text-align: center;
-    font-family: arial, sans-serif;
-    margin: 0;
-  }
-
-  div.dialog {
-    width: 95%;
-    max-width: 33em;
-    margin: 4em auto 0;
-  }
-
-  div.dialog > div {
-    border: 1px solid #CCC;
-    border-right-color: #999;
-    border-left-color: #999;
-    border-bottom-color: #BBB;
-    border-top: #B00100 solid 4px;
-    border-top-left-radius: 9px;
-    border-top-right-radius: 9px;
-    background-color: white;
-    padding: 7px 12% 0;
-    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
-  }
-
-  h1 {
-    font-size: 100%;
-    color: #730E15;
-    line-height: 1.5em;
-  }
-
-  div.dialog > p {
-    margin: 0 0 1em;
-    padding: 1em;
-    background-color: #F7F7F7;
-    border: 1px solid #CCC;
-    border-right-color: #999;
-    border-left-color: #999;
-    border-bottom-color: #999;
-    border-bottom-left-radius: 4px;
-    border-bottom-right-radius: 4px;
-    border-top-color: #DADADA;
-    color: #666;
-    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
-  }
-  </style>
-</head>
-
-<body>
-  <!-- This file lives in public/404.html -->
-  <div class="dialog">
-    <div>
-      <h1>The page you were looking for doesn't exist.</h1>
-      <p>You may have mistyped the address or the page may have moved.</p>
-    </div>
-    <p>If you are the application owner check the logs for more information.</p>
-  </div>
-</body>
-</html>