xrb-formatters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c7d3c4882fa5d1766266d11516647193f2edb6a414aa3901cd2280da98b219e
+  data.tar.gz: 82609011a18a1ebf7848c8b92654b75ed9721d2f27640b2687fdb4d89e03cec7
+SHA512:
+  metadata.gz: af17a0f56086a82b143d69d5b02ec070126a8182bd1a6ecb8ce628d10b6063ac6a689e15d69c059e298128202165c9b15ed382ce27f7147a387bb5eb7933bf99
+  data.tar.gz: 836b7440bf8623edf869c929172c32c4613a89c6ff18b68aff2a3f26fc68bd62da3e2f0d0a123940f6bf28051b3d1aac54f6d0083988b01e36887041ba368e9d

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+<���3S-q�Aa�G�"hsiǯ���S����g^^]C_�1���v�������XT����TZܼXc��������c�Hr��'~&�	$aK�廰��L���t������!y����Г<�O�b�_lgu�i�NX�S�n�=���Eh<�Lv�8x`V��{gP����5

data/lib/xrb/formatters/formatter.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+require 'xrb/strings'
+require 'mapping/model'
+require 'mapping/descendants'
+
+module XRB
+	module Formatters
+		class Formatter < Mapping::Model
+			def self.for(object, **options)
+				self.new(object: object, **options)
+			end
+			
+			def initialize(**options)
+				@options = options
+				
+				@object = nil
+			end
+			
+			# The target object of the form.
+			def object
+				@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]
+				
+				if suffix = options[:suffix]
+					name = "#{name}#{suffix}"
+				end
+				
+				if nested_name = self.nested_name(**options)
+					"#{nested_name}[#{name}]"
+				else
+					name
+				end
+			end
+			
+			def nested_name_for(**options)
+				name_for(**options)
+			end
+			
+			def nested(name, key = name, klass: self.class)
+				options = @options.dup
+				target = self.object.send(name)
+				
+				options[:object] = target
+				options[:nested_name] = nested_name_for(name: key)
+				
+				formatter = klass.new(**options)
+				
+				return formatter unless block_given?
+				
+				yield formatter
+			end
+			
+			attr :options
+			
+			def format_unspecified(object, **options)
+				object.to_s
+			end
+
+			def format(object, **options)
+				method_name = self.method_for_mapping(object)
+				
+				if self.respond_to?(method_name)
+					self.send(method_name, object, **options)
+				else
+					format_unspecified(object, **options)
+				end
+			end
+
+			alias text format
+
+			def [] key
+				@options[key]
+			end
+			
+			map(String) do |object, **options|
+				object
+			end
+			
+			map(NilClass) do |object, **options|
+				options[:blank] || @options[:blank] || ""
+			end
+			
+			map(TrueClass, FalseClass, *Mapping.lookup_descendants(Numeric)) do |object, **options|
+				object.to_s
+			end
+		end
+	end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require 'xrb/builder'
+
+module XRB
+	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/xrb/formatters/html/definition_list_form.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+require 'xrb/builder'
+require 'xrb/template'
+
+require_relative 'form_formatter'
+
+module XRB
+	module Formatters
+		module HTML
+			module DefinitionListForm
+				include FormFormatter
+				
+				# An input field (single line text).
+				def input(**options)
+					options = @options.merge(**options)
+					
+					Builder.fragment do |builder|
+						builder.inline(:dt) do
+							builder.text title_for(**options)
+						end
+						
+						builder.inline(:dd) do
+							builder.tag :input, input_attributes_for(**options)
+							
+							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)
+
+					Builder.fragment do |builder|
+						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)
+							end
+						end
+					end
+				end
+				
+				# A textarea field (multi-line text).
+				def textarea(**options)
+					options = @options.merge(**options)
+
+					Builder.fragment do |builder|
+						builder.tag(:dt) do
+								builder.text title_for(**options)
+								
+								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)
+							end
+						end
+					end
+				end
+				
+				# A checkbox field.
+				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.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
+							
+							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)
+					
+					Builder.fragment do |builder|
+						builder.tag :input, submit_attributes_for(**options)
+					end
+				end
+				
+				def element(klass, **options, &block)
+					options = @options.merge(**options)
+					
+					Builder.fragment(block&.binding) do |builder|
+						builder.inline(:dt) do
+							builder.text title_for(**options)
+						end
+						
+						builder.tag(:dd) do
+							klass.call(self, builder, **options, &block)
+							
+							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) do
+							yield(builder)
+						end
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2014-2024, by Samuel Williams.
+
+require 'xrb/builder'
+
+module XRB
+	module Formatters
+		module HTML
+			module FormFormatter
+				# Return true if the object is begin created or false if it is being updated.
+				def new_record?
+					object.new_record?
+				end
+				
+				# Any additional details relating to a field (e.g. explanation text)
+				def details_for(**options)
+					options[:details]
+				end
+				
+				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)
+					if title = options[:title]
+						return title
+					end
+					
+					# 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)
+					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)}
+					
+					# 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)
+						self.format(value, **options)
+					end
+				end
+
+				def pattern_for(**options)
+					options[:pattern]
+				end
+
+				def placeholder_for(**options)
+					options[:placeholder]
+				end
+
+				def input_attributes_for(**options)
+					attributes = {
+						:type => options[:type],
+						:name => name_for(**options),
+						:id => options[:id],
+						:class => options[:class],
+						:value => value_for(**options),
+						:required => options[:required],
+						:disabled => options[:disabled],
+						:readonly => options[:readonly],
+						:pattern => pattern_for(**options),
+						:placeholder => placeholder_for(**options),
+						# for <input type="range|number">
+						:min => options[:minimum] || options[:min],
+						:max => options[:maximum] || options[:max],
+						:step => options[:step],
+						# for <input type="text">
+						:minlength => options[:minimum] || options[:minlength],
+						:maxlength => options[:maximum] || options[:maxlength],
+						:data => options[:data],
+					}
+					
+					return attributes
+				end
+
+				def output_attributes_for(**options)
+					attributes = {
+						:name => name_for(**options),
+						:id => options[:id],
+						:class => options[:class],
+						:for => options[:for],
+						:form => options[:form],
+						:data => options[:data],
+					}
+					
+					return attributes
+				end
+
+				def textarea_attributes_for(**options)
+					return {
+						: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),
+						:minlength => options[:minlength],
+						:maxlength => options[:maxlength],
+						:data => options[:data],
+					}
+				end
+
+				def checkbox_attributes_for(**options)
+					return {
+						:type => options[:type] || 'checkbox',
+						:id => options[:id],
+						:class => options[:class],
+						:name => name_for(**options),
+						:value => 'true',
+						:checked => raw_value_for(**options),
+						:required => options[:required],
+						:disabled => options[:disabled],
+						:readonly => options[:readonly],
+						:data => options[:data],
+					}
+				end
+
+				def submit_attributes_for(**options)
+					return {
+						:type => options[:type] || 'submit',
+						:name => name_for(**options),
+						:id => options[:id],
+						:class => options[:class],
+						:disabled => options[:disabled],
+						:value => title_for(**options),
+						:data => options[:data],
+					}
+				end
+				
+				def submit_title_for(**options)
+					title_for(**options) || (new_record? ? 'Create' : 'Update')
+				end
+				
+				def hidden_attributes_for(**options)
+					return {
+						:type => options[:type] || 'hidden',
+						:id => options[:id],
+						:class => options[:class],
+						:name => name_for(**options),
+						:value => value_for(**options),
+						:data => options[:data],
+					}
+				end
+
+				# A hidden field.
+				def hidden(**options)
+					options = @options.merge(**options)
+
+					Builder.fragment do |builder|
+						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),
+						:data => options[:data],
+					}
+				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
+				
+				def fieldset(**options, &block)
+					options = @options.merge(**options)
+					buffer = XRB::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
+			end
+		end
+	end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require 'xrb/builder'
+require 'xrb/template'
+
+require_relative 'form_formatter'
+
+module XRB
+	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
+								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 = XRB::Template.buffer(block.binding)
+					
+					Builder.fragment(buffer) 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, builder, **options, &block)
+						end
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+require 'xrb/builder'
+
+module XRB
+	module Formatters
+		module HTML
+			# Standard drop-down select box:
+			class OptionSelect
+				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)
+					if name = @formatter.name_for(**options)
+						if options[:multiple]
+							name = "#{name}[]"
+						end
+						
+						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),
+						:selected => options.fetch(:selected) {raw_value == raw_value_for(**options)},
+						:id => options[:id],
+						:class => options[:class],
+						:data => options[:data],
+					}
+				end
+				
+				def item(**options, &block)
+					options[:field] ||= 'id'
+					
+					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] || ''
+					else
+						options[:optional]
+					end
+				end
+				
+				def group_attributes_for(**options)
+					return {
+						:label => title_for(**options),
+						:id => options[:id],
+						:class => options[:class],
+						:data => options[:data],
+					}
+				end
+				
+				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),
+						:id => options[:id],
+						:class => options[:class],
+						:multiple => options[:multiple],
+						:data => options[:data],
+						:required => options[:required],
+					}
+				end
+				
+				def optional?
+					@options[:optional]
+				end
+				
+				def call(&block)
+					Builder.fragment(@builder) do |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)
+						end
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+require 'xrb/builder'
+
+module XRB
+	module Formatters
+		module HTML
+			# Table based select boxes using per-row checkboxes.
+			class RadioSelect
+				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
+					
+					@field = options[:field]
+				end
+				
+				def name_for(**options)
+					@formatter.name_for(**options)
+				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 radio_attributes_for(**options)
+					return {
+						:type => :radio,
+						:name => @field,
+						# We set a default value to empty string, otherwise it becomes "on".
+						:value => value_for(**options) || "",
+						:checked => options.fetch(:selected) {raw_value == raw_value_for(**options)},
+						:data => options[:data],
+					}
+				end
+				
+				def item(**options, &block)
+					Builder.fragment(block&.binding || @builder) do |builder|
+						builder.tag :tr do
+							builder.inline(:td, :class => :handle) do
+								builder.tag :input, radio_attributes_for(**options)
+							end
+							
+							builder.inline(:td, :class => :item) do
+								if block_given?
+									builder.capture(self, &block)
+								else
+									builder.text title_for(**options)
+								end
+							end
+						end
+					end
+				end
+
+				def optional_title_for(**options)
+					if options[:optional] == true
+						options[:blank] || ''
+					else
+						options[:optional]
+					end
+				end
+				
+				def optional?
+					@options[:optional]
+				end
+				
+				def call(&block)
+					Builder.fragment(@builder) do |builder|
+						builder.tag :table do
+							builder.tag :tbody do
+								if self.optional?
+									builder << item(title: optional_title_for(**@options), value: nil)
+								end
+								
+								builder.capture(self, &block)
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/xrb/formatters/markdown.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
+
+require 'markly'
+
+require 'xrb/markup'
+require 'xrb/sanitize/fragment'
+
+module XRB
+	module Formatters
+		module Markdown
+			def markdown(text, filter = XRB::Sanitize::Fragment, **options)
+				root = Markly.parse(text, **options)
+				
+				html = filter.parse(root.to_html).output
+				
+				return MarkupString.raw(html)
+			end
+		end
+	end
+end

data/lib/xrb/formatters/relative_time.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
+
+require 'xrb/strings'
+require 'mapping/model'
+
+module XRB
+	module Formatters
+		module RelativeTime
+			def self.included(base)
+				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:
+					if object.localtime.year != current_time.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/xrb/formatters/truncated_text.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
+
+require 'xrb/strings'
+require 'mapping/model'
+
+module XRB
+	module Formatters
+		module TruncatedText
+			def truncated_text(content, length: 30, **options)
+				if content
+					content = TruncatedText.truncate_text(content, length, **options)
+					
+					return self.format(content)
+				end
+			end
+			
+			def self.truncate_text(text, truncate_at, omission: nil, separator: nil, **options)
+				return text.dup unless text.length > truncate_at
+				
+				omission ||= '...'
+				
+				length_with_room_for_omission = truncate_at - omission.length
+				
+				stop = nil
+				
+				if separator
+					stop = text.rindex(separator, length_with_room_for_omission)
+				end
+				
+				stop ||= length_with_room_for_omission
+				
+				"#{text[0...stop]}#{omission}"
+			end
+		end
+	end
+end

data/lib/xrb/formatters/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+module XRB
+	module Formatters
+		VERSION = "0.1.0"
+	end
+end

data/lib/xrb/formatters.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2024, by Samuel Williams.
+
+require 'xrb/formatters/formatter'

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2012-2024, by Samuel Williams.  
+
+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.

