pakyow-presenter 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 833e0e238ad912016ef2aa6b0a0745754a6507b3
-  data.tar.gz: d73f4a20f79596cb69f34d11a43ef9c1ebd2eac9
+  metadata.gz: f3b7aee6ee2692ce29bd4e2bdaa323fae1aedef3
+  data.tar.gz: 1e743f0597314c2a52fcc32a2c4f490b62eb1db8
 SHA512:
-  metadata.gz: bab66d8a3f87d2c57b67e2cc4670d401b229c1c1fff8b2e1e0c87a286170d5d722893ab2d90d77bd2a3e96eb405d076fcfeaf0b8d9b6d4db3115ce780bafc04b
-  data.tar.gz: 5fa4f5ee5cebed37990c3299e91652c7f23a763b726106309449e4104d14bc75dbd351bc4cdc63148f343418b7445b4c7a847bbd4ecb1333e987224d15e083bd
+  metadata.gz: dd7aa6575f476fe52a680d9b7fe0a4465337556323b1bdc03ff0997aa6f6bbc8fdd71b3137b678c1239d626b3bd5b002f28fc81cbe9ce0a56ba6dc38137e48df
+  data.tar.gz: 1d0e79dcdd3c8910cd6af4f76906bd1b26575f33e83759dae61414766b55c0ba26d7e1380939f5a0bfb885de9c160572984623b62b112d6083e2210e5b0e7a13

data/pakyow-presenter/CHANGES

@@ -1,3 +1,13 @@
+= 0.9.0
+
+  * Introduces StringDoc, replacing Nokogiri for view rendering with a performant alternative
+  * Adds the ability to set an empty first option in bindings
+  * Remove the annoying "no content" for container log message
+  * Binding context must now be explicitly passed when binding
+  * Yield bindable value before bindable in view binding fns
+  * Fixes bug causing non-html view contents to be processed twice
+  * Removes support for Ruby versions < 2.0.0
+
 = 0.8.0 / 2014-03-02
 
   * Major rewrite, including new view syntax, composer, and transformation api
@@ -38,4 +48,4 @@
 
 = 0.6.0 / 2011-08-20
 
- * Initial gem release of 0.6.0 codebase
+ * Initial gem release of 0.6.0 codebase

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

@@ -53,14 +53,13 @@ module Pakyow
       def method_missing(method, *args)
         ret = @value.send(method, *args)
         update_value
-
         return ret
       end
 
       # returns the full string value
       def to_s
         value = @value
-        value = value.call(deconstruct_attribute_value_of_type(@doc[@name], @type)) if value.is_a? Proc
+        value = value.call(deconstruct_attribute_value_of_type(@doc.get_attribute(@name), @type)) if value.is_a? Proc
         value = construct_attribute_value_of_type(value, @type, @name)
 
         return value
@@ -70,6 +69,10 @@ module Pakyow
         @value
       end
 
+      def ancestors
+        self.class.ancestors
+      end
+
       private
 
       def update_value
@@ -117,10 +120,9 @@ module Pakyow
     end
 
     class Attributes
-      def initialize(doc, composer = nil)
+      def initialize(doc)
         @doc = doc
         @attributes = {}
-        @composer = composer
       end
 
       def method_missing(method, *args)
@@ -144,34 +146,28 @@ module Pakyow
       def class(*args)
         method_missing(:class, *args)
       end
-      
+
       def id(*args)
         method_missing(:id, *args)
       end
 
       def update_value_for_attribute(attribute, value)
-        if !@doc.is_a?(Nokogiri::XML::Element) && @doc.children.count == 1
-          @doc.children.first[attribute] = value
-        else
-          @doc[attribute] = value
-        end
+        @doc.update_attribute(attribute, value)
       end
 
       def remove_attribute(attribute)
         @doc.remove_attribute(attribute)
-        @composer.dirty! unless @composer.nil?
       end
 
       protected
 
       def set_attribute(attribute, value)
         get_attribute(attribute).set(value)
