elkinsware-erubis_rails_helper 0.2.0

data/README.rdoc

@@ -0,0 +1,59 @@
+= erubis_rails_helper
+
+* http://github.com/elkinsware/erubis_rails_helper/tree/master
+
+== DESCRIPTION:
+
+This is a fix for Erubis integration with Rails 2.3.  It is a drop in replacement for the rails helper in the Erubis gem.
+The fix is minor and I am submitting it to Erubis but until it is fixed this will work.
+
+== FEATURES/PROBLEMS:
+
+* Drop in replacement for the Erubis Rails Helper in the Erubis gem.
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+  inside config/environment.rb and the following
+     config.gem 'erubis' , :version => '2.6.4'
+     config.gem 'erubis_rails_helper'
+     
+  add config/initializers/erubis_config.rb
+     #Erubis::Helpers::RailsHelper.engine_class = Erubis::Eruby # or Erubis::FastEruby
+     #Erubis::Helpers::RailsHelper.init_properties = {}
+     Erubis::Helpers::RailsHelper.show_src = false
+     Erubis::Helpers::RailsHelper.preprocessing = true  
+     
+== REQUIREMENTS:
+
+* Rails 2.3
+* Erubis 2.6.4
+
+== INSTALL:
+
+* sudo gem install elkinsware-erubis_rails_helper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Dave Elkins (elkinsware)
+
+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/lib/erubis_rails_helper.rb

