grapple 0.0.1

data/app/assets/stylesheets/grapple.css

@@ -0,0 +1,252 @@
+/*************************
+ **   Core              **
+ *************************/
+
+.grapple {
+	position: relative;
+}
+
+.grapple table {
+	border-collapse: collapse;
+}
+
+.grapple thead .column-headers th {
+	white-space: nowrap; /* Don't wrap text in column headers */
+}
+
+.grapple thead .sortable {
+	cursor: pointer;
+}
+
+
+/*************************
+ **   Skin              **
+ *************************/
+
+.grapple table {
+	/* 1px border at the top of the table */
+	border: 1px solid #cbcbcb; 
+	border-width: 1px 0 0 0;
+}
+
+/* Cells */
+.grapple td, .grapple th {
+	padding: 4px 10px;
+	border: 1px solid #cbcbcb;
+	border-width: 0 1px;
+}
+
+/* Loading */
+.grapple-loading table {
+	opacity: 0.5;
+	-ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=50)";
+	filter: alpha(opacity=50);
+}
+
+.grapple .loading-overlay {
+	display: none;
+	position: absolute;
+	height: 19px;
+	width: 100%;
+	top: 150px;
+	left: 0;
+	background: url("grapple/loading-bar.gif") no-repeat scroll center center transparent;
+}
+
+.grapple.grapple-loading .loading-overlay {
+	display: block;
+}
+
+/* Grapple AJAX */
+.grapple-ajax-loading .search-form, 
+.grapple-ajax-loading .pagination, 
+.grapple-ajax-loading .column-headers {
+	/* Hide interactive elements until javascript finishes initializing */
+	visibility: hidden;
+}
+
+
+/**************** Header ****************/
+
+/* Column Headers */
+.grapple thead .column-headers th {
+	font-size: 108%;
+	border-bottom: 1px solid #cbcbcb;
+	border-top: 1px solid #cbcbcb;
+	background-color: #eee;
+}
+
+/* Sortable Column Headings */
+.grapple thead .sortable:hover {
+	background-color: #e0e0e0;
+}
+
+.grapple thead .sortable a:hover {
+	text-decoration: none;
+}
+
+.grapple thead .column-headers th.sorted {
+	background-color: #e0e0e0;
+}
+
+.grapple thead .sortable .sort-asc {
+	/* TODO: put in sprite */
+	background: url("grapple/arrow-up.png") no-repeat scroll right center transparent;
+}
+
+.grapple thead .sortable .sort-desc {
+	/* TODO: put in sprite */
+	background: url("grapple/arrow-down.png") no-repeat scroll right center transparent;
+}
+
+/* Infobar */
+.grapple thead .infobar th{
+	border-bottom: 1px solid #aaa;
+}
+
+/* Toolbar */
+.grapple .toolbar th {
+	background: #cbcbcb;
+	border-bottom: 1px solid #aaa;
+	/*border-width: 0;*/
+}
+
+/* Search Form */
+.grapple .search-form {
+	float: left;
+	padding: 3px 0;
+}
+
+.grapple .search-form .search-icon {
+	margin-left: 5px;
+}
+
+.grapple .search-form * {
+	vertical-align: middle;
+}
+
+.grapple .search-form table,
+.grapple .search-form table td {
+	border: 0;
+	padding: 0;
+}
+
+.grapple .search-form table td {
+	padding-right: 5px;
+}
+
+/* Actions */
+.grapple .toolbar .actions {
+	height: 22px;
+	float: right;
+}
+
+
+/**************** Footer ****************/
+
+/* Footer */
+.grapple tfoot td {
+	background-color: #fff;
+	border-top: 1px solid #cbcbcb;
+	border-width: 1px 0 0 0;
+}
+
+/* Pagination */
+.grapple tfoot .pagination {
+	display: block;
+	width: 100%;
+	text-align: center;
+	margin: 6px 0;
+}
+
+.grapple .pagination .disabled.previous_page,
+.grapple .pagination .disabled.next_page {
+	display: none;
+}
+
+.grapple .pagination .current {
+	font-weight: bold;
+	background-color: transparent;
+	border: medium none;
+	padding: 3px 6px;
+}
+
+.grapple .pagination a {
+	background-color: #FFFFFF;
+	border: 1px solid #CBCBCB;
+	padding: 2px 6px;
+	color: #0066CC;
+	outline: 0 none;
+	text-decoration: underline;
+	margin-left: 1px;
+	margin-right: 1px;
+}
+
+.grapple .pagination .next_page, 
+.grapple .pagination .previous_page {
+	background-color: transparent;
+	border: 0;
+}
+
+
+/**************** Body ****************/
+
+/* Alternating row colors */
+.grapple tbody .even {
+	background-color: #fff;
+}
+
+.grapple tbody .odd {
+	background-color: #edf5ff;
+}
+
+/* Row Actions (for Edit/Delete/Show/etc) */
+.grapple td.actions {
+	white-space: nowrap;
+}
+
+/* Expanding/collapsing content */
+.grapple .expand-icon {
+	background: url('grapple/plus.png') no-repeat;
+}
+
+.grapple .collapse-icon {
+	background: url('grapple/minus.png') no-repeat;
+}
+
+.grapple .spacer, .grapple .expand-icon, .grapple .collapse-icon {
+	padding-left: 10px;
+	float: left;
+	width: 16px;
+	height: 16px;
+	display: block;
+}
+
+/* Nested tables */
+.grapple table.inner-table {
+	border: none;
+}
+
+.grapple table.inner-table {
+	border: none;
+}
+
+.grapple table.inner-table td {
+	border: none;
+	padding: 1px;
+	margin: 0px;
+}
+
+
+/* TODO: Remove this stuff */
+.grapple tbody .red {
+	background-color: #ffdddd;
+}
+.grapple h2 {
+	font-size: 116%;
+	padding: 2px 0;
+}
+
+.grapple .not-ready {
+	visibility: hidden;
+}

data/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  no_search_results: "We're sorry. No results were found."

data/lib/grapple/ajax_data_grid_builder.rb

@@ -0,0 +1,38 @@
+module Grapple
+	class AjaxDataGridBuilder < DataGridBuilder
+	
+		CONTAINER_CLASSES = 'grapple grapple-ajax grapple-ajax-loading'
+	
+		@@next_id = 1000
+
+		def self.container_attributes(template, options)
+			@@next_id += 1
+			options[:id] ||= "grapple_ajax_table_#{@@next_id}"
+			css = CONTAINER_CLASSES
+			css += " #{options[:container_class]}" unless options[:container_class].nil?
+			
+			data = {
+				"grapple-ajax-url" => options[:url] || template.url_for(action: 'table'),
+				"grapple-ajax-history" => options[:history] === false ? '0' : '1'
+			}
+
+			return {
+				:id => options[:id],
+				:class => css, 
+				:data => data
+			}
+		end
+
+		def after_table
+			style = 'background-image: url(' + template.image_path("grapple/loading-bar.gif") + ')'
+			template.content_tag :div, '', :class => 'loading-overlay', :style => style
+		end
+		
+		def self.after_container(template, options)
+			selector = '#' + options[:id]
+			js = "$(#{selector.to_json}).grapple();"
+			return template.javascript_tag(js)
+		end
+
+	end
+end

data/lib/grapple/base_table_builder.rb

@@ -0,0 +1,58 @@
+module Grapple
+	class BaseTableBuilder
+
+		# Create a helper
+		def self.helper(name, klass, settings = {})
+			class_eval <<-RUBY_EVAL
+				def #{name}(*arguments, &block)
+					invoke_helper(:"#{name}", *arguments, &block)
+				end
+			RUBY_EVAL
+			define_singleton_method(:"class_for_#{name}") { klass }
+			define_singleton_method(:"settings_for_#{name}") { settings }
+		end
+		
+		# Update settings for a helper
+		def self.configure(helper_name, *options)
+			settings = options[0] || {}
+			method = :"settings_for_#{helper_name}"
+			if self.respond_to?(method)
+				self.send(method).each do |key, value|
+					settings[key] = value unless settings.has_key?(key)
+				end
+			end
+			define_singleton_method(method) { settings }
+		end
+
+		attr_reader :columns, :records, :template, :params
+
+		def initialize(template, columns, records, params = {}, *options)
+			@template = template
+			@columns = columns
+			@records = records
+			@params = params
+			@options = options[0] || {}
+			@helper_instances = {}
+		end
+		
+		def before_table
+			''
+		end
+		
+		def after_table
+			''
+		end
+
+	protected
+	
+		def invoke_helper(name, *arguments, &block)
+			unless @helper_instances.has_key?(name)
+				klass = self.class.send(:"class_for_#{name}")
+				settings = self.class.send(:"settings_for_#{name}")
+				@helper_instances[name] = klass.new(@columns, @records, @template, @params, self, settings)
+			end
+			@helper_instances[name].send(:render, *arguments, &block)
+		end
+		
+	end
+end

data/lib/grapple/components/actions.rb

@@ -0,0 +1,24 @@
+module Grapple
+	module Components
+		class Actions < HtmlComponent
+
+			setting :link_to_helper, :link_to
+
+			def render(actions = [], &block)
+				html = capture_block(&block)
+				actions.each do |action|
+					if action.kind_of?(String)
+						html << action
+					else
+						# TODO: why are we deleting the label and url?
+						label = action.delete(:label)
+						url = action.delete(:url)
+						html << template.send(link_to_helper, label, url, action)
+					end
+				end			
+				content_tag(:div, html.html_safe, :class => 'actions')
+			end
+
+		end
+	end
+end

data/lib/grapple/components/base_component.rb

@@ -0,0 +1,91 @@
+module Grapple
+	module Components
+		class BaseComponent
+			
+			cattr_accessor :default_settings
+			@@default_settings = {}
+			
+			def self.setting(name, default = nil)
+				attr_accessor(name)
+				@@default_settings[self.name] = {} unless @@default_settings.has_key?(self.name)
+				@@default_settings[self.name][name] = default
+			end
+			
+			attr_reader :columns, :records, :template, :params, :builder
+			
+			def initialize(columns, records, template, params, builder, settings = {})
+				@template = template
+				@columns = columns
+				@records = records
+				@params = params
+				@builder = builder
+				merge_settings(settings).each do |name, value|
+					self.send(:"#{name}=", value)
+				end
+			end
+			
+			def render(*options, &block)
+				raise StandardError.new("Component must override render method")
+			end
+			
+		protected
+		
+			# TODO: this is all pretty hacky
+			def merge_settings(settings)
+				result = {}
+				klass = self.class
+				while klass && klass.name != 'BaseComponent'
+					if @@default_settings[klass.name]
+						@@default_settings[klass.name].each do |name, value|
+							result[name] = value
+						end
+					end
+					klass = klass.superclass
+				end
+
+				settings.each do |name, value|
+					result[name] = value
+				end
+				result
+			end
+		
+			# Shortcut for translations
+			def t(*args)
+				begin
+					return template.t(*args) if template.method_defined?(:t)
+				ensure
+					return I18n.translate(*args)
+				end
+			end
+		
+			def num_columns
+				@columns.length
+			end
+
+			def capture_block(default = '', &block)
+				return default if block.nil?
+				template.with_output_buffer(&block).html_safe
+			end
+
+			def block_or_components(components, options, &block)
+				block.nil? ? render_components(components, options, &block).join : capture_block(&block)
+			end
+			
+			def render_components(components, options, &block)
+				html = []
+				components.each do |component|
+					if component == :body
+						html << capture_block(&block)
+					elsif options[component] === false
+						next
+					else
+						args = options[component] || []
+						html << self.builder.send(component, *args)
+					end
+				end
+				html
+			end
+			
+		end
+	end
+end

data/lib/grapple/components/column_headings.rb

@@ -0,0 +1,42 @@
+module Grapple
+	module Components
+		class ColumnHeadings < HtmlComponent
+
+			setting :alignment_classes, { left: 'text-left', center: 'text-center', right: 'text-right' }
+			setting :tooltip_class, 'table-tooltip'
+
+			def render(url_params = {})
+				cols = columns.collect do |column|
+					indent + column_header(column, url_params)
+				end
+				builder.row cols.join("\n"), :class => 'column-headers'
+			end
+
+			def column_header(column, additional_parameters = {})
+				cell_classes = []
+				cell_classes << alignment_classes[(column[:align] || :left).to_sym]
+				
+				liner_classes = []
+				liner_classes << tooltip_class if column[:title].present?
+
+				if column[:sort] && params.present?
+					cell_classes << 'sortable'
+					if column[:sort] == params[:sort]
+						liner_classes << (params[:dir] == 'desc' ? 'sort-desc' : 'sort-asc')
+						cell_classes << 'sorted'
+					end
+					content = template.link_to(column[:label], table_url(additional_parameters.merge({:sort => column[:sort]})))
+				else
+					content = column[:label]
+				end
+				
+				cell_classes = ' class="' + cell_classes.join(' ') + '"'
+				title = column[:title] ? " title=\"#{h(column[:title])}\"" : ''
+				liner_classes = liner_classes.length ? " class=\"#{liner_classes.join(" ")}\"" : ''
+
+				"<th#{cell_classes}><div#{title}#{liner_classes}>#{h content}</div></th>".html_safe
+			end
+			
+		end
+	end
+end

data/lib/grapple/components/html_body.rb

@@ -0,0 +1,37 @@
+module Grapple
+	module Components
+		class HtmlBody < HtmlComponent
+
+			# If not false, each row will be wrapped in a <tr> tag
+			# if false, the <tr> tag needs to be added in the block
+			# if the value is a proc, it will be called for each row
+			# and the returned value will be passed as the options to 
+			# the tr tag
+			setting :tr, true
+
+			def render(*options, &block)
+				options = options[0] || {}
+				
+				wrap_row = if options[:tr].nil?
+					self.tr
+				elsif options[:tr] === false
+					false
+				else
+					options[:tr]
+				end
+				
+				args = {}
+				html = records.collect do |data|
+					if wrap_row		
+						args = wrap_row.call(template) if wrap_row.is_a?(Proc)
+						builder.row(capture_block { block.call(data) }, args)
+					else
+						indent + capture_block { block.call(data) }
+					end
+				end
+				"<tbody>\n#{html.join("\n")}\n</tbody>\n".html_safe
+			end
+			
+		end
+	end
+end

data/lib/grapple/components/html_colgroup.rb

@@ -0,0 +1,14 @@
+module Grapple
+	module Components
+		class HtmlColgroup < HtmlComponent
+			
+			def render
+				cols = columns.collect do |col|
+					indent + (col[:width].nil? ? "<col>" : "<col width=\"#{col[:width]}\">")
+				end
+				"<colgroup>\n#{cols.join("\n")}\n</colgroup>\n".html_safe
+			end
+			
+		end
+	end
+end

data/lib/grapple/components/html_component.rb

@@ -0,0 +1,24 @@
+module Grapple
+	module Components
+		class HtmlComponent < BaseComponent
+			
+			setting :indent, "\t"
+			
+		protected
+
+			include ERB::Util
+
+			def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+				template.content_tag(name, content_or_options_with_block, options, escape, &block)
+			end
+			
+			def table_url(options)
+				if options[:sort] == params[:sort]
+					options[:dir] = (params[:dir] == 'desc') ? 'asc' : 'desc'
+				end
+				template.url_for params.stringify_keys().merge(options.stringify_keys())
+			end
+		
+		end
+	end
+end

data/lib/grapple/components/html_footer.rb

@@ -0,0 +1,14 @@
+module Grapple
+	module Components
+		class HtmlFooter < HtmlComponent
+
+			setting :components, []
+
+			def render(*options, &block)
+				html = block_or_components(components, options[0] || {}, &block)
+				"<tfoot>\n#{html}</tfoot>\n".html_safe
+			end
+
+		end
+	end
+end

data/lib/grapple/components/html_header.rb

@@ -0,0 +1,16 @@
+module Grapple
+	module Components
+
+		class HtmlHeader < HtmlComponent
+			
+			setting :components, []
+			
+			def render(*options, &block)
+				html = block_or_components(components, options[0] || {}, &block)
+				"<thead>\n#{html}</thead>\n".html_safe
+			end
+			
+		end
+		
+	end
+end

data/lib/grapple/components/html_row.rb

@@ -0,0 +1,11 @@
+module Grapple
+	module Components
+		class HtmlRow < HtmlComponent
+			
+			def render(content, *options)
+				(indent + template.content_tag(:tr, content.html_safe, *options) + "\n").html_safe
+			end
+			
+		end
+	end
+end

data/lib/grapple/components/search_form.rb

@@ -0,0 +1,27 @@
+module Grapple
+	module Components
+		class SearchForm < HtmlComponent
+
+			setting :components, [:body, :search_query_field, :search_submit]
+			setting :page_param, 'page'
+			setting :form_class, 'search-form'
+
+			def render(*options, &block)
+				options = options[0] ? options[0] : {}
+				form_classes = [form_class]
+				html = ''
+				html << template.form_tag({}, { :class => form_classes.join(' ') })
+				html << template.hidden_field_tag(page_param, 1)
+				# TODO: don't use tables for vertical alignment
+				html << '<table><tr>'
+				render_components(components, options, &block).each do |c|
+					html << "<td>#{c}</td>\n"
+				end
+				html << '</tr></table>'
+				html << '</form>'
+				html.html_safe
+			end
+
+		end
+	end
+end

data/lib/grapple/components/search_query_field.rb

@@ -0,0 +1,14 @@
+module Grapple
+	module Components
+		class SearchQueryField < HtmlComponent
+			
+			setting :search_query_param, 'query'
+			setting :search_query_field_class, 'search-query'
+			
+			def render(*options, &block)
+				template.text_field_tag(search_query_param.to_s, params[search_query_param.to_sym], { :class => search_query_field_class })
+			end
+
+		end
+	end
+end

data/lib/grapple/components/search_submit.rb

@@ -0,0 +1,11 @@
+module Grapple
+	module Components
+		class SearchSubmit < HtmlComponent
+
+			def render
+				template.submit_tag(t(:filter))
+			end
+
+		end
+	end
+end

data/lib/grapple/components/toolbar.rb

@@ -0,0 +1,15 @@
+module Grapple
+	module Components
+		class Toolbar < HtmlComponent
+
+			setting :components, []
+
+			def render(*options, &block)
+				options = options[0] || {}
+				html = block_or_components(components, options, &block)
+				builder.row "<th colspan=\"#{num_columns}\">#{html}</th>", :class => 'toolbar'
+			end
+
+		end
+	end
+end