tablets 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fabd1f1477cd295cede4c19f5401f3200a19dd2d
-  data.tar.gz: 7dbfdf2ae6f5e4ee8c7fc40c351ef4b1130e3d50
+  metadata.gz: b2b9c6ae56d77fa44950ef647ae6492ad50803f4
+  data.tar.gz: 1bed78d14eee5c42e294b1f3103ddcb6de070a3e
 SHA512:
-  metadata.gz: 96286ea703337dd2e0123835c8fc9a41c35455a1c3b1680e178ec0bcab57d1292fd91cce2e0026e15c96c07ad6e962947bdfb461568741cd38107e7d6d9f1da3
-  data.tar.gz: 3ea819cbd7b92d3d0ffb38f9ac3bc77333877e7515c9af05df0d9bcb5a56d06525f97461eb3df1e472613ca682ac3c7d0e3e50120be3c6c8739efdee2c4386a3
+  metadata.gz: a534d1816ca669da1c8636d7eb500c03ff913ff19e2c0e1450fbfaee3e8c2a86e7b384bef9973fe1b0b6aa19364dc19478dfd28f0210159b617fab1b3399183c
+  data.tar.gz: faf361c98793fdda26042efc0e5c9aae4d27c7ee8da22abc5d46916eca73b34dfc4407ed6a0d747a28a57023660c6a74a3f9a0f244e8d198dcd54f51fb2e7274

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/tablets.svg)](http://badge.fury.io/rb/tablets)
 [![Code Climate](https://codeclimate.com/github/zenedge/tablets/badges/gpa.svg)](https://codeclimate.com/github/zenedge/tablets)
-[![Test Coverage](https://codeclimate.com/github/zenedge/tablets/badges/coverage.svg)](https://codeclimate.com/github/zenedge/tablets/coverage)
 
 ## Installation
 

data/app/controllers/tablets/ajax_controller.rb

@@ -1,7 +1,7 @@
 module Tablets
   # Responsible to provide data to tablet on ajax request.
   class AjaxController < ApplicationController
-    before_filter :authorize!
+    before_action :authorize!
 
     def data
       render json: Tablets::Data.new(tablet, data_params, self)

data/config/routes.rb

@@ -1,3 +1,3 @@
 Tablets::Engine.routes.draw do
-  get 'ajax/:name/data', to: 'tablets/ajax#data', as: :data
+  post 'ajax/:name/data', to: 'tablets/ajax#data', as: :data
 end

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

@@ -1,6 +1,6 @@
-require 'active_support/core_ext/object'
+require 'active_support/core_ext/object/blank'
 
-require 'tablets/utils/search_condition'
+require 'tablets/utils/search_condition_builder'
 
 require 'tablets/data/processing/base'
 
@@ -18,7 +18,7 @@ module Tablets
 
         # Applies search conditions if need.
         def search(relation)
-          return relation unless params[:search].try(:[], :value).present?
+          return relation unless params[:search].fetch(:value, nil).present?
 
           conditions = build_conditions_for(params[:search][:value])
           relation = relation.where(conditions) if conditions
@@ -40,7 +40,7 @@ module Tablets
         # Returs search conditions for each searchable column.
         def search_conditions(value)
           searchable_columns.map do |column|
-            Tablets::Utils::SearchCondition.build(column, value)
+            Tablets::Utils::SearchConditionBuilder.new(column, value).build
           end.join(' OR ')
         end
       end

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

@@ -22,7 +22,7 @@ module Tablets
         # Determines order direction from params.
         # ASC by default.
         def direction(item)
-          if %w(ASC DESC).include?(item[:dir].upcase)
+          if %w(ASC DESC).include?(item.fetch(:dir, '').upcase)
             item[:dir].upcase
           else
             'ASC'

data/lib/tablets/data/query.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/object'
+require 'active_support/core_ext/object/blank'
 
 require 'tablets/data/processing/filter'
 require 'tablets/data/processing/paginate'

data/lib/tablets/data.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/object'
-
 require 'tablets/data/query'
 
 module Tablets
@@ -55,7 +53,7 @@ module Tablets
         end.to_h
 
         details = tablet.details(record)
-        data[:details] = details if details.present?
+        data[:details] = details unless details.nil?
 
         data
       end
@@ -64,8 +62,8 @@ module Tablets
     # 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])
-        when Proc then column[:data].call(record, @controller)
+      when Symbol then record.send(column[:data])
+      when Proc then column[:data].call(record, @controller)
       end
     end
   end

data/lib/tablets/global/configurator.rb

@@ -28,6 +28,7 @@ module Tablets
         order: [0, 'asc'],
         autoWidth: true,
         orderCellsTop: true,
+        serverMethod: 'POST',
         language: {
           lengthMenu: '<span class=\'seperator\'>|</span>View _MENU_ records',
           info: '<span class=\'seperator\'>|</span>Found total _TOTAL_ records',

data/lib/tablets/renderer.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/object'
+require 'active_support/core_ext/object/blank'
 
 require 'tablets/engine'
 
@@ -26,7 +26,7 @@ module Tablets
         id: id,
         name: tablet.name,
         columns: tablet.columns,
-        options: options,
+        options: resulting_options,
         params: params
       }
     end
@@ -41,11 +41,10 @@ module Tablets
     end
 
     # Calculates resulting options.
-    def options
-      @options ||= {}
-      .merge(Tablets.options)
-      .merge(columnDefs: columns_definitions, ajax: data_path)
-      .merge(tablet.options)
+    def resulting_options
+      {}.merge(Tablets.options)
+        .merge(columnDefs: columns_definitions, ajax: data_path)
+        .merge(tablet.options)
     end
 
     # Calculates column options and applies options on top.

data/lib/tablets/tablet.rb

@@ -44,7 +44,7 @@ module Tablets
     # Returns database relation to fetch data.
     # By default tries to deduct class from tablet name.
     def relation(params = {})
-      if defined? @name.camelize.constantize
+      if defined? @name.singularize.camelize.constantize
         call(:relation, params) { @name.camelize.constantize.where(nil) }
       else
         call(:relation, params)

data/lib/tablets/utils/config.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/object'
+require 'active_support/core_ext/object/blank'
 
 module Tablets
   module Utils

data/lib/tablets/utils/search_condition_builder.rb

@@ -0,0 +1,70 @@
+require 'rails'
+require 'active_record'
+
+module Tablets
+  module Utils
+    # Resposible for building database specific search conditions.
+    class SearchConditionBuilder
+      attr_reader :column, :query
+
+      # Initializes builder.
+      def initialize(column, query)
+        @column = column
+        @query = query
+      end
+
+      # Builds search condition for specific db type.
+      def build
+        sanitize "(#{prepared_column} #{like} ?)", "%#{query}%"
+      end
+
+      private
+
+      # 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.
+      def prepared_column
+        cast quote @column
+      end
+
+      # Cast column to string.
+      def cast(column)
+        "CAST (#{column} AS #{string_type})"
+      end
+
+      # 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.
+      def like
+        case db_adapter
+        when :postgresql then 'ILIKE'
+        when :mysql2 then 'LIKE'
+        when :sqlite3 then 'LIKE'
+        end
+      end
+
+      # Returns database specific string type.
+      def string_type
+        case db_adapter
+        when :postgresql then 'VARCHAR'
+        when :mysql2 then 'CHAR'
+        when :sqlite3 then 'TEXT'
+        end
+      end
+
+      # Retrieves rails database adapter.
+      def db_adapter
+        @db_adapter ||=
+        ActiveRecord::Base.configurations[Rails.env]['adapter'].to_sym
+      end
+    end
+  end
+end

data/lib/tablets/version.rb

@@ -1,3 +1,17 @@
 module Tablets
-  VERSION = '0.3.7'
+  # Tablets gem version.
+  module Version
+    MAJOR = 0
+    MINOR = 3
+    TINY  = 8
+    PRE   = nil
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, TINY, PRE].compact.join('.')
+      end
+
+      alias_method :to_str, :to_s
+    end
+  end
 end

data/lib/tablets.rb

@@ -15,5 +15,7 @@ require 'tablets/version'
 
 require 'tablets/tablet'
 
-require 'tablets/railtie'
-require 'tablets/engine'
+if defined? Rails
+  require 'tablets/railtie'
+  require 'tablets/engine'
+end

data/spec/lib/tablets/data/processing/filter_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+require 'tablets/data/processing/filter'
+
+RSpec.describe Tablets::Data::Processing::Filter do
+  subject { described_class.new(params, columns) }
+
+  let(:relation) { double }
+  let(:params) { { search: { value: value } } }
+
+  describe '#apply' do
+    let(:value) { 'query1 query2' }
+
+    before do
+      allow_any_instance_of(
+        Tablets::Utils::SearchConditionBuilder
+      ).to receive(:build) { |builder| "#{builder.column} #{builder.query}" }
+
+      allow(relation).to receive(:where).and_return(relation)
+    end
+
+    let(:columns) { [{ search: %w(column1 column2) }] }
+    let!(:result) { subject.apply(relation) }
+
+    it 'applies search conditions' do
+      expect(relation).to have_received(:where).with(
+        '(column1 query1 OR column2 query1) AND ' \
+        '(column1 query2 OR column2 query2)'
+      )
+    end
+
+    it 'returns relation' do
+      expect(result).to eq(relation)
+    end
+  end
+end

data/spec/lib/tablets/data/processing/order_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+require 'tablets/data/processing/order'
+
+RSpec.describe Tablets::Data::Processing::Order do
+  subject { described_class.new(params, columns) }
+
+  let(:relation) { double }
+  let(:order) { {} }
+  let(:params) { { order: order } }
+
+  describe '#apply' do
+    before do
+      allow(order).to receive(:values).and_return(values)
+      allow(relation).to receive(:order).and_return(relation)
+    end
+
+    let!(:result) { subject.apply(relation) }
+
+    context 'simple' do
+      let(:field) { 'field' }
+      let(:direction) { 'DESC' }
+      let(:columns) { [{ order: field }] }
+      let(:values) { [{ column: 0, dir: direction }] }
+
+      it 'applies order' do
+        expect(relation).to have_received(:order).with("#{field} #{direction}")
+      end
+
+      it 'returns relation' do
+        expect(result).to eq(relation)
+      end
+    end
+
+    context 'without direction' do
+      let(:field) { 'field' }
+      let(:columns) { [{ order: field }] }
+      let(:values) { [{ column: 0 }] }
+
+      it 'applies order with default direction' do
+        expect(relation).to have_received(:order).with("#{field} ASC")
+      end
+
+      it 'returns relation' do
+        expect(result).to eq(relation)
+      end
+    end
+
+    context 'multiple' do
+      let(:orders) do
+        (0..1).map do |index|
+          { field: "field#{index}", direction: 'DESC' }
+        end
+      end
+      let(:columns) { orders.map { |order| { order: order[:field] } } }
+      let(:values) do
+        orders.map.with_index do |order, index|
+          { column: index, dir: order[:direction] }
+        end
+      end
+
+      it 'applies order' do
+        orders.each do |order|
+          expect(relation).to have_received(:order)
+            .with("#{order[:field]} #{order[:direction]}")
+        end
+      end
+
+      it 'returns relation' do
+        expect(result).to eq(relation)
+      end
+    end
+  end
+end

data/spec/lib/tablets/global/store_spec.rb

@@ -12,8 +12,8 @@ RSpec.describe Tablets::Global::Store do
 
     before do
       subject.instance_eval { @tablets = {} }
-      allow(Tablets::Tablet).to receive(:new).with(name, &block)
-                                             .and_return(tablet)
+      allow(Tablets::Tablet).to receive(:new)
+        .with(name, &block).and_return(tablet)
     end
 
     let!(:result) { subject.register(name, &block) }

data/spec/lib/tablets/renderer_spec.rb

@@ -70,33 +70,28 @@ RSpec.describe Tablets::Renderer do
     end
 
     it 'renders tablets partial' do
-      expect(view_context).to have_received(:render).with(
-        hash_including(partial: 'tablets/tablet')
-      )
+      expect(view_context).to have_received(:render)
+        .with(hash_including(partial: 'tablets/tablet'))
     end
 
     it 'passes correct id as partial locals' do
-      expect(view_context).to have_received(:render).with(
-        locals(id: 'posts_user_id_1_tablet')
-      )
+      expect(view_context).to have_received(:render)
+        .with(locals(id: 'posts_user_id_1_tablet'))
     end
 
     it 'passes correct columns as partial locals' do
-      expect(view_context).to have_received(:render).with(
-        locals(columns: tablet_columns)
-      )
+      expect(view_context).to have_received(:render)
+        .with(locals(columns: tablet_columns))
     end
 
     it 'passes correct config as partial locals' do
-      expect(view_context).to have_received(:render).with(
-        locals(options: hash_including(options))
-      )
+      expect(view_context).to have_received(:render)
+        .with(locals(options: hash_including(options)))
     end
 
     it 'passes correct params as partial locals' do
-      expect(view_context).to have_received(:render).with(
-        locals(params: params)
-      )
+      expect(view_context).to have_received(:render)
+        .with(locals(params: params))
     end
 
     it 'returns render result' do

data/spec/lib/tablets/tablet_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+require 'tablets'
+
+require 'tablets/tablet'
+
+RSpec.describe Tablets::Tablet do
+  let(:name) { 'example' }
+  let(:block) { proc {} }
+
+  subject { described_class.new(name, &block) }
+
+  def self.define(callback, value)
+    let(:block) do
+      proc { send(callback) { value } }
+    end
+  end
+
+  context '#relation' do
+    context 'if configured' do
+      define(:relation, 'relation')
+
+      let!(:result) { subject.relation }
+
+      it 'return column configuration' do
+        expect(result).to eq('relation')
+      end
+    end
+  end
+
+  context '#columns' do
+    context 'if configured' do
+      define(:columns, 'columns')
+
+      let!(:result) { subject.columns }
+
+      it 'return column configuration' do
+        expect(result).to eq('columns')
+      end
+    end
+  end
+end

data/spec/lib/tablets/utils/search_condition_builder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+require 'tablets/utils/search_condition_builder'
+
+RSpec.describe Tablets::Utils::SearchConditionBuilder do
+  subject { described_class.new(column, query) }
+
+  before do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                            database: ':memory:')
+
+    allow(Rails).to receive(:env).and_return('env')
+    allow(ActiveRecord::Base).to receive(:configurations)
+      .and_return('env' => { 'adapter' => adapter })
+  end
+
+  describe '#build' do
+    let(:column) { 'table.column' }
+    let(:query) { 'query' }
+    let!(:result) { subject.build }
+
+    context 'postgresql' do
+      let(:adapter) { 'postgresql' }
+
+      it 'returns correct SQL statement' do
+        expect(result).to eq(
+          '(CAST ("table"."column" AS VARCHAR) ILIKE \'%query%\')'
+        )
+      end
+    end
+
+    context 'mysql2' do
+      let(:adapter) { 'mysql2' }
+
+      it 'returns correct SQL statement' do
+        expect(result).to eq(
+          '(CAST ("table"."column" AS CHAR) LIKE \'%query%\')'
+        )
+      end
+    end
+
+    context 'sqlite3' do
+      let(:adapter) { 'sqlite3' }
+
+      it 'returns correct SQL statement' do
+        expect(result).to eq(
+          '(CAST ("table"."column" AS TEXT) LIKE \'%query%\')'
+        )
+      end
+    end
+  end
+end

data/spec/lib/tablets/view_helpers_spec.rb

@@ -16,10 +16,10 @@ RSpec.describe Tablets::ViewHelpers do
 
     before do
       allow(Tablets).to receive(:[]).with(name).and_return(tablet)
-      allow(Tablets::Renderer).to receive(:new).with(tablet, params)
-                                               .and_return(renderer)
-      allow(renderer).to receive(:render).with(subject)
-                                         .and_return(render_result)
+      allow(Tablets::Renderer).to receive(:new)
+        .with(tablet, params).and_return(renderer)
+      allow(renderer).to receive(:render)
+        .with(subject).and_return(render_result)
     end
 
     let!(:result) { subject.render_tablet(name, params) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablets
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Yevhen Shemet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: jquery-datatables-rails
   requirement: !ruby/object:Gem::Requirement
@@ -127,17 +127,21 @@ files:
 - lib/tablets/renderer.rb
 - lib/tablets/tablet.rb
 - lib/tablets/utils/config.rb
-- lib/tablets/utils/search_condition.rb
+- lib/tablets/utils/search_condition_builder.rb
 - lib/tablets/version.rb
 - lib/tablets/view_helpers.rb
 - spec/lib/tablets/data/processing/base_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/configurator_spec.rb
 - spec/lib/tablets/global/loader_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
 homepage: https://github.com/zenedge/tablets
@@ -168,10 +172,14 @@ 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/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/renderer_spec.rb

data/lib/tablets/utils/search_condition.rb

@@ -1,56 +0,0 @@
-module Tablets
-  module Utils
-    # Resposible for building database specific search conditions.
-    module SearchCondition
-      class << self
-        # Builds search condition for specific db type.
-        def build(column, query)
-          sanitize "(#{casted_column(column)} #{like} ?)", "%#{query}%"
-        end
-
-        private
-
-        # Sanitizes sql expression with params.
-        def sanitize(sql, *params)
-          ActiveRecord::Base.send(:sanitize_sql_array, [sql, *params])
-        end
-
-        # Casyt column to string.
-        def casted_column(column)
-          "CAST (#{quoted_column(column)} AS #{string_type})"
-        end
-
-        # Quotes column name.
-        def quoted_column(column)
-          column.split('.').map do |component|
-            ActiveRecord::Base.connection.quote_column_name component
-          end.join('.')
-        end
-
-        # Returns database specific like operator.
-        def like
-          case db_adapter
-            when :postgresql then 'ILIKE'
-            when :mysql2 then 'LIKE'
-            when :sqlite3 then 'LIKE'
-          end
-        end
-
-        # Returns database specific string type.
-        def string_type
-          case db_adapter
-            when :postgresql then 'VARCHAR'
-            when :mysql2 then 'CHAR'
-            when :sqlite3 then 'TEXT'
-          end
-        end
-
-        # Retrieves rails database adapter.
-        def db_adapter
-          @db_adapter ||=
-          ActiveRecord::Base.configurations[Rails.env]['adapter'].to_sym
-        end
-      end
-    end
-  end
-end