cheveret 2.0.0.rc5 → 3.0.0

data/lib/cheveret/{base.rb → table/locale.rb}

@@ -21,37 +21,34 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'active_support/ordered_hash'
-
 module Cheveret
-  class Base
-    attr_accessor :columns
-
-    def initialize(template, &block)
-      @template = template
-      @columns  = ::ActiveSupport::OrderedHash.new
-
-      instance_eval(&block) if block_given?
-    end
+  module Table
+    module Locale
 
-    include DSL
-    include Rendering
-    include Config
-    include Resizing
-    include Filtering
-  # include Sorting
+      ##
+      #
+      #
+      def render_th(column, options={})
+        unless options[:title]
+          scope = self.class.to_s.sub(/Table\Z/, '').underscore
+          hint  = ::I18n.translate("cheveret.hints.#{scope}.#{column.name}",
+                                   :default => '')
 
-  protected
+          options[:title] = hint.squish unless hint.blank?
+        end
 
-    # since the define_table block gets instance_eval'd in the context of this object
-    # we need to proxy view methods (e.g. check_box_tag) back to the template
-    def method_missing(method_name, *args, &block) #:nodoc:
-      if @template.respond_to?(method_name)
-        @template.send(method_name, *args, &block)
-      else
         super
       end
-    end
 
-  end
-end
+      ##
+      #
+      #
+      def table_header_for(column)
+        scope  = self.class.to_s.sub(/Table\Z/, '').underscore
+        header = ::I18n.translate("cheveret.headers.#{scope}.#{column.name}",
+                                  :default => column.name.to_s.humanize).squish
+      end
+
+    end # Locale
+  end # Table
+end # Cheveret

data/lib/cheveret/table/mapping.rb

@@ -0,0 +1,88 @@
+#--
+# Copyright (c) 2010 RateCity Pty. Ltd.
+#
+# 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.
+#++
+
+module Cheveret
+  module Table
+    module Mapping
+
+      def self.included(base)
+        ::Cheveret::Column.send :include, Mappable
+      end
+
+      module Mappable
+        attr_accessor :data, :header
+      end # Mappable
+
+      ##
+      #
+      #
+      def table_data(column, item)
+        args = [ item ]
+
+        case column.data
+        when Symbol
+          args.unshift(column) if method(column.data).arity > 1
+          send(column.data, *args)
+        when Proc
+          args.unshift(column) if column.data.arity > 1
+          template.capture(*args, &column.data)
+        else
+          if respond_to?(column.name)
+            args.unshift(column) if method(column.name).arity > 1
+            send(column.name, *args)
+          else
+             table_data_for(column, item)
+          end
+        end
+      end
+
+      ##
+      #
+      #
+      def table_data_for(column, item)
+        raise NotImplementedError
+      end
+
+      ##
+      #
+      #
+      def table_header(column)
+        case column.header
+        when Symbol then send(column.header)
+        when Proc then template.capture(&column.header)
+        when String then column.header
+        else
+          table_header_for(column) unless column.header == false
+        end
+      end
+
+      ##
+      #
+      #
+      def table_header_for(column)
+        raise NotImplementedError
+      end
+
+    end # Mapping
+  end # Table
+end # Cheveret

data/lib/cheveret/table/rendering.rb

@@ -0,0 +1,122 @@
+#--
+# Copyright (c) 2010 RateCity Pty. Ltd.
+#
+# 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.
+#++
+
+module Cheveret
+  module Table
+    module Rendering
+
+      def self.included(base)
+        base.module_eval do
+          extend ClassMethods
+        end
+      end
+
+      attr_accessor :template
+
+      module ClassMethods
+      end # ClassMethods
+
+      ##
+      #
+      #
+      def render_table(options={})
+        table_tag(options) do
+          render_thead << render_tbody
+        end
+      end
+
+      ##
+      #
+      #
+      def render_thead(options={})
+        thead_tag(options) do
+          tr_tag do
+            columns.values.map do |column|
+              render_th(column) { table_header(column) }
+            end
+          end
+        end
+      end
+
+      ##
+      #
+      #
+      def render_tbody(options={})
+        tbody_tag(options) { render_rows }
+      end
+
+      ##
+      #
+      #
+      def render_rows(options={})
+        template.reset_cycle('cheveret')
+
+        collection.map do |item|
+          cycle = template.cycle('', 'alt', :name => 'cheveret')
+
+          tr_tag(:class => cycle) do
+            columns.values.map do |column|
+              render_td(column) { table_data(column, item) }
+            end
+          end
+        end.join("\n")
+      end
+
+      ##
+      # generates a <th> tag for the specified column using the configured builder
+      #
+      def render_th(column, options={})
+        options.reverse_merge!(column.th_html) if column.th_html
+
+        # phwarrrgg!
+        options[:class] = ([ column.name, options[:class],
+          column.th_html ? column.th_html[:class] : nil
+        ]).flatten.join(' ').strip
+
+        th_tag(options) { yield }
+      end
+
+      ##
+      #
+      #
+      def render_td(column, options={})
+        options.reverse_merge!(column.td_html) if column.td_html
+        options[:class] = [ column.name, *options[:class] ].flatten.join(' ').strip
+
+        td_tag(options) { yield }
+      end
+
+      ##
+      #
+      #
+      def render(*args, &block)
+        if args.empty? && block_given?
+          template.instance_eval(&block)
+        else
+          template.render(*args, &block)
+        end
+      end
+
+    end # Rendering
+  end # Table
+end # Cheveret

data/lib/cheveret/table/sizing.rb

@@ -0,0 +1,136 @@
+#--
+# Copyright (c) 2010 RateCity Pty. Ltd.
+#
+# 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.
+#++
+
+module Cheveret
+  module Table
+    module Sizing
+
+      def self.included(base)
+        base.module_eval do
+          extend ClassMethods
+        end
+
+        # allow columns to be flexible and/or have their width set
+        ::Cheveret::Column.send :include, Sizable
+      end
+
+      attr_accessor :width
+
+      module ClassMethods
+
+        # todo: set width?
+
+      end # ClassMethods
+
+      module Sizable
+        attr_accessor :flexible, :size, :width
+
+        ##
+        #
+        #
+        def flexible?
+          @flexible == true
+        end
+
+        ##
+        #
+        #
+        def size
+          @size || width
+        end
+
+        ##
+        #
+        #
+        def width
+          @width || 0
+        end
+
+      end # Sizable
+
+      ##
+      #
+      #
+      def width
+        @width ||= 0
+      end
+
+      [ :table, :thead, :tbody, :rows].each do |elem|
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          def render_#{elem}(options={})
+            resize! if needs_resize?
+
+            options[:style] = "width:\#{width}px;" if width > 0
+            super
+          end
+        RUBY_EVAL
+      end
+
+      ##
+      #
+      #
+      def render_th(column, options={})
+        options[:style] = "width:#{column.size}px;" if column.size > 0
+        super
+      end
+
+      ##
+      #
+      #
+      def render_td(column, options={})
+        options[:style] = "width:#{column.size}px;" if column.size > 0
+        super
+      end
+
+      ##
+      #
+      #
+      def resize!
+        columns_width, flexibles = 0, []
+
+        columns.values.each do |column|
+          columns_width += column.width
+          flexibles << column if column.flexible?
+        end
+
+        # todo: handle too-many/too-wide columns
+        raise "uh-oh spaghettio-s" if columns_width > width
+
+        # todo: fix rounding in with calculation
+        if columns_width < width && !flexibles.empty?
+          padding = (width - columns_width) / flexibles.length
+          flexibles.each { |column| column.size = column.width + padding }
+        end
+      end
+
+      ##
+      #
+      #
+      def needs_resize?
+        columns.map(&:size).sum != width
+      end
+
+
+    end # Sizing
+  end # Table
+end # Cheveret

data/lib/cheveret/table/sorting.rb

@@ -0,0 +1,124 @@
+#--
+# Copyright (c) 2010 RateCity Pty. Ltd.
+#
+# 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.
+#++
+
+module Cheveret
+  module Table
+    module Sorting
+
+      def self.included(base)
+        base.module_eval do
+          extend ClassMethods
+        end
+
+        # make sure our column objects can be configured as sortable
+        ::Cheveret::Column.send :include, Sortable
+      end
+
+      attr_accessor :sort_column, :sort_direction, :sort_param, :sort_url
+
+      module ClassMethods
+
+        ##
+        # defines which table columns can be sorted by the user
+        #
+        def sortable_on(*args)
+          args.each do |column_name|
+            raise "unrecognised column #{column_name}" unless columns[column_name]
+            columns[column_name].sortable = true
+          end
+        end
+
+        ##
+        # TODO: depricate
+        #
+        def default_sort(column_name, direction)
+          raise ArgumentError 'Column not found' unless columns.has_key?(column_name)
+
+          @default_sort_column    = columns[column_name]
+          @default_sort_direction = direction
+        end
+
+      end # ClassMethods
+
+      module Sortable
+        attr_accessor :default_sort_direction, :sortable
+
+        ##
+        # whether or not sorting the table by this column is allowed. default +false+
+        #
+        def sortable?
+          sortable == true
+        end
+
+        def default_sort_direction
+          @default_sort_direction ||= :desc
+        end
+
+      end # Sortable
+
+      ##
+      #
+      #
+      def sort_param
+        @sort_param ||= '%s'
+      end
+
+      ##
+      #
+      #
+      def render_th(column, options={})
+        return super unless column.sortable?
+
+        options[:class] = [ 'sortable', *options[:class] ]
+        options[:class] << 'sorted' if column.name == sort_column
+        options[:class].flatten.join(' ').strip
+
+        super
+      end
+
+      ##
+      #
+      #
+      def table_header(column)
+        # wrap unsortable columns in a <span> tag
+        return template.content_tag(:span, super) unless column.sortable?
+
+        column_key = sort_param % 'sort_column'
+        direction_key = sort_param % 'sort_direction'
+
+        attrs = {}
+        query = { column_key => column.name,
+                  direction_key => column.default_sort_direction }
+
+        if column.name == sort_column
+          query[direction_key] = ( sort_direction == :asc ? :desc : :asc )
+          attrs[:class] = "#{sort_direction}"
+        end
+
+        attrs[:href] = template.url_for(sort_url.merge(query))
+        template.content_tag(:a, super, attrs)
+      end
+
+    end # Sorting
+  end # Table
+end # Cheveret