snaptable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41a46aa96e307baf3ccdf299cdf0775f37d558e1
-  data.tar.gz: bac55a7791146152abeb42727d92c0287434f8e7
+  metadata.gz: 2a329765ca3e389f8a39ad7df923654c54badf3c
+  data.tar.gz: b4d83a2d3295dc3cc22945a372500894144203da
 SHA512:
-  metadata.gz: dcca510c040d61d7dd672c93951ad9cc3198fb208d03c4d705d732ad50758615c87f3dd3dd01180be747851ad0fc227a918052bcfd89a58645af50aa6a7dff7b
-  data.tar.gz: 8456f737cdf4b70d0e7ae6b2f7adb7c7ab5bb7af6a87a309df92ca219b26ac4ac30e973e121f38a049d14b6de3fafcaea4d10c30d1c54f12be961bd948ad05e0
+  metadata.gz: e9342e4c99c083163d97f48253a21063ec3fd5b5ffa488d5992f4d189e04503edbb2bf6c873cefe671734ba11a8f8264d09fde359a3fd5b0493ca8a682c57143
+  data.tar.gz: 157be0ae6d0afd21014f3c83ccb848f3a7f8d065e78ac9af42e33dbcc58a1b2b6d56761a363a8495ec830478839391795e840c196a5373631a1acf46b2565256

data/README.md

@@ -1,6 +1,6 @@
 # Snaptable
 
-A gem that generate HTML tables from your models to display in your admin views. It supports pagination (carrierwave), sorting and searching. It is also possible to customize the tables.
+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
 
@@ -20,7 +20,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic table
+
+In your controller, instanciate a new `Table` with minimum two arguments: the controller itself and the model to use.
+
+```ruby
+@table = Table.new(self, Article)
+```
+
+Then, in order to enable sorting, call the method `respond` on the table.
+
+```ruby
+@table = Table.new(self, Article)
+@table.respond
+```
+
+Finally, in your view, generate the table where you wish.
+
+```html
+<div>
+  <%= @table.present %>
+</div>
+```
+
+### Options
+
+You can customize the table when you instanciate 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]: disable 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 })
+```
 
 ## Contributing
 

data/app/views/base.html.erb

@@ -1,25 +1,29 @@
-<%= render 'search_field' if presenter.options[:search] == true %>
-<%= render 'buttons' unless presenter.options[:buttons] == false %>
-<table>
-	<thead>
-		<tr>
-			<% presenter.column_names.each do |column| %>
-			<th><%= presenter.sortable(column) %></th>
+<div id="admin_table">
+
+	<%= render 'search_field' if presenter.options[:search] == true %>
+	<%= render 'buttons' unless presenter.options[:buttons] == false %>
+	<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="<%= presenter.url(record) %>">
+						<% 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 %>">Il n'y a aucun élément à afficher.</td></tr>
 			<% end %>
-		</tr>
-	</thead>
-	<tbody>
-		<% if presenter.records.any? %>
-			<% presenter.records.each do |record| %>
-				<tr class="<%= cycle('odd', 'even') %>" data-url="<%= presenter.url(record) %>">
-					<% 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 %>">Il n'y a aucun élément à afficher.</td></tr>
-		<% end %>
-	</tbody>
-</table>
-<%= will_paginate presenter.records %>
+		</tbody>
+	</table>
+	<%= will_paginate presenter.records %>
+
+</div>

data/lib/snaptable/rails/version.rb

@@ -1,5 +1,5 @@
 module Snaptable
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/snaptable/version.rb

@@ -1,3 +1,3 @@
 module Snaptable
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/snaptable.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
 
   spec.add_dependency "railties", ">= 4.2.0"
+  spec.add_dependency "will_paginate", ">= 3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - khcr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A gem that generate HTML tables from your models to display in your admin
   views.
 email: