datagrid 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a4a2eb29ee46c28e9a999c0344f1b7552259e1b
-  data.tar.gz: 758b66ea4521616cbb3dc76ac959a228446c33c6
+  metadata.gz: 652aabb87668eb9c636d3a0b03249f79f8df4c1b
+  data.tar.gz: 71de05a4267561305a3e2badc2aa33e1eb88cf35
 SHA512:
-  metadata.gz: 6232d055d5c2b037a18007ac3e77ec1423863da9a8e0085420a49d4275459c3d3e68f0451c285941d14cae0741ceadc6a62d866d279cd39d5db6bcc52a02969e
-  data.tar.gz: 8b06d12a459dd0a8cd2115d1c8721f5676859d747fc08cd890c748fb2949f8b4177050379ac040caf5b16883960f6e39f2729be22074f9b5e2670ba594aa972d
+  metadata.gz: 5db3557c03071721e24d355ac939ab76f29167c252c9cfda160a618e4f1b7737dfc241c808de1ccd1a75a8c7b2a9c16490a1d96500065c196413f6548e47b9ed
+  data.tar.gz: c34e6068303b5aa6d351869fe7d734cc4034305de5e649ea9480e74ec3dddb39b2d34ff16277f1f4a792c670d36b09cf8b826a0888a8d23906c1682facd68ac9

data/Readme.markdown

@@ -40,19 +40,19 @@ class UsersGrid
     User.includes(:group)
   end
 
-  filter(:category, :enum, :select => ["first", "second"])
+  filter(:category, :enum, select: ["first", "second"])
   filter(:disabled, :xboolean)
-  filter(:group_id, :integer, :multiple => true)
-  filter(:logins_count, :integer, :range => true)
-  filter(:group_name, :string, :header => "Group") do |value|
+  filter(:group_id, :integer, multiple: true)
+  filter(:logins_count, :integer, range: true)
+  filter(:group_name, :string, header: "Group") do |value|
     self.joins(:group).where(:groups => {:name => value})
   end
 
   column(:name)
-  column(:group, :order => "groups.name") do |user|
+  column(:group, order: -> { joins(:group).order(groups: :name) }) do |user|
     user.name
   end
-  column(:active, :header => "Activated") do |user|
+  column(:active, header: "Activated") do |user|
     !user.disabled
   end
 

data/VERSION

@@ -1 +1 @@
-1.4.3
+1.4.4

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

@@ -1,4 +1,4 @@
-<tr class="<%= options[:cycle] && cycle(*options[:cycle]) %>">
+<tr>
   <% grid.html_columns(*options[:columns]).each do |column| %>
     <td class="<%= datagrid_column_classes(grid, column) %>"><%= datagrid_value(grid, column, asset) %></td>
   <% end %>

data/datagrid.gemspec

