RubyGems - arbre - Versions diffs - 0.0.1 → 1.0.0.rc1 - Mend

arbre 0.0.1 → 1.0.0.rc1

Files changed (49) hide show

data/.DS_Store +0 -0
data/.gitignore +3 -0
data/Gemfile +10 -1
data/README.rdoc +68 -2
data/arbre.gemspec +2 -0
data/lib/.DS_Store +0 -0
data/lib/arbre.rb +18 -0
data/lib/arbre/component.rb +22 -0
data/lib/arbre/context.rb +81 -0
data/lib/arbre/element.rb +182 -0
data/lib/arbre/element/builder_methods.rb +92 -0
data/lib/arbre/element_collection.rb +25 -0
data/lib/arbre/html/attributes.rb +20 -0
data/lib/arbre/html/class_list.rb +24 -0
data/lib/arbre/html/document.rb +42 -0
data/lib/arbre/html/html5_elements.rb +47 -0
data/lib/arbre/html/tag.rb +175 -0
data/lib/arbre/html/text_node.rb +35 -0
data/lib/arbre/rails.rb +5 -0
data/lib/arbre/rails/forms.rb +92 -0
data/lib/arbre/rails/rendering.rb +17 -0
data/lib/arbre/rails/template_handler.rb +15 -0
data/lib/arbre/version.rb +1 -1
data/spec/arbre/integration/html_spec.rb +241 -0
data/spec/arbre/unit/component.rb +23 -0
data/spec/arbre/unit/context_spec.rb +35 -0
data/spec/arbre/unit/element_finder_methods_spec.rb +101 -0
data/spec/arbre/unit/element_spec.rb +252 -0
data/spec/arbre/unit/html/tag_attributes_spec.rb +60 -0
data/spec/arbre/unit/html/tag_spec.rb +63 -0
data/spec/arbre/unit/html/text_node_spec.rb +5 -0
data/spec/rails/integration/forms_spec.rb +121 -0
data/spec/rails/integration/rendering_spec.rb +73 -0
data/spec/rails/rails_spec_helper.rb +45 -0
data/spec/rails/stub_app/config/database.yml +3 -0
data/spec/rails/stub_app/config/routes.rb +3 -0
data/spec/rails/stub_app/db/schema.rb +3 -0
data/spec/rails/stub_app/log/.gitignore +1 -0
data/spec/rails/stub_app/public/favicon.ico +0 -0
data/spec/rails/templates/arbre/_partial.arb +1 -0
data/spec/rails/templates/arbre/empty.arb +0 -0
data/spec/rails/templates/arbre/page_with_assignment.arb +1 -0
data/spec/rails/templates/arbre/page_with_erb_partial.arb +3 -0
data/spec/rails/templates/arbre/page_with_partial.arb +3 -0
data/spec/rails/templates/arbre/simple_page.arb +8 -0
data/spec/rails/templates/erb/_partial.erb +1 -0
data/spec/spec_helper.rb +7 -0
data/spec/support/bundle.rb +4 -0
metadata +101 -45

data/lib/arbre/element_collection.rb ADDED

@@ -0,0 +1,25 @@
+module Arbre
+  # Stores a collection of Element objects
+  class ElementCollection < Array
+    def +(other)
+      self.class.new(super)
+    end
+    def -(other)
+      self.class.new(super)
+    end
+    def &(other)
+      self.class.new(super)
+    end
+    def to_s
+      self.collect do |element|
+        element.to_s
+      end.join.html_safe
+    end
+  end
+end

data/lib/arbre/html/attributes.rb ADDED

@@ -0,0 +1,20 @@
+module Arbre
+  module HTML
+    class Attributes < Hash
+      def to_s
+        self.collect do |name, value|
+          "#{html_escape(name)}=\"#{html_escape(value)}\""
+        end.join(" ")
+      end
+      protected
+      def html_escape(s)
+        ERB::Util.html_escape(s)
+      end
+    end
+  end
+end

data/lib/arbre/html/class_list.rb ADDED

@@ -0,0 +1,24 @@
+require 'set'
+module Arbre
+  module HTML
+    # Holds a set of classes
+    class ClassList < Set
+      def add(class_names)
+        class_names.to_s.split(" ").each do |class_name|
+          super(class_name)
+        end
+        self
+      end
+      alias :<< :add
+      def to_s
+        to_a.join(" ")
+      end
+    end
+  end
+end

data/lib/arbre/html/document.rb ADDED

