simple_grid 0.0.2 → 0.0.3

data/README.md

@@ -5,28 +5,27 @@ SimpleGrid is the most easy way to transform your CRUD in a powerful jQuery Data
 ## Requisites
 
 * Rails 3.1 (asset pipeline) - You can run it in minor versions but you need to add the assets manually (not tested yet).
-* ActiveRecord
 
 ## Installation
 
 Install the gem:
 
-		$ gem install simple_grid
+	$ gem install simple_grid
 
 Add this line to your Rails application Gemfile:
 
-    gem 'simple_grid'
+	gem 'simple_grid'
 
 Execute:
 
-    $ bundle install
-		$ rails generate simple_grid:install
+	$ bundle install
+	$ rails generate simple_grid:install
 
 Include the SimpleGrid helper in your ApplicationHelper:
 
-		module ApplicationHelper
-		  include SimpleGrid::Helpers
-		end
+	module ApplicationHelper
+	  include SimpleGrid::Helpers
+	end
 		
 Load the assets in your application.
 
@@ -34,44 +33,48 @@ Load the assets in your application.
 
 Is very easy to use the SimpleGrid gem, suppose that we have the tables Books and Authors. Each book has an author and an author has many books.
 
-To use the gem in our book index view we need to call the method simple_grid. Like bellow:
+To use the gem in our book index view we need to call the method simple_grid. Like below:
 		
-		<%= simple_grid(@books) %>
-		# The first parameter is our records based on ActiveRecord.
-		# In this example it will display a grid with all table columns and the actions show, edit and destroy.
+	<%= simple_grid(@books) %>
+	# The first parameter is our records based on ActiveRecord.
+	# In this example it will display a grid with all table columns and the actions show, edit and destroy.
 
 The second parameter can be an options hash, see the examples below:
 
-		<%= simple_grid(@books, :exclude_columns => ["id","description","created_at","updated_at"]) %>
-		# In this example it will not display the columns present in :exclude_columns array
-		
-		<%= simple_grid(@books, :exclude_columns => ["id","description"],
-														:extra_columns => {
-																								:author_name => { :label => "Author", :relationship => "author.name" }
-																							}) %>
-		# In this example it will not display the columns "id" and "description" but it will display an extra column with the author name based in our relationship.
-		# The :label key is the column title and the :relationship key is our models relationship.
-
-		<%= simple_grid(@books, :exclude_columns => ["id","description"],
-														:extra_columns => {
-																								:author_name => { :label => "Author", :relationship => "author.name" },
-																								:other_column => { :label => "New Column", :content => "<strong>Content</strong>" }
-																							}) %>
-		# In this example it will add a new column with label "New column" and the content as html.
-		
-		<%= simple_grid(@books, :exclude_columns => ["id","description"],
-														:extra_columns => {
-																									:author_name => { :label => "Author", :relationship => "author.name" }
-																							 },
-														:actions => {
-																						:show => { :label => "View", :html => { :id => "show_info" } },
-																						:edit => { :route => "my_route" },
-																						:destroy => { :display => false }
-																				}) %>
-		# In this example it will display the actions based in the hash options.
-		# The action show will be displayed with label "View" and the id "show_info" in the html element.
-		# The action edit will use the route "my_route" (it will interprete as "my_route(record)").
-		# The action destroy will not be displayed.
+In this example it will not display the columns present in :exclude_columns array
+
+	<%= simple_grid(@books, :exclude_columns => ["id","description","created_at","updated_at"]) %>
+
+In this example it will not display the columns "id" and "description" but it will display an extra column with the author name based in our relationship.
+
+	<%= simple_grid(@books, :exclude_columns => ["id","description"],
+		:extra_columns => {
+			:author_name => { :label => "Author", :relationship => "author.name" }
+		}) %>
+	# The :label key is the column title and the :relationship key is our models relationship.
+
+In this example it will add a new column with label "New column" and the content as html.
+
+	<%= simple_grid(@books, :exclude_columns => ["id","description"],
+		:extra_columns => {
+			:author_name => { :label => "Author", :relationship => "author.name" },
+			:other_column => { :label => "New Column", :content => "<strong>Content</strong>" }
+		}) %>
+
+In this example it will display the actions based in the hash options.
+
+	<%= simple_grid(@books, :exclude_columns => ["id","description"],
+		:extra_columns => {
+			:author_name => { :label => "Author", :relationship => "author.name" }
+		},
+		:actions => {
+			:show => { :label => "View", :html => { :id => "show_info" } },
+			:edit => { :route => "my_route" },
+			:destroy => { :display => false }
+		}) %>
+	# The action show will be displayed with label "View" and the id "show_info" in the html element.
+	# The action edit will use the route "my_route" (it will interprete as "my_route(record)").
+	# The action destroy will not be displayed.
 
 ## TODO
 

data/lib/simple_grid/version.rb

@@ -1,3 +1,3 @@
 module SimpleGrid
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_grid
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: