RubyGems - pivotal-erector - Versions diffs - 0.5.1 - Mend

pivotal-erector 0.5.1

Files changed (42) hide show

data/README.txt +81 -0
data/VERSION.yml +4 -0
data/bin/erect +7 -0
data/lib/erector/erect.rb +148 -0
data/lib/erector/erected.rb +63 -0
data/lib/erector/extensions/object.rb +18 -0
data/lib/erector/indenting.rb +36 -0
data/lib/erector/rails/extensions/action_controller/1.2.5/action_controller.rb +17 -0
data/lib/erector/rails/extensions/action_controller/2.2.0/action_controller.rb +26 -0
data/lib/erector/rails/extensions/action_controller.rb +8 -0
data/lib/erector/rails/extensions/action_view.rb +21 -0
data/lib/erector/rails/extensions/widget/1.2.5/widget.rb +18 -0
data/lib/erector/rails/extensions/widget/2.2.0/widget.rb +36 -0
data/lib/erector/rails/extensions/widget.rb +117 -0
data/lib/erector/rails/supported_rails_versions.rb +14 -0
data/lib/erector/rails/template_handlers/1.2.5/action_view_template_handler.rb +32 -0
data/lib/erector/rails/template_handlers/2.0.0/action_view_template_handler.rb +36 -0
data/lib/erector/rails/template_handlers/2.1.0/action_view_template_handler.rb +31 -0
data/lib/erector/rails/template_handlers/2.2.0/action_view_template_handler.rb +46 -0
data/lib/erector/rails/template_handlers/action_view_template_handler.rb +14 -0
data/lib/erector/rails.rb +6 -0
data/lib/erector/raw_string.rb +8 -0
data/lib/erector/rhtml.treetop +156 -0
data/lib/erector/unicode.rb +18185 -0
data/lib/erector/unicode_builder.rb +67 -0
data/lib/erector/version.rb +10 -0
data/lib/erector/widget.rb +510 -0
data/lib/erector/widgets/table.rb +96 -0
data/lib/erector/widgets.rb +2 -0
data/lib/erector.rb +16 -0
data/spec/core_spec_suite.rb +3 -0
data/spec/erect/erect_spec.rb +145 -0
data/spec/erect/erected_spec.rb +80 -0
data/spec/erect/rhtml_parser_spec.rb +318 -0
data/spec/erector/indentation_spec.rb +136 -0
data/spec/erector/unicode_builder_spec.rb +75 -0
data/spec/erector/widget_spec.rb +657 -0
data/spec/erector/widgets/table_spec.rb +99 -0
data/spec/rails_spec_suite.rb +3 -0
data/spec/spec_helper.rb +54 -0
data/spec/spec_suite.rb +45 -0
metadata +118 -0

data/README.txt ADDED Viewed

@@ -0,0 +1,81 @@
+= Erector
+* http://erector.rubyforge.org
+* mailto:erector-devel@rubyforge.org
+* http://www.pivotaltracker.com/projects/482
+== DESCRIPTION
+Erector is a Builder-like view framework, inspired by Markaby but overcoming
+some of its flaws. In Erector all views are objects, not template files,
+which allows the full power of object-oriented programming (inheritance,
+modular decomposition, encapsulation) in views. See the rdoc for the
+Erector::Widget class to learn how to make your own widgets, and visit the
+project site at http://erector.rubyforge.org for more documentation.
+== SYNOPSIS
+    require 'erector'
+    class Hello < Erector::Widget
+      def render
+        html do
+          head do
+            title "Hello"
+          end
+          body do
+            text "Hello, "
+            b "world!", :class => 'big'
+          end
+        end
+      end
+    end
+    Hello.new.to_s
+    => "<html><head><title>Hello</title></head><body>Hello, <b class=\"big\">world!</b></body></html>"
+== REQUIREMENTS
+The gem depends on rake and treetop, although this is just for using the "erect" tool,
+so deployed applications won't need these. Currently it also requires rails, although
+we plan to separate the rails-dependent code so you can use Erector cleanly in a non-Rails app.
+== INSTALL
+To install as a gem:
+* sudo gem install erector
+Then add "require 'erector'" to any files which need erector.
+To install as a Rails plugin:
+* Copy the erector source to vendor/plugins/erector in your Rails directory.
+When installing this way, erector is automatically available to your Rails code
+(no require directive is needed).
+== LICENSE:
+(The MIT License)
+Copyright (c) 2007-8 Pivotal Labs
+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/VERSION.yml ADDED Viewed

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 5
+:patch: 1