-        @composer.dirty! unless @composer.nil?
       end
 
       def get_attribute(attribute)
         unless a = @attributes[attribute]
-          a = Attribute.new(attribute, @doc[attribute], self, @doc)
+          a = Attribute.new(attribute, @doc.get_attribute(attribute), self, @doc)
         end
 
         return a
@@ -187,10 +183,17 @@ module Pakyow
 
       def <<(attributes)
         @attributes << attributes
+        self
+      end
+
+      def each
+        @attributes.each { |a| yield(a) }
       end
 
       def method_missing(method, *args)
-        @attributes.inject(AttributesCollection.new) { |coll, a| coll<< a.send(method, *args) }
+        @attributes.inject(AttributesCollection.new) { |coll, a|
+          coll << a.send(method, *args)
+        }
       end
 
       def to_s
@@ -200,7 +203,7 @@ module Pakyow
       def class(*args)
         method_missing(:class, *args)
       end
-      
+
       def id(*args)
         method_missing(:id, *args)
       end

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

@@ -1,7 +1,6 @@
 require 'yaml'
+
 require 'presenter/view_store'
-require 'presenter/doc_helpers'
-require 'presenter/title_helpers'
 require 'presenter/view'
 require 'presenter/template'
 require 'presenter/page'
@@ -13,6 +12,13 @@ require 'presenter/binder_set'
 require 'presenter/attributes'
 require 'presenter/exceptions'
 require 'presenter/view_composer'
+require 'presenter/nokogiri_doc'
+require 'presenter/string_doc'
+require 'presenter/string_doc_parser'
+require 'presenter/string_doc_renderer'
+require 'presenter/binding_eval'
+require 'presenter/doc_helpers'
+require 'presenter/view_context'
 
 module Pakyow
   module Presenter

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

@@ -1,78 +1,88 @@
+require 'singleton'
+
 module Pakyow
   module Presenter
-    # A singleton that manages route sets.
+    # A singleton that manages BinderSet instances for an app. It handles
+    # the creation / registration of sets and provides a mechanism
+    # to augment data to be bound with values from the sets.
     #
     class Binder
       include Singleton
-      include Helpers
 
+      # Access to the registered binder sets for an app.
+      #
       attr_reader :sets
 
       def initialize
         @sets = {}
       end
 
-      #TODO want to do this for all sets?
+      # Resets the registered binder sets.
+      #
+      # @return [Binder] the reset instance
+      #
       def reset
         @sets = {}
         self
       end
 
-      # Creates a new set.
+      # Creates and registers a new binder set by name. A block should be passed
+      # that defines the bindings. This block will be evaluated in context
+      # of the created binder set.
+      #
+      # @see BinderSet
+      #
+      # @param name [Symbol] the name of the binder set to be created
       #
       def set(name, &block)
-        @sets[name] = BinderSet.new
-        @sets[name].instance_exec(&block)
+        @sets[name] = BinderSet.new(&block)
       end
 
