erubis_rails_helper 1.0.0

data/README.rdoc

@@ -0,0 +1,66 @@
+= 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 code makes a few tweaks to the Erubis 2.6.4 Rails Helper along with the Generator class.  The main issue with getting
+Erubis and Rails 2.3 to work together is to replace "_buf" with "@output_buffer" in the generator code.  Rails 2.3 relies on
+for "@output_buffer" to be used in the generated code to make helpers like capture_helper.rb work properly.
+
+== FEATURES/PROBLEMS:
+
+* Drop in replacement for the Erubis Rails Helper in the Erubis gem.
+
+* Using the tests from actionpack-2.3, this passes all but two tests currently.  The two failures are because
+  there are two end of line characters instead of one end of line characters.  I think that is none critical for 
+  the moment.
+
+== SYNOPSIS:
+
+  inside config/environment.rb and the following
+     config.gem 'erubis' , :version => '2.6.4'
+     config.gem 'elkinsware-erubis_rails_helper', :lib => 'erubis_rails_helper', :source => 'http://gems.github.com'
+  
+  #you can customize some of the options for Erubis still if you want to by
+  #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,17 @@
+unless defined?(Rails) and defined?(ActionController)
+  $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
+
+require 'erubis_rails_helper/erubis/generator'
+require 'erubis_rails_helper/template_handlers/erubis'
+
+## finish
+$stdout.puts "** Erubis #{::Erubis::VERSION}"

data/lib/erubis_rails_helper/erubis/generator.rb

