tableling-rails 0.0.11 → 0.0.12

data/lib/tableling-rails.rb

@@ -1,6 +1,4 @@
 module Tableling
 end
 
-[ :engine, :model, :field, :version, :activerecord ].each do |lib|
-  require File.expand_path("../tableling-rails/#{lib}", __FILE__)
-end
+Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }

data/lib/tableling-rails/config.rb

@@ -0,0 +1,34 @@
+
+module Tableling
+
+  class Configuration
+    attr_reader :model, :settings
+
+    def initialize model, options = {}, &block
+
+      @model = model
+      @views = []
+
+      @settings = Settings.new Tableling.settings
+      extend @settings.dsl
+
+      instance_eval &block if block
+      @frozen = true
+    end
+
+    def view name, options = {}, &block
+      return @views.find{ |v| v.name.to_s == name.to_s } if @frozen
+      @views.delete_if{ |v| v.name.to_s == name }
+      View.new(name, self, options, &block).tap{ |v| @views << v }
+    end
+
+    def default_view options = {}, &block
+      view :default, options, &block
+    end
+
+    def process params
+      raise ConfigurationError, "You must specify a default view" unless view(:default)
+      view(:default).process params
+    end
+  end
+end

data/lib/tableling-rails/errors.rb

@@ -0,0 +1,7 @@
+
+module Tableling
+
+  class Error < StandardError; end
+  class BaseQueryError < Error; end
+  class ConfigurationError < Error; end
+end

data/lib/tableling-rails/ext.rb

@@ -0,0 +1,14 @@
+
+module Tableling
+
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def tableling options = {}, &block
+        @tableling ||= Tableling::Configuration.new(self, options, &block)
+      end
+    end
+  end
+end

data/lib/tableling-rails/field.rb

@@ -3,17 +3,19 @@ module Tableling
 
   class Field
     attr_reader :name
-    # TODO: extract active record functionality
 
-    def initialize name, options = {}, &block
-      @name = name.to_s
-      @order_column = options[:order].try :to_s
+    def initialize name, view, options = {}, &block
+
+      @name, @view = name.to_s, view
       @value_column = options[:value].try :to_s
       @includes = options[:includes]
-      @model = options[:model]
-      Array.wrap(options[:modules] || []).each do |mod|
-        extend mod
+
+      if options[:order] == false
+        @no_order = true
+      elsif options[:order]
+        @order_column = options[:order].to_s
       end
+
       instance_eval &block if block
     end
 
@@ -21,6 +23,10 @@ module Tableling
       @order_block = block
     end
 
+    def no_order
+      @no_order = true
+    end
+
     def value &block
       @value_block = block
     end
@@ -30,10 +36,11 @@ module Tableling
     end
 
     def with_order query, direction
+      return if @no_order
       if @order_block
         @order_block.call query, direction
       else
-        query.order "#{@model.table_name}.#{@order_column || @name} #{direction}"
+        query.order "#{model.table_name}.#{@order_column || @name} #{direction}"
       end
     end
 
@@ -51,8 +58,19 @@ module Tableling
       if @value_block
         @value_block.call object
       else
-        object.send(@value_column || @name).to_s
+        serialize object.send(@value_column || @name)
       end
     end
+
+    private
+
+    def model
+      @view.config.model
+    end
+
+    def serialize value
+      serializer = @view.settings.serializers.find{ |s| s.match? value }
+      serializer ? serializer.serialize(value) : value
+    end
   end
 end

data/lib/tableling-rails/global.rb

@@ -0,0 +1,11 @@
+
+module Tableling
+
+  def self.settings
+    @settings ||= Settings.new
+  end
+
+  def self.global &block
+    settings.configure &block
+  end
+end

data/lib/tableling-rails/serializer.rb

@@ -0,0 +1,18 @@
+
+module Tableling
+
+  class Serializer
+
+    def initialize type, block
+      @type, @block = type, block
+    end
+
+    def match? value
+      value.kind_of? @type
+    end
+
+    def serialize value
+      @block.call value
+    end
+  end
+end

data/lib/tableling-rails/settings.rb

@@ -0,0 +1,34 @@
+
+module Tableling
+
+  class Settings
+
+    def initialize parent = nil
+      @parent = parent
+      @serializers = []
+    end
+
+    def configure &block
+      instance_eval &block if block
+    end
+
+    def serialize type, &block
+      @serializers << Serializer.new(type, block)
+    end
+
+    def serializers
+      (@parent ? @parent.serializers : []) + @serializers.dup
+    end
+
+    def dsl
+      m = Module.new do
+
+        def serialize type, &block
+          @settings.serialize type, &block
+        end
+      end
+      m.instance_variable_set :@settings, self
+      m
+    end
+  end
+end

data/lib/tableling-rails/version.rb

@@ -1,3 +1,3 @@
 module Tableling
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/tableling-rails/view.rb

@@ -0,0 +1,79 @@
+
+module Tableling
+
+  class View
+    attr_reader :name, :config, :settings, :base_query, :base_count_query
+
+    def initialize name, config, options = {}, &block
+
+      @name, @config = name, config
+      @fields = []
+
+      @base_query = @config.model
+      @base_count_query = nil
+
+      @settings = Settings.new @config.settings
+      extend @settings.dsl
+
+      instance_eval &block if block
+      @frozen = true
+    end
+
+    def field name, options = {}, &block
+      return @fields.find{ |f| f.name.to_s == name.to_s } if @frozen
+      @fields.delete_if{ |f| f.name.to_s == name.to_s }
+      Field.new(name, self, options, &block).tap{ |f| @fields << f }
+    end
+
+    def quick_search &block
+      @quick_search = block
+    end
+
+    def base base_query
+      @base_query = base_query
+    end
+
+    def base_count base_count_query
+      @base_count_query = base_count_query
+    end
+
+    def process options = {}
+      
+      q = options[:base] || @base_query
+      cq = options[:base_count] || @base_count_query
+
+      if @quick_search and options[:quickSearch].present?
+        q = @quick_search.call q, options[:quickSearch].to_s
+        cq = @quick_search.call cq, options[:quickSearch].to_s if cq
+      end
+
+      total = (cq || q).count
+      raise BaseQueryError, "Count query must return a number" unless total.kind_of?(Fixnum)
+
+      if options[:sort].present?
+        options[:sort].select{ |item| item.match /\A([^ ]+)* (asc|desc)\Z/i }.each do |item|
+          parts = item.split ' '
+          f = field parts[0]
+          q = f.with_order q, parts[1].downcase.to_sym if f
+        end
+      end
+
+      @fields.each{ |f| q = f.with_includes q }
+
+      limit = options[:pageSize].to_i
+      limit = 10 if limit <= 0
+      q = q.limit limit
+
+      offset = options[:page].to_i - 1
+      offset = 0 if offset < 0
+      q = q.offset offset * limit
+
+      {
+        :total => total,
+        :data => q.all.collect{ |o|
+          @fields.inject({}){ |memo,f| memo[f.name] = f.extract(o); memo }
+        }
+      }
+    end
+  end
+end

data/vendor/assets/javascripts/tableling.backbone.js

@@ -3555,7 +3555,7 @@ _.extend(Marionette.Module, {
   return Marionette;
 })(Backbone, _, $ || window.jQuery || window.Zepto || window.ender);
 /*!
- * Tableling v0.0.14
+ * Tableling v0.0.15
  * Copyright (c) 2012-2013 Simon Oulevay (Alpha Hydrae) <hydrae.alpha@gmail.com>
  * Distributed under MIT license
  * https://github.com/AlphaHydrae/tableling
@@ -3563,7 +3563,7 @@ _.extend(Marionette.Module, {
 Backbone.Tableling = Tableling = (function(Backbone, _, $){
 
   var Tableling = {
-    version : "0.0.14"
+    version : "0.0.15"
   };
 
   // Tableling
@@ -3905,7 +3905,9 @@ Backbone.Tableling = Tableling = (function(Backbone, _, $){
   Tableling.Plain.TableView = Backbone.Marionette.CompositeView.extend({
   
     events : {
-      'click thead th' : 'updateSort'
+      'click thead th.sorting' : 'updateSort',
+      'click thead th.sorting-asc' : 'updateSort',
+      'click thead th.sorting-desc' : 'updateSort'
     },
   
     initialize : function(options) {
@@ -3962,7 +3964,7 @@ Backbone.Tableling = Tableling = (function(Backbone, _, $){
   
     showSort : function() {
   
-      this.$el.find('thead th').removeClass('sorting sorting-asc sorting-desc').addClass('sorting');
+      this.$el.find('thead th.sorting, thead th.sorting-asc, thead th.sorting-desc').removeClass('sorting sorting-asc sorting-desc').addClass('sorting');
   
       for (var i = 0; i < this.sort.length; i++) {
   

data/vendor/assets/javascripts/tableling.js

@@ -1,5 +1,5 @@
 /*!
- * Tableling v0.0.14
+ * Tableling v0.0.15
  * Copyright (c) 2012-2013 Simon Oulevay (Alpha Hydrae) <hydrae.alpha@gmail.com>
  * Distributed under MIT license
  * https://github.com/AlphaHydrae/tableling
@@ -7,7 +7,7 @@
 Backbone.Tableling = Tableling = (function(Backbone, _, $){
 
   var Tableling = {
-    version : "0.0.14"
+    version : "0.0.15"
   };
 
   // Tableling
@@ -349,7 +349,9 @@ Backbone.Tableling = Tableling = (function(Backbone, _, $){
   Tableling.Plain.TableView = Backbone.Marionette.CompositeView.extend({
   
     events : {
-      'click thead th' : 'updateSort'
+      'click thead th.sorting' : 'updateSort',
+      'click thead th.sorting-asc' : 'updateSort',
+      'click thead th.sorting-desc' : 'updateSort'
     },
   
     initialize : function(options) {
@@ -406,7 +408,7 @@ Backbone.Tableling = Tableling = (function(Backbone, _, $){
   
     showSort : function() {
   
-      this.$el.find('thead th').removeClass('sorting sorting-asc sorting-desc').addClass('sorting');
+      this.$el.find('thead th.sorting, thead th.sorting-asc, thead th.sorting-desc').removeClass('sorting sorting-asc sorting-desc').addClass('sorting');
   
       for (var i = 0; i < this.sort.length; i++) {
   

data/vendor/assets/javascripts/tableling.world.js

@@ -14826,7 +14826,7 @@ _.extend(Marionette.Module, {
   return Marionette;
 })(Backbone, _, $ || window.jQuery || window.Zepto || window.ender);
 /*!
- * Tableling v0.0.14
+ * Tableling v0.0.15
  * Copyright (c) 2012-2013 Simon Oulevay (Alpha Hydrae) <hydrae.alpha@gmail.com>
  * Distributed under MIT license
  * https://github.com/AlphaHydrae/tableling
@@ -14834,7 +14834,7 @@ _.extend(Marionette.Module, {
 Backbone.Tableling = Tableling = (function(Backbone, _, $){
 
   var Tableling = {
-    version : "0.0.14"
+    version : "0.0.15"
   };
 
   // Tableling
@@ -15176,7 +15176,9 @@ Backbone.Tableling = Tableling = (function(Backbone, _, $){
   Tableling.Plain.TableView = Backbone.Marionette.CompositeView.extend({
   
     events : {
-      'click thead th' : 'updateSort'
+      'click thead th.sorting' : 'updateSort',
+      'click thead th.sorting-asc' : 'updateSort',
+      'click thead th.sorting-desc' : 'updateSort'
     },
   
     initialize : function(options) {
@@ -15233,7 +15235,7 @@ Backbone.Tableling = Tableling = (function(Backbone, _, $){
   
     showSort : function() {
   
-      this.$el.find('thead th').removeClass('sorting sorting-asc sorting-desc').addClass('sorting');
+      this.$el.find('thead th.sorting, thead th.sorting-asc, thead th.sorting-desc').removeClass('sorting sorting-asc sorting-desc').addClass('sorting');
   
       for (var i = 0; i < this.sort.length; i++) {
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tableling-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,14 +35,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tableling-rails/activerecord/ext.rb
-- lib/tableling-rails/activerecord/field.rb
-- lib/tableling-rails/activerecord/model.rb
-- lib/tableling-rails/activerecord.rb
+- lib/tableling-rails/config.rb
 - lib/tableling-rails/engine.rb
+- lib/tableling-rails/errors.rb
+- lib/tableling-rails/ext.rb
 - lib/tableling-rails/field.rb
-- lib/tableling-rails/model.rb
+- lib/tableling-rails/global.rb
+- lib/tableling-rails/serializer.rb
+- lib/tableling-rails/settings.rb
 - lib/tableling-rails/version.rb
+- lib/tableling-rails/view.rb
 - lib/tableling-rails.rb
 - vendor/assets/javascripts/tableling.backbone.js
 - vendor/assets/javascripts/tableling.js

data/lib/tableling-rails/activerecord.rb

@@ -1,2 +0,0 @@
-Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }
-ActiveRecord::Base.send :include, Tableling::ActiveRecord::Extensions

data/lib/tableling-rails/activerecord/ext.rb

@@ -1,15 +0,0 @@
-module Tableling
-
-  module ActiveRecord
-
-    module Extensions
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        def tableling options = {}, &block
-          @model ||= Tableling::Model.new(:modules => Tableling::ActiveRecord::Model, :model => self, &block)
-        end
-      end
-    end
-  end
-end

data/lib/tableling-rails/activerecord/field.rb

@@ -1,9 +0,0 @@
-
-module Tableling
-
-  module ActiveRecord
-
-    module Field
-    end
-  end
-end

data/lib/tableling-rails/activerecord/model.rb

@@ -1,18 +0,0 @@
-module Tableling
-
-  module ActiveRecord
-
-    module Model
-
-      def initialize_model options = {}
-        @model = options[:model]
-        @field_options[:model] = @model
-        @field_options[:modules] = Tableling::ActiveRecord::Field
-      end
-
-      def base_query
-        @model
-      end
-    end
-  end
-end

data/lib/tableling-rails/model.rb

@@ -1,68 +0,0 @@
-
-module Tableling
-
-  class Model
-
-    def initialize options = {}, &block
-
-      @fields = []
-      @field_options = {}
-
-      Array.wrap(options[:modules] || []).each do |mod|
-        extend mod
-        initialize_model options if respond_to? :initialize_model
-      end
-
-      instance_eval &block if block
-    end
-
-    def field name, options = {}, &block
-      if field = @fields.find{ |f| f.name.to_s == name.to_s }
-        return field
-      end
-      # TODO: do not add field if it's already there
-      Field.new(name, @field_options.merge(options), &block).tap{ |f| @fields << f }
-    end
-
-    def quick_search &block
-      @quick_search = block
-    end
-
-    def process params
-      
-      q = params[:base] || base_query
-
-      if @quick_search and params[:quickSearch].present?
-        q = @quick_search.call q, params[:quickSearch].to_s
-      end
-
-      total = q.count
-      # TODO: allow to override count query to handle group by use cases
-      total = total.inject(0){ |memo,(k,v)| memo + v } if total.kind_of? Hash
-
-      if params[:sort].present?
-        params[:sort].select{ |item| item.match /\A([^ ]+)* (asc|desc)\Z/ }.each do |item|
-          parts = item.split ' '
-          q = field(parts[0]).with_order q, parts[1].to_sym
-        end
-      end
-
-      @fields.each{ |f| q = f.with_includes q }
-
-      limit = params[:pageSize].to_i
-      limit = 10 if limit <= 0
-      q = q.limit limit
-
-      offset = params[:page].to_i - 1
-      offset = 0 if offset < 0
-      q = q.offset offset * limit
-
-      {
-        :total => total,
-        :data => q.all.collect{ |o|
-          @fields.inject({}){ |memo,f| memo[f.name] = f.extract(o); memo }
-        }
-      }
-    end
-  end
-end