cheveret 2.0.0.rc5 → 3.0.0

data/cheveret.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cheveret}
-  s.version = "2.0.0.rc5"
+  s.version = "3.0.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Caldwell"]
-  s.date = %q{2010-10-07}
+  s.date = %q{2010-12-01}
   s.description = %q{Generating HTML tables of data in the views of your Rails
 application is not very DRY even for the simpler of cases. Cheveret allows you to more
 clearly separate logic and templating and reduce the amount of code in your views.}
@@ -27,14 +27,19 @@ clearly separate logic and templating and reduce the amount of code in your view
      "cheveret.gemspec",
      "init.rb",
      "lib/cheveret.rb",
-     "lib/cheveret/base.rb",
+     "lib/cheveret/adapter/active_record.rb",
+     "lib/cheveret/adapter/sunspot.rb",
+     "lib/cheveret/builder/divider.rb",
      "lib/cheveret/column.rb",
-     "lib/cheveret/config.rb",
-     "lib/cheveret/dsl.rb",
-     "lib/cheveret/filtering.rb",
      "lib/cheveret/helper.rb",
-     "lib/cheveret/rendering.rb",
-     "lib/cheveret/resizing.rb",
+     "lib/cheveret/table.rb",
+     "lib/cheveret/table/columns.rb",
+     "lib/cheveret/table/data.rb",
+     "lib/cheveret/table/locale.rb",
+     "lib/cheveret/table/mapping.rb",
+     "lib/cheveret/table/rendering.rb",
+     "lib/cheveret/table/sizing.rb",
+     "lib/cheveret/table/sorting.rb",
      "lib/cheveret/version.rb",
      "rails/init.rb",
      "spec/cheveret_spec.rb",

data/lib/cheveret.rb

@@ -22,13 +22,29 @@
 #++
 
 module Cheveret
-  autoload :Base,      'cheveret/base'
-  autoload :Column,    'cheveret/column'
-  autoload :Config,    'cheveret/config'
-  autoload :DSL,       'cheveret/dsl'
-  autoload :Filtering, 'cheveret/filtering'
-  autoload :Helper,    'cheveret/helper'
-  autoload :Rendering, 'cheveret/rendering'
-  autoload :Resizing,  'cheveret/resizing'
+  autoload :Column, 'cheveret/column'
+  autoload :Helper, 'cheveret/helper'
+
+  module Adapter
+    autoload :ActiveRecord, 'cheveret/adapter/active_record'
+    autoload :Sunspot,      'cheveret/adapter/sunspot'
+  end
+
+  module Builder
+    autoload :Divider,        'cheveret/builder/divider'
+    # autoload :DefinitionList, 'cheveret/builder/definition_list'
+    # autoload :Table,          'cheveret/builder/table'
+  end
+
+  module Table
+    autoload :Base,      'cheveret/table'
+    autoload :Columns,   'cheveret/table/columns'
+    autoload :Data,      'cheveret/table/data'
+    autoload :Locale,    'cheveret/table/locale'
+    autoload :Mapping,   'cheveret/table/mapping'
+    autoload :Rendering, 'cheveret/table/rendering'
+    autoload :Sizing,    'cheveret/table/sizing'
+    autoload :Sorting,   'cheveret/table/sorting'
+  end
 
 end

data/lib/cheveret/{filtering.rb → adapter/active_record.rb}

@@ -22,20 +22,9 @@
 #++
 
 module Cheveret
-  module Filtering
-    def config(new_config=nil)
-      return super if new_config.nil?
+  module Adapter
+    module ActiveRecord
 
-      except, only = new_config.delete(:except), new_config.delete(:only)
-      if (except || only)
-        @columns.reject! { |k, v| !only.include?(k) } if only
-        # todo: support use of except
-      end
-
-      super
-    end
-
-    # todo: wrap around header, body, rows and allow localised :only and :except
-
-  end
-end
+    end # ActiveRecord
+  end # Adapter
+end # Cheveret

data/lib/cheveret/adapter/sunspot.rb

@@ -0,0 +1,57 @@
+#--
+# 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 Adapter
+    module Sunspot
+
+      ##
+      #
+      #
+      def table_data_for(column, item)
+        item.stored(column.name)
+      end
+
+      ##
+      #
+      #
+      [ :current_page,
+        :next_page,
+        :offset,
+        :per_page,
+        :total,
+        :total_entries,
+        :total_pages
+      ].each do |proxy|
+        # this is really territory of will_paginate
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          def #{proxy}(*args)
+            return 0 unless collection.respond_to?(:#{proxy})
+            collection.#{proxy}(*args)
+          end
+        RUBY_EVAL
+      end
+
+    end # Sunspot
+  end # Adapter
+end # Cheveret

data/lib/cheveret/{config.rb → builder/divider.rb}

@@ -22,24 +22,21 @@
 #++
 
 module Cheveret
-  module Config
-    # dsl method for defining default configuration options for table rendering
-    #
-    # @param [Hash] new_config
-    #   a hash of configuration options. gets merged with any existing config
-    def config(new_config=nil)
-      return @config ||= {} if new_config.nil?
-      config.merge!(new_config)
-    end
+  module Builder
+    module Divider
 
-    [ :render, :header, :body, :rows ].each do |renderer|
-      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-        def #{renderer}(*args)
-          options = config(args.extract_options!)
-          super(*args << options)
-        end
-      RUBY_EVAL
-    end
+      ##
+      #
+      #
+      [ :table, :thead, :tbody, :tr, :th, :td ].each do |tag|
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          def #{tag}_tag(options={})
+            options[:class] = [ '#{tag}', options[:class] ].flatten.join(' ').strip
+            template.content_tag(:div, options) { yield }
+          end
+        RUBY_EVAL
+      end
 
-  end
-end
+    end # Divider
+  end # Builder
+end # Cheveret

data/lib/cheveret/column.rb

@@ -23,34 +23,19 @@
 
 module Cheveret
   class Column
-    attr_accessor :name, :data, :label, :hint, :weight, :width
-    attr_accessor :flexible, :sortable
+    attr_accessor :name, :weight
+    attr_accessor :th_html, :td_html
 
-    def initialize(name, config={})
-      config.merge(:name => name).each do |k, v|
-        instance_variable_set(:"@#{k}", v) if respond_to?(:"#{k}=")
-      end
+    def initialize(name, options=nil)
+      @name = name
+      config(options) unless options.nil?
     end
 
-    def flexible?
-      @flexible == true
-    end
-
-    def label
-      case @label
-      when nil then @name.to_s.humanize # todo: support i18n for column labels
-      when false then nil
-      else @label
-      end
-    end
-
-    # returns +true+ unless a column has explicitly set <tt>:sortable => false</tt>
-    def sortable?
-      @sortable == true
-    end
-
-    def width
-      @width || 0
+    ##
+    #
+    #
+    def config(options)
+      options.each { |k, v| send(:"#{k}=", v) if respond_to?(:"#{k}=") }
     end
 
   end

data/lib/cheveret/helper.rb

@@ -23,15 +23,54 @@
 
 module Cheveret
   module Helper
-    def define_table(options={}, &block)
-      builder = options.delete(:builder) || ActionView::Base.default_table_builder
-      builder.new(self, &block)
+
+    ##
+    #
+    #
+    def cheveret_table(table, options={})
+      table.template = self
+      options.keys.each do |option|
+        table.send(:"#{option}=", options.delete(option)) if table.respond_to?(:"#{option}=")
+      end
+
+      table.render_table(options)
+    end
+
+    ##
+    #
+    #
+    def cheveret_head(table, options)
+      table.template = self
+      options.keys.each do |option|
+        table.send(:"#{option}=", options.delete(option)) if table.respond_to?(:"#{option}=")
+      end
+
+      table.render_thead(options)
     end
 
-    ActionView::Base.class_eval do
-      cattr_accessor :default_table_builder
-      self.default_table_builder = Cheveret::Base
+    ##
+    #
+    #
+    def cheveret_body(table, options={})
+      table.template = self
+      options.keys.each do |option|
+        table.send(:"#{option}=", options.delete(option)) if table.respond_to?(:"#{option}=")
+      end
+
+      table.render_tbody(options)
+    end
+
+    ##
+    #
+    #
+    def cheveret_rows(table, options={})
+      table.template = self
+      options.keys.each do |option|
+        table.send(:"#{option}=", options.delete(option)) if table.respond_to?(:"#{option}=")
+      end
+
+      table.render_rows(options)
     end
 
-  end
-end
+  end # Helper
+end # Cheveret

data/lib/cheveret/table.rb

@@ -0,0 +1,47 @@
+#--
+# 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
+    class Base
+      include Cheveret::Table::Columns
+      include Cheveret::Table::Data
+      include Cheveret::Table::Mapping
+      include Cheveret::Table::Rendering
+      include Cheveret::Table::Locale
+      include Cheveret::Table::Sizing
+      include Cheveret::Table::Sorting
+
+      include Cheveret::Builder::Divider
+      #include Cheveret::Adapter::ActiveRecord
+
+      ##
+      #
+      #
+      def config(options)
+        options.each { |k, v| send(:"#{k}=", v) if respond_to?(:"#{k}=") }
+      end
+
+    end # Base
+  end # Table
+end # Cheveret

data/lib/cheveret/table/columns.rb

@@ -0,0 +1,77 @@
+#--
+# 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 Columns
+
+      def self.included(base)
+        base.module_eval do
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+
+        ##
+        # returns an ordered hash of all defined table columns
+        #
+        def columns
+          @columns ||= ::ActiveSupport::OrderedHash.new
+        end
+
+        ##
+        # define a new (or re-define an existing) table column
+        #
+        def column(*args)
+          options = args.extract_options!
+          raise ArgumentError if args.empty?
+
+          column_name = args.first
+
+          # only create new column if one doesn't already exist with specified name
+          columns[column_name] ||= Column.new(column_name)
+          columns[column_name].tap do |column|
+            column.config(options)
+          end
+        end
+
+        ##
+        #
+        #
+        def remove_column(column_name)
+          columns.delete(column_name)
+        end
+
+      end # ClassMethods
+
+      ##
+      # instance proxy method to get columns defined by the class
+      #
+      def columns
+        @column ||= self.class.columns.dup
+      end
+
+    end # Columns
+  end # Table
+end # Cheveret

data/lib/cheveret/table/data.rb

@@ -0,0 +1,62 @@
+#--
+# 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 Data
+
+      attr_accessor :collection
+
+      ##
+      #
+      #
+      def initialize(collection=[], options={})
+        if block_given?
+          yield self
+        else
+          config(options.merge({ :collection => collection }))
+        end
+      end
+
+      ##
+      #
+      #
+      def collection
+        @collection ||= []
+      end
+
+      ##
+      #
+      #
+      [ :each, :empty?, :length, :map ].each do |proxy|
+        # there is a nicer way to do this using forwardable, but this works for now
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          def #{proxy}(*args)
+            collection.#{proxy}(*args)
+          end
+        RUBY_EVAL
+      end
+
+    end # Data
+  end # Table
+end #Cheveret