webmachine-actionview 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webmachine-actionview.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Russell Garner
+
+MIT License
+
+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,98 @@
+# Webmachine::Actionview
+
+Integration of some Rails-style view conventions into Webmachine.  Uses your resource as a view context.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webmachine-actionview'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webmachine-actionview
+
+## Usage
+
+Include `Webmachine::ActionView::Resource` in resources you want to use ActionView. Somewhere in your app's
+startup, you'll need to tell it where views live and (optionally) what handlers you're supporting, for example:
+
+```ruby
+Webmachine::ActionView.configure do |config|
+  config.view_paths = [MY_VIEWS_PATH]
+  config.handlers = [:erb, :haml, :builder]
+end
+```
+
+In your resource, you'll need to render the view at some point.  Rendering is broadly similar to that in Rails.
+The simplest thing you can do is this:
+
+```ruby
+class HomeResource < Webmachine::Resource
+  include Webmachine::ActionView::Resource
+  def to_html
+    render
+  end
+end
+```
+
+This will look for a template called "home" in your `Webmachine::ActionView.configuration.view_paths`.  By default, this
+will look for an application layout of `layouts/application`.
+
+You can be more specific:
+
+```ruby
+render template: 'other_template', layout: 'mini'
+```
+
+You can suppress a layout:
+
+```ruby
+render layout: nil
+# or
+render layout: false
+```
+
+Your resource itself is used as the view context. This means that you can use instance variables as you would in Rails.
+For example:
+
+```ruby
+class Customer << Webmachine::Resource
+  include Webmachine::ActionView::Resource
+
+  def resource_exists?
+    @customer = Customer.find(some_id)
+  end
+
+  def to_html
+    render
+  end
+end
+```
+
+And in an associated `customer.html.erb` template, `@customer` will be available:
+
+```erb
+<p class="name"><%= @customer.name %></p>
+```
+
+You can also render partials from your views:
+
+```ruby
+render partial: 'shared/my_partial'
+```
+
+Partials are subject to the same conventions as Rails, i.e. their filenames begin with an underscore, but no underscore
+is required when making a call to `render partial: 'some_partial'`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/webmachine/actionview.rb

@@ -0,0 +1,4 @@
+require 'action_view'
+require 'webmachine/actionview/version'
+require 'webmachine/actionview/configuration'
+require 'webmachine/actionview/resource'

data/lib/webmachine/actionview/configuration.rb

@@ -0,0 +1,21 @@
+require 'active_support/configurable'
+
+module Webmachine
+  module ActionView
+
+    # Configures settings for Webmachine::ActionView
+    def self.configure(&block)
+      yield @config ||= Configuration.new
+    end
+
+    def self.config
+      @config
+    end
+
+    class Configuration #:nodoc:
+      include ActiveSupport::Configurable
+
+      config_accessor :view_paths, :handlers
+    end
+  end
+end

data/lib/webmachine/actionview/resource.rb

@@ -0,0 +1,50 @@
+module Webmachine
+  module ActionView
+    def self.view_paths
+      []
+    end
+
+    module Resource
+      def self.included(base)
+        base.class_eval do
+          include ::ActionView::Helpers::CaptureHelper
+          include ::ActionView::Context
+        end
+      end
+
+      DEFAULT_LAYOUT = 'layouts/application'
+
+      def render(options = nil)
+        options ||= default_template_name
+        options = { :template => options } if options.is_a?(String)
+
+        unless options[:partial]
+          if options.has_key?(:layout) && !options[:layout]
+            options.delete(:layout)
+          else
+            options.reverse_merge!(layout: DEFAULT_LAYOUT)
+          end
+          _prepare_context
+        end
+
+        view_renderer.render(self, options)
+      end
+
+      def default_template_name
+        @default_template_name ||= self.class.name.underscore.sub(/_resource$/, '')
+      end
+
+      def view_paths
+        @view_paths ||= ::ActionView::PathSet.new(Webmachine::ActionView.config.view_paths)
+      end
+
+      def lookup_context
+        @lookup_context ||= ::ActionView::LookupContext.new(view_paths)
+      end
+
+      def view_renderer
+        @view_renderer ||= ::ActionView::Renderer.new(lookup_context)
+      end
+    end
+  end
+end

