erector 0.9.0.pre1 → 0.9.0

data/Gemfile

@@ -12,7 +12,7 @@ group :development do
   gem "haml"
   gem "sass"
   gem "erubis"
-  gem "rdoc", "~>2.3"
+  gem "rdoc", "~> 3.4"
   gem "wrong", ">=0.5.4"
 end
 

data/README.txt

@@ -2,6 +2,7 @@
 
 * http://erector.rubyforge.org
 * mailto:erector@googlegroups.com
+* http://github.com/pivotal/erector
 * http://www.pivotaltracker.com/projects/482
 
 == DESCRIPTION
@@ -44,8 +45,8 @@ check it out.
 
 == REQUIREMENTS
 
-The gem depends on rake and treetop, although this is just for using the command-line tool, 
-so deployed applications won't need these. The Rails-dependent code is now separated so 
+The gem depends on rake and treetop, although this is just for using the command-line tool,
+so deployed applications won't need these. The Rails-dependent code is now separated so
 you can use Erector cleanly in a non-Rails app.
 
 == INSTALL

data/Rakefile

@@ -7,6 +7,9 @@ rescue LoadError
   warn "Couldn't find psych; continuing."
 end
 
+require "bundler"
+Bundler.setup
+
 require 'rake'
 require 'rake/testtask'
 
@@ -31,6 +34,7 @@ begin
       "VERSION.yml",
       "lib/**/*",
       "bin/erector",
+      ".gemtest",
     ]
     gemspec.executables = ["erector"]
     specs = Dir.glob("spec/**/*") #.reject { |file| file =~ %r{spec/rails2/} }
@@ -50,6 +54,7 @@ begin
   end
 
   Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.project = "erector"
     rubyforge.doc_task = "rdoc"
     rubyforge.remote_doc_path = "rdoc"
   end
@@ -69,7 +74,9 @@ 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"]
+  files = Dir["web/*.rb"].select do |filename|
+    File.read(filename) =~ (/\< Page/)
+  end
   require 'erector'
   require 'erector/erect/erect'
   $: << "."
@@ -85,11 +92,8 @@ 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
+desc "Publish web site and docs to RubyForge"
+task :publish => [:web, :docs] do
   config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
   host = "#{config["username"]}@rubyforge.org"
   rubyforge_name = "erector"
@@ -98,19 +102,27 @@ task :publish_web do
   rdoc_dir = "rdoc"
   rsync_args = '--archive --verbose --delete'
 
