grapple 0.0.1

data/lib/grapple/components/will_paginate_infobar.rb

@@ -0,0 +1,22 @@
+module Grapple
+	module Components
+		class WillPaginateInfobar < HtmlComponent
+
+			setting :message, "Displaying %d - %d of %d items"
+			setting :no_results_message, "0 items"
+
+			def render
+				if records.total_entries > 0
+					start_range = records.offset + 1
+					end_range = [records.offset + records.per_page, records.total_entries].min
+					html = sprintf(message, start_range, end_range, records.total_entries)
+				else
+					html = no_results_message
+				end
+
+				builder.row "<th colspan=\"#{num_columns}\">#{html}</th>", :class => 'infobar'
+			end
+
+		end
+	end
+end

data/lib/grapple/components/will_paginate_pagination.rb

@@ -0,0 +1,30 @@
+module Grapple
+	module Components
+		# Generates paging links using will_paginate.
+		#
+		# @example 
+		#   <%= table_for(columns, Post.paginate(page: 2)) do |t| %>
+		#     <%= t.footer do %>
+		#       <%= t.pagination %>
+		#     <% end %>
+		#   <% end %>
+		#
+		class WillPaginatePagination < HtmlComponent
+
+			setting :no_results_message, :no_search_results
+
+			def render(paginate_parameters = {})
+				if records.instance_of?(Array)
+					html = '&nbsp;'
+				elsif !params[:query].blank? and records.empty?
+					html = h(t(no_results_message))
+				else
+					html = template.will_paginate(records, paginate_parameters) || '&nbsp;'
+				end
+
+				builder.row "<td colspan=\"#{num_columns}\">#{html}</td>"
+			end
+		
+		end
+	end
+end

data/lib/grapple/components.rb

@@ -0,0 +1,23 @@
+module Grapple
+	module Components
+		extend ActiveSupport::Autoload
+
+		autoload :BaseComponent
+		autoload :HtmlComponent
+		autoload :HtmlRow
+		autoload :HtmlHeader
+		autoload :HtmlBody
+		autoload :HtmlFooter
+		autoload :HtmlColgroup
+		autoload :ColumnHeadings
+		autoload :WillPaginate
+		autoload :Toolbar
+		autoload :Actions
+		autoload :SearchForm
+		autoload :SearchQueryField
+		autoload :SearchSubmit
+		autoload :WillPaginatePagination
+		autoload :WillPaginateInfobar
+
+	end
+end

data/lib/grapple/data_grid_builder.rb

@@ -0,0 +1,24 @@
+module Grapple
+	class DataGridBuilder < HtmlTableBuilder
+
+		helper :infobar, Grapple::Components::WillPaginateInfobar		
+
+		# Toolbar		
+		helper :search_submit, Grapple::Components::SearchSubmit
+		helper :search_query_field, Grapple::Components::SearchQueryField		
+		helper :search_form, Grapple::Components::SearchForm
+		helper :actions, Grapple::Components::Actions
+		helper :toolbar, Grapple::Components::Toolbar, components: [:search_form, :actions]
+
+		# Sortable column headings
+		helper :column_headings, Grapple::Components::ColumnHeadings
+		
+		configure :header, components: [:infobar, :toolbar, :column_headings] 
+		
+		# Paging
+		helper :pagination, Grapple::Components::WillPaginatePagination
+		
+		configure :footer, components: [:pagination]
+
+	end
+end

data/lib/grapple/engine.rb

@@ -0,0 +1,11 @@
+require 'grapple/helpers/table_helper'
+
+module Grapple
+	class Engine < Rails::Engine
+    initializer 'grapple.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include Grapple::Helpers::TableHelper
+      end
+    end
+  end
+end

data/lib/grapple/helpers/table_helper.rb

@@ -0,0 +1,31 @@
+module Grapple
+	module Helpers
+		module TableHelper
+
+			@@builder = Grapple::DataGridBuilder
+			mattr_accessor :builder
+
+			def grapple_container(*args, &block)
+				options = args[0] || {}
+				builder_class = options[:builder] || @@builder
+				container_attr = builder_class.container_attributes(self, options)
+				html = ''
+				html << builder_class.before_container(self, options)
+				html << tag('div', container_attr, false) + "\n"
+				html << capture(&block)
+				html << "</div>\n"
+				html << builder_class.after_container(self, options)
+				return html.html_safe
+			end
+		
+			def table_for(columns, records, *args, &block)
+				options = args[0] || {}
+				builder_class = options[:builder] || @@builder
+				builder = builder_class.new(self, columns, records, params, options)
+				output = capture(builder, &block)
+				(builder.before_table + builder.table(output) + builder.after_table).html_safe
+			end
+		
+		end
+	end
+end

data/lib/grapple/helpers.rb

@@ -0,0 +1,8 @@
+module Grapple
+	module Helpers
+		extend ActiveSupport::Autoload
+
+		autoload :TableHelper, 'grapple/helpers/table_helper'
+
+	end
+end

data/lib/grapple/html_table_builder.rb

@@ -0,0 +1,31 @@
+module Grapple
+
+	class HtmlTableBuilder < BaseTableBuilder
+
+		helper :row, Grapple::Components::HtmlRow
+		helper :colgroup, Grapple::Components::HtmlColgroup
+		helper :header, Grapple::Components::HtmlHeader
+		helper :body, Grapple::Components::HtmlBody
+		helper :footer, Grapple::Components::HtmlFooter
+
+		def table(content)
+			"<table>#{content}</table>\n".html_safe
+		end
+		
+		def self.container_attributes(template, options)
+			return {
+				:class => 'grapple' 
+			}
+		end
+		
+		def self.before_container(template, options)
+			''
+		end
+		
+		def self.after_container(template, options)
+			''
+		end
+		
+	end
+
+end

data/lib/grapple.rb

@@ -0,0 +1,14 @@
+require 'active_support'
+
+module Grapple
+	extend ActiveSupport::Autoload
+
+	autoload :Components
+	autoload :BaseTableBuilder
+	autoload :HtmlTableBuilder
+	autoload :DataGridBuilder
+	autoload :AjaxDataGridBuilder
+	autoload :Helpers
+end
+
+require 'grapple/engine' if defined?(::Rails)

data/spec/builders/ajax_data_grid_builder_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Ajax Data Grid Builder' do
+	include GrappleSpecHelper
+
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "container_attributes should be correct" do
+		attr = Grapple::AjaxDataGridBuilder.container_attributes(self, { :id => 'my_table' })
+		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/components/actions_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'actions' do
+	include GrappleSpecHelper
+
+
+	
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		actions = [
+			{ label: "New User", url: "/test" },
+			{ label: "Export Users", url: url_for({controller: 'users', action: 'new'}) }
+		]
+		builder = Grapple::DataGridBuilder.new(self, [], [], {})
+		html = builder.actions(actions.clone)
+
+		#puts html
+
+		expect(html).to have_tag('div.actions') do
+			with_tag("a", count: actions.length)
+			actions.each do |action|
+				with_tag("a", with: {href: action[:url]}) do
+					with_text(action[:label])
+				end
+			end
+		end
+	end
+
+end

data/spec/components/column_headings_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'toolbar' do
+	include GrappleSpecHelper
+
+	columns = [
+		{ label: '' },
+		{ label: 'first name', sort: 'LOWER(firstname)', width: 140 },
+		{ label: 'last name', sort: 'LOWER(lastname)', width: 140 },
+		{ label: 'username', sort: 'LOWER(login)', width: 150 },
+		{ label: 'email', sort: 'LOWER(email)', width: 300 },
+		{ label: 'Created At', sort: 'created_at', width: 175 }
+	]
+	
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		records = User.all.paginate({ page: 1, per_page: 3 })
+		builder = Grapple::DataGridBuilder.new(self, columns, records, {})
+		#puts builder.methods.inspect
+
+		html = builder.column_headings
+		#puts html
+
+		expect(html).to have_tag('tr.column-headers') do
+			with_tag('th', count: columns.length)
+		end
+	end
+
+end

data/spec/components/html_body_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'html body' do
+	include GrappleSpecHelper
+
+	columns = [
+		{ label: '' },
+		{ label: 'first name', sort: 'LOWER(firstname)', width: 140 },
+		{ label: 'last name', sort: 'LOWER(lastname)', width: 140 },
+		{ label: 'username', sort: 'LOWER(login)', width: 150 },
+		{ label: 'email', sort: 'LOWER(email)', width: 300 },
+		{ label: 'Created At', sort: 'created_at', width: 175 }
+	]
+	
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		records = User.all.paginate({ page: 1, per_page: 3 })
+		builder = Grapple::HtmlTableBuilder.new(self, columns, records, {})
+
+		html = builder.body(tr: false) do |item|
+			concat((
+				"<tr>\n\t\t<td>#{item.login}</td>\n\t\t" + 
+				'<td class="text-right">' + item.firstname + '</td>' +
+				"</tr>"
+			).html_safe)
+		end
+
+		#puts html
+
+		expect(html).to have_tag('tbody') do
+			with_tag('tr', count: records.length)
+
+			records.each do |user|
+				with_tag('tr') do
+					with_tag("td") do
+						with_text(user.login)
+					end
+
+					with_tag("td") do
+						with_text(user.firstname)
+					end
+				end
+			end
+
+		end
+		
+	end
+
+end

data/spec/components/html_colgroup_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'html_colgroup' do
+	include GrappleSpecHelper
+
+	columns = [
+		{ label: '' },
+		{ label: 'first name', sort: 'LOWER(firstname)', width: 140 },
+		{ label: 'last name', sort: 'LOWER(lastname)', width: 140 },
+		{ label: 'username', sort: 'LOWER(login)', width: 150 },
+		{ label: 'email', sort: 'LOWER(email)', width: 300 },
+		{ label: 'Created At', sort: 'created_at', width: 175 }
+	]
+	
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		records = User.all.paginate({ page: 1, per_page: 3 })
+		builder = Grapple::HtmlTableBuilder.new(self, columns, records, {})
+		html = builder.colgroup()
+
+		#puts html
+
+		expect(html).to have_tag('colgroup') do
+			with_tag('col', count: columns.length)
+
+			columns.each do |column|
+				with_tag('col', with: {width: column[:width]}) if column[:width].present?
+			end
+
+		end
+		
+	end
+
+end

data/spec/components/html_footer_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'html footer' do
+	include GrappleSpecHelper
+
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		records = User.all.paginate({ page: 1, per_page: 3 })
+		builder = Grapple::DataGridBuilder.new(self, users_columns, records, {})
+
+		html = builder.footer do |item|
+			concat(("<tr><td>TEST</td></tr>").html_safe)
+		end
+
+		#puts html
+
+		expect(html).to have_tag('tfoot') do
+			with_tag('tr', count: 1) do
+				with_tag('td', count: 1) do
+					with_text("TEST")
+				end
+			end
+		end
+		
+		html = builder.footer
+
+		expect(html).to have_tag('tfoot') do
+			with_tag('tr', count: 1) 
+		end
+
+		#puts html
+	end
+
+end

data/spec/components/search_form_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'search form' do
+	include GrappleSpecHelper
+
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		records = User.all.paginate({ page: 1, per_page: 3 })
+		builder = Grapple::DataGridBuilder.new(self, users_columns, records, {})
+		
+		html = builder.search_form()
+
+		puts html
+
+		expect(html).to have_tag('form.search-form', with: {method: "post"}) do
+			with_tag('input', with: {type: "hidden", name: "page"})
+			with_tag('input', with: {type: "hidden", name: "utf8"})
+
+			with_tag('input', with: {name: "query", type: "text", id: 'query', class: 'search-query'})
+			with_tag('input', with: {type: "submit"})
+		end
+
+	end
+
+end

data/spec/components/toolbar_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'toolbar' do
+	include GrappleSpecHelper
+
+	columns = [
+		{ label: '' },
+		{ label: 'first name', sort: 'LOWER(firstname)', width: 140 },
+		{ label: 'last name', sort: 'LOWER(lastname)', width: 140 },
+		{ label: 'username', sort: 'LOWER(login)', width: 150 },
+		{ label: 'email', sort: 'LOWER(email)', width: 300 },
+		{ label: 'Created At', sort: 'created_at', width: 175 }
+	]
+	
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	it "should be valid" do
+		records = User.all.paginate({ page: 1, per_page: 3 })
+		builder = Grapple::DataGridBuilder.new(self, columns, records, {})
+		#puts builder.methods.inspect
+
+		html = builder.toolbar do 
+			concat('<div class="test">test</div>'.html_safe)
+		end
+
+		expect(html).to have_tag('tr', with: { class: 'toolbar' }) do
+			with_tag('th', with: { colspan: columns.length }) do
+				with_tag('div', with: { class: 'test' })
+			end
+		end
+		
+		#puts html
+	end
+
+end

data/spec/components/will_paginate_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'will_paginate' do
+	include GrappleSpecHelper
+
+	columns = [
+		{ label: '' },
+		{ label: 'first name', sort: 'LOWER(firstname)', width: 140 },
+		{ label: 'last name', sort: 'LOWER(lastname)', width: 140 },
+		{ label: 'username', sort: 'LOWER(login)', width: 150 },
+		{ label: 'email', sort: 'LOWER(email)', width: 300 },
+		{ label: 'Created At', sort: 'created_at', width: 175 }
+	]
+	
+	before do
+		@output_buffer = ''
+		mock_everything
+	end
+	
+	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()
+		
+	end
+
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define do
+
+	create_table "users", :force => true do |t|
+		t.string   "login",                      :limit => 100, :default => "",       :null => false
+		t.string   "crypted_password",           :limit => 40,  :default => "",       :null => false
+		t.string   "email",                      :limit => 100, :default => "",       :null => false
+		t.string   "firstname",                  :limit => 50
+		t.string   "lastname",                   :limit => 50
+		t.string   "salt",                       :limit => 40,  :default => "",       :null => false
+		t.datetime "created_at"
+		t.datetime "updated_at"
+		t.datetime "logged_in_at"
+		t.boolean  "deleted",                                   :default => false
+		t.datetime "deleted_at"
+	end
+
+end

data/spec/fixtures/users.yml

@@ -0,0 +1,56 @@
+--- 
+users_001: 
+  id: 1
+  login: jdoe
+  crypted_password: f95659157fe670690ef522c8bc15ea6f583fba77
+  email: jdoe@test12345.com
+  firstname: John
+  lastname: Doe
+  salt: 1565b93dd4226040d687ee21163113a8729532ea
+  created_at: 2009-03-01 14:01:34 Z
+  updated_at: 2010-01-01 02:07:50 Z
+  deleted: false
+users_002: 
+  id: 2
+  login: admin
+  crypted_password: f95659157fe670690ef522c8bc15ea6f583fba77
+  email: admin@test12345.com
+  firstname: Admin
+  lastname: User
+  salt: 1565b93dd4226040d687ee21163113a8729532ea
+  created_at: 2009-03-01 14:01:34 Z
+  updated_at: 2010-01-01 02:07:50 Z
+  deleted: false
+users_003: 
+  id: 2
+  login: admin
+  crypted_password: f95659157fe670690ef522c8bc15ea6f583fba77
+  email: admin@test12345.com
+  firstname: Admin
+  lastname: User
+  salt: 1565b93dd4226040d687ee21163113a8729532ea
+  created_at: 2009-03-01 14:01:34 Z
+  updated_at: 2010-01-01 02:07:50 Z
+  deleted: false
+users_003: 
+  id: 3
+  login: user
+  crypted_password: f95659157fe670690ef522c8bc15ea6f583fba77
+  email: user@test12345.com
+  firstname: User
+  lastname: User
+  salt: 1565b93dd4226040d687ee21163113a8729532ea
+  created_at: 2009-03-01 14:01:34 Z
+  updated_at: 2010-01-01 02:07:50 Z
+  deleted: false
+users_004: 
+  id: 4
+  login: eddie
+  crypted_password: f95659157fe670690ef522c8bc15ea6f583fba77
+  email: eddie@test12345.com
+  firstname: Eddie
+  lastname: Test
+  salt: 1565b93dd4226040d687ee21163113a8729532ea
+  created_at: 2009-03-01 14:01:34 Z
+  updated_at: 2010-01-01 02:07:50 Z
+  deleted: false