data/lib/webmachine/actionview/version.rb

@@ -0,0 +1,5 @@
+module Webmachine
+  module ActionView
+    VERSION = "0.0.1"
+  end
+end

data/spec/dummy/app.rb

@@ -0,0 +1,11 @@
+require 'dummy/resources/home_resource'
+
+module Dummy
+  Application = Webmachine::Application.new do |app|
+  end
+
+  Application.routes do
+    add [], HomeResource
+  end
+end
+

data/spec/dummy/resources/home_resource.rb

@@ -0,0 +1,15 @@
+class HomeResource < Webmachine::Resource
+  include Webmachine::ActionView::Resource
+
+  def to_html
+    @home = HomeResource.home_instance
+    render
+  end
+
+  def self.home_instance
+    Struct.new(:id, :name).new.tap do |h|
+      h.id = 1
+      h.name = "some name"
+    end
+  end
+end

data/spec/dummy/views/home.html.erb

@@ -0,0 +1,4 @@
+<p>home.html.erb content</p>
+<p>id: <%= @home.id %></p>
+<p>name: <%= @home.name %></p>
+<div class="from_a_partial"><%= render partial: 'shared/some_partial'  %></div>

data/spec/dummy/views/layouts/application.html.erb

@@ -0,0 +1,4 @@
+<div id="application">
+  <p>content from the application layout</p>
+  <%= yield %>
+</div>

data/spec/dummy/views/layouts/explicit.html.erb

@@ -0,0 +1 @@
+FUSKING CLOFF PRUNKER

data/spec/dummy/views/shared/_some_partial.html.erb

@@ -0,0 +1 @@
+<p>content from shared/some_partial</p>

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'webmachine'
+require 'webmachine/actionview'
+require 'dummy/app'

data/spec/webmachine/actionview/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Webmachine::ActionView::Configuration do
+  describe "Configuring" do
+    let(:paths) { ['somewhere/over/the/rainbow'] }
+    let(:handlers) { ['erb', 'slim', 'haml'] }
+
+    before do
+      Webmachine::ActionView.configure do |c|
+        c.view_paths = paths
+        c.handlers = handlers
+      end
+    end
+
+    subject(:config) { Webmachine::ActionView.config }
+
+    its(:view_paths) { should eql(paths) }
+    its(:handlers) { should eql(handlers) }
+  end
+end

data/spec/webmachine/actionview/resource_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+
+class BaseResource < Webmachine::Resource
+  include Webmachine::ActionView::Resource
+end
+
+class UnconventionalName < BaseResource
+end
+
+describe "A resource including Webmachine::ActionView::Resource" do
+  let(:request)  { nil }
+  let(:response) { nil }
+
+  let(:resource)                { HomeResource.new(request, response) }
+  let(:unconventional_resource) { UnconventionalName.new(request, response) }
+
+  before :all do
+    Webmachine::ActionView.configure do |c|
+      c.view_paths = ['spec/dummy/views']
+    end
+  end
+
+  describe "Default places to look for templates" do
+    describe "the path set" do
+      subject(:view_paths) { resource.view_paths }
+
+      it { should be_an(ActionView::PathSet) }
+      it "has the path we previously configured" do
+        view_paths.paths.map(&:to_s).should include(File.expand_path('spec/dummy/views'))
+      end
+    end
+
+    context "A conventionally-named resource" do
+      it "looks for a template without resource in the class name" do
+        resource.default_template_name.should == 'home'
+      end
+    end
+    context "An unconventionally-named resource" do
+      it "looks for a template as an underscored version of its class name" do
+        unconventional_resource.default_template_name.should == 'unconventional_name'
+      end
+    end
+  end
+
+  describe "Finding templates through the lookup context" do
+    subject(:lookup_context) { resource.lookup_context }
+
+    it { should be_an(ActionView::LookupContext) }
+
+    it "finds templates implicitly" do
+      lookup_context.find('home').should be_a(ActionView::Template)
+    end
+    it "finds templates implicitly when html is mentioned" do
+      lookup_context.find('home.html').should be_a(ActionView::Template)
+    end
+    it "fails to find templates for unmentioned extensions" do
+      lambda { resource.lookup_context.find('foo') }.should raise_error(ActionView::MissingTemplate)
+    end
+  end
+
+  describe "Rendering from a template with a context" do
+    subject(:rendered) { resource.to_html }
+
+    it { should include('id: 1') }
+    it { should include('name: some name') }
+
+    it { should include('content from the application layout')}
+    it { should include('content from shared/some_partial')}
+  end
+
+  describe "Explicit template rendering" do
+    subject(:rendered) { resource.to_html }
+
+    context "With an explicit layout" do
+      let(:resource) do
+        HomeResource.new(request, response).tap do |h|
+          def h.to_html
+            @home = HomeResource.home_instance
+            render template: 'home', layout: 'layouts/explicit'
+          end
+        end
+      end
+
+      it "should include explicit content" do
+        rendered.should include('FUSKING CLOFF PRUNKER')
+      end
+    end
+    context "Suppressing default layout" do
+      let(:resource) do
+        HomeResource.new(request, response).tap do |h|
+          def h.to_html
+            @home = HomeResource.home_instance
+            render template: 'home', layout: false
+          end
+        end
+      end
+
+      it "should not include explicit content" do
+        rendered.should_not include('FUSKING CLOFF PRUNKER')
+      end
+    end
+  end
+end

