stencils 0.0.0

data/Manifest

@@ -0,0 +1,7 @@
+lib/stencils/stencil.rb
+lib/stencils/stencil_context.rb
+lib/stencils.rb
+Rakefile
+README
+stencils.tmproj
+Manifest

data/README

@@ -0,0 +1,14 @@
+= stencils
+
+Rails gem that provides a way to reuse 'stencils' for common actions and views. 
+Stencils lets you define an action and views once and reuse them for different models.
+A Stencil might typically be used for generic CRUD operations.
+
+== Install
+
+gem install stencils
+
+== Usage
+
+...coming soon
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('stencils', '0.0.0') do |p|
+  p.description    = "Lets you define an action and views once and reuse them for different models."
+  p.project        = 'stencils'
+  p.url            = "http://rubyforge.org/projects/stencils"
+  p.author         = "Ryan Owens"
+  p.email          = "ryan@infoether.com"
+  p.ignore_pattern = ["tmp/*", "script/*", "stencils_notes.txt"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/stencils.rb

@@ -0,0 +1,8 @@
+require 'stencils/stencil'
+require 'stencils/stencil_context'
+
+#include into Rails when the gem is loaded
+class ActionController::Base
+  include Stencils::Stencil
+end
+

data/lib/stencils/stencil.rb

@@ -0,0 +1,59 @@
+module Stencils
+
+  module Stencil
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      def stencil(name, options={})
+        @stencil_name = name
+        @stencil_options = options
+        @stencil_options[:name] = name
+        @stencil_options[:view_dir] ||= "stencils/#{name}"
+
+        #define a method here like setup_rest_stencil for the before filter.
+        #make the include and attr_accessor conditional so it only happens once.
+        #do whatever else is necessary to alow multiple stencils. (use instance_var_set with :@rest_stencil_options)
+
+        include RestStencil
+        attr_accessor :stencil
+        helper_method :stencil
+        before_filter :stencil_filter
+        helper "#{name.to_s.camelize}StencilHelper".constantize
+      end
+
+      def stencil_options
+        @stencil_options
+      end
+
+    end
+
+    def stencil_filter
+      setup_stencil(self)
+    end
+
+    def setup_stencil(model_or_class_or_symbol)
+      @stencil ||= StencilContext.new(self.response.template, model_or_class_or_symbol, self.class.stencil_options)
+    end
+
+    def render_stencil(action=nil, options={})
+      action, options = nil, action if action.is_a? Hash
+      action ||= params[:action]
+      render(:template => stencil_template(action)) unless custom_stencil_template_exists?(action)
+    end
+
+    def stencil_template(action)
+      "stencils/#{stencil.stencil_name}/#{action}"
+    end
+
+    def custom_stencil_template_exists?(action=params[:action])
+      custom_template_path = File.join(RAILS_ROOT, 'app', 'views', "#{stencil.collection_name}", action.to_s)
+      File.exist?("#{custom_template_path}.html.erb") || File.exist?("#{custom_template_path}.erb")
+    end
+
+  end
+
+end

data/lib/stencils/stencil_context.rb

@@ -0,0 +1,331 @@
+module Stencils
+
+  class StencilContext
+  
+    attr_accessor :template
+    attr_accessor :base_name
+    attr_accessor :stencil_name, :stencil_view_dir
+  
+    def initialize(template, model_or_class_or_symbol, options={})
+      @template = template
+      @base_name = base_name_for(model_or_class_or_symbol)
+      @stencil_name = options.delete :name
+      @stencil_view_dir = options.delete :view_dir
+    end
+
+    def base_name_for(model_or_class_or_symbol)
+      full_base_name = if model_or_class_or_symbol.kind_of? Class
+        model_or_class_or_symbol.name
+      elsif model_or_class_or_symbol.kind_of? Symbol
+        model_or_class_or_symbol.to_s.camelize
+      # elsif model_or_class_or_symbol.respond_to?(:controller) 
+      elsif model_or_class_or_symbol.respond_to?(:controller) 
+        model_or_class_or_symbol.controller.class.name
+      else
+        model_or_class_or_symbol.class.name
+      end
+      name = full_base_name.chomp('Test').chomp('Controller')
+      index = name.rindex(':')
+      index = index ? index+1 : 0
+      name[index,name.size]
+    end
+  
+    def collection_class_name
+      #this singularize/pluralize chain lets you provide eg people/person and get people back, as opposed to peoples.
+      base_name.singularize.pluralize
+    end
+
+    def collection_name_base
+      collection_class_name.underscore.downcase
+    end
+
+    def collection_name
+      name = collection_name_base
+      name = "#{name}_collection" if uncountable? name
+      name
+    end
+
+    def collection_label
+      collection_name.titleize
+    end
+
+    def collection_symbol
+      collection_name.intern
+    end
+  
+    def partial(name)
+      "#{collection_name}/#{name}"
+    end
+
+    def collection_partial
+      partial 'list_item'
+    end
+
+    def render_collection_partial(model)
+      template.render :partial => collection_partial, :locals => {model_symbol => model}
+    end
+
+    def render_collection
+      html = []
+      collection.each do |model|
+        html << render_collection_partial(model)
+      end
+      html.join
+    end
+
+    def model_partial
+      # partial model_name
+      partial 'model'
+    end
+
+    def render_model
+      template.render :partial => model_partial, :locals => {model_symbol => model}
+    end
+
+    def form_partial
+      partial 'form'
+    end
+
+    def render_form(form)
+      template.render :partial => form_partial, :locals => {:form => form, model_symbol => model}
+    end
+
+    def model_class_name
+      collection_class_name.singularize
+    end
+
+    def model_name
+      model_class_name.underscore.downcase
+    end
+
+    def model_label
+      model_class_name.titleize
+    end
+  
+    def new_or_old_label(new_label, old_label)
+      new_record? ? new_label : old_label
+    end
+  
+    def new_or_edit_label(new_label="Add New #{model_label}", edit_label="Edit #{model_label}")
+      new_or_old_label new_label, edit_label
+    end
+
+    def model_instance_variable_name
+      "@#{model_name}"
+    end
+
+    def collection_instance_variable_name
+      "@#{collection_name}"
+    end
+
+    def collection_route
+      route = collection_name_base
+      route = "#{route}_index" if uncountable? route
+      route
+    end
+
+    def collection_url(options=nil)
+      args = adjust_hash_arg_to_last options
+      args.pop if args.last && args.last.empty?
+      args.delete_if {|arg| arg == nil || arg.kind_of?(ActiveRecord::Base)}
+      template.send "#{collection_route}_url", *args
+    end
+
+    def collection_path(options=nil)
+      args = adjust_hash_arg_to_last options
+      args.pop if args.last && args.last.empty?
+      args.delete_if {|arg| arg == nil || arg.kind_of?(ActiveRecord::Base)}
+      template.send "#{collection_route}_path", *args
+    end
+  
+    def link_to_collection(options=nil)
+      template.link_to(collection_label, collection_path(options))
+    end
+
+    def show_route
+      "#{get_path_prefix}#{model_name}"
+    end
+
+    def show_path(model=self.model, options=nil)
+    
+      args = adjust_hash_arg_to_last model, options
+      args.pop if args.last && args.last.empty?
+      args.delete_if {|arg| arg == nil}
+
+      puts "***show_path: "
+      puts "***model: #{model.inspect}"
+      puts "***args: #{args.inspect}"
+
+      template.send "#{show_route}_path", *args
+    end
+
+    def show_url(model=self.model, options=nil)
+      args = adjust_hash_arg_to_last model, options
+      args.pop if args.last && args.last.empty?
+      args.delete_if {|arg| arg == nil}
+      template.send "#{show_route}_url", *args
+    end
+
+    def edit_route
+      "edit_#{get_path_prefix}#{model_name}"
+    end
+
+    def edit_path(model=self.model, options=nil)
+      args = adjust_hash_arg_to_last model, options
+      args.pop if args.last && args.last.empty?
+      args.delete_if {|arg| arg == nil}
+      template.send "#{edit_route}_path", *args
+    end
+
+    def edit_path_url(model=self.model, options=nil)
+      args = adjust_hash_arg_to_last model, options
+      args.pop if args.last && args.last.empty?
+      args.delete_if {|arg| arg == nil}
+      template.send "#{edit_route}_url", *args
+    end
+
+    def new_route
+      "new_#{get_path_prefix}#{model_name}"
+    end
+
+    def new_path(options=nil)
+      route = "#{new_route}_path"
+      if options.blank? 
+        template.send route
+      else
+        template.send route, options
+      end
+    end
+
+    def new_path_url(options=nil)
+      route = "#{new_route}_url"
+      if options.blank? 
+        template.send route
+      else
+        template.send route, options
+      end
+    end
+
+    def get_path_prefix
+      path_prefix ? "#{path_prefix}_" : nil
+    end
+
+    def path_prefix
+      nil
+    end
+
+    def collection
+      instance_variable_get collection_instance_variable_name
+    end
+
+    def collection=(collection)
+      instance_variable_set collection_instance_variable_name, collection
+    end
+    alias_method :set_collection, :collection=
+
+    def model
+      instance_variable_get model_instance_variable_name
+    end
+
+    def model=(model)
+      puts "***model= : #{model_instance_variable_name}"
+      instance_variable_set model_instance_variable_name, model
+    end
+    alias_method :set_model, :model=
+
+    def model_class
+      Kernel.const_get(model_class_name)
+    end
+
+    def fixture_model(name=nil)
+      template.send collection_name_base, name
+    end
+
+    def model_symbol
+      model_name.intern
+    end
+
+    def adjust_hash_arg_to_last(*args)
+      hash_arg = nil
+      args.each_with_index do |arg,index|
+        if arg.kind_of? Hash
+          hash_arg = arg
+        end
+        if hash_arg 
+          if index == args.size-1
+            args[index] = hash_arg 
+          else
+            args[index] = nil 
+          end
+        end
+      end
+      args
+    end
+
+    ##UTILS MOVED THESE OUT OF RestControllerExtension so they could be used separately
+
+    def find_model_with_param_id
+      model_id = "#{model_name}_id"
+      param = params[model_id] || params[:id]
+      self.set_model model_class.find(param)
+    end
+
+    def new_model
+      self.set_model model_class.new
+    end
+
+    def new_model_with_params
+      self.set_model model_class.new(model_params)
+    end
+
+    def create_model_with_params
+      self.set_model model_class.create(model_params)
+    end
+
+    def update_model_with_params
+      find_model_with_param_id
+      self.model.update_attributes(model_params)
+    end
+
+    def init_model_with_params
+      find_model_with_param_id
+      self.model.attributes = model_params
+    end
+
+    def destroy_model_with_param_id
+      find_model_with_param_id.destroy
+    end
+
+    def save_model
+      self.model.save
+    end
+
+    def new_record?
+      model.new_record?
+    end
+
+    def model_params
+      params[model_symbol]
+    end
+
+    def params
+      template.params
+    end
+
+    def instance_variable_set(name, value)
+      super
+      template.instance_variable_set name, value
+      template.controller.instance_variable_set name, value
+    end
+
+    def instance_variable_get(name)
+      super || template.instance_variable_get(name) || template.controller.instance_variable_get(name)
+    end
+
+    def uncountable?(name)
+      ActiveSupport::Inflector.inflections.uncountables.include? name
+    end
+
+  end
+
+end

data/stencils.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stencils}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Owens"]
+  s.date = %q{2009-07-24}
+  s.description = %q{Lets you define an action and views once and reuse them for different models.}
+  s.email = %q{ryan@infoether.com}
+  s.extra_rdoc_files = ["lib/stencils/stencil.rb", "lib/stencils/stencil_context.rb", "lib/stencils.rb", "README"]
+  s.files = ["lib/stencils/stencil.rb", "lib/stencils/stencil_context.rb", "lib/stencils.rb", "Rakefile", "README", "stencils.tmproj", "Manifest", "stencils.gemspec"]
+  s.homepage = %q{http://rubyforge.org/projects/stencils}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Stencils", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{stencils}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Lets you define an action and views once and reuse them for different models.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/stencils.tmproj

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>stencils</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\coverage|\.svn|\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>370</integer>
+	<key>metaData</key>
+	<dict/>
+	<key>showFileHierarchyDrawer</key>
+	<false/>
+	<key>showFileHierarchyPanel</key>
+	<true/>
+	<key>treeState</key>
+	<dict>
+		<key>stencils</key>
+		<dict>
+			<key>isExpanded</key>
+			<true/>
+			<key>subItems</key>
+			<dict/>
+		</dict>
+	</dict>
+	<key>windowFrame</key>
+	<string>{{0, 64}, {1680, 964}}</string>
+</dict>
+</plist>

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: stencils
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ryan Owens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-24 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Lets you define an action and views once and reuse them for different models.
+email: ryan@infoether.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/stencils/stencil.rb
+- lib/stencils/stencil_context.rb
+- lib/stencils.rb
+- README
+files: 
+- lib/stencils/stencil.rb
+- lib/stencils/stencil_context.rb
+- lib/stencils.rb
+- Rakefile
+- README
+- stencils.tmproj
+- Manifest
+- stencils.gemspec
+has_rdoc: true
+homepage: http://rubyforge.org/projects/stencils
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Stencils
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: stencils
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Lets you define an action and views once and reuse them for different models.
+test_files: []
+