tablets 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a1fa5246fe01b026cb2cb2eea4d8a1bdf1bb864
-  data.tar.gz: d41e7ccd372d8f2a63b702c77521a874e4baf4bc
+  metadata.gz: 073682f3e75df008250ab8ec39352ed307eb797e
+  data.tar.gz: e811d153b45b6bce4396f9711aa45e2c039b6fea
 SHA512:
-  metadata.gz: ab12d327506c9abfc4083855019fadffcddd399db62098b44f788a5abc91e823969df57e140214f9c5d38fb6047de374dc920281c128ae84c649d7c51235ac42
-  data.tar.gz: 8a0c9608f4dfb7deb525674287114fef5f6090bca34ec10daa1a0e8b8df4342c0cb7ae6b99382ff5053323774d63d2fa64b4c30cdfa16357b14a45a22bcb9563
+  metadata.gz: c0603710b65211af597d17c3015e6b175871f44c3d5d417f9560fe810c0c6c172e1bfe90d4472beb85e31d81d2e67902274a151a34210bbbd16a6362a429f511
+  data.tar.gz: 086fe45cd22de329a6fc4da74dcc5f273cccdd4e724380d15ff3e4c24e3d8457b0e59c848288f4dd7db1d38747fd31e99f0f38b445d0f8aafb214ff2fd2e0d50

data/README.md

@@ -1,33 +1,39 @@
 # Tablets
 
+[![Gem Version](https://badge.fury.io/rb/tablets.svg)](http://badge.fury.io/rb/tablets)
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
 
-```ruby
+``` ruby
 gem 'tablets'
 ```
 
 Include tablets and jquery datatables scripts in your `app/assets/application.js`:
-```
+
+``` javascript
 //= require dataTables/jquery.dataTables
 //= require tablets
 ```
 
 Include jquery datatables styles in your `app/assets/application.css`:
+
 ```
  *= require dataTables/jquery.dataTables
 ```
 
 Mount engine in `config/routes.rb`:
-```
+
+``` ruby
 mount Tablets::Engine, at: '/tablets'
 ```
 
 ## Examples
 
 In `app/tablets/posts.rb`:
-```ruby
+
+``` ruby
 Tablets.register :posts do
   # Authorization logic.
   authorize do |controller|
@@ -43,13 +49,14 @@ Tablets.register :posts do
   columns do
     [{
       title: 'Title',
-      order: 'posts.title',
       data: :title,
+      order: 'posts.title',
+      search: 'posts.title',
       options: { className: 'post-title' }
     }, {
       title: 'User',
-      order: ['users.first_name', 'users.last_name'],
       data: ->(user) { [user.first_name, user.last_name].compact.join(' ') },
+      order: ['users.first_name', 'users.last_name'],
       search: ['users.first_name', 'users.last_name']
     }]
   end
@@ -72,19 +79,41 @@ Tablets.register :posts do
 end
 ```
 
-In `app/views/posts/index.html.erb`
-```erb
+In `app/views/posts/index.html.erb`:
+
+``` erb
 <%= render_tablet :posts, user_id: current_user.id %>
 ```
 
-## JavaScripts callbacks
+In `app/assets/javascripts/posts.js`:
+
+``` javascript
+$('.tablet[name="posts"]').on('click', 'tbody > tr[role=row]', function() {
+  Tablets.toggleDetails($(this).closest('tr'));
+});
+
+```
+
+Use `'.tablet.has-details'` for all tablets that has details.
+
+## JavaScript callbacks
 
 Called just before datatable initialization.
-```javascript
-Tablets.Callbacks.beforeInit = function(element, options) {}
+
+``` javascript
+Tablets.Callbacks.beforeInit = function(element, options) {};
 ```
 
 Called after datatable initialization.
-```javascript
-Tablets.Callbacks.afterInit = function(table) {}
+
+``` javascript
+Tablets.Callbacks.afterInit = function(table) {};
+```
+
+## JavaScript API
+
+Open details for row.
+
+``` javascript
+Tablets.toggleDetails($tr);
 ```

data/Rakefile

@@ -11,6 +11,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.title    = 'Tablets'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.md')
 end
 
 Bundler::GemHelper.install_tasks

data/app/assets/javascripts/tablets/details.js.coffee

@@ -0,0 +1,3 @@
+$.extend @Tablets,
+  toggleDetails: ($tr) ->
+    @tabletForElement($tr).toggleDetails($tr)

data/app/assets/javascripts/tablets/navigation.js.coffee

@@ -0,0 +1,5 @@
+$.extend @Tablets,
+  tabletId: ($element) ->
+    $element.closest('.tablet').attr('id')
+  tabletForElement: ($element) ->
+    Tablets.get(@tabletId($element))

data/app/assets/javascripts/tablets/store.js.coffee

@@ -0,0 +1,5 @@
+$.extend @Tablets,
+  set: (id, tablet) ->
+    (@store ||= {})[id] = tablet
+  get: (id) ->
+    (@store ||= {})[id]

data/app/assets/javascripts/tablets/tablet.js.coffee

@@ -1,7 +1,8 @@
 class Tablets.Tablet
   constructor: (@element, @options, @params) ->
     @initTable()
-    @initDetails()
+
+    Tablets.set(@element.attr('id'), this)
 
   dataTableOptions: ->
     $.extend {}, @options,
@@ -17,19 +18,15 @@ class Tablets.Tablet
 
     Tablets.Callbacks.afterInit(@table)
 
-  initDetails: ->
-    table = @table
-    table.on 'click', 'tbody > tr[role=row] > td:first-child', ->
-      tr = $(this).closest 'tr'
-      row = table.row tr
-
-      if row.child.isShown()
-        row.child.hide()
-        tr.removeClass 'expanded'
-        tr.removeClass 'shown'
-      else
-        data = row.data().details
-        if data
-          row.child("<span>#{data}</span>").show()
-          tr.addClass 'expanded'
-          tr.addClass 'shown'
+  toggleDetails: (tr) ->
+    row = @table.row tr
+
+    if row.child.isShown()
+      row.child.hide()
+      tr.removeClass 'expanded'
+      tr.removeClass 'shown'
+    else
+      data = row.data().details
+      row.child("<span>#{data}</span>").show()
+      tr.addClass 'expanded'
+      tr.addClass 'shown'

data/app/views/tablets/_tablet.html.erb

@@ -1,4 +1,4 @@
-<table class="table tablet" id="<%= id %>" data-name="<%= name %>">
+<table class="table tablet <%= 'has-details' if has_details %>" id="<%= id %>" data-name="<%= name %>">
   <thead>
     <tr>
       <% columns.each.with_index do |column, index| %>

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

@@ -10,7 +10,7 @@ module Tablets
         end
 
         # Applies processing on relation. Need to be implemented in descendants.
-        def apply(relation)
+        def apply(_relation)
           fail NotImplementedError, '#apply need to be overrided by processing.'
         end
 

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

@@ -7,8 +7,8 @@ module Tablets
       class Order < Tablets::Data::Processing::Base
         # Applies order processing on relation.
         def apply(relation)
-          params[:order].values.inject(relation) do |relation, item|
-            relation.order("#{column(item)} #{direction(item)}")
+          params[:order].values.inject(relation) do |rel, item|
+            rel.order("#{column(item)} #{direction(item)}")
           end
         end
 

data/lib/tablets/renderer.rb

@@ -25,7 +25,8 @@ module Tablets
         name: tablet.name,
         columns: tablet.columns,
         options: options,
-        params: params
+        params: params,
+        has_details: tablet.details?
       }
     end
 

data/lib/tablets/tablet.rb

@@ -35,6 +35,11 @@ module Tablets
       call(:details, record) { nil }
     end
 
+    # Checks if details is defined.
+    def details?
+      has?(:details)
+    end
+
     # Returns columns definitions.
     # Required.
     def columns
@@ -49,6 +54,11 @@ module Tablets
 
     private
 
+    # Checks if config has callback with specified name.
+    def has?(name)
+      @config.has?(name)
+    end
+
     # Calls callback.
     # Clarifies error message on error.
     def call(callback, *params, &block)

data/lib/tablets/utils/config.rb

@@ -32,6 +32,11 @@ module Tablets
         instance_eval(&block)
       end
 
+      # 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.

data/lib/tablets/version.rb

@@ -1,3 +1,3 @@
 module Tablets
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/lib/tablets/renderer_spec.rb

@@ -49,7 +49,10 @@ RSpec.describe Tablets::Renderer do
 
     before do
       allow(tablet).to receive_messages(
-        name: tablet_name, columns: tablet_columns, options: tablet_options
+        name: tablet_name,
+        columns: tablet_columns,
+        options: tablet_options,
+        details?: false
       )
 
       allow(Tablets::Engine).to receive_message_chain(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yevhen Shemet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -106,6 +106,9 @@ files:
 - Rakefile
 - app/assets/javascripts/tablets.js.coffee
 - app/assets/javascripts/tablets/callbacks.js.coffee
+- app/assets/javascripts/tablets/details.js.coffee
+- app/assets/javascripts/tablets/navigation.js.coffee
+- app/assets/javascripts/tablets/store.js.coffee
 - app/assets/javascripts/tablets/tablet.js.coffee
 - app/controllers/tablets/ajax_controller.rb
 - app/views/tablets/_tablet.html.erb