trenni-formatters 2.8.1 → 2.10.0

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,4 +0,0 @@
---color
---format documentation
---backtrace
---warnings

data/.simplecov

@@ -1,9 +0,0 @@
-
-SimpleCov.start do
-	add_filter "/spec/"
-end
-
-if ENV['TRAVIS']
-	require 'coveralls'
-	Coveralls.wear!
-end

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head

data/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in trenni-formatters.gemspec
-gemspec
-
-group :test do
-	gem 'sanitize'
-	gem 'kramdown'
-	
-	gem 'simplecov'
-	gem 'coveralls', require: false
-end

data/README.md

@@ -1,77 +0,0 @@
-# Trenni::Formatters
-
-Trenni 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.
-
-[![Build Status](https://travis-ci.org/ioquatix/trenni-formatters.svg?branch=master)](https://travis-ci.org/ioquatix/trenni-formatters)
-[![Code Climate](https://codeclimate.com/github/ioquatix/trenni-formatters.png)](https://codeclimate.com/github/ioquatix/trenni-formatters)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/trenni-formatters/badge.svg)](https://coveralls.io/r/ioquatix/trenni-formatters)
-
-## Motivation
-
-`Trenni::Formatters` was a library extracted from [Financier](https://github.com/ioquatix/financier) which is a CouchDB backed invoicing system, 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. `Trenni::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 'trenni-formatters'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install trenni-formatters
-
-## Usage
-
-The most basic usage involves converting model data into presentation text by
-a mapping corresponding to the objects type:
-
-	formatter = Trenni::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
-
-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
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2014, by [Samuel G. D. Williams](http://www.codeotaku.com/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/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec) do |task|
-	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
-end
-
-task :default => :spec

data/spec/trenni/formatters/formatters_spec.rb

@@ -1,57 +0,0 @@
-# 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/formatters'
-
-module Trenni::FormattersSpec
-	class TestFormatter < Trenni::Formatters::Formatter
-		def initialize(*)
-			@count = 0
-			
-			super
-		end
-		
-		attr :count
-		
-		map(String) do |value, options|
-			@count += 1
-			
-			"String: #{value}"
-		end
-	end
-	
-	describe Trenni::Formatters do
-		let(:test_formatter) {TestFormatter.new(foo: :bar)}
-	
-		it "should format string" do
-			expect(test_formatter.format("foobar")).to be == "String: foobar"
-			expect(test_formatter.count).to be == 1
-		end
-	
-		it "should format numbers" do
-			expect(test_formatter.format(10)).to be == "10"
-			expect(test_formatter.count).to be == 0
-		end
-		
-		it "has options" do
-			expect(test_formatter[:foo]).to be == :bar
-		end
-	end
-end

data/spec/trenni/formatters/html/form_formatter_spec.rb

@@ -1,186 +0,0 @@
-# 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/formatters'
-require 'trenni/formatters/html/definition_list_form'
-
-module Trenni::Formatters::FormFormatterSpec
-	class FormFormatter < Trenni::Formatters::Formatter
-		include Trenni::Formatters::HTML::DefinitionListForm
-	end
-	
-	describe Trenni::Formatters do
-		let(:formatter) {FormFormatter.for(double(bar: 10))}
-		
-		it "should generate form" do
-			result = formatter.input(:field => :bar)
-			expect(result).to be == %Q{<dt>Bar</dt>\n<dd><input name="bar" value="10"/></dd>}
-		end
-		
-		it "should have default value" do
-			expect(formatter.value_for(:value => 10)).to be == "10"
-			expect(formatter.value_for(:value => nil, :default => 10)).to be == "10"
-		end
-		
-		it "should have a different title" do
-			result = formatter.input(:field => :bar, :title => "Title")
-			expect(result).to be == %Q{<dt>Title</dt>\n<dd><input name="bar" value="10"/></dd>}
-		end
-		
-		context "with key" do
-			let(:formatter) {FormFormatter.for(double(bar: 10), nested_name: 'attributes')}
-			
-			it "should generate form with nested name" do
-				result = formatter.input(:field => :bar)
-				expect(result).to be == %Q{<dt>Bar</dt>\n<dd><input name="attributes[bar]" value="10"/></dd>}
-			end
-		end
-		
-		context "with nested object" do
-			let(:formatter) {FormFormatter.for(double(animal: double(name: "cat")))}
-			
-			it "can generate nested attributes" do
-				result = formatter.nested(:animal) do |formatter|
-					formatter.input(field: :name)
-				end
-				
-				expect(result).to be == %Q{<dt>Name</dt>\n<dd><input name="animal[name]" value="cat"/></dd>}
-			end
-		end
-	end
-	
-	describe "<input>" do
-		let(:formatter) {FormFormatter.new(:object => double(bar: 10, bob: true, dole: false))}
-		
-		it "should support support min, max and step" do
-			attributes = formatter.input_attributes_for(:min => 10, :max => 20, :step => 2)
-			
-			expect(attributes[:min]).to be == 10
-			expect(attributes[:max]).to be == 20
-			expect(attributes[:step]).to be == 2
-			
-			result = formatter.input(:field => :bar, :min => 10)
-			expect(result).to be == %Q{<dt>Bar</dt>\n<dd><input name="bar" value="10" min="10"/></dd>}
-		end
-		
-		it "should not specify required, readonly or disabled" do
-			attributes = formatter.input_attributes_for(:field => :bar)
-			expect(attributes[:required]).to be nil
-			expect(attributes[:readonly]).to be nil
-			expect(attributes[:disabled]).to be nil
-		end
-		
-		it "should specify required, readonly or disabled" do
-			attributes = formatter.input_attributes_for(:field => :bar, :required => true, :readonly => true, :disabled => true)
-			expect(attributes[:required]).to be true
-			expect(attributes[:readonly]).to be true
-			expect(attributes[:disabled]).to be true
-		end
-		
-		it "should generate checked checkbox" do
-			attributes = formatter.checkbox_attributes_for(:value => true)
-			expect(attributes[:checked]).to be true
-			
-			result = formatter.checkbox(:field => :bob)
-			expect(result).to be == %Q{<dd>\n\t<input type="hidden" name="bob" value="false"/>\n\t<label><input type="checkbox" name="bob" value="true" checked/> Bob</label>\n</dd>}
-		end
-		
-		it "should generate unchecked checkbox" do
-			attributes = formatter.checkbox_attributes_for(:value => false)
-			expect(attributes[:checked]).to be nil
-			
-			result = formatter.checkbox(:field => :dole)
-			expect(result).to be == %Q{<dd>\n\t<input type="hidden" name="dole" value="false"/>\n\t<label><input type="checkbox" name="dole" value="true"/> Dole</label>\n</dd>}
-		end
-	end
-	
-	describe '<input type="hidden">' do
-		let(:formatter) {FormFormatter.new(:object => double(age: 20))}
-		
-		it "should generate hidden field" do
-			result = formatter.hidden(:field => :age)
-			expect(result).to be == %Q{<input type="hidden" name="age" value="20"/>}
-		end
-		
-		it "should escape characters correctly" do
-			expect(formatter.object).to receive(:new_record?).and_return(false)
-			
-			result = formatter.submit
-			expect(result).to be == %Q{<input type="submit" value="Update"/>}
-		end
-		
-		it "can have custom title" do
-			result = formatter.submit(title: 'Alice')
-			expect(result).to be == %Q{<input type="submit" value="Alice"/>}
-		end
-	end
-	
-	describe '<input type="submit">' do
-		let(:new_record_formatter) {FormFormatter.new(:object => double(new_record?: true))}
-		let(:formatter) {FormFormatter.new(:object => double(new_record?: false))}
-		
-		it "should have correct title for new_record?" do
-			result = new_record_formatter.submit
-			expect(result).to be == %Q{<input type="submit" value="Create"/>}
-		end
-		
-		it "should escape characters correctly" do
-			result = formatter.submit
-			expect(result).to be == %Q{<input type="submit" value="Update"/>}
-		end
-		
-		it "can have custom title" do
-			result = formatter.submit(title: 'Alice')
-			expect(result).to be == %Q{<input type="submit" value="Alice"/>}
-		end
-	end
-	
-	describe "<textarea>" do
-		let(:formatter) {FormFormatter.new(:object => double(details: "foo<bar>"))}
-		
-		it "should escape characters correctly" do
-			result = formatter.textarea(:field => :details)
-			expect(result).to be == %Q{<dt>\n\tDetails\n</dt>\n<dd><textarea name=\"details\">foo&lt;bar&gt;</textarea></dd>}
-		end
-	end
-	
-	describe "<output>" do
-		let(:formatter) {FormFormatter.new(:object => double(bar: 10, bob: true, dole: false))}
-		
-		it "should show output value" do
-			result = formatter.output(:field => :bar)
-			expect(result).to be == %Q{<dt>Bar</dt>\n<dd><output name=\"bar\">10</output></dd>}
-		end
-		
-		it "should show output value" do
-			result = formatter.output(:name => :total)
-			expect(result).to be == %Q{<dt></dt>\n<dd><output name=\"total\"></output></dd>}
-		end
-	end
-	
-	describe "<button>" do
-		let(:formatter) {FormFormatter.new}
-		
-		it "should generate reset button" do
-			result = formatter.button(:type => :reset)
-			expect(result).to be == %Q{<button type="reset">Reset</button>}
-		end
-	end
-end

data/spec/trenni/formatters/html/option_select_spec.rb

@@ -1,129 +0,0 @@
-# Copyright, 2014, 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/formatters'
-require 'trenni/formatters/html/definition_list_form'
-require 'trenni/formatters/html/option_select'
-
-module Trenni::Formatters::HTML::OptionSelectSpec
-	class FormFormatter < Trenni::Formatters::Formatter
-		include Trenni::Formatters::HTML::DefinitionListForm
-		
-		def select(options = {}, &block)
-			element(Trenni::Formatters::HTML::OptionSelect, options, &block)
-		end
-	end
-	
-	def capture(&block)
-		_out = ""
-		
-		Trenni::Template.capture do
-			formatter.select :field => :bar do |select|
-				_out << select.item(:title => "A", :value => 0)
-				_out << select.item(:title => "B", :value => 10)
-			end
-		end
-	end
-	
-	describe Trenni::Formatters::HTML::OptionSelect do
-		let(:formatter) {FormFormatter.new(:object => double(:bar => 10))}
-		
-		it "should list items" do
-			_out = ""
-			
-			captured = Trenni::Template.capture do
-				formatter.select :field => :bar do |select|
-					_out << select.item(:title => "A", :value => 0)
-					_out << select.item(:title => "B", :value => 10)
-				end
-			end
-			
-			expect(captured).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<option value=\"0\">A</option><option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
-		end
-		
-		it "should list items with data attributes" do
-			_out = ""
-			
-			captured = Trenni::Template.capture do
-				formatter.select :field => :bar do |select|
-					_out << select.item(:title => "A", :value => 0, :data => {foo: 'bar'})
-				end
-			end
-			
-			expect(captured).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<option value=\"0\" data-foo=\"bar\">A</option>\n\t</select>\n</dd>"
-		end
-		
-		it "should list items for multiple selection" do
-			_out = ""
-			
-			captured = Trenni::Template.capture do
-				formatter.select :field => :bar, multiple: true do |select|
-					_out << select.item(:title => "A", :value => 0)
-					_out << select.item(:title => "B", :value => 10)
-				end
-			end
-			
-			expect(captured).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar[]\" multiple>\n\t\t<option value=\"0\">A</option><option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
-		end
-		
-		it "should add optional item" do
-			_out = ""
-			
-			captured = Trenni::Template.capture do
-				formatter.select :field => :bar, optional: true do |select|
-					_out << select.item(:title => "A", :value => 0)
-					_out << select.item(:title => "B", :value => 10)
-				end
-			end
-			
-			expect(captured).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<option></option>\t\t<option value=\"0\">A</option><option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
-		end
-		
-		it "should add optional item in group" do
-			_out = ""
-			
-			captured = Trenni::Template.capture do
-				formatter.select :field => :bar do |select|
-					select.group(title: 'group', optional: true) do
-						_out << select.item(:title => "A", :value => 0)
-					end
-					_out << select.item(:title => "B", :value => 10)
-				end
-			end
-			
-			expect(captured).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<optgroup label=\"group\">\n\t\t\t<option></option>\t\t\t<option value=\"0\">A</option>\n\t\t</optgroup>\t\t<option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
-		end
-		
-		it "should add a group" do
-			_out = ""
-			
-			captured = Trenni::Template.capture do
-				formatter.select :field => :bar do |select|
-					select.group(title: 'group') do
-						_out << select.item(:title => "A", :value => 0)
-					end
-					_out << select.item(:title => "B", :value => 10)
-				end
-			end
-			
-			expect(captured).to be == "<dt>Bar</dt>\n<dd>\n\t<select name=\"bar\">\n\t\t<optgroup label=\"group\">\n\t\t\t<option value=\"0\">A</option>\n\t\t</optgroup>\t\t<option value=\"10\" selected>B</option>\n\t</select>\n</dd>"
-		end
-	end
-end