RubyGems - honkster-erector - Versions diffs - 0.8.1 - Mend

honkster-erector 0.8.1

Files changed (71) hide show

data/README.txt +116 -0
data/VERSION.yml +4 -0
data/bin/erector +14 -0
data/lib/erector.rb +34 -0
data/lib/erector/abstract_widget.rb +172 -0
data/lib/erector/after_initialize.rb +34 -0
data/lib/erector/caching.rb +93 -0
data/lib/erector/convenience.rb +58 -0
data/lib/erector/dependencies.rb +24 -0
data/lib/erector/dependency.rb +30 -0
data/lib/erector/erect/erect.rb +160 -0
data/lib/erector/erect/erected.rb +75 -0
data/lib/erector/erect/indenting.rb +36 -0
data/lib/erector/erect/rhtml.treetop +233 -0
data/lib/erector/errors.rb +12 -0
data/lib/erector/extensions/hash.rb +21 -0
data/lib/erector/extensions/object.rb +18 -0
data/lib/erector/externals.rb +97 -0
data/lib/erector/html.rb +352 -0
data/lib/erector/inline.rb +37 -0
data/lib/erector/jquery.rb +36 -0
data/lib/erector/mixin.rb +12 -0
data/lib/erector/needs.rb +94 -0
data/lib/erector/output.rb +117 -0
data/lib/erector/rails.rb +27 -0
data/lib/erector/rails/extensions/action_controller.rb +16 -0
data/lib/erector/rails/extensions/rails_helpers.rb +159 -0
data/lib/erector/rails/extensions/rails_widget.rb +126 -0
data/lib/erector/rails/rails_form_builder.rb +24 -0
data/lib/erector/rails/rails_version.rb +6 -0
data/lib/erector/rails/template_handlers/ert_handler.rb +32 -0
data/lib/erector/rails/template_handlers/rb_handler.rb +52 -0
data/lib/erector/raw_string.rb +8 -0
data/lib/erector/sass.rb +22 -0
data/lib/erector/unicode.rb +18185 -0
data/lib/erector/unicode_builder.rb +67 -0
data/lib/erector/version.rb +12 -0
data/lib/erector/widget.rb +54 -0
data/lib/erector/widgets.rb +6 -0
data/lib/erector/widgets/environment_badge.rb +29 -0
data/lib/erector/widgets/external_renderer.rb +51 -0
data/lib/erector/widgets/field_table.rb +110 -0
data/lib/erector/widgets/form.rb +30 -0
data/lib/erector/widgets/page.rb +165 -0
data/lib/erector/widgets/table.rb +104 -0
data/rails/init.rb +4 -0
data/spec/erect/erect_rails_spec.rb +114 -0
data/spec/erect/erect_spec.rb +175 -0
data/spec/erect/erected_spec.rb +164 -0
data/spec/erect/rhtml_parser_spec.rb +361 -0
data/spec/erector/caching_spec.rb +269 -0
data/spec/erector/convenience_spec.rb +259 -0
data/spec/erector/dependency_spec.rb +67 -0
data/spec/erector/externals_spec.rb +236 -0
data/spec/erector/html_spec.rb +509 -0
data/spec/erector/indentation_spec.rb +211 -0
data/spec/erector/inline_spec.rb +94 -0
data/spec/erector/jquery_spec.rb +35 -0
data/spec/erector/mixin_spec.rb +65 -0
data/spec/erector/needs_spec.rb +120 -0
data/spec/erector/output_spec.rb +199 -0
data/spec/erector/sample-file.txt +1 -0
data/spec/erector/sass_spec.rb +33 -0
data/spec/erector/unicode_builder_spec.rb +75 -0
data/spec/erector/widget_spec.rb +250 -0
data/spec/erector/widgets/field_table_spec.rb +133 -0
data/spec/erector/widgets/form_spec.rb +31 -0
data/spec/erector/widgets/page_spec.rb +85 -0
data/spec/erector/widgets/table_spec.rb +99 -0
data/spec/spec_helper.rb +95 -0
metadata +191 -0

data/README.txt ADDED Viewed

@@ -0,0 +1,116 @@
+= Erector
+* http://erector.rubyforge.org
+* mailto:erector@googlegroups.com
+* 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.
+No, seriously, we've got hella docs at http://erector.rubyforge.org -- go
+check it out.
+== SYNOPSIS
+    require 'erector'
+    class Hello < Erector::Widget
+      def content
+        html do
+          head do
+            title "Hello"
+          end
+          body do
+            text "Hello, "
+            b @target, :class => 'big'
+            text "!"
+          end
+        end
+      end
+    end
+    Hello.new(:target => 'world').to_html
+    => "<html><head><title>Hello</title></head><body>Hello, <b class=\"big\">world</b>!</body></html>"
+    include Erector::Mixin
+    erector { div "love", :class => "big" }
+    => "<div class=\"big\">love</div>"
+== 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
+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).
+== TESTS
+Three spec rake tasks are provided: spec:core (core functionality),
+spec:erect (the erector command line tool), and spec:rails (rails integration).
+You do not need to have Rails installed to run the latter two; they will clone
+the rails git repository and set it up for testing automatically. You can test
+against a different version of Rails by changing the constants in
+lib/erector/rails/rails_version.rb
+'rake spec' will run the complete set of specs.
+== CREDITS:
+Core Team:
+* Alex Chaffee
+* Brian Takita
+Special Thanks To:
+* Abby (Chaffee's muse & Best friend)
+* Jim Kingdon
+* Jeff Dean
+* John Firebaugh
+* Nathan Sobo
+* Nick Kallen
+* Alon Salant
+* Andy Peterson
+== LICENSE:
+(The MIT License)
+Copyright (c) 2007-2010 Pivotal Labs and the Erector Project
+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: 8
+:patch: 1

data/bin/erector ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+begin
+  require 'erector'
+rescue LoadError
+  require 'rubygems'
+  require 'erector'
+end
+require 'erector/erect/erect'
+unless Erector::Erect.new(ARGV).run
+  exit 1
+end

data/lib/erector.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module Erector
+end
+require "cgi"
+require "yaml"
+begin
+  require "sass"
+rescue LoadError => e
+  # oh well, no Sass
+end
+require "erector/errors"
+require "erector/extensions/object"
+require "erector/extensions/hash"
+require "erector/raw_string"
+require "erector/dependencies"
+require "erector/dependency"
+require "erector/externals"
+require "erector/output"
+require "erector/caching"
+require "erector/after_initialize"
+require "erector/needs"
+require "erector/html"
+require "erector/convenience"
+require "erector/jquery"
+require "erector/sass"
+require "erector/abstract_widget"
+require "erector/widget"
+require "erector/inline"
+require "erector/unicode"
+require "erector/widgets"
+require "erector/version"
+require "erector/mixin"

data/lib/erector/abstract_widget.rb ADDED Viewed

@@ -0,0 +1,172 @@
+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.
+  class AbstractWidget
+    @@prettyprint_default = false
+    def prettyprint_default
+      @@prettyprint_default
+    end
+    def self.prettyprint_default
+      @@prettyprint_default
+    end
+    def self.prettyprint_default=(enabled)
+      @@prettyprint_default = enabled
+    end
+    def self.inline(*args, &block)
+      Class.new(self) do
+        include Erector::Inline
+      end.new(*args, &block)
+    end
+    [:helpers, :assigns, :output, :parent, :block].each do |attr|
+      class_eval(<<-SRC, __FILE__, __LINE__ + 1)
+        def #{attr}
+          @_#{attr}
+        end
+      SRC
+    end
+    def initialize(assigns = {}, &block)
+      unless assigns.is_a? Hash
+        raise "Erector widgets are initialized with only a parameter hash. (Other parameters are passed to to_html, or the #widget method.)"
+      end
+      @_assigns = assigns
+      assigns.each do |name, value|
+        instance_variable_set(name.to_s[0..0] == '@' ? name : "@#{name}", value)
+      end
+      @_parent = eval("self", block.binding) if block
+      @_block = block
+    end
+    # Entry point for rendering a widget (and all its children). This method
+    # creates a new output string (if necessary), calls this widget's #content
+    # method and returns the string.
+    #
+    # Options:
+    # output:: the string 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).
+    # 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.
+    # 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
+      _render(options).to_s
+    end
+    # alias for #to_html
+    # @deprecated Please use {#to_html} 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}"
+        @@already_warned_to_s = true
+      end
+      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).
+    #
+    # # Options: see #to_html
+    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
+    # +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
+    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
+    # 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
+    # to instance variables and methods of the calling object.
+    #
+    # 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
+    end
+    # Emits a (nested) widget onto the current widget's output stream. Accepts
+    # either a class or an instance. If the first argument is a class, then
+    # 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.
+    #
+    # 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
+    # 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)
+      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)
+      end
+    end
+    # 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.
+    def capture
+      original, @_output = output, Output.new
+      yield
+      original.widgets.concat(output.widgets) # todo: test!!!
+      output.to_s
+    ensure
+      @_output = original
+    end
+    protected
+    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)
+      output.widgets << self.class
+      send(options[:content_method_name] || :content)
+      output
+    end
+    def _render_via(parent, options = {}, &block)
+      _render(options.merge(:parent  => parent,
+                            :output  => parent.output,
+                            :helpers => parent.helpers), &block)
+    end
+  end
+end

