snaptable 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb56b243781d4c42a2d7c5b9b2c63057ce3a3db
-  data.tar.gz: 78499e0f5de6a5d9fc83ee6f1dc30d83755b05e8
+  metadata.gz: bb7ab05db59cf1a238e3efb6b1d7d091314a0b60
+  data.tar.gz: 97e0fad19495df1c621b997f549dcacdbdc4fe4f
 SHA512:
-  metadata.gz: 73550f23e475b6e13ec28dec5df99e92993ed3fa6428fca7fe4bf4ac8cf5e66a2bab831866ce2837ff1ddaa0385915211953840ce24093bc8dca7c37c0281d80
-  data.tar.gz: 7aad41b65884219bf7ea6ac661a04820522ca164ebbf22095569d9f0dee9f99170672c4186d38d562e749a6bf6270d9b32f78d209ac55c3e08c1fe33cbf4116d
+  metadata.gz: c6d9e2e50baf967dc1f41172fa698d24aa48d831806f1423518c90bc194a9bd2736cd0f692c18bae243ad1d4370770c2698ddf1289629043a05a402b1d53a8f0
+  data.tar.gz: 8b97555bd23e36319578a1f4aeb3ab983cece15f4b4403f1e260c5c5814eda48230170627eb33fe04aabab8a5b328a9b79244522c24b46f7c0789a4a69979bed

data/README.md

@@ -18,6 +18,8 @@ Or install it yourself as:
 
     $ gem install snaptable
 
+The gem requires also jQuery.
+
 ## Usage
 
 ### Basic table
@@ -47,6 +49,8 @@ Finally, in your view, generate the table where you wish.
 </div>
 ```
 
+The elements in the table are clickable. Click on an element and use the links above the table to edit or destroy it. If you double-click, you are directly redirect to the edit page.
+
 ### Options
 
 You can customize the table when you instanciate it. Pass you own collection in the third argument.
@@ -67,18 +71,78 @@ Table.new(self, Article, nil, { search: true, buttons: false })
 
 ### Custom class
 
-TODO
+If you need more control on the displayed fields or on the search, you can easily create your own table.
+Create a directory `app/tables`. Then create a file `my_model_table.rb`. Inside declare a class `MyModelTable` that inherits from `BaseTable`.
+You must necessarily write a method called `model` that returns the model to use for your table.
+
+```ruby
+# article_table.rb
+class ArticleTable < BaseTable
+
+  def model
+    Article
+  end
+
+end
+```
+
+From that point, you have a working table, but it acts exactly the same than the basic table. You have few possibilites to change the behavior.
+If you want to change the table's columns, write a method `attributes` that return an array of the model's attributes you want to display. It supports associations by allowing you to put a hash.
+
+```ruby
+def attributes
+  [:title, :content, { user: :name }]
+end
+```
+
+You can also change how the URL to edit and delete an element is generated. By default it uses the element's id, but you can specify an other attribute. Write a method `url` that returns the attribute.
+
+```ruby
+def url
+  :slug
+end
+```
+
+By default, the search is done on the string fields of the model. If you want to search on the associations, create a module `Search` inside the class. Then declare a method `self.fields` that returns a hash and `self.associations` that returns an array. Be careful, the search is only possible on string fields.
+
+```ruby
+class ArticleTable < BaseTable
+
+  def model
+    Article
+  end
+
+  def attributes
+    [:title, :content, { user: :name }]
+  end
+
+  def url
+    :slug
+  end
+
+  module Search
+
+    def self.associations
+      [:user, :category]
+    end
+
+    def self.fields
+      { articles: [:title, :content], user: [:name, :email], category: [:name] }
+    end
+
+  end
+```
 
-### Permissions
+### Permission
 
 if you want to use a permission system, you can enable it in an initializer.
 
 ```ruby
-# snaptable.rb
+# initializers/snaptable.rb
 Snaptable.use_permission = true
 ```
 
-When the table fetches the data, it will use `current_permission.records(controller, model, token)`. It is up to you to implement a class and its method that respond to those three arguments.
+When the table fetches the data, it will use `current_permission.records(controller, model, token)`. It is up to you to implement the class and its method that respond to those three arguments.
 
 ## Contributing
 

data/app/assets/javascripts/{autotable.js → snaptable.js}

@@ -1,21 +1,22 @@
 /* Admin table */
 
-$(document).on("ready page:load", function() {
+function snapifyTable() {
   
-  var tableButtons = $('.table_buttons'),
+  var snaptable = $('#snaptable')
+
+  var tableButtons = snaptable.find('.table_buttons'),
       editButton = tableButtons.find('a[class="edit"]'),
       deleteButton = tableButtons.find('a[class="delete"]'),
       path = window.location.pathname + '/';
-      table = $("#admin_table");
 
   // add ajax to the pagination
-  table.on("click", ".pagination a", function() {
+  snaptable.on("click", ".pagination a", function() {
     $.getScript(this.href);
     return false;
   });
 
   // line clickable
-  table.on("click", "tbody tr", function(e) {
+  snaptable.on("click", "tbody tr", function(e) {
     var id = $(this).data('url') ;
     if ( typeof id !== 'undefined' && !$(this).hasClass('selected') ) {
       $('tr.selected').removeClass('selected');
@@ -27,11 +28,17 @@ $(document).on("ready page:load", function() {
   });
 
   // Double click
-  table.on("dblclick", "tbody tr", function() {
+  snaptable.on("dblclick", "tbody tr", function() {
     var id = $(this).data('url');
     if ( typeof id !== 'undefined' ) {
       window.location = path + id + '/edit';
     }
   });
 
+}
+
+$(document).on("ready page:load", function() {
+
+  snapifyTable();
+
 });

data/app/assets/stylesheets/{autotable.css.scss → snaptable.css.scss}

@@ -1,6 +1,6 @@
 /* Table */
 
-#admin_table {
+#snaptable {
   width: 100%;
   overflow: auto;
 

data/app/views/base.html.erb

@@ -1,4 +1,4 @@
-<div id="admin_table">
+<div id="snaptable">
 
 	<%= render 'search_field' if presenter.options[:search] == true %>
 	<%= render 'buttons' unless presenter.options[:buttons] == false %>
@@ -13,7 +13,7 @@
 		<tbody>
 			<% if presenter.records.any? %>
 				<% presenter.records.each do |record| %>
-					<tr class="<%= cycle('odd', 'even') %>" data-url="<%= presenter.url(record) %>">
+					<tr class="<%= cycle('odd', 'even') %>" data-url="<%= record.send(presenter.url) %>">
 						<% presenter.values(record).each do |value| %>
 							<td><%= truncate((strip_tags value), length: 40) %></td>
 						<% end %>

data/app/views/sort.js.erb

@@ -1 +1,2 @@
-$('#admin_table').html('<%= j @table.present %>') ;
+$('#snaptable').replaceWith('<%= j @table.present %>') ;
+snapifyTable();

data/lib/snaptable/constructor/base_table.rb

@@ -3,7 +3,7 @@ require 'snaptable/constructor/collection'
 require 'snaptable/constructor/renderer'
 
 module Snaptable
-  module Constructor 
+  module Constructor
 
       class BaseTable < SimpleDelegator
         include Sortable
@@ -21,22 +21,8 @@ module Snaptable
           @options
         end
 
-        def column_names
-          model.column_names
-        end
-
-        def url(e)
-          e.id
-        end
-
-        def values(element)
-          attributes.map do |attribute|
-            if attribute.is_a? Symbol 
-              element.send(attribute)
-            else
-              element.send(*attribute.keys).send(*attribute.values)
-            end.to_s
-          end
+        def url
+          :id
         end
 
         private
@@ -48,4 +34,6 @@ module Snaptable
       end
 
   end
-end
+end
+
+BaseTable = Snaptable::Constructor::BaseTable

data/lib/snaptable/constructor/collection.rb

@@ -33,11 +33,15 @@ module Snaptable
       end
 
       def query_fields
-        self.class::Search.fields || { model.table_name => model.columns.select{ |c| c.type == :string }.map{ |c| c.name } }
+        if self.class.const_defined?(:Search)
+          self.class::Search.fields
+        else
+          { model.table_name => model.columns.select{ |c| c.type == :string }.map{ |c| c.name } }
+        end
       end
 
       def search_associations
-        self.class::Search.associations
+        self.class::Search.associations if self.class.const_defined?(:Search)
       end
 
       def belongs_to_associations

data/lib/snaptable/constructor/renderer.rb

@@ -13,6 +13,35 @@ module Snaptable
         end
       end
 
+      def attributes
+        model.attribute_names
+      end
+
+      def column_names
+        attributes.map do |a|
+          (a.is_a?(Hash) ? a.keys[0] : a).to_s
+        end
+      end
+
+      def values(element)
+        attributes.map do |attribute|
+          attr_value = if attribute.is_a?(Symbol) || attribute.is_a?(String)
+            element.send(attribute)
+          else
+            element.send(*attribute.keys).send(*attribute.values)
+          end
+          format_if_date(attr_value)
+        end
+      end
+
+      def format_if_date(attr_value)
+        if attr_value.is_a?(Date) || attr_value.is_a?(Time) || attr_value.is_a?(DateTime)
+          attr_value.strftime("%d.%m.%y %H:%M")
+        else
+          attr_value
+        end.to_s
+      end
+
     end
   end
 end

data/lib/snaptable/helpers/table.rb

@@ -10,31 +10,10 @@ module Snaptable
 				@model = model
 			end
 
-			def values(element)
-				element.attributes.map do |attr_name, attr_value|
-					if attr_value.is_a?(Date) || attr_value.is_a?(Time) || attr_value.is_a?(DateTime)
-						l(attr_value, format: :short)
-					else
-						attr_value
-					end.to_s
-				end
-			end
-
 			def model
 				@model
 			end
 
-			module Search
-
-				def self.associations
-			 		nil
-			 	end
-
-			 	def self.fields
-			 		nil
-			 	end
-
-			end
 		end
 	end
 end

data/lib/snaptable/rails/version.rb

@@ -1,5 +1,5 @@
 module Snaptable
   module Rails
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/snaptable/version.rb

@@ -1,3 +1,3 @@
 module Snaptable
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snaptable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - khcr
@@ -80,8 +80,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/javascripts/autotable.js
-- app/assets/stylesheets/autotable.css.scss
+- app/assets/javascripts/snaptable.js
+- app/assets/stylesheets/snaptable.css.scss
 - app/views/application/_buttons.html.erb
 - app/views/application/_search_field.html.erb
 - app/views/base.html.erb