@@ -0,0 +1,373 @@
+begin
+  require 'action_controller'
+  require 'action_view'
+rescue LoadError
+  $stderr.puts %[This erubis_rails requires actionpack 2.2.2 or higher]
+end
+
+begin
+  require 'erubis'
+  require 'erubis/preprocessing'
+rescue LoadError
+  $stderr.puts %[This erubis_rails requires erubis 2.6.4\n
+                 Add "config.gem 'erubis', :version => 2.6.4" to config/environment.rb]
+end  
+
+module Erubis
+  module OutputBufferEnhancer
+
+    def self.desc   # :nodoc:
+      "set '@output_buffer = _buf = \"\";'"
+    end
+
+    def add_preamble(src)
+      src << "__in_erubis_template=true; @output_buffer = _buf = '';"
+    end
+
+  end
+  
+  class Eruby
+    #include ErboutEnhancer      # will generate '_erbout = _buf = ""; '
+    include OutputBufferEnhancer
+  end
+
+  class FastEruby
+    #include ErboutEnhancer      # will generate '_erbout = _buf = ""; '
+    include OutputBufferEnhancer 
+  end
+
+  module Helpers
+
+    ##
+    ## helper module for Ruby on Rails
+    ##
+    ## howto:
+    ##
+    ## 1. add the folliwng code in your 'config/environment.rb'
+    ##
+    ##      require 'erubis/helpers/rails_helper'
+    ##      #Erubis::Helpers::RailsHelper.engine_class = Erubis::Eruby # or Erubis::FastEruby
+    ##      #Erubis::Helpers::RailsHelper.init_properties = {}
+    ##      #Erubis::Helpers::RailsHelper.show_src = false       # set true for debugging
+    ##      #Erubis::Helpers::RailsHelper.preprocessing = true   # set true to enable preprocessing
+    ##
+    ## 2. restart web server.
+    ##
+    ## if Erubis::Helper::Rails.show_src is true, Erubis prints converted Ruby code
+    ## into log file ('log/development.log' or so). if false, it doesn't.
+    ## if nil, Erubis prints converted Ruby code if ENV['RAILS_ENV'] == 'development'.
+    ##
+    module RailsHelper
+
+      #cattr_accessor :init_properties
+      @@engine_class = ::Erubis::Eruby
+      #@@engine_class = ::Erubis::FastEruby
+      def self.engine_class
+        @@engine_class
+      end
+      def self.engine_class=(klass)
+        @@engine_class = klass
+      end
+
+      #cattr_accessor :init_properties
+      @@init_properties = {}
+      def self.init_properties
+        @@init_properties
+      end
+      def self.init_properties=(hash)
+        @@init_properties = hash
+      end
+
+      #cattr_accessor :show_src
+      @@show_src = nil
+      def self.show_src
+        @@show_src
+      end
+      def self.show_src=(flag)
+        @@show_src = flag
+      end
+
+      #cattr_accessor :preprocessing
+      @@preprocessing = false
+      def self.preprocessing
+        @@preprocessing
+      end
+      def self.preprocessing=(flag)
+        @@preprocessing = flag
+      end
+
+
+      ## define class for backward-compatibility
+      class PreprocessingEruby < Erubis::PreprocessingEruby   # :nodoc:
+      end
+
+
+      module TemplateConverter
+        ## covert eRuby string into ruby code
+        def _convert_template(template)    # :nodoc:
+          #src = ::Erubis::Eruby.new(template).src
+          klass      = ::Erubis::Helpers::RailsHelper.engine_class
+          properties = ::Erubis::Helpers::RailsHelper.init_properties
+          show_src   = ::Erubis::Helpers::RailsHelper.show_src
+          show_src = ENV['RAILS_ENV'] == 'development' if show_src.nil?
+          ## preprocessing
+          if ::Erubis::Helpers::RailsHelper.preprocessing
+            preprocessor = _create_preprocessor(template)
+            template = preprocessor.evaluate(_preprocessing_context_object())
+            _logger_info "** Erubis: preprocessed==<<'END'\n#{template}END\n" if show_src
+          end
+          ## convert into ruby code
+          src = klass.new(template, properties).src
+          #src.insert(0, '_erbout = ')
+          _logger_info "** Erubis: src==<<'END'\n#{src}END\n" if show_src
+          return src
+        end
+        def _create_preprocessor(template)
+          return PreprocessingEruby.new(template, :escape=>true)
+        end
+        def _preprocessing_context_object
+          return self
+        end
+        def _logger_info(message)
+          logger.info message
+        end
+      end
+
+    end
+
+  end
+
+end
+
+
+class ActionView::Base   # :nodoc:
+  include ::Erubis::Helpers::RailsHelper::TemplateConverter
+  include ::Erubis::PreprocessingHelper
+  private
+  # convert template into ruby code
+  def convert_template_into_ruby_code(template)
+    #ERB.new(template, nil, @@erb_trim_mode).src
+    return _convert_template(template)
+  end
+end
+
+
+require 'action_pack/version'
+
+rails22 = false
+
+if ActionPack::VERSION::MAJOR >= 2             ### Rails 2.X
+
+
+  if ActionPack::VERSION::MINOR >=2            ### Rails 2.2, 2.3 or higher
+
+    rails22 = true
+    module ActionView
+      module TemplateHandlers
+        class ErubisHandler < TemplateHandler
+          include Compilable
+          include ::Erubis::Helpers::RailsHelper::TemplateConverter
+          include ::Erubis::PreprocessingHelper
+          def compile(template)
+            #src = ::ERB.new("<% __in_erb_template=true %>#{template.source}", nil, erb_trim_mode, '@output_buffer').src
+            return _convert_template("<% __in_erb_template=true %>#{template.source}")
+          end
+        end
+      end
+      handler_klass = TemplateHandlers::ErubisHandler
+      Template.register_default_template_handler :erb, handler_klass
+      Template.register_template_handler :rhtml, handler_klass
+    end
+    module Erubis::Helpers::RailsHelper::TemplateConverter
+      def _logger_info(message)
+        #logger.info message   # logger.info seems not available in Rails 2.2
+        ActionController::Base.new.logger.info message
+      end
+    end
+
+  elsif ActionPack::VERSION::MINOR >=1            ### Rails 2.1
+
+    module ActionView
+      module TemplateHandlers # :nodoc:
+        class ErubisHandler < TemplateHandler
+          include Compilable
+          include Erubis::Helpers::RailsHelper::TemplateConverter
+          include Erubis::PreprocessingHelper
+          #
+          def compile(template)
+            return _convert_template(template.source)   # template.is_a?(ActionView::Template)
+          end
+          def logger  #:nodoc:
+            return @view.controller.logger
+          end
+          def _preprocessing_context_object  #:nodoc:
+            return @view.controller.instance_variable_get('@template')
+          end
+          #
+          def cache_fragment(block, name = {}, options = nil) #:nodoc:
+            @view.fragment_for(block, name, options) do
+              #eval(ActionView::Base.erb_variable, block.binding)
+              eval('_buf', block.binding)
+            end
+          end
+        end
+      end
+      handler_klass = TemplateHandlers::ErubisHandler
+      Template.register_default_template_handler :erb, handler_klass
+      Template.register_template_handler :rhtml, handler_klass
+    end
+
+  elsif ActionPack::VERSION::TINY >= 2         ### Rails 2.0.X (X >= 2)
+
+    module ActionView
+      module TemplateHandlers # :nodoc:
+        class ErubisHandler < TemplateHandler
+          include Erubis::Helpers::RailsHelper::TemplateConverter
+          include Erubis::PreprocessingHelper
+          def compile(template)
+            return _convert_template(template)     # template.is_a?(String)
+          end
+          def logger  #:nodoc:
+            return @view.controller.logger
+          end
+          def _preprocessing_context_object  #:nodoc:
+            return @view.controller.instance_variable_get('@template')
+          end
+        end
+      end
+      Base.class_eval do
+        handler_klass = TemplateHandlers::ErubisHandler
+        register_default_template_handler :erb, handler_klass
+        register_template_handler :rhtml, handler_klass
+      end
+    end
+
+  else                                         ### Rails 2.0.0 or 2.0.1
+
+    class ActionView::Base   # :nodoc:
+      private
+      # Method to create the source code for a given template.
+      def create_template_source(extension, template, render_symbol, locals)
+        if template_requires_setup?(extension)
+          body = case extension.to_sym
+            when :rxml, :builder
+              content_type_handler = (controller.respond_to?(:response) ? "controller.response" : "controller")
+              "#{content_type_handler}.content_type ||= Mime::XML\n" +
+              "xml = Builder::XmlMarkup.new(:indent => 2)\n" +
+              template +
+              "\nxml.target!\n"
+            when :rjs
+              "controller.response.content_type ||= Mime::JS\n" +
+              "update_page do |page|\n#{template}\nend"
+          end
+        else
+          #body = ERB.new(template, nil, @@erb_trim_mode).src
+          body = convert_template_into_ruby_code(template)
+        end
+        #
+        @@template_args[render_symbol] ||= {}
+        locals_keys = @@template_args[render_symbol].keys | locals
+        @@template_args[render_symbol] = locals_keys.inject({}) { |h, k| h[k] = true; h }
+        #
+        locals_code = ""
+        locals_keys.each do |key|
+          locals_code << "#{key} = local_assigns[:#{key}]\n"
+        end
+        #
+        "def #{render_symbol}(local_assigns)\n#{locals_code}#{body}\nend"
+      end
+    end
+
+  end #if
+
+
+else                                           ###  Rails 1.X
+
+
+  if ActionPack::VERSION::MINOR > 12           ###  Rails 1.2
+
+    class ActionView::Base   # :nodoc:
+      private
+      # Create source code for given template
+      def create_template_source(extension, template, render_symbol, locals)
+        if template_requires_setup?(extension)
+          body = case extension.to_sym
+            when :rxml
+              "controller.response.content_type ||= 'application/xml'\n" +
+              "xml = Builder::XmlMarkup.new(:indent => 2)\n" +
+              template
+            when :rjs
+              "controller.response.content_type ||= 'text/javascript'\n" +
+              "update_page do |page|\n#{template}\nend"
+          end
+        else
+          #body = ERB.new(template, nil, @@erb_trim_mode).src
+          body = convert_template_into_ruby_code(template)
+        end
+        #
+        @@template_args[render_symbol] ||= {}
+        locals_keys = @@template_args[render_symbol].keys | locals
+        @@template_args[render_symbol] = locals_keys.inject({}) { |h, k| h[k] = true; h }
+        #
+        locals_code = ""
+        locals_keys.each do |key|
+          locals_code << "#{key} = local_assigns[:#{key}]\n"
+        end
+        #
+        "def #{render_symbol}(local_assigns)\n#{locals_code}#{body}\nend"
+      end
+    end
+
+  else                                         ###  Rails 1.1
+
+    class ActionView::Base   # :nodoc:
+      private
+      # Create source code for given template
+      def create_template_source(extension, template, render_symbol, locals)
+        if template_requires_setup?(extension)
+          body = case extension.to_sym
+            when :rxml
+              "xml = Builder::XmlMarkup.new(:indent => 2)\n" +
+              "@controller.headers['Content-Type'] ||= 'application/xml'\n" +
+              template
+            when :rjs
+              "@controller.headers['Content-Type'] ||= 'text/javascript'\n" +
+              "update_page do |page|\n#{template}\nend"
+          end
+        else
+          #body = ERB.new(template, nil, @@erb_trim_mode).src
+          body = convert_template_into_ruby_code(template)
+        end
+        #
+        @@template_args[render_symbol] ||= {}
+        locals_keys = @@template_args[render_symbol].keys | locals
+        @@template_args[render_symbol] = locals_keys.inject({}) { |h, k| h[k] = true; h }
+        #
+        locals_code = ""
+        locals_keys.each do |key|
+          locals_code << "#{key} = local_assigns[:#{key}] if local_assigns.has_key?(:#{key})\n"
+        end
+        #
+        "def #{render_symbol}(local_assigns)\n#{locals_code}#{body}\nend"
+      end
+    end
+
+  end #if
+
+  ## make h() method faster (only for Rails 1.X)
+  module ERB::Util  # :nodoc:
+    ESCAPE_TABLE = { '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;', '"'=>'&quot;', "'"=>'&#039;', }
+    def h(value)
+      value.to_s.gsub(/[&<>"]/) {|s| ESCAPE_TABLE[s] }
+    end
+    module_function :h
+  end
+
+end   ###
+
+
+## finish
+if defined?(Rails) and defined?(ActionController)
+  ActionController::Base.new.logger.info "** Erubis #{::Erubis::VERSION}"
+end
+$stdout.puts "** Erubis #{::Erubis::VERSION}....rails22=#{rails22}" if rails22

data/test/test_erubis_rails_helper.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestErubisRailsHelper < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/erubis_rails_helper'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: elkinsware-erubis_rails_helper
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dave Elkins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.2
+    version: 
+description: Drop in replacement for the Rails integration in the Erubis gem so that Erubis will work with Rails 2.3.
+email: dave@elkinsware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/erubis_rails_helper.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/elkinsware/erubis_rails_helper/tree/master
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Drop in replacement for the Rails integration in the Erubis gem so that Erubis will work with Rails 2.3.
+test_files: 
+- test/test_erubis_rails_helper.rb
+- test/test_helper.rb