middleman-cells 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78e0de27631ecda408448270d603dcbdf978c6ba
+  data.tar.gz: 3b487f2183c522e01e639e9edba5eefaa4cfcef8
+SHA512:
+  metadata.gz: 924d0d83a3fba72932d7ec2e34a713354b1bbf9f58f2231e1fc57d1f18e7f98975d40d974cf43a9a1bfa6201e09bdaaa48a30ba4af5742864ed76fd1f7464fc7
+  data.tar.gz: 8a17f15450d9349a592fa57f31155ccc40b6facd5e0a81209de1b388ac1db112e3b8ccbbaed10b3ddab5b4e3c20bb53357cf4559d72b245a01476aaf076c9818

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+/tmp

data/Gemfile

@@ -0,0 +1,27 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-cells.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber', '~> 2.0.0'
+  gem 'aruba', '~> 0.7.4'
+  gem 'rspec', '~> 3.0.0'
+
+  gem 'cells-erb'
+  gem 'cells-haml'
+  # Haml 4.1 is required (see https://github.com/trailblazer/cells-haml#installation)
+  gem 'haml', github: 'haml/haml', ref: '7c7c169'
+  gem 'cells-hamlit'
+  gem 'hamlit'
+  gem 'cells-slim'
+  gem 'hashie'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 notozeki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# Middleman::Cells
+
+[Cells](https://github.com/apotonick/cells) support for [Middleman](https://github.com/middleman/middleman).
+
+## Usage
+
+Create cells under `source/cells`.
+
+`source/cells/greet_cell.rb`:
+```ruby
+class GreetCell < Cell::ViewModel
+  property :name
+
+  def show
+    render
+  end
+end
+```
+
+`source/cells/greet/show.erb`:
+```erb
+<p>Hello, <%= name %>!</p>
+```
+
+Use it in your views.
+
+`source/index.html.erb`
+```erb
+---
+name: Ninome-chan
+---
+
+<%= cell(:greet, current_page.data).() %>
+```
+
+Cool. :smirk:
+
+For more details of Cells, see [Cells' README](https://github.com/apotonick/cells/blob/master/README.md).
+
+
+## Installation
+
+Add the following line to your `Gemfile`.
+
+```ruby
+gem 'middleman-cells'
+```
+
+In addition, you need to install template engine(s) which you want to use in cells.
+Available engines are listed [here](https://github.com/apotonick/cells#installation).
+
+If you want to use [cells-erb](https://github.com/trailblazer/cells-erb), for example, add the following line to `Gemfile`.
+
+```ruby
+gem 'cells-erb'
+```
+
+Then, run `bundle install`.
+
+
+## Configuration
+
+```ruby
+require 'cells-erb' # Require template engine(s) you installed.
+
+activate :cells
+```
+
+Or, if you prefer:
+
+```ruby
+activate :cells do
+  require 'cells-erb'
+end
+```
+
+### Configuration Options
+
+#### `cells_dir` (default: `"cells"`)
+
+```ruby
+# Change directory where to place cells to `source/view_models`.
+activate :cells, cells_dir: 'view_models'
+```
+
+#### `autoload` (default: `true`)
+
+```ruby
+# Disable to autoload cells.
+activate :cells, autoload: false
+
+# ...and you need to require your cells manually.
+require 'source/cells/foobar_cell'
+```
+
+## Contributing
+
+Please report bugs via [Issues](https://github.com/notozeki/middleman-cells/issues). Also [Pull Requests](https://github.com/notozeki/middleman-cells/pulls) are welcome. :grinning:
+
+Issue や Pull Request は日本語でもOKです :jp:
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/cells.feature

@@ -0,0 +1,48 @@
+Feature: Cells support for Middleman
+
+  Scenario: Render a basic cell
+    Given the Server is running at "basic-app"
+    When I go to "/index.html"
+    Then I should see "Hello."
+
+  Scenario: Cells in non-default directory
+    Given the Server is running at "non-default-dir-app"
+    When I go to "/index.html"
+    Then I should see "Hello from non-default directory."
+
+  Scenario: Render with helpers
+    Given the Server is running at "helpers-app"
+    When I go to "/index.html"
+    Then I should see "This is rendered by a helper."
+    When I go to "/method.html"
+    Then I should see "This is rendered by #foobar."
+    When I go to "/collection.html"
+    Then I should see "Item #1"
+    Then I should see "Item #2"
+    Then I should see "Item #3"
+
+  Scenario: Edit and reload
+    Given the Server is running at "reload-app"
+    When I go to "/index.html"
+    Then I should see "Before"
+    And a file named "source/cells/reload/show.erb" with:
+      """
+      <p>After</p>
+      """
+    When I go to "/index.html"
+    Then I should see "After"
+
+  Scenario: Hamlit support
+    Given the Server is running at "hamlit-app"
+    When I go to "/index.html"
+    Then I should see "<p>This is a Hamlit.</p>"
+
+  Scenario: Haml support
+    Given the Server is running at "haml-app"
+    When I go to "/index.html"
+    Then I should see "<p>This is a Haml.</p>"
+
+  Scenario: Slim support
+    Given the Server is running at "slim-app"
+    When I go to "/index.html"
+    Then I should see "<p>This is a Slim.</p>"

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-cells')

data/fixtures/basic-app/config.rb

@@ -0,0 +1,3 @@
+activate :cells do
+  require 'cells-erb'
+end

data/fixtures/basic-app/source/cells/basic/show.erb

@@ -0,0 +1 @@
+<p>Hello.</p>

data/fixtures/basic-app/source/cells/basic_cell.rb

@@ -0,0 +1,5 @@
+class BasicCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/basic-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= BasicCell.().() %>

data/fixtures/haml-app/config.rb

@@ -0,0 +1,3 @@
+activate :cells do
+  require 'cells-haml'
+end

data/fixtures/haml-app/source/cells/haml/show.haml

@@ -0,0 +1 @@
+%p This is a Haml.

data/fixtures/haml-app/source/cells/haml_cell.rb

@@ -0,0 +1,5 @@
+class HamlCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/haml-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= HamlCell.().() %>

data/fixtures/hamlit-app/config.rb

@@ -0,0 +1,3 @@
+activate :cells do
+  require 'cells-hamlit'
+end

data/fixtures/hamlit-app/source/cells/hamlit/show.haml

@@ -0,0 +1 @@
+%p This is a Hamlit.

data/fixtures/hamlit-app/source/cells/hamlit_cell.rb

@@ -0,0 +1,5 @@
+class HamlitCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/hamlit-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= HamlitCell.().() %>

data/fixtures/helpers-app/config.rb

@@ -0,0 +1,5 @@
+require 'hashie'
+
+activate :cells do
+  require 'cells-erb'
+end

data/fixtures/helpers-app/source/cells/helpers/show.erb

@@ -0,0 +1 @@
+<p>This is rendered by a helper.</p>

data/fixtures/helpers-app/source/cells/helpers_cell.rb

@@ -0,0 +1,5 @@
+class HelpersCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/helpers-app/source/cells/item/show.erb

@@ -0,0 +1 @@
+<li>Item #<%= id %></li>

data/fixtures/helpers-app/source/cells/item_cell.rb

@@ -0,0 +1,7 @@
+class ItemCell < Cell::ViewModel
+  property :id
+
+  def show
+    render
+  end
+end

data/fixtures/helpers-app/source/cells/method/foobar.erb

@@ -0,0 +1 @@
+<p>This is rendered by #foobar.</p>

data/fixtures/helpers-app/source/cells/method_cell.rb

@@ -0,0 +1,5 @@
+class MethodCell < Cell::ViewModel
+  def foobar
+    render
+  end
+end

data/fixtures/helpers-app/source/collection.html.erb

@@ -0,0 +1,5 @@
+<% items = (1..3).map{|i| Hashie::Mash.new(id: i) } %>
+
+<ul>
+  <%= cell(:item, collection: items) %>
+</ul>

data/fixtures/helpers-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= cell(:helpers).() %>

data/fixtures/helpers-app/source/method.html.erb

@@ -0,0 +1 @@
+<%= cell(:method).(:foobar) %>

data/fixtures/non-default-dir-app/config.rb

@@ -0,0 +1,3 @@
+activate :cells, cells_dir: 'view_models' do
+  require 'cells-erb'
+end

data/fixtures/non-default-dir-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= NonDefaultDirCell.().() %>

data/fixtures/non-default-dir-app/source/view_models/non_default_dir/show.erb

@@ -0,0 +1 @@
+<p>Hello from non-default directory.</p>

data/fixtures/non-default-dir-app/source/view_models/non_default_dir_cell.rb

@@ -0,0 +1,5 @@
+class NonDefaultDirCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/reload-app/config.rb

@@ -0,0 +1,3 @@
+activate :cells do
+  require 'cells-erb'
+end

data/fixtures/reload-app/source/cells/reload/show.erb

@@ -0,0 +1 @@
+<p>Before</p>

data/fixtures/reload-app/source/cells/reload_cell.rb

@@ -0,0 +1,5 @@
+class ReloadCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/reload-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= ReloadCell.().() %>

data/fixtures/slim-app/config.rb

@@ -0,0 +1,3 @@
+activate :cells do
+  require 'cells-slim'
+end

data/fixtures/slim-app/source/cells/slim/show.slim

@@ -0,0 +1 @@
+p This is a Slim.

data/fixtures/slim-app/source/cells/slim_cell.rb

@@ -0,0 +1,5 @@
+class SlimCell < Cell::ViewModel
+  def show
+    render
+  end
+end

data/fixtures/slim-app/source/index.html.erb

@@ -0,0 +1 @@
+<%= SlimCell.().() %>

data/lib/middleman-cells.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+Middleman::Extensions.register :cells do
+  require 'middleman-cells/extension'
+  Middleman::Cells::Extension
+end

data/lib/middleman-cells/extension.rb

@@ -0,0 +1,59 @@
+require 'middleman-core'
+
+module Middleman
+  module Cells
+    class Extension < ::Middleman::Extension
+      option :cells_dir, 'cells', 'Directory where to place cells'
+      option :autoload, true, 'Whether to autoload cells or not'
+
+      def initialize(app, options_hash={}, &block)
+        super
+
+        require 'cells'
+        require 'active_support/inflector'
+        yield if block_given? # Expect to require template engines (like cells-erb).
+
+        ::Cell::ViewModel.send(:include, ::Cell::Erb) if defined?(::Cell::Erb)
+        ::Cell::ViewModel.send(:include, ::Cell::Hamlit) if defined?(::Cell::Hamlit)
+        ::Cell::ViewModel.send(:include, ::Cell::Haml) if defined?(::Cell::Haml)
+        if defined?(::Cell::Slim)
+          ::Cell::ViewModel.send(:include, ::Cell::Slim)
+
+          # HACK: In Tilt's convention, All arguments of Template#initialize
+          # are optional. But Middleman breaks it when overriding
+          # Slim::Template and it causes ArgumentError. So we re-define it here
+          # to follow the convention for the nonce. This very smells...:hankey:
+          ::Slim::Template.class_eval do
+            alias orig_initialize initialize
+            def initialize(file=nil, line=1, options={}, &block)
+              orig_initialize(file, line, options, &block)
+            end
+          end
+        end
+      end
+
+      def after_configuration
+        cells_dir = File.join(app.root, app.config[:source], options.cells_dir)
+
+        ::Cell::ViewModel.view_paths << cells_dir
+
+        if options.autoload
+          require 'active_support/dependencies'
+          ::ActiveSupport::Dependencies.autoload_paths << cells_dir
+        end
+
+        if app.config[:environment] == :development
+          require 'cell/development'
+          ::Cell::ViewModel.send(:include, ::Cell::Development)
+        end
+      end
+
+      helpers do
+        # Refer to Cell::ViewModel::Helpers#cell
+        def cell(name, *args, &block)
+          "#{name}_cell".camelize.constantize.(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-cells/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Cells
+    VERSION = '0.0.1'
+  end
+end

data/middleman-cells.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'middleman-cells/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-cells'
+  s.version     = Middleman::Cells::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['notozeki']
+  s.email       = ['notozeki@gmail.com']
+  s.summary     = %q{Cells support for Middleman.}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'middleman-core', '~> 4.0'
+  s.add_runtime_dependency 'cells', '~> 4.0.0'
+  s.add_runtime_dependency 'activesupport', '~> 4.2.0'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: middleman-cells
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- notozeki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: cells
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: 
+email:
+- notozeki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/cells.feature
+- features/support/env.rb
+- fixtures/basic-app/config.rb
+- fixtures/basic-app/source/cells/basic/show.erb
+- fixtures/basic-app/source/cells/basic_cell.rb
+- fixtures/basic-app/source/index.html.erb
+- fixtures/haml-app/config.rb
+- fixtures/haml-app/source/cells/haml/show.haml
+- fixtures/haml-app/source/cells/haml_cell.rb
+- fixtures/haml-app/source/index.html.erb
+- fixtures/hamlit-app/config.rb
+- fixtures/hamlit-app/source/cells/hamlit/show.haml
+- fixtures/hamlit-app/source/cells/hamlit_cell.rb
+- fixtures/hamlit-app/source/index.html.erb
+- fixtures/helpers-app/config.rb
+- fixtures/helpers-app/source/cells/helpers/show.erb
+- fixtures/helpers-app/source/cells/helpers_cell.rb
+- fixtures/helpers-app/source/cells/item/show.erb
+- fixtures/helpers-app/source/cells/item_cell.rb
+- fixtures/helpers-app/source/cells/method/foobar.erb
+- fixtures/helpers-app/source/cells/method_cell.rb
+- fixtures/helpers-app/source/collection.html.erb
+- fixtures/helpers-app/source/index.html.erb
+- fixtures/helpers-app/source/method.html.erb
+- fixtures/non-default-dir-app/config.rb
+- fixtures/non-default-dir-app/source/index.html.erb
+- fixtures/non-default-dir-app/source/view_models/non_default_dir/show.erb
+- fixtures/non-default-dir-app/source/view_models/non_default_dir_cell.rb
+- fixtures/reload-app/config.rb
+- fixtures/reload-app/source/cells/reload/show.erb
+- fixtures/reload-app/source/cells/reload_cell.rb
+- fixtures/reload-app/source/index.html.erb
+- fixtures/slim-app/config.rb
+- fixtures/slim-app/source/cells/slim/show.slim
+- fixtures/slim-app/source/cells/slim_cell.rb
+- fixtures/slim-app/source/index.html.erb
+- lib/middleman-cells.rb
+- lib/middleman-cells/extension.rb
+- lib/middleman-cells/version.rb
+- middleman-cells.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Cells support for Middleman.
+test_files:
+- features/cells.feature
+- features/support/env.rb
+has_rdoc: