trenni-formatters 2.5.0 → 2.10.0

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

data/lib/trenni/formatters/html/option_select.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
@@ -41,8 +43,8 @@ module Trenni
 					@builder = builder
 				end
 
-				def name_for(options)
-					if name = @formatter.name_for(options)
+				def name_for(**options)
+					if name = @formatter.name_for(**options)
 						if options[:multiple]
 							name = "#{name}[]"
 						end
@@ -51,26 +53,26 @@ module Trenni
 					end
 				end
 
-				def raw_value_for(options)
-					@formatter.raw_value_for(options)
+				def raw_value_for(**options)
+					@formatter.raw_value_for(**options)
 				end
 
 				def raw_value
-					@raw_value ||= raw_value_for(@options)
+					@raw_value ||= raw_value_for(**@options)
 				end
 
-				def value_for(options)
-					@formatter.value_for(options)
+				def value_for(**options)
+					@formatter.value_for(**options)
 				end
 
-				def title_for(options)
-					@formatter.title_for(options)
+				def title_for(**options)
+					@formatter.title_for(**options)
 				end
 
-				def option_attributes_for(options)
+				def option_attributes_for(**options)
 					return {
-						:value => value_for(options),
-						:selected => options.fetch(:selected){ raw_value == raw_value_for(options) },
+						:value => value_for(**options),
+						:selected => options.fetch(:selected) {raw_value == raw_value_for(**options)},
 						:id => options[:id],
 						:class => options[:class],
 						:data => options[:data],
@@ -81,11 +83,11 @@ module Trenni
 					options[:field] ||= 'id'
 					
 					Builder.fragment(builder) do |builder|
-						builder.inline(:option, option_attributes_for(options)) { builder.text title_for(options) }
+						builder.inline(:option, option_attributes_for(**options)) {builder.text title_for(**options)}
 					end
 				end
 
-				def optional_title_for(options)
+				def optional_title_for(**options)
 					if options[:optional] == true
 						options[:blank] || ''
 					else
@@ -93,9 +95,9 @@ module Trenni
 					end
 				end
 
-				def group_attributes_for(options)
+				def group_attributes_for(**options)
 					return {
-						:label => title_for(options),
+						:label => title_for(**options),
 						:id => options[:id],
 						:class => options[:class],
 						:data => options[:data],
@@ -104,19 +106,19 @@ module Trenni
 
 				def group(options = {}, &block)
 					Builder.fragment(@builder) do |builder|
-						builder.tag :optgroup, group_attributes_for(options) do
+						builder.tag :optgroup, group_attributes_for(**options) do
 							if options[:optional]
-								item(:title => optional_title_for(options), :value => nil, :builder => builder)
+								item(:title => optional_title_for(**options), :value => nil, :builder => builder)
 							end
 							
-							builder.append Trenni::Template.capture(&block)
+							builder.capture(&block)
 						end
 					end
 				end
 
-				def select_attributes_for(options)
+				def select_attributes_for(**options)
 					return {
-						:name => name_for(options),
+						:name => name_for(**options),
 						:id => options[:id],
 						:class => options[:class],
 						:multiple => options[:multiple],
@@ -126,12 +128,12 @@ module Trenni
 
 				def call(options = {}, &block)
 					Builder.fragment(@builder) do |builder|
-						builder.tag :select, select_attributes_for(options) do
+						builder.tag :select, select_attributes_for(**options) do
 							if options[:optional]
-								item(:title => optional_title_for(options), :value => nil, :builder => builder)
+								item(:title => optional_title_for(**options), :value => nil, :builder => builder)
 							end
 							
-							builder.append Trenni::Template.capture(self, &block)
+							builder.capture(self, &block)
 						end
 					end
 				end

data/lib/trenni/formatters/html/radio_select.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
@@ -41,33 +43,33 @@ module Trenni
 					@builder = builder
 				end
 
-				def name_for(options)
-					@formatter.name_for(options)
+				def name_for(**options)
+					@formatter.name_for(**options)
 				end
 				
-				def raw_value_for(options)
-					@formatter.raw_value_for(options)
+				def raw_value_for(**options)
+					@formatter.raw_value_for(**options)
 				end
 
 				def raw_value
-					@raw_value ||= raw_value_for(@options)
+					@raw_value ||= raw_value_for(**@options)
 				end
 
-				def value_for(options)
-					@formatter.value_for(options)
+				def value_for(**options)
+					@formatter.value_for(**options)
 				end
 
-				def title_for(options)
-					@formatter.title_for(options)
+				def title_for(**options)
+					@formatter.title_for(**options)
 				end
 
-				def radio_attributes_for(options)
+				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) },
+						:value => value_for(**options) || "",
+						:checked => options.fetch(:selected) {raw_value == raw_value_for(**options)},
 						:data => options[:data],
 					}
 				end
