cells 3.11.3 → 4.0.0.beta1

data/lib/cells.rb

@@ -1,20 +1 @@
-module Cells
-  # Setup your special needs for Cells here. Use this to add new view paths.
-  #
-  # Example:
-  #
-  #   Cells.setup do |config|
-  #     config.append_view_path "app/view_models"
-  #   end
-  #
-  def self.setup
-    yield(Cell::Rails)
-  end
-end
-
-require 'cell'
-require 'cell/rails'
-require 'cells/rails'
-require 'cell/deprecations'
-require 'cells/engines'
-require 'cells/railtie'
+require 'cell'

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.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/{generators/templates/concept/cell.rb → rails/generators/concept/templates/concept.rb.erb}

@@ -1,6 +1,6 @@
 class <%= class_name %>::Cell < Cell::Concept
-<% for action in actions -%>
-  def <%= action %>
+<% states.each do |state| -%>
+  def <%= state %>
     render
   end
 <% end -%>

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/{generators/templates/cell_test.rb → rails/generators/test_unit/cell/templates/unit_test.rb.erb}

@@ -1,11 +1,11 @@
 require 'test_helper'
 
 class <%= class_name %>CellTest < Cell::TestCase
-<% for state in @states -%>
+<% states.each do |state| -%>
   test "<%= state %>" do
     invoke :<%= state %>
-    assert_select "p"
+    assert_select '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
+    invoke :<%= state %>
+    assert_select 'p'
+  end
+  
+<% end %>
+end

data/test/builder_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class BuilderTest < MiniTest::Spec
+  Song = Struct.new(:title)
+  Hit  = Struct.new(:title)
+
+  class SongCell < Cell::ViewModel
+    builds do |model, options|
+      if model.is_a? Hit
+        HitCell
+      elsif options[:evergreen]
+        EvergreenCell
+      end
+    end
+
+    def options
+      @options
+    end
+
+    def show
+      "* #{title}"
+    end
+
+    property :title
+  end
+
+  class HitCell < SongCell
+    def show
+      "* **#{title}**"
+    end
+  end
+
+  class EvergreenCell < SongCell
+  end
+
+  # the original class is used when no builder matches.
+  it { Cell::ViewModel.cell("builder_test/song", nil, Song.new("Nation States"), {}).must_be_instance_of BuilderTest::SongCell }
+
+  it do
+    cell = Cell::ViewModel.cell("builder_test/song", nil, Hit.new("New York"), {})
+    cell.must_be_instance_of BuilderTest::HitCell
+    cell.options.must_equal({})
+  end
+
+  it do
+    cell = Cell::ViewModel.cell("builder_test/song", nil, Song.new("San Francisco"), evergreen: true)
+    cell.must_be_instance_of BuilderTest::EvergreenCell
+    cell.options.must_equal({:evergreen=>true})
+  end
+
+  # with collection.
+  it { Cell::ViewModel.cell("builder_test/song", nil, collection: [Song.new("Nation States"), Hit.new("New York")]).must_equal "* Nation States* **New York**" }
+
+  # with Concept
+  class Track < Cell::Concept
+  end
+  it { Cell::Concept.cell("builder_test/track", nil).must_be_instance_of Track }
+end

data/test/caching_test.rb

@@ -0,0 +1,298 @@
+# encoding: utf-8
+require 'test_helper'
+
+class DirectorCell < Cell::ViewModel
+  attr_reader :count
+
+  def initialize(*)
+    super
+    @count = 0
+  end
+
+  cache :tock
+
+  def tock
+    @count += 1
+  end
+end
+
+
+class CachingUnitTest < MiniTest::Spec
+  before :each do
+    ActionController::Base.cache_store.clear
+    ActionController::Base.perform_caching = true
+  end
+
+  let (:director) { DirectorCell }
+  let (:cellule) { DirectorCell.new(nil) }
+
+
+  describe "::state_cache_key" do
+    # accepts state name, only.
+    it { director.state_cache_key(:count).must_equal "cells/director/count/" }
+
+    # accepts hash as key parts
+    if Cell.rails_version >= Gem::Version.new('4.0')
+      it { director.state_cache_key(:count, b: 2, a: 1).must_equal "cells/director/count/b/2/a/1" }
+    else
+      it { director.state_cache_key(:count, b: 2, a: 1).must_equal "cells/director/count/a=1&b=2" }
+    end
+
+    # accepts array as key parts
+    it { director.state_cache_key(:count, [1, 2, 3]).must_equal "cells/director/count/1/2/3" }
+
+    # accepts string as key parts
+    it { director.state_cache_key(:count, "1/2").must_equal "cells/director/count/1/2" }
+
+    # accepts nil as key parts
+    it { director.state_cache_key(:count, nil).must_equal "cells/director/count/" }
+  end
+
+
+  describe "#state_cached?" do
+    # true for cached
+    it { cellule.send(:state_cached?, :tock).must_equal true }
+
+    # false otherwise
+    it { cellule.send(:state_cached?, :sing).must_equal false }
+  end
+
+
+  describe "#cache?" do
+    # true for cached
+    it { cellule.cache?(:tock).must_equal true }
+
+    # false otherwise
+    it { cellule.cache?(:sing).must_equal false }
+
+    describe "perform_caching turned off" do
+      after do
+        ::ActionController::Base.perform_caching = true
+      end
+
+      # always false
+      it do
+        ::ActionController::Base.perform_caching = false
+        cellule.cache?(:sing).must_equal false
+        cellule.cache?(:sing).must_equal false
+      end
+    end
+
+    describe "#cache_store" do
+      # rails cache store per default.
+      it { cellule.cache_store.must_equal ActionController::Base.cache_store }
+    end
+  end
+
+
+  # describe ".expire_cache_key" do
+  #   before :each do
+  #     @key = @class.state_cache_key(:tock)
+  #     puts "====== key is #{@key}"
+  #     assert_equal "1", render_cell(:director, :tock)
+  #     assert_equal "1", @class.cache_store.read(@key)
+  #   end
+
+  #   it "delete the state from cache" do
+  #     @class.expire_cache_key(@key)
+  #     assert_not @class.cache_store.read(@key)
+  #   end
+
+  #   it "be available in controllers for sweepers" do
+  #     MusicianController.new.expire_cell_state(DirectorCell, :tock)
+  #     assert_not @class.cache_store.read(@key)
+  #   end
+
+  #   it "accept cache options" do
+  #     key = @class.state_cache_key(:tock, :volume => 9)
+  #     assert Cell::Rails.cache_store.write(key, 'ONE!')
+
+  #     MusicianController.new.expire_cell_state(DirectorCell, :tock, :volume => 9)
+  #     assert_equal "1", @class.cache_store.read(@key)
+  #     assert_not ::Cell::Rails.cache_store.read(key)
+  #   end
+  # end
+end
+
+
+class CachingTest < MiniTest::Spec
+  class DirectorCell < Cell::ViewModel
+    def initialize(controller, counter=0)
+      super
+      @counter = counter
+    end
+
+    def show # public method.
+      @counter
+    end
+
+
+    cache :utf8
+
+    def utf8
+      "æøå" # or any other UTF-8 string
+    end
+  end
+
+  before :each do
+    ActionController::Base.cache_store.clear
+    ActionController::Base.perform_caching = true
+  end
+
+  # let (:cell) { DirectorCell.new(nil) }
+  def cellule(*args)
+    DirectorCell.new(nil, *args)
+  end
+
+  # no caching when turned off.
+  it do
+    cellule.class.cache :show
+    ActionController::Base.perform_caching = false
+
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "2"
+  end
+
+  # cache forever when no options.
+  it do
+    cellule.class.cache :show
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "1"
+  end
+
+
+  # no caching when state not configured.
+  it do
+    cellule.class.class_eval do
+      def dictate
+        @counter
+      end
+    end
+
+    cellule(1).call(:dictate).must_equal "1"
+    cellule(2).call(:dictate).must_equal "2"
+  end
+
+  # compute key with cell properties from #initialize.
+  it do
+    cellule.class.cache :show do
+      @counter < 3 ? {:count => "<"} : {:count => ">"}
+    end
+
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "1"
+    cellule(3).call.must_equal "3"
+    cellule(4).call.must_equal "3"
+  end
+
+  # compute key with instance method
+  it do
+    cellule.class.cache :show, :version
+    cellule.class.class_eval do
+      def version
+        @counter < 3 ? {:count => "<"} : {:count => ">"}
+      end
+    end
+
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "1"
+    cellule(3).call.must_equal "3"
+    cellule(4).call.must_equal "3"
+  end
+
+  # allow returning strings for key
+  it do
+    cellule.class.cache :show do
+      @counter < 3 ? "<" : ">"
+    end
+
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "1"
+    cellule(3).call.must_equal "3"
+    cellule(4).call.must_equal "3"
+  end
+
+  # allows conditional ifs.
+  it do
+    cellule.class.cache :show, if: lambda { @counter < 3 }
+
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "1"
+    cellule(3).call.must_equal "3"
+    cellule(4).call.must_equal "4"
+  end
+
+  # allows conditional ifs with instance method.
+  it do
+    cellule.class.class_eval do
+      cache :show, if: :smaller?
+
+      def smaller?
+        @counter < 3
+      end
+    end
+
+    cellule(1).call.must_equal "1"
+    cellule(2).call.must_equal "1"
+    cellule(3).call.must_equal "3"
+    cellule(4).call.must_equal "4"
+  end
+
+
+  unless ::ActionPack::VERSION::MAJOR == 3 and ::ActionPack::VERSION::MINOR >= 2 # bug in 3.2.
+    describe "utf-8" do
+      before do
+        @key = cellule.class.state_cache_key(:utf8)
+      end
+
+      it "has the correct encoding when reading from cache" do
+        assert_equal "UTF-8", cellule.call(:utf8).encoding.to_s
+        assert_equal "UTF-8", cellule.cache_store.read(@key).encoding.to_s
+      end
+    end
+  end
+
+  # options are passed through to cache store.
+  # :expires_in.
+  # :tags => lambda { |one, two, three| "#{one},#{two},#{three}" }
+  class CacheStore
+    attr_reader :fetch_args
+
+    def fetch(*args)
+      @fetch_args = args
+    end
+  end
+
+  it do
+    cellule = self.cellule
+
+    cellule.instance_eval do
+      def cache_store;
+        @cache_store ||= CacheStore.new;
+      end
+    end
+
+    cellule.class.cache :show, expires_in: 1.minutes, tags: lambda { self.class.to_s }
+    cellule.call
+    cellule.cache_store.fetch_args.must_equal ["cells/caching_test/director/show/", {expires_in: 60, tags: "CachingTest::DirectorCell"}]
+  end
+end
+
+
+class CachingInheritanceTest < CachingTest
+  class DirectorCell < ::DirectorCell
+    cache :show, :expires_in => 10.minutes do
+      "v1"
+    end
+  end
+
+  class DirectorsSonCell < DirectorCell
+  end
+
+  class DirectorsDaughterCell < ::DirectorCell
+    cache :show, :expires_in => 9.minutes do
+      "v2"
+    end
+  end
+
+end