@@ -0,0 +1,100 @@
+##
+## This is a copy of the generator.rb from the Erubis 2.6.4 gem
+## The modification I made was that you can substitute any variable name (i.e. @output_buffer) for _buf.
+## This is necessary for Erubis to work with Rails 2.3 and 2.2 because ActionView code like CaptureHelper
+## relies on @output_buffer to be used and not _buf to work correctly.
+##
+
+##
+## $Rev: 77 $
+## $Release: 2.6.4 $
+## copyright(c) 2006-2009 kuwata-lab.com all rights reserved.
+##
+
+require 'erubis/engine'
+require 'erubis/enhancer'
+
+
+module Erubis
+
+
+  ##
+  ## code generator for Ruby
+  ##
+  module RubyGenerator
+    include Generator
+    #include ArrayBufferEnhancer
+    include StringBufferEnhancer
+
+    def init_generator(properties={})
+      super
+      
+      @escapefunc ||= "Erubis::XmlHelper.escape_xml"
+      
+      set_eoutvar(properties[:eoutvar] || '_buf')
+    end
+
+    def self.supported_properties()  # :nodoc:
+      return []
+    end
+
+    def escape_text(text)
+      text.gsub(/['\\]/, '\\\\\&')   # "'" => "\\'",  '\\' => '\\\\'
+    end
+
+    def escaped_expr(code)
+      return "#{@escapefunc}(#{code})"
+    end
+
+    #--
+    #def add_preamble(src)
+    #  src << "_buf = [];"
+    #end
+    #++
+
+    def add_text(src, text)
+      #src << " _buf << '" << escape_text(text) << "';" unless text.empty?
+      src << " #{eoutvar} << '" << escape_text(text) << "';" unless text.empty?
+    end
+
+    def add_stmt(src, code)
+      #src << code << ';'
+      src << code
+      src << ';' unless code[-1] == ?\n
+    end
+
+    def add_expr_literal(src, code)
+      #src << ' _buf << (' << code << ').to_s;'
+      src << " #{eoutvar} << (" << code << ").to_s;"
+    end
+
+    def add_expr_escaped(src, code)
+      #src << ' _buf << ' << escaped_expr(code) << ';'
+      src << " #{eoutvar} << " << escaped_expr(code) << ';'
+    end
+
+    def add_expr_debug(src, code)
+      code.strip!
+      s = (code.dump =~ /\A"(.*)"\z/) && $1
+      src << ' $stderr.puts("*** debug: ' << s << '=#{(' << code << ').inspect}");'
+    end
+
+    #--
+    #def add_postamble(src)
+    #  src << "\n_buf.join\n"
+    #end
+    #++
+
+    private
+    ##
+    ## Added to set the buffer variable name. defaults to _buf.
+    ##
+    def set_eoutvar(new_eoutvar = '_buf')
+      @eoutvar = new_eoutvar
+    end
+    
+    def eoutvar
+      @eoutvar || '_buf'
+    end
+  end
+end

data/lib/erubis_rails_helper/template_handlers/erubis.rb

@@ -0,0 +1,258 @@
+module Erubis
+  ##
+  ## convert "<h1><%=title%></h1>" into "@output_buffer << %Q`<h1>#{title}</h1>`"
+  ##
+  ## this is only for Eruby.
+  ##
+  module InterpolationEnhancer
+
+    def self.desc   # :nodoc:
+      "convert '<p><%=text%></p>' into '@output_buffer << %Q`<p>\#{text}</p>`'"
+    end
+
+    def convert_input(src, input)
+      pat = @pattern
+      regexp = pat.nil? || pat == '<% %>' ? Basic::Converter::DEFAULT_REGEXP : pattern_regexp(pat)
+      pos = 0
+      is_bol = true     # is beginning of line
+      str = ''
+      input.scan(regexp) do |indicator, code, tailch, rspace|
+        match = Regexp.last_match()
+        len  = match.begin(0) - pos
+        text = input[pos, len]
+        pos  = match.end(0)
+        ch   = indicator ? indicator[0] : nil
+        lspace = ch == ?= ? nil : detect_spaces_at_bol(text, is_bol)
+        is_bol = rspace ? true : false
+        _add_text_to_str(str, text)
+        ## * when '<%= %>', do nothing
+        ## * when '<% %>' or '<%# %>', delete spaces iff only spaces are around '<% %>'
+        if ch == ?=              # <%= %>
+          rspace = nil if tailch && !tailch.empty?
+          str << lspace if lspace
+          add_expr(str, code, indicator)
+          str << rspace if rspace
+        elsif ch == ?\#          # <%# %>
+          n = code.count("\n") + (rspace ? 1 : 0)
+          if @trim && lspace && rspace
+            add_text(src, str)
+            str = ''
+            add_stmt(src, "\n" * n)
+          else
+            str << lspace if lspace
+            add_text(src, str)
+            str = ''
+            add_stmt(src, "\n" * n)
+            str << rspace if rspace
+          end
+        else                     # <% %>
+          if @trim && lspace && rspace
+            add_text(src, str)
+            str = ''
+            add_stmt(src, "#{lspace}#{code}#{rspace}")
+          else
+            str << lspace if lspace
+            add_text(src, str)
+            str = ''
+            add_stmt(src, code)
+            str << rspace if rspace
+          end
+        end
+      end
+      #rest = $' || input                       # ruby1.8
+      rest = pos == 0 ? input : input[pos..-1]  # ruby1.9
+      _add_text_to_str(str, rest)
+      add_text(src, str)
+    end
+
+    def add_text(src, text)
+      return if !text || text.empty?
+      #src << " _buf << %Q`" << text << "`;"
+      if text[-1] == ?\n
+        text[-1] = "\\n"
+        src << " @output_buffer << %Q`" << text << "`\n"
+      else
+        src << " @output_buffer << %Q`" << text << "`;"
+      end
+    end
+
+    def _add_text_to_str(str, text)
+      return if !text || text.empty?
+      text.gsub!(/['\#\\]/, '\\\\\&')
+      str << text
+    end
+
+    def add_expr_escaped(str, code)
+      str << "\#{#{escaped_expr(code)}}"
+    end
+
+    def add_expr_literal(str, code)
+      str << "\#{#{code}}"
+    end
+  end
+
+  module OutputBufferEnhancer
+    def self.desc   # :nodoc:
+      "set '@output_buffer = _buf = \"\";'"
+    end
+
+    def add_preamble(src)
+      src << "@output_buffer = _buf = '';"
+    end
+
+    def add_postamble(src)
+      src << "\n" unless src[-1] == ?\n
+      src << "@output_buffer.to_s\n"
+    end
+  end
+
+  class Eruby
+    include ::Erubis::PercentLineEnhancer
+    include OutputBufferEnhancer
+  end
+
+  class FastEruby
+    include ::Erubis::PercentLineEnhancer
+    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
+        def _convert_template(template)    # :nodoc:
+
+          klass      = ::Erubis::Helpers::RailsHelper.engine_class
+          properties = ::Erubis::Helpers::RailsHelper.init_properties || {}
+
+          if preprocess?
+            preprocessor = _create_preprocessor(template)
+            template = preprocessor.evaluate(_preprocessing_context_object())
+          end
+
+          src = klass.new(template, properties.merge(:eoutvar => "@output_buffer")).src
+          return src
+        end
+
+        def _create_preprocessor(template)
+          return PreprocessingEruby.new(template, :escape=>true)
+        end
+
+        def _preprocessing_context_object
+          return self
+        end
+
+        def preprocess?
+          ::Erubis::Helpers::RailsHelper.preprocessing
+        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
+
+module ActionView
+  module TemplateHandlers
+    class Erubis < TemplateHandler
+      include Compilable
+      include ::Erubis::Helpers::RailsHelper::TemplateConverter
+      include ::Erubis::PreprocessingHelper
+
+      def compile(template)
+        src =  _convert_template("<% __in_erb_template=true %>#{template.source}")
+
+        if show_source?
+          logger.debug("** Erubis: src==<<'END'\n#{src}END\n") if logger
+        end
+
+        # Ruby 1.9 prepends an encoding to the source. However this is
+        # useless because you can only set an encoding on the first line
+        RUBY_VERSION >= '1.9' ? src.sub(/\A#coding:.*\n/, '') : src
+      end
+
+      protected
+      def logger
+        @logger ||= ActionController::Base.new.logger
+      end
+
+      def show_source?
+        return ::Erubis::Helpers::RailsHelper.show_src if not ::Erubis::Helpers::RailsHelper.show_src.nil?
+        ENV['RAILS_ENV'] == 'development' if ::Erubis::Helpers::RailsHelper.show_src.nil?
+      end
+    end
+
+    handler_klass = TemplateHandlers::Erubis
+    Template.register_default_template_handler(:erb, handler_klass)
+    Template.register_template_handler(:rhtml, handler_klass)
+  end
+end

data/test/abstract_unit.rb

@@ -0,0 +1,51 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+#$:.unshift(File.dirname(__FILE__) + '/../../activesupport/lib')
+$:.unshift(File.dirname(__FILE__) + '/fixtures/helpers')
+$:.unshift(File.dirname(__FILE__) + '/fixtures/alternate_helpers')
+
+require 'rubygems'
+require 'yaml'
+require 'stringio'
+require 'test/unit'
+
+gem 'mocha', '>= 0.9.5'
+require 'mocha'
+
+begin
+  require 'ruby-debug'
+  Debugger.settings[:autoeval] = true
+  Debugger.start
+rescue LoadError
+  # Debugging disabled. `gem install ruby-debug` to enable.
+end
+
+require 'action_controller'
+require 'action_controller/cgi_ext'
+require 'action_controller/test_process'
+require 'action_view/test_case'
+
+#puts "#{File.dirname(__FILE__) + '/../lib/erubis_rails_helper'}\n"
+#require File.dirname(__FILE__) + '/../lib/erubis_rails_helper'
+
+require 'erubis'
+require 'erubis_rails_helper'
+
+# Show backtraces for deprecated behavior for quicker cleanup.
+ActiveSupport::Deprecation.debug = true
+
+ActionController::Base.logger = nil
+ActionController::Routing::Routes.reload rescue nil
+
+ActionController::Base.session_store = nil
+
+# Register danish language for testing
+I18n.backend.store_translations 'da', {}
+I18n.backend.store_translations 'pt-BR', {}
+ORIGINAL_LOCALES = I18n.available_locales.map(&:to_s).sort
+
+FIXTURE_LOAD_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+ActionView::Base.cache_template_loading = true
+ActionController::Base.view_paths = FIXTURE_LOAD_PATH
+CACHED_VIEW_PATHS = ActionView::Base.cache_template_loading? ?
+                      ActionController::Base.view_paths :
+                      ActionController::Base.view_paths.map {|path| ActionView::Template::EagerPath.new(path.to_s)}