snaptable 2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd1d36813feff2abd769b78bcc5aebe4340ba890
-  data.tar.gz: 2d918c32f5a8366a04b6a6c33e8041299384c3fa
+  metadata.gz: a47cdc0973b24df9558a52bca76c5db61ebc66c4
+  data.tar.gz: 41ef5c4837577bcfdbefc45427a62a92db8fe0b6
 SHA512:
-  metadata.gz: 26c5addcad41645f4c13599f28827a7a437dc27e7e95b5b6b9a7a395fb8de73721aac1326e09978f02b2186f89dec2b99ef169dd565b5861f8919dd09dea991c
-  data.tar.gz: 75d2ecaff90b2c9095c2b2e2c49ea1724cc621b70b90931dc3c1db4a881ef64a9a37a4f2530d58330c273e335c2aabec630ca5612f2842fc2754062009895582
+  metadata.gz: fd322359ab58269b6a42b6be0a63c05371e27a1a48467590d249fbf37ea764f20f87e21c1c55594040c6991b9d04eabff1d3038dbbaf62777d794d2663c3996a
+  data.tar.gz: 4398927f2d24d004dc72d897e716561eaf56787a452d8dbffb426e6b5be51b9bc543a8ab72a6d2265cd9c15b8da92113da893137bb3a82dc5f6c68480ff1b39c

data/README.md

