grapple 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29fe6d42cf2c20b787701ae4129775f325a3a67a
-  data.tar.gz: 274443c21e688445641107e68db1a937baa4848f
+SHA256:
+  metadata.gz: a00ec50832f4583379666e80a35b898efc63c066b1b19018efeccbfadefeb531
+  data.tar.gz: fb7475bad8276a7f4867622aaf3fe47d09829853d12841795fb9ce4455697399
 SHA512:
-  metadata.gz: 86634330ca55fc613cff43012798c0ab8a5f0e6742c9301e836c20bcc32355c5c43e0a76677c1ffd8cfd6d8936f4ec2eb323ccb17f90e62ece6ddbb7ff9856a8
-  data.tar.gz: 362d5d6e62826ae54ef5dc6759e964a75f2b05e0486b01799e0c7dac0b5b6f84db1d684ec0a34cb025e1388c60508bd7d87aef7c2e4454f81f50e081e7248476
+  metadata.gz: 9255cd578e733a19c272c73e47fc3fae1ac17838aa61f355a0fa150e6bd31d37ba0236a0f825cd441a9e082fb26241ddad3237bf041582ae0312275c9c8a3722
+  data.tar.gz: 985d05b1ac0354f7ae92b5a78acf3a2236b2543bc083041009bc084539c09aa315b0f9becb1a99901944b7ece92c853f65ddb6fc6b759b3a19a04c4e4c6bd952

data/config/locales/en.yml

@@ -1,2 +1,5 @@
 en:
-  no_search_results: "We're sorry. No results were found."
+  displaying_x_y_of_z_results: "Displaying %{x} - %{y} of %{z} results"
+  no_search_results: "We're sorry. No results were found."
+  search: "Search"
+  zero_results: "0 results"

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.rb

@@ -19,6 +19,8 @@ module Grapple
 		autoload :SearchSubmit
 		autoload :WillPaginatePagination
 		autoload :WillPaginateInfobar
+		autoload :KaminariPagination
+		autoload :KaminariInfobar
 
 	end
 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

@@ -34,6 +34,10 @@ module Grapple
 					content = label
 				end
 				
+				if column[:class]
+					column[:class].split(" ").each{|c| cell_classes << c}
+				end
+				
 				cell_classes = ' class="' + cell_classes.join(' ') + '"'
 				title = column[:title] ? " title=\"#{h(column[:title])}\"" : ''
 				liner_classes = liner_classes.length ? " class=\"#{liner_classes.join(" ")}\"" : ''

data/lib/grapple/components/html_component.rb

@@ -16,7 +16,13 @@ module Grapple
 				if options[:sort] == params[:sort]
 					options[:dir] = (params[:dir] == 'desc') ? 'asc' : 'desc'
 				end
-				url_params = params.stringify_keys().merge(options.stringify_keys())
+				# Convert ActionController::Parameters to a Hash
+				p = if params.respond_to?(:to_unsafe_h)				
+					params.to_unsafe_h
+				else
+					params.to_h
+				end
+				url_params = p.stringify_keys().merge(options.stringify_keys())
 				if @builder.namespace
 					tmp = {}
 					url_params.each do |key, value|

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_infobar.rb

@@ -0,0 +1,40 @@
+module Grapple
+	module Components
+		class KaminariInfobar < HtmlComponent
+
+			setting :message, "Displaying %s - %s of %s results"
+			setting :estimate_message, "Displaying %s - %s of about %s results"
+			setting :no_results_message, "0 results"
+
+			def render
+				estimate = false
+				begin
+					# total_count will throw an error if without_count is being used
+					total_count = records.total_count
+				rescue Exception => e
+					estimate = true
+					total_count = ActiveRecord::Base.connection.execute(
+						"SELECT reltuples AS approximate_row_count FROM pg_class WHERE relname = '#{records.table_name}'"
+					).first["approximate_row_count"].to_i
+				end
+				
+				if total_count > 0
+					offset = (records.current_page - 1) * records.current_per_page
+					start_range = offset + 1
+					end_range = [offset + records.current_per_page, total_count].min
+
+					start_range = ActiveSupport::NumberHelper.number_to_delimited(start_range)
+					end_range = ActiveSupport::NumberHelper.number_to_delimited(end_range)
+					total = ActiveSupport::NumberHelper.number_to_delimited(total_count)
+
+					html = sprintf((estimate ? estimate_message : message), start_range, end_range, total)
+				else
+					html = no_results_message
+				end
+
+				builder.row "<th colspan=\"#{num_columns}\">#{html}</th>", :class => 'infobar'
+			end
+
+		end
+	end
+end

data/lib/grapple/components/kaminari_pagination.rb

@@ -0,0 +1,40 @@
+module Grapple
+	module Components
+		# Generates paging links using Kaminari.
+		#
+		# @example 
+		#   <%= table_for(columns, Post.page(2)) do |t| %>
+		#     <%= t.footer do %>
+		#       <%= t.pagination %>
+		#     <% end %>
+		#   <% end %>
+		#
+		class KaminariPagination < HtmlComponent
+
+			setting :no_results_message, :no_search_results
+			setting :renderer, nil
+
+			def render(paginate_parameters = {})
+				td_class = ""
+				if records.instance_of?(Array)
+					html = '&nbsp;'
+				elsif !params[:query].blank? and records.empty?
+					html = h(t(no_results_message))
+					td_class = "class='text-left'"
+				else
+					begin
+						# paginate helper will throw an error if without_count is being used
+						html = template.paginate(records)
+					rescue Exception => e
+						html = template.link_to_prev_page(records, "Previous Page") || ""
+						html += " " if html
+						html += template.link_to_next_page(records, "Next Page") || ""
+					end
+				end
+
+				builder.row "<td colspan=\"#{num_columns}\" #{td_class}>#{html}</td>"
+			end
+		
+		end
+	end
+end

data/lib/grapple/components/search_query_field.rb

@@ -9,7 +9,7 @@ module Grapple
 				template.text_field_tag(
 					search_query_param.to_s, 
 					params[search_query_param.to_sym], 
-					{ :class => search_query_field_class, placeholder: "Search" }
+					{ class: search_query_field_class, placeholder: I18n.translate(:search) }
 				)
 			end
 

data/lib/grapple/components/will_paginate_infobar.rb

@@ -2,9 +2,6 @@ module Grapple
 	module Components
 		class WillPaginateInfobar < HtmlComponent
 
-			setting :message, "Displaying %s - %s of %s results"
-			setting :no_results_message, "0 results"
-
 			def render
 				if records.total_entries > 0
 					start_range = records.offset + 1
@@ -14,12 +11,12 @@ module Grapple
 					end_range = ActiveSupport::NumberHelper.number_to_delimited(end_range)
 					total = ActiveSupport::NumberHelper.number_to_delimited(records.total_entries)
 
-					html = sprintf(message, start_range, end_range, total)
+					html = I18n.translate(:displaying_x_y_of_z_results, x: start_range, y: end_range, z: total)
 				else
-					html = no_results_message
+					html = I18n.translate(:zero_results)
 				end
 
-				builder.row "<th colspan=\"#{num_columns}\">#{html}</th>", :class => 'infobar'
+				builder.row "<th colspan=\"#{num_columns}\">#{html}</th>", class: 'infobar'
 			end
 
 		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

data/spec/builders/ajax_data_grid_builder_spec.rb

@@ -9,11 +9,11 @@ describe 'Ajax Data Grid Builder' do
 	end
 	
 	it "container_attributes should be correct" do
-		attr = Grapple::AjaxDataGridBuilder.container_attributes(self, { :id => 'my_table' })
+		builder = Grapple::AjaxDataGridBuilder.new(self, [], [], {}, id: 'my_table')
+		attr = builder.container_attributes()
 		expect(attr[:id]).to eq "my_table"
 		expect(attr[:class]).to include("grapple")
 		expect(attr[:data]['grapple-ajax-url']).to eq '/mock/path'
-		puts attr
 	end
 
 end

data/spec/builders/html_table_builder_spec.rb

@@ -9,16 +9,15 @@ describe 'Base Table Builder' do
 	end
 
 	it "container_attributes should be correct" do
-		attr = Grapple::HtmlTableBuilder.container_attributes(self, { :id => 'my_table' })
+		builder = Grapple::HtmlTableBuilder.new(self, users_columns, users_records, {}, id: 'my_table')
+		attr = builder.container_attributes()
 		expect(attr[:class]).to include("grapple")
 	end
 
 	it "table should be correct" do
 		builder = Grapple::HtmlTableBuilder.new(self, users_columns, users_records, {})
 
-		html = builder.table("<tr><td>TEST</td></tr>")
-
-		#puts html
+		html = builder.table("<tr><td>TEST</td></tr>".html_safe)
 
 		expect(html).to have_tag('table') do
 			with_tag("tr", count: 1) do 
@@ -29,4 +28,4 @@ describe 'Base Table Builder' do
 		end
 	end
 	
-end
+end

data/spec/components/will_paginate_spec.rb

@@ -20,14 +20,9 @@ describe 'will_paginate' do
 	it "should be valid" do
 		records = User.all.paginate({ page: 1, per_page: 3 })
 		builder = Grapple::DataGridBuilder.new(self, columns, records, {})
-		puts builder.infobar()
-		puts builder.pagination()
 
 		records = User.where('id < 0').paginate({ page: 1, per_page: 3 })
-		builder = Grapple::DataGridBuilder.new(self, columns, records, {:query => 'test'})
-		puts builder.infobar()
-		puts builder.pagination()
-		
+		builder = Grapple::DataGridBuilder.new(self, columns, records, {:query => 'test'})	
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grapple
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Edward Potocko
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -88,28 +88,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.2.11.1
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,8 @@ files:
 - lib/grapple/components/html_footer.rb
 - lib/grapple/components/html_header.rb
 - lib/grapple/components/html_row.rb
+- lib/grapple/components/kaminari_infobar.rb
+- lib/grapple/components/kaminari_pagination.rb
 - lib/grapple/components/search_form.rb
 - lib/grapple/components/search_query_field.rb
 - lib/grapple/components/search_submit.rb
@@ -205,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Customizable data grid for Rails