tablets 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5e96cdb1c2b3d97a936ff7d2c8f9db941468990
-  data.tar.gz: 5337d9aa657c9c69aa82281778f0fe2316837a4c
+  metadata.gz: a1b6c2a3367aa2d3d1a85c849259390a61bd66e9
+  data.tar.gz: '093dd43af37ae99f4f5997da3f166af019adf33a'
 SHA512:
-  metadata.gz: 90d6403fb216b57abf8e4284f82295ee946b3abce57d5b456f0cfbc2fa343d52ded1c741e71f37d10c3f4e5e0efda68c290dac6e3351469c93328189b2125726
-  data.tar.gz: c991fccc8065312bf592cdd23f587da5007852c7981187b539e28cab8f6987fd91362c1c53afb0d9ff7f8baec4af0ed1b4c8df649ed320c8a94f65021c012a01
+  metadata.gz: 89467c8e0d974dc4763b45752b46ba498af5b48a7bb3db41d4b6120072f5a961482014ede0bca39a7004ef1cb11fb8049c646926cd6816be592341a0802201c0
+  data.tar.gz: 57640ae54b8fea65a99457eb403a4243ddec1f9f832d3e7a1b333aad4283a16cc3ee62a3f181efe2361963403628cafd28b144e0ad4870f0deba49c9322eba5e

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![Build Status](https://travis-ci.org/zenedge/tablets.svg?branch=master)](https://travis-ci.org/zenedge/tablets)
 
 ## Installation
 
@@ -36,19 +37,19 @@ mount Tablets::Engine, at: '/tablets'
 In `app/tablets/posts.rb`:
 
 ``` ruby
-Tablets.register :posts do
+PostsTablet < Tablets::Base
   # Authorization logic.
-  authorize do |controller|
+  def authorize(controller)
     controller.current_user.id == params[:author_id]
   end
 
   # jQuery-datatables options overrides.
-  options do
+  def options
     { order: [0, 'asc'] }
   end
 
   # Columns definitions.
-  columns do
+  def columns
     [{
       title: 'Title',
       data: :title,
@@ -70,23 +71,23 @@ Tablets.register :posts do
   end
 
   # HTML for details area.
-  details do |post|
+  def details(post)
     post.content.html_safe
   end
 
   # Process records before extracting data.
-  process do |posts|
+  def process(posts)
     posts.map { |post| post.use_wrapper }
   end
 
   # Data relation.
-  relation do |params|
+  def relation(params:, **)
     # Note: users joined to enable ordering.
     Post.joins(:users).where(user_id: params[:user_id])
   end
 
   # Additional data added to response.
-  payload do
+  def payload
     { hash_with: 'data' }
   end
 end

data/app/controllers/tablets/ajax_controller.rb

@@ -10,7 +10,7 @@ module Tablets
     private
 
     def tablet
-      @tablet ||= Tablets[params[:name].to_sym]
+      @tablet ||= Tablets[params[:name].to_s].new
     end
 
     def authorize!

data/lib/tablets/base.rb

@@ -0,0 +1,65 @@
+module Tablets
+  # Incapsulates tablet related information
+  class Base
+    def self.inherited(child_class)
+      tablet_name = child_class.tablet_name
+      Tablets.register_tablet(tablet_name, child_class)
+    end
+
+    def self.tablet_name
+      name.underscore.sub(/_tablet$/, '')
+    end
+
+    def name
+      self.class.tablet_name
+    end
+
+    # Returns general jquery-datatable configuration overrides
+    def options
+      {}
+    end
+
+    # Determines is user authorized
+    def authorize(controller)
+      true
+    end
+
+    # Allows to make additional processing before records would be used
+    def process(records)
+      records
+    end
+
+    # Returns details HTML for the record
+    def details(record)
+      nil
+    end
+
+    # Returns columns definitions
+    def columns
+      deduct_columns_from_relation
+    end
+
+    # Returns database relation to fetch data
+    def relation(options = {})
+      name.camelize.constantize.where(nil)
+    end
+
+    # Returns additional data returned to client
+    def payload
+      {}
+    end
+
+    private
+
+    # Returns default columns definititions, deducted from relation
+    def deduct_columns_from_relation
+      relation.columns.map(&:name).map do |name|
+        {
+          title: name.humanize.capitalize,
+          data: name.to_sym,
+          order: name
+        }
+      end
+    end
+  end
+end

data/lib/tablets/data.rb

@@ -34,7 +34,7 @@ module Tablets
 
     # Relation with concretized parameters
     def concrete_relation
-      tablet.relation(relation_params, controller)
+      tablet.relation(params: relation_params, controller: controller)
     end
 
     # Relation params. Empty hash by default

data/lib/tablets/global/loader.rb

@@ -3,20 +3,8 @@ module Tablets
     # Tablets loader
     # Manages files loading from app tablets directory
     module Loader
-      # Unloads tablet
-      def unload!
-        @tablets = nil
-      end
-
-      # Checks if tablet is loading
-      # Tablets is not loaded only if tablets is nil
-      def loaded?
-        !@tablets.nil?
-      end
-
       # Loads tablets files
       def load!
-        @tablets = {}
         files.each { |file| load file }
       end
 

data/lib/tablets/global/store.rb

@@ -1,4 +1,4 @@
-require 'tablets/tablet'
+require 'tablets/base'
 
 module Tablets
   module Global
@@ -7,18 +7,16 @@ module Tablets
     module Store
       extend Forwardable
 
-      attr_reader :tablets
-
       def_delegators :tablets, :[]
 
-      # Initializes tablet and put tablet into store
-      #
-      #   Tablets.register(:user) do
-      #     # Tablet configuration.
-      #   end
-      #
-      def register(name, &block)
-        @tablets[name] = Tablets::Tablet.new(name, &block)
+      def tablets
+        @tablets || {}
+      end
+
+      # put tablet into store
+      def register_tablet(name, tablet_class)
+        @tablets ||= {}
+        @tablets[name] = tablet_class
       end
     end
   end

data/lib/tablets/railtie.rb

@@ -20,15 +20,7 @@ module Tablets
     # 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
-        reloader_class.to_prepare(prepend: true) { Tablets.unload! }
-      else
-        reloader_class.to_cleanup { Tablets.unload! }
-      end
-
-      reloader_class.to_prepare do
-        Tablets.load! unless Tablets.loaded?
-      end
+      reloader_class.to_prepare { Tablets.load! }
     end
   end
 end

data/lib/tablets/version.rb

@@ -1,8 +1,8 @@
 module Tablets
   # Tablets gem version
   module Version
-    MAJOR = 1
-    MINOR = 1
+    MAJOR = 2
+    MINOR = 0
     TINY  = 0
     PRE   = nil
 

data/lib/tablets/view_helpers.rb

@@ -12,7 +12,7 @@ module Tablets
       locals = opts.fetch(:locals, {})
       initialize_instantly = opts.fetch(:initialize_instantly, false)
 
-      Tablets::Renderer.new(Tablets[name], locals, initialize_instantly: initialize_instantly).render(self)
+      Tablets::Renderer.new(Tablets[name.to_s].new, locals, initialize_instantly: initialize_instantly).render(self)
     end
   end
 end

data/lib/tablets.rb

@@ -13,8 +13,6 @@ end
 
 require 'tablets/version'
 
-require 'tablets/tablet'
-
 if defined? Rails
   require 'tablets/railtie'
   require 'tablets/engine'

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

@@ -20,11 +20,12 @@ RSpec.describe Tablets::Data::Processing::Order do
     context 'simple' do
       let(:field) { 'field' }
       let(:direction) { 'DESC' }
+      let(:nulls) { 'NULLS LAST' }
       let(:columns) { [{ order: field }] }
       let(:values) { [{ column: 0, dir: direction }] }
 
       it 'applies order' do
-        expect(relation).to have_received(:order).with("#{field} #{direction}")
+        expect(relation).to have_received(:order).with("#{field} #{direction} #{nulls}")
       end
 
       it 'returns relation' do
@@ -38,7 +39,7 @@ RSpec.describe Tablets::Data::Processing::Order do
       let(:values) { [{ column: 0 }] }
 
       it 'applies order with default direction' do
-        expect(relation).to have_received(:order).with("#{field} ASC")
+        expect(relation).to have_received(:order).with("#{field} ASC NULLS FIRST")
       end
 
       it 'returns relation' do
@@ -49,7 +50,7 @@ RSpec.describe Tablets::Data::Processing::Order do
     context 'multiple' do
       let(:orders) do
         (0..1).map do |index|
-          { field: "field#{index}", direction: 'DESC' }
+          { field: "field#{index}", direction: 'DESC', nulls: 'NULLS LAST' }
         end
       end
       let(:columns) { orders.map { |order| { order: order[:field] } } }
@@ -62,7 +63,7 @@ RSpec.describe Tablets::Data::Processing::Order do
       it 'applies order' do
         orders.each do |order|
           expect(relation).to have_received(:order)
-            .with("#{order[:field]} #{order[:direction]}")
+            .with("#{order[:field]} #{order[:direction]} #{order[:nulls]}")
         end
       end
 

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

@@ -7,42 +7,6 @@ require 'tablets/global/loader'
 RSpec.describe Tablets::Global::Loader do
   subject { Object.new.tap { |object| object.extend(described_class) } }
 
-  def self.set_tablets
-    before do
-      subject.instance_variable_set(:@tablets, yield)
-    end
-  end
-
-  def tablets
-    subject.instance_variable_get(:@tablets)
-  end
-
-  describe '#unload!' do
-    set_tablets { {} }
-
-    before { subject.unload! }
-
-    it 'sets tablets to nil' do
-      expect(tablets).to be_nil
-    end
-  end
-
-  describe '#loaded?' do
-    context 'if tablets is not nil' do
-      set_tablets { {} }
-
-      it 'returns true' do
-        expect(subject.loaded?).to eq(true)
-      end
-    end
-
-    context 'if tablets is nil' do
-      it 'returns false' do
-        expect(subject.loaded?).to eq(false)
-      end
-    end
-  end
-
   describe '#load!' do
     let(:files) { %w(file1 file2) }
     let(:tablets_dir) { 'dir' }
@@ -56,16 +20,10 @@ RSpec.describe Tablets::Global::Loader do
       allow(subject).to receive(:load)
     end
 
-    before { subject.load! }
-
-    it 'sets tablets to empty hash' do
-      expect(tablets).to eq({})
-    end
-
-    it 'loads each file' do
-      files.each do |file|
-        expect(subject).to have_received(:load).with(file)
-      end
+    it 'loads files from tablets directory' do
+      expect(subject).to receive(:load).with 'file1'
+      expect(subject).to receive(:load).with 'file2'
+      subject.load!
     end
   end
 end

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

@@ -7,20 +7,13 @@ RSpec.describe Tablets::Global::Store do
 
   describe '#register' do
     let(:name) { :posts }
-    let(:block) { proc {} }
     let(:tablet) { double }
 
     before do
       subject.instance_eval { @tablets = {} }
-      allow(Tablets::Tablet).to receive(:new)
-        .with(name, &block).and_return(tablet)
     end
 
-    let!(:result) { subject.register(name, &block) }
-
-    it 'initializes tablet' do
-      expect(Tablets::Tablet).to have_received(:new).with(name, &block)
-    end
+    let!(:result) { subject.register_tablet(name, tablet) }
 
     it 'stores tablet' do
       expect(subject.tablets).to eq(name => tablet)

data/spec/lib/tablets/tablets_base_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+require 'tablets'
+
+require 'tablets/base'
+
+RSpec.describe Tablets::Base do
+  class PostTablet < Tablets::Base; end
+
+  subject { PostTablet.new }
+
+  describe '#name' do
+    let(:result) { subject.name }
+
+    it 'returns tablet name' do
+      expect(result).to eq('post')
+    end
+  end
+
+  describe '#options' do
+    let(:result) { subject.options }
+
+    it 'returns tablet options' do
+      expect(result).to eq({})
+    end
+  end
+
+  describe '#authorize' do
+    let(:result) { subject.authorize(nil) }
+
+    it 'returns tablet authorization response' do
+      expect(result).to eq(true)
+    end
+  end
+
+  describe '#process' do
+    let(:result) { subject.process([1, 2]) }
+
+    it 'returns tablet processings' do
+      expect(result).to eq([1, 2])
+    end
+  end
+
+  describe '#details' do
+    let(:result) { subject.details(nil) }
+
+    it 'returns tablet details' do
+      expect(result).to eq(nil)
+    end
+  end
+
+  describe '#payload' do
+    let(:result) { subject.payload }
+
+    it 'returns tablet payload' do
+      expect(result).to eq({})
+    end
+  end
+
+  describe '#tablet_name' do
+    let(:result) { PostTablet.tablet_name }
+
+    it 'returns tablet name' do
+      expect(result).to eq('post')
+    end
+  end
+end

data/spec/lib/tablets/view_helpers_spec.rb

@@ -9,15 +9,16 @@ RSpec.describe Tablets::ViewHelpers do
 
   describe '#render_tablet' do
     let(:name) { :name }
-    let(:params) { 'params' }
+    let(:params) { {} }
+    let(:initialize_param) { { initialize_instantly: false } }
     let(:tablet) { double }
     let(:renderer) { double }
     let(:render_result) { 'render_result' }
 
     before do
-      allow(Tablets).to receive(:[]).with(name).and_return(tablet)
+      allow(Tablets).to receive_message_chain(:[], :new).and_return(tablet)
       allow(Tablets::Renderer).to receive(:new)
-        .with(tablet, params).and_return(renderer)
+        .with(tablet, params, initialize_param).and_return(renderer)
       allow(renderer).to receive(:render)
         .with(subject).and_return(render_result)
     end
@@ -25,11 +26,11 @@ RSpec.describe Tablets::ViewHelpers do
     let!(:result) { subject.render_tablet(name, params) }
 
     it 'finds tablet' do
-      expect(Tablets).to have_received(:[]).with(name)
+      expect(Tablets).to have_received(:[]).with(name.to_s)
     end
 
     it 'initializes renderer' do
-      expect(Tablets::Renderer).to have_received(:new).with(tablet, params)
+      expect(Tablets::Renderer).to have_received(:new).with(tablet, params, initialize_param)
     end
 
     it 'renders in current view context' do

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: tablets
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
+- Ramunas Cvirka
 - Yevhen Shemet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -96,7 +97,7 @@ dependencies:
         version: 0.30.1
 description: 
 email:
-- yevhene@gmail.com
+- rcvirka@zenedge.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -113,6 +114,7 @@ files:
 - app/views/tablets/_tablet.html.erb
 - config/routes.rb
 - lib/tablets.rb
+- lib/tablets/base.rb
 - lib/tablets/data.rb
 - lib/tablets/data/processing/base.rb
 - lib/tablets/data/processing/filter.rb
@@ -125,7 +127,6 @@ files:
 - lib/tablets/global/store.rb
 - lib/tablets/railtie.rb
 - lib/tablets/renderer.rb
-- lib/tablets/tablet.rb
 - lib/tablets/utils/config.rb
 - lib/tablets/utils/search_condition_builder.rb
 - lib/tablets/version.rb
@@ -139,7 +140,7 @@ files:
 - 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/tablets_base_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
@@ -164,22 +165,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Wrapper around jquery-datatables.
 test_files:
+- spec/lib/tablets/data/processing/paginate_spec.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/view_helpers_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/global/loader_spec.rb
+- spec/lib/tablets/tablets_base_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/lib/tablets/utils/config_spec.rb
 - spec/spec_helper.rb

data/lib/tablets/tablet.rb

@@ -1,86 +0,0 @@
-require 'tablets/utils/config'
-
-module Tablets
-  # Incapsulates tablet related information
-  class Tablet
-    attr_reader :name
-
-    # 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
-    def options
-      call(:options) { {} }
-    end
-
-    # 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
-    def process(records)
-      call(:process, records) { records }
-    end
-
-    # 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
-    def columns
-      call(:columns) { deduct_columns_from_relation }
-    end
-
-    # 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
-          @name.camelize.constantize.where(nil)
-        end
-      else
-        call(:relation, params, controller)
-      end
-    end
-
-    # Returns additional data returned to client
-    def payload
-      call(:payload) { {} }
-    end
-
-    # Checks if config has callback with specified name
-    def has?(name)
-      @config.has?(name)
-    end
-
-    private
-
-    # Returns default columns definititions, deducted from relation
-    def deduct_columns_from_relation
-      relation.columns.map(&:name).map do |name|
-        {
-          title: name.humanize.capitalize,
-          data: name.to_sym,
-          order: name
-        }
-      end
-    end
-
-    # Calls callback and clarifies error message on error
-    def call(callback, *params, &block)
-      @config.call(callback, *params, &block)
-    rescue ArgumentError
-      raise ArgumentError, "Please define #{callback} for '#{name}' tablet."
-    end
-  end
-end

data/spec/lib/tablets/tablet_spec.rb

@@ -1,42 +0,0 @@
-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