-      def value_for_prop(prop, scope, bindable, bindings = {}, context)
-        @context = context
-        binding = nil
-        @sets.each {|set|
-          binding = set[1].match_for_prop(prop, scope, bindable, bindings)
-          break if binding
+      # Returns the value for the scope->prop by applying any defined bindings to the data.
+      #
+      # @param scope [Symbol] the scope name
+      # @param prop [Symbol] the prop name
+      # @param bindable [Symbol] the data being bound
+      # @param bindings [Symbol] additional bindings to take into consideration when determining the value
+      # @param context [Symbol] context passed through to the defined bindings
+      #
+      def value_for_scoped_prop(scope, prop, bindable, bindings, context)
+        binding_fn = @sets.lazy.map { |set|
+          set[1].match_for_prop(prop, scope, bindable, bindings)
+        }.find { |match|
+          !match.nil?
         }
 
-        if binding
+        if binding_fn
           binding_eval = BindingEval.new(prop, bindable, context)
-
-          case binding.arity
-          when 0
-            binding_eval.instance_exec(&binding)
-          when 1
-            self.instance_exec(bindable, &binding)
-          when 2
-            self.instance_exec(bindable, binding_eval.value, &binding)
+          binding_eval.instance_exec(binding_eval.value, bindable, context, &binding_fn)
+        else # default value
+          if bindable.is_a?(Hash)
+            bindable[prop]
+          elsif bindable.class.method_defined?(prop)
+            bindable.send(prop)
           end
-        else
-          # default
-          prop_value_for_bindable(bindable, prop)
         end
       end
 
-      def prop_value_for_bindable(bindable, prop)
-        return bindable[prop] if bindable.is_a?(Hash)
-        return bindable.send(prop) if bindable.class.method_defined?(prop)
-      end
-
-      def options_for_prop(*args)
-        match = nil
-        @sets.each {|set|
-          match = set[1].options_for_prop(*args)
-          break if match
+      # Returns true if a binding is defined for the scope->prop.
+      #
+      def has_scoped_prop?(scope, prop, bindings)
+        @sets.lazy.map { |set|
+          set[1].has_prop?(scope, prop, bindings)
+        }.find { |has_prop|
+          has_prop
         }
-
-        return match
       end
 
-      def has_prop?(*args)
-        has = nil
-        @sets.each {|set|
-          has = set[1].has_prop?(*args)
-          break if has
+      # Returns options for the scope->prop.
+      #
+      def options_for_scoped_prop(scope, prop, bindable, context)
+        @sets.lazy.map { |set|
+          set[1].options_for_prop(scope, prop, bindable, context)
+        }.find { |options|
+          !options.nil?
         }
-
-        return has
       end
     end
   end

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

@@ -3,31 +3,37 @@ module Pakyow
     class BinderSet
       attr_reader :scopes
 
-      def initialize
+      def initialize(&block)
         @scopes = {}
         @options = {}
+        @config = {}
+
+        instance_exec(&block)
       end
 
       def scope(name, &block)
         scope_eval = ScopeEval.new
-        bindings, options = scope_eval.eval(&block)
+        bindings, options, config = scope_eval.eval(&block)
 
         @scopes[name.to_sym] = bindings
         @options[name.to_sym] = options
+        @config[name.to_sym] = config
       end
 
       def match_for_prop(prop, scope, bindable, bindings = {})
         return bindings_for_scope(scope, bindings)[prop]
       end
 
-      def options_for_prop(prop, scope, bindable, context)
+      def options_for_prop(scope, prop, bindable, context)
         if block = (@options[scope] || {})[prop]
-          binding_eval = BindingEval.new(bindable, prop, context)
-          binding_eval.instance_exec(&block)
+          binding_eval = BindingEval.new(prop, bindable, context)
+          values = binding_eval.instance_exec(binding_eval.value, bindable, context, &block)
+          values.unshift(['', '']) if @config[scope][prop][:empty]
+          values
         end
       end
 
-      def has_prop?(prop, scope, bindings)
+      def has_prop?(scope, prop, bindings)
         bindings_for_scope(scope, bindings).key? prop
       end
 
@@ -43,29 +49,31 @@ module Pakyow
       def initialize
         @bindings = {}
         @options = {}
+        @config = {}
       end
 
       def eval(&block)
         self.instance_eval(&block)
-        return @bindings, @options
+        return @bindings, @options, @config
       end
 
       def binding(name, &block)
         @bindings[name.to_sym] = block
       end
 
-      def options(name, &block)
+      def options(name, empty: false, &block)
         @options[name] = block
+        @config[name] = { empty: empty }
       end
 
       def restful(route_group)
         binding(:action) {
-          routes = router.group(route_group)
+          routes = Router.instance.group(route_group)
           return_data = {}
 
           if id = bindable[:id]
             return_data[:view] = lambda { |view|
-              view.prepend(View.from_doc(Nokogiri::HTML.fragment('<input type="hidden" name="_method" value="patch">')))
+              view.prepend(View.from_doc(NokogiriDoc.from_doc(Nokogiri::HTML.fragment('<input type="hidden" name="_method" value="patch">'))))
             }
 
             action = routes.path(:update, :"#{route_group}_id" => id)
@@ -81,22 +89,5 @@ module Pakyow
 
       #TODO options
     end
-
-    class BindingEval
-      include Helpers
-
-      attr_accessor :context
-      attr_reader :bindable
-
-      def initialize(prop, bindable, context)
-        @prop = prop
-        @bindable = bindable
-        @context = context
-      end
-
-      def value
-        bindable[@prop]
-      end
-    end
   end
 end

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

@@ -0,0 +1,23 @@
+module Pakyow
+  module Presenter
+    class BindingEval
+      include Pakyow::Helpers
+
+      attr_reader :context, :bindable
+
+      def initialize(prop, bindable, context)
+        @prop = prop
+        @bindable = bindable
+        @context = context
+      end
+
+      def value
+        if bindable.is_a?(Hash)
+          bindable[@prop]
+        elsif bindable.respond_to?(@prop)
+          bindable.send(@prop)
+        end
+      end
+    end
+  end
+end

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

@@ -1,61 +1,36 @@
-module Pakyow
-  module Config
-    class Presenter
-      Config::Base.register_config(:presenter, self)
-
-      class << self
-        attr_accessor :javascripts, :stylesheets, :view_stores, :default_views,
-        :scope_attribute, :prop_attribute, :container_attribute, :template_dirs
-
-        # Location of javascripts
-        def javascripts
-          @javascripts || '/javascripts'
-        end
-
-        # Location of stylesheets
-        def stylesheets
-          @stylesheets || '/stylesheets'
-        end
-
-        def view_stores
-          @view_stores ||= {:default => "#{Config::Base.app.root}/app/views"}
-        end
-
-        def default_views(store_name = nil)
-          @default_views ||= {:default => "pakyow.html"}
-        end
-
-        # Returns the default view for store, or default.
-        #
-        def default_view(store_name)
-          views = default_views
-          views.key?(store_name) ? views[store_name] : views[:default]
-        end
-
-        def template_dirs(store_name = nil)
-          @template_dirs ||= {:default => '_templates'}
-        end
-
-        # Returns the default template dir for store, or default.
-        #
-        def template_dir(store_name)
-          dirs = template_dirs
-          dirs.key?(store_name) ? dirs[store_name] : dirs[:default]
-        end
-
-        def scope_attribute
-          @scope_attribute || "data-scope"
-        end
-
-        def prop_attribute
-          @prop_attribute || "data-prop"
-        end
-
-        def container_attribute
-          @container_attribute || "data-container"
-        end
-
-      end
-    end
-  end
-end
+Pakyow::Config.register(:presenter) { |config|
+
+  # registered view stores
+  config.opt :view_stores, lambda {
+    @stores ||= {
+      default: File.join(Pakyow::Config.app.root, 'app', 'views')
+    }
+  }
+
+  # the default view for each view store
+  config.opt :default_views, { default: 'pakyow.html' }
+
+  # a convenience option to lookup the default_view for a view store by name
+  config.opt :default_view, lambda { |store_name|
+    views = Pakyow::Config.presenter.default_views
+    views.fetch(store_name) { views[:default] }
+  }
+
+  # the default template dir for each view store
+  config.opt :template_dirs, { default: '_templates' }
+
+  # a convenience option to lookup the template_dir for a view store by name
+  config.opt :template_dir, lambda { |store_name|
+    dirs = Pakyow::Config.presenter.template_dirs
+    dirs.fetch(store_name) { dirs[:default] }
+  }
+
+  # the attribute expected for scope definitions
+  config.opt :scope_attribute, 'data-scope'
+
+  # the attribute expected for prop definitions
+  config.opt :prop_attribute, 'data-prop'
+
+  # the document class used to parse and render views
+  config.opt :view_doc_class, StringDoc
+}