cells 3.10.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db50f24112bb37938584135fab9266353fe79b7d
-  data.tar.gz: dbccc6a922a93e77ee3d3e9ec44f87f95835eed0
+  metadata.gz: c2d03718953028c4185882847b48fad453efa237
+  data.tar.gz: 32dbbe7fbb4b1605d71ceb671939e20767d29139
 SHA512:
-  metadata.gz: 0f4b0a3a5ccb60348172268dd14b64c5e246549ccc49b3f3aa3da15f8b40dd96785bd92b7ad875fb881f632dfbfaae93d6b507decd1de22b2821147313e1e81f
-  data.tar.gz: 74d5ab523f9075541a9472a20eb3ffdfe3d420e42f26a4e9be22769b955351c3fa3b03f47108a16b0e440825e28c9ca2e0b91cbb63cdb0b94a2f67203631ca14
+  metadata.gz: 461f6ab4355c3d259369c7f6de6593fbcb1029f0e1e5ed10ea67048fc7bf720a9e1be74ee32f4c9b14985915d806852c1327ec2467a7c4a645ff828489f8087b
+  data.tar.gz: 0c1bc64ceb91d75103e8a4a6eacece2f14eb12f36fccaf1dc89001c16f7b72bc927f4f4799031e056500ca100bcc440324491928773e77ea9482b02b2709bff8

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 3.10.1
+
+Allow packaging assets for Rails' asset pipeline into cells. This is still experimental but works great. I love it.
+
 ## 3.10.0
 
 * API CHANGE: Blocks passed to `::cache` and `::cache ... if: ` no longer receive the cell instance as the first argument. Instead, they're executed in cell instance context. Change your code like this:

data/README.md

@@ -113,6 +113,88 @@ The distinction between partials and views is making things more complex, so why
   = render :view => 'items'
 ```
 
+## File Structure
+
+In Cells 3.10 we introduce a new _optional_ file structure integrating with [trailblazer](https://github.com/apotonick/trailblazer)'s "concept-oriented" layout.
+
+This new file layout makes a cell fully **self-contained** so it can be moved around just by grabbing one single directory.
+
+Activate it with
+
+```ruby
+class Comment::Cell
+  self_contained!
+
+  # ...
+end
+```
+
+Now, the cell directory ideally looks like the following.
+
+```
+app
+├── cells
+│   ├── comment
+│   │   ├── cell.rb
+│   │   ├── views
+│   │   │   ├── show.haml
+│   │   │   ├── list.haml
+```
+
+
+Here, cell class and associated views are in the same self-contained `comment` directory.
+
+You can use the new views directory along with leaving your cell _class_ at `app/cells/comment_cell.rb`, if you fancy that.
+
+
+## Asset Pipeline
+
+Cells can also package their own assets like JavaScript, CoffeeScript, Sass and stylesheets. When configured, those files go directly into Rails' asset pipeline. This is a great way to clean up your assets by pushing scripts and styles into the component they belong to. It makes it so much easier to find out which files are actually involved per "widget".
+
+Note: This feature is **still experimental** and the API (file name conventions, configuration, etc.) might change.
+
+Assets per default sit in the cell's `assets/` directory.
+
+```
+app
+├── cells
+│   ├── comment
+│   │   ├── views
+│   │   ├── ..
+│   │   ├── assets
+│   │   │   ├── comment.js.coffee
+│   │   │   ├── comment.css.sass
+```
+
+Adding the assets files to the asset pipeline currently involves two steps (I know it feels a bit clumsy, but I'm sure we'll find a way to make it better soon).
+
+1. Tell Rails that this cell provides its own self-contained assets.
+
+    ```ruby
+    Gemgem::Application.configure do
+      # ...
+
+      config.cells.with_assets = %w(comment)
+    ```
+
+    This will add `app/cells/comment/assets/` to the asset pipeline's paths.
+
+2. Include the assets in `application.js` and `application.css.sass`
+
+    In `app/assets/application.js`, you have to add the cell assets manually.
+
+    ```javascript
+    //=# require comments
+    ```
+
+    Same goes into `app/assets/application.css.sass`.
+
+    ```sass
+    @import 'comments';
+    ```
+
+In future versions, we wanna improve this by automatically including cell assets and avoiding name clashes. If you have ideas, suggestions, I'd love to hear them.
+
 ### Rendering Global Partials
 
 Sometimes you need to render a global partial from `app/views` within a cell. For instance, the `gmaps4rails` helper depends on a global partial. While this breaks encapsulation it's still possible in cells - just add the global view path.
@@ -221,6 +303,7 @@ The block's return value is appended to the state key: `"cells/cart/show/0ecb136
 Cache configuration is inherited to derived cells.
 
 
