tablets 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 238d1476e9dd86d9dd4daffeb15e11db1e4526a4
-  data.tar.gz: 7bd06119e0d5593f011b1ea7aa9f41def63170ec
+  metadata.gz: b7e0261127b2b6dcd32cbb870ba4480581a6320b
+  data.tar.gz: b9419a63583a1da3be7af865dbf8d9825b3bb76b
 SHA512:
-  metadata.gz: e292ad1d238eb6d39cc70db0754569467a6beb30b6268159f66917043daece16eb79fdf1ba177e1569e503267f2ea75a7ddf864ee357c0fb49a6e3386667073a
-  data.tar.gz: 6de1bee9d84c095e9ddbd9f816eade30fb4c9f6ee15001dda0d00a8f042f808bac2e5896808b7cf4801700a5bef6218978f22ac7b282a0781bb4ae8eae50e848
+  metadata.gz: 234ef30615feb35d4f8c2320e30ad55354d91a1790a87ac382fa6d7b65c7bf316daa8525a1cc738a75e9d551882fb8eaca7fdd95c5ae04d505ad6fd6102957a5
+  data.tar.gz: 7385d770428d5139cc64121e9cd3f421e20c5060539053751026a3f65dcf46a49befb4648e45ac5ecee9230ef2319f36e02e07ca2aa35532d950f7042ea0862e

data/app/controllers/tablets/ajax_controller.rb

@@ -1,5 +1,5 @@
 module Tablets
-  # Responsible to provide data to tablet on ajax request.
+  # Responsible to provide data to tablet on ajax request
   class AjaxController < ApplicationController
     before_action :authorize!
 

data/lib/tablets/data/processing/base.rb

@@ -1,20 +1,20 @@
 module Tablets
   class Data
     module Processing
-      # Base class for relation processings.
+      # Base class for relation processings
       class Base
-        # Initializes processor with relation and data reqired for processing.
+        # Initializes processor with relation and data reqired for processing
         def initialize(params, columns)
           @params = params
           @columns = columns
         end
 
-        # Applies processing on relation. Need to be implemented in descendants.
+        # Applies processing on relation. Need to be implemented in descendants
         def apply(_relation)
           fail NotImplementedError, '#apply need to be overrided by processing.'
         end
 
-        # Shorthand for create processing and apply it.
+        # Shorthand for create processing and apply it
         def self.apply(params, columns, relation)
           new(params, columns).apply(relation)
         end

data/lib/tablets/data/processing/filter.rb

@@ -7,16 +7,16 @@ require 'tablets/data/processing/base'
 module Tablets
   class Data
     module Processing
-      # Incapsulate relation filtering logic.
+      # Incapsulate relation filtering logic
       class Filter < Tablets::Data::Processing::Base
-        # Applies filter processing on relation.
+        # Applies filter processing on relation
         def apply(relation)
           search(relation)
         end
 
         private
 
-        # Applies search conditions if need.
+        # Applies search conditions if need
         def search(relation)
           return relation unless params[:search].fetch(:value, nil).present?
 
@@ -25,19 +25,19 @@ module Tablets
           relation
         end
 
-        # Builds search conditions.
+        # Builds search conditions
         def build_conditions_for(query)
           query.split(' ').map do |value|
             '(' + search_conditions(value) + ')'
           end.join(' AND ')
         end
 
-        # Returns searchable columns.
+        # Returns searchable columns
         def searchable_columns
-          columns.map { |column| column[:search] }.flatten.compact
+          columns.map { |column| column[:search] }.flatten.map(&:to_s).compact
         end
 
-        # Returs search conditions for each searchable column.
+        # Returs search conditions for each searchable column
         def search_conditions(value)
           searchable_columns.map do |column|
             Tablets::Utils::SearchConditionBuilder.new(column, value).build

data/lib/tablets/data/processing/order.rb

@@ -3,24 +3,25 @@ require 'tablets/data/processing/base'
 module Tablets
   class Data
     module Processing
-      # Incapsulate relation ordering logic.
+      # Incapsulate relation ordering logic
       class Order < Tablets::Data::Processing::Base
