trenni-formatters 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 54e55baacc3ffd8e0fd529f9261d3d953c8500df
-  data.tar.gz: 5750df51c9534a3794af5a596ef54861c8d234b3
+SHA256:
+  metadata.gz: d037e40cc445eb738842fe5d21e393b3b9166a4cd0cc16f663a68d89748029c3
+  data.tar.gz: 971da30b39aa8c5bfb40d2838ef09083abb25ff054e6ab8d4dfc63b405a5d2dc
 SHA512:
-  metadata.gz: dd169596c9742758211f18b22c7a207fc746094f774113ec982d372537d377b73443c3b9bea017eaa52d1f1cae6b919ffaf0210252a64dcd8becc8f1cc9a6f78
-  data.tar.gz: fc24cb66fb14cb62a0505de3594cc0b31c2a9ff339459ca1554a52b74589d507809a81baa4ca19c1b2b7f621ae311d296204f441be58135e3b8a915fa0736ab8
+  metadata.gz: dab2480c97459bbb95ec16b6c68a006d6cf513ad3888f0484d38b2136a0ea8c62eb948692ecc8d573a98a4030e96365b3b6dfef3fd9aab7229eb7bddffdeef26
+  data.tar.gz: af3b1cf1cb56ae17c96c1ba08b3975c6667a30b4e303a61453132fb5bf977b630eca7ea9224e5b45fd1e75d096705f7908d233ea8a22d600d9802711d60a3568

data/.travis.yml

@@ -1,14 +1,8 @@
 language: ruby
-sudo: false
+
 rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - 2.4.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
-  - rbx-2
-env: COVERAGE=true
-matrix:
-  allow_failures:
-    - rvm: "rbx-2"
-    - rvm: "ruby-head"

data/lib/trenni/formatters/formatter.rb

@@ -25,12 +25,54 @@ require 'mapping/descendants'
 module Trenni
 	module Formatters
 		class Formatter < Mapping::Model
-			def initialize(options = {})
+			def self.for(object, **options)
+				self.new(object: object, **options)
+			end
+			
+			def initialize(**options)
 				@options = options
 			end
 			
+			# The target object of the form.
+			def object
+				@object ||= @options[:object]
+			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 = options[:nested_name]
+					"#{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

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

@@ -36,14 +36,14 @@ module Trenni
 					Builder.fragment do |builder|
 						builder.inline(:dt) do
 							builder.text title_for(options)
-							
-							if details = details_for(options)
-								builder.inline(:small) { builder.text details }
-							end
 						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
@@ -72,7 +72,7 @@ module Trenni
 								builder.text title_for(options)
 								
 								if details = details_for(options)
-									builder.inline(:small) { builder.text details }
+									builder.inline(:small, class: 'details') { builder.text details }
 								end
 						end
 
@@ -91,11 +91,16 @@ module Trenni
 					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
@@ -117,14 +122,14 @@ module Trenni
 					buffer << Builder.fragment do |builder|
 						builder.inline(:dt) do
 							builder.text title_for(options)
-							
-							if details = details_for(options)
-								builder.inline(:small) { builder.text details }
-							end
 						end
 						
 						builder.tag(:dd) do
 							klass.call(self, options, builder, &block)
+							
+							if details = details_for(options)
+								builder.inline(:small, class: 'details') { builder.text details }
+							end
 						end
 					end
 				end

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

@@ -24,11 +24,6 @@ module Trenni
 	module Formatters
 		module HTML
 			module FormFormatter
-				# The target object of the form.
-				def object
-					@object ||= @options[:object]
-				end
-
 				# Return true if the object is begin created or false if it is being updated.
 				def new_record?
 					object.new_record?
@@ -39,11 +34,6 @@ module Trenni
 					options[:details]
 				end
 				
-				# The name of the field, used for the name attribute of an input.
-				def name_for(options)
-					options[:name] || options[:field]
-				end
-				
 				def field_for(options)
 					options[:field]
 				end

data/lib/trenni/formatters/truncated_text.rb

@@ -27,24 +27,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

@@ -20,6 +20,6 @@
 
 module Trenni
 	module Formatters
-		VERSION = "2.7.0"
+		VERSION = "2.8.0"
 	end
 end

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

@@ -27,7 +27,7 @@ module Trenni::Formatters::FormFormatterSpec
 	end
 	
 	describe Trenni::Formatters do
-		let(:formatter) {FormFormatter.new(:object => double(:bar => 10))}
+		let(:formatter) {FormFormatter.for(double(bar: 10))}
 		
 		it "should generate form" do
 			result = formatter.input(:field => :bar)
@@ -43,6 +43,27 @@ module Trenni::Formatters::FormFormatterSpec
 			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

data/trenni-formatters.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 	spec.add_dependency "trenni", "~> 3.4"
 	spec.add_dependency "mapping", "~> 1.1"
 	
-	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rspec", "~> 3.4"
 	spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni-formatters
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -42,16 +42,16 @@ dependencies:
   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
   requirement: !ruby/object:Gem::Requirement
@@ -133,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Formatters for Trenni, to assist with typical views and form based interfaces.