presenting 2.0.0 → 2.0.1

data/lib/presenting/attribute.rb

@@ -1,51 +1,51 @@
-module Presenting
-  # represents an attribute meant to be read from a record
-  # used for things like Grid and Details.
-  # not intended for things like Form or FieldSearch
-  class Attribute
-    include Presenting::Configurable
-    
-    def name=(val)
-      self.value ||= val # don't lazy define :value, because we're about to typecast here
-      if val.is_a? Symbol
-        @name = val.to_s.titleize
-      else
-        @name = val.to_s
-      end
-    end
-    attr_reader :name
-    
-    # The short programmatic name for this field. Can be used as a CSS class, sorting name, etc.
-    def id=(val)
-      @id = val.to_s
-    end
-    
-    def id
-      @id ||= name.to_s.underscore.gsub(/[^a-z0-9]/i, '_').gsub(/__+/, '_').sub(/_$/, '')
-    end
-  
-    # Where a field's value comes from. Depends heavily on the data type you provide.
-    # - String: fixed value (as provided)
-    # - Symbol: a method on the record (no arguments)
-    # - Proc: a custom block that accepts the record as an argument
-    attr_accessor :value
-    
-    def value_from(obj) #:nodoc:
-      case value
-        when Symbol: obj.is_a?(Hash) ? obj[value] : obj.send(value)
-        when String: value
-        when Proc:   value.call(obj)
-      end
-    end
-    
-    # whether html should be sanitize. right now this actually means html escaping.
-    # consider: by default, do not sanitize if value is a String?
-    attr_writer :sanitize
-    def sanitize?
-      unless defined? @sanitize
-        @sanitize = Presenting::Defaults.sanitize_fields
-      end
-      @sanitize
-    end
-  end
-end
+module Presenting
+  # represents an attribute meant to be read from a record
+  # used for things like Grid and Details.
+  # not intended for things like Form or FieldSearch
+  class Attribute
+    include Presenting::Configurable
+    
+    def name=(val)
+      self.value ||= val # don't lazy define :value, because we're about to typecast here
+      if val.is_a? Symbol
+        @name = val.to_s.titleize
+      else
+        @name = val.to_s
+      end
+    end
+    attr_reader :name
+    
+    # The short programmatic name for this field. Can be used as a CSS class, sorting name, etc.
+    def id=(val)
+      @id = val.to_s
+    end
+    
+    def id
+      @id ||= name.to_s.underscore.gsub(/[^a-z0-9]/i, '_').gsub(/__+/, '_').sub(/_$/, '')
+    end
+  
+    # Where a field's value comes from. Depends heavily on the data type you provide.
+    # - String: fixed value (as provided)
+    # - Symbol: a method on the record (no arguments)
+    # - Proc: a custom block that accepts the record as an argument
+    attr_accessor :value
+    
+    def value_from(obj) #:nodoc:
+      case value
+        when Symbol: obj.is_a?(Hash) ? obj[value] : obj.send(value)
+        when String: value
+        when Proc:   value.call(obj)
+      end
+    end
+    
+    # whether html should be sanitize. right now this actually means html escaping.
+    # consider: by default, do not sanitize if value is a String?
+    attr_writer :sanitize
+    def sanitize?
+      unless defined? @sanitize
+        @sanitize = Presenting::Defaults.sanitize_fields
+      end
+      @sanitize
+    end
+  end
+end

data/lib/presenting/configurable.rb

@@ -1,10 +1,10 @@
-module Presenting
-  module Configurable
-    def initialize(options = {}, &block)
-      options.each do |k, v|
-        self.send("#{k}=", v)
-      end
-      yield self if block_given?
-    end
-  end
-end
+module Presenting
+  module Configurable
+    def initialize(options = {}, &block)
+      options.each do |k, v|
+        self.send("#{k}=", v)
+      end
+      yield self if block_given?
+    end
+  end
+end

data/lib/presenting/defaults.rb

@@ -1,10 +1,10 @@
-module Presenting::Defaults
-  # Whether the columns in the Grid should be sortable by default
-  mattr_accessor :grid_is_sortable
-  self.grid_is_sortable = true
-  
-  # Whether fields should be sanitized by default
-  mattr_accessor :sanitize_fields
-  self.sanitize_fields = true
-end
-
+module Presenting::Defaults
+  # Whether the columns in the Grid should be sortable by default
+  mattr_accessor :grid_is_sortable
+  self.grid_is_sortable = true
+  
+  # Whether fields should be sanitized by default
+  mattr_accessor :sanitize_fields
+  self.sanitize_fields = true
+end
+

data/lib/presenting/field_set.rb

@@ -1,26 +1,26 @@
-class Presenting::FieldSet < Array
-  def initialize(field_class, primary, secondary)
-    @klass = field_class
-    @primary_attribute = primary
-    @secondary_attribute = secondary
-  end
-
-  def <<(field)
-    if field.is_a? Hash
-      k, v = *field.to_a.first
-      opts = v.is_a?(Hash) ? v : {@secondary_attribute => v}
-      opts[@primary_attribute] = k
-    else
-      opts = {@primary_attribute => field}
-    end
-    super @klass.new(opts)
-  end
-  
-  def [](key)
-    detect{|i| i.send(@primary_attribute) == key}
-  end
-  
-  def []=(key, val)
-    self << {key => val}
-  end
-end
+class Presenting::FieldSet < Array
+  def initialize(field_class, primary, secondary)
+    @klass = field_class
+    @primary_attribute = primary
+    @secondary_attribute = secondary
+  end
+
+  def <<(field)
+    if field.is_a? Hash
+      k, v = *field.to_a.first
+      opts = v.is_a?(Hash) ? v : {@secondary_attribute => v}
+      opts[@primary_attribute] = k
+    else
+      opts = {@primary_attribute => field}
+    end
+    super @klass.new(opts)
+  end
+  
+  def [](key)
+    detect{|i| i.send(@primary_attribute) == key}
+  end
+  
+  def []=(key, val)
+    self << {key => val}
+  end
+end

data/lib/presenting/form_helpers.rb

@@ -1,51 +1,51 @@
-module Presenting::FormHelpers
-  def present(field)
-    send("present_#{field.type}_input", field)
-  end
-  
-  def present_readonly_input(field)
-    text_field field.name, :disabled => true, :value => field.value_from(object)
-  end
-  
-  def present_string_input(field)
-    text_field field.name, :value => field.value_from(object)
-  end
-  
-  def present_hidden_input(field)
-    hidden_field field.name, :value => field.value_from(object)
-  end
-  
-  def present_text_input(field)
-    text_area field.name, :value => field.value_from(object)
-  end
-  
-  def present_password_input(field)
-    password_field field.name
-  end
-  
-  def present_boolean_input(field)
-    check_box field.name
-  end
-  
-  def present_dropdown_input(field)
-    view.select_tag "#{object_name}[#{field.name}]", view.options_for_select(field.type_options, object.send(field.name))
-  end
-  alias_method :present_select_input, :present_dropdown_input
-  
-  def present_multi_select_input(field)
-    view.select_tag "#{object_name}[#{field.name}][]", view.options_for_select(field.type_options, object.send(field.name)), :multiple => true
-  end
-  
-  def present_radios_input(field)
-    field.type_options.collect do |(display, value)|
-      label("#{field.name}_#{value}", display) +
-      radio_button(field.name, value)
-    end.join.html_safe
-  end
-  
-  private
-  
-  def view
-    @template
-  end
-end
+module Presenting::FormHelpers
+  def present(field)
+    send("present_#{field.type}_input", field)
+  end
+  
+  def present_readonly_input(field)
+    text_field field.name, :disabled => true, :value => field.value_from(object)
+  end
+  
+  def present_string_input(field)
+    text_field field.name, :value => field.value_from(object)
+  end
+  
+  def present_hidden_input(field)
+    hidden_field field.name, :value => field.value_from(object)
+  end
+  
+  def present_text_input(field)
+    text_area field.name, :value => field.value_from(object)
+  end
+  
+  def present_password_input(field)
+    password_field field.name
+  end
+  
+  def present_boolean_input(field)
+    check_box field.name
+  end
+  
+  def present_dropdown_input(field)
+    view.select_tag "#{object_name}[#{field.name}]", view.options_for_select(field.type_options, object.send(field.name))
+  end
+  alias_method :present_select_input, :present_dropdown_input
+  
+  def present_multi_select_input(field)
+    view.select_tag "#{object_name}[#{field.name}][]", view.options_for_select(field.type_options, object.send(field.name)), :multiple => true
+  end
+  
+  def present_radios_input(field)
+    field.type_options.collect do |(display, value)|
+      label("#{field.name}_#{value}", display) +
+      radio_button(field.name, value)
+    end.join.html_safe
+  end
+  
+  private
+  
+  def view
+    @template
+  end
+end

