cells 4.0.0.beta4 → 4.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57a798a4273783ab7f1deffc6939d0ac6b619984
-  data.tar.gz: 5a2456cabe4d16534dd86ee2036c834c6c11ea45
+  metadata.gz: 3732dd6583b86eaee3a97d864d066cfe8f4268f3
+  data.tar.gz: 95c3e9832728d606d3118b723904276e4a58c958
 SHA512:
-  metadata.gz: 96f18c5cd146d90ce0595e3d46c1f1daca73c0f0b75bafb5e8e0b247124fbc89db6f42dfdc2f4dd7c05b4db95ab6b1c6b670e82ef6b14448c754bb70243b7d50
-  data.tar.gz: 4f2340f3263885ba1d4a2fa738c7e35132a6a6bc07b23a0ccd373a09b8e4d6aaecc300e314e50ced135e17d1aa7d870ce8a10bef9b6392ce9e4a54299c3edb7a
+  metadata.gz: e7e422083ff700c7a9ddd1a5d4d8e2a53833d6b8b55b88042aa5d858210363f331495622c03c264cc1d846ed91f2007a0405755122fb2669108251a524f67910
+  data.tar.gz: 7d691187b2b8123cfc131e58803bf9b5f280ce568486d0449ab86ac1ce704f96db48ea1647c79033c6d22a3c50895119d24079d75d39f2b0818a8a3d953538c7

data/CHANGES.md

@@ -18,12 +18,31 @@
 
 * When using HAML, we do not use any of HAML's helper hacks to "fix" ActionView and XSS. While you might not note this, it removes tons of code from our stack.
 
+
+## 4.0.0.beta5
+
+* Assets bundled in engine cells now work.
+* Directory change: Assets like `.css`, `.coffee` and `.js`, no longer have their own `assets/` directory but live inside the views directory of a cell. It turned out that two directories `views/` and `assets/` was too noisy for most users. If you think you have a valid point for re-introducing it, email me, it is not hard to implement.
+* When bundling your cell's assets into the asset pipeline, you have to specify the full name of your cell. The names will be constantized.
+
+    ```ruby
+    config.cells.with_assets = ["song/cell", "user_cell"] #=> Song::Cell, UserCell
+    ```
+* `ViewModel` is now completely decoupled from Rails and doesn't inherit from AbstractController anymore.
+* API change: The controller dependency is now a second-class citizen being passed into the cell via options.
+
+    ```ruby
+    Cell.new(model, {controller: ..})
+    ```
+* Removing `actionpack` from gemspec.
+
 ## 4.0.0.beta4
 
 * Fixed a bug when rendering more than once with ERB, the output buffer was being reused.
 *  API change: ViewModel::_prefixes now returns the "fully qualified" pathes including the view paths, prepended to the prefixes. This allows multiple view paths and basically fixes cells in engines.
 * The only public way to retrieve prefixes for a cell is `ViewModel::prefixes`. The result is cached.
 
+
 ## 4.0.0.beta3
 
 * Introduce `Cell::Testing` for Rspec and MiniTest.

data/Rakefile

