datagrid 0.3.3 → 0.3.4

data/Readme.markdown

@@ -1,6 +1,6 @@
 # Datagrid
 
-Ruby library that helps you to build and repsend table like data with:
+Ruby library that helps you to build and represent table-like data with:
 
 * Customizable filtering
 * Columns
@@ -9,18 +9,13 @@ Ruby library that helps you to build and repsend table like data with:
 * Export to CSV
 
 
-*NOTE:* This gem is still under heavy development. If you find a bug don't consider this a peace of shit, just report it and I'll fix it shortly. 
-
-*This is not trivial staff, so a really need your help guys.*
-
-
 ### Grid DSL
 
-In order to create a report You need to define:
+In order to create a report, you need to define:
 
 * scope of ActiveRecord objects to look through
 * filters that will be used to filter data
-* columns that should be displayed and sortable(if possible)
+* columns that should be displayed and sortable (if possible)
 
 
 ### Working grid example
@@ -125,6 +120,13 @@ Datagrid supports different type of filters including:
 ### Columns
 
 Each column is represented by name and code block to calculate the value.
+
+``` ruby
+column(:activated, :header => "Active", :order => "activated") do
+  self.activated?
+end
+```
+
 Some formatting options are also available. 
 Each column is sortable.
 
@@ -132,6 +134,7 @@ Each column is sortable.
 
 ### Front end
 
+
 In order to create form for your report you can use all set of rails built-in tools.
 
 More over Datagrid provides you two additional form helpers:
@@ -164,5 +167,7 @@ There is a simple helper set of helpers that allows you display report:
 = will_paginate assets
 ```
 
+If you need a custom interface for your report you should probably build it yourself with datagrid helpers.
+
 [More about frontend](https://github.com/bogdan/datagrid/wiki/Frontend)
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datagrid}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = %q{2011-07-07}
+  s.date = %q{2011-08-10}
   s.description = %q{This allows you to easily build datagrid aka data tables with sortable columns and filters}
   s.email = %q{agresso@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "lib/datagrid.rb",
     "lib/datagrid/columns.rb",
     "lib/datagrid/columns/column.rb",
+    "lib/datagrid/conversion.rb",
     "lib/datagrid/core.rb",
     "lib/datagrid/filters.rb",
     "lib/datagrid/filters/base_filter.rb",
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
     "lib/datagrid/filters/string_filter.rb",
     "lib/datagrid/form_builder.rb",
     "lib/datagrid/helper.rb",
+    "lib/datagrid/ordering.rb",
     "lib/datagrid/rspec.rb",
     "lib/datagrid/utils.rb",
     "spec/datagrid/columns_spec.rb",
@@ -57,10 +59,11 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/bogdan/datagrid}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby gem to create datagrids}
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/datagrid.rb

@@ -1,6 +1,8 @@
+require "datagrid/core"
+require "datagrid/conversion"
 require "datagrid/filters"
 require "datagrid/columns"
-require "datagrid/core"
+require "datagrid/ordering"
 
 require "datagrid/helper"
 require "datagrid/form_builder"
@@ -12,8 +14,10 @@ module Datagrid
     base.class_eval do
 
       include ::Datagrid::Core
+      include ::Datagrid::Conversion
       include ::Datagrid::Filters
       include ::Datagrid::Columns
+      include ::Datagrid::Ordering
 
     end
     base.send :include, InstanceMethods

data/lib/datagrid/columns.rb

@@ -2,8 +2,6 @@ require "datagrid/utils"
 
 module Datagrid
   
-  class OrderUnsupported < StandardError
-  end
   
   module Columns
     require "datagrid/columns/column"
@@ -14,28 +12,6 @@ module Datagrid
 
         include Datagrid::Core
 
-        datagrid_attribute :order do |value|
-          unless value.blank?
-            value = value.to_sym
-            column = column_by_name(value)
-            unless column 
-              order_unsupported(value, "no column #{value} in #{self.class}")
-            end
-            unless column.order
-              order_unsupported(
-                name, "#{self.class}##{name} don't support order" 
-              ) 
-            end
-            value
-          else
-            nil
-          end
-
-        end
-        datagrid_attribute :descending do |value|
-          Datagrid::Utils.booleanize(value)
-        end
-
 
       end
       base.send :include, InstanceMethods
@@ -55,10 +31,6 @@ module Datagrid
         self.columns << Datagrid::Columns::Column.new(self, name, options, &block)
       end
 
-      def order_unsupported(name, reason)
-        raise Datagrid::OrderUnsupported, "Can not sort #{self.inspect} by ##{name}: #{reason}"
-      end
-
       def column_by_name(name)
         self.columns.find do |col|
           col.name.to_sym == name.to_sym
@@ -105,15 +77,6 @@ module Datagrid
         end
       end
 
-      def assets
-        result = super
-        if self.order
-          column = column_by_name(self.order)
-          result = apply_order(result, self.descending ? column.desc_order : column.order)
-        end
-        result
-      end
-
       def to_csv(options = {})
         klass = if RUBY_VERSION >= "1.9"
                   require 'csv'
@@ -139,14 +102,6 @@ module Datagrid
         self.class.column_by_name(name)
       end
 
-      private
-
-      def apply_order(assets, order)
-        # Rails 3.0.x don't able to override already applied order
-        # Using #reorder instead
-        assets.respond_to?(:reorder) ? assets.reorder(order) : assets.order(order)
-      end
-
     end # InstanceMethods
 
   end

data/lib/datagrid/columns/column.rb

@@ -46,7 +46,8 @@ class Datagrid::Columns::Column
   end
 
   def desc_order
-    self.options[:desc_order]  || (order ? order.to_s + " DESC" : nil)
+    return nil unless order
+    self.options[:desc_order]  
   end
 
 end

data/lib/datagrid/conversion.rb

@@ -0,0 +1,52 @@
+module Datagrid
+
+  # Required to be ActiveModel compatible
+  module Conversion
+  
+    def self.included(base)
+      base.extend         ClassMethods
+      base.class_eval do
+        
+      end
+      base.send :include, InstanceMethods
+    end # self.included
+  
+    module ClassMethods
+  
+      def param_name
+        self.to_s.underscore.split('/').last
+      end
+
+      def model_name
+        self.param_name
+      end
+
+    end # ClassMethods
+  
+    module InstanceMethods
+  
+      def param_name
+        self.class.param_name
+      end
+
+      def to_key
+        [self.class.param_name]
+      end
+
+      def persisted?
+        false
+      end
+
+      def to_model
+        self
+      end
+
+      def to_param
+        self.param_name
+      end
+    end # InstanceMethods
+  
+  end
+    
+  
+end

data/lib/datagrid/core.rb

@@ -1,3 +1,5 @@
+require "active_record"
+
 module Datagrid
   module Core
 
@@ -40,14 +42,6 @@ module Datagrid
         end
       end
 
-      def param_name
-        self.to_s.underscore.split('/').last
-      end
-
-      # Required for ActionView form builder
-      def model_name
-        self.param_name
-      end
 
       protected
       def check_scope_defined!(message = "Scope not defined")
@@ -101,19 +95,6 @@ module Datagrid
       end
 
 
-      def param_name
-        self.class.param_name
-      end
-
-      # Required for ActionView form builder
-      def to_key
-        [self.class.param_name]
-      end
-
-      # Required for ActionView form builder
-      def persisted?
-        false
-      end
       
       protected
 

data/lib/datagrid/filters/boolean_enum_filter.rb

@@ -2,7 +2,9 @@ class Datagrid::Filters::BooleanEnumFilter < Datagrid::Filters::EnumFilter
 
   YES = "YES"
   NO = "NO"
-  VALUES = {YES => true, NO => false}
+  VALUES = ActiveSupport::OrderedHash.new
+  VALUES[YES] = YES
+  VALUES[NO] = NO
 
   def initialize(report, attribute, options = {}, &block)
     options[:select] = VALUES.keys

data/lib/datagrid/filters/boolean_filter.rb

@@ -1,7 +1,8 @@
+require "datagrid/utils"
 class Datagrid::Filters::BooleanFilter < Datagrid::Filters::BaseFilter
 
   def format(value)
-    [true, 1, "1", "true", "yes", "on"].include?(value)
+    Datagrid::Utils.booleanize(value)
   end
 
 end

data/lib/datagrid/ordering.rb

@@ -0,0 +1,87 @@
+require "datagrid/columns"
+
+module Datagrid
+  class OrderUnsupported < StandardError
+  end
+  module Ordering
+
+    def self.included(base)
+      base.extend         ClassMethods
+      base.class_eval do
+        include Datagrid::Columns
+
+        datagrid_attribute :order do |value|
+          unless value.blank?
+            value = value.to_sym
+            column = column_by_name(value)
+            unless column 
+              order_unsupported(value, "no column #{value} in #{self.class}")
+            end
+            unless column.order
+              order_unsupported(
+                name, "#{self.class}##{name} don't support order" 
+              ) 
+            end
+            value
+          else
+            nil
+          end
+
+        end
+
+        datagrid_attribute :descending do |value|
+          Datagrid::Utils.booleanize(value)
+        end
+        alias descending? descending
+
+      end
+      base.send :include, InstanceMethods
+    end # self.included
+
+    module ClassMethods
+
+      def order_unsupported(name, reason)
+        raise Datagrid::OrderUnsupported, "Can not sort #{self.inspect} by ##{name}: #{reason}"
+      end
+
+    end # ClassMethods
+
+    module InstanceMethods
+
+      def assets
+        result = super
+        if self.order
+          column = column_by_name(self.order)
+          result = apply_order(result, column)
+        end
+        result
+      end
+
+      private
+
+      def apply_order(assets, column)
+
+        # Rails 3.0.x don't able to override already applied order
+        # Using #reorder instead
+        order_method = assets.respond_to?(:reorder) ? :reorder : :order # Rails 3?
+
+        order = column.order
+        if self.descending?
+          if column.order_desc
+            assets.send(order_method, column.order_desc) 
+          else
+            if assets.respond_to?(:reverse_order) # Rails 3?
+              assets.reorder(order).reverse_order
+            else
+              assets.order(ActiveRecord::Base.send(:reverse_sql_order, order))
+            end
+          end
+        else
+          assets.send(order_method, order)
+        end
+      end
+
+    end # InstanceMethods
+
+  end
+end

data/lib/datagrid/utils.rb

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

data/spec/datagrid/filters_spec.rb

@@ -22,6 +22,7 @@ describe Datagrid::Filters do
 
   it "should initialize report Scope table not exists" do
     class ModelWithoutTable < ActiveRecord::Base; end
+    ModelWithoutTable.should_not be_table_exists
     class TheReport
       include Datagrid
 
@@ -29,6 +30,7 @@ describe Datagrid::Filters do
 
       filter(:name)
     end
+    TheReport.new(:name => 'hello')
 
   end
   

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: datagrid
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.3.3
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -10,141 +15,187 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 +03:00
+date: 2011-08-10 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rails
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id001
   type: :runtime
+  name: rails
   prerelease: false
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
+  requirement: *id002
   type: :development
+  name: rake
   prerelease: false
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id003
   type: :development
+  name: mocha
   prerelease: false
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
         version: 2.6.0
+  requirement: *id004
   type: :development
+  name: rspec
   prerelease: false
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
+  requirement: *id005
   type: :development
+  name: bundler
   prerelease: false
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
         version: 1.6.0
+  requirement: *id006
   type: :development
+  name: jeweler
   prerelease: false
-  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id007
   type: :development
+  name: rcov
   prerelease: false
-  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id008
   type: :development
+  name: ruby-debug
   prerelease: false
-  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id009
   type: :development
+  name: sqlite3-ruby
   prerelease: false
-  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: fastercsv
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id010
   type: :development
+  name: fastercsv
   prerelease: false
-  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
+  requirement: *id011
   type: :development
+  name: nokogiri
   prerelease: false
-  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
-  name: will_paginate
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 3
+        - 15
         version: 2.3.15
+  requirement: *id012
   type: :development
+  name: will_paginate
   prerelease: false
-  version_requirements: *id012
 description: This allows you to easily build datagrid aka data tables with sortable columns and filters
 email: agresso@gmail.com
 executables: []
@@ -166,6 +217,7 @@ files:
 - lib/datagrid.rb
 - lib/datagrid/columns.rb
 - lib/datagrid/columns/column.rb
+- lib/datagrid/conversion.rb
 - lib/datagrid/core.rb
 - lib/datagrid/filters.rb
 - lib/datagrid/filters/base_filter.rb
@@ -180,6 +232,7 @@ files:
 - lib/datagrid/filters/string_filter.rb
 - lib/datagrid/form_builder.rb
 - lib/datagrid/helper.rb
+- lib/datagrid/ordering.rb
 - lib/datagrid/rspec.rb
 - lib/datagrid/utils.rb
 - spec/datagrid/columns_spec.rb
@@ -205,7 +258,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2656529442255327450
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -214,11 +267,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby gem to create datagrids