pakyow-presenter 0.8.rc4 → 0.8.0

data/pakyow-presenter/lib/presenter/view.rb

@@ -2,6 +2,9 @@ module Pakyow
   module Presenter
     class View
       include DocHelpers
+      include TitleHelpers
+
+      PARTIAL_REGEX = /<!--\s*@include\s*([a-zA-Z0-9\-_]*)\s*-->/
 
       class << self
         attr_accessor :binders
@@ -19,15 +22,9 @@ module Pakyow
         end
       end
 
-      attr_accessor :doc, :scoped_as, :scopes, :related_views
+      attr_accessor :doc, :scoped_as, :scopes, :related_views, :context, :composer
       attr_writer   :bindings
 
-      def dup
-        view = self.class.from_doc(@doc.dup)
-        view.scoped_as = scoped_as
-        return view
-      end
-
       def initialize(contents = '', format = :html)
         @related_views = []
 
@@ -40,6 +37,15 @@ module Pakyow
         end
       end
 
+      def initialize_copy(original_view)
+        super
+
+        @doc = original_view.doc.dup
+        @scoped_as = original_view.scoped_as
+        @context = @context
+        @composer = @composer
+      end
+
       def self.from_doc(doc)
         view = self.new
         view.doc = doc
@@ -47,35 +53,20 @@ module Pakyow
       end
 
       def self.load(path)
-        format    = StringUtils.split_at_last_dot(path)[-1]
+        format    = Utils::String.split_at_last_dot(path)[-1]
         contents  = File.read(path)
 
         return self.new(contents, format)
       end
 
-      def title=(title)
-        if @doc
-          if o = @doc.css('title').first
-            o.inner_html = Nokogiri::HTML::fragment(title)
-          else
-            if o = @doc.css('head').first
-              o.add_child(Nokogiri::HTML::fragment("<title>#{title}</title>"))
-            end
-          end
-        end
-      end
-
-      def title
-        o = @doc.css('title').first
-        o.inner_html if o
-      end
-
       # Allows multiple attributes to be set at once.
       # root_view.find(selector).attributes(:class => my_class, :style => my_style)
       #
       def attributes(attrs = {})
+        #TODO this is not invalidating composer
+
         if attrs.empty?
-          return Attributes.new(self.doc)
+          return Attributes.new(self.doc, @composer)
         else
           self.bind_attributes_to_doc(attrs, doc)
         end
@@ -84,8 +75,14 @@ module Pakyow
       alias :attrs :attributes
 
       def remove
-        self.doc.remove
-        self.refind_significant_nodes
+        if doc.parent.nil?
+          # best we can do is to remove the children
+          doc.children.remove
+        else
+          doc.remove
+        end
+
+        invalidate!
       end
 
       alias :delete :remove
@@ -93,7 +90,7 @@ module Pakyow
       def clear
         return if self.doc.blank?
         self.doc.inner_html = ''
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def text
@@ -103,7 +100,7 @@ module Pakyow
       def text=(text)
         text = text.call(self.text) if text.is_a?(Proc)
         self.doc.content = text.to_s
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def html
@@ -113,7 +110,7 @@ module Pakyow
       def html=(html)
         html = html.call(self.html) if html.is_a?(Proc)
         self.doc.inner_html = Nokogiri::HTML.fragment(html.to_s)
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def append(view)
@@ -124,7 +121,7 @@ module Pakyow
         self.doc.add_child(view.doc)
 
         self.update_binding_offset_at_path(num, path)
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def prepend(view)
@@ -139,7 +136,7 @@ module Pakyow
         end
 
         self.update_binding_offset_at_path(num, path)
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def after(view)
@@ -150,7 +147,7 @@ module Pakyow
         self.doc.after(view.doc)
 
         self.update_binding_offset_at_path(num, path)
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def before(view)
@@ -161,22 +158,35 @@ module Pakyow
         self.doc.before(view.doc)
 
         self.update_binding_offset_at_path(num, path)
-        self.refind_significant_nodes
+        self.invalidate!
       end
 
       def replace(view)
-        doc.replace(view)
+        view = view.doc if view.is_a?(View)
+
+        if doc.parent.nil?
+          doc.children.remove
+          doc.inner_html = view
+        else
+          doc.replace(view)
+        end
+
+        invalidate!
       end
 
       def scope(name)
         name = name.to_sym
 
         views = ViewCollection.new
+        views.context = @context
+        views.composer = @composer
         self.bindings.select{|b| b[:scope] == name}.each{|s|
           v = self.view_from_path(s[:path])
 
           v.bindings = self.update_binding_paths_from_path([s].concat(s[:nested_bindings]), s[:path])
           v.scoped_as = s[:scope]
+          v.context = @context
+          v.composer = @composer
 
           views << v
         }
@@ -188,6 +198,8 @@ module Pakyow
         name = name.to_sym
 
         views = ViewCollection.new
+        views.context = @context
+        views.composer = @composer
 
         if binding = self.bindings.select{|binding| binding[:scope] == self.scoped_as}[0]
           binding[:props].each {|prop|
@@ -195,6 +207,8 @@ module Pakyow
               v = self.view_from_path(prop[:path])
 
               v.scoped_as = self.scoped_as
+              v.context = @context
+              v.composer = @composer
               views << v
             end
           }
@@ -208,11 +222,13 @@ module Pakyow
       #
       # Creates a context in which view manipulations can be performed.
       #
-      # Unlike previous versions, the context can only be referenced by the
-      # block argument. No `context` method will be available.s
-      #
-      def with
-        yield(self)
+      def with(&block)
+        if block.arity == 0
+          self.instance_exec(&block)
+        else
+          yield(self)
+        end
+
         self
       end
 
@@ -228,7 +244,27 @@ module Pakyow
       def for(data, &block)
         data = data.to_a if data.is_a?(Enumerator)
         data = [data] if (!data.is_a?(Enumerable) || data.is_a?(Hash))
-        block.call(self, data[0], 0) if block_given?
+
+        if block.arity == 1
+          self.instance_exec(data[0], &block)
+        else
+          block.call(self, data[0])
+        end
+      end
+
+      # call-seq:
+      #   for_with_index {|view, datum, i| block}
+      #
+      # Yields a view, its matching dataum, and the index. See #for.
+      #
+      def for_with_index(data, &block)
+        self.for(data) do |ctx, datum|
+          if block.arity == 2
+            ctx.instance_exec(datum, 0, &block)
+          else
+            block.call(ctx, datum, 0)
+          end
+        end
       end
 
       # call-seq:
@@ -243,6 +279,8 @@ module Pakyow
         data = [data] if (!data.is_a?(Enumerable) || data.is_a?(Hash))
 
         views = ViewCollection.new
+        views.context = @context
+        views.composer = @composer
         data.each {|datum|
           d_v = self.doc.dup
           self.doc.before(d_v)
@@ -250,6 +288,8 @@ module Pakyow
           v = View.from_doc(d_v)
           v.bindings = self.bindings.dup
           v.scoped_as = self.scoped_as
+          v.context = @context
+          v.composer = @composer
 
           views << v
         }
@@ -267,16 +307,51 @@ module Pakyow
         self.match(data).for(data, &block)
       end
 
+      # call-seq:
+      #   repeat_with_index(data) {|view, datum, i| block}
+      #
+      # Matches self with data and yields a view/datum pair with index.
+      #
+      def repeat_with_index(data, &block)
+        self.match(data).for_with_index(data, &block)
+      end
+
       # call-seq:
       #   bind(data)
       #
       # Binds data across existing scopes.
       #
       def bind(data, bindings = {}, &block)
+        data = data.to_a if data.is_a?(Enumerator)
+        data = [data] if (!data.is_a?(Enumerable) || data.is_a?(Hash))
+
         scope_info = self.bindings.first
 
-        self.bind_data_to_scope(data, scope_info, bindings)
-        yield(self, data, 0) if block_given?
+        self.bind_data_to_scope(data[0], scope_info, bindings)
+        invalidate!(true)
+
+        return if block.nil?
+
+        if block.arity == 1
+          self.instance_exec(data[0], &block)
+        else
+          block.call(self, data[0])
+        end
+      end
+
+      # call-seq:
+      #   bind_with_index(data)
+      #
+      # Binds data across existing scopes, yielding a view/datum pair with index.
+      #
+      def bind_with_index(data, bindings = {}, &block)
+        self.bind(data) do |ctx, datum|
+          if block.arity == 2
+            ctx.instance_exec(datum, 0, &block)
+          else
+            block.call(ctx, datum, 0)
+          end
+        end
       end
 
       # call-seq:
@@ -285,15 +360,74 @@ module Pakyow
       # Matches self to data then binds data to the view.
       #
       def apply(data, bindings = {}, &block)
-        views = self.match(data).bind(data, bindings, &block)
+        self.match(data).bind(data, bindings, &block)
       end
 
       def bindings(refind = false)
         @bindings = (!@bindings || refind) ? self.find_bindings : @bindings
       end
 
+      def includes(partial_map)
+        partial_map = partial_map.dup
+
+        # mixin all the partials
+        partials.each do |partial|
+          partial[1].replace(partial_map[partial[0]].to_s)
+        end
+
+        # now delete them from the map
+        partials.each do |partial|
+          partial_map.delete(partial[0])
+        end
+
+        # we have more partials
+        if partial_map.count > 0
+          # initiate another build if content contains partials
+          includes(partial_map) if partials(true).count > 0
+        end
+
+        return self
+      end
+
+      def invalidate!(composer_only = false)
+        self.bindings(true) unless composer_only
+        @composer.dirty! unless @composer.nil?
+
+        @related_views.each {|v|
+          v.invalidate!(composer_only)
+        }
+      end
+
       protected
 
+      def partials(refind = false)
+        @partials = (!@partials || refind) ? find_partials : @partials
+      end
+
+      def partials_in(content)
+        partials = []
+
+        content.scan(PARTIAL_REGEX) do |m|
+          partials << m[0].to_sym
+        end
+
+        return partials
+      end
+
+      def find_partials
+        partials = []
+
+        @doc.traverse { |e|
+          next unless e.is_a?(Nokogiri::XML::Comment)
+          next unless match = e.to_html.strip.match(PARTIAL_REGEX)
+
+          name = match[1]
+          partials << [name.to_sym, e]
+        }
+
+        return partials
+      end
+
       # populates the root_view using view_store data by recursively building
       # and substituting in child views named in the structure
       def populate_view(root_view, view_store, view_info)
@@ -301,6 +435,8 @@ module Pakyow
           next unless path = view_info[e[:name]]
 
           v = self.populate_view(View.new(path, view_store), view_store, view_info)
+          v.context = @context
+          v.composer = @composer
           self.reset_container(e[:doc])
           self.add_content_to_container(v, e[:doc])
         }
@@ -325,7 +461,7 @@ module Pakyow
             # this is the root node, which we need as the first hash in the
             # list of bindings, but we don't want to nest other scopes inside
             # of it in this case
-            bindings.last[:nested_bindings] = {}
+            bindings.last[:nested_bindings] = []
           else
             bindings.last[:nested_bindings] = find_bindings(o, true)
             # reject so children aren't traversed
@@ -334,12 +470,14 @@ module Pakyow
         }
 
         # find unscoped props
-        bindings.unshift({
-          :scope => nil,
-          :path => [],
-          :props => find_props(doc),
-          :nested_bindings => {}
-        })
+        unless doc[Config::Presenter.scope_attribute]
+          bindings.unshift({
+            :scope => nil,
+            :path => [],
+            :props => find_props(doc),
+            :nested_bindings => []
+          })
+        end
 
         return bindings
       end
@@ -388,42 +526,42 @@ module Pakyow
         }
       end
 
-      def refind_significant_nodes
-        self.bindings(true)
-
-        @related_views.each {|v|
-          v.refind_significant_nodes
-        }
-      end
-
       def bind_data_to_scope(data, scope_info, bindings = {})
         return unless data
 
         scope = scope_info[:scope]
 
-        # handle root binding
-        if value = Pakyow.app.presenter.binder.value_for_prop(:_root, scope, data, bindings)
-          value.is_a?(Hash) ? self.bind_attributes_to_doc(value, self.doc) : self.bind_value_to_doc(value, self.doc)
-        end
+        bind_data_to_root(data, scope, bindings)
 
-        scope_info[:props].each {|prop_info|
+        scope_info[:props].each { |prop_info|
           catch(:unbound) {
             prop = prop_info[:prop]
 
-            self.handle_unbound_data(scope, prop) unless data_has_prop?(data, prop) || Pakyow.app.presenter.binder.has_prop?(prop, scope, bindings)
-            value = Pakyow.app.presenter.binder.value_for_prop(prop, scope, data, bindings)
+            if data_has_prop?(data, prop) || Pakyow.app.presenter.binder.has_prop?(prop, scope, bindings)
+              value = Pakyow.app.presenter.binder.value_for_prop(prop, scope, data, bindings, context)
+              doc = doc_from_path(prop_info[:path])
 
-            doc = doc_from_path(prop_info[:path])
-
-            # handle form field
-            self.bind_to_form_field(doc, scope, prop, value, data) if View.form_field?(doc.name)
+              if View.form_field?(doc.name)
+                bind_to_form_field(doc, scope, prop, value, data)
+              end
 
-            # bind attributes or value
-            value.is_a?(Hash) ? self.bind_attributes_to_doc(value, doc) : self.bind_value_to_doc(value, doc)
+              bind_data_to_doc(doc, value)
+            else
+              handle_unbound_data(scope, prop)
+            end
           }
         }
       end
 
+      def bind_data_to_root(data, scope, bindings)
+        return unless value = Pakyow.app.presenter.binder.value_for_prop(:_root, scope, data, bindings, context)
+        value.is_a?(Hash) ? self.bind_attributes_to_doc(value, self.doc) : self.bind_value_to_doc(value, self.doc)
+      end
+
+      def bind_data_to_doc(doc, data)
+        data.is_a?(Hash) ? self.bind_attributes_to_doc(data, doc) : self.bind_value_to_doc(data, doc)
+      end
+
       def data_has_prop?(data, prop)
         (data.is_a?(Hash) && (data.key?(prop) || data.key?(prop.to_s))) || (!data.is_a?(Hash) && data.class.method_defined?(prop))
       end
@@ -433,6 +571,7 @@ module Pakyow
 
         tag = doc.name
         return if View.tag_without_value?(tag)
+
         if View.self_closing_tag?(tag)
           # don't override value if set
           if !doc['value'] || doc['value'].empty?
@@ -458,72 +597,89 @@ module Pakyow
           attr = attr.to_s
           attrs = Attributes.new(doc)
           v = v.call(attrs.send(attr)) if v.is_a?(Proc)
-          v.nil? ? doc.remove_attribute(attr) : attrs.send(:"#{attr}=", v)
+
+          if v.nil?
+            doc.remove_attribute(attr)
+          else
+            attrs.send(:"#{attr}=", v)
+          end
         end
       end
 
       def bind_to_form_field(doc, scope, prop, value, bindable)
-
-        # don't overwrite the name if already defined
-        if !doc['name'] || doc['name'].empty?
-          # set name on form element
-          doc['name'] = "#{scope}[#{prop}]"
-        end
+        set_form_field_name(doc, scope, prop)
 
         # special binding for checkboxes and radio buttons
         if doc.name == 'input' && (doc[:type] == 'checkbox' || doc[:type] == 'radio')
-          if value == true || (doc[:value] && doc[:value] == value.to_s)
-            doc[:checked] = 'checked'
-          else
-            doc.delete('checked')
-          end
-
-          # coerce to string since booleans are often used
-          # and fail when binding to a view
-          value = value.to_s
+          bind_to_checked_field(doc, value)
         # special binding for selects
         elsif doc.name == 'select'
-          if options = Pakyow.app.presenter.binder.options_for_prop(prop, scope, bindable)
-            option_nodes = Nokogiri::HTML::DocumentFragment.parse ""
-            Nokogiri::HTML::Builder.with(option_nodes) do |h|
-              until options.length == 0
-                catch :optgroup do
-                  o = options.first
-
-                  # an array containing value/content
-                  if o.is_a?(Array)
-                    h.option o[1], :value => o[0]
+          bind_to_select_field(doc, scope, prop, value, bindable)
+        end
+      end
+
+      def bind_to_checked_field(doc, value)
+        if value == true || (doc[:value] && doc[:value] == value.to_s)
+          doc[:checked] = 'checked'
+        else
+          doc.delete('checked')
+        end
+
+        # coerce to string since booleans are often used and fail when binding to a view
+        value = value.to_s
+      end
+
+      def bind_to_select_field(doc, scope, prop, value, bindable)
+        create_select_options(doc, scope, prop, value, bindable)
+        select_option_with_value(doc, value)
+      end
+
+      def set_form_field_name(doc, scope, prop)
+        return if doc['name'] && !doc['name'].empty? # don't overwrite the name if already defined
+        doc['name'] = "#{scope}[#{prop}]"
+      end
+
+      def create_select_options(doc, scope, prop, value, bindable)
+        return unless options = Pakyow.app.presenter.binder.options_for_prop(prop, scope, bindable, context)
+
+        option_nodes = Nokogiri::HTML::DocumentFragment.parse ""
+        Nokogiri::HTML::Builder.with(option_nodes) do |h|
+          until options.length == 0
+            catch :optgroup do
+              o = options.first
+
+              # an array containing value/content
+              if o.is_a?(Array)
+                h.option o[1], :value => o[0]
+                options.shift
+                # likely an object (e.g. string); start a group
+              else
+                h.optgroup(:label => o) {
+                  options.shift
+
+                  options[0..-1].each_with_index { |o2,i2|
+                    # starting a new group
+                    throw :optgroup if !o2.is_a?(Array)
+
+                    h.option o2[1], :value => o2[0]
                     options.shift
-                  # likely an object (e.g. string); start a group
-                  else
-                    h.optgroup(:label => o) {
-                      options.shift
-
-                      options[0..-1].each_with_index { |o2,i2|
-                        # starting a new group
-                        throw :optgroup if !o2.is_a?(Array)
-
-                        h.option o2[1], :value => o2[0]
-                        options.shift
-                      }
-                    }
-                  end
-                end
+                  }
+                }
               end
             end
+          end
+        end
 
-            # remove existing options
-            doc.children.remove
+        # remove existing options
+        doc.children.remove
 
-            # add generated options
-            doc.add_child(option_nodes)
-          end
+        # add generated options
+        doc.add_child(option_nodes)
+      end
 
-          # select appropriate option
-          if o = doc.css('option[value="' + value.to_s + '"]').first
-            o[:selected] = 'selected'
-          end
-        end
+      def select_option_with_value(doc, value)
+        return unless o = doc.css('option[value="' + value.to_s + '"]').first
+        o[:selected] = 'selected'
       end
 
       def handle_unbound_data(scope, prop)