webmachine-actionview 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in webmachine-actionview.gemspec
+group :development, :test do
+  gem "rspec"
+  gem "yard"
+  gem "webmachine-test"
+end
+
 gemspec

data/README.md

@@ -61,7 +61,7 @@ Your resource itself is used as the view context. This means that you can use in
 For example:
 
 ```ruby
-class Customer << Webmachine::Resource
+class CustomerResource < Webmachine::Resource
   include Webmachine::ActionView::Resource
 
   def resource_exists?
@@ -89,6 +89,12 @@ 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'`.
 
+## Thanks
+
+This gem came about a lot quicker due to someone else already having fiddled with the internals of ActionView.
+The link I originally found is https://github.com/newhavenrb/conferences/wiki/Using-Rails-without-Rails, so I think
+that means thanks to @drogus - pretty sure those are his slides linked to from that page.
+
 ## Contributing
 
 1. Fork it

data/lib/webmachine/actionview/configuration.rb

@@ -3,11 +3,18 @@ require 'active_support/configurable'
 module Webmachine
   module ActionView
 
-    # Configures settings for Webmachine::ActionView
+    # Configures settings for {Webmachine::ActionView}
+    # @return [Webmachine::ActionView::Configuration]
+    # @example
+    #   Webmachine::ActionView.configure do |config|
+    #     config.view_paths = [MY_VIEWS_PATH]
+    #     config.handlers = [:erb, :haml, :builder]
+    #   end
     def self.configure(&block)
       yield @config ||= Configuration.new
     end
 
+    # @return [Webmachine::ActionView::Configuration]
     def self.config
       @config
     end
@@ -15,7 +22,13 @@ module Webmachine
     class Configuration #:nodoc:
       include ActiveSupport::Configurable
 
-      config_accessor :view_paths, :handlers
+      DEFAULT_LAYOUT = 'layouts/application'
+
+      config_accessor :view_paths, :handlers, :default_layout
+    end
+
+    configure do |c|
+      c.default_layout = Configuration::DEFAULT_LAYOUT
     end
   end
 end

data/lib/webmachine/actionview/resource.rb

@@ -1,9 +1,6 @@
 module Webmachine
   module ActionView
-    def self.view_paths
-      []
-    end
-
+    # Include on {::Webmachine::Resource}-derived classes to get access to ActionView-style templating.
     module Resource
       def self.included(base)
         base.class_eval do
@@ -12,8 +9,16 @@ module Webmachine
         end
       end
 
-      DEFAULT_LAYOUT = 'layouts/application'
-
+      # Renders a template or partial with an optional layout from a `Webmachine::ActionView::Resource`
+      #
+      # @param [Hash] options Describe what you want to render. Leave blank to render the {#default_template_name}
+      # @option options [String] :template Name of the template to render. Do not use with `:partial`
+      # @option options [String] :partial Name of the template to render. Do not use with `:template`
+      # @option options [String] :layout Name of the layout within which to render the template.
+      # @option options [String] :locals `Hash` of locals to pass to a partial.
+      #   Defaults to {Webmachine::ActionView::Resource::DEFAULT_LAYOUT}.
+      #   Suppress with `layout: false` or `layout: nil`
+      # @return [::ActionView::OutputBuffer] the output content
       def render(options = nil)
         options ||= default_template_name
         options = { :template => options } if options.is_a?(String)
@@ -22,7 +27,7 @@ module Webmachine
           if options.has_key?(:layout) && !options[:layout]
             options.delete(:layout)
           else
-            options.reverse_merge!(layout: DEFAULT_LAYOUT)
+            options.reverse_merge!(layout: Webmachine::ActionView.config.default_layout)
           end
           _prepare_context
         end
@@ -30,18 +35,27 @@ module Webmachine
         view_renderer.render(self, options)
       end
 
+      # The conventional template name for the resource. In a class called `HomeResource`, this would be 'home'
+      #
+      # @return [String] default template name for this resource
       def default_template_name
         @default_template_name ||= self.class.name.underscore.sub(/_resource$/, '')
       end
 
+      # Lazily created path set. Configure first with {::Webmachine::ActionView.configure}
+      # @return [::ActionView::PathSet] paths in which to find templates.
       def view_paths
         @view_paths ||= ::ActionView::PathSet.new(Webmachine::ActionView.config.view_paths)
       end
 
+      # The `::ActionView::Context` in which views are looked up.
+      # @return [::ActionView::Context]
       def lookup_context
         @lookup_context ||= ::ActionView::LookupContext.new(view_paths)
       end
 
+      # The renderer responsible for rendering when #render is called
+      # @return [::ActionView::Renderer] the renderer
       def view_renderer
         @view_renderer ||= ::ActionView::Renderer.new(lookup_context)
       end

data/lib/webmachine/actionview/version.rb

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

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

@@ -1,4 +1,6 @@
 <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>
+<div class="from_a_partial">
+  <%= render partial: 'shared/some_partial', locals: { local: Struct.new(:content).new(content: 'local content') }  %>
+</div>

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

@@ -1 +1,2 @@
-<p>content from shared/some_partial</p>
+<p>content from shared/some_partial</p>
+<%= local.content %>

data/spec/webmachine/actionview/configuration_spec.rb

@@ -9,6 +9,7 @@ describe Webmachine::ActionView::Configuration do
       Webmachine::ActionView.configure do |c|
         c.view_paths = paths
         c.handlers = handlers
+        c.default_layout = 'layouts/some_default'
       end
     end
 
@@ -16,5 +17,6 @@ describe Webmachine::ActionView::Configuration do
 
     its(:view_paths) { should eql(paths) }
     its(:handlers) { should eql(handlers) }
+    its(:default_layout) { should eql('layouts/some_default') }
   end
 end

data/spec/webmachine/actionview/resource_spec.rb

@@ -14,9 +14,10 @@ describe "A resource including Webmachine::ActionView::Resource" do
   let(:resource)                { HomeResource.new(request, response) }
   let(:unconventional_resource) { UnconventionalName.new(request, response) }
 
-  before :all do
+  before do
     Webmachine::ActionView.configure do |c|
       c.view_paths = ['spec/dummy/views']
+      c.default_layout = 'layouts/application'
     end
   end
 
@@ -66,6 +67,7 @@ describe "A resource including Webmachine::ActionView::Resource" do
 
     it { should include('content from the application layout')}
     it { should include('content from shared/some_partial')}
+    it { should include('local content')}
   end
 
   describe "Explicit template rendering" do

data/webmachine-actionview.gemspec

@@ -12,12 +12,9 @@ Gem::Specification.new do |gem|
   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.add_dependency "webmachine", '~> 1.0'
+  gem.add_dependency "activesupport", '~> 3.2'
+  gem.add_dependency "actionpack", '~> 3.2'
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmachine-actionview
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,63 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2152313240 !ruby/object:Gem::Requirement
+  name: webmachine
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  version_requirements: *2152313240
-- !ruby/object:Gem::Dependency
-  name: webmachine-test
-  requirement: &2152312620 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2152312620
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: webmachine
-  requirement: &2152311940 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2152311940
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2152311380 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2152311380
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2152310840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2152310840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Brings ActionView to webmachine-ruby
 email:
 - rgarner@zephyros-systems.co.uk
@@ -74,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Want the Rails conventions that you're used to for HTML views in webmachine-ruby?
@@ -129,3 +123,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/webmachine/actionview/configuration_spec.rb
 - spec/webmachine/actionview/resource_spec.rb
+has_rdoc: