datagrid 0.1.2 → 0.2.0

data/{Readme.md → Readme.markdown}

@@ -66,7 +66,7 @@ end
 Basic grid api:
 
 ``` ruby
-report = SimpleReport.new(:order => "group", :reverse => true, :group_id => [1,2], :from_logins_count => 1, :category => "first")
+report = SimpleReport.new(:order => "group", :descending => true, :group_id => [1,2], :from_logins_count => 1, :category => "first")
 
 report.assets # => Array of User instances: 
               # SELECT * FROM users WHERE users.group_id in (1,2) AND users.logins_count >= 1 AND users.category = 'first' ORDER BY groups.name DESC
@@ -111,7 +111,7 @@ Read more about filters here:
 ### Columns
 
 Each column is represented by name and code block to calculate the value.
-Grids are sortable by it's columns. Ordering is controller by `#order` and `#reverse` attributes.
+Grids are sortable by it's columns. Ordering is controller by `#order` and `#descending` attributes.
 
 More information about columns here:
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/datagrid.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datagrid}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "Gemfile.lock",
     "LICENSE.txt",
     "Rakefile",
-    "Readme.md",
+    "Readme.markdown",
     "VERSION",
     "datagrid.gemspec",
     "lib/datagrid.rb",
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     "lib/datagrid/form_builder.rb",
     "lib/datagrid/helper.rb",
     "lib/datagrid/rspec.rb",
+    "lib/datagrid/utils.rb",
     "spec/datagrid/columns_spec.rb",
     "spec/datagrid/filters_spec.rb",
     "spec/datagrid/form_builder_spec.rb",

data/lib/datagrid/columns.rb

@@ -1,3 +1,5 @@
+require "datagrid/utils"
+
 module Datagrid
   
   class OrderUnsupported < StandardError
@@ -13,7 +15,9 @@ module Datagrid
         include Datagrid::Core
 
         datagrid_attribute :order
-        datagrid_attribute :reverse
+        datagrid_attribute :descending do |value|
+          Datagrid::Utils.booleanize(value)
+        end
 
 
       end
@@ -63,26 +67,32 @@ module Datagrid
       # = Column value
       #
       # Column value can be defined by passing a block to <tt>#column</tt> method.
-      # If no block given column is generated automatically by sending column name method to model.
+      # If no block given column it is generated automatically by sending column name method to model.
       # The block could have zero arguments(<tt>instance_eval</tt>) or one argument that is model object.
       #
+      # = Column options
+      #
+      # The following options can be passed to column definition:
+      #
+      # * <tt>:order</tt> - an order SQL that should be used to sort by this column. 
+      # Default: report column name if there is database column with this name.
+      # * <tt>:order_desc</tt> - descending order expression from this column. Default: "#{order} desc".
+      #
+      # TODO: frontend options description
+      #
       # = Columns order
       #
       # Each column supports <tt>:order</tt> option that is used to specify SQL to sort data by the given column.
-      # In order to specify order for the given grid the following attributes are used:
+      # In order to specify order the following attributes are used:
       #
-      # * <tt>:order</tt> - column name to use order. Default: nil.
-      # * <tt>:reverse</tt> - if true descending suffix is added to specified order. Default: false.
+      # * <tt>:order</tt> - column name to sort with as <tt>Symbol</tt>. Default: nil.
+      # * <tt>:descending</tt> - if true descending suffix is added to specified order. Default: false.
       #
-      # 
       # Example:
       #
-      #   grid = UserGrid.new(:order => :group, :reverse => true)
+      #   grid = UserGrid.new(:order => :group, :descending => true)
       #   grid.assets # => Return assets ordered by :group column descending
       #
-      # = Options
-      #
-      # TODO
       def column(name, options = {}, &block)
         check_scope_defined!("Scope should be defined before columns")
         block ||= lambda do |model|
@@ -135,7 +145,7 @@ module Datagrid
         if self.order
           column = column_by_name(self.order)
           raise Datagrid::OrderUnsupported, "Can not sort #{self.inspect} by #{name.inspect}" unless column
-          result = result.order(self.reverse ? column.desc_order : column.order)
+          result = result.order(self.descending ? column.desc_order : column.order)
         end
         result
       end

data/lib/datagrid/helper.rb

@@ -32,6 +32,7 @@ module Datagrid
 
     def datagrid_header(grid, options = {})
       header = empty_string
+      options[:order] = true unless options.has_key?(:order)
       grid.columns.each do |column|
         data = _safe(column.header)
         if options[:order] && column.order
@@ -60,7 +61,7 @@ module Datagrid
           :class => "order asc"
         ) + " " + link_to(
           I18n.t("datagrid.table.order.desc", :default => "DESC"),
-          url_for(grid.param_name => grid.attributes.merge(:order => column.name, :reverse => true )),
+          url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => true )),
           :class => "order desc"
         )
       end

data/lib/datagrid/rspec.rb

@@ -21,8 +21,8 @@ shared_examples_for "Datagrid" do
           subject.assets.first.should_not be_nil
         end
 
-        it "should support reverse order" do
-          subject.reverse = true
+        it "should support descending order" do
+          subject.descending = true
           subject.assets.first.should_not be_nil
         end
       end

data/lib/datagrid/utils.rb

@@ -0,0 +1,12 @@
+module Datagrid
+  module Utils
+    class << self
+
+      TRUTH =["1", true, 1, "true", "yes"] 
+
+      def booleanize(value)
+        TRUTH.include?(value)
+      end
+    end
+  end
+end

data/spec/datagrid_spec.rb

@@ -26,7 +26,7 @@ describe Datagrid do
 
   describe ".attributes" do
     it "should return report attributes" do
-      (subject.filters.map(&:name) + [:order, :reverse]).each do |attribute|
+      (subject.filters.map(&:name) + [:order, :descending]).each do |attribute|
         subject.attributes.should have_key(attribute)
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: datagrid
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -211,7 +211,7 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - Rakefile
-- Readme.md
+- Readme.markdown
 - VERSION
 - datagrid.gemspec
 - lib/datagrid.rb
@@ -231,6 +231,7 @@ files:
 - lib/datagrid/form_builder.rb
 - lib/datagrid/helper.rb
 - lib/datagrid/rspec.rb
+- lib/datagrid/utils.rb
 - spec/datagrid/columns_spec.rb
 - spec/datagrid/filters_spec.rb
 - spec/datagrid/form_builder_spec.rb