-        # Applies order processing on relation.
+        # Applies order processing on relation
         def apply(relation)
           params[:order].values.inject(relation) do |rel, item|
-            rel.order("#{column(item)} #{direction(item)}")
+            sorting_direction = direction(item)
+            nulls = null_place(sorting_direction)
+            rel.order("#{column(item)} #{sorting_direction} #{nulls}")
           end
         end
 
         private
 
-        # Determines order column from params.
+        # Determines order column from params
         def column(item)
           columns[item[:column].to_i][:order]
         end
 
-        # Determines order direction from params.
-        # ASC by default.
+        # Determines order direction from params (ASC by default)
         def direction(item)
           if %w(ASC DESC).include?(item.fetch(:dir, '').upcase)
             item[:dir].upcase
@@ -28,6 +29,15 @@ module Tablets
             'ASC'
           end
         end
+
+        # Determines where nulls appear
+        def null_place(sort)
+          if sort.upcase == 'ASC'
+            'NULLS FIRST'
+          else
+            'NULLS LAST'
+          end
+        end
       end
     end
   end

data/lib/tablets/data/processing/paginate.rb

@@ -3,12 +3,11 @@ require 'tablets/data/processing/base'
 module Tablets
   class Data
     module Processing
-      # Incapsulate relation pagination logic.
+      # Incapsulate relation pagination logic
       class Paginate < Tablets::Data::Processing::Base
-        # Applies :start and :length from params to relation
-        # as offset and limit.
-        # :length is optional. Default value is used if no length is provided.
-        # :start recalculated to match beginnning of page.
+        # Applies :start and :length from params to relation as offset and limit
+        # :length is optional. Default value is used if no length is provided
+        # :start recalculated to match beginnning of page
         def apply(relation)
           relation.offset(offset).limit(per_page)
         end

data/lib/tablets/data/query.rb

@@ -6,26 +6,26 @@ require 'tablets/data/processing/order'
 
 module Tablets
   class Data
-    # Incapsulates database query.
+    # Incapsulates database query
     class Query
-      # Initializes query with relation, params and columns.
+      # Initializes query with relation, params and columns
       def initialize(relation, params, columns)
         @relation = relation
         @params = params
         @columns = columns
       end
 
-      # Applies all processings on relation and returns it.
+      # Applies all processings on relation and returns it
       def fetch
         paginate filter order relation
       end
 
-      # Returns total records count before filter and pagination is applied.
+      # Returns total records count before filter and pagination is applied
       def total
         relation.count(:all)
       end
 
-      # Returns records count after filter is applied but before pagination.
+      # Returns records count after filter is applied but before pagination
       def filtered
         filter(relation).count(:all)
       end
@@ -34,21 +34,21 @@ module Tablets
 
       attr_reader :relation, :params, :columns
 
-      # Applies order processing.
+      # Applies order processing
       def order(records)
         return records unless params[:order].present?
 
         Tablets::Data::Processing::Order.apply(params, columns, records)
       end
 
-      # Applies filter processing.
+      # Applies filter processing
       def filter(records)
         return records unless params[:search].present?
 
         Tablets::Data::Processing::Filter.apply(params, columns, records)
       end
 
-      # Applies paginate processing.
+      # Applies paginate processing
       def paginate(records)
         return records if params[:length] == '-1'
 

data/lib/tablets/data.rb

@@ -1,16 +1,16 @@
 require 'tablets/data/query'
 
 module Tablets
-  # Responsible to fetch and prepare data for jquery-datatables.
+  # Responsible to fetch and prepare data for jquery-datatables
   class Data
-    # Initializes data with tablet and params.
+    # Initializes data with tablet and params
     def initialize(tablet, params, controller)
       @tablet = tablet
       @params = params
       @controller = controller
     end
 