data/bin/erect ADDED Viewed

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+dir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift("#{dir}/../lib")
+require "erector"
+require "erector/erect"
+Erector::Erect.new(ARGV).run

data/lib/erector/erect.rb ADDED Viewed

@@ -0,0 +1,148 @@
+require "optparse"
+require "rake"
+require "erector/erected"  # pull this out so we don't recreate the grammar every time
+module Erector
+  class Erect
+    attr_reader :files, :verbose, :mode, :output_dir
+    def initialize(args)
+      @verbose = true
+      @mode = :to_erector
+      @output_dir = nil
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: erect [options] [file|dir]*"
+        opts.separator "Converts from html/rhtml files to erector widgets, or from erector widgets to html files"
+        opts.separator ""
+        opts.separator "Options:"
+        opts.on("-q", "--quiet",
+                "Operate silently except in case of error") do |quiet|
+          @verbose = !quiet
+        end
+        opts.on("--to-erector", "(default) Convert from html/rhtml to erector classes") do
+          @mode = :to_erector
+        end
+        opts.on("--to-html", "Convert from erector to html") do
+          @mode = :to_html
+        end
+        opts.on("-o", "--output-dir DIRECTORY", "Output files to DIRECTORY (default: output files go next to input files)") do |dir|
+          @output_dir = dir
+        end
+        opts.on_tail("-h", "--help", "Show this message") do
+          @mode = :help
+          puts opts
+          exit
+        end
+        opts.on_tail("-v", "--version", "Show version") do
+          puts Erector::VERSION
+          exit
+        end
+      end
+      opts.parse!(args)
+      @files = args
+      explode_dirs
+    end
+    def say(msg)
+      print msg if verbose
+    end
+    #todo: unit test
+    def explode_dirs
+      exploded_files = FileList.new
+      files.each do |file|
+        if File.directory?(file)
+          exploded_files.add(explode(file))
+        else
+          exploded_files.add(file)
+        end
+      end
+      @files = exploded_files
+    end
+    def explode(dir)
+      case mode
+      when :to_erector
+        FileList["#{dir}/**/*.rhtml", "#{dir}/**/*.html", "#{dir}/**/*.html.erb"]
+      when :to_html
+        FileList["#{dir}/**/*.rb"]
+      end
+    end
+    def run
+      self.send(mode)
+    end
+    def to_erector
+      files.each do |file|
+        say "Erecting #{file}... "
+        begin
+          e = Erector::Erected.new(file)
+          e.convert
+          say " --> #{e.filename}\n"
+        rescue => e
+          puts e
+          puts e.backtrace.join("\n\t")
+          puts
+        end
+      end
+    end
+    def to_html
+      files.each do |file|
+        say "Erecting #{file}... "
+        #todo: move this into Erected with better tests for the naming methods
+        begin
+          #todo: fail if file isn't a .rb file
+          require file
+          #todo: understand modulized widgets (e.g. class Foo::Bar::Baz < Erector::Widget in baz.rb)
+          filename = file.split('/').last.gsub(/\.rb$/, '')
+          widget_name = camelize(filename)
+          widget_class = constantize(widget_name)
+          if widget_class < Erector::Widget
+            widget = widget_class.new
+            #todo: skip if it's missing a no-arg constructor
+            dir = output_dir || File.dirname(file)
+            FileUtils.mkdir_p(dir)
+            output_file = "#{dir}/#{filename}.html"
+            File.open(output_file, "w") do |f|
+              f.puts widget.to_s
+            end
+            say " --> #{output_file}\n"
+          else
+            say " -- not a widget, skipping\n"
+          end
+        rescue => e
+          puts e
+          puts e.backtrace.join("\n\t")
+        end
+      end
+    end
+    # stolen from activesuppport/lib/inflector.rb
+    def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+    def constantize(camel_cased_word)
+      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+        raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+      end
+      Object.module_eval("::#{$1}", __FILE__, __LINE__)
+    end
+  end
+end

