trenni-formatters 2.10.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f7c57bec0e5a3a6a532780308ca6e15569b3f26772876cdd2442c4d9e88a9b
-  data.tar.gz: 7e56a4f516c1306d708ad88716000eff4778023e3976ad9b44bced6fa5dacbf3
+  metadata.gz: a733cfc023aed3ce78ce8278b8d4ef57ee05215440d5bcf0304280115b002cc5
+  data.tar.gz: 374dade3208878129d786ef7917085ee5f05e5df50a62eb2d969ce970be944b3
 SHA512:
-  metadata.gz: f0a149e19f9a21e00335da046d7721c102ee30c6a0bec7382e855058fa5ae28ff51318a917c28d8eee09c4192499fa9a5908d6e7b365843176d18e7392869d91
-  data.tar.gz: ce08752246ea4f8529a9bd1adbbd008912a0b34ac1d8927a7cb43453dc45eee612a076ad01f5c39e0dc9696180562417d6338dd634a99c45ddbe5e2fb18d803c
+  metadata.gz: a6663a34484d4fdc67cc9771df53959941e8c514bf03b752bb2c63680ac1e041ee7da4c95a6d8bb45430dd230093cc9b5911c1fef394dc6d179fafd4e9632121
+  data.tar.gz: a469d0252fdf4dd7fecd68048350e68a938bb28bbfe3347b47d2c04c39cc40fd7f5fd6dc3477c05d7eb360190f58c526d9fc900930183868ff3cadc2538486b6

data/lib/trenni/formatters/formatter.rb

@@ -81,17 +81,17 @@ module Trenni
 			
 			attr :options
 			
-			def format_unspecified(object, options)
+			def format_unspecified(object, **options)
 				object.to_s
 			end
 
-			def format(object, options = {})
+			def format(object, **options)
 				method_name = self.method_for_mapping(object)
 				
 				if self.respond_to?(method_name)
-					self.send(method_name, object, options)
+					self.send(method_name, object, **options)
 				else
-					format_unspecified(object, options)
+					format_unspecified(object, **options)
 				end
 			end
 
@@ -101,15 +101,15 @@ module Trenni
 				@options[key]
 			end
 			
-			map(String) do |object, options|
+			map(String) do |object, **options|
 				object
 			end
 			
-			map(NilClass) do |object, options|
+			map(NilClass) do |object, **options|
 				options[:blank] || @options[:blank] || ""
 			end
 			
-			map(TrueClass, FalseClass, *Mapping.lookup_descendants(Numeric)) do |object, options|
+			map(TrueClass, FalseClass, *Mapping.lookup_descendants(Numeric)) do |object, **options|
 				object.to_s
 			end
 		end

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

@@ -0,0 +1,65 @@
+# 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(&block)
+				end
+				
+				def initialize(formatter, builder, **options)
+					@formatter = formatter
+					@builder = builder
+					@options = options
+				end
+				
+				def name_for(**options)
+					@formatter.name_for(**options)
+				end
+				
+				def checkbox_attributes_for(**options)
+					@formatter.checkbox_attributes_for(**options)
+				end
+				
+				def call(&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

@@ -116,18 +116,17 @@ module Trenni
 						builder.tag :input, submit_attributes_for(**options)
 					end
 				end
-
-				def element(klass, options = {}, &block)
+				
+				def element(klass, **options, &block)
 					options = @options.merge(**options)
-					buffer = Trenni::Template.buffer(block.binding)
 					
-					buffer << Builder.fragment do |builder|
+					Builder.fragment(block&.binding) do |builder|
 						builder.inline(:dt) do
 							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}
@@ -138,7 +137,9 @@ module Trenni
 				
 				def fieldset(**options, &block)
 					super do |builder|
-						builder.tag(:dl, &block)
+						builder.tag(:dl) do
+							yield(builder)
+						end
 					end
 				end
 			end

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

@@ -69,7 +69,7 @@ module Trenni
 				# The value of the field.
 				def value_for(**options)
 					if value = raw_value_for(**options)
-						self.format(value, options)
+						self.format(value, **options)
 					end
 				end
 

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

@@ -99,8 +99,6 @@ module Trenni
 							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
@@ -108,7 +106,7 @@ module Trenni
 							
 							builder.tag :input, checkbox_attributes_for(**options)
 							
-							# We would like a little bit of whitespace between the checkbox and the title.
+							# We would like a little bit of whitespace between the checkbox and the title:
 							builder.text " " + title_for(**options)
 						end
 					end
@@ -124,11 +122,11 @@ module Trenni
 					end
 				end
 				