@@ -0,0 +1,42 @@
+module Arbre
+  module HTML
+    class Document < Tag
+      def build(*args)
+        super
+        build_head
+        build_body
+      end
+      def document
+        self
+      end
+      def tag_name
+        'html'
+      end
+      def doctype
+        '<!DOCTYPE html>'.html_safe
+      end
+      def to_s
+        doctype + super
+      end
+      protected
+      def build_head
+        @head = head do
+          meta :"http-equiv" => "Content-type", :content => "text/html; charset=utf-8"
+        end
+      end
+      def build_body
+        @body = body
+      end
+    end
+  end
+end

data/lib/arbre/html/html5_elements.rb ADDED

@@ -0,0 +1,47 @@
+module Arbre
+  module HTML
+    AUTO_BUILD_ELEMENTS = [ :a, :abbr, :address, :area, :article, :aside, :audio, :b, :base,
+                       :bdo, :blockquote, :body, :br, :button, :canvas, :caption, :cite,
+                       :code, :col, :colgroup, :command, :datalist, :dd, :del, :details,
+                       :dfn, :div, :dl, :dt, :em, :embed, :fieldset, :figcaption, :figure,
+                       :footer, :form, :h1, :h2, :h3, :h4, :h5, :h6, :head, :header, :hgroup,
+                       :hr, :html, :i, :iframe, :img, :input, :ins, :keygen, :kbd, :label,
+                       :legend, :li, :link, :map, :mark, :menu, :meta, :meter, :nav, :noscript,
+                       :object, :ol, :optgroup, :option, :output, :pre, :progress, :q,
+                       :s, :samp, :script, :section, :select, :small, :source, :span,
+                       :strong, :style, :sub, :summary, :sup, :table, :tbody, :td,
+                       :textarea, :tfoot, :th, :thead, :time, :title, :tr, :ul, :var, :video ]
+    HTML5_ELEMENTS = [ :p ] + AUTO_BUILD_ELEMENTS
+    AUTO_BUILD_ELEMENTS.each do |name|
+      class_eval <<-EOF
+        class #{name.to_s.capitalize} < Tag
+          builder_method :#{name}
+        end
+      EOF
+    end
+    class P < Tag
+      builder_method :para
+    end
+    class Table < Tag
+      def initialize(*)
+        super
+        set_table_tag_defaults
+      end
+      protected
+      # Set some good defaults for tables
+      def set_table_tag_defaults
+        set_attribute :border,      0
+        set_attribute :cellspacing, 0
+        set_attribute :cellpadding, 0
+      end
+    end
+  end
+end

data/lib/arbre/html/tag.rb ADDED

@@ -0,0 +1,175 @@
+require 'erb'
+module Arbre
+  module HTML
+    class Tag < Element
+      attr_reader :attributes
+      def initialize(*)
+        super
+        @attributes = Attributes.new
+      end
+      def build(*args)
+        super
+        attributes = extract_arguments(args)
+        self.content = args.first if args.first
+        set_for_attribute(attributes.delete(:for))
+        attributes.each do |key, value|
+          set_attribute(key, value)
+        end
+      end
+      def extract_arguments(args)
+        if args.last.is_a?(Hash)
+          args.pop
+        else
+          {}
+        end
+      end
+      def set_attribute(name, value)
+        @attributes[name.to_sym] = value
+      end
+      def get_attribute(name)
+        @attributes[name.to_sym]
+      end
+      alias :attr :get_attribute
+      def has_attribute?(name)
+        @attributes.has_key?(name.to_sym)
+      end
+      def remove_attribute(name)
+        @attributes.delete(name.to_sym)
+      end
+      def id
+        get_attribute(:id)
+      end
+      # Generates and id for the object if it doesn't exist already
+      def id!
+        return id if id
+        self.id = object_id.to_s
+        id
+      end
+      def id=(id)
+        set_attribute(:id, id)
+      end
+      def add_class(class_names)
+        class_list.add class_names
+      end
+      def remove_class(class_names)
+        class_list.delete(class_names)
+      end
+      # Returns a string of classes
+      def class_names
+        class_list.to_s
+      end
+      def class_list
+        get_attribute(:class) || set_attribute(:class, ClassList.new)
+      end
+      def to_s
+        indent(opening_tag, content, closing_tag).html_safe
+      end
+      private
+      def opening_tag
+        "<#{tag_name}#{attributes_html}>"
+      end
+      def closing_tag
+        "</#{tag_name}>"
+      end
+      INDENT_SIZE = 2
+      def indent(open_tag, child_content, close_tag)
+        spaces = ' ' * indent_level * INDENT_SIZE
+        html = ""
+        if no_child? || child_is_text?
+          if self_closing_tag?
+            html << spaces << open_tag.sub( />$/, '/>' )
+          else
+            # one line
+            html << spaces << open_tag << child_content << close_tag
+          end
+        else
+          # multiple lines
+          html << spaces << open_tag << "\n"
+          html << child_content # the child takes care of its own spaces
+          html << spaces << close_tag
+        end
+        html << "\n"
+        html
+      end
+      def self_closing_tag?
+        %w|meta link|.include?(tag_name)
+      end
+      def no_child?
+        children.empty?
+      end
+      def child_is_text?
+        children.size == 1 && children.first.is_a?(TextNode)
+      end
+      def attributes_html
+        attributes.any? ? " " + attributes.to_s : nil
+      end
+      def set_for_attribute(record)
+        return unless record
+        # set_attribute :id, ActionController::RecordIdentifier.dom_id(record, default_id_for_prefix)
+        # add_class ActionController::RecordIdentifier.dom_class(record)
+        set_attribute :id, dom_id_for(record)
+        add_class dom_class_name_for(record)
+      end
+      def dom_class_name_for(record)
+        if record.class.respond_to?(:model_name)
+          record.class.model_name.singular
+        else
+          record.class.underscore.gsub("/", "_")
+        end
+      end
+      def dom_id_for(record)
+        id = if record.respond_to?(:to_key)
+               record.to_key
+             elsif record.respond_to?(:id)
+               record.id
+             else
+               record.object_id
+             end
+        [dom_class_name_for(record), id].join("_")
+      end
+      def default_id_for_prefix
+        nil
+      end
+    end
+  end
+end

data/lib/arbre/html/text_node.rb ADDED

@@ -0,0 +1,35 @@
+require 'erb'
+module Arbre
+  module HTML
+    class TextNode < Element
+      builder_method :text_node
+      # Builds a text node from a string
+      def self.from_string(string)
+        node = new
+        node.build(string)
+        node
+      end
+      def add_child(*args)
+        raise "TextNodes do not have children"
+      end
+      def build(string)
+        @content = string
+      end
+      def tag_name
+        nil
+      end
+      def to_s
+        ERB::Util.html_escape(@content.to_s)
+      end
+    end
+  end
+end

data/lib/arbre/rails.rb ADDED

@@ -0,0 +1,5 @@
+require 'arbre/rails/template_handler'
+require 'arbre/rails/forms'
+require 'arbre/rails/rendering'
+Arbre::Element.send :include, Arbre::Rails::Rendering

data/lib/arbre/rails/forms.rb ADDED

@@ -0,0 +1,92 @@
+module SplitOpenAndCloseOn
+  def split_open_and_close_on(string, match)
+    return "" unless string && match
+    @opening_tag = string.split(Regexp.new("#{match}\\z")).first
+    @closing_tag = match
+  end
+  def opening_tag
+    @opening_tag || ""
+  end
+  def closing_tag
+    @closing_tag || ""
+  end
+end
+class FormBuilderProxy < Arbre::Component
+  attr_reader :form_builder
+  # Since label and select are Arbre Elements already, we must
+  # override it here instead of letting method_missing
+  # deal with it
+  def label(*args)
+    proxy_call_to_form :label, *args
+  end
+  def select(*args)
+    proxy_call_to_form :select, *args
+  end
+  def respond_to?(name)
+    if form_builder && form_builder.respond_to?(name)
+      true
+    else
+      super
+    end
+  end
+  private
+  def proxy_call_to_form(method, *args, &block)
+    text_node form_builder.send(method, *args, &block)
+  end
+  def method_missing(method, *args, &block)
+    if form_builder && form_builder.respond_to?(method)
+      proxy_call_to_form(method, *args, &block)
+    else
+      super
+    end
+  end
+end
+class FormForProxy < FormBuilderProxy
+  builder_method :form_for
+  include SplitOpenAndCloseOn
+  def build(resource, form_options = {}, &block)
+    form_string = helpers.form_for(resource, form_options) do |f|
+      @form_builder = f
+    end
+    split_open_and_close_on form_string, "</form>"
+    super(&block)
+  end
+  def fields_for(*args, &block)
+    insert_tag FieldsForProxy, form_builder, *args, &block
+  end
+end
+class FieldsForProxy < FormBuilderProxy
+  def build(form_builder, *args, &block)
+    form_builder.fields_for(*args) do |f|
+      @form_builder = f
+    end
+    super(&block)
+  end
+  def to_s
+    children.to_s
+  end
+end