trenni-formatters 2.8.0 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d037e40cc445eb738842fe5d21e393b3b9166a4cd0cc16f663a68d89748029c3
-  data.tar.gz: 971da30b39aa8c5bfb40d2838ef09083abb25ff054e6ab8d4dfc63b405a5d2dc
+  metadata.gz: 518b46786862caa9ff2dced015ea7f14299c274f42bbe7556f9d85ef4fe5a21c
+  data.tar.gz: af3c874086ff1d37d39f2294a2037d4cbc63fafc4e3a783f6d2481d579404c14
 SHA512:
-  metadata.gz: dab2480c97459bbb95ec16b6c68a006d6cf513ad3888f0484d38b2136a0ea8c62eb948692ecc8d573a98a4030e96365b3b6dfef3fd9aab7229eb7bddffdeef26
-  data.tar.gz: af3b1cf1cb56ae17c96c1ba08b3975c6667a30b4e303a61453132fb5bf977b630eca7ea9224e5b45fd1e75d096705f7908d233ea8a22d600d9802711d60a3568
+  metadata.gz: b044fd11db20ab856fe9608dea7039020c1ec42850260deb3b2ca27c6c56884e7a98aeb52ef53347dde510dc0070a6ab38ac2453e7b9d1fb4cc91f36e3d853f4
+  data.tar.gz: 2e59bdcdfec2617347c0dd4ccbdc786057ea3cd2d1618f1f00c51c8cf9506a6f075489a0442163025bb2bb9c08468bee285c44e5a22e91a906a8b3aeb545c68d

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
@@ -31,6 +33,8 @@ module Trenni
 			
 			def initialize(**options)
 				@options = options
+				
+				@object = nil
 			end
 			
 			# The target object of the form.
@@ -38,6 +42,10 @@ module Trenni
 				@object ||= @options[:object]
 			end
 			
+			def nested_name(**options)
+				options[:nested_name] || @options[:nested_name]
+			end
+			
 			# The name of the field, used for the name attribute of an input.
 			def name_for(**options)
 				name = options[:name] || options[:field]
@@ -46,7 +54,7 @@ module Trenni
 					name = "#{name}#{suffix}"
 				end
 				
-				if nested_name = options[:nested_name]
+				if nested_name = self.nested_name(**options)
 					"#{nested_name}[#{name}]"
 				else
 					name

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, 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'
+
+module Trenni
+	module Formatters
+		module HTML
+			class AcceptCheckbox
+				def self.call(formatter, builder, **options, &block)
+					instance = self.new(formatter, builder, **options)
+					
+					instance.call(options, &block)
+				end
+				
+				def initialize(formatter, builder, **options)
+					@formatter = formatter
+					@object = formatter.object
+					
+					@builder = builder
+					
+					@options = options
+					@field = options[:field]
+				end
+				
+				def name_for(**options)
+					@formatter.name_for(**options)
+				end
+				
+				def title_for(**options)
+					@formatter.title_for(**options)
+				end
+				
+				def checkbox_attributes_for(**options)
+					@formatter.checkbox_attributes_for(**options)
+				end
+				
+				def call(**options, &block)
+					Builder.fragment(@builder) do |builder|
+						builder.inline('span') do
+							builder.inline :input, :type => :hidden, :name => name_for(**options), :value => 'false'
+							
+							builder.tag :input, checkbox_attributes_for(**options)
+							
+							builder.text " "
+							
+							builder.capture(self, &block)
+						end
+					end
+				end
+			end
+		end
+	end
+end

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,132 @@ 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)
+				
+				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
+							
+							builder.tag('dl') do
+								yield(builder)
+							end
+						end
+					end
+				end
+				
+				def element(klass, **options, &block)
+					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)
+							klass.call(self, builder, **options, &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