data/webmachine-actionview.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webmachine/actionview/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "webmachine-actionview"
+  gem.version       = Webmachine::ActionView::VERSION
+  gem.authors       = ["Russell Garner"]
+  gem.email         = ["rgarner@zephyros-systems.co.uk"]
+  gem.description   = %q{Brings ActionView to webmachine-ruby}
+  gem.summary       = %q{Want the Rails conventions that you're used to for HTML views in webmachine-ruby? This is your gem.}
+  gem.homepage      = "http://github.com/rgarner/webmachine-actionview"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmachine-test"
+
+  gem.add_runtime_dependency "webmachine"
+  gem.add_runtime_dependency "activesupport"
+  gem.add_runtime_dependency "actionpack"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: webmachine-actionview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Russell Garner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152313240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152313240
+- !ruby/object:Gem::Dependency
+  name: webmachine-test
+  requirement: &2152312620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152312620
+- !ruby/object:Gem::Dependency
+  name: webmachine
+  requirement: &2152311940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152311940
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152311380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152311380
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2152310840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152310840
+description: Brings ActionView to webmachine-ruby
+email:
+- rgarner@zephyros-systems.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webmachine/actionview.rb
+- lib/webmachine/actionview/configuration.rb
+- lib/webmachine/actionview/resource.rb
+- lib/webmachine/actionview/version.rb
+- spec/dummy/app.rb
+- spec/dummy/resources/home_resource.rb
+- spec/dummy/views/foo.html.unsupportedfiletype
+- spec/dummy/views/home.html.erb
+- spec/dummy/views/layouts/application.html.erb
+- spec/dummy/views/layouts/explicit.html.erb
+- spec/dummy/views/shared/_some_partial.html.erb
+- spec/spec_helper.rb
+- spec/webmachine/actionview/configuration_spec.rb
+- spec/webmachine/actionview/resource_spec.rb
+- webmachine-actionview.gemspec
+homepage: http://github.com/rgarner/webmachine-actionview
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Want the Rails conventions that you're used to for HTML views in webmachine-ruby?
+  This is your gem.
+test_files:
+- spec/dummy/app.rb
+- spec/dummy/resources/home_resource.rb
+- spec/dummy/views/foo.html.unsupportedfiletype
+- spec/dummy/views/home.html.erb
+- spec/dummy/views/layouts/application.html.erb
+- spec/dummy/views/layouts/explicit.html.erb
+- spec/dummy/views/shared/_some_partial.html.erb
+- spec/spec_helper.rb
+- spec/webmachine/actionview/configuration_spec.rb
+- spec/webmachine/actionview/resource_spec.rb