trenni-formatters 0.5.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3010072052341464ed8f33309fd8b9b59b827c8b
-  data.tar.gz: 4d4e10b75652a479706624c450ef5905c67507d0
+  metadata.gz: 38446eb1ee4817cddda1a893f8ac201d994102cd
+  data.tar.gz: 0a5bdcf731d0aab78c21cb8ec379c385aff4c561
 SHA512:
-  metadata.gz: dc49678aecb21aef566d29fd8c4e1a8dbb734d54160dc76b6c39ef28b1dfe581000de5723080f840374bceca8f5dfa87471e0707213004b00df038bc52e2cce1
-  data.tar.gz: e6a51446102c792d38f64315ffbd64bdf55ac091048fd3a2bf3a4ac3bc3438f6e4b4ffea49b18cd3c3cb34dc27425dddfa7069d816555d50ddaad99f93ea9aa6
+  metadata.gz: 5c764c5ed7624b752f6fa3c1171db00f945bb1c449bc115cc06cdd9fe849c4bee7d0124e9ff291fe779e3944d75b4449d7e19b093454cbfb49b5236a8760ceb5
+  data.tar.gz: 693f5abca9f92b155338aa2a7d2bbd0a1f9c61cfec40b5d910e5f226e2333cf5a885524075b9bffb8d42c7a8fd3c3bb421b7755dff4418e20e22eea2d835f278

data/README.md

