easy_partials 0.0.1 → 0.1.0

data/.gitignore

@@ -19,3 +19,8 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+*~
+#*#
+log/*
+tmp/*
+pkg/*

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Samer Abukhait
+Copyright (c) 2010 On-Site Manager (on-site.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,49 @@
 = easy_partials
 
-Description goes here.
+EasyPartials are a way to make partials in Rails even easier!  This is
+an expansion of a blog post by Mike Stone at
+"http://smellsblue.blogspot.com/2009/11/easy-partials-in-rails.html".
+
+== FEATURES:
+
+* Allows easy partial invocation syntax, with simpler local variable passing
+* Allows configurable shared directories for partials
+
+== SYNOPSIS:
+
+<% _my_partial :var => "123" do %>
+  <p>
+    Some block content.
+  </p>
+<% end %>
+
+The above would render a partial (as with <%= render :partial =>
+"my_partial" %>), with the local variable "var" set to "123", and the
+local variable "body" set to the paragraph "some block content", HTML
+tags included.
+
+Note that you need to use <% rather than <%=.
+
+For a shared partial, use a line like the following in environment.rb
+or in a file under initializers:
+
+  Easypartials.shared_directories = ["mydir1", "mydir2"]
+
+This will set up app/views/mydir1 and app/views/mydir2 as the
+locations to look for partials when a directory isn't explicitly
+given.
+
+This plugin will first check the directory of the view being rendered,
+then check the shared directories in the order given.
+
+== REQUIREMENTS:
+
+You'll need a recent-ish version of Rails.  You'll also need hoe and
+newgem, but you get them automatically when you install easypartials.
+
+== INSTALL:
+
+sudo gem install easy_partials
 
 == Note on Patches/Pull Requests
  
@@ -11,7 +54,3 @@ Description goes here.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Samer Abukhait. See LICENSE for details.

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "easy_partials"
     gem.summary = %Q{Easy Partials}
-    gem.description = %Q{Helper to call partials in an easier way}
+    gem.description = %Q{An easier way to call partials}
     gem.email = "abukhait@gmail.com"
     gem.homepage = "http://github.com/on-site/Easy-Partials"
     gem.authors = ["Samer Abukhait"]

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/easy_partials.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_partials}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Samer Abukhait"]
+  s.date = %q{2010-07-16}
+  s.description = %q{An easier way to call partials}
+  s.email = %q{abukhait@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "easy_partials.gemspec",
+     "lib/easy_partials.rb",
+     "spec/easy_partials_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/on-site/Easy-Partials}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{easy_partials}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easy Partials}
+  s.test_files = [
+    "spec/easy_partials_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/easy_partials.rb

@@ -0,0 +1,163 @@
+class Object
+  # Obtain the metaclass of this object instance.
+  def metaclass
+    class << self
+      self
+    end
+  end
+
+  # Define an instance method using a symbol for the method name and a
+  # block for the method contents.  This makes it so a closure can be
+  # used to define a singleton method.
+  def meta_def(name, &block)
+    metaclass.send :define_method, name, &block
+  end
+
+  # Define an instance method using a block that will accept a block
+  # as the first parameter, and the rest of the arguments as the
+  # second.  This requires the block to have the first parameter act
+  # as the block.
+  #
+  # For example:
+  # o.meta_def_with_block(:say_hi) { |block, name|
+  #   block.call
+  #   puts "hello #{name}!"
+  # }
+  #
+  # Will create a method that can be invoked as such:
+  # o.say_hi("Mike") { puts "Saying hi:" }
+  #
+  # Implicitly, 2 methods are created... __real__say_hi, which is
+  # created using the given block, and say_hi, which will accept the
+  # arguments and block and pass them to __real__say_hi in reverse
+  # order.
+  def meta_def_with_block(name, &block)
+    meta_def "__real__#{name}".to_sym, &block
+    metaclass.instance_eval "
+      def #{name}(*args, &block)
+        __real__#{name} block, *args
+      end
+    "
+  end
+end
+
+module EasyPartials
+  def self.shared_directories
+    @ep_shared_directories || ["shared"]
+  end
+
+  def self.shared_directories=(arglist)
+    @ep_shared_directories = arglist
+  end
+end
+
+module ApplicationHelper
+
+  METHOD_REGEXP = /^_/
+
+  alias_method :original_respond_to?, :respond_to?
+
+  def respond_to?(method_name, inc_priv = false)
+    return true if method_name =~ METHOD_REGEXP
+
+    original_respond_to?(method_name, inc_priv)
+  end
+
+  alias_method :original_method_missing, :method_missing
+
+  def method_missing(method_name, *args, &block)
+    method_str = method_name.to_s
+
+    if method_str.sub! METHOD_REGEXP, ''
+      locations = [method_str]
+      locations.push *additional_partials(method_str)
+      new_method = partial_method locations, *args, &block
+      meta_def_with_block method_name, &new_method
+    else
+      original_method_missing method_name, *args, &block
+    end
+  end
+
+  def additional_partials(partial_name)
+    @additional_partials ||= EasyPartials.shared_directories
+    @additional_partials.map { |location| "#{location}/#{partial_name}" }
+  end
+
+  # Utility method to create and invoke a Proc which will concat the
+  # partial given the possible locations.  The Proc is then returned
+  # so it can be added as a new method for caching purposes (otherwise
+  # method_missing will have to be invoked each time the partial is
+  # invoked).  The locations parameter is modified in the process.
+  # This is used by method_missing.
+  def partial_method(locations, *args, &block)
+    raise "No possible locations!" if locations.empty?
+    partial_name = locations.delete_at 0
+    new_method = lambda do |block, *args|
+      if params[:format] == "pdf"
+        invoke_partial partial_name, *args, &block
+      else
+        concat_partial partial_name, *args, &block
+      end
+    end
+    begin
+      new_method.call block, *args
+    rescue ActionView::MissingTemplate
+      if locations.empty?
+        raise
+      else
+        new_method = partial_method locations, *args, &block
+      end
+    end
+
+    new_method
+  end
+
+  def invoke_partial(partial, *args, &block)
+    locals = {}
+
+    if args.length == 1 && args[0].is_a?(Hash)
+      locals.merge! args[0]
+    else
+      locals.merge! :args => args
+    end
+
+    locals.merge! :body => capture(&block) if block
+    locals[:body] = nil unless locals[:body]
+
+    if locals.has_key? :collection
+      return "" if locals[:collection].blank?
+      render :partial => partial.to_s, :collection => locals[:collection],
+             :locals => locals.except(:collection)
+    else
+      render :partial => partial.to_s, :locals => locals
+    end
+
+  end
+
+  # Used to create nice templated "tags" while keeping the html out of
+  # our helpers.  Additionally, this can be invoked implicitly by
+  # invoking the partial as a method with "_" prepended to the name.
+  #
+  # Invoking the method:
+  #
+  #   <% concat_partial "my_partial", { :var => "value" } do %>
+  #     <strong>Contents stored as a "body" local</strong>
+  #   <% end %>
+  #
+  # Or invoking implicitly:
+  #
+  #   <% _my_partial :var => "value" do %>
+  #     <strong>Contents stored as a "body" local</strong>
+  #   <% end %>
+  #
+  # Note that with the implicit partials the partial will first be
+  # searched for locally within the current view directory, and then
+  # additional directories defined by the controller level
+  # 'additional_partials' method, and finally within the views/shared
+  # directory.
+  def concat_partial(partial, *args, &block)
+    rendered = invoke_partial partial, *args, &block
+    concat rendered
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: easy_partials
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Samer Abukhait
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 -07:00
+date: 2010-07-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
-description: Helper to call partials in an easier way
+description: An easier way to call partials
 email: abukhait@gmail.com
 executables: []
 
@@ -43,13 +43,16 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
+- TODO
 files: 
 - .document
 - .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
+- TODO
 - VERSION
+- easy_partials.gemspec
 - lib/easy_partials.rb
 - spec/easy_partials_spec.rb
 - spec/spec.opts