@@ -76,21 +78,21 @@ module Trenni
 					Builder.fragment(builder) do |builder|
 						builder.tag :tr do
 							builder.inline(:td, :class => :handle) do
-								builder.tag :input, radio_attributes_for(options)
+								builder.tag :input, radio_attributes_for(**options)
 							end
 							
 							builder.inline(:td, :class => :item) do
 								if block_given?
-									builder.append Trenni::Template.capture(self, &block)
+									builder.capture(self, &block)
 								else
-									builder.text title_for(options)
+									builder.text title_for(**options)
 								end
 							end
 						end
 					end >> block
 				end
 
-				def optional_title_for(options)
+				def optional_title_for(**options)
 					if options[:optional] == true
 						options[:blank] || ''
 					else
@@ -103,10 +105,10 @@ module Trenni
 						builder.tag :table do
 							builder.tag :tbody do
 								if options[:optional]
-									item(:title => optional_title_for(options), :value => nil, :builder => builder)
+									item(:title => optional_title_for(**options), :value => nil, :builder => builder)
 								end
 								
-								builder.append Trenni::Template.capture(self, &block)
+								builder.capture(self, &block)
 							end
 						end
 					end

data/lib/trenni/formatters/markdown.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
@@ -18,20 +20,18 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'sanitize'
-require 'kramdown'
+require 'markly'
 
 require 'trenni/markup'
+require 'trenni/sanitize/fragment'
 
 module Trenni
 	module Formatters
 		module Markdown
-			def markdown(text)
-				config = Sanitize::Config::BASIC.dup
-				
-				config[:elements] += ['h1', 'h2', 'h3']
+			def markdown(text, filter = Trenni::Sanitize::Fragment, **options)
+				root = Markly.parse(text, **options)
 				
-				html = Sanitize.clean(Kramdown::Document.new(text).to_html, config)
+				html = filter.parse(root.to_html).output
 				
 				return MarkupString.raw(html)
 			end

data/lib/trenni/formatters/relative_time.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/truncated_text.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
@@ -27,24 +29,24 @@ module Trenni
 			def truncated_text(content, options = {})
 				if content
 					length  = options.fetch(:length, 30)
-
+					
 					content = TruncatedText.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.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

data/lib/trenni/formatters/version.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
@@ -20,6 +22,6 @@
 
 module Trenni
 	module Formatters
-		VERSION = "2.5.0"
+		VERSION = "2.10.0"
 	end
 end

metadata

@@ -1,73 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: trenni-formatters
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2020-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: trenni
+  name: mapping
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: mapping
+  name: trenni
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bake-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bake-modernize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,44 +122,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\tTrenni is a templating system, and these formatters assist with the
-  development\n\tof typical view and form based web interface. A formatter is a high-level\n\tadapter
-  that turns model data into presentation text.\n\n\tFormatters are designed to be
-  customised, typically per-project, for specific\n\tformatting needs.\n"
-email:
-- samuel.williams@oriontransfer.co.nz
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".simplecov"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
 - lib/trenni/formatters.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/label_form.rb
 - lib/trenni/formatters/html/option_select.rb
 - lib/trenni/formatters/html/radio_select.rb
 - lib/trenni/formatters/markdown.rb
 - lib/trenni/formatters/relative_time.rb
 - lib/trenni/formatters/truncated_text.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
-- spec/trenni/formatters/markdown_spec.rb
-- spec/trenni/formatters/relative_time_spec.rb
-- spec/trenni/formatters/truncated_text_spec.rb
-- trenni-formatters.gemspec
 homepage: https://github.com/ioquatix/trenni-formatters
-licenses: []
-metadata: {}
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,23 +152,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Formatters for Trenni, to assist with typical views and form based interfaces.
-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
-- spec/trenni/formatters/markdown_spec.rb
-- spec/trenni/formatters/relative_time_spec.rb
-- spec/trenni/formatters/truncated_text_spec.rb
+test_files: []