-    # Prepares data to render as json.
+    # Prepares data to render as json
     def as_json(_options = {})
       {
         draw: params[:draw].to_i,
@@ -25,32 +25,32 @@ module Tablets
 
     attr_reader :params, :tablet, :controller
 
-    # Initializes query with concrete relation.
+    # Initializes query with concrete relation
     def query
       @query ||= Tablets::Data::Query.new(concrete_relation,
                                           params,
                                           tablet.columns)
     end
 
-    # Relation with concretized parameters.
+    # Relation with concretized parameters
     def concrete_relation
       tablet.relation(relation_params, controller)
     end
 
-    # Relation params. Empty hash by default.
+    # Relation params. Empty hash by default
     def relation_params
       params[:params] || {}
     end
 
-    # Fetching records and applies process tablet callback on it.
+    # Fetching records and applies process tablet callback on it
     def records
       @records ||= tablet.process(query.fetch)
     end
 
-    # Fetching columns data for each row using column[:data] value.
-    # If column[:data] is symbol send it to the record.
-    # If column[:data] is proc calls it on the record.
-    # Also appends details.
+    # Fetching columns data for each row using column[:data] value:
+    # * If column[:data] is symbol send it to the record
+    # * If column[:data] is proc calls it on the record
+    # Also appends details
     def data
       records.map do |record|
         data = tablet.columns.map.with_index do |column, index|
@@ -64,7 +64,7 @@ module Tablets
       end
     end
 
-    # Returns single cell value, for specified record and for specified column.
+    # Returns single cell value, for specified record and for specified column
     def cell(record, column)
       case column[:data]
       when Symbol then record.send(column[:data])

data/lib/tablets/engine.rb

@@ -1,7 +1,7 @@
 require 'rails/engine'
 
 module Tablets
-  # Rails mountable engine.
+  # Rails mountable engine
   class Engine < ::Rails::Engine
     require 'jquery-datatables-rails'
     engine_name 'tablets'

data/lib/tablets/global/configurator.rb

@@ -2,17 +2,17 @@ require 'rails'
 
 module Tablets
   module Global
-    # Responsible to make application configurable.
+    # Responsible to make application configurable
     module Configurator
       attr_accessor :options
       attr_accessor :tablets_dir
 
-      # Setup configuration. Used in initializers.
+      # Setup configuration. Used in initializers
       def setup
         yield self
       end
 
-      # Initialize default config values.
+      # Initialize default config values
       def self.extended(base)
         base.options = DEFAULT_OPTIONS
         base.tablets_dir = File.expand_path('app/tablets', Rails.root)

data/lib/tablets/global/loader.rb

@@ -1,19 +1,20 @@
 module Tablets
   module Global
-    # Tablets loader. Manages files loading from app tablets directory.
+    # Tablets loader
+    # Manages files loading from app tablets directory
     module Loader
-      # Unloads tablet.
+      # Unloads tablet
       def unload!
         @tablets = nil
       end
 
-      # Checks if tablet is loading.
-      # Tablets is not loaded only if tablets is nil.
+      # Checks if tablet is loading
+      # Tablets is not loaded only if tablets is nil
       def loaded?
         !@tablets.nil?
       end
 
-      # Loads tablets files.
+      # Loads tablets files
       def load!
         @tablets = {}
         files.each { |file| load file }
@@ -21,12 +22,12 @@ module Tablets
 
       private
 
-      # Load paths.
+      # Load paths
       def load_paths
         [Tablets.tablets_dir]
       end
 
-      # Prepares files list using load paths.
+      # Prepares files list using load paths
       def files
         load_paths.flatten.compact.uniq.flat_map do |path|
           Dir["#{path}/**/*.rb"]

data/lib/tablets/global/store.rb

@@ -2,8 +2,8 @@ require 'tablets/tablet'
 
 module Tablets
   module Global
-    # Tables store.
-    # Expects @tablets to be defined elsewhere.
+    # Tables store
+    # Expects @tablets to be defined elsewhere
     module Store
       extend Forwardable
 
@@ -11,7 +11,7 @@ module Tablets
 
       def_delegators :tablets, :[]
 
-      # Initializes tablet and put tablet into store.
+      # Initializes tablet and put tablet into store
       #
       #   Tablets.register(:user) do
       #     # Tablet configuration.

data/lib/tablets/railtie.rb

@@ -5,13 +5,13 @@ require 'tablets/view_helpers'
 module Tablets
   # Rails hooks.
   class Railtie < ::Rails::Railtie
-    # Allows tablets view helper to be used anywhere in rails views.
+    # Allows tablets view helper to be used anywhere in rails views
     initializer 'tablets.view_helpers' do
       ActionView::Base.send :include, Tablets::ViewHelpers
     end
 
-    # Manages tablets loading and cleanup.
-    # Also ensures tablets reloading in development environment.
+    # Manages tablets loading and cleanup
+    # Also ensures tablets reloading in development environment
     initializer 'tablets.reloader' do |app|
       if app.config.reload_classes_only_on_change
         ActionDispatch::Reloader.to_prepare(prepend: true) { Tablets.unload! }

data/lib/tablets/renderer.rb

@@ -3,15 +3,15 @@ require 'active_support/core_ext/object/blank'
 require 'tablets/engine'
 
 module Tablets
-  # Prepares markup. Renders table without any data.
+  # Prepares markup. Renders table without any data
   class Renderer
-    # Initializes renderer with tablet and params.
+    # Initializes renderer with tablet and params
     def initialize(tablet, params = {})
       @tablet = tablet
       @params = params
     end
 
-    # Renders table in view_context.
+    # Renders table in view_context
     def render(view_context)
       view_context.render(partial: 'tablets/tablet', locals: locals)
     end
@@ -20,7 +20,7 @@ module Tablets
 
     attr_reader :params, :tablet
 
-    # Prepares locals for tablet partial.
+    # Prepares locals for tablet partial
     def locals
       {
         id: id,
@@ -31,7 +31,7 @@ module Tablets
       }
     end
 
-    # Id for HTML container. Includes name and params with values.
+    # Id for HTML container. Includes name and params with values
     #
     #  renderer = Tablets::Renderer.new(:posts, user_id: 1)
     #  renderer.id #=> 'posts_user_id_1'
@@ -47,7 +47,7 @@ module Tablets
         .merge(tablet.options)
     end
 
-    # Calculates column options and applies options on top.
+    # Calculates column options and applies options on top
     #
     #   ...
     #   columns do
@@ -77,7 +77,7 @@ module Tablets
       end
     end
 
-    # Returns path to data.
+    # Returns path to data
     def data_path
       Tablets::Engine.routes.url_helpers.data_path(tablet.name)
     end

data/lib/tablets/tablet.rb

@@ -1,48 +1,48 @@
 require 'tablets/utils/config'
 
 module Tablets
-  # Incapsulates tablet related information.
+  # Incapsulates tablet related information
   class Tablet
     attr_reader :name
 
-    # Initializes tablet with name, callbacks fed with block.
+    # Initializes tablet with name, callbacks fed with block
     def initialize(name, &block)
       @name = name
       @config = Tablets::Utils::Config.new(&block)
     end
 
-    # Returns general jquery-datatable configuration overrides.
-    # By default returns empty options.
+    # Returns general jquery-datatable configuration overrides
+    # By default returns empty options
     def options
       call(:options) { {} }
     end
 
-    # Determines is user authorized.
-    # By default returns true.
+    # Determines is user authorized
+    # By default returns true
     def authorize(controller)
       call(:authorize, controller) { true }
     end
 
-    # Allows to make additional processing before records would be used.
-    # By default returns records.
+    # Allows to make additional processing before records would be used
+    # By default returns records
     def process(records)
       call(:process, records) { records }
     end
 
-    # Returns details HTML for the record.
-    # By default returns nil.
+    # Returns details HTML for the record
+    # By default returns nil
     def details(record)
       call(:details, record) { nil }
     end
 
-    # Returns columns definitions.
-    # By default deduct columns from relation.
+    # Returns columns definitions
+    # By default deduct columns from relation
     def columns
       call(:columns) { deduct_columns_from_relation }
     end
 
-    # Returns database relation to fetch data.
-    # By default tries to deduct class from tablet name.
+    # Returns database relation to fetch data
+    # By default tries to deduct class from tablet name
     def relation(params = {}, controller = nil)
       if defined? @name.singularize.camelize.constantize
         call(:relation, params, controller) do
@@ -53,19 +53,19 @@ module Tablets
       end
     end
 
-    # Returns additional data returned to client.
+    # Returns additional data returned to client
     def payload
       call(:payload) { {} }
     end
 
-    # Checks if config has callback with specified name.
+    # Checks if config has callback with specified name
     def has?(name)
       @config.has?(name)
     end
 
     private
 
-    # Returns default columns definititions, deducted from relation.
+    # Returns default columns definititions, deducted from relation
     def deduct_columns_from_relation
       relation.columns.map(&:name).map do |name|
         {
@@ -76,8 +76,7 @@ module Tablets
       end
     end
 
-    # Calls callback.
-    # Clarifies error message on error.
+    # Calls callback and clarifies error message on error
     def call(callback, *params, &block)
       @config.call(callback, *params, &block)
     rescue ArgumentError

data/lib/tablets/utils/config.rb

@@ -3,45 +3,45 @@ require 'active_support/core_ext/object/blank'
 module Tablets
   module Utils
     # Config utility. Allows to write configs in declarative form.
-    # And fetch values with defaults.
+    # And fetch values with defaults:
     #
-    #  config = Config.new do
-    #    some_var 32
-    #    another_var 42
+    #   config = Config.new do
+    #     some_var 32
+    #     another_var 42
     #
-    #    some_callback do |arg|
-    #      do_something_with arg
-    #    end
-    #  end
+    #     some_callback do |arg|
+    #       do_something_with arg
+    #     end
+    #   end
     #
-    #  config.get(:some_var) #=> 32
-    #  config.get(:non_existent_var) #=> ArgumentError
-    #  config.get(:non_existent_var, 'default') #=> 'default'
+    #   config.get(:some_var) #=> 32
+    #   config.get(:non_existent_var) #=> ArgumentError
+    #   config.get(:non_existent_var, 'default') #=> 'default'
     #
-    #  config.call(:some_callback, 'my_arg') { |arg| default_action arg }
+    #   config.call(:some_callback, 'my_arg') { |arg| default_action arg }
     #
     class Config
-      # Initializes config with block.
-      # Block is optional and can be applied later.
+      # Initializes config with block
+      # Block is optional and can be applied later
       def initialize(&block)
         @hash = {}
 
         apply(&block) unless block.nil?
       end
 
-      # Executes block in config context.
+      # Executes block in config context
       def apply(&block)
         instance_eval(&block)
       end
 
-      # Checks if value or callback is defined with specified name.
+      # Checks if value or callback is defined with specified name
       def has?(name)
         @hash[name].present?
       end
 
-      # Returns value.
-      # If no value defined, returns default.
-      # If no default raises ArgumentError.
+      # Returns value
+      # If no value defined, returns default
+      # If no default raises ArgumentError
       def get(name, default = nil, &default_block)
         value = @hash[name][0] if @hash[name]
 
@@ -56,9 +56,9 @@ module Tablets
         end
       end
 
-      # Calls callback.
-      # If no calbback defined, calls default.
-      # If no default raises ArgumentError.
+      # Calls callback
+      # If no calbback defined, calls default
+      # If no default raises ArgumentError
       def call(name, *params, &default)
         callback = @hash[name][0] if @hash[name]
 
@@ -73,7 +73,7 @@ module Tablets
 
       private
 
-      # Gathers all calls.
+      # Gathers all calls
       def method_missing(name, *args, &block)
         @hash[name] = [*args, block]
       end

data/lib/tablets/utils/search_condition_builder.rb

@@ -3,46 +3,46 @@ require 'active_record'
 
 module Tablets
   module Utils
-    # Resposible for building database specific search conditions.
+    # Resposible for building database specific search conditions
     class SearchConditionBuilder
       attr_reader :column, :query
 
-      # Initializes builder.
+      # Initializes builder
       def initialize(column, query)
         @column = column
         @query = query
       end
 
-      # Builds search condition for specific db type.
+      # Builds search condition for specific db type
       def build
         sanitize "(#{prepared_column} #{like} ?)", "%#{query}%"
       end
 
       private
 
-      # Sanitizes sql expression with params.
+      # Sanitizes sql expression with params
       def sanitize(sql, *params)
         ActiveRecord::Base.send(:sanitize_sql_array, [sql, *params])
       end
 
-      # Returns column prepared for using in SQL statement.
+      # Returns column prepared for using in SQL statement
       def prepared_column
         cast quote @column
       end
 
-      # Cast column to string.
+      # Cast column to string
       def cast(column)
         "CAST (#{column} AS #{string_type})"
       end
 
-      # Quotes column name.
+      # Quotes column name
       def quote(column)
         column.split('.').map do |component|
           ActiveRecord::Base.connection.quote_column_name component
         end.join('.')
       end
 
-      # Returns database specific like operator.
+      # Returns database specific like operator
       def like
         case db_adapter
         when :postgresql then 'ILIKE'
@@ -51,7 +51,7 @@ module Tablets
         end
       end
 
-      # Returns database specific string type.
+      # Returns database specific string type
       def string_type
         case db_adapter
         when :postgresql then 'VARCHAR'
@@ -60,7 +60,7 @@ module Tablets
         end
       end
 
-      # Retrieves rails database adapter.
+      # Retrieves rails database adapter
       def db_adapter
         @db_adapter ||=
         ActiveRecord::Base.configurations[Rails.env]['adapter'].to_sym

data/lib/tablets/version.rb

@@ -1,9 +1,9 @@
 module Tablets
-  # Tablets gem version.
+  # Tablets gem version
   module Version
     MAJOR = 0
     MINOR = 3
-    TINY  = 9
+    TINY  = 10
     PRE   = nil
 
     class << self

data/lib/tablets/view_helpers.rb

@@ -1,9 +1,9 @@
 require 'tablets/renderer'
 
 module Tablets
-  # View helpers included to Rails.
+  # View helpers included to Rails
   module ViewHelpers
-    # Finds tablet by name and renders is with params in current view context.
+    # Finds tablet by name and renders is with params in current view context
     #
     #  <%= render_tablet :posts, user_id: @user.id %>
     #

data/lib/tablets.rb

@@ -2,7 +2,7 @@ require 'tablets/global/loader'
 require 'tablets/global/store'
 require 'tablets/global/configurator'
 
-# Top level tablets module. Extended with global tablets methods.
+# Top level tablets module extended with global tablets methods
 module Tablets
   autoload :Data, 'tablets/data'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablets
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Yevhen Shemet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,22 +164,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Wrapper around jquery-datatables.
 test_files:
-- spec/spec_helper.rb
 - spec/lib/tablets/data/processing/base_spec.rb
-- spec/lib/tablets/data/processing/paginate_spec.rb
-- spec/lib/tablets/data/processing/order_spec.rb
 - spec/lib/tablets/data/processing/filter_spec.rb
+- spec/lib/tablets/data/processing/order_spec.rb
+- spec/lib/tablets/data/processing/paginate_spec.rb
 - spec/lib/tablets/data/query_spec.rb
-- spec/lib/tablets/global/store_spec.rb
 - spec/lib/tablets/global/configurator_spec.rb
 - spec/lib/tablets/global/loader_spec.rb
-- spec/lib/tablets/view_helpers_spec.rb
-- spec/lib/tablets/utils/search_condition_builder_spec.rb
-- spec/lib/tablets/utils/config_spec.rb
-- spec/lib/tablets/tablet_spec.rb
+- spec/lib/tablets/global/store_spec.rb
 - spec/lib/tablets/renderer_spec.rb
+- spec/lib/tablets/tablet_spec.rb
+- spec/lib/tablets/utils/config_spec.rb
+- spec/lib/tablets/utils/search_condition_builder_spec.rb
+- spec/lib/tablets/view_helpers_spec.rb
+- spec/spec_helper.rb