datagrid 0.7.1 → 0.8.0

data/Gemfile

@@ -3,14 +3,15 @@ source "http://rubygems.org"
 gem "rails", ">= 3.0"
 
 
-
 group :development do
 
   gem "rake"
   gem "bundler"
   gem "jeweler"
 
+
   gem "debugger", :platform => "ruby_19"
+  gem "ruby-debug", :platform => "ruby_18"
 
   gem "rspec"
   gem "nokogiri" # used to test html output

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/app/views/datagrid/_order_for.html.erb

@@ -0,0 +1,10 @@
+<div class="order">
+  <%= link_to(
+      I18n.t("datagrid.table.order.asc", :default => "&uarr;".html_safe).html_safe,
+      url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => false)),
+      :class => "order asc") %>
+  <%= link_to(
+      I18n.t("datagrid.table.order.desc", :default => "&darr;".html_safe).html_safe,
+      url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => true )),
+      :class => "order desc") %>
+</div>

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "0.7.1"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-01-15"
+  s.date = "2013-04-07"
   s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters"
   s.email = "agresso@gmail.com"
   s.extra_rdoc_files = [
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     "Readme.markdown",
     "VERSION",
     "app/views/datagrid/_head.html.erb",
+    "app/views/datagrid/_order_for.html.erb",
     "app/views/datagrid/_row.html.erb",
     "app/views/datagrid/_table.html.erb",
     "datagrid.gemspec",
@@ -55,6 +56,7 @@ Gem::Specification.new do |s|
     "lib/datagrid/ordering.rb",
     "lib/datagrid/renderer.rb",
     "lib/datagrid/rspec.rb",
+    "lib/datagrid/scaffold.rb",
     "lib/datagrid/utils.rb",
     "lib/tasks/datagrid_tasks.rake",
     "spec/datagrid/active_model_spec.rb",
@@ -81,7 +83,12 @@ Gem::Specification.new do |s|
     "spec/support/mongo_mapper.rb",
     "spec/support/mongoid.rb",
     "spec/support/simple_report.rb",
-    "spec/support/test_partials/_actions.html.erb"
+    "spec/support/test_partials/_actions.html.erb",
+    "template/controller.rb.erb",
+    "template/grid.rb.erb",
+    "templates/controller.rb.erb",
+    "templates/grid.rb.erb",
+    "templates/index.html.erb"
   ]
   s.homepage = "http://github.com/bogdan/datagrid"
   s.licenses = ["MIT"]
@@ -98,6 +105,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<debugger>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<nokogiri>, [">= 0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
@@ -112,6 +120,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<debugger>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
@@ -127,6 +136,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<debugger>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])

data/lib/datagrid.rb

@@ -31,23 +31,16 @@ module Datagrid
       include ::Datagrid::Ordering
 
     end
-    base.send :include, InstanceMethods
   end # self.included
 
   module ClassMethods
-
-
   end # ClassMethods
 
-  module InstanceMethods
-
-  end # InstanceMethods
-
   class ConfigurationError < StandardError; end
   class ArgumentError < ::ArgumentError; end
 
-
 end
 
+require "datagrid/scaffold"
 
 

data/lib/datagrid/columns.rb

@@ -21,11 +21,13 @@ module Datagrid
     module ClassMethods
 
       # Returns a list of columns defined.
+      # All column definistion are returned by default
       # You can limit the output with only columns you need like:
       #
       #   grid.columns(:id, :name)
       #
       # Supported options:
+      #
       # * :data - if true returns only non-html columns. Default: false.
       def columns(*args)
         options = args.extract_options!
@@ -94,15 +96,27 @@ module Datagrid
         self.rows.unshift(self.header)
       end
 
-      # Return Array of Hashes where keys are column names and values are column values for each row in datagrid <tt>#assets</tt>
+      # Return Array of Hashes where keys are column names and values are column values 
+      # for each row in datagrid <tt>#assets</tt>
       def data_hash
         self.assets.map do |asset|
           hash_for(asset)
         end
       end
 
+      # Returns a CSV representation of the data in the table
+      # You are able to specify which columns you want to see in CSV.
+      # All data columns are included by default
+      # Also you can specify options hash as last argument that is proxied to
+      # Ruby CSV library.
+      #
+      # Example:
+      #
+      #   grid.to_csv
+      #   grid.to_csv(:id, :name)
+      #   grid.to_csv(:col_sep => ';')
       def to_csv(*column_names)
-        options = columns.extract_options!
+        options = column_names.extract_options!
         klass = if RUBY_VERSION >= "1.9"
                   require 'csv'
                   CSV

data/lib/datagrid/filters.rb

@@ -84,7 +84,8 @@ module Datagrid
       def assets
         result = super
         self.class.filters.each do |filter|
-          result = filter.apply(self, result, filter_value(filter))
+          result_filter = filter.apply(self, result, filter_value(filter))
+          result = result_filter if result_filter
         end
         result
       end

data/lib/datagrid/renderer.rb

@@ -72,17 +72,7 @@ module Datagrid
     end
 
     def order_for(grid, column)
-      @template.content_tag(:div, :class => "order") do
-        @template.link_to(
-          I18n.t("datagrid.table.order.asc", :default => "↑".html_safe),
-          @template.url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => false)),
-          :class => "order asc"
-        ) + " " + @template.link_to(
-          I18n.t("datagrid.table.order.desc", :default => "↓".html_safe),
-          @template.url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => true )),
-          :class => "order desc"
-        )
-      end
+      @template.render :partial => "datagrid/order_for", :locals => { :grid => grid, :column => column }
     end
 
 

data/lib/datagrid/scaffold.rb

@@ -0,0 +1,58 @@
+require "rails/generators"
+
+class Datagrid::Scaffold < Rails::Generators::NamedBase
+  source_root File.expand_path(__FILE__ + "/../../../templates")
+
+  def create_scaffold
+    template "grid.rb.erb", "app/grids/#{grid_class_name.underscore}.rb"
+    template "controller.rb.erb", "app/controllers/#{grid_controller_name.underscore}.rb"
+    template "index.html.erb", "app/views/#{grid_controller_short_name}/index.html.erb"
+    route("resources :#{grid_controller_short_name}")
+  end
+
+  def grid_class_name
+    file_name.camelize.pluralize + "Grid"
+  end
+  
+  def grid_controller_name
+    grid_controller_short_name.camelize + "Controller"
+  end
+
+  def grid_controller_short_name
+    file_name.underscore.pluralize
+  end
+
+  def grid_model_name
+    file_name.camelize.singularize
+  end
+
+  def grid_ivar_name
+    grid_class_name.underscore
+  end
+
+  def paginate_code
+    if defined?(Kaminari)
+      "page(params[:page])"
+    elsif defned?(WillPaginate)
+      "paginate(:page => params[:page])"
+    else
+      "paginate_somehow"
+    end
+  end
+
+  def pagination_helper_code
+    if defined?(Kaminari)
+      "paginate(@assets)"
+    elsif defned?(WillPaginate)
+      "will_paginate(@assets)"
+    else
+      "some_pagination_helper(@assets)"
+    end
+
+  end
+
+  def grid_route_name
+    grid_controller_short_name + "_path"
+  end
+
+end

data/lib/tasks/datagrid_tasks.rake

@@ -13,6 +13,7 @@ namespace :datagrid do
     end
     copy_template "views/datagrid/_table.html.erb"
     copy_template "views/datagrid/_head.html.erb"
+    copy_template "views/datagrid/_order_for.html.erb"
     copy_template "views/datagrid/_row.html.erb"
   end
 

data/spec/datagrid/columns_spec.rb

@@ -53,6 +53,10 @@ describe Datagrid::Columns do
     it "should support csv export of particular columns" do
       subject.to_csv(:name).should == "Name\nStar\n"
     end
+    
+    it "should support csv export options" do
+      subject.to_csv(:col_sep => ";").should == "Group;Name;Access level;Pet\nPop;Star;admin;ROTTWEILER\n"
+    end
   end
 
   it "should support columns with model and report arguments" do

data/spec/datagrid/filters_spec.rb

@@ -114,4 +114,19 @@ describe Datagrid::Filters do
     end
     
   end
+  describe "default filter as scope" do
+    it "should create default filter if scope respond to filter name method" do
+      Entry.create!
+      grid = test_report(:custom => 'skip') do
+        scope {Entry}
+        filter(:custom) do |value|
+          if value != 'skip'
+            where(:custom => value)
+          end
+        end
+      end
+      grid.assets.should_not be_empty
+    end
+    
+  end
 end

data/spec/datagrid/helper_spec.rb

@@ -272,7 +272,8 @@ describe Datagrid::Helper do
         grid = OrderedGrid.new(:descending => true, :order => :category)
         subject.datagrid_order_for(grid, grid.column_by_name(:category)).should equal_to_dom(<<-HTML)
 <div class="order">
-<a href="ordered_grid%5Bdescending%5D=false&amp;ordered_grid%5Border%5D=category" class="order asc">&uarr;</a> <a href="ordered_grid%5Bdescending%5D=true&amp;ordered_grid%5Border%5D=category" class="order desc">&darr;</a>
+  <a href="ordered_grid%5Bdescending%5D=false&amp;ordered_grid%5Border%5D=category" class="order asc">&uarr;</a>
+  <a href="ordered_grid%5Bdescending%5D=true&amp;ordered_grid%5Border%5D=category" class="order desc">&darr;</a>
 </div>
         HTML
       end

data/spec/support/matchers.rb

@@ -34,17 +34,24 @@ end
 class EqualToDom
 
   def initialize(expectation)
-    @expectation = Nokogiri::HTML::DocumentFragment.parse(expectation.strip).to_s
+    @expectation = Nokogiri::HTML::DocumentFragment.parse(force_encoding(expectation).strip).to_s
   end
 
   def matches?(text)
-    @matcher = Nokogiri::HTML::DocumentFragment.parse(text.strip).to_s
+
+    @matcher = Nokogiri::HTML::DocumentFragment.parse(force_encoding(text).strip).to_s
     @matcher == @expectation
   end
 
   def failure_message
     "Expected dom #{@matcher} to match #{@expectation}, but it wasn't"
   end
+
+  private
+
+  def force_encoding(text)
+    "1.9.3".respond_to?(:force_encoding) ? text.clone.force_encoding("UTF-8") : text
+  end
 end
 
 

data/template/controller.rb.erb

@@ -0,0 +1,9 @@
+class <%= class_name %>Controller < ApplicationController
+
+  def index
+    @grid = <%= class_name %>Grid.new(params[:<%= (class_name + "Grid").underscore %>])
+    @assets = @grid.assets.page(params[:page])
+  end
+
+end
+

data/template/grid.rb.erb

@@ -0,0 +1,10 @@
+class <%= class_name %>Grid
+
+  include Datagrid
+
+  scope do
+    <%= class_name.singularize %>
+  end
+
+  column(:id)
+end

data/templates/controller.rb.erb

@@ -0,0 +1,9 @@
+class <%= grid_controller_name %> < ApplicationController
+
+  def index
+    @grid = <%= grid_class_name %>.new(params[:<%= grid_ivar_name %>])
+    @assets = @grid.assets.<%= paginate_code %>
+  end
+
+end
+

data/templates/grid.rb.erb

@@ -0,0 +1,17 @@
+class <%= grid_class_name %>
+
+  include Datagrid
+
+  scope do
+    <%= grid_model_name %>
+  end
+
+  filter(:id, :integer)
+  filter(:created_at, :date, :range => true)
+
+  column(:id)
+  column(:name)
+  column(:created_at) do |model|
+    model.created_at.to_date
+  end
+end

data/templates/index.html.erb

@@ -0,0 +1,13 @@
+<%%= form_for @grid, :method => :get, :url => <%= grid_route_name %> do |f| %>
+  <%% @grid.filters.each do |filter| %>
+    <div class="field">
+      <%%= f.datagrid_label filter %>
+      <%%= f.datagrid_filter filter %>
+    </div>
+  <%% end %>
+  <%%= f.submit %>
+<%% end %>
+
+<%%= <%=pagination_helper_code%> %>
+<%%= datagrid_table @grid, @assets %>
+<%%= <%=pagination_helper_code%> %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +251,7 @@ files:
 - Readme.markdown
 - VERSION
 - app/views/datagrid/_head.html.erb
+- app/views/datagrid/_order_for.html.erb
 - app/views/datagrid/_row.html.erb
 - app/views/datagrid/_table.html.erb
 - datagrid.gemspec
@@ -266,6 +283,7 @@ files:
 - lib/datagrid/ordering.rb
 - lib/datagrid/renderer.rb
 - lib/datagrid/rspec.rb
+- lib/datagrid/scaffold.rb
 - lib/datagrid/utils.rb
 - lib/tasks/datagrid_tasks.rake
 - spec/datagrid/active_model_spec.rb
@@ -293,6 +311,11 @@ files:
 - spec/support/mongoid.rb
 - spec/support/simple_report.rb
 - spec/support/test_partials/_actions.html.erb
+- template/controller.rb.erb
+- template/grid.rb.erb
+- templates/controller.rb.erb
+- templates/grid.rb.erb
+- templates/index.html.erb
 homepage: http://github.com/bogdan/datagrid
 licenses:
 - MIT
@@ -308,7 +331,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1867326624462415975
+      hash: 1083654781262067166
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: