tabulatr2 0.6.0 → 0.8.0

data/lib/{generators → tabulatr/generators}/tabulatr/install_generator.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Peter Horn, Provideal GmbH
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -20,11 +20,19 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
-class Tabulatr
+
+module Tabulatr
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    class InstallGenerator < Rails::Generators::NamedBase
       desc "initialize tabulatr"
       source_root File.expand_path('../templates', __FILE__)
+      check_class_collision suffix: 'TabulatrData'
+
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
+
+      def create_tabulatr_data_file
+        template 'tabulatr_data.rb', File.join('app/tabulatr_data/', class_path, "#{file_name}_tabulatr_data.rb")
+      end
 
       def copy_initializer_file
         copy_file "tabulatr.rb", "config/initializers/tabulatr.rb"
@@ -39,6 +47,16 @@ class Tabulatr
           gsub_file 'config/initializers/tabulatr.rb', 'create_ul_paginator', 'create_div_paginator'
         end
       end
+
+      private
+
+      def attributes_names
+        [:id] + attributes.select { |attr| !attr.reference? }.map { |a| a.name.to_sym }
+      end
+
+      def association_names
+        attributes.select { |attr| attr.reference? }.map { |a| a.name.to_sym }
+      end
     end
   end
 end

data/lib/{generators → tabulatr/generators}/tabulatr/templates/tabulatr.yml

@@ -5,10 +5,12 @@ en:
     batch_actions: 'Batch actions'
     count: 'Showing: %{current} of total %{total}. %{per_page} items per page.'
     apply_filters: 'Apply'
+    search: 'Search'
 de:
   tabulatr:
     rows_per_page: 'Ergebnisse pro Seite'
     filter: 'Filter'
     batch_actions: 'Batch-Aktionen'
     count: 'Zeige %{current} von insgesamt %{total}. %{per_page} pro Seite.'
-    apply_filters: 'Anwenden'
+    apply_filters: 'Anwenden'
+    search: 'Suche'

data/lib/tabulatr/generators/tabulatr/templates/tabulatr_data.rb

@@ -0,0 +1,18 @@
+<% module_namespacing do %>
+class <%= class_name %>TabulatrData < Tabulatr::Data
+  <% attributes = attributes_names %>
+  <% if class_name.constantize.table_exists? %>
+    <% attributes << class_name.constantize.column_names.map(&:to_sym) %>
+  <% end %>
+  <% attributes = attributes.flatten.uniq %>
+  <% if attributes.any? %>
+    search :<%= attributes.last %>
+  <% end %>
+  <% attributes.each do |a| %>
+    column :<%= a %>
+  <% end %>
+  <% association_names.each do |attribute| %>
+    association :<%= attribute %>, :id
+  <% end %>
+end
+<% end %>

data/lib/tabulatr/json_builder.rb

@@ -0,0 +1,94 @@
+#--
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module Tabulatr::JsonBuilder
+  def self.build(data, klass, requested_attributes, id="id")
+    if klass && ActiveModel.const_defined?(:ArraySerializer)
+      ActiveModel::ArraySerializer.new(data,
+        { root: "data", meta: data.__pagination,
+          each_serializer: klass
+        }).as_json
+    else
+      id_included = false
+      attrs = build_hash_from requested_attributes, id
+      result = []
+      data.each do |f|
+        tmp = {}
+        attrs.each do |at|
+          insert_attribute_in_hash(at, f, tmp)
+        end
+        result << tmp
+      end
+      { data: result, meta: data.__pagination }
+    end
+  end
+
+  private
+
+  def self.build_hash_from requested_attributes, id
+    attrs = []
+    id_included = false
+    requested_attributes.split(',').each do |par|
+      if par.include? ':'
+        relation, action = par.split(':')
+        attrs << {action: action, relation: relation}
+      else
+        id_included = true if par == id
+        attrs << {action: par}
+      end
+    end
+    attrs << {action: id} unless id_included
+    attrs
+  end
+
+  def self.insert_attribute_in_hash at, f, r={}
+    if at.has_key? :relation
+      rel = at[:relation].to_sym
+      action = at[:action].to_sym
+      # if f.class.reflect_on_association(at[:relation].to_sym).collection?
+      #   if at[:action].to_sym == :count
+      #     r["#{at[:relation]}:#{at[:action]}"] = f.try(at[:relation]).count
+      #   else
+      #     r["#{at[:relation]}:#{at[:action]}"] = f.try(at[:relation]).map(&at[:action].to_sym).join(', ')
+      #   end
+      # else
+      #   r["#{at[:relation]}:#{at[:action]}"] = f.try(at[:relation]).try(at[:action])
+      # end
+      begin
+        r["#{at[:relation]}:#{at[:action]}"] = f[rel][action]
+      rescue NoMethodError => e
+        raise $!, "You requested '#{at[:action]}' on '#{at[:relation]}' but
+          there was no such method included in your TabulatrData", $!.backtrace
+      end
+    else
+      begin
+        action = at[:action].to_sym
+        r[at[:action]] = f[action]
+      rescue NoMethodError => e
+        raise $!, "You requested '#{at[:action]}' but
+          there was no such method included in your TabulatrData", $!.backtrace
+      end
+    end
+    r
+  end
+end

data/lib/tabulatr/rails/action_controller.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+class ActionController::Base
+  def tabulatr_for(klaz, tabulatr_data_class: nil, serializer: nil, render_action: nil, &block)
+    respond_to do |format|
+      format.json {
+        records = klaz.tabulatr(tabulatr_data_class).data_for_table(params, &block)
+        render json: records.to_tabulatr_json(serializer)
+      }
+      format.html {
+        render action: render_action || action_name
+      }
+    end
+  end
+end

data/lib/{initializers → tabulatr/rails}/action_view.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Peter Horn, Provideal GmbH
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -24,8 +24,11 @@
 class ActionView::Base
   # render the table in a view
   def table_for(klass, opts={}, &block)
-    tabulatr = Tabulatr.new(klass, self, opts)
-    tabulatr.build_table(&block)
+    Tabulatr::Renderer.build_table(klass, self, opts, &block)
+  end
+
+  def static_table_for(records, opts={}, &block)
+    Tabulatr::Renderer.build_static_table(records, self, opts, &block)
   end
 end
 

data/lib/{initializers → tabulatr/rails}/active_record.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Peter Horn, Provideal GmbH
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -25,24 +25,16 @@
 # the information of the params hash as created by a Tabulatr table
 if Object.const_defined? "ActiveRecord"
   class ActiveRecord::Base
-    def self.find_for_table(params, opts={}, &block)
-      Tabulatr::Finder.find_for_table(self, params, opts, &block)
-    end
-
-    def self.tabulatr_name_mapping(name_mapping_hash)
-      tabulatr_name_mappings.merge! name_mapping_hash
-    end
-
-    def self.tabulatr_name_mappings
-      @tabulatr_name_mappings ||= {}
-    end
-
-    def self.tabulatr_select_attributes(more={})
-      maps = tabulatr_name_mappings.merge(more)
-      return nil if maps.blank?
-       "#{table_name}.*, " + maps.map do |name, mapping|
-        %{#{mapping} AS "#{name}"}
-      end.join(", ")
+    def self.tabulatr(tabulatr_data_class = nil)
+      return tabulatr_data_class.new(self) if tabulatr_data_class
+      begin
+        klaz = self.respond_to?(:klass) ? self.klass : self
+        "#{klaz.name}TabulatrData".constantize.new(self)
+      rescue NameError => e
+        puts e.message
+        # TODO: Better message
+        raise "No class `#{klaz.name}TabulatrData' defined. Explanation here."
+      end
     end
   end
 end

data/lib/tabulatr/renderer/action.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+class Tabulatr::Renderer::Action < Tabulatr::Renderer::Column
+  def human_name
+    header
+  end
+
+  def coltype() 'action' end
+  def column?() false end
+  def action?() true end
+end

data/lib/tabulatr/{tabulatr/formattr.rb → renderer/association.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Peter Horn, Provideal GmbH
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,35 +21,24 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-module Tabulatr::Formattr
-  ALLOWED_METHODS = [:euro, :dollar, :percent, :lamp]
-  #include ActionView::TagHelpers
-  
-  def self.format(nam, val)
-    nam = nam.to_sym
-    if ALLOWED_METHODS.member?(nam)
-      self.send nam, val
+class Tabulatr::Renderer::Association < Tabulatr::Renderer::Column
+  def human_name
+    header ||
+      klass.reflect_on_association(table_name.to_sym).klass.model_name.human + ' ' +
+      klass.reflect_on_association(table_name.to_sym).klass.human_attribute_name(name)
+  end
+
+  def coltype() 'association' end
+  def column?() false end
+  def association?() true end
+
+  def principal_value(record)
+    v = record.send(table_name)
+    if v && v.respond_to?(:to_a) && map
+      v.map(&:"#{name}")
     else
-      "[Requested unautorized format '#{nam}' for '#{val}'.]" 
+      v.try(name)
     end
   end
-  
-  def self.euro(x)
-    ("%.2f&thinsp;&euro;" % x).gsub(".", ",")
-  end
-  
-  def self.dollar(x)
-    "$&thinsp;%.2f" % x
-  end
-  
-  def self.percent(x)
-    ("%.2f&thinspace;%%" % 100.0*x).gsub(".", ",")
-  end
-  
-  def self.lamp(x, mapping)
-    s = mapping[x].to_s
-    return "?" unless %w{g y r n}.member?(s)
-    image_tag("tabulatr/#{s}state.gif").html_safe
-  end
-  
-end
+
+end

data/lib/tabulatr/renderer/checkbox.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+class Tabulatr::Renderer::Checkbox < Tabulatr::Renderer::Column
+  def human_name
+    nil
+  end
+
+  def coltype() 'checkbox' end
+  def column?() false end
+  def checkbox?() true end
+
+  def value_for(record, view)
+    nil
+  end
+end

data/lib/tabulatr/renderer/column.rb

@@ -0,0 +1,113 @@
+#--
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+class Tabulatr::Renderer::Column
+  include ActiveModel::Model
+
+  attr_accessor *%i{name header width align valign wrap type th_html filter_html
+    filter checkbox_value checkbox_label filter_width range_filter_symbol
+    sortable format_methods table_name block klass format map}
+
+  def self.from(
+    name: nil,
+    table_name: nil,
+    header: false,
+    width: false,
+    align: false,
+    valign: false,
+    wrap: true,
+    type: :string,
+    th_html: false,
+    filter_html: false,
+    filter: true,
+    checkbox_value: '1',
+    checkbox_label: '',
+    sortable: true,
+    format: nil,
+    map: true,
+    klass: nil,
+    &block)
+    b = block_given? ? block : nil
+    self.new(
+      name: name,
+      table_name: table_name,
+      header: header,
+      width: width,
+      align: align,
+      valign: valign,
+      wrap: wrap,
+      type: type,
+      th_html: th_html,
+      filter_html: filter_html,
+      filter: filter,
+      checkbox_value: checkbox_value,
+      checkbox_label: checkbox_label,
+      sortable: sortable,
+      format: format,
+      map: map,
+      klass: klass,
+      block: b
+    )
+  end
+
+  def klassname() @_klassname ||= @klass.name.underscore end
+  def human_name() header || klass.human_attribute_name(name) end
+  def sort_param() "#{klassname}_sort" end
+  def full_name() [table_name, name].compact.join(":") end
+  def coltype() 'column' end
+
+  def column?() true end
+  def association?() false end
+  def checkbox?() false end
+  def action?() false end
+
+  def value_for(record, view)
+    if block
+      return view.instance_exec(record, &block)
+    end
+    val = principal_value(record) or return ''
+
+    if format.present? && val.respond_to?(:to_a)
+      val.map do |v|
+        case format
+        when Symbol then view.send(format, v)
+        when String then format % v
+        when Proc   then format.(v)
+        else val
+        end
+      end
+    elsif format.present?
+      case format
+      when Symbol then view.send(format, val)
+      when String then format % val
+      when Proc   then format.(val)
+      else val
+      end
+    end
+  end
+
+  def principal_value(record)
+    record.send name
+  end
+
+end

data/lib/{initializers/mark_as_localizable.rb → tabulatr/renderer/columns.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Peter Horn, Provideal GmbH
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,23 +21,21 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-# This is probably a REALLY bad idea...
-module MarkAsLocalizable
-  def l
-    @should_localize = true
-    self
+class Tabulatr::Renderer::Columns < ::Array
+
+  attr_accessor :klass
+
+  def initialize(klass)
+    super()
+    @klass = klass
   end
 
-  def should_localize?
-    @should_localize == true
+  def filtered_columns
+    self.select &:filter
   end
-end
 
-class String
-  include MarkAsLocalizable
-end
+  def class_name
+    @klass.name.underscore
+  end
 
-class Symbol
-  include MarkAsLocalizable
 end
-

data/lib/tabulatr/renderer/columns_from_block.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright (c) 2010-2014 Peter Horn & Florian Thomas, Provideal GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+class Tabulatr::Renderer
+  class ColumnsFromBlock
+    attr_accessor :columns, :klass
+
+    def initialize(klass)
+      @klass = klass
+      @columns ||= Columns.new(klass)
+    end
+
+    def column(name, opts={}, &block)
+      @columns << Column.from(opts.merge(klass: klass, name: name), &block)
+    end
+
+    def association(table_name, name, opts={}, &block)
+      @columns << Association.from(opts.merge(klass: klass, name: name, table_name: table_name), &block)
+    end
+
+    def checkbox(opts={})
+      @columns << Checkbox.from(opts.merge(klass: klass, filter: false, sortable: false))
+    end
+
+    def action(opts={}, &block)
+      @columns << Action.from(opts.merge(klass: klass, filter: false, sortable: false), &block)
+    end
+
+    def self.process(klass, &block)
+      i = self.new(klass)
+      yield(i)
+      c = i.columns
+      c
+    end
+  end
+end