@@ -11,19 +11,23 @@ formatting needs.
 [![Code Climate](https://codeclimate.com/github/ioquatix/trenni-formatters.png)](https://codeclimate.com/github/ioquatix/trenni-formatters)
 [![Coverage Status](https://coveralls.io/repos/ioquatix/trenni-formatters/badge.svg)](https://coveralls.io/r/ioquatix/trenni-formatters)
 
+## Motivation
+
+`Trenni::Formatters` was a library extracted from [Financier](https://github.com/ioquatix/financier) which is a CouchDB backed invoicing system, itself, derived from an old Rails app. I was a bit envious of `form_for` in terms of the ease of generating forms, but found that it wasn't very extendable. I also found myself generating code to format model data as rich HTML. `Trenni::Formatters` attempts to be an easily extendable formatting module which can generate rich text, links and HTML.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'trenni-formatters'
+	gem 'trenni-formatters'
 
 And then execute:
 
-    $ bundle
+	$ bundle
 
 Or install it yourself as:
 
-    $ gem install trenni-formatters
+	$ gem install trenni-formatters
 
 ## Usage
 
@@ -36,9 +40,9 @@ a mapping corresponding to the objects type:
 		"String: #{value}"
 	end
 		
-	assert_equal "String: foobar", formatter.format("foobar")
+	expect(formatter.format("foobar")).to be == "String: foobar"
 
-For more examples please see `test/`.
+For more examples please see `spec/`.
 
 ## Contributing
 

data/lib/trenni/formatters/format/markdown.rb

@@ -0,0 +1,34 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'sanitize'
+require 'kramdown'
+
+module Trenni::Formatters::Format
+	module Markdown
+		def markdown(text)
+			config = Sanitize::Config::BASIC.dup
+			
+			config[:elements] += ['h1', 'h2', 'h3']
+			
+			Sanitize.clean(Kramdown::Document.new(text).to_html, config)
+		end
+	end
+end

data/lib/trenni/formatters/format/text.rb

@@ -0,0 +1,50 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'trenni/strings'
+require 'mapping/model'
+
+module Trenni::Formatters::Format
+	module Text
+		def truncated_text(content, options = {}, &block)
+			if content
+				length  = options.fetch(:length, 30)
+
+				content = self.class.truncate_text(content, length, options)
+				
+				return self.format(content)
+			end
+		end
+
+		def self.truncate_text(text, truncate_at, options = {})
+			return text.dup unless text.length > truncate_at
+
+			options[:omission] ||= '...'
+			length_with_room_for_omission = truncate_at - options[:omission].length
+			stop = if options[:separator]
+					text.rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
+				else
+					length_with_room_for_omission
+				end
+
+			"#{text[0...stop]}#{options[:omission]}"
+		end
+	end
+end

data/lib/trenni/formatters/format/time.rb

@@ -0,0 +1,39 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'trenni/strings'
+require 'mapping/model'
+
+module Trenni::Formatters::Format
+	module Time
+		def included(base)
+			base.map(Time) do |object, options|
+				# Ensure we display the time in localtime, and show the year if it is different:
+				if object.localtime.year != Time.now.year
+					object.localtime.strftime("%B %-d, %-l:%M%P, %Y")
+				else
+					object.localtime.strftime("%B %-d, %-l:%M%P")
+				end
+			end
+			end
+		end
+	end
+end
+

data/lib/trenni/formatters/formatter.rb

@@ -19,24 +19,30 @@
 # THE SOFTWARE.
 
 require 'trenni/strings'
+require 'mapping/model'
 
 module Trenni
 	module Formatters
-		class Formatter
+		class Formatter < Mapping::Model
 			def initialize(options = {})
 				@options = options
-				@formatters = {}
+			end
+
+			def format_unspecified(object, options)
+				if object
+					Strings::to_html(object.to_s)
+				else
+					options[:blank] || ""
+				end
 			end
 
 			def format(object, options = {})
-				if formatter = @formatters[object.class]
-					formatter.call(object, options)
+				method_name = self.method_for_mapping(object)
+				
+				if self.respond_to?(method_name)
+					self.send(method_name, object, options)
 				else
-					if object
-						Strings::to_html(object.to_s)
-					else
-						options[:blank] || ""
-					end
+					format_unspecified(object, options)
 				end
 			end
 
@@ -45,10 +51,6 @@ module Trenni
 			def [] key
 				@options[key]
 			end
-
-			def for(klass, &block)
-				@formatters[klass] = block
-			end
 		end
 	end
 end

data/lib/trenni/formatters/html/definition_list_form.rb

@@ -34,8 +34,14 @@ module Trenni
 					options = @options.merge(options)
 
 					Builder.fragment do |builder|
-						builder.inline(:dt) { builder.text title_for(options) }
-
+						builder.inline(:dt) do
+							builder.text title_for(options)
+							
+							if details = details_for(options)
+								builder.inline(:small) { builder.text details }
+							end
+						end
+						
 						builder.inline(:dd) do
 							builder.tag :input, input_attributes_for(options)
 						end
@@ -50,7 +56,9 @@ module Trenni
 						builder.inline(:dt) { builder.text title_for(options) }
 
 						builder.inline(:dd) do
-							builder.tag :output, output_attributes_for(options)
+							builder.inline :output, output_attributes_for(options) do
+								builder.text value_for(options)
+							end
 						end
 					end
 				end
@@ -60,7 +68,13 @@ module Trenni
 					options = @options.merge(options)
 
 					Builder.fragment do |builder|
-						builder.inline(:dt) { builder.text title_for(options) }
+						builder.tag(:dt) do
+								builder.text title_for(options)
+								
+								if details = details_for(options)
+									builder.inline(:small) { builder.text details }
+								end
+						end
 
 						builder.inline(:dd) do
 							builder.tag :textarea, textarea_attributes_for(options) do
@@ -77,8 +91,11 @@ module Trenni
 					Builder.fragment do |builder|
 						builder.tag(:dd) do
 							builder.tag :input, :type => :hidden, :name => name_for(options), :value => 'false'
-							builder.tag :input, checkbox_attributes_for(options)
-							builder.text " " + title_for(options)
+							builder.inline(:label) do
+								builder.tag :input, checkbox_attributes_for(options)
+								# We would like a little bit of whitespace between the checkbox and the title.
+								builder.text " " + title_for(options)
+							end
 						end
 					end
 				end
@@ -86,13 +103,8 @@ module Trenni
 				# A submission button
 				def submit(options = {})
 					options = @options.merge(options)
+					options[:title] ||= submit_title_for(options)
 					
-					if title = title_for(options)
-						options[:title] = title
-					else
-						options[:title] ||= new_record? ? 'Create' : 'Update'
-					end
-
 					Builder.fragment do |builder|
 						builder.tag :input, submit_attributes_for(options)
 					end
@@ -103,7 +115,14 @@ module Trenni
 					buffer = Trenni::Template.buffer(block.binding)
 					
 					buffer << Builder.fragment do |builder|
-						builder.inline(:dt) { builder.text title_for(options) }
+						builder.inline(:dt) do
+							builder.text title_for(options)
+							
+							if details = details_for(options)
+								builder.inline(:small) { builder.text details }
+							end
+						end
+						
 						builder.tag(:dd) do
 							klass.call(self, options, builder, &block)
 						end

data/lib/trenni/formatters/html/form_formatter.rb

@@ -37,10 +37,15 @@ module Trenni
 						return !object.saved?
 					end
 				end
-
+				
+				# Any additional details relating to a field (e.g. explanation text)
+				def details_for(options)
+					options[:details]
+				end
+				
 				# The name of the field, used for the name attribute of an input.
 				def name_for(options)
-					(options[:name] || options[:field]).to_s
+					options[:name] || options[:field]
 				end
 				
 				def field_for(options)
@@ -49,17 +54,21 @@ module Trenni
 				
 				# A title is a text string that will be displayed next to or on top of the control to describe it or its value:
 				def title_for(options)
-					title = options[:title]
-					return Strings::to_html(title) if title
-					
-					field_name = field_for(options)
+					if title = options[:title]
+						return title
+					end
 					
-					# Remove postfix "_id" or "_ids":
-					return Strings::to_title(field_name.to_s.sub(/_ids?/, '')) if field_name
+					# Generate a title from a field name:
+					if field_name = field_for(options)
+						# Remove postfix "_id" or "_ids":
+						return Strings::to_title(field_name.to_s.sub(/_ids?/, ''))
+					end
 				end
 
 				def object_value_for(options)
-					options[:object].send(field_for(options)) if options[:object]
+					if object = options[:object] and field = field_for(options)
+						object.send(field)
+					end
 				end
 
 				def raw_value_for(options)
@@ -71,7 +80,9 @@ module Trenni
 
 				# The value of the field.
 				def value_for(options)
-					self.format(raw_value_for(options), options)
+					if value = raw_value_for(options)
+						self.format(value, options)
+					end
 				end
 
 				def pattern_for(options)
@@ -157,7 +168,11 @@ module Trenni
 						:value => title_for(options),
 					}
 				end
-
+				
+				def submit_title_for(options)
+					title_for(options) || (new_record? ? 'Create' : 'Update')
+				end
+				
 				def hidden_attributes_for(options)
 					return {
 						:type => options[:type] || 'hidden',
@@ -176,6 +191,38 @@ module Trenni
 						builder.tag :input, hidden_attributes_for(options)
 					end
 				end
+				
+				def button_attributes_for(options)
+					return {
+						:type => options[:type] || 'submit',
+						:name => name_for(options),
+						:id => options[:id],
+						:class => options[:class],
+						:disabled => options[:disabled],
+						:value => value_for(options),
+					}
+				end
+				
+				def button_title_for(options)
+					type = options.fetch(:type, 'submit').to_sym
+					
+					if type == :submit
+						submit_title_for(options)
+					else
+						title_for(options) || Strings::to_title(type.to_s)
+					end
+				end
+				
+				# A hidden field.
+				def button(options = {})
+					options = @options.merge(options)
+
+					Builder.fragment do |builder|
+						builder.inline :button, button_attributes_for(options) do
+							builder.text button_title_for(options)
+						end
+					end
+				end
 			end
 		end
 	end

data/lib/trenni/formatters/html/option_select.rb

@@ -42,13 +42,13 @@ module Trenni
 				end
 
 				def name_for(options)
-					name = @formatter.name_for(options)
-					
-					if options[:multiple]
-						name += '[]'
+					if name = @formatter.name_for(options)
+						if options[:multiple]
+							name = "#{name}[]"
+						end
+						
+						return name
 					end
-					
-					return name
 				end
 
 				def value_for(options)
@@ -85,7 +85,7 @@ module Trenni
 				end
 
 				def group(options = {}, &block)
-					Builder.fragment do |builder|
+					Builder.fragment(@builder) do |builder|
 						builder.tag :optgroup, group_attributes_for(options) do
 							if options[:optional]
 								item(:title => '', :value => '', :builder => builder)

data/lib/trenni/formatters/html/{table_select.rb → radio_select.rb}

@@ -24,7 +24,7 @@ module Trenni
 	module Formatters
 		module HTML
 			# Table based select boxes using per-row checkboxes.
-			class TableSelect
+			class RadioSelect
 				def self.call(formatter, options, builder, &block)
 					instance = self.new(formatter, options, builder)
 					
@@ -97,7 +97,6 @@ module Trenni
 					end
 				end
 			end
-
 		end
 	end
 end

data/lib/trenni/formatters/version.rb

@@ -20,6 +20,6 @@
 
 module Trenni
 	module Formatters
-		VERSION = "0.5.3"
+		VERSION = "1.0.0"
 	end
 end

data/spec/trenni/formatters/form_formatter_spec.rb

@@ -20,8 +20,6 @@
 
 require 'trenni/formatters'
 require 'trenni/formatters/html/definition_list_form'
-require 'trenni/formatters/html/option_select'
-require 'trenni/formatters/html/table_select'
 
 module Trenni::Formatters::FormFormatterSpec
 	class FormFormatter < Trenni::Formatters::Formatter
@@ -32,8 +30,8 @@ module Trenni::Formatters::FormFormatterSpec
 		let(:formatter) {FormFormatter.new(:object => double(:bar => 10))}
 		
 		it "should generate form" do
-			output_tag = formatter.input(:field => :bar)
-			expect(output_tag).to be == %Q{<dt>Bar</dt>\n<dd><input name="bar" value="10"/></dd>}
+			result = formatter.input(:field => :bar)
+			expect(result).to be == %Q{<dt>Bar</dt>\n<dd><input name="bar" value="10"/></dd>}
 		end
 		
 		it "should have default value" do
@@ -42,8 +40,8 @@ module Trenni::Formatters::FormFormatterSpec
 		end
 		
 		it "should have a different title" do
-			output_tag = formatter.input(:field => :bar, :title => "Title")
-			expect(output_tag).to be == %Q{<dt>Title</dt>\n<dd><input name="bar" value="10"/></dd>}
+			result = formatter.input(:field => :bar, :title => "Title")
+			expect(result).to be == %Q{<dt>Title</dt>\n<dd><input name="bar" value="10"/></dd>}
 		end
 	end
 	
@@ -57,8 +55,8 @@ module Trenni::Formatters::FormFormatterSpec
 			expect(attributes[:max]).to be == 20
 			expect(attributes[:step]).to be == 2
 			
-			output_tag = formatter.input(:field => :bar, :min => 10)
-			expect(output_tag).to be == %Q{<dt>Bar</dt>\n<dd><input name="bar" value="10" min="10"/></dd>}
+			result = formatter.input(:field => :bar, :min => 10)
+			expect(result).to be == %Q{<dt>Bar</dt>\n<dd><input name="bar" value="10" min="10"/></dd>}
 		end
 		
 		it "should not specify required, readonly or disabled" do
@@ -79,16 +77,87 @@ module Trenni::Formatters::FormFormatterSpec
 			attributes = formatter.checkbox_attributes_for(:value => true)
 			expect(attributes[:checked]).to be true
 			
-			output_tag = formatter.checkbox(:field => :bob)
-			expect(output_tag).to be == %Q{<dd>\n\t<input type="hidden" name="bob" value="false"/>\t<input type="checkbox" name="bob" value="true" checked/>\tBob\n</dd>}
+			result = formatter.checkbox(:field => :bob)
+			expect(result).to be == %Q{<dd>\n\t<input type="hidden" name="bob" value="false"/>\n\t<label><input type="checkbox" name="bob" value="true" checked/> Bob</label>\n</dd>}
 		end
 		
 		it "should generate unchecked checkbox" do
 			attributes = formatter.checkbox_attributes_for(:value => false)
 			expect(attributes[:checked]).to be nil
 			
-			output_tag = formatter.checkbox(:field => :dole)
-			expect(output_tag).to be == %Q{<dd>\n\t<input type="hidden" name="dole" value="false"/>\t<input type="checkbox" name="dole" value="true"/>\tDole\n</dd>}
+			result = formatter.checkbox(:field => :dole)
+			expect(result).to be == %Q{<dd>\n\t<input type="hidden" name="dole" value="false"/>\n\t<label><input type="checkbox" name="dole" value="true"/> Dole</label>\n</dd>}
+		end
+	end
+	
+	describe '<input type="hidden">' do
+		let(:formatter) {FormFormatter.new(:object => double(age: 20))}
+		
+		it "should generate hidden field" do
+			result = formatter.hidden(:field => :age)
+			expect(result).to be == %Q{<input type="hidden" name="age" value="20"/>}
+		end
+		
+		it "should escape characters correctly" do
+			result = formatter.submit
+			expect(result).to be == %Q{<input type="submit" value="Update"/>}
+		end
+		
+		it "can have custom title" do
+			result = formatter.submit(title: 'Alice')
+			expect(result).to be == %Q{<input type="submit" value="Alice"/>}
+		end
+	end
+	
+	describe '<input type="submit">' do
+		let(:new_record_formatter) {FormFormatter.new(:object => double(new_record?: true))}
+		let(:formatter) {FormFormatter.new(:object => double(new_record?: false))}
+		
+		it "should have correct title for new_record?" do
+			result = new_record_formatter.submit
+			expect(result).to be == %Q{<input type="submit" value="Create"/>}
+		end
+		
+		it "should escape characters correctly" do
+			result = formatter.submit
+			expect(result).to be == %Q{<input type="submit" value="Update"/>}
+		end
+		
+		it "can have custom title" do
+			result = formatter.submit(title: 'Alice')
+			expect(result).to be == %Q{<input type="submit" value="Alice"/>}
+		end
+	end
+	
+	describe "<textarea>" do
+		let(:formatter) {FormFormatter.new(:object => double(details: "foo<bar>"))}
+		
+		it "should escape characters correctly" do
+			result = formatter.textarea(:field => :details)
+			expect(result).to be == %Q{<dt>\n\tDetails\n</dt>\n<dd><textarea name=\"details\">foo&lt;bar&gt;</textarea></dd>}
+		end
+	end
+	
+	describe "<output>" do
+		let(:formatter) {FormFormatter.new(:object => double(bar: 10, bob: true, dole: false))}
+		
+		it "should show output value" do
+			result = formatter.output(:field => :bar)
+			expect(result).to be == %Q{<dt>Bar</dt>\n<dd><output name=\"bar\">10</output></dd>}
+		end
+		
+		it "should show output value" do
+			result = formatter.output(:name => :total)
+			expect(result).to be == %Q{<dt></dt>\n<dd><output name=\"total\"></output></dd>}
+		end
+	end
+	
+	describe "<button>" do
+		let(:formatter) {FormFormatter.new}
+		
+		it "should generate reset button" do
+			result = formatter.button(:type => :reset)
+			expect(result).to be == %Q{<button type="reset">Reset</button>}
 		end
 	end
 end

data/spec/trenni/formatters/formatters_spec.rb

@@ -21,25 +21,37 @@
 require 'trenni/formatters'
 
 module Trenni::FormattersSpec
-	describe Trenni::Formatters do
-		before do
+	class TestFormatter < Trenni::Formatters::Formatter
+		def initialize(*)
 			@count = 0
-			@formatter = Trenni::Formatters::Formatter.new
+			
+			super
+		end
 		
-			@formatter.for(String) do |value, options|
-				@count += 1
-				"String: #{value}"
-			end
+		attr :count
+		
+		map(String) do |value, options|
+			@count += 1
+			
+			"String: #{value}"
 		end
+	end
+	
+	describe Trenni::Formatters do
+		let(:test_formatter) {TestFormatter.new(foo: :bar)}
 	
 		it "should format string" do
-			expect(@formatter.format("foobar")).to be == "String: foobar"
-			expect(@count).to be == 1
+			expect(test_formatter.format("foobar")).to be == "String: foobar"
+			expect(test_formatter.count).to be == 1
 		end
 	
 		it "should format numbers" do
-			expect(@formatter.format(10)).to be == "10"
-			expect(@count).to be == 0
+			expect(test_formatter.format(10)).to be == "10"
+			expect(test_formatter.count).to be == 0
+		end
+		
+		it "has options" do
+			expect(test_formatter[:foo]).to be == :bar
 		end
 	end
 end

data/spec/trenni/formatters/html/option_select_spec.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'trenni/formatters'
+require 'trenni/formatters/html/option_select'
 
 module Trenni::Formatters::HTML::OptionSelectSpec
 	class FormFormatter < Trenni::Formatters::Formatter
@@ -31,10 +32,9 @@ module Trenni::Formatters::HTML::OptionSelectSpec
 	
 	describe Trenni::Formatters::HTML::OptionSelect do
 		let(:formatter) {FormFormatter.new(:object => double(:bar => 10))}
+		let(:_out) {Array.new}
 		
-		it "should format items" do
-			_out = []
-			
+		it "should list items" do
 			formatter.select :field => :bar do |select|
 				_out << select.item(:title => "A", :value => 0)
 				_out << select.item(:title => "B", :value => 10)
@@ -42,5 +42,45 @@ module Trenni::Formatters::HTML::OptionSelectSpec
 			
 			expect(_out.join).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<option value=\"0\">A</option><option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
 		end
+		
+		it "should list items for multiple selection" do
+			formatter.select :field => :bar, multiple: true do |select|
+				_out << select.item(:title => "A", :value => 0)
+				_out << select.item(:title => "B", :value => 10)
+			end
+			
+			expect(_out.join).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar[]\" multiple>\n\t\t<option value=\"0\">A</option><option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
+		end
+		
+		it "should add optional item" do
+			formatter.select :field => :bar, optional: true do |select|
+				_out << select.item(:title => "A", :value => 0)
+				_out << select.item(:title => "B", :value => 10)
+			end
+			
+			expect(_out.join).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<option value=\"\"></option>\t\t<option value=\"0\">A</option><option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
+		end
+		
+		it "should add optional item in group" do
+			formatter.select :field => :bar do |select|
+				select.group(title: 'group', optional: true) do
+					_out << select.item(:title => "A", :value => 0)
+				end
+				_out << select.item(:title => "B", :value => 10)
+			end
+			
+			expect(_out.join).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<optgroup label=\"group\">\n\t\t\t<option value=\"\"></option>\t\t\t<option value=\"0\">A</option>\n\t\t</optgroup>\t\t<option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
+		end
+		
+		it "should add a group" do
+			formatter.select :field => :bar do |select|
+				select.group(title: 'group') do
+					_out << select.item(:title => "A", :value => 0)
+				end
+				_out << select.item(:title => "B", :value => 10)
+			end
+			
+			expect(_out.join).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<optgroup label=\"group\">\n\t\t\t<option value=\"0\">A</option>\n\t\t</optgroup>\t\t<option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
+		end
 	end
 end

data/spec/trenni/formatters/html/radio_select_spec.rb

@@ -0,0 +1,46 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'trenni/formatters'
+require 'trenni/formatters/html/radio_select'
+
+module Trenni::Formatters::HTML::RadioSelectSpec
+	class FormFormatter < Trenni::Formatters::Formatter
+		include Trenni::Formatters::HTML::DefinitionListForm
+		
+		def select(options = {}, &block)
+			element(Trenni::Formatters::HTML::RadioSelect, options, &block)
+		end
+	end
+	
+	describe Trenni::Formatters::HTML::RadioSelect do
+		let(:formatter) {FormFormatter.new(:object => double(:bar => 10))}
+		let(:_out) {Array.new}
+		
+		it "should list items" do
+			formatter.select :field => :bar do |select|
+				_out << select.item(:title => "A", :value => 0)
+				_out << select.item(:title => "B", :value => 10)
+			end
+			
+			expect(_out.join).to be == %Q{<dt>Bar</dt>\n<dd>\n\t<table>\n\t\t<tbody>\n\t\t\t<tr>\n\t\t\t\t<td class="handle"><input type="radio" name="bar" value="0"/></td>\n\t\t\t\t<td class="item">A</td>\n\t\t\t</tr><tr>\n\t\t\t\t<td class="handle"><input type="radio" name="bar" value="10"/></td>\n\t\t\t\t<td class="item">B</td>\n\t\t\t</tr>\n\t\t</tbody>\n\t</table>\n</dd>}
+		end
+	end
+end

data/trenni-formatters.gemspec

@@ -24,7 +24,9 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 	
-	spec.add_dependency "trenni", "~> 1.4.0"
+	spec.add_dependency "trenni", "~> 1.5.0"
+	
+	spec.add_dependency "mapping", "~> 1.0.0"
 	
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "rspec", "~> 3.4.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni-formatters
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: mapping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,15 +98,19 @@ files:
 - README.md
 - Rakefile
 - lib/trenni/formatters.rb
+- lib/trenni/formatters/format/markdown.rb
+- lib/trenni/formatters/format/text.rb
+- lib/trenni/formatters/format/time.rb
 - lib/trenni/formatters/formatter.rb
 - lib/trenni/formatters/html/definition_list_form.rb
 - lib/trenni/formatters/html/form_formatter.rb
 - lib/trenni/formatters/html/option_select.rb
-- lib/trenni/formatters/html/table_select.rb
+- lib/trenni/formatters/html/radio_select.rb
 - lib/trenni/formatters/version.rb
 - spec/trenni/formatters/form_formatter_spec.rb
 - spec/trenni/formatters/formatters_spec.rb
 - spec/trenni/formatters/html/option_select_spec.rb
+- spec/trenni/formatters/html/radio_select_spec.rb
 - trenni-formatters.gemspec
 homepage: https://github.com/ioquatix/trenni-formatters
 licenses: []
@@ -113,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Formatters for Trenni, to assist with typical views and form based interfaces.
@@ -121,3 +139,4 @@ test_files:
 - spec/trenni/formatters/form_formatter_spec.rb
 - spec/trenni/formatters/formatters_spec.rb
 - spec/trenni/formatters/html/option_select_spec.rb
+- spec/trenni/formatters/html/radio_select_spec.rb