trenni-formatters 2.8.1 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3394bc79205491b32b1ccda3d66f2bf61dac01306735d375c33568386bbae6c1
-  data.tar.gz: 3d150680e6494f6b7abaa10eb3b4622f772c69b740c886de05d8c6b371151ffb
+  metadata.gz: 73f7c57bec0e5a3a6a532780308ca6e15569b3f26772876cdd2442c4d9e88a9b
+  data.tar.gz: 7e56a4f516c1306d708ad88716000eff4778023e3976ad9b44bced6fa5dacbf3
 SHA512:
-  metadata.gz: 62458096a57b44c43fd13cb5b03d7e75907eea995b8776d7dc60ebac74326b6747d8386c9757aa2e6fbf8549c084b6ffa5245dbf353c6394935fc9b80e4f6f9e
-  data.tar.gz: 34a072f941bf47d5ebd6e9959064f5b18ad5bb8aee6002977540ec692e3bc8a33db6b695549f113e2b958a28edc50b956de0f97627cb4a1f5c5f627f262cfbee
+  metadata.gz: f0a149e19f9a21e00335da046d7721c102ee30c6a0bec7382e855058fa5ae28ff51318a917c28d8eee09c4192499fa9a5908d6e7b365843176d18e7392869d91
+  data.tar.gz: ce08752246ea4f8529a9bd1adbbd008912a0b34ac1d8927a7cb43453dc45eee612a076ad01f5c39e0dc9696180562417d6338dd634a99c45ddbe5e2fb18d803c

data/lib/trenni/formatters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2012 Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/trenni/formatters/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -30,109 +32,115 @@ module Trenni
 				include FormFormatter
 				
 				# An input field (single line text).
-				def input(options = {})
-					options = @options.merge(options)
+				def input(**options)
+					options = @options.merge(**options)
 
 					Builder.fragment do |builder|
 						builder.inline(:dt) do
-							builder.text title_for(options)
+							builder.text title_for(**options)
 						end
 						
 						builder.inline(:dd) do
-							builder.tag :input, input_attributes_for(options)
+							builder.tag :input, input_attributes_for(**options)
 							
-							if details = details_for(options)
-								builder.inline(:small, class: 'details') { builder.text details }
+							if details = details_for(**options)
+								builder.inline(:small, class: 'details') {builder.text details}
 							end
 						end
 					end
 				end
 
 				# An output field for the result of a computation.
-				def output(options = {})
-					options = @options.merge(options)
+				def output(**options)
+					options = @options.merge(**options)
 
 					Builder.fragment do |builder|
-						builder.inline(:dt) { builder.text title_for(options) }
+						builder.inline(:dt) {builder.text title_for(**options)}
 
 						builder.inline(:dd) do
-							builder.inline :output, output_attributes_for(options) do
-								builder.text value_for(options)
+							builder.inline :output, output_attributes_for(**options) do
+								builder.text value_for(**options)
 							end
 						end
 					end
 				end
 
 				# A textarea field (multi-line text).
-				def textarea(options = {})
-					options = @options.merge(options)
+				def textarea(**options)
+					options = @options.merge(**options)
 
 					Builder.fragment do |builder|
 						builder.tag(:dt) do
-								builder.text title_for(options)
+								builder.text title_for(**options)
 								
-								if details = details_for(options)
-									builder.inline(:small, class: 'details') { builder.text details }
+								if details = details_for(**options)
+									builder.inline(:small, class: 'details') {builder.text details}
 								end
 						end
 
 						builder.inline(:dd) do
-							builder.tag :textarea, textarea_attributes_for(options) do
-								builder.text value_for(options)
+							builder.tag :textarea, textarea_attributes_for(**options) do
+								builder.text value_for(**options)
 							end
 						end
 					end
 				end
 
 				# A checkbox field.
-				def checkbox(options)
-					options = @options.merge(options)
+				def checkbox(**options)
+					options = @options.merge(**options)
 
 					Builder.fragment do |builder|
 						builder.tag(:dd) do
-							builder.tag :input, :type => :hidden, :name => name_for(options), :value => 'false'
+							builder.tag :input, :type => :hidden, :name => name_for(**options), :value => 'false'
 							
 							builder.inline(:label) do
-								builder.tag :input, checkbox_attributes_for(options)
+								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)
+								builder.text " " + title_for(**options)
 							end
 							
-							if details = details_for(options)
-								builder.inline(:small, class: 'details') { builder.text details }
+							if details = details_for(**options)
+								builder.inline(:small, class: 'details') {builder.text details}
 							end
 						end
 					end
 				end
 
 				# A submission button
-				def submit(options = {})
-					options = @options.merge(options)
-					options[:title] ||= submit_title_for(options)
+				def submit(**options)
+					options = @options.merge(**options)
+					options[:title] ||= submit_title_for(**options)
 					
 					Builder.fragment do |builder|
-						builder.tag :input, submit_attributes_for(options)
+						builder.tag :input, submit_attributes_for(**options)
 					end
 				end
 
 				def element(klass, options = {}, &block)
-					options = @options.merge(options)
+					options = @options.merge(**options)
 					buffer = Trenni::Template.buffer(block.binding)
 					
 					buffer << Builder.fragment do |builder|
 						builder.inline(:dt) do
-							builder.text title_for(options)
+							builder.text title_for(**options)
 						end
 						
 						builder.tag(:dd) do
 							klass.call(self, options, builder, &block)
 							
-							if details = details_for(options)
-								builder.inline(:small, class: 'details') { builder.text details }
+							if details = details_for(**options)
+								builder.inline(:small, class: 'details') {builder.text details}
 							end
 						end
 					end
 				end
+				
+				def fieldset(**options, &block)
+					super do |builder|
+						builder.tag(:dl, &block)
+					end
+				end
 			end
 		end
 	end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -30,83 +32,83 @@ module Trenni
 				end
 				
 				# Any additional details relating to a field (e.g. explanation text)
-				def details_for(options)
+				def details_for(**options)
 					options[:details]
 				end
 				
-				def field_for(options)
+				def field_for(**options)
 					options[:field]
 				end
 				
 				# 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)
+				def title_for(**options)
 					if title = options[:title]
 						return title
 					end
 					
 					# Generate a title from a field name:
-					if field_name = field_for(options)
+					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)
-					if object = options[:object] and field = field_for(options)
+				def object_value_for(**options)
+					if object = options[:object] and field = field_for(**options)
 						object.send(field)
 					end
 				end
 
-				def raw_value_for(options)
-					value = options.fetch(:value) { object_value_for(options) }
+				def raw_value_for(**options)
+					value = options.fetch(:value) {object_value_for(**options)}
 					
 					# Allow to specify a default value if the value given, usually from an object, is nil.
 					value || options[:default]
 				end
 
 				# The value of the field.
-				def value_for(options)
-					if value = raw_value_for(options)
+				def value_for(**options)
+					if value = raw_value_for(**options)
 						self.format(value, options)
 					end
 				end
 
-				def pattern_for(options)
+				def pattern_for(**options)
 					options[:pattern]
 				end
 
-				def placeholder_for(options)
+				def placeholder_for(**options)
 					options[:placeholder]
 				end
 
-				def input_attributes_for(options)
+				def input_attributes_for(**options)
 					attributes = {
 						:type => options[:type],
-						:name => name_for(options),
+						:name => name_for(**options),
 						:id => options[:id],
 						:class => options[:class],
-						:value => value_for(options),
+						:value => value_for(**options),
 						:required => options[:required],
 						:disabled => options[:disabled],
 						:readonly => options[:readonly],
-						:pattern => pattern_for(options),
-						:placeholder => placeholder_for(options),
+						:pattern => pattern_for(**options),
+						:placeholder => placeholder_for(**options),
 						# for <input type="range|number">
-						:min => options[:min],
-						:max => options[:max],
+						:min => options[:minimum] || options[:min],
+						:max => options[:maximum] || options[:max],
 						:step => options[:step],
 						# for <input type="text">
-						:minlength => options[:minlength],
-						:maxlength => options[:maxlength],
+						:minlength => options[:minimum] || options[:minlength],
+						:maxlength => options[:maximum] || options[:maxlength],
 						:data => options[:data],
 					}
 					
 					return attributes
 				end
 
-				def output_attributes_for(options)
+				def output_attributes_for(**options)
 					attributes = {
-						:name => name_for(options),
+						:name => name_for(**options),
 						:id => options[:id],
 						:class => options[:class],
 						:for => options[:for],
@@ -117,30 +119,30 @@ module Trenni
 					return attributes
 				end
 
-				def textarea_attributes_for(options)
+				def textarea_attributes_for(**options)
 					return {
-						:name => name_for(options),
+						:name => name_for(**options),
 						:id => options[:id],
 						:class => options[:class],
 						:required => options[:required],
 						:disabled => options[:disabled],
 						:readonly => options[:readonly],
-						:pattern => pattern_for(options),
-						:placeholder => placeholder_for(options),
+						:pattern => pattern_for(**options),
+						:placeholder => placeholder_for(**options),
 						:minlength => options[:minlength],
 						:maxlength => options[:maxlength],
 						:data => options[:data],
 					}
 				end
 
-				def checkbox_attributes_for(options)
+				def checkbox_attributes_for(**options)
 					return {
 						:type => options[:type] || 'checkbox',
 						:id => options[:id],
 						:class => options[:class],
-						:name => name_for(options),
+						:name => name_for(**options),
 						:value => 'true',
-						:checked => raw_value_for(options),
+						:checked => raw_value_for(**options),
 						:required => options[:required],
 						:disabled => options[:disabled],
 						:readonly => options[:readonly],
@@ -148,71 +150,86 @@ module Trenni
 					}
 				end
 
-				def submit_attributes_for(options)
+				def submit_attributes_for(**options)
 					return {
 						:type => options[:type] || 'submit',
-						:name => name_for(options),
+						:name => name_for(**options),
 						:id => options[:id],
 						:class => options[:class],
 						:disabled => options[:disabled],
-						:value => title_for(options),
+						:value => title_for(**options),
 						:data => options[:data],
 					}
 				end
 				
-				def submit_title_for(options)
-					title_for(options) || (new_record? ? 'Create' : 'Update')
+				def submit_title_for(**options)
+					title_for(**options) || (new_record? ? 'Create' : 'Update')
 				end
 				
-				def hidden_attributes_for(options)
+				def hidden_attributes_for(**options)
 					return {
 						:type => options[:type] || 'hidden',
 						:id => options[:id],
 						:class => options[:class],
-						:name => name_for(options),
-						:value => value_for(options),
+						:name => name_for(**options),
+						:value => value_for(**options),
 						:data => options[:data],
 					}
 				end
 
 				# A hidden field.
-				def hidden(options = {})
-					options = @options.merge(options)
+				def hidden(**options)
+					options = @options.merge(**options)
 
 					Builder.fragment do |builder|
-						builder.tag :input, hidden_attributes_for(options)
+						builder.tag :input, hidden_attributes_for(**options)
 					end
 				end
 				
-				def button_attributes_for(options)
+				def button_attributes_for(**options)
 					return {
 						:type => options[:type] || 'submit',
-						:name => name_for(options),
+						:name => name_for(**options),
 						:id => options[:id],
 						:class => options[:class],
 						:disabled => options[:disabled],
-						:value => value_for(options),
+						:value => value_for(**options),
 						:data => options[:data],
 					}
 				end
 				
-				def button_title_for(options)
+				def button_title_for(**options)
 					type = options.fetch(:type, 'submit').to_sym
 					
 					if type == :submit
-						submit_title_for(options)
+						submit_title_for(**options)
 					else
-						title_for(options) || Strings::to_title(type.to_s)
+						title_for(**options) || Strings::to_title(type.to_s)
 					end
 				end
 				
 				# A hidden field.
-				def button(options = {})
-					options = @options.merge(options)
+				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)
+						builder.inline :button, button_attributes_for(**options) do
+							builder.text button_title_for(**options)
+						end
+					end
+				end
+				
+				def fieldset(**options, &block)
+					options = @options.merge(**options)
+					buffer = Trenni::Template.buffer(block.binding)
+					
+					Builder.fragment(buffer) do |builder|
+						builder.tag('fieldset') do
+							builder.inline('legend') do
+								builder.text title_for(**options)
+							end
+							
+							yield(builder)
 						end
 					end
 				end

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

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# 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/builder'
+require 'trenni/template'
+
+require_relative 'form_formatter'
+
+module Trenni
+	module Formatters
+		module HTML
+			module LabelForm
+				include FormFormatter
+				
+				# An input field (single line text).
+				def input(**options)
+					options = @options.merge(**options)
+					
+					Builder.fragment do |builder|
+						builder.inline(:label) do
+							builder.inline(:span) do
+								builder.text title_for(**options)
+								
+								if details = details_for(**options)
+									builder.inline(:small) {builder.text details}
+								end
+							end
+							
+							builder.inline :input, input_attributes_for(**options)
+						end
+					end
+				end
+				
+				# An output field for the result of a computation.
+				def output(**options)
+					options = @options.merge(**options)
+					
+					builder.inline(:label) do
+						builder.inline(:span) do
+							builder.text title_for(**options)
+							
+							if details = details_for(**options)
+								builder.inline(:small) {builder.text details}
+							end
+						end
+						
+						builder.inline :output, output_attributes_for(**options) do
+							builder.text value_for(**options)
+						end
+					end
+				end
+				
+				# A textarea field (multi-line text).
+				def textarea(**options)
+					options = @options.merge(**options)
+					
+					Builder.fragment do |builder|
+						builder.inline(:label) do
+							builder.inline(:span) do
+								builder.text title_for(**options)
+								
+								if details = details_for(**options)
+									builder.inline(:small) {builder.text details}
+								end
+							end
+							
+							builder.tag :textarea, textarea_attributes_for(**options) do
+								builder.text value_for(**options)
+							end
+						end
+					end
+				end
+				
+				# A checkbox field.
+				def checkbox(**options)
+					options = @options.merge(**options)
+					
+					Builder.fragment do |builder|
+						builder.inline(:label) do
+							builder.inline :input, :type => :hidden, :name => name_for(**options), :value => 'false'
+							
+							builder.inline(:span) do
+								builder.text title_for(**options)
+								
+								if details = details_for(**options)
+									builder.inline(:small) {builder.text details}
+								end
+							end
+							
+							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
+				
+				# A submission button
+				def submit(**options)
+					options = @options.merge(**options)
+					options[:title] ||= submit_title_for(**options)
+					
+					Builder.fragment do |builder|
+						builder.inline :input, submit_attributes_for(**options)
+					end
+				end
+				
+				def element(klass, options = {}, &block)
+					options = @options.merge(**options)
+					buffer = Trenni::Template.buffer(block.binding)
+					
+					buffer << Builder.fragment do |builder|
+						builder.inline(:label) do
+							builder.inline(:span) do
+								builder.text title_for(**options)
+								
+								if details = details_for(**options)
+									builder.inline(:small) {builder.text details}
+								end
+							end
+							
+							klass.call(self, options, builder, &block)
+						end
+					end
+				end
+			end
+		end
+	end
+end