data/lib/erector/erected.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'treetop'
+dir = File.dirname(__FILE__)
+require "#{dir}/indenting"
+Treetop.load("#{dir}/rhtml.treetop")
+module Erector
+  class Erected
+    def initialize(in_file)
+      @in_file = in_file
+    end
+    def filename
+      dir + basename + ".rb"
+    end
+    def classname
+      base = classize(basename)
+      parent = File.dirname(@in_file)
+      grandparent = File.dirname(parent)
+      if File.basename(grandparent) == "views"
+        base = "Views::" + classize(File.basename(parent)) + "::" + base
+      end
+      base
+    end
+    def text
+      File.read(@in_file)
+    end
+    def convert
+      parser = RhtmlParser.new
+      parsed = parser.parse(File.read(@in_file))
+      if parsed.nil?
+        raise "Could not parse #{@in_file}\n" +
+          parser.failure_reason
+      else
+        File.open(filename, "w") do |f|
+          f.puts("class #{classname} < Erector::Widget")
+          f.puts("  def render")
+          f.puts(parsed.set_indent(2).convert)
+          f.puts("  end")
+          f.puts("end")
+        end
+      end
+    end
+    protected
+    def basename
+      @in_file.split("/").last.gsub(/\..*$/, '')
+    end
+    def dir
+      x = File.dirname(@in_file)
+      return (x == ".") ? "" : "#{x}/"
+    end
+    def classize(filename)
+      filename.split("_").map{|part| part.capitalize}.join
+    end
+  end
+end

data/lib/erector/extensions/object.rb ADDED Viewed

@@ -0,0 +1,18 @@
+class Object
+  def metaclass
+    class << self; self; end
+  end
+  def html_escape
+    return CGI.escapeHTML(to_s)
+  end
+  def html_unescape
+    CGI.unescapeHTML(to_s)
+  end
+  def escape_single_quotes
+    self.gsub(/[']/, '\\\\\'')
+  end
+end

data/lib/erector/indenting.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'treetop'
+module Erector
+  class Indenting < Treetop::Runtime::SyntaxNode #:nodoc:
+    @@indent = 0
+    def set_indent(x)
+      @@indent = x
+      self
+    end
+    def indent
+      [0, @@indent].max
+    end
+    def indented(s)
+      "  " * indent + s + "\n"
+    end
+    def line(s)
+      indented(s)
+    end
+    def line_in(s)
+      s = indented(s)
+      @@indent += 1
+      s
+    end
+    def line_out(s)
+      @@indent -= 1
+      indented(s)
+    end
+  end
+end

data/lib/erector/rails/extensions/action_controller/1.2.5/action_controller.rb ADDED Viewed

@@ -0,0 +1,17 @@
+ActionController::Base.class_eval do
+  def render_widget(widget_class, assigns=@assigns)
+    @__widget_class = widget_class
+    @__widget_assigns = assigns
+    add_variables_to_assigns
+    render :inline => "<% @__widget_class.new(self, @__widget_assigns, _erbout).render %>"
+  end
+  def render_with_erector_widget(*options, &block)
+    if options.first.is_a?(Hash) && widget = options.first.delete(:widget)
+      render_widget widget, @assigns, &block
+    else
+      render_without_erector_widget *options, &block
+    end
+  end
+  alias_method_chain :render, :erector_widget
+end

data/lib/erector/rails/extensions/action_controller/2.2.0/action_controller.rb ADDED Viewed

@@ -0,0 +1,26 @@
+ActionController::Base.class_eval do
+  def render_widget(widget_class, assigns=nil)
+    @__widget_class = widget_class
+    if assigns
+      @__widget_assigns = assigns
+    else
+      @__widget_assigns = {}
+      variables = instance_variable_names
+      variables -= protected_instance_variables
+      variables.each do |name|
+        @__widget_assigns[name.sub('@', "")] = instance_variable_get(name)
+      end
+    end
+    response.template.send(:_evaluate_assigns_and_ivars)
+    render :inline => "<% @__widget_class.new(self, @__widget_assigns, output_buffer).render %>"
+  end
+  def render_with_erector_widget(*options, &block)
+    if options.first.is_a?(Hash) && widget = options.first.delete(:widget)
+      render_widget widget, @assigns, &block
+    else
+      render_without_erector_widget *options, &block
+    end
+  end
+  alias_method_chain :render, :erector_widget
+end

data/lib/erector/rails/extensions/action_controller.rb ADDED Viewed

@@ -0,0 +1,8 @@
+dir = File.dirname(__FILE__)
+if (
+  ActionController::Base.instance_methods + ActionController::Base.private_instance_methods).
+  include?("add_variables_to_assigns")
+  require File.expand_path("#{dir}/action_controller/1.2.5/action_controller")
+else
+  require File.expand_path("#{dir}/action_controller/2.2.0/action_controller")
+end

data/lib/erector/rails/extensions/action_view.rb ADDED Viewed

@@ -0,0 +1,21 @@
+unless ActionView.const_defined?(:Template)
+  ActionView::Base.class_eval do
+    attr_reader :template_file_path
+    def render_template_with_saving_file_path(template_extension, template, file_path = nil, local_assigns = {})
+      @template_file_path = file_path
+      render_template_without_saving_file_path(template_extension, template, file_path, local_assigns)
+    end
+    alias_method_chain :render_template, :saving_file_path
+    def render_partial_with_notification(*args, &blk)
+      @is_partial_template = true
+      render_partial_without_notification(*args, &blk)
+    end
+    alias_method_chain :render_partial, :notification
+    def is_partial_template?
+      @is_partial_template || false
+    end
+  end
+end

data/lib/erector/rails/extensions/widget/1.2.5/widget.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module Erector
+  Widget.class_eval do
+    attr_reader :_erbout
+    after_initialize do
+      @_erbout = output
+    end
+    def define_javascript_functions(*args)
+      begin
+        text raw(helpers.define_javascript_functions(*args))
+      rescue => e
+        puts e.backtrace.join("\n\t")
+        raise e
+      end
+    end
+  end
+end

data/lib/erector/rails/extensions/widget/2.2.0/widget.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module Erector
+  Widget.class_eval do
+    def output
+      process_output_buffer || @output
+    end
+    def capture_with_helpers(&block)
+      helpers ? helpers.capture(&block) : capture_without_helpers(&block)
+    end
+    alias_method_chain :capture, :helpers
+    # This is here to force #helpers.capture to return the output
+    def __in_erb_template; end
+    private
+    def process_output_buffer
+      if helpers.respond_to?(:output_buffer)
+        buffer = helpers.output_buffer
+        buffer.is_a?(String) ? buffer : handle_rjs_buffer
+      else
+        nil
+      end
+    end
+    def handle_rjs_buffer
+      returning buffer = helpers.output_buffer.dup.to_s do
+        helpers.output_buffer.clear
+        helpers.with_output_buffer(buffer) do
+          buffer << helpers.output_buffer.to_s
+        end
+      end
+    end
+  end
+end

data/lib/erector/rails/extensions/widget.rb ADDED Viewed

@@ -0,0 +1,117 @@
+module Erector
+  Widget.class_eval do
+    include ActionController::UrlWriter
+    # helpers returning raw text
+    [
+      :image_tag,
+      :javascript_include_tag,
+      :stylesheet_link_tag,
+      :sortable_element,
+      :sortable_element_js,
+      :text_field_with_auto_complete,
+    ].each do |helper_name|
+      define_method helper_name do |*args|
+        begin
+          text raw(helpers.send(helper_name, *args))
+        rescue => e
+          puts e.backtrace.join("\n\t")
+          raise e
+        end
+      end
+    end
+    # helpers returning raw text whose first parameter is HTML escaped
+    [
+      :link_to,
+      :link_to_remote,
+      :mail_to,
+      :button_to,
+      :submit_tag,
+    ].each do |helper_name|
+      method_def =<<-METHOD_DEF
+      def #{helper_name}(link_text, *args, &block)
+        text raw(helpers.#{helper_name}(h(link_text), *args, &block))
+      end
+      METHOD_DEF
+      eval(method_def)
+    end
+    def error_messages_for(*args)
+      text raw(helpers.error_messages_for(*args))
+    end
+    # return text, take block
+    [
+      :link_to_function,
+      :text_field_tag,
+      :password_field_tag,
+      :check_box_tag
+    ].each do |method_to_proxy_with_block|
+      method_def =<<-METHOD_DEF
+      def #{method_to_proxy_with_block}(*args, &block)
+        text raw(helpers.#{method_to_proxy_with_block}(*args, &block))
+      end
+      METHOD_DEF
+      eval(method_def)
+    end
+    # render text, take block
+    [
+      :error_messages_for,
+      :form_tag,
+      :form_for,
+    ].each do |method_to_proxy_with_block|
+      method_def =<<-METHOD_DEF
+      def #{method_to_proxy_with_block}(*args, &block)
+        helpers.#{method_to_proxy_with_block}(*args, &block)
+      end
+      METHOD_DEF
+      eval(method_def)
+    end
+    def javascript_include_merged(key)
+      helpers.javascript_include_merged(key)
+    end
+    def stylesheet_link_merged(key)
+      helpers.stylesheet_link_merged(key)
+    end
+    def flash
+      helpers.controller.send(:flash)
+    end
+    def session
+      helpers.controller.session
+    end
+    def controller
+      helpers.controller
+    end
+    def cycle(*args)
+      helpers.cycle(*args)
+    end
+    def simple_format(string)
+      p raw(string.to_s.html_escape.gsub(/\r\n?/, "\n").gsub(/\n/, "<br/>\n"))
+    end
+    def time_ago_in_words(*args)
+      helpers.time_ago_in_words(*args)
+    end
+    def pluralize(*args)
+      helpers.pluralize(*args)
+    end
+  end
+end
+dir = File.dirname(__FILE__)
+if ActionView::Base.instance_methods.include?("output_buffer")
+  require "#{dir}/widget/2.2.0/widget"
+else
+  require "#{dir}/widget/1.2.5/widget"
+end

data/lib/erector/rails/supported_rails_versions.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Erector
+  module Rails
+    SUPPORTED_RAILS_VERSIONS = {
+#      "1.2.5" => {'version' => '1.2.5', 'git_tag' => 'v1.2.5'},
+      "1.99.0" => {'version' => '1.99.0', 'git_tag' => 'v2.0.0_RC1'},
+      "2.0.2" => {'version' => '2.0.2', 'git_tag' => 'v2.0.2'},
+      "2.1.0" => {'version' => '2.1.0', 'git_tag' => 'v2.1.0'},
+      "2.2.0" => {'version' => '2.2.0', 'git_tag' => 'v2.2.0'},
+      "2.2.2" => {'version' => '2.2.2', 'git_tag' => 'v2.2.2'},
+      "2.3.2" => {'version' => '2.3.2', 'git_tag' => 'v2.3.2'},
+#      "edge" => {'version' => 'edge', 'git_tag' => 'master'}, #TODO: Readd edge support
+    }
+  end
+end

data/lib/erector/rails/template_handlers/1.2.5/action_view_template_handler.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module ActionView #:nodoc:
+  module TemplateHandlers #:nodoc:
+    class Erector
+      def self.line_offset
+        2
+      end
+      attr_reader :view
+      def initialize(view)
+        @view = view
+      end
+      def compilable?
+        true
+      end
+      ActionView::Base.register_template_handler :rb, ActionView::TemplateHandlers::Erector
+      def render(template, local_assigns)
+        relative_path_parts = view.first_render.split('/')
+        require_dependency view.template_file_path
+        dot_rb = /\.rb$/
+        widget_class = relative_path_parts.inject(Views) do |mod, node|
+          mod.const_get(node.gsub(dot_rb, '').gsub(".html", "").camelize)
+        end
+        render_method = view.is_partial_template? ? 'render_partial' : 'render'
+        widget_class.new(view, view.assigns).to_s(render_method)
+      end
+    end
+  end
+end