trenni-formatters 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1036d2369c3b3bde480f8bad87942960ba4a7b22
-  data.tar.gz: e7d467c11f019cc49ae0e23a3383548d8673bcfc
+  metadata.gz: 5e2814d2a4811d2a066fd96b9cc0c9bc78f7dbe4
+  data.tar.gz: 525e508d5b65000040c12b3c09b5452c2f899ef3
 SHA512:
-  metadata.gz: f7cc27f561472dd8c22148278484a73e58331a7efec5b13bd09cd0548b78bb93f56a0def9abdf632e5d790567c0dac6159d6280a0cd5fbf2bc3ccc92eecc664a
-  data.tar.gz: 1cfd277dafd6b61868df9893595c921a5de35eccbeb357f6e7b0947f276bbdb94c4ca804ab7b61df64d3f46118a99ff88b3e714f882c48517dcbe5535d04849a
+  metadata.gz: 5fbaeb44cb3ad9a3d6f3b499043f2a8e2703b03dd59b998349423384e32be1c927a89d2ec662f13edfe5eeb3f5e2621160231df9d32ae82aa506e0ab118a7c41
+  data.tar.gz: 1fe8760cbe647bc9ab1266666bdde4bc6e6b771f86bfc874af30b29cab7d3b4f1815610612b3e9222c2f007434ff0d3fb84832b03b54395f20d54e524ac7d41b

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.1.8
   - 2.2.4
   - 2.3.0
+  - 2.4.0
   - ruby-head
   - rbx-2
 env: COVERAGE=true

data/Gemfile

@@ -4,6 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+	gem 'sanitize'
+	gem 'kramdown'
+	
 	gem 'simplecov'
 	gem 'coveralls', require: false
 end

data/lib/trenni/formatters/{format/markdown.rb → markdown.rb}

@@ -21,14 +21,20 @@
 require 'sanitize'
 require 'kramdown'
 
-module Trenni::Formatters::Format
-	module Markdown
-		def markdown(text)
-			config = Sanitize::Config::BASIC.dup
-			
-			config[:elements] += ['h1', 'h2', 'h3']
-			
-			Sanitize.clean(Kramdown::Document.new(text).to_html, config)
+require 'trenni/markup'
+
+module Trenni
+	module Formatters
+		module Markdown
+			def markdown(text)
+				config = Sanitize::Config::BASIC.dup
+				
+				config[:elements] += ['h1', 'h2', 'h3']
+				
+				html = Sanitize.clean(Kramdown::Document.new(text).to_html, config)
+				
+				return MarkupString.raw(html)
+			end
 		end
 	end
 end

data/lib/trenni/formatters/{format/time.rb → relative_time.rb}

@@ -21,19 +21,21 @@
 require 'trenni/strings'
 require 'mapping/model'
 
-module Trenni::Formatters::Format
-	module Time
-		def included(base)
-			base.map(Time) do |object, options|
-				# Ensure we display the time in localtime, and show the year if it is different:
-				if object.localtime.year != Time.now.year
-					object.localtime.strftime("%B %-d, %-l:%M%P, %Y")
-				else
-					object.localtime.strftime("%B %-d, %-l:%M%P")
+module Trenni
+	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
 end
-

data/lib/trenni/formatters/{format/text.rb → truncated_text.rb}

@@ -21,30 +21,32 @@
 require 'trenni/strings'
 require 'mapping/model'
 
-module Trenni::Formatters::Format
-	module Text
-		def truncated_text(content, options = {}, &block)
-			if content
-				length  = options.fetch(:length, 30)
+module Trenni
+	module Formatters
+		module TruncatedText
+			def truncated_text(content, options = {})
+				if content
+					length  = options.fetch(:length, 30)
 
-				content = self.class.truncate_text(content, length, options)
-				
-				return self.format(content)
+					content = TruncatedText.truncate_text(content, length, options)
+					
+					return self.format(content)
+				end
 			end
-		end
 
-		def self.truncate_text(text, truncate_at, options = {})
-			return text.dup unless text.length > truncate_at
+			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
+				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[0...stop]}#{options[:omission]}"
+				"#{text[0...stop]}#{options[:omission]}"
+			end
 		end
 	end
 end