-				def element(klass, options = {}, &block)
+				def element(klass, **options, &block)
 					options = @options.merge(**options)
 					buffer = Trenni::Template.buffer(block.binding)
 					
-					buffer << Builder.fragment do |builder|
+					Builder.fragment(buffer) do |builder|
 						builder.inline(:label) do
 							builder.inline(:span) do
 								builder.text title_for(**options)
@@ -138,7 +136,7 @@ module Trenni
 								end
 							end
 							
-							klass.call(self, options, builder, &block)
+							klass.call(self, builder, **options, &block)
 						end
 					end
 				end

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

@@ -27,22 +27,18 @@ module Trenni
 		module HTML
 			# Standard drop-down select box:
 			class OptionSelect
-				def self.call(formatter, options, builder, &block)
-					instance = self.new(formatter, options, builder)
+				def self.call(formatter, builder, **options, &block)
+					instance = self.new(formatter, builder, **options)
 					
-					instance.call(options, &block)
+					instance.call(&block)
 				end
 				
-				def initialize(formatter, options, builder)
+				def initialize(formatter, builder, **options)
 					@formatter = formatter
-					@object = formatter.object
-					@field = options[:field]
-					
-					@options = options
-					
 					@builder = builder
+					@options = options
 				end
-
+				
 				def name_for(**options)
 					if name = @formatter.name_for(**options)
 						if options[:multiple]
@@ -52,23 +48,23 @@ module Trenni
 						return name
 					end
 				end
-
+				
 				def raw_value_for(**options)
 					@formatter.raw_value_for(**options)
 				end
-
+				
 				def raw_value
 					@raw_value ||= raw_value_for(**@options)
 				end
-
+				
 				def value_for(**options)
 					@formatter.value_for(**options)
 				end
-
+				
 				def title_for(**options)
 					@formatter.title_for(**options)
 				end
-
+				
 				def option_attributes_for(**options)
 					return {
 						:value => value_for(**options),
@@ -78,15 +74,21 @@ module Trenni
 						:data => options[:data],
 					}
 				end
-
-				def item(builder: nil, **options)
+				
+				def item(**options, &block)
 					options[:field] ||= 'id'
 					
-					Builder.fragment(builder) do |builder|
-						builder.inline(:option, option_attributes_for(**options)) {builder.text title_for(**options)}
+					Builder.fragment(block&.binding || @builder) do |builder|
+						builder.inline(:option, option_attributes_for(**options)) do
+							if block_given?
+								builder.capture(self, &block)
+							else
+								builder.text title_for(**options)
+							end
+						end
 					end
 				end
-
+				
 				def optional_title_for(**options)
 					if options[:optional] == true
 						options[:blank] || ''
@@ -94,7 +96,7 @@ module Trenni
 						options[:optional]
 					end
 				end
-
+				
 				def group_attributes_for(**options)
 					return {
 						:label => title_for(**options),
@@ -103,19 +105,17 @@ module Trenni
 						:data => options[:data],
 					}
 				end
-
-				def group(options = {}, &block)
-					Builder.fragment(@builder) do |builder|
-						builder.tag :optgroup, group_attributes_for(**options) do
-							if options[:optional]
-								item(:title => optional_title_for(**options), :value => nil, :builder => builder)
-							end
-							
-							builder.capture(&block)
+				
+				def group(**options, &block)
+					@builder.tag :optgroup, group_attributes_for(**options) do
+						if options[:optional]
+							item(title: optional_title_for(**options), value: nil)
 						end
+						
+						@builder.capture(&block)
 					end
 				end
-
+				
 				def select_attributes_for(**options)
 					return {
 						:name => name_for(**options),
@@ -123,14 +123,19 @@ module Trenni
 						:class => options[:class],
 						:multiple => options[:multiple],
 						:data => options[:data],
+						:required => options[:required],
 					}
 				end
-
-				def call(options = {}, &block)
+				
+				def optional?
+					@options[:optional]
+				end
+				
+				def call(&block)
 					Builder.fragment(@builder) do |builder|
-						builder.tag :select, select_attributes_for(**options) do
-							if options[:optional]
-								item(:title => optional_title_for(**options), :value => nil, :builder => builder)
+						builder.tag :select, select_attributes_for(**@options) do
+							if self.optional?
+								builder << item(title: optional_title_for(**@options), value: nil)
 							end
 							
 							builder.capture(self, &block)

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

@@ -27,22 +27,20 @@ module Trenni
 		module HTML
 			# Table based select boxes using per-row checkboxes.
 			class RadioSelect
-				def self.call(formatter, options, builder, &block)
-					instance = self.new(formatter, options, builder)
+				def self.call(formatter, builder, **options, &block)
+					instance = self.new(formatter, builder, **options)
 					
-					instance.call(options, &block)
+					instance.call(&block)
 				end
 				
-				def initialize(formatter, options, builder)
+				def initialize(formatter, builder, **options)
 					@formatter = formatter
-					@object = formatter.object
-					
+					@builder = builder
 					@options = options
-					@field = options[:field]
 					
-					@builder = builder
+					@field = options[:field]
 				end
-
+				
 				def name_for(**options)
 					@formatter.name_for(**options)
 				end
@@ -50,19 +48,19 @@ module Trenni
 				def raw_value_for(**options)
 					@formatter.raw_value_for(**options)
 				end
-
+				
 				def raw_value
 					@raw_value ||= raw_value_for(**@options)
 				end
-
+				
 				def value_for(**options)
 					@formatter.value_for(**options)
 				end
-
+				
 				def title_for(**options)
 					@formatter.title_for(**options)
 				end
-
+				
 				def radio_attributes_for(**options)
 					return {
 						:type => :radio,
@@ -73,9 +71,9 @@ module Trenni
 						:data => options[:data],
 					}
 				end
-
-				def item(builder: nil, **options, &block)
-					Builder.fragment(builder) do |builder|
+				
+				def item(**options, &block)
+					Builder.fragment do |builder|
 						builder.tag :tr do
 							builder.inline(:td, :class => :handle) do
 								builder.tag :input, radio_attributes_for(**options)
@@ -89,7 +87,7 @@ module Trenni
 								end
 							end
 						end
-					end >> block
+					end
 				end
 
 				def optional_title_for(**options)
@@ -99,13 +97,17 @@ module Trenni
 						options[:optional]
 					end
 				end
-
-				def call(options = {}, &block)
+				
+				def optional?
+					@options[:optional]
+				end
+				
+				def call(&block)
 					Builder.fragment(@builder) do |builder|
 						builder.tag :table do
 							builder.tag :tbody do
-								if options[:optional]
-									item(:title => optional_title_for(**options), :value => nil, :builder => builder)
+								if self.optional?
+									builder << item(title: optional_title_for(**@options), value: nil)
 								end
 								
 								builder.capture(self, &block)

data/lib/trenni/formatters/relative_time.rb

@@ -27,7 +27,7 @@ module Trenni
 	module Formatters
 		module RelativeTime
 			def self.included(base)
-				base.map(Time) do |object, options|
+				base.map(Time) do |object, **options|
 					current_time = options.fetch(:current_time) {Time.now}
 					
 					# Ensure we display the time in localtime, and show the year if it is different:

data/lib/trenni/formatters/truncated_text.rb

@@ -26,28 +26,30 @@ require 'mapping/model'
 module Trenni
 	module Formatters
 		module TruncatedText
-			def truncated_text(content, options = {})
+			def truncated_text(content, length: 30, **options)
 				if content
-					length  = options.fetch(:length, 30)
-					
-					content = TruncatedText.truncate_text(content, length, options)
+					content = TruncatedText.truncate_text(content, length, **options)
 					
 					return self.format(content)
 				end
 			end
 			
-			def self.truncate_text(text, truncate_at, options = {})
+			def self.truncate_text(text, truncate_at, omission: nil, separator: nil, **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
+				omission ||= '...'
+				
+				length_with_room_for_omission = truncate_at - omission.length
+				
+				stop = nil
+				
+				if separator
+					stop = text.rindex(separator, length_with_room_for_omission)
 				end
 				
-				"#{text[0...stop]}#{options[:omission]}"
+				stop ||= length_with_room_for_omission
+				
+				"#{text[0...stop]}#{omission}"
 			end
 		end
 	end

data/lib/trenni/formatters/version.rb

@@ -22,6 +22,6 @@
 
 module Trenni
 	module Formatters
-		VERSION = "2.10.0"
+		VERSION = "2.13.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni-formatters
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mapping
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bake
   requirement: !ruby/object:Gem::Requirement
@@ -122,14 +122,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/trenni/formatters.rb
 - lib/trenni/formatters/formatter.rb
+- lib/trenni/formatters/html/accept_checkbox.rb
 - lib/trenni/formatters/html/definition_list_form.rb
 - lib/trenni/formatters/html/form_formatter.rb
 - lib/trenni/formatters/html/label_form.rb
@@ -144,7 +145,7 @@ licenses:
 - MIT
 metadata:
   funding_uri: https://github.com/sponsors/ioquatix/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Formatters for Trenni, to assist with typical views and form based interfaces.
 test_files: []