@@ -11,3 +11,14 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/*_test.rb'
   test.verbose = true
 end
+
+# Rake::TestTask.new(:rails) do |test|
+#   test.libs << 'test/rails'
+#   test.test_files = FileList['test/rails4.2/*_test.rb']
+#   test.verbose = true
+# end
+
+# rails_task = Rake::Task["rails"]
+# test_task = Rake::Task["test"]
+# default_task.enhance { test_task.invoke }
+# default_task.enhance { rails_task.invoke }

data/cells.gemspec

@@ -5,13 +5,13 @@ require 'cell/version'
 
 Gem::Specification.new do |spec|
   spec.name        = "cells"
-  spec.version     = Cell::VERSION::STRING
+  spec.version     = Cell::VERSION
   spec.platform    = Gem::Platform::RUBY
   spec.authors     = ["Nick Sutterer"]
   spec.email       = ["apotonick@gmail.com"]
   spec.homepage    = "https://github.com/apotonick/cells"
-  spec.summary     = %q{View Models for Rails.}
-  spec.description = %q{Cells replace partials and helpers with OOP view models, giving you proper encapsulation, inheritance, testability and a cleaner view architecture.}
+  spec.summary     = %q{View Models for Ruby and Rails.}
+  spec.description = %q{Cells replaces partials and helpers with OOP view models, giving you proper encapsulation, inheritance, testability and a cleaner view architecture.}
   spec.license     = 'MIT'
 
   spec.files         = `git ls-files`.split("\n")
@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'actionpack',  '>= 3.2'
   spec.add_dependency "uber",        "~> 0.0.9"
   spec.add_dependency 'tilt', '>= 1.4', '< 3'
   spec.add_dependency 'disposable', '~> 0.0.8'

data/gemfiles/rails4.2.gemfile

@@ -1,12 +1,5 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
-gem "minitest-reporters"
-gem "pry-byebug", :platforms => [:mri_20, :mri_21]
-gem "appraisal"
-gem "rake"
-gem "test_xml"
 gem "railties", "~> 4.2.0"
 gem "activemodel", "~> 4.2.0"
 gem "minitest", "~> 5.2"

data/lib/cell.rb

@@ -1,15 +1,11 @@
-require 'tilt'
-require 'uber/inheritable_attr'
-require 'uber/delegates'
-require 'cell/version'
-require 'active_support/dependencies/autoload'
+require "tilt"
+require "uber/inheritable_attr"
+require "uber/delegates"
+require "cell/version"
 
 module Cell
-  extend ActiveSupport::Autoload
-
-  autoload :Concept
-  autoload :TestCase
-  autoload :Testing
+  autoload :TestCase, "cell/test_case"
+  autoload :Testing,  "cell/testing"
 
   def self.rails_version
     Gem::Version.new(ActionPack::VERSION::STRING)
@@ -22,13 +18,17 @@ module Cell
   end # Error
 end
 
-require 'cell/caching'
-require 'cell/caching/notification'
-require 'uber/builder'
-require 'cell/prefixes'
-require 'cell/self_contained'
-require 'cell/layout'
-require 'cell/templates'
-require 'cell/view_model'
+require "cell/caching"
+require "cell/caching/notification"
+require "uber/builder"
+require "cell/prefixes"
+require "cell/self_contained"
+require "cell/layout"
+require "cell/templates"
+require "cell/abstract"
+require "cell/util"
+require "cell/view_model"
+require "cell/concept"
+
 
-require 'cell/railtie'
+require "cell/railtie" if defined?(Rails)

data/lib/cell/abstract.rb

@@ -0,0 +1,9 @@
+module Cell::Abstract
+  def abstract!
+    @abstract = true
+  end
+
+  def abstract?
+    @abstract
+  end
+end

data/lib/cell/caching.rb

@@ -1,25 +1,24 @@
-require 'active_support/concern'
-require 'active_support/cache'
 require 'uber/options'
 
 module Cell
   module Caching
-    extend ActiveSupport::Concern
-
-    included do
-      extend Uber::InheritableAttr
-      inheritable_attr :version_procs
-      inheritable_attr :conditional_procs
-      inheritable_attr :cache_options
-
-      self.version_procs = {}
-      self.conditional_procs = {}
-      self.cache_options = Uber::Options.new({})
+    def self.included(includer)
+      includer.class_eval do
+        extend ClassMethods
+        extend Uber::InheritableAttr
+        inheritable_attr :version_procs
+        inheritable_attr :conditional_procs
+        inheritable_attr :cache_options
+
+        self.version_procs = {}
+        self.conditional_procs = {}
+        self.cache_options = Uber::Options.new({})
+      end
     end
 
     module ClassMethods
       def cache(state, *args, &block)
-        options = args.extract_options!
+        options = args.last.is_a?(Hash) ? args.pop : {} # I have to admit, Array#extract_options is a brillant tool.
 
         self.conditional_procs[state] = Uber::Options::Value.new(options.delete(:if) || true)
         self.version_procs[state] = Uber::Options::Value.new(args.first || block)
@@ -38,7 +37,7 @@ module Cell
     private
 
       def expand_cache_key(key)
-        ::ActiveSupport::Cache.expand_cache_key(key, :cells)
+        key.join("/") # TODO: test me!
       end
     end
 
@@ -53,7 +52,7 @@ module Cell
     end
 
     def cache_store  # we want to use DI to set a cache store in cell/rails.
-      ActionController::Base.cache_store
+      raise "No cache store has been set."
     end
 
     def cache?(state, *args)
@@ -63,7 +62,7 @@ module Cell
   private
 
     def perform_caching?
-      ActionController::Base.perform_caching
+      true
     end
 
     def fetch_from_cache_for(key, options)

data/lib/cell/concept.rb

@@ -9,13 +9,11 @@ class Cell::Concept < Cell::ViewModel
     end
 
     def controller_path
-      @controller_path ||= name.sub(/::Cell/, '').underscore
+      @controller_path ||= util.underscore(name.sub(/::Cell/, ''))
     end
   end
 
-  def concept(name, *args, &block)
-    self.class.cell(name, parent_controller, *args, &block)
-  end
+  alias_method :concept, :cell # the #cell helper to instantiate cells in cells.
 
   self_contained!
 end

data/lib/cell/prefixes.rb

@@ -1,6 +1,7 @@
-# TODO: cache _prefixes on class layer.
 module Cell::Prefixes
-  extend ActiveSupport::Concern
+  def self.included(includer)
+    includer.extend(ClassMethods)
+  end
 
   def _prefixes
     self.class.prefixes

data/lib/cell/rails.rb

@@ -2,12 +2,12 @@
 module Cell
   module RailsExtensions
     module ActionController
-      def cell(name, *args, &block)
-        ViewModel.cell(name, self, *args, &block)
+      def cell(name, model=nil, options={}, &block)
+        ::Cell::ViewModel.cell(name, model, options.merge(controller: self), &block)
       end
 
-      def concept(name, *args, &block)
-        Concept.cell(name, self, *args, &block)
+      def concept(name, model=nil, options={}, &block)
+        ::Cell::Concept.cell(name, model, options.merge(controller: self), &block)
       end
     end
 
@@ -29,5 +29,28 @@ module Cell
         controller.concept(name, *args, &block)
       end
     end
+
+    # Gets included into Cell::ViewModel in a Rails environment.
+    module ViewModel
+      extend ActiveSupport::Concern
+
+      def call(*)
+        super.html_safe
+      end
+
+      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
   end
 end

data/lib/cell/railtie.rb

@@ -1,60 +1,65 @@
-begin
-  require 'rails/railtie'
-rescue LoadError
-else
-  module Cell
-    class Railtie < Rails::Railtie
-      require 'cell/rails'
-      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
+require 'rails/railtie'
+
+module Cell
+  class Railtie < Rails::Railtie
+    require 'cell/rails'
+    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
+
+    initializer 'cells.template_engine' do |app|
+      ViewModel.template_engine = app.config.app_generators.rails.fetch(:template_engine, 'erb').to_s
+    end
 
-      initializer 'cells.template_engine' do |app|
-        ViewModel.template_engine = app.config.app_generators.rails.fetch(:template_engine, 'erb').to_s
+    # 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
 
-      # ruthlessly stolen from the zurb-foundation gem.
-      initializer 'cells.update_asset_paths' do |app|
-        Array(app.config.cells.with_assets).each do |name|
-          # FIXME: this doesn't take engine cells into account.
-          app.config.assets.paths.append "#{app.root}/app/cells/#{name}/assets"
-          app.config.assets.paths.append "#{app.root}/app/concepts/#{name}/assets" # TODO: find out type.
+    initializer('cells.rails_extensions') do |app|
+      ActiveSupport.on_load(:action_controller) do
+        self.class_eval do
+          include ::Cell::RailsExtensions::ActionController
         end
       end
 
-      initializer('cells.rails_extensions') do |app|
-        ActiveSupport.on_load(:action_controller) do
-          self.class_eval do
-            include ::Cell::RailsExtensions::ActionController
-          end
+      ActiveSupport.on_load(:action_view) do |app|
+        self.class_eval do
+          include ::Cell::RailsExtensions::ActionView
         end
 
-        ActiveSupport.on_load(:action_view) do
-          self.class_eval do
-            include ::Cell::RailsExtensions::ActionView
-          end
-
-          #include assert helpers (image_path, font_path, ect)
-          ViewModel.class_eval do
-            include ActionView::Helpers::AssetTagHelper
-          end
+        #include assert helpers (image_path, font_path, ect)
+        ViewModel.class_eval do
+          include ActionView::Helpers::AssetTagHelper
         end
       end
 
-      initializer('cells.development') do |app|
-        if Rails.env == "development"
-          require "cell/development"
-          ViewModel.send(:include, Development)
-        end
+      # set VM#cache_store, etc.
+      ViewModel.send(:include, RailsExtensions::ViewModel)
+
+      if defined?(ActionView)
+        # always include those helpers so we can override the shitty parts.
+        ViewModel.send(:include, ActionView::Helpers::UrlHelper)
+        ViewModel.send(:include, ActionView::Helpers::FormTagHelper)
       end
+    end
 
-      rake_tasks do
-        load 'tasks/cells.rake'
+    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/cell/testing.rb

@@ -11,8 +11,8 @@ module Cell
     end
 
   private
-    def cell_for(baseclass, name, *args)
-      cell = baseclass.cell(name, controller, *args)
+    def cell_for(baseclass, name, model=nil, options={})
+      cell = baseclass.cell(name, model, options.merge(controller: controller))
       cell.extend(Capybara) if Cell::Testing.capybara? # leaving this here as most people use Capybara.
       cell
     end
@@ -42,23 +42,26 @@ module Cell
 
 
     # Rails specific.
-    def controller
+    def controller_for(controller_class)
       # TODO: test without controller.
-      return unless self.class.controller_class
+      return unless controller_class
 
-      # TODO: test with controller.
-      self.class.controller_class.new.tap do |ctl|
-        ctl.request = ActionController::TestRequest.new
-        ctl.instance_variable_set :@routes, Rails.application.routes.url_helpers
+      controller_class.new.tap do |ctl|
+        ctl.request = ::ActionController::TestRequest.new
+        ctl.instance_variable_set :@routes, ::Rails.application.routes.url_helpers
       end
     end
 
+    def controller # FIXME: this won't allow us using let(:controller) in MiniTest.
+      controller_for(self.class.controller_class)
+    end
+
     def self.included(base)
       base.class_eval do
         extend Uber::InheritableAttr
         inheritable_attr :controller_class
 
-        def self.controller(name)
+        def self.controller(name) # DSL method for the test.
           self.controller_class = name
         end
       end