data/lib/trenni/formatters/version.rb

@@ -20,6 +20,6 @@
 
 module Trenni
 	module Formatters
-		VERSION = "2.1.1"
+		VERSION = "2.2.0"
 	end
 end

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

@@ -43,7 +43,7 @@ module Trenni::Formatters::HTML::RadioSelectSpec
 				end
 			end
 			
-			expect(captured).to be == %Q{<dt>Bar</dt>\n<dd>\n\t<table>\n\t\t<tbody>\n\t\t\t<tr>\n\t\t\t\t<td class="handle"><input type="radio" name="bar" value="0"/></td>\n\t\t\t\t<td class="item">A</td>\n\t\t\t</tr><tr>\n\t\t\t\t<td class="handle"><input type="radio" name="bar" value="10"/></td>\n\t\t\t\t<td class="item">B</td>\n\t\t\t</tr>\n\t\t</tbody>\n\t</table>\n</dd>}
+			expect(captured).to be == %Q{<dt>Bar</dt>\n<dd>\n\t<table>\n\t\t<tbody>\n\t\t\t<tr>\n\t\t\t\t<td class="handle"><input type="radio" name="bar" value="0"/></td>\n\t\t\t\t<td class="item">A</td>\n\t\t\t</tr><tr>\n\t\t\t\t<td class="handle"><input type="radio" name="bar" value="10" checked/></td>\n\t\t\t\t<td class="item">B</td>\n\t\t\t</tr>\n\t\t</tbody>\n\t</table>\n</dd>}
 		end
 	end
 end

data/spec/trenni/formatters/markdown_spec.rb

@@ -0,0 +1,34 @@
+# Copyright, 2017, 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/formatter'
+require 'trenni/formatters/markdown'
+
+describe Trenni::Formatters::Markdown do
+	subject {Class.new(Trenni::Formatters::Formatter).include(Trenni::Formatters::Markdown).new}
+	
+	let(:sample_text) {"# Heading\n\nParagraph\n"}
+	
+	it "should format markdown" do
+		result = subject.markdown(sample_text)
+		
+		expect(result).to include('<h1>', '<p>')
+	end
+end

data/spec/trenni/formatters/relative_time_spec.rb

@@ -0,0 +1,38 @@
+# Copyright, 2017, 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/formatter'
+require 'trenni/formatters/relative_time'
+
+describe Trenni::Formatters::RelativeTime do
+	subject {Class.new(Trenni::Formatters::Formatter).include(Trenni::Formatters::RelativeTime).new}
+	
+	let(:now) {Time.now}
+	let(:time_this_year) {Time.mktime(now.year, 1, 1)}
+	let(:time_last_year) {Time.mktime(now.year - 1, 1, 1)}
+	
+	it "should format without year" do
+		expect(subject.format(time_this_year, current_time: now)).to be == "January 1, 12:00am"
+	end
+	
+	it "should format with year" do
+		expect(subject.format(time_last_year, current_time: now)).to be == "January 1, 12:00am, #{time_last_year.year}"
+	end
+end

data/spec/trenni/formatters/truncated_text_spec.rb

@@ -0,0 +1,32 @@
+# Copyright, 2017, 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/formatter'
+require 'trenni/formatters/truncated_text'
+
+describe Trenni::Formatters::TruncatedText do
+	subject {Class.new(Trenni::Formatters::Formatter).include(Trenni::Formatters::TruncatedText).new}
+	
+	let(:sample_text) {"The quick brown fox jumped over the lazy dog!"}
+	
+	it "should truncate text" do
+		expect(subject.truncated_text(sample_text)).to be == "The quick brown fox jumped ..."
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni-formatters
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-13 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -98,19 +98,22 @@ files:
 - README.md
 - Rakefile
 - lib/trenni/formatters.rb
-- lib/trenni/formatters/format/markdown.rb
-- lib/trenni/formatters/format/text.rb
-- lib/trenni/formatters/format/time.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/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: []
@@ -140,3 +143,6 @@ test_files:
 - 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