+
 ### A Note On Fragment Caching
 
 Fragment caching is [not implemented in Cells per design](http://nicksda.apotomo.de/2011/02/rails-misapprehensions-caching-views-is-not-the-views-job/) - Cells tries to move caching to the class layer enforcing an object-oriented design rather than cluttering your views with caching blocks.
@@ -284,7 +367,7 @@ Think of a view model as a cell decorating a model or a collection. In this mode
 
 ```ruby
 class SongCell < Cell::Rails
-  include Cell::Rails::ViewModel
+  include ViewModel
 
   property :title
 

data/gemfiles/Gemfile.rails4-0

@@ -6,5 +6,6 @@ gemspec path: '../'
 gem 'railties', '4.0.2'
 gem 'activemodel', '4.0.2'
 gem 'minitest', '4.7.5'
+gem 'simple_form', '~> 3.0.0'
 
 gem 'label', :path => "../test/dummy/label"

data/gemfiles/Gemfile.rails4-1

@@ -3,8 +3,8 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in cells.gemspec
 gemspec path: '../'
 
-gem 'railties', '4.1.0.beta1'
-gem 'activemodel', '4.1.0.beta1'
+gem 'railties', '4.1.0.rc2'
+gem 'activemodel', '4.1.0.rc2'
 gem 'minitest', '5.2.0'
 
 gem 'label', :path => "../test/dummy/label"

data/lib/cell/base.rb

@@ -90,5 +90,24 @@ module Cell
     def self.controller_path
       @controller_path ||= name.sub(/Cell$/, '').underscore unless anonymous?
     end
+
+
+    # Enforces the new trailblazer directory layout where cells (or concepts in general) are fully self-contained in its own directory.
+    module SelfContained
+      def self_contained!
+        include Prefixes
+      end
+
+      module Prefixes
+        def _prefixes
+          @_prefixes ||= begin
+            super.tap do |prefixes|
+              prefixes[-1] = "#{controller_path}/views" # replace comment/.
+            end
+          end
+        end
+      end
+    end
+    extend SelfContained
   end
 end

data/lib/cell/rails/view_model.rb

@@ -3,6 +3,9 @@
 # no locals
 # options are automatically made instance methods via constructor.
 # call "helpers" in class
+
+# TODO: warn when using ::property but not passing in model in constructor.
+
 class Cell::Rails
   module ViewModel
     include Cell::OptionsConstructor

data/lib/cells/railtie.rb

@@ -2,20 +2,38 @@ 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
       end
     end
-    
+
     initializer "cells.setup_view_paths" do |app|
       Cell::Base.setup_view_paths!
     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"
+      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

data/lib/cells/version.rb

@@ -1,3 +1,3 @@
 module Cells
-  VERSION = '3.10.0'
+  VERSION = '3.10.1'
 end

data/test/app/cells/album/views/cover.haml

@@ -0,0 +1 @@
+%h3= @title

data/test/app/cells/bassist/form_for.erb

@@ -0,0 +1,3 @@
+<%= form_for FormsTest::Song.new, :url => "/songs" do |f| %>
+  <%= f.text_field :name %>
+<% end %>

data/test/app/cells/bassist/form_for_in_haml.haml

@@ -0,0 +1,2 @@
+= form_for FormsTest::Song.new, :url => "/songs" do |f|
+  = f.text_field :name

data/test/rails/forms_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+class FormsTest < MiniTest::Spec
+  class Song < OpenStruct
+    extend ActiveModel::Naming
+  end
+
+  include Cell::TestCase::TestMethods
+
+  let (:bassist) { cell(:bassist) }
+
+  it "renders input fields within the form tag with ERB" do
+    bassist.instance_eval do
+      def form_for
+        render
+      end
+    end
+
+    html = bassist.render_state(:form_for)
+
+    html.must_match Regexp.new("<form.+[name].+<\/form>", Regexp::MULTILINE)
+  end
+
+  class SongFormCell < BassistCell
+    include ViewModel
+    include ActionView::Helpers::FormHelper
+
+    def form
+      render :view => :form_for
+    end
+
+    def dom_class(*)
+
+    end
+
+    def dom_id(*)
+
+    end
+  end
+
+  it "renders input fields within the form tag with ERB and ViewModel" do
+
+    html = SongFormCell.new(@controller).form
+    puts html.to_s
+
+    html.must_match Regexp.new("<form.+<input id=\"forms_test_song_name\".+<\/form>", Regexp::MULTILINE)
+  end
+
+
+  class HamlSongFormCell < BassistCell
+    include ViewModel
+    include ActionView::Helpers::FormHelper
+
+    def form
+      render :view => :form_for_in_haml
+    end
+
+    def dom_class(*)
+
+    end
+
+    def dom_id(*)
+
+    end
+  end
+
+  it "renders input fields within the form tag with HAML and ViewModel" do
+
+    html = HamlSongFormCell.new(@controller).form
+    puts html.to_s
+
+    html.must_match Regexp.new("<form.+<input id=\"forms_test_song_name\".+<\/form>", Regexp::MULTILINE)
+  end
+end

data/test/rails/integration_test.rb

@@ -102,6 +102,7 @@ class ViewMethodsTest < ActionController::TestCase
       end
     end
     get 'skills'
-    assert_equal "<form accept-charset=\"UTF-8\" action=\"musician/index\" method=\"post\"><div style=\"margin:0;padding:0;display:inline\"><input name=\"utf8\" type=\"hidden\" value=\"&#x2713;\" /></div>\n", @response.body
+
+    @response.body.must_match /<form.*action="musician\/index"/
   end
 end

data/test/rails/view_model_test.rb

@@ -1,5 +1,7 @@
 require 'test_helper'
 
+# TODO: test if nested state renders are html_safe.
+
 class Song < OpenStruct
   extend ActiveModel::Naming
 
@@ -56,6 +58,12 @@ class SongCell < Cell::Rails
   end
 
 class ViewModelTest < MiniTest::Spec
+  # class PianoSongCell < Cell::Rails
+  #   include ViewModel
+
+  #   property :title
+  # end
+
   # views :show, :create #=> wrap in render_state(:show, *)
   let (:cell) { SongCell.build_for(nil, :title => "Shades Of Truth") }
 
@@ -87,6 +95,13 @@ if Cell.rails3_2_or_more?
     end
 
 
+    # test "instantiating without model, but call to ::property" do
+    #   assert_raises do
+    #     @controller.cell("view_model_test/piano_song")
+    #   end
+    # end
+
+
     test "URL helpers in view" do
         @cell.show.must_equal %{<h1>BLINDFOLD</h1>
 <a href=\"#{@url}\">Permalink</a>

data/test/self_contained_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class AlbumCell < Cell::Rails
+  self_contained!
+
+  def cover
+    @title = "The Sufferer & The Witness"
+    render
+  end
+end
+
+unless Cell.rails3_0?
+
+  class SelfContainedTest < MiniTest::Spec
+    include Cell::TestCase::TestMethods
+
+    let (:album) { cell(:album) }
+
+    it "renders views from album/views/" do
+     album.render_state(:cover).must_equal "<h3>The Sufferer &amp; The Witness</h3>\n"
+    end
+  end
+
+end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: cells
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.10.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.7.5
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Cells are view components for Rails. They are lightweight controllers,
@@ -145,8 +145,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - README.md
@@ -193,12 +193,15 @@ files:
 - lib/generators/templates/view.haml
 - lib/generators/templates/view.slim
 - lib/generators/test_unit/cell_generator.rb
+- test/app/cells/album/views/cover.haml
 - test/app/cells/bad_guitarist/_dii.html.erb
 - test/app/cells/bad_guitarist_cell.rb
 - test/app/cells/bassist/_dii.html.erb
 - test/app/cells/bassist/ahem.html.erb
 - test/app/cells/bassist/compose.html.erb
 - test/app/cells/bassist/contact_form.html.erb
+- test/app/cells/bassist/form_for.erb
+- test/app/cells/bassist/form_for_in_haml.haml
 - test/app/cells/bassist/jam.html.erb
 - test/app/cells/bassist/play.html.erb
 - test/app/cells/bassist/play.js.erb
@@ -272,12 +275,14 @@ files:
 - test/rack_test.rb
 - test/rails/caching_test.rb
 - test/rails/cells_test.rb
+- test/rails/forms_test.rb
 - test/rails/integration_test.rb
 - test/rails/render_test.rb
 - test/rails/router_test.rb
 - test/rails/view_model_test.rb
 - test/rails/view_test.rb
 - test/rails_helper_api_test.rb
+- test/self_contained_test.rb
 - test/test_case_test.rb
 - test/test_helper.rb
 homepage: http://cells.rubyforge.org
@@ -290,18 +295,111 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: View Components for Rails.
-test_files: []
+test_files:
+- test/app/cells/album/views/cover.haml
+- test/app/cells/bad_guitarist/_dii.html.erb
+- test/app/cells/bad_guitarist_cell.rb
+- test/app/cells/bassist/_dii.html.erb
+- test/app/cells/bassist/ahem.html.erb
+- test/app/cells/bassist/compose.html.erb
+- test/app/cells/bassist/contact_form.html.erb
+- test/app/cells/bassist/form_for.erb
+- test/app/cells/bassist/form_for_in_haml.haml
+- test/app/cells/bassist/jam.html.erb
+- test/app/cells/bassist/play.html.erb
+- test/app/cells/bassist/play.js.erb
+- test/app/cells/bassist/pose.html.erb
+- test/app/cells/bassist/promote.html.erb
+- test/app/cells/bassist/provoke.html.erb
+- test/app/cells/bassist/shout.html.erb
+- test/app/cells/bassist/sing.html.haml
+- test/app/cells/bassist/slap.html.erb
+- test/app/cells/bassist/yell.en.html.erb
+- test/app/cells/bassist_cell.rb
+- test/app/cells/club_security.rb
+- test/app/cells/club_security/guard/help.html.erb
+- test/app/cells/club_security/guard_cell.rb
+- test/app/cells/club_security/medic/help.html.erb
+- test/app/cells/club_security/medic_cell.rb
+- test/app/cells/layouts/b.erb
+- test/app/cells/layouts/metal.html.erb
+- test/app/cells/rails_helper_api_test/bassist/edit.html.erb
+- test/app/cells/shouter/sing.html.erb
+- test/app/cells/song/dashboard.haml
+- test/app/cells/song/details.html.haml
+- test/app/cells/song/info.html.haml
+- test/app/cells/song/lyrics.html.haml
+- test/app/cells/song/plays.haml
+- test/app/cells/song/show.html.haml
+- test/app/cells/song/title.html.haml
+- test/app/cells/trumpeter/promote.html.erb
+- test/app/cells/trumpeter_cell.rb
+- test/app/cells/view_model_test/comments/show.haml
+- test/app/views/shared/_dong.html.erb
+- test/cell_generator_test.rb
+- test/cell_module_test.rb
+- test/cell_test.rb
+- test/cells_module_test.rb
+- test/deprecations_test.rb
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/musician_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/musician/featured.html.erb
+- test/dummy/app/views/musician/featured_with_block.html.erb
+- test/dummy/app/views/musician/hamlet.html.haml
+- test/dummy/app/views/musician/title.erb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/label/app/cells/label/show.erb
+- test/dummy/label/app/cells/label_cell.rb
+- test/dummy/label/label.gemspec
+- test/dummy/label/lib/label.rb
+- test/dummy/label/lib/label/version.rb
+- test/dummy/log/production.log
+- test/dummy/log/server.log
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/public/stylesheets/.gitkeep
+- test/dummy/script/rails
+- test/helper_test.rb
+- test/rack_test.rb
+- test/rails/caching_test.rb
+- test/rails/cells_test.rb
+- test/rails/forms_test.rb
+- test/rails/integration_test.rb
+- test/rails/render_test.rb
+- test/rails/router_test.rb
+- test/rails/view_model_test.rb
+- test/rails/view_test.rb
+- test/rails_helper_api_test.rb
+- test/self_contained_test.rb
+- test/test_case_test.rb
+- test/test_helper.rb
+has_rdoc: