grapple 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b8b223182179f78a4769730995aca3da8d06c40
-  data.tar.gz: 5f7a579be08f3bde19acd2c3aa467f5ea2d2ffb6
+  metadata.gz: 68bba465bb61d6a8343e0029923b398fe5ef5569
+  data.tar.gz: ff37c6cc6d79e153795c6d74cd2a418101f856d5
 SHA512:
-  metadata.gz: 243715b28b9f5ec15b10fb07fd58b63dcef9aa163b64db954559feb2d5472fdc556af4f53ded4d180f9b53a27f525714c3ad67395bc155953e3247a0d965f9ac
-  data.tar.gz: e00d0910ef11f3287249a25437429557c546a579f04ea367746ffd384928625aa5c0982794cfdd4c22d38ea164a06c7d8dc0d57db6d106cec136f5188003d22e
+  metadata.gz: b41a77f3d07dadd2502b0561a5889d4347c415f9c372d159d7114d12f6e1aa9fedbab7a65592658a8b59aee33f82303997a861adcdb2f6bd168c65cf4161f257
+  data.tar.gz: 3b1a4b251d8300697f1084d7fdf538ca3b1f27f83f959b862ea158e074e08185e8a710d8b827b8c650df3e3f72ef63b5189e3491a230cee82f8af3ee09afe438

data/lib/grapple/base_table_builder.rb

@@ -2,6 +2,12 @@ module Grapple
 	class BaseTableBuilder
 
 		# Create a helper
+		# @param name [Symbol]
+		#   The name of the helper
+		# @param klass [Grapple::Components::BaseComponent]
+		#   The component class
+		# @param settings [Hash]
+		#   Settings for the component
 		def self.helper(name, klass, settings = {})
 			class_eval <<-RUBY_EVAL
 				def #{name}(*arguments, &block)
@@ -13,6 +19,10 @@ module Grapple
 		end
 
 		# Update settings for a helper
+		# @param helper_name [Symbol]
+		#   The name of the helper
+		# @param options [Hash]
+		#   Settings to update for the component
 		def self.configure(helper_name, *options)
 			settings = options[0] || {}
 			method = :"settings_for_#{helper_name}"
@@ -24,7 +34,22 @@ module Grapple
 			define_singleton_method(method) { settings }
 		end
 
-		attr_reader :columns, :records, :template, :params, :namespace
+		# An Array of columns
+		# @return [Array<Hash>]
+		attr_reader :columns
+		
+		# An Array, ActiveRecord::Collection or Enumerable of records to be displayed in the table
+		# @return [Enumerable]
+		attr_reader :records
+
+		# @return [ActionView::Base]
+		attr_reader :template
+		
+		# Request parameters
+		attr_reader :params
+		
+		# @return [String] namespace for the grapple table
+		attr_reader :namespace
 
 		def initialize(template, columns, records, params = {}, *options)
 			@template = template
@@ -37,14 +62,18 @@ module Grapple
 			@helper_instances = {}
 		end
 		
+		# Default options for the component
+		# @return [Hash]
 		def default_options
 			{ }
 		end
 
+		# HTML to insert before the <table> tag
 		def before_table
 			''
 		end
 
+		# HTML to insert after the </table> tag
 		def after_table
 			''
 		end

data/lib/grapple/components/actions.rb

@@ -1,5 +1,22 @@
 module Grapple
 	module Components
+
+		# Render links that apply to the table
+		# @example
+		#  <%
+		#    actions = [
+		#      { label: :new_user, url: new_user_path },
+		#      { label: :export_users, url: export_users_path }
+		#    ]
+		#  %>
+		#  <%= table_for(columns, @users) do |t| %>
+		#    <%= t.header do %>
+		#      <%= t.toolbar do %>
+		#        <%= t.actions actions %>
+		#      <% end %>
+		#		   <%= t.column_headings %>
+		#	   <% end %>
+		#  <% end %>
 		class Actions < HtmlComponent
 
 			setting :link_to_helper, :link_to

data/lib/grapple/components/base_component.rb

@@ -1,5 +1,7 @@
 module Grapple
 	module Components
+
+		# Base class for components
 		class BaseComponent
 			
 			cattr_accessor :default_settings
@@ -11,8 +13,12 @@ module Grapple
 				@@default_settings[self.name][name] = default
 			end
 			
-			attr_reader :columns, :records, :template, :params, :builder
-			
+			attr_reader :columns
+			attr_reader :records
+			attr_reader :template
+			attr_reader :params
+			attr_reader :builder
+
 			def initialize(columns, records, template, params, builder, settings = {})
 				@template = template
 				@columns = columns
@@ -23,7 +29,7 @@ module Grapple
 					self.send(:"#{name}=", value)
 				end
 			end
-			
+
 			def render(*options, &block)
 				raise StandardError.new("Component must override render method")
 			end
@@ -71,6 +77,7 @@ module Grapple
 				template.with_output_buffer(&block).html_safe
 			end
 
+			# Renders a block if present, otherwise renders the components with options
 			def block_or_components(components, options, &block)
 				block.nil? ? render_components(components, options, &block).join : capture_block(&block)
 			end

data/lib/grapple/components/column_headings.rb

@@ -33,9 +33,9 @@ module Grapple
 				else
 					content = label
 				end
-
+				
 				if column[:class]
-					column[:class].split(" ").each{|c| cell_classes << c }
+					column[:class].split(" ").each{|c| cell_classes << c}
 				end
 				
 				cell_classes = ' class="' + cell_classes.join(' ') + '"'

data/lib/grapple/components/html_header.rb

@@ -1,6 +1,7 @@
 module Grapple
 	module Components
 
+		# thead element for tables
 		class HtmlHeader < HtmlComponent
 			
 			setting :components, []

data/lib/grapple/components/kaminari_pagination.rb

@@ -1,9 +1,9 @@
 module Grapple
 	module Components
-		# Generates paging links using will_paginate.
+		# Generates paging links using Kaminari.
 		#
 		# @example 
-		#   <%= table_for(columns, Post.paginate(page: 2)) do |t| %>
+		#   <%= table_for(columns, Post.page(2)) do |t| %>
 		#     <%= t.footer do %>
 		#       <%= t.pagination %>
 		#     <% end %>

data/lib/grapple/components/will_paginate_pagination.rb

@@ -16,9 +16,10 @@ module Grapple
 
 			def render(paginate_parameters = {})
 				td_class = ""
+
 				if records.instance_of?(Array)
 					html = ' '
-				elsif !params[:query].blank? and records.empty?
+				elsif params.has_key?(:query) && records.empty?
 					html = h(t(no_results_message))
 					td_class = "class='text-left'"
 				else

data/lib/grapple/helpers/table_helper.rb

@@ -5,6 +5,16 @@ module Grapple
 			@@builder = Grapple::DataGridBuilder
 			mattr_accessor :builder
 		
+			# Render a grapple table
+			# @param columns [Enumerable]
+			# @param records [Enumerable]
+			# @option args :container [Boolean]
+			#   If true the table will be rendered with a container div around it
+			# @option args :html [Hash]
+			#   HTML attributes for the `<table>` element
+			# @option args :builder [Grapple::BaseTableBuilder]
+			#   The table builder to use to render the table
+			# @option args :params 
 			def table_for(columns, records, *args, &block)
 				options = args[0] || {}
 				# Don't render the container for AJAX requests by default

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grapple
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Edward Potocko
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Customizable data grid for Rails