data/lib/erector/after_initialize.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module Erector
+  module AfterInitialize
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    module ClassMethods
+      def after_initialize(instance=nil, &blk)
+        if blk
+          after_initialize_parts << blk
+        elsif instance
+          if superclass.respond_to?(:after_initialize)
+            superclass.after_initialize instance
+          end
+          after_initialize_parts.each do |part|
+            instance.instance_eval &part
+          end
+        else
+          raise ArgumentError, "You must provide either an instance or a block"
+        end
+      end
+      protected
+      def after_initialize_parts
+        @after_initialize_parts ||= []
+      end
+    end
+    def initialize(*args, &blk)
+      super
+      self.class.after_initialize self
+    end
+  end
+end

data/lib/erector/caching.rb ADDED Viewed

@@ -0,0 +1,93 @@
+module Erector
+  class Cache
+    def initialize
+      @stores = {}
+    end
+    def store_for(klass)
+      @stores[klass] ||= Hash.new {|h,k| h[k] = {}}
+    end
+    def []=(*args)
+      value = args.pop
+      klass = args.shift
+      params = args.first.is_a?(Hash) ? args.first : {}
+      content_method = args.last.is_a?(Symbol) ? args.last : nil
+      store_for(klass)[key(params)][content_method] = value
+    end
+    def [](klass, params = {}, content_method = nil)
+      store_for(klass)[key(params)][content_method]
+    end
+    def delete(klass, params = {})
+      store_for(klass).delete(key(params))
+    end
+    def delete_all(klass)
+      @stores.delete(klass)
+    end
+    # convert hash-key to array-key for compatibility with 1.8.6
+    def key(params)
+      params.to_a
+    end
+  end
+  module Caching
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    module ClassMethods
+      def cacheable(value = true)
+        @cachable = value
+      end
+      def cachable(value = true)
+        @cachable = value
+      end
+      def cachable?
+        if @cachable.nil?
+          superclass.respond_to?(:cachable?) && superclass.cachable?
+        else
+          @cachable
+        end
+      end
+      def cache
+        @@cache ||= nil
+      end
+      def cache=(c)
+        @@cache = c
+      end
+    end
+    def cache
+      self.class.cache
+    end
+    def should_cache?
+      cache && block.nil? && self.class.cachable?
+    end
+    def _render(options = {})
+      if should_cache?
+        cache[self.class, assigns, options[:content_method_name]] ||= super
+      else
+        super
+      end
+    end
+    def _render_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!!!
+      else
+        super
+      end
+    end
+  end
+end