thorero-parts 0.9.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+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

@@ -0,0 +1,4 @@
+merb-parts
+==========
+
+A plugin for the Merb framework that provides ...

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require "extlib"
+require 'merb-core/tasks/merb_rake_helper'
+require "spec/rake/spectask"
+
+##############################################################################
+# Package && release
+##############################################################################
+RUBY_FORGE_PROJECT  = "thorero"
+PROJECT_URL         = "http://merbivore.com"
+PROJECT_SUMMARY     = "Merb More: Merb plugin that provides Part Controllers."
+PROJECT_DESCRIPTION = PROJECT_SUMMARY
+
+GEM_AUTHOR = "Daniel Neighman"
+GEM_EMAIL  = "has.sox@gmail.com"
+
+GEM_NAME    = "thorero-parts"
+PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.4") + PKG_BUILD
+
+RELEASE_NAME    = "REL #{GEM_VERSION}"
+
+require "extlib/tasks/release"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = PROJECT_SUMMARY
+  s.description = PROJECT_DESCRIPTION
+  s.author = GEM_AUTHOR
+  s.email = GEM_EMAIL
+  s.homepage = PROJECT_URL
+  s.add_dependency('merb-core', '>= 0.9.4')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,merb_generators}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install => [:package] do
+  sh %{#{sudo} gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new("specs") do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb-parts.rb
+Add your Merb rake tasks to lib/merb-parts/merbtasks.rb

data/lib/merb-parts.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), "merb-parts", "part_controller")
+require File.join(File.dirname(__FILE__), "merb-parts", "mixins", "parts_mixin")
+
+Merb::Controller.send(:include, Merb::PartsMixin)

data/lib/merb-parts/merbtasks.rb

@@ -0,0 +1,6 @@
+namespace :merb-parts do
+  desc "Do something for merb-parts"
+  task :default do
+    puts "merb-parts doesn't do anything"
+  end
+end

data/lib/merb-parts/mixins/parts_mixin.rb

@@ -0,0 +1,42 @@
+module Merb
+  module PartsMixin
+    
+    # Dispatches a PartController.
+    # ==== Parameters
+    # opts<Hash>:: A Hash of Options. (see below)
+    #
+    # ==== Options
+    # An option hash has two parts.
+    # 1. keys that are Merb::PartControllers with values that are action names (as symbols)
+    # 2. key value pairs that will become available in the PartController as params merged
+    #    with the web controllers params
+    #
+    # ==== Example
+    #  Calling a part controller
+    #  {{{
+    #    part TodoPart => :list
+    #   }}}
+    #
+    #  Calling a part with additional options
+    #  {{{
+    #    part TodoPart => :list, :limit => 20, :user => current_user 
+    #  }}}
+    #
+    # ==== Returns
+    #   Returns the result of the PartControllers action, which is a string.
+    def part(opts = {})
+      # Extract any params out that may have been specified
+      klasses, opts = opts.partition do |k,v| 
+        k.respond_to?(:ancestors) && k.ancestors.include?(Merb::PartController)
+      end       
+        
+      opts = Hash[*(opts.flatten)]
+      
+      res = klasses.inject([]) do |memo,(klass,action)|
+        memo << klass.new(self, opts)._dispatch(action)
+      end
+      res.size == 1 ? res[0] : res
+    end
+    
+  end
+end

data/lib/merb-parts/mixins/web_controller.rb

@@ -0,0 +1,67 @@
+# Includes files into the class to allow it to minimally delegates to a web controller
+module Merb
+  module Mixins
+    module WebController
+      
+      def self.included(base)
+        [:content_type, :web_controller].each do |attr|
+          base.send(:attr_accessor, attr)
+        end
+        base.send(:include, InstanceMethods)
+        base.send(:extend, ClassMethods)
+      end
+      
+      module InstanceMethods
+        def request
+           @web_controller.request  
+        end
+
+        def cookies
+          @web_controller.cookies
+        end  
+
+        def headers
+          @web_controller.headers
+        end
+
+        def session
+          @web_controller.session
+        end
+
+        def response
+          @web_controller.response
+        end    
+
+        def route
+          request.route
+        end
+
+        def url(name, rparams={})
+          Merb::Router.generate(name, rparams,
+            { :controller => @web_controller.controller_name,
+              :action => @web_controller.action_name,
+              :format => params[:format]
+            }
+          )
+        end
+        
+        private 
+        # This method is here to overwrite the one in the general_controller mixin
+        # The method ensures that when a url is generated with a hash, it contains a controller
+        def get_controller_for_url_generation(opts)
+           controller = opts[:controller] || @web_controller.params[:controller]
+           raise "No Controller Specified for url()" unless controller
+           controller
+        end
+        
+      end
+      
+      module ClassMethods
+        
+      end
+      
+      
+      
+    end # WebController
+  end # Mixins
+end # Merb

data/lib/merb-parts/part_controller.rb

@@ -0,0 +1,94 @@
+require File.join(File.dirname(__FILE__), "mixins", "web_controller")
+module Merb
+
+  # A Merb::PartController is a light weight way to share logic and templates
+  # amongst controllers.
+  # Merb::PartControllers work just like Merb::controller.
+  # There is a filter stack, layouts (if needed) all the render functions,
+  # and url generation.
+  #
+  # Cookies, params, and even the request object are shared with the web controller
+  class PartController < AbstractController
+    include Merb::Mixins::WebController
+
+    attr_reader :params
+
+    cattr_accessor :_subclasses
+    self._subclasses = Set.new
+
+    # ==== Returns
+    # Array[Class]:: Classes that inherit from Merb::PartController.
+    def self.subclasses_list() _subclasses end
+
+    # ==== Parameters
+    # action<~to_s>:: The name of the action that will be rendered.
+    # type<~to_s>::
+    #    The mime-type of the template that will be rendered. Defaults to html.
+    # controller<~to_s>::
+    #   The name of the controller that will be rendered. Defaults to
+    #   controller_name.
+    #
+    # ==== Returns
+    # String:: The template location, i.e. ":controller/:action.:type".
+    def _template_location(action, type = :html, controller = controller_name)
+      "#{controller}/#{action}.#{type}"
+    end
+    
+    # The location to look for a template and mime-type. This is overridden 
+    # from AbstractController, which defines a version of this that does not 
+    # involve mime-types.
+    #
+    # ==== Parameters
+    # template<String>:: 
+    #    The absolute path to a template - without mime and template extension.
+    #    The mime-type extension is optional - it will be appended from the 
+    #    current content type if it hasn't been added already.
+    # type<~to_s>::
+    #    The mime-type of the template that will be rendered. Defaults to nil.
+    #
+    # @public
+    def _absolute_template_location(template, type)
+      template.match(/\.#{type.to_s.escape_regexp}$/) ? template : "#{template}.#{type}"
+    end
+
+    # Sets the template root to the default parts view directory.
+    #
+    # ==== Parameters
+    # klass<Class>::
+    #   The Merb::PartController inheriting from the base class.
+    def self.inherited(klass)
+      _subclasses << klass.to_s
+      super
+      klass._template_root = Merb.dir_for(:part) / "views" unless self._template_root
+    end
+
+    # ==== Parameters
+    # web_controller<Merb::Controller>:: The controller calling this part.
+    # opts<Hash>:: Additional options for this part.
+    def initialize(web_controller, opts = {})
+      @web_controller = web_controller
+      @params = @web_controller.params.dup
+      @params.merge!(opts) unless opts.empty?
+      super
+      @content_type = @web_controller.content_type
+    end
+
+    # ==== Parameters
+    # action<~to_s>:: An action to dispatch to. Defaults to :to_s.
+    #
+    # ==== Returns
+    # String:: The part body.
+    def _dispatch(action=:to_s)
+      self.action_name = action
+      super(action)
+      @body
+    end
+
+    # Send any methods that are missing back up to the web controller
+    # Patched to set partial locals on the web controller
+    def method_missing(sym, *args, &blk)
+      @web_controller.instance_variable_set(:@_merb_partial_locals, @_merb_partial_locals)
+      @web_controller.send(sym, *args, &blk)
+    end
+  end
+end

data/spec/fixtures/controllers/main.rb

@@ -0,0 +1,33 @@
+class Main < Merb::Controller
+  self._template_root = File.dirname(__FILE__) / ".." / "views"
+  
+  def index
+    part TodoPart => :list
+  end
+  
+  def index2
+    part TodoPart => :one    
+  end
+  
+  def index3
+    part(TodoPart => :one) + part(TodoPart => :list)
+  end
+  
+  def index4
+    provides :xml, :js
+    part(TodoPart => :formatted_output)
+  end
+  
+  def part_with_params
+    part(TodoPart => :part_with_params, :my_param => "my_value")
+  end
+  
+  def part_within_view
+    render
+  end
+  
+  def parth_with_absolute_template
+    part(TodoPart => :parth_with_absolute_template)
+  end
+  
+end

data/spec/fixtures/parts/done_part.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) / 'todo_part'
+
+class DonePart < TodoPart
+end