@@ -2,21 +2,20 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: datagrid 1.4.3 ruby lib
+# stub: datagrid 1.4.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "1.4.3"
+  s.version = "1.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2016-03-31"
+  s.date = "2016-07-22"
   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 = [
-    "LICENSE.txt",
-    "Readme.markdown"
+    "LICENSE.txt"
   ]
   s.files = [
     ".document",
@@ -129,7 +128,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/bogdan/datagrid"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.7"
+  s.rubygems_version = "2.5.1"
   s.summary = "Ruby gem to create datagrids"
 
   if s.respond_to? :specification_version then

data/lib/datagrid/columns.rb

@@ -21,10 +21,13 @@ module Datagrid
         self.columns_array = []
 
         class_attribute :dynamic_block, :instance_writer => false
-        
+
         class_attribute :cached
         self.cached = false
 
+
+        class_attribute :decorator, instance_writer: false
+
       end
       base.send :include, InstanceMethods
     end # self.included
@@ -184,7 +187,7 @@ module Datagrid
       #             #    ]
       def dynamic(&block)
         previous_block = dynamic_block
-        self.dynamic_block = 
+        self.dynamic_block =
           if previous_block
             proc {
               instance_eval(&previous_block)
@@ -195,6 +198,23 @@ module Datagrid
           end
       end
 
+      # Defines a model decorator that will be used to define a column value.
+      # All column blocks will be given a decorated version of the model.
+      #
+      #   decorate { |user| UserPresenter.new(user) }
+      #
+      #   decorate { UserPresenter } # a shortcut
+      def decorate(model = nil, &block)
+        if !model && !block
+          raise ArgumentError, "decorate needs either a block to define decoration or a model to decorate"
+        end
+        return self.decorator = block unless model
+        return model unless decorator
+        presenter = ::Datagrid::Utils.apply_args(model, &decorator)
+        presenter = presenter.is_a?(Class) ?  presenter.new(model) : presenter
+        block_given? ? yield(presenter) : presenter
+      end
+
       def inherited(child_class) #:nodoc:
         super(child_class)
         child_class.columns_array = self.columns_array.clone
@@ -342,7 +362,7 @@ module Datagrid
       #   grid.columns # => id and name columns
       #   grid.columns(:id, :category) # => id and category column
       def columns(*args)
-        self.class.filter_columns(columns_array, *args).select {|column| column.enabled?(self)} 
+        self.class.filter_columns(columns_array, *args).select {|column| column.enabled?(self)}
       end
 
       # Returns all columns that can be represented in plain data(non-html) way
@@ -425,19 +445,21 @@ module Datagrid
       end
 
       # Returns all columns available for current grid configuration.
-      #   
+      #
       #   class MyGrid
-      #     filter(:search)
+      #     filter(:search) {|scope, value| scope.full_text_search(value)}
       #     column(:id)
       #     column(:name, :mandatory => true)
-      #     column(:search_match, :if => proc {|grid| grid.search.present? }
+      #     column(:search_match, :if => proc {|grid| grid.search.present? }) do |model, grid|
+      #       search_match_line(model.searchable_content, grid.search)
+      #     end
       #   end
       #
       #   grid = MyGrid.new
-      #   grid.columns # => [ <#Column:name> ]
-      #   grid.available_columns # => [ <#Column:id>, <#Column:name> ]
+      #   grid.columns # => [ #<Column:name> ]
+      #   grid.available_columns # => [ #<Column:id>, #<Column:name> ]
       #   grid.search = "keyword"
-      #   grid.available_columns # => [ <#Column:id>, <#Column:name>, <#Column:search_match> ] 
+      #   grid.available_columns # => [ #<Column:id>, #<Column:name>, #<Column:search_match> ]
       #
       def available_columns
         columns_array.select do |column|
@@ -468,17 +490,22 @@ module Datagrid
         end
       end
 
+      # Returns a decorated version of given model if decorator is specified or the model otherwise.
+      def decorate(model)
+        self.class.decorate(model)
+      end
 
       def generic_value(column, model) #:nodoc:
         cache(column, model, :generic_value) do
+          presenter = decorate(model)
           unless column.enabled?(self)
             raise Datagrid::ColumnUnavailableError, "Column #{column.name} disabled for #{inspect}"
           end
 
           if column.data_block.arity >= 1
-            Datagrid::Utils.apply_args(model, self, data_row(model), &column.data_block)
+            Datagrid::Utils.apply_args(presenter, self, data_row(model), &column.data_block)
           else
-            model.instance_eval(&column.data_block)
+            presenter.instance_eval(&column.data_block)
           end
         end
 

data/lib/datagrid/columns/column.rb

@@ -20,6 +20,10 @@ class Datagrid::Columns::Column
       data_block.call
     end
 
+    def to_s
+      call_data.to_s
+    end
+
     def call_html(context)
       context.instance_eval(&html_block)
     end
@@ -54,7 +58,7 @@ class Datagrid::Columns::Column
   end
 
   def header
-    if header = options[:header] 
+    if header = options[:header]
       callable(header)
     else
       Datagrid::Utils.translate_from_namespace(:columns, grid_class, name)
@@ -137,7 +141,7 @@ class Datagrid::Columns::Column
     when Proc
       option.call(grid)
     when Symbol, String
-      grid.send(option.to_sym) 
+      grid.send(option.to_sym)
     else
       raise Datagrid::ConfigurationError, "Incorrect column availability option: #{option.insepct}"
     end

data/lib/datagrid/core.rb

@@ -115,11 +115,6 @@ module Datagrid
         attributes
       end
 
-      def paginate(*args, &block) # :nodoc:
-        ::Datagrid::Utils.warn_once("#paginate is deprecated. Call it like object.assets.paginate(...).")
-        self.assets.paginate(*args, &block)
-      end
-
       # Redefines scope at instance level
       #
       #   class MyGrid

data/lib/datagrid/helper.rb

@@ -22,19 +22,19 @@ module Datagrid
     end
 
     # Renders html table with columns defined in grid class.
-    # In the most common used you need to pass paginated collection 
+    # In the most common used you need to pass paginated collection
     # to datagrid table because datagrid do not have pagination compatibilities:
-    #     
+    #
     #   assets = grid.assets.page(params[:page])
     #   datagrid_table(grid, assets, options)
     #
     # Supported options:
     #
     # * <tt>:html</tt> - hash of attributes for <table> tag
-    # * <tt>:order</tt> - If false do not generate ordering controlls. 
+    # * <tt>:order</tt> - If false do not generate ordering controlls.
     #   Default: true.
-    # * <tt>:columns</tt> - Array of column names to display. 
-    #   Used in case when same grid class is used in different places 
+    # * <tt>:columns</tt> - Array of column names to display.
+    #   Used in case when same grid class is used in different places
     #   and needs different columns. Default: all defined columns.
     # * <tt>:partials</tt> - Path for partials lookup.
     #   Default: 'datagrid'.
@@ -59,8 +59,8 @@ module Datagrid
     #
     # Supported options:
     #
-    # * <tt>:columns</tt> - Array of column names to display. 
-    #   Used in case when same grid class is used in different places 
+    # * <tt>:columns</tt> - Array of column names to display.
+    #   Used in case when same grid class is used in different places
     #   and needs different columns. Default: all defined columns.
     # * <tt>:partials</tt> - Path for partials lookup.
     #   Default: 'datagrid'.
@@ -108,12 +108,21 @@ module Datagrid
       end
     end
 
-    class HtmlRow #:nodoc:
-      def initialize(context, grid, asset)
+    # Represents a datagrid row that provides access to column values for the given asset
+    #
+    #   row = datagrid_row(grid, user)
+    #   row.first_name # => "<strong>Bogdan</strong>"
+    #   row.grid       # => Grid object
+    #   row.asset      # => User object
+    class HtmlRow
+
+      attr_reader :grid, :asset
+
+      def initialize(context, grid, asset) # :nodoc:
         @context = context
         @grid = grid
         @asset = asset
-      end 
+      end
 
       def method_missing(method, *args, &blk)
         if column = @grid.column_by_name(method)

data/lib/datagrid/renderer.rb

@@ -38,15 +38,7 @@ module Datagrid
       options = args.extract_options!
       options[:html] ||= {}
       options[:html][:class] ||= "datagrid #{@template.dom_class(grid)}"
-      if options[:cycle]
-        ::Datagrid::Utils.warn_once("datagrid_table cycle option is deprecated. Use css to style odd/even rows instead.")
-      end
       assets = args.any? ? args.shift : grid.assets
-      paginate = options[:paginate]
-      if paginate
-        ::Datagrid::Utils.warn_once(":paginate option is deprecated. Look to https://github.com/bogdan/datagrid/wiki/Frontend.")
-        assets = assets.paginate(paginate)
-      end
 
       _render_partial('table', options[:partials],
                       {

data/lib/datagrid/scaffold.rb

@@ -10,12 +10,12 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
   def create_scaffold
     template "grid.rb.erb", "app/grids/#{grid_class_name.underscore}.rb"
     if File.exists?(grid_controller_file)
-      inject_into_file grid_controller_file, index_action, :after => %r{class .*#{grid_controller_name}.*\n}
+      inject_into_file grid_controller_file, index_action, :after => %r{class .*#{grid_controller_class_name}.*\n}
     else
       template "controller.rb.erb", grid_controller_file
     end
-    template "index.html.erb", "app/views/#{grid_controller_short_name}/index.html.erb"
-    route("resources :#{grid_controller_short_name}")
+    template "index.html.erb", view_file
+    route(generate_routing_namespace("resources :#{grid_controller_short_name}"))
     unless defined?(::Kaminari) || defined?(::WillPaginate)
       gem 'kaminari'
     end
@@ -33,20 +33,24 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
     end
   end
 
+  def view_file
+    Rails.root.join("app/views").join(controller_file_path).join("index.html.erb")
+  end
+
   def grid_class_name
     file_name.camelize.pluralize + "Grid"
   end
 
-  def grid_controller_name
-    grid_controller_short_name.camelize + "Controller"
+  def grid_controller_class_name
+    controller_class_name.camelize + "Controller"
   end
 
   def grid_controller_file
-    Rails.root.join("app/controllers/#{grid_controller_name.underscore}.rb")
+    Rails.root.join("app/controllers").join("#{grid_controller_class_name.underscore}.rb")
   end
 
   def grid_controller_short_name
-    file_name.underscore.pluralize
+    controller_file_name
   end
 
   def grid_model_name
@@ -68,7 +72,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
   end
 
   def grid_route_name
-    grid_controller_short_name + "_path"
+    controller_class_name.underscore.gsub("/", "_") + "_path"
   end
 
   def index_action
@@ -81,4 +85,28 @@ end
 RUBY
   end
 
+  protected
+  def generate_routing_namespace(code)
+    depth = regular_class_path.length
+    # Create 'namespace' ladder
+    # namespace :foo do
+    #   namespace :bar do
+    namespace_ladder = regular_class_path.each_with_index.map do |ns, i|
+      indent("namespace :#{ns} do\n", i * 2)
+    end.join
+
+    # Create route
+    #     get 'baz/index'
+    route = indent(code, depth * 2)
+
+    # Create `end` ladder
+    #   end
+    # end
+    end_ladder = (1..depth).reverse_each.map do |i|
+      indent("end\n", i * 2)
+    end.join
+
+    # Combine the 3 parts to generate complete route entry
+    namespace_ladder + route + "\n" + end_ladder
+  end
 end

data/spec/datagrid/columns_spec.rb

@@ -521,4 +521,45 @@ describe Datagrid::Columns do
       expect(row.random2).to_not eq(row.random1)
     end
   end
+
+  describe "decoration" do
+    class EntryDecorator
+      attr_reader :model
+      def initialize(model)
+        @model = model
+      end
+      def capitalized_name
+        model.name.capitalize
+      end
+    end
+
+    let!(:entry) do
+      Entry.create!(name: 'hello', category: 'first')
+    end
+
+    it "delegates column values to decorator" do
+      grid = test_report do
+        scope { Entry }
+        decorate { |model| EntryDecorator.new(model) }
+        column(:capitalized_name)
+        column(:category) do |presenter|
+          presenter.model.category
+        end
+        column(:capitalized_name_dup) do |_, _, row|
+          row.capitalized_name
+        end
+      end
+
+      expect(grid.rows).to eq([['Hello', 'first', 'Hello']])
+    end
+
+    it "allows class decorator" do
+      grid = test_report do
+        scope { Entry }
+        decorate { EntryDecorator }
+        column(:capitalized_name)
+      end
+      expect(grid.rows).to eq([['Hello']])
+    end
+  end
 end

data/spec/datagrid/helper_spec.rb

@@ -90,14 +90,6 @@ describe Datagrid::Helper do
       })
     end
 
-    it "should support cycle option" do
-      expect(subject.datagrid_rows(grid, [entry], :cycle => ["odd", "even"])).to match_css_pattern({
-        "tr.odd td.group" => "Pop",
-        "tr.odd td.name" => "Star"
-      })
-
-    end
-
     it "should support no order given" do
       expect(subject.datagrid_table(grid, [entry], :order => false)).to match_css_pattern("table.datagrid th .order" => 0)
     end
@@ -383,7 +375,7 @@ describe Datagrid::Helper do
     it "should escape html" do
       entry.update_attributes!(:name => "<div>hello</div>")
       expect(subject.datagrid_rows(grid, [entry], :columns => [:name])).to equal_to_dom(<<-HTML)
-       <tr class=""><td class="name">&lt;div&gt;hello&lt;/div&gt;</td></tr>
+       <tr><td class="name">&lt;div&gt;hello&lt;/div&gt;</td></tr>
         HTML
     end
 
@@ -393,7 +385,7 @@ describe Datagrid::Helper do
         model.name.html_safe
       end
       expect(subject.datagrid_rows(grid, [entry], :columns => [:safe_name])).to equal_to_dom(<<-HTML)
-       <tr class=""><td class="safe_name"><div>hello</div></td></tr>
+       <tr><td class="safe_name"><div>hello</div></td></tr>
         HTML
 
     end
@@ -513,6 +505,7 @@ describe Datagrid::Helper do
       expect(r.name).to eq("Hello")
       expect(r.category).to eq("greetings")
     end
+
     it "should yield block" do
       subject.datagrid_row(grid, entry) do |row|
         expect(row.name).to eq("Hello")
@@ -528,30 +521,11 @@ describe Datagrid::Helper do
       end
       expect(name).to eq("Hello,greetings")
     end
-  end
-
-  describe ".datagrid_value" do
-    it "should format value by column name" do
-      report = test_report do
-        scope {Entry}
-        column(:name) do |e|
-          "<b>#{e.name}</b>"
-        end
-      end
 
-      expect(subject.datagrid_value(report, :name, entry)).to eq("<b>Star</b>")
-    end
-    it "should support format in column" do
-      report = test_report do
-        scope {Entry}
-        column(:name) do |e|
-          format(e.name) do |value|
-             link_to value, "/profile" 
-          end
-        end
-      end
-      expect(subject.datagrid_value(report, :name, entry)).to be_html_safe
-      expect(subject.datagrid_value(report, :name, entry)).to eq("<a href=\"/profile\">Star</a>")
+    it "should give access to grid and asset" do
+      r = subject.datagrid_row(grid, entry)
+      expect(r.grid).to eq(grid)
+      expect(r.asset).to eq(entry)
     end
 
     it "should use cache" do
@@ -576,11 +550,37 @@ describe Datagrid::Helper do
       expect(data_row.random2).to_not eq(html_row.random2)
       expect(data_row.random2).to_not eq(html_row.random1)
     end
-  
+
+  end
+
+  describe ".datagrid_value" do
+    it "should format value by column name" do
+      report = test_report do
+        scope {Entry}
+        column(:name) do |e|
+          "<b>#{e.name}</b>"
+        end
+      end
+
+      expect(subject.datagrid_value(report, :name, entry)).to eq("<b>Star</b>")
+    end
+    it "should support format in column" do
+      report = test_report do
+        scope {Entry}
+        column(:name) do |e|
+          format(e.name) do |value|
+             link_to value, "/profile"
+          end
+        end
+      end
+      expect(subject.datagrid_value(report, :name, entry)).to be_html_safe
+      expect(subject.datagrid_value(report, :name, entry)).to eq("<a href=\"/profile\">Star</a>")
+    end
+
   end
 
   describe ".datagrid_header" do
-    
+
     it "should support order_by_value colums" do
       grid = test_report(:order => "category") do
         scope { Entry }

data/spec/support/test_partials/client/datagrid/_row.html.erb

@@ -1,4 +1,4 @@
-<tr class="<%= options[:cycle] && cycle(*options[:cycle]) %>">
+<tr>
   <p>Namespaced row partial.</p>
   <% grid.html_columns(*options[:columns]).each do |column| %>
     <td class="<%= datagrid_column_classes(grid, column) %>"><%= datagrid_value(grid, column, asset) %></td>

data/templates/controller.rb.erb

@@ -1,4 +1,4 @@
-class <%= grid_controller_name %> < ApplicationController
+class <%= grid_controller_class_name %> < ApplicationController
 
 <%= index_action -%>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -199,7 +199,6 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- Readme.markdown
 files:
 - ".document"
 - ".rspec"
@@ -328,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby gem to create datagrids