erector 0.8.3 → 0.9.0.pre1

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem "treetop", ">= 1.2.3"
+
+group :development do
+  gem "activesupport", "~>3"
+  gem "rspec", "~>2"
+  gem "rubyforge"
+  gem "rr"
+  gem "nokogiri"
+  gem "jeweler"
+  gem "haml"
+  gem "sass"
+  gem "erubis"
+  gem "rdoc", "~>2.3"
+  gem "wrong", ">=0.5.4"
+end
+
+group :rails do
+  gem "rails", "~> 3.0.0"
+end

data/Rakefile

@@ -0,0 +1,171 @@
+puts "RUBY_VERSION=#{RUBY_VERSION}"
+
+begin
+  # fix http://stackoverflow.com/questions/4932881/gemcutter-rake-build-now-throws-undefined-method-write-for-syckemitter
+  require 'psych' unless RUBY_VERSION =~ /^1\.8/
+rescue LoadError
+  warn "Couldn't find psych; continuing."
+end
+
+require 'rake'
+require 'rake/testtask'
+
+require "rspec/core/rake_task"
+
+require 'rdoc'
+here = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift("#{here}/lib")
+
+require "erector/version"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.version = Erector::VERSION
+    gemspec.name = "erector"
+    gemspec.summary = "HTML/XML Builder library"
+    gemspec.email = "erector@googlegroups.com"
+    gemspec.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."
+    gemspec.files = FileList[
+      "README.txt",
+      "VERSION.yml",
+      "lib/**/*",
+      "bin/erector",
+    ]
+    gemspec.executables = ["erector"]
+    specs = Dir.glob("spec/**/*") #.reject { |file| file =~ %r{spec/rails2/} }
+    gemspec.test_files = ([
+      "Rakefile",
+      "Gemfile",
+    ] + specs).flatten
+    gemspec.homepage = "http://erector.rubyforge.org/"
+    gemspec.authors = [
+            "Alex Chaffee",
+            "Brian Takita",
+            "Jeff Dean",
+            "Jim Kingdon",
+            "John Firebaugh",
+    ]
+    # gemspec.add_dependency 'treetop', ">= 1.2.3" # Jeweler now reads Gemfile, I think
+  end
+
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+    rubyforge.remote_doc_path = "rdoc"
+  end
+
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end
+
+desc "Default: run most tests"
+task :default => :spec
+task :cruise => [:install_gems, :print_environment, :test]
+task :test => :spec
+
+task :install_gems do
+  sh "bundle check"
+end
+
+desc "Build the web site from the .rb files in web/"
+task :web do
+  files = Dir["web/*.rb"] - ["web/page.rb", "web/sidebar.rb", "web/clickable_li.rb"]
+  require 'erector'
+  require 'erector/erect/erect'
+  $: << "."
+  Erector::Widget.prettyprint_default = true
+  Erector::Erect.new(["--to-html", * files]).run
+end
+
+desc "Generate rdoc"
+task :docs => :rdoc
+
+task :rdoc => :clean_rdoc
+task :clean_rdoc do
+  FileUtils.rm_rf("rdoc")
+end
+
+# push the docs to Rubyforge
+task :publish_docs => :"rubyforge:release:docs"
+
+desc "Publish web site to RubyForge"
+task :publish_web do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  rubyforge_name = "erector"
+  remote_dir = "/var/www/gforge-projects/#{rubyforge_name}"
+  local_dir = "web"
+  rdoc_dir = "rdoc"
+  rsync_args = '--archive --verbose --delete'
+
+  sh %{rsync #{rsync_args} --exclude=#{rdoc_dir} #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "Erector #{Erector::VERSION}"
+  rdoc.options << '--inline-source' << "--promiscuous"
+  rdoc.options << "--main=README.txt"
+#  rdoc.options << '--diagram' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ and not ENV['NODOT']
+  rdoc.rdoc_files.include('README.txt')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('bin/**/*')
+end
+
+desc "Regenerate unicode.rb from UnicodeData.txt from unicode.org.  Only needs to be run when there is a new version of the Unicode specification"
+task(:build_unicode) do
+  require 'lib/erector/unicode_builder'
+  builder = Erector::UnicodeBuilder.new(
+          File.open("/usr/lib/perl5/5.8.8/unicore/UnicodeData.txt"),
+          File.open("lib/erector/unicode.rb", "w")
+  )
+  builder.generate
+end
+
+task :print_environment do
+  puts <<-ENVIRONMENT
+Build environment:
+     #{`uname -a`.chomp}
+  #{`ruby -v`.chomp}
+  SQLite3:    #{`sqlite3 -version`}
+  #{`gem env`}
+Local gems:
+   #{`gem list`.gsub(/^/, '  ')}
+  ENVIRONMENT
+end
+
+namespace :spec do
+  desc "Run core specs."
+  RSpec::Core::RakeTask.new(:core) do |spec|
+    spec.pattern = 'spec/erector/*_spec.rb'
+  end
+
+  desc "Run specs for the 'erector' command line tool."
+  RSpec::Core::RakeTask.new(:erect) do |spec|
+    spec.pattern = 'spec/erect/*_spec.rb'
+  end
+
+  desc "Run specs for erector's Rails integration."
+  RSpec::Core::RakeTask.new(:rails) do |spec|
+    spec.pattern = 'spec/rails_root/spec/*_spec.rb'
+  end
+
+  desc "Run specs for erector's Rails integration under Rails 2."
+  task :rails2 do
+    Dir.chdir("spec/rails2/rails_app") do
+      # Bundler.with_clean_env do
+        sh "BUNDLE_GEMFILE='./Gemfile' bundle exec rake rails2"
+      # end
+    end
+  end
+
+  desc "Run all specs under Rails 3.1 - prepare with 'bundle install --gemfile Gemfile-rails31'"
+  task :rails31 do
+    gemfile = "#{here}/Gemfile-rails31"
+    sh "BUNDLE_GEMFILE='#{gemfile}' bundle exec rake spec:core spec:erect spec:rails"
+  end
+end
+
+desc "Run most specs"
+task :spec => ['spec:core', 'spec:erect', 'spec:rails', 'spec:rails2']

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
 :major: 0
-:minor: 8
-:patch: 3
+:minor: 9
+:patch: 0
+:build: pre1

data/lib/erector.rb

@@ -3,11 +3,6 @@ end
 
 require "cgi"
 require "yaml"
-begin
-  require "sass"
-rescue LoadError => e
-  # oh well, no Sass
-end
 
 require "erector/raw_string"
 require "erector/dependencies"
@@ -21,7 +16,10 @@ require "erector/html"
 require "erector/convenience"
 require "erector/jquery"
 require "erector/sass"
+
 require "erector/abstract_widget"
+require "erector/xml_widget"
+require "erector/html_widget"
 require "erector/widget"
 
 require "erector/inline"

data/lib/erector/abstract_widget.rb

@@ -1,8 +1,25 @@
+require 'erector/element'
+require 'erector/attributes'
+require 'erector/text'
+require 'erector/convenience'
+require 'erector/after_initialize'
+require 'erector/output'
+
 module Erector
 
-  # Abstract base class for Widget. This pattern allows Widget to include lots of nicely organized modules and still
-  # have proper semantics for "super" in subclasses. See the rdoc for Widget for the list of all the included modules.
+  # Abstract base class for Widget. This pattern allows Widget to include lots
+  # of nicely organized modules and still have proper semantics for "super" in
+  # subclasses. See the rdoc for Widget for the list of all the included
+  # modules.
   class AbstractWidget
+
+    include Erector::Element
+    include Erector::Attributes
+    include Erector::Text
+    include Erector::AfterInitialize
+
+    include Erector::Convenience
+
     @@prettyprint_default = false
     def prettyprint_default
       @@prettyprint_default
@@ -50,30 +67,30 @@ module Erector
     # method and returns the string.
     #
     # Options:
-    # output:: the string to output to. Default: a new empty string
+    # output:: the string (or array, or Erector::Output) to output to.
+    #          Default: a new empty string
     # prettyprint:: whether Erector should add newlines and indentation.
-    #               Default: the value of prettyprint_default (which is false
-    #               by default). 
+    #               Default: the value of prettyprint_default (which, in turn,
+    #               is false by default).
     # indentation:: the amount of spaces to indent. Ignored unless prettyprint
     #               is true.
     # max_length:: preferred maximum length of a line. Line wraps will only
-    #              occur at space characters, so a long word may end up creating
-    #              a line longer than this. If nil (default), then there is no
-    #              arbitrary limit to line lengths, and only internal newline
-    #              characters and prettyprinting will determine newlines in the
-    #              output.
+    #              occur at space characters, so a long word may end up
+    #              creating a line longer than this. If nil (default), then
+    #              there is no arbitrary limit to line lengths, and only
+    #              internal newline characters and prettyprinting will
+    #              determine newlines in the output.
     # helpers:: a helpers object containing utility methods. Usually this is a
     #           Rails view object.
     # content_method_name:: in case you want to call a method other than
     #                       #content, pass its name in here.
     #
-    def to_html(options = {})
-      raise "Erector::Widget#to_html takes an options hash, not a symbol. Try calling \"to_html(:content_method_name=> :#{options})\"" if options.is_a? Symbol
+    def render(options = {})
       _render(options).to_s
     end
 
-    # alias for #to_html
-    # @deprecated Please use {#to_html} instead
+    # alias for #render
+    # @deprecated Please use {#render} instead
     def to_s(*args)
       unless defined? @@already_warned_to_s
         $stderr.puts "Erector::Widget#to_s is deprecated. Please use #to_html instead. Called from #{caller.first}"
@@ -82,36 +99,39 @@ module Erector
       to_html(*args)
     end
 
-    # Entry point for rendering a widget (and all its children). Same as #to_html
-    # only it returns an array, for theoretical performance improvements when using a
-    # Rack server (like Sinatra or Rails Metal).
+    # Entry point for rendering a widget (and all its children). Same as
+    # #render / #to_html only it returns an array, for theoretical performance
+    # improvements when using a Rack server (like Sinatra or Rails Metal).
     #
-    # # Options: see #to_html
+    # # Options: see #render
     def to_a(options = {})
       _render(options).to_a
     end
 
     # Template method which must be overridden by all widget subclasses.
     # Inside this method you call the magic #element methods which emit HTML
-    # and text to the output string. If you call "super" (or don't override
+    # and text to the output string.
+    #
+    # If you call "super" (or don't override
     # +content+, or explicitly call "call_block") then your widget will
     # execute the block that was passed into its constructor. The semantics of
-    # this block are confusing; make sure to read the rdoc for Erector#call_block
+    # this block are confusing; make sure to read the rdoc for
+    # Erector#call_block
     def content
       call_block
     end
-    
-    # When this method is executed, the default block that was passed in to 
-    # the widget's constructor will be executed. The semantics of this 
+
+    # When this method is executed, the default block that was passed in to
+    # the widget's constructor will be executed. The semantics of this
     # block -- that is, what "self" is, and whether it has access to
     # Erector methods like "div" and "text", and the widget's instance
     # variables -- can be quite confusing. The rule is, most of the time the
     # block is evaluated using "call" or "yield", which means that its scope
     # is that of the caller. So if that caller is not an Erector widget, it
-    # will *not* have access to the Erector methods, but it *will* have access 
+    # will *not* have access to the Erector methods, but it *will* have access
     # to instance variables and methods of the calling object.
-    #   
-    # If you want this block to have access to Erector methods then use 
+    #
+    # If you want this block to have access to Erector methods then use
     # Erector::Inline#content or Erector#inline.
     def call_block
       @_block.call(self) if @_block
@@ -122,7 +142,8 @@ module Erector
     # the second argument is a hash used to populate its instance variables.
     # If the first argument is an instance then the hash must be unspecified
     # (or empty). If a block is passed to this method, then it gets set as the
-    # rendered widget's block.
+    # rendered widget's block, and will be executed when that widget calls
+    # +call_block+ or calls +super+ from inside its +content+ method.
     #
     # This is the preferred way to call one widget from inside another. This
     # method assures that the same output string is used, which gives better
@@ -140,8 +161,8 @@ module Erector
 
     # Creates a whole new output string, executes the block, then converts the
     # output string to a string and returns it as raw text. If at all possible
-    # you should avoid this method since it hurts performance, and use +widget+
-    # instead.
+    # you should avoid this method since it hurts performance, and use
+    # +widget+ instead.
     def capture
       original, @_output = output, Output.new
       yield
@@ -152,22 +173,46 @@ module Erector
     end
 
     protected
+    # executes this widget's #content method, which emits stuff onto the
+    # output stream
     def _render(options = {}, &block)
       @_block   = block if block
       @_parent  = options[:parent]  || parent
       @_helpers = options[:helpers] || parent
-      @_output  = options[:output]
-      @_output  = Output.new(options) unless output.is_a?(Output)
+      if options[:output]
+        # todo: document that either :buffer or :output can be used to specify an output buffer, and deprecate :output
+        if options[:output].is_a? Output
+          @_output = options[:output]
+        else
+          @_output = Output.new({:buffer => options[:output]}.merge(options))
+        end
+      else
+        @_output = Output.new(options)
+      end
 
       output.widgets << self.class
       send(options[:content_method_name] || :content)
       output
     end
 
+    # same as _render, but using a parent widget's output stream and helpers
     def _render_via(parent, options = {}, &block)
       _render(options.merge(:parent  => parent,
                             :output  => parent.output,
                             :helpers => parent.helpers), &block)
     end
+
+    protected
+
+    def sort_for_xml_declaration(attributes)
+      # correct order is "version, encoding, standalone" (XML 1.0 section 2.8).
+      # But we only try to put version before encoding for now.
+      stringized = []
+      attributes.each do |key, value|
+        stringized << [key.to_s, value]
+      end
+      stringized.sort{|a, b| b <=> a}
+    end
+
   end
 end

data/lib/erector/attributes.rb

@@ -0,0 +1,34 @@
+module Erector
+  module Attributes
+    def format_attributes(attributes)
+      if !attributes || attributes.empty?
+        ""
+      else
+        format_sorted(sort_attributes(attributes))
+      end
+    end
+
+    def format_sorted(sorted)
+      results = ['']
+      sorted.each do |key, value|
+        if value
+          if value.is_a?(Array)
+            value = value.flatten
+            next if value.empty?
+            value = value.join(' ')
+          end
+          results << "#{key}=\"#{h(value)}\""
+        end
+      end
+      results.join(' ')
+    end
+
+    def sort_attributes(attributes)
+      stringized = []
+      attributes.each do |key, value|
+        stringized << [key.to_s, value]
+      end
+      stringized.sort
+    end
+  end
+end