data/spec/fixtures/parts/todo_part.rb

@@ -0,0 +1,30 @@
+class TodoPart < Merb::PartController
+  self._template_root = File.expand_path(File.join(File.dirname(__FILE__), "views"))
+  
+  before :load_todos
+  
+  def list
+    render
+  end
+  
+  def one
+    render :list, :layout => false
+  end
+  
+  def load_todos
+    @todos = ["Do this", "Do that", 'Do the other thing']
+  end
+  
+  def formatted_output
+    render
+  end
+  
+  def part_with_params
+    render
+  end
+  
+  def parth_with_absolute_template
+    render :template => File.expand_path(self._template_root) / 'todo_part' / 'formatted_output'
+  end
+  
+end

data/spec/fixtures/parts/views/layout/todo_part.html.erb

@@ -0,0 +1,3 @@
+TODOLAYOUT
+<%= catch_content :for_layout %>
+TODOLAYOUT

data/spec/fixtures/parts/views/layout/todo_part.xml.erb

@@ -0,0 +1,3 @@
+<todolayout>
+<%= catch_content :for_layout %>
+</todolayout>

data/spec/fixtures/parts/views/todo_part/formatted_output.html.erb

@@ -0,0 +1 @@
+part_html_format

data/spec/fixtures/parts/views/todo_part/formatted_output.js.erb

@@ -0,0 +1 @@
+part_js_format

data/spec/fixtures/parts/views/todo_part/formatted_output.xml.erb

@@ -0,0 +1 @@
+part_xml_format

data/spec/fixtures/parts/views/todo_part/list.html.erb

@@ -0,0 +1,3 @@
+TODOPART
+<%= @todos.join('|') %>
+TODOPART

data/spec/fixtures/parts/views/todo_part/part_with_params.html.erb

@@ -0,0 +1,3 @@
+<% params.each do |param, value| %>
+  <%= param %> = <%= value %>
+<% end %>

data/spec/fixtures/views/main/part_within_view.html.erb

@@ -0,0 +1 @@
+<%= part TodoPart => :one %>

