listalicious 0.3.2 → 0.3.3

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "listalicious"
-    gem.summary = %Q{Semantic lists (datagrids) for Rails}
+    gem.summary = %Q{Semantic lists (aka datagrids) for Rails}
     gem.description = %Q{Semantic listing; a semantic way to build datagrid structures in Rails.}
     gem.email = "jejacks0n@gmail.com"
     gem.homepage = "http://github.com/jejacks0n/listalicious"

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/lib/builders/generic_builder.rb

@@ -5,8 +5,10 @@ module Listalicious
 
     def initialize(template, collection, options = {}, &proc)
       @template, @collection, @options = template, collection, options
-      @object_name = "#{options[:as] || collection.first ? collection.first.class.name.underscore : ''}"
+      @object_name = "#{options[:as] || (collection.empty? ? '' : collection.first.class.name.underscore)}"
       @table_name = (options[:table_name] || @object_name.pluralize).to_s
+      @object = @object_name.classify.constantize.new
+      @column_count = 0
 
       render(options.delete(:html), &proc)
     end
@@ -19,9 +21,15 @@ module Listalicious
     # eg. order[users][]=login:asc&order[users][]=first_name:asc
     def orderable_link(contents, field)
       return contents if @object_name.empty?
+      field = field.to_s
 
       order_params = (template.params['order'] || {})[@table_name]
       fields = Hash[*order_params.to_a.collect { |field_and_dir| field_and_dir.split(':') }.flatten]
+      if @object && @object.default_order[:field].to_s == field
+        # TODO: this should technically be fields.empty? && @object.default_order[:options][:stable],
+        # but it lends itself to a little bit of an odd behavior unless you're expecting the additive ordering
+        fields[field] = fields[field] || @object.default_order[:direction].to_s if fields.empty?
+      end
 
       order_params = (template.params['order'] || {}).clone.
           merge({@table_name => ["#{field}:#{"#{fields[field] == 'asc' ? 'desc' : 'asc'}"}"]})

data/lib/builders/table_builder.rb

@@ -41,7 +41,7 @@ module Listalicious
     def column_group_head(options = {}, &proc)
       @column_count = 0
 
-      @head_wrapper = template.content_tag(:tr, template.capture(collection.first, 0, &proc),
+      @head_wrapper = template.content_tag(:tr, template.capture(collection.first || @object, 0, &proc),
                          options[:html].merge({:class => template.add_class(options[:html][:class], 'header')}))
       template.content_tag(:thead, @head_wrapper, options.delete(:wrapper_html))
     end
@@ -78,7 +78,13 @@ module Listalicious
       contents = options == args.first ? nil : args.first
 
       if @current_scope == :body
-        contents = template.capture(self, &proc) if block_given? && collection.first.present?
+        contents = if block_given?
+          template.capture(self, &proc)
+        elsif args.last.is_a?(Proc)
+          args.last.call
+        else
+          contents
+        end
       else
         contents = options[:title] || contents
       end
@@ -124,7 +130,8 @@ module Listalicious
       options[:html] ||= {}
       options[:html][:width] ||= options[:width]
 
-      contents = contents.to_s.humanize.titleize if contents.is_a? Symbol
+      options[:sort] ||= contents.is_a?(Symbol) ? contents : nil
+      contents = contents.to_s.humanize.titleize
       contents = orderable_link(contents, options[:sort]) if options[:sort]
 
       template.content_tag(:th, contents, options.delete(:html))

data/lib/listalicious.rb

@@ -2,11 +2,18 @@
 require 'builders/generic_builder'
 require 'builders/table_builder'
 
-module Listalicious #:nodoc:
+module Listalicious
 
   # Semantic list helper methods
   #
-  # Example Usage:
+  # == Example Usage (HAML)
+  # - semantic_list_for @users, :as => :user, :html => {:class => 'user-list'} do |l|
+  #   = l.columns [:head, :body] do |user, index|
+  #   = l.column "#{user.first_name} #{user.last_name}", :title => 'User Name', :sort => 'first_name', :width => '20%'
+  #   = l.column :login, :width => '20%'
+  #   = l.column link_to(user.email, "mailto:#{user.email}"), :title => 'Email Address', :sort => 'email', :width => '40%'
+  #   = l.controls do
+  #     = link_to('edit', edit_user_path(user))
   #
   module SemanticListHelper
 
@@ -20,7 +27,7 @@ module Listalicious #:nodoc:
 
       options[:html] ||= {}
       options[:html][:class] = add_class(options[:html][:class], 'semantic-list')
-      options[:html][:id] ||= "#{options[:as] || collection.first ? collection.first.class.name.underscore : 'semantic'}_list"
+      options[:html][:id] ||= options[:as].to_s
 
       if options[:sort_url]
         options[:html][:class] = add_class(options[:html][:class], 'sortable')
@@ -30,7 +37,7 @@ module Listalicious #:nodoc:
       options[:html][:class] = add_class(options[:html][:class], 'selectable') if options[:selectable]
       options[:html][:class] = add_class(options[:html][:class], 'expandable') if options[:expandable]
 
-      builder = options[:builder] || @@builder
+      builder = options[:builder] || TableBuilder
       builder.new(@template, collection, options, &proc)
     end
 
@@ -41,7 +48,45 @@ module Listalicious #:nodoc:
 
   end
 
-  module ActiveRecordExtensions # :nodoc:
+  module ActiveRecordExtensions
+
+    # Makes a given model orderable for lists
+    #
+    # To specify that a model behaves according to the Listalicious order style call orderable_fields.  The
+    # orderable_fields method takes a configuration block.
+    #
+    # === Example
+    # orderable_fields do
+    #   only :first_name, :last_name
+    #   default :last_name
+    # end
+    #
+    # === Configuration Methods
+    # [only]
+    #   Provide fields that are orderable.
+    # [except]
+    #   Provide fields that are not orderable, with the default list being all fields.
+    # [default]
+    #   Provide the default sort field, optionally a direction, and additional options.
+    #
+    # *Notes*:
+    # * If +only+ or +except+ are not called within the block, all fields on the model will be orderable, this includes
+    #   things like id, and password/password salt columns.
+    # * If +default+ isn't called, the first field will be considered the default, asc being the default direction.
+    #
+    def orderable_fields(&config_block)
+      cattr_accessor :orderable_fields, :default_order
+
+      # make all columns orderable, incase only or except aren't called in the configuration block
+      self.orderable_fields = column_names.map { |column_name| column_name.to_s }
+
+      OrderableConfiguration.new(self).instance_eval(&config_block)
+      self.orderable_fields.collect!{ |field| field.to_s }
+
+      self.default_order ||= {:field => self.orderable_fields.first, :direction => :desc, :options => {}}
+
+      attach_orderable_scopes
+    end
 
     class OrderableConfiguration
       def initialize(target)
@@ -83,48 +128,10 @@ module Listalicious #:nodoc:
         field = args.shift
         direction = args.shift || :asc
 
-        @target.default_order = {:field => field, :direction => direction, :options => options}
+        @target.default_order = {:field => field, :direction => direction, :options => options || {}}
       end
     end
 
-    # Makes a given model orderable for lists
-    #
-    # To specify that a model behaves according to the Listalicious order style call orderable_fields.  The
-    # orderable_fields method takes a configuration block.
-    #
-    # === Example
-    # orderable_fields do
-    #   only :first_name, :last_name
-    #   default :last_name
-    # end
-    #
-    # === Configuration Methods
-    # [only]
-    #   Provide fields that are orderable.
-    # [except]
-    #   Provide fields that are not orderable, with the default list being all fields.
-    # [default]
-    #   Provide the default sort field, optionally a direction, and additional options.
-    #
-    # *Notes*:
-    # * If +only+ or +except+ are not called within the block, all fields on the model will be orderable, this includes
-    #   things like id, and password/password salt columns.
-    # * If +default+ isn't called, the first field will be considered the default, asc being the default direction.
-    #
-    def orderable_fields(&config_block)
-      cattr_accessor :orderable_fields, :default_order
-
-      # make all columns orderable, incase only or except aren't called in the configuration block
-      self.orderable_fields = column_names.map { |column_name| column_name.to_s }
-
-      OrderableConfiguration.new(self).instance_eval(&config_block)
-      self.orderable_fields.collect!{ |field| field.to_s }
-
-      self.default_order ||= {:field => self.orderable_fields.first, :direction => :desc}
-      
-      attach_orderable_scopes
-    end
-
     # Attaches the ordered_from named scope to the model requesting it.  The named scope can be chained in the
     # controller by using:
     #
@@ -137,16 +144,21 @@ module Listalicious #:nodoc:
     # Which will generate the order clause +"last_name DESC, first_name ASC"+.
     def attach_orderable_scopes
       self.named_scope :ordered_from, lambda { |params|
-        return unless params.include?(:order) and params[:order][self.table_name.to_sym]
-
-        fields = params[:order][self.table_name.to_sym].collect do |field_and_dir|
-          field, dir = field_and_dir.split(':')
-          self.orderable_fields.include?(field) ? [field, dir.to_s.downcase] : nil
-        end.compact
-
+        fields = []
+        if params.include?(:order) and params[:order][self.table_name.to_sym]
+          fields = params[:order][self.table_name.to_sym].collect do |field_and_dir|
+            field, dir = field_and_dir.split(':')
+            self.orderable_fields.include?(field) ? [field, dir.to_s.downcase] : nil
+          end.compact
+        end
+
+        if self.default_order && fields.empty? || self.default_order[:options][:stable]
+          fields << [self.default_order[:field], self.default_order[:direction]]
+        end
+        
         fields.empty? ?
           nil :
-          {:order => fields.map{ |field, dir| "#{field} #{dir.downcase == 'desc' ? 'DESC' : 'ASC'}" }.join(', ')}
+          {:order => fields.map{ |field, dir| "#{field} #{dir.to_s.downcase == 'desc' ? 'DESC' : 'ASC'}" }.join(', ')}
       }
     end
 

data/listalicious.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{listalicious}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Jackson"]
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Semantic lists (datagrids) for Rails}
+  s.summary = %q{Semantic lists (aka datagrids) for Rails}
   s.test_files = [
     "test/helper.rb",
      "test/test_listalicious.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: listalicious
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Jeremy Jackson
@@ -71,7 +71,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Semantic lists (datagrids) for Rails
+summary: Semantic lists (aka datagrids) for Rails
 test_files: 
 - test/helper.rb
 - test/test_listalicious.rb