@@ -0,0 +1,230 @@
+# Snaptable
+
+A gem that generate HTML tables from your models in order to display them in your admin views. It supports pagination, sorting and searching. It is also possible to customize the tables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snaptable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snaptable
+
+Include the assets:
+
+```css
+# application.css
+/*
+ *= require_self
+ *= require_tree .
+ *= require snaptable
+ */
+
+```
+
+```js
+# application.js
+//= require_tree .
+//= require snaptable
+```
+
+## Usage
+
+### Basic table
+
+In your controller, instantiate a new `Table` with minimum two arguments: the controller itself and the model to use.
+
+```ruby
+def index
+  @table = Table.new(self, Article)
+end
+```
+
+Then, in order to enable sorting, call the method `respond` on the table.
+
+```ruby
+def index
+  @table = Table.new(self, Article)
+  @table.respond
+end
+```
+
+Finally, in your view, generate the table where you wish.
+
+```html
+<div>
+  <%= @table.present %>
+</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. Furthermore, the columns are sortable. Click on a label to sort the data by a column.
+
+### Options
+
+You can customize the table when you instantiate it. Pass you own collection in the third argument.
+
+```ruby
+@articles = Article.last(3)
+Table.new(self, Article, @articles)
+```
+
+Pass the options in the fourth argument. Here is a list:
+
+* buttons [true]: enable the buttons above the table to add, edit or destroy an element.
+* search [false]: enable searching. Add a search field above the table.
+
+```ruby
+Table.new(self, Article, nil, { search: true, buttons: false })
+```
+
+You can also configure the table in the view. The `present` method takes a single named argument to let you add a custom buttons bar. Pass the name of a partial to the parameter `buttons` and the content will be added above the table.
+
+```erb
+<div>
+  <%= @table.present(buttons: "my_custom_partial") %>
+</div>
+```
+To help you build your custom buttons header, you are provided two helper methods for each of the possible actions (add, show, edit, delete):
+
+* `#{action}_button` returns the HTML code to display the button for the desired action, e.g `add_button`.
+* `#{action}_button?` returns if the user is allowed to see the desired button, e.g. `delete_button?`.
+
+```erb
+<div id="custom-buttons">
+  <p>This is my custom table header !</p>
+  <%= add_button if add_button? %>
+<div>
+```
+
+Notice that you can customize the buttons header application-wide. With the following options, you decide which buttons are displayed by default.
+
+```ruby
+Snaptable.add_button = true
+Snaptable.edit_button = true
+Snaptable.delete_button = true
+Snaptable.show_button = false
+```
+
+### Custom class
+
+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 possibilities to change the behavior.
+If you want to change the table's columns, write a method `attributes` that returns 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 an 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
+```
+
+### Multiple tables
+
+Snaptable supports multiple tables on the same page. However, if you want sorting for your tables to work, then type the following in the controller:
+
+```ruby
+def index
+  @user_table = UserTable.new(self)
+  @group_table = GroupTable.new(self)
+  Snaptable.respond_with(self, @user_table, @group_table)
+end
+```
+
+### Enums
+
+The gem supports enum's type in your model. If it detects a column that is an enum, it will automatically looks for the localized path `#{model.model_name.singular}.#{enum.pluralize}.#{enum_value}`. For example: `member.statuses.active`.
+
+### i18n
+
+To display date & time columns, the gem uses a format named `snaptable`. You can easily override it in your localization file:
+
+```yml
+# en.yml
+
+time:
+  format:
+    snaptable: "%m.d.%y %H:%M"
+
+```
+
+See the [localization files](config/locales) to see all the keys you can override.
+
+### Gotchas
+
+If you're using Postgresql, array types and want to enable searching, then you must create a custom table and specify the fields to search (see above). You must exclude the array columns from the search or it will raise an error.
+
+### Permission
+
+if you want to use the `adeia` gem which provides a permission system:
+
+```ruby
+# initializers/snaptable.rb
+Snaptable.use_permission = true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/khcr/snaptable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -4,12 +4,4 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks

data/app/assets/stylesheets/snaptable/table.css.scss

@@ -7,67 +7,71 @@
   }
   width: 100%;
   font-family: "helvetica neue", "helvetica", "sans-serif";
-  overflow: auto;
   a {
     text-decoration: none;
   }
-  // show scrollbar
-  &::-webkit-scrollbar {
-      -webkit-appearance: none;
-      width: 7px;
-  }
-  &::-webkit-scrollbar-thumb {
-      border-radius: 4px;
-      background-color: rgba(0,0,0,.5);
-      -webkit-box-shadow: 0 0 1px rgba(255,255,255,.5);
-  }
 
-  table {
-    border-collapse: collapse;
-    width: 100%;
-    max-width: 100%;
-    line-height: 25px;
-    margin: 20px 0 20px 0;
-    thead {
-      tr {
-        th {
-          vertical-align: bottom;
-          border-bottom: 1px solid #DADADA;
-          padding: 10px 8px 5px 8px;
-          font-size: 13px;
-          text-align: left;
-          background: #3d3d3e;
-          color: #c0c0c0;
-          font-weight: 400;
-          &:not(:first-child) {
-          }
-          &:not(:last-child) {
-          }
-          a {
-            color:#c0c0c0;
-            font-weight: bold;
+  .table_container {
+    overflow: auto;
+
+    // show scrollbar
+    &::-webkit-scrollbar {
+        -webkit-appearance: none;
+        width: 7px;
+    }
+    &::-webkit-scrollbar-thumb {
+        border-radius: 4px;
+        background-color: rgba(0,0,0,.5);
+        -webkit-box-shadow: 0 0 1px rgba(255,255,255,.5);
+    }
+
+    table {
+      border-collapse: collapse;
+      width: 100%;
+      max-width: 100%;
+      line-height: 25px;
+      margin: 20px 0 20px 0;
+      thead {
+        tr {
+          th {
+            vertical-align: bottom;
+            border-bottom: 1px solid #DADADA;
+            padding: 10px 8px 5px 8px;
+            font-size: 13px;
+            text-align: left;
+            background: #3d3d3e;
+            color: #c0c0c0;
+            font-weight: 400;
+            &:not(:first-child) {
+            }
+            &:not(:last-child) {
+            }
+            a {
+              color:#c0c0c0;
+              font-weight: bold;
+            }
           }
         }
       }
-    }
-    tbody {
-      td {
-        font-size: 12px;
-        color: #333;
-        padding: 7px 8px;
-        &:not(:first-child) {
-          border-left: 1px solid #DADADA;
+      tbody {
+        td {
+          font-size: 12px;
+          color: #333;
+          padding: 7px 8px;
+          &:not(:first-child) {
+            border-left: 1px solid #DADADA;
+          }
         }
       }
-    }
-    tr.odd {
-      background: #fff;
-    }
-    tr.even {
-      background: #f8f8f8;
-    }
-    tr.selected {
-      background: #F0BEBE;
+      tr.odd {
+        background: #fff;
+      }
+      tr.even {
+        background: #f8f8f8;
+      }
+      tr.selected {
+        background: #F0BEBE;
+      }
     }
   }
 

data/app/views/snaptable/base.html.erb

@@ -5,28 +5,30 @@
 		<%= render presenter.instance_variable_get(:@buttons) unless presenter.options[:buttons] == false %>
 	</div>
 
-	<table>
-		<thead>
-			<tr>
-				<% presenter.column_names.each do |column| %>
-				<th><%= presenter.sortable(column) %></th>
+	<div class="table_container">
+		<table>
+			<thead>
+				<tr>
+					<% presenter.column_names.each do |column| %>
+					<th><%= presenter.sortable(column) %></th>
+					<% end %>
+				</tr>
+			</thead>
+			<tbody>
+				<% if presenter.records.any? %>
+					<% presenter.records.each do |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 %>
+						</tr>
+					<% end %>
+				<% else %>
+					<tr><td class="none" colspan="<%= presenter.column_names.count %>"><%= t("table.nothing") %></td></tr>
 				<% end %>
-			</tr>
-		</thead>
-		<tbody>
-			<% if presenter.records.any? %>
-				<% presenter.records.each do |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 %>
-					</tr>
-				<% end %>
-			<% else %>
-				<tr><td class="none" colspan="<%= presenter.column_names.count %>"><%= t("table.nothing") %></td></tr>
-			<% end %>
-		</tbody>
-	</table>
+			</tbody>
+		</table>
+	</div>
 	<%= will_paginate presenter.records, param_name: presenter.paginate_key, params: { table: presenter.table_name } %>
 
 </div>

data/lib/snaptable/version.rb

@@ -1,3 +1,3 @@
 module Snaptable
-  VERSION = "2.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptable
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: 2.0.1
 platform: ruby
 authors:
 - khcr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-26 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/snaptable.js
 - app/assets/javascripts/snaptable/table.js
@@ -109,42 +110,6 @@ files:
 - lib/snaptable/helpers/buttons_helper.rb
 - lib/snaptable/helpers/table_helper.rb
 - lib/snaptable/version.rb
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/integration/navigation_test.rb
-- test/snaptable_test.rb
-- test/test_helper.rb
 homepage: http://github.com/khcr/snaptable
 licenses:
 - MIT
@@ -170,40 +135,4 @@ signing_key:
 specification_version: 4
 summary: A gem that generate HTML tables from your models in order to display them
   in your admin views.
-test_files:
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config.ru
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/integration/navigation_test.rb
-- test/snaptable_test.rb
-- test/test_helper.rb
+test_files: []

data/test/dummy/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/test/dummy/app/controllers/application_controller.rb

@@ -1,5 +0,0 @@
-class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
-end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy/bin/bundle

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
-Rake.application.run

data/test/dummy/bin/setup

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-require 'pathname'
-
-# path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
-
-Dir.chdir APP_ROOT do
-  # This script is a starting point to setup your application.
-  # Add necessary setup steps to this file:
-
-  puts "== Installing dependencies =="
-  system "gem install bundler --conservative"
-  system "bundle check || bundle install"
-
-  # puts "\n== Copying sample files =="
-  # unless File.exist?("config/database.yml")
-  #   system "cp config/database.yml.sample config/database.yml"
-  # end
-
-  puts "\n== Preparing database =="
-  system "bin/rake db:setup"
-
-  puts "\n== Removing old logs and tempfiles =="
-  system "rm -f log/*"
-  system "rm -rf tmp/cache"
-
-  puts "\n== Restarting application server =="
-  system "touch tmp/restart.txt"
-end