+  puts "== Publishing web site to RubyForge"
   sh %{rsync #{rsync_args} --exclude=#{rdoc_dir} #{local_dir}/ #{host}:#{remote_dir}}
+
+  puts "== Publishing rdoc to RubyForge"
+  sh %{rsync #{rsync_args} #{rdoc_dir}/ #{host}:#{remote_dir}/rdoc}
 end
 
+
+begin
 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/**/*')
+  RDoc::Task.new(:rdoc) do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title    = "Erector #{Erector::VERSION}"
+    rdoc.options <<
+      "--main=README.txt"
+    rdoc.rdoc_files.include('README.txt')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_files.include('bin/**/*')
+  end
+rescue LoadError => e
+  puts "#{e.class}: #{e.message}"
 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"
@@ -146,6 +158,7 @@ namespace :spec do
     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'
@@ -153,9 +166,11 @@ namespace :spec do
 
   desc "Run specs for erector's Rails integration under Rails 2."
   task :rails2 do
-    Dir.chdir("spec/rails2/rails_app") do
+    rails_app = "#{here}/spec/rails2/rails_app"
+    gemfile = "#{rails_app}/Gemfile"
+    Dir.chdir(rails_app) do
       # Bundler.with_clean_env do
-        sh "BUNDLE_GEMFILE='./Gemfile' bundle exec rake rails2"
+        sh "BUNDLE_GEMFILE='#{gemfile}' bundle exec rake rails2"
       # end
     end
   end
@@ -165,7 +180,13 @@ namespace :spec do
     gemfile = "#{here}/Gemfile-rails31"
     sh "BUNDLE_GEMFILE='#{gemfile}' bundle exec rake spec:core spec:erect spec:rails"
   end
+
+  desc "Run specs for the Erector web site."
+  RSpec::Core::RakeTask.new(:web) do |spec|
+    spec.pattern = 'spec/web/*_spec.rb'
+  end
+
 end
 
 desc "Run most specs"
-task :spec => ['spec:core', 'spec:erect', 'spec:rails', 'spec:rails2']
+task :spec => ['spec:core', 'spec:erect', 'spec:rails', 'spec:rails2', 'spec:web']

data/VERSION.yml

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

data/bin/erector

@@ -1,5 +1,11 @@
 #!/usr/bin/env ruby
 
+here = File.expand_path(File.dirname(__FILE__))
+
+if File.directory?("#{here}/../lib/erector")
+  $:.unshift "#{here}/../lib"
+end
+
 begin
   require 'erector'
 rescue LoadError

data/lib/erector/abstract_widget.rb

@@ -85,12 +85,12 @@ module Erector
     # content_method_name:: in case you want to call a method other than
     #                       #content, pass its name in here.
     #
-    def render(options = {})
-      _render(options).to_s
+    def emit(options = {})
+      _emit(options).to_s
     end
 
-    # alias for #render
-    # @deprecated Please use {#render} instead
+    # alias for #emit
+    # @deprecated Please use {#emit} 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}"
@@ -103,9 +103,9 @@ module Erector
     # #render / #to_html only it returns an array, for theoretical performance
     # improvements when using a Rack server (like Sinatra or Rails Metal).
     #
-    # # Options: see #render
+    # # Options: see #emit
     def to_a(options = {})
-      _render(options).to_a
+      _emit(options).to_a
     end
 
     # Template method which must be overridden by all widget subclasses.
@@ -142,7 +142,7 @@ 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, and will be executed when that widget calls
+    # emited 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
@@ -150,12 +150,12 @@ module Erector
     # performance than using +capture+ or +to_html+.
     def widget(target, assigns = {}, options = {}, &block)
       if target.is_a? Class
-        target.new(assigns, &block)._render_via(self, options)
+        target.new(assigns, &block)._emit_via(self, options)
       else
         unless assigns.empty?
           raise "Unexpected second parameter. Did you mean to pass in assigns when you instantiated the #{target.class.to_s}?"
         end
-        target._render_via(self, options, &block)
+        target._emit_via(self, options, &block)
       end
     end
 
@@ -163,7 +163,7 @@ module Erector
     # 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.
-    def capture
+    def capture_content
       original, @_output = output, Output.new
       yield
       original.widgets.concat(output.widgets) # todo: test!!!
@@ -171,11 +171,12 @@ module Erector
     ensure
       @_output = original
     end
+    alias_method :capture, :capture_content
 
     protected
     # executes this widget's #content method, which emits stuff onto the
     # output stream
-    def _render(options = {}, &block)
+    def _emit(options = {}, &block)
       @_block   = block if block
       @_parent  = options[:parent]  || parent
       @_helpers = options[:helpers] || parent
@@ -195,9 +196,9 @@ module Erector
       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,
+    # same as _emit, but using a parent widget's output stream and helpers
+    def _emit_via(parent, options = {}, &block)
+      _emit(options.merge(:parent  => parent,
                             :output  => parent.output,
                             :helpers => parent.helpers), &block)
     end

data/lib/erector/caching.rb

@@ -74,7 +74,7 @@ module Erector
     end
 
 protected
-    def _render(options = {})
+    def _emit(options = {})
       if should_cache?
         cache[self.class, assigns, options[:content_method_name]] ||= super
       else
@@ -82,7 +82,7 @@ protected
       end
     end
 
-    def _render_via(parent, options = {})
+    def _emit_via(parent, options = {})
       if should_cache?
         parent.output << cache[self.class, assigns, options[:content_method_name]] ||= parent.capture { super }
         parent.output.widgets << self.class # todo: test!!!

data/lib/erector/convenience.rb

@@ -4,7 +4,7 @@ module Erector
     # You may just want to call to_html(:prettyprint => true)
     # so you can pass in other rendering options as well.
     def to_pretty(options = {})
-      render(options.merge(:prettyprint => true))
+      emit(options.merge(:prettyprint => true))
     end
 
     # Render (like to_html) but stripping all tags and inserting some
@@ -57,6 +57,38 @@ module Erector
       a href, ({:href => href}.merge(options))
     end
 
+    # Emits a javascript block inside a +script+ tag, wrapped in CDATA
+    # doohickeys like all the cool JS kids do.
+    def javascript(value = nil, attributes = {})
+      if value.is_a?(Hash)
+        attributes = value
+        value      = nil
+      elsif block_given? && value
+        raise ArgumentError, "You can't pass both a block and a value to javascript -- please choose one."
+      end
+
+      script(attributes.merge(:type => "text/javascript")) do
+        # Shouldn't this be a "cdata" HtmlPart?
+        # (maybe, but the syntax is specific to javascript; it isn't
+        # really a generic XML CDATA section.  Specifically,
+        # ]]> within value is not treated as ending the
+        # CDATA section by Firefox2 when parsing text/html,
+        # although I guess we could refuse to generate ]]>
+        # there, for the benefit of XML/XHTML parsers).
+        output << raw("\n// <![CDATA[\n")
+        if block_given?
+          yield
+        else
+          output << raw(value)
+        end
+        output << raw("\n// ]]>")
+        output.append_newline # this forces a newline even if we're not in pretty mode
+      end
+
+      output << raw("\n")
+    end
+
+
     # makes a unique id based on the widget's class name and object id
     # that you can use as the HTML id of an emitted element
     def dom_id

data/lib/erector/erect/erect.rb

@@ -1,5 +1,6 @@
 require "optparse"
 require "erector/erect/erected"  # pull this out so we don't recreate the grammar every time
+require "fileutils"
 
 module Erector
 
@@ -129,7 +130,7 @@ module Erector
             widget = widget_class.new
             #todo: skip if it's missing a no-arg constructor
             dir = output_dir || File.dirname(file)
-            FileUtils.mkdir_p(dir)
+            ::FileUtils.mkdir_p(dir)
             output_file = "#{dir}/#{filename}.html"
             File.open(output_file, "w") do |f|
               f.puts widget.to_html

data/lib/erector/externals.rb

@@ -2,8 +2,8 @@ module Erector
 
   # Externals are a mechanism by which a widget can declare page-level
   # resources upon which it depends. They are not emitted during the widget's
-  # normal rendering process. Rather, the Erector::Widget::Page keeps track of
-  # all the widgets it renders, then goes back and inserts the proper tags for
+  # normal emiting process. Rather, the Erector::Widget::Page keeps track of
+  # all the widgets it emits, then goes back and inserts the proper tags for
   # all the externals inside its HEAD element.
   module Externals
     def self.included(base)
@@ -83,21 +83,21 @@ module Erector
       end
     end
 
-    def render_with_externals(options_to_external_renderer = {})
+    def render_with_externals(options_to_external_emiter = {})
       output = Erector::Output.new
-      self.to_a(:output => output) # render all the externals onto this new output buffer
+      self.to_a(:output => output) # emit all the externals onto this new output buffer
       nested_widgets = output.widgets.to_a
-      options_to_external_renderer = {:classes => nested_widgets}.merge(options_to_external_renderer)
-      renderer = ExternalRenderer.new(options_to_external_renderer)
-      externals = renderer.to_a(:output => output)
+      options_to_external_emiter = {:classes => nested_widgets}.merge(options_to_external_emiter)
+      emiter = ExternalRenderer.new(options_to_external_emiter)
+      externals = emiter.to_a(:output => output)
       output.to_a
     end
 
-    def render_externals(options_to_external_renderer = {})
+    def render_externals(options_to_external_emiter = {})
       output_for_externals = Erector::Output.new
       nested_widgets = output.widgets
-      externalizer = ExternalRenderer.new({:classes => nested_widgets}.merge(options_to_external_renderer))
-      externalizer._render(:output => output_for_externals)
+      externalizer = ExternalRenderer.new({:classes => nested_widgets}.merge(options_to_external_emiter))
+      externalizer._emit(:output => output_for_externals)
       output_for_externals.to_a
     end
   end

data/lib/erector/html_widget.rb

@@ -61,7 +61,7 @@ module Erector
     include Erector::HTML
     include Erector::Convenience
     include Erector::JQuery
-    include Erector::Sass if Object.const_defined?(:Sass)
+    include Erector::Sass
 
     tag 'area', :self_closing
     tag 'base', :self_closing
@@ -194,39 +194,6 @@ module Erector
     tag 'video'
 
 
-    # Emits a javascript block inside a +script+ tag, wrapped in CDATA
-    # doohickeys like all the cool JS kids do.
-    def javascript(value = nil, attributes = {})
-      if value.is_a?(Hash)
-        attributes = value
-        value      = nil
-      elsif block_given? && value
-        raise ArgumentError, "You can't pass both a block and a value to javascript -- please choose one."
-      end
-
-      script(attributes.merge(:type => "text/javascript")) do
-        # Shouldn't this be a "cdata" HtmlPart?
-        # (maybe, but the syntax is specific to javascript; it isn't
-        # really a generic XML CDATA section.  Specifically,
-        # ]]> within value is not treated as ending the
-        # CDATA section by Firefox2 when parsing text/html,
-        # although I guess we could refuse to generate ]]>
-        # there, for the benefit of XML/XHTML parsers).
-        output << raw("\n// <![CDATA[\n")
-        if block_given?
-          yield
-        else
-          output << raw(value)
-        end
-        output << raw("\n// ]]>")
-        output.append_newline # this forces a newline even if we're not in pretty mode
-      end
-
-      output << raw("\n")
-    end
-
-
-
     # alias for AbstractWidget#render
     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
@@ -243,53 +210,6 @@ module Erector
       to_html(*args)
     end
 
-
-    # Emits an XML instruction, which looks like this: <?xml version=\"1.0\" encoding=\"UTF-8\"?>
-    def instruct(attributes={:version => "1.0", :encoding => "UTF-8"})
-      output << raw("<?xml#{format_sorted(sort_for_xml_declaration(attributes))}?>")
-    end
-
-    # Emits an XML/HTML comment (&lt;!-- ... --&gt;) surrounding +text+ and/or
-    # the output of +block+. see
-    # http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4
-    #
-    # If +text+ is an Internet Explorer conditional comment condition such as
-    # "[if IE]", the output includes the opening condition and closing
-    # "[endif]". See http://www.quirksmode.org/css/condcom.html
-    #
-    # Since "Authors should avoid putting two or more adjacent hyphens inside
-    # comments," we emit a warning if you do that.
-    def comment(text = '')
-      puts "Warning: Authors should avoid putting two or more adjacent hyphens inside comments." if text =~ /--/
-
-      conditional = text =~ /\[if .*\]/
-
-      rawtext "<!--"
-      rawtext text
-      rawtext ">" if conditional
-
-      if block_given?
-        rawtext "\n"
-        yield
-        rawtext "\n"
-      end
-
-      rawtext "<![endif]" if conditional
-      rawtext "-->\n"
-    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
 
   public