data/spec/merb-parts_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "A Merb PartController" do
+  
+  before(:each) do
+    Merb::Router.prepare do |r|
+      r.default_routes
+    end
+  end  
+  
+  it "should render a part template with no layout" do
+    controller = dispatch_to(Main, :index2)
+    controller.body.should ==
+      "TODOPART\nDo this|Do that|Do the other thing\nTODOPART"
+  end
+  
+  it "should render a part template with it's own layout" do
+    controller = dispatch_to(Main, :index)
+    controller.body.should ==
+      "TODOLAYOUT\nTODOPART\nDo this|Do that|Do the other thing\nTODOPART\nTODOLAYOUT"
+  end 
+  
+  it "should render multiple parts if more then one part is passed in" do
+    controller = dispatch_to(Main, :index3)
+    controller.body.should ==
+      "TODOPART\nDo this|Do that|Do the other thing\nTODOPART" +
+      "TODOLAYOUT\nTODOPART\nDo this|Do that|Do the other thing\nTODOPART\nTODOLAYOUT"
+  end 
+  
+  it "should render the html format by default to the controller that set it" do
+    controller = dispatch_to(Main, :index4)
+    controller.body.should match(/part_html_format/m)
+  end
+  
+  it "should render the xml format according to the controller" do
+    controller = dispatch_to(Main, :index4, {:format => 'xml'} )
+    controller.body.should match(/part_xml_format/m)
+  end
+  
+  it "should render the js format according to the controller" do
+    controller = dispatch_to(Main, :index4, :format => 'js')
+    controller.body.should match(/part_js_format/m)
+  end
+  
+  it "should provide params when calling a part" do
+    controller = dispatch_to(Main, :part_with_params)
+    controller.body.should match( /my_param = my_value/)
+  end
+  
+  it "should render from inside a view" do
+    controller = dispatch_to(Main, :part_within_view)
+    controller.body.should match( /Do this/)
+  end
+  
+  it "should render a template from an absolute path" do
+    controller = dispatch_to(Main, :parth_with_absolute_template)
+    controller.body.should match(/part_html_format/m)
+  end
+  
+end  
+
+describe "A Merb Part Controller with urls" do
+   
+  def new_url_controller(route, params = {:action => 'show', :controller => 'Test'})    
+    @controller = dispatch_to(Main, :index)
+    TodoPart.new(@controller)
+  end
+  
+  it "should use the web_controllers type if no controller is specified" do
+    c = new_url_controller(@default_route, :controller => "my_controller")
+    the_url = c.url(:action => "bar")
+    the_url.should == "/main/bar"
+  end
+
+end
+
+describe "A Merb Part Controller inheriting from another Part Controller" do
+  
+  it "should inherit the _template_root" do
+    TodoPart._template_root.should == File.expand_path(File.dirname(__FILE__) / 'fixtures' / 'parts' / 'views')
+    TodoPart._template_root.should == DonePart._template_root
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require "merb-core"
+require File.join( File.dirname(__FILE__), "..", "lib", "merb-parts" )
+
+# Require the fixtures
+Dir[File.join(File.dirname(__FILE__), "fixtures", "*/**.rb")].each{|f| require f }
+
+Merb.start :environment => 'test'
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::RequestHelper  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: thorero-parts
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-02 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+description: "Merb More: Merb plugin that provides Part Controllers."
+email: has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb-parts
+- lib/merb-parts/merbtasks.rb
+- lib/merb-parts/mixins
+- lib/merb-parts/mixins/parts_mixin.rb
+- lib/merb-parts/mixins/web_controller.rb
+- lib/merb-parts/part_controller.rb
+- lib/merb-parts.rb
+- spec/fixtures
+- spec/fixtures/controllers
+- spec/fixtures/controllers/main.rb
+- spec/fixtures/parts
+- spec/fixtures/parts/done_part.rb
+- spec/fixtures/parts/todo_part.rb
+- spec/fixtures/parts/views
+- spec/fixtures/parts/views/layout
+- spec/fixtures/parts/views/layout/todo_part.html.erb
+- spec/fixtures/parts/views/layout/todo_part.xml.erb
+- spec/fixtures/parts/views/todo_part
+- spec/fixtures/parts/views/todo_part/formatted_output.html.erb
+- spec/fixtures/parts/views/todo_part/formatted_output.js.erb
+- spec/fixtures/parts/views/todo_part/formatted_output.xml.erb
+- spec/fixtures/parts/views/todo_part/list.html.erb
+- spec/fixtures/parts/views/todo_part/part_with_params.html.erb
+- spec/fixtures/views
+- spec/fixtures/views/main
+- spec/fixtures/views/main/part_within_view.html.erb
+- spec/merb-parts_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://merbivore.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thorero
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "Merb More: Merb plugin that provides Part Controllers."
+test_files: []
+