data/lib/presenting/helpers.rb

@@ -1,114 +1,114 @@
-module Presenting
-  module Helpers
-    def presentation_stylesheets(*args)
-      warn "[DEPRECATION] presentation_stylesheets is deprecated. Please use the stylesheets" <<
-           "that are copied to public/stylesheets/presenting/* on boot."
-      stylesheet_link_tag presentation_stylesheet_path(args.sort.join(','), :format => 'css')
-    end
-    
-    def presentation_javascript(*args)
-      warn "[DEPRECATION] presentation_javascript is deprecated. Please use the javascripts" <<
-           "that are copied to public/javascripts/presenting/* on boot."
-      javascript_include_tag presentation_javascript_path(args.sort.join(','), :format => 'js')
-    end
-    
-    def present(*args, &block)
-      options = args.length > 1 ? args.extract_options! : {}
-      
-      if args.first.is_a? Symbol
-        object, presentation = nil, args.first
-      else
-        object, presentation = args.first, args.second
-      end
-
-      if presentation
-        klass = "Presentation::#{presentation.to_s.camelcase}".constantize rescue nil
-        if klass
-          instance = klass.new(options, &block)
-          instance.presentable = object
-          instance.controller = controller
-          instance.render
-        elsif respond_to?(method_name = "present_#{presentation}")
-          send(method_name, object, options)
-        else
-          raise ArgumentError, "unknown presentation `#{presentation}'"
-        end
-      elsif object.respond_to?(:loaded?) # AssociationProxy
-        present_association(object, options)
-      else
-        present_by_class(object, options)
-      end
-    end
-    
-    # presents a text search widget for the given field (a Presentation::FieldSearch::Field, probably)
-    def present_text_search(field, options = {})
-      current_value = (params[:search][field.param][:value] rescue nil)
-      text_field_tag options[:name], h(current_value)
-    end
-    
-    # presents a checkbox search widget for the given field (a Presentation::FieldSearch::Field, probably)
-    def present_checkbox_search(field, options = {})
-      current_value = (params[:search][field.param][:value] rescue nil)
-      check_box_tag options[:name], '1', current_value.to_s == '1'
-    end
-    
-    # presents a dropdown/select search widget for the given field (a Presentation::FieldSearch::Field, probably)
-    def present_dropdown_search(field, options = {})
-      current_value = (params[:search][field.param][:value] rescue nil)
-      select_tag options[:name], options_for_select(normalize_dropdown_options_to_strings(field.options), current_value)
-    end
-    
-    protected
-    
-    # We want to normalize the value elements of the dropdown options to strings so that
-    # they will match against params[:search].
-    #
-    # Need to handle the three different dropdown options formats:
-    # * array of strings
-    # * array of arrays
-    # * hash
-    def normalize_dropdown_options_to_strings(options)
-      options.to_a.map do |element|
-        if element.is_a? String
-          [element, element]
-        else
-          [element.first, element.last.to_s]
-        end
-      end
-    end
-
-    # TODO: special handling for associations (displaying activerecords)
-    def present_association(object, options = {})
-      present_by_class(object, options)
-    end
-    
-    def present_by_class(object, options = {})
-      case object
-        when Array
-        content_tag "ol" do
-          object.collect do |i|
-            content_tag "li", present(i, options)
-          end.join.html_safe
-        end
-        
-        when Hash
-        # sort by keys
-        content_tag "dl" do
-          object.keys.sort.collect do |k|
-            content_tag("dt", k) +
-            content_tag("dd", present(object[k], options))
-          end.join.html_safe
-        end
-        
-        when TrueClass, FalseClass
-        object ? "True" : "False"
-        
-        when Date, Time, DateTime
-        l(object, :format => :default)
-        
-        else
-        options[:raw] ? object.to_s.html_safe : object.to_s
-      end 
-    end
-  end
-end
+module Presenting
+  module Helpers
+    def presentation_stylesheets(*args)
+      warn "[DEPRECATION] presentation_stylesheets is deprecated. Please use the stylesheets" <<
+           "that are copied to public/stylesheets/presenting/* on boot."
+      stylesheet_link_tag presentation_stylesheet_path(args.sort.join(','), :format => 'css')
+    end
+    
+    def presentation_javascript(*args)
+      warn "[DEPRECATION] presentation_javascript is deprecated. Please use the javascripts" <<
+           "that are copied to public/javascripts/presenting/* on boot."
+      javascript_include_tag presentation_javascript_path(args.sort.join(','), :format => 'js')
+    end
+    
+    def present(*args, &block)
+      options = args.length > 1 ? args.extract_options! : {}
+      
+      if args.first.is_a? Symbol
+        object, presentation = nil, args.first
+      else
+        object, presentation = args.first, args.second
+      end
+
+      if presentation
+        klass = "Presentation::#{presentation.to_s.camelcase}".constantize rescue nil
+        if klass
+          instance = klass.new(options, &block)
+          instance.presentable = object
+          instance.controller = controller
+          instance.render
+        elsif respond_to?(method_name = "present_#{presentation}")
+          send(method_name, object, options)
+        else
+          raise ArgumentError, "unknown presentation `#{presentation}'"
+        end
+      elsif object.respond_to?(:loaded?) # AssociationProxy
+        present_association(object, options)
+      else
+        present_by_class(object, options)
+      end
+    end
+    
+    # presents a text search widget for the given field (a Presentation::FieldSearch::Field, probably)
+    def present_text_search(field, options = {})
+      current_value = (params[:search][field.param][:value] rescue nil)
+      text_field_tag options[:name], h(current_value)
+    end
+    
+    # presents a checkbox search widget for the given field (a Presentation::FieldSearch::Field, probably)
+    def present_checkbox_search(field, options = {})
+      current_value = (params[:search][field.param][:value] rescue nil)
+      check_box_tag options[:name], '1', current_value.to_s == '1'
+    end
+    
+    # presents a dropdown/select search widget for the given field (a Presentation::FieldSearch::Field, probably)
+    def present_dropdown_search(field, options = {})
+      current_value = (params[:search][field.param][:value] rescue nil)
+      select_tag options[:name], options_for_select(normalize_dropdown_options_to_strings(field.options), current_value)
+    end
+    
+    protected
+    
+    # We want to normalize the value elements of the dropdown options to strings so that
+    # they will match against params[:search].
+    #
+    # Need to handle the three different dropdown options formats:
+    # * array of strings
+    # * array of arrays
+    # * hash
+    def normalize_dropdown_options_to_strings(options)
+      options.to_a.map do |element|
+        if element.is_a? String
+          [element, element]
+        else
+          [element.first, element.last.to_s]
+        end
+      end
+    end
+
+    # TODO: special handling for associations (displaying activerecords)
+    def present_association(object, options = {})
+      present_by_class(object, options)
+    end
+    
+    def present_by_class(object, options = {})
+      case object
+        when Array
+        content_tag "ol" do
+          object.collect do |i|
+            content_tag "li", present(i, options)
+          end.join.html_safe
+        end
+        
+        when Hash
+        # sort by keys
+        content_tag "dl" do
+          object.keys.sort.collect do |k|
+            content_tag("dt", k) +
+            content_tag("dd", present(object[k], options))
+          end.join.html_safe
+        end
+        
+        when TrueClass, FalseClass
+        object ? "True" : "False"
+        
+        when Date, Time, DateTime
+        l(object, :format => :default)
+        
+        else
+        options[:raw] ? object.to_s.html_safe : object.to_s
+      end 
+    end
+  end
+end

data/lib/presenting/sanitize.rb

@@ -1,19 +1,19 @@
-module Presenting::Sanitize
-  class << self
-    include ERB::Util
-    
-    # escape but preserve Arrays and Hashes
-    def h(val)
-      case val
-        when Array
-        val.map{|i| h(i)}
-        
-        when Hash
-        val.clone.each{|k, v| val[h(k)] = h(v)}
-        
-        else
-        html_escape(val)
-      end
-    end
-  end
-end
+module Presenting::Sanitize
+  class << self
+    include ERB::Util
+    
+    # escape but preserve Arrays and Hashes
+    def h(val)
+      case val
+        when Array
+        val.map{|i| h(i)}
+        
+        when Hash
+        val.clone.each{|k, v| val[h(k)] = h(v)}
+        
+        else
+        html_escape(val)
+      end
+    end
+  end
+end