data/readme.md

@@ -0,0 +1,63 @@
+# XRB::Formatters
+
+XRB is a templating system, and these formatters assist with the development
+of typical view and form based web interface. A formatter is a high-level
+adapter that turns model data into presentation text.
+
+Formatters are designed to be customised, typically per-project, for specific
+formatting needs.
+
+[![Development Status](https://github.com/socketry/xrb-formatters/workflows/Test/badge.svg)](https://github.com/socketry/xrb-formatters/actions?workflow=Test)
+
+## Motivation
+
+`XRB::Formatters` was a library extracted from [Financier](https://github.com/ioquatix/financier), an small business management app, 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. `XRB::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 'xrb-formatters'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xrb-formatters
+
+## Usage
+
+The most basic usage involves converting model data into presentation text by
+a mapping corresponding to the objects type:
+
+``` ruby
+formatter = XRB::Formatters::Formatter.new
+	
+formatter.for(String) do |value, **options|
+	"String: #{value}"
+end
+	
+expect(formatter.format("foobar")).to be == "String: foobar"
+```
+
+For more examples please see `spec/`.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: xrb-formatters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mapping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: xrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xrb/formatters.rb
+- lib/xrb/formatters/formatter.rb
+- lib/xrb/formatters/html/accept_checkbox.rb
+- lib/xrb/formatters/html/definition_list_form.rb
+- lib/xrb/formatters/html/form_formatter.rb
+- lib/xrb/formatters/html/label_form.rb
+- lib/xrb/formatters/html/option_select.rb
+- lib/xrb/formatters/html/radio_select.rb
+- lib/xrb/formatters/markdown.rb
+- lib/xrb/formatters/relative_time.rb
+- lib/xrb/formatters/truncated_text.rb
+- lib/xrb/formatters/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/ioquatix/xrb-formatters
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/ioquatix/xrb-formatters.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Formatters for XRB, to assist with typical views and form based interfaces.
+test_files: []