http-accept 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 326c4ed19982fc140d5b4d9c691b99333f12e679
-  data.tar.gz: 5bacffff48f9a58e8eca3fb045591ef35d787398
+  metadata.gz: ce16687c7850ca9d1dd0be4c680adb9b97ee4da6
+  data.tar.gz: d499d0388301d0a70af43c4c1a6cb434c20ec603
 SHA512:
-  metadata.gz: fff4f229ca636f688d921a81f8f62fa585eda081680827dea0a63ade5f834c9620438afdbff51301619417ce3da5dcffe12a46cad9a40d57305bbe1f999e73a7
-  data.tar.gz: 3b11ffa81002bac08ab011ad45a41ce598b3254d56c690951405901d0514bb337dd5fcfbf834e23665a2ca9f771e61616da44aaa9be999f966c51093810bdcf0
+  metadata.gz: 222edb80960c3dbee1d005edff20f74397ed570bf78f96a23630a6755aecc78918fcff1710d8a5b592b8061629951841c8affcd111d790145667a5a18f2ff6b4
+  data.tar.gz: 16dc4e102473806c8b00b24ec29a246f9009d61681a09847d328e81bab6125d1376a3db913b58700f894d04d626c522c39d4795182093fba1fa1d2c23a8ea2db

data/.rspec

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

data/README.md

@@ -52,6 +52,11 @@ Normally, you'd want to match the media types against some set of available mime
 			HTTP::Accept::ContentType.new("application/json", charset: 'utf-8')
 		end
 		
+		# Used for inserting into map.
+		def split(*args)
+			content_type.split(*args)
+		end
+		
 		def convert(object, options)
 			object.to_json
 		end

data/lib/http/accept/media_types.rb

@@ -24,58 +24,17 @@ require_relative 'parse_error'
 require_relative 'quoted_string'
 require_relative 'sort'
 
+require_relative 'media_types/map'
+
 module HTTP
 	module Accept
+		# Parse and process the HTTP Accept: header.
 		module MediaTypes
 			# According to https://tools.ietf.org/html/rfc7231#section-5.3.2
 			MIME_TYPE = /(#{TOKEN})\/(#{TOKEN})/
 			PARAMETER = /\s*;\s*(?<key>#{TOKEN})=((?<value>#{TOKEN})|(?<quoted_value>#{QUOTED_STRING}))/
 			
-			# Map a set of mime types to objects.
-			class Map
-				WILDCARD = "*/*".freeze
-				
-				def initialize
-					@media_types = {}
-				end
-				
-				def freeze
-					unless frozen?
-						@media_types.freeze
-						@media_types.each{|key,value| value.freeze}
-						
-						super
-					end
-				end
-				
-				# Given a list of content types (e.g. from browser_preferred_content_types), return the best converter.
-				def for(media_types)
-					media_types.each do |media_range|
-						mime_type = case media_range
-							when String then media_range
-							else media_range.mime_type
-						end
-						
-						if object = @media_types[mime_type]
-							return object, media_range
-						end
-					end
-					
-					return nil
-				end
-				
-				# Add a converter to the collection. A converter can be anything that responds to #content_type.
-				def << object
-					type, subtype = object.content_type.split('/')
-					
-					@media_types[WILDCARD] = object if @media_types.empty?
-					@media_types["#{type}/*"] ||= object
-					@media_types["#{type}/#{subtype}"] ||= object
-					
-					return self
-				end
-			end
-			
+			# A single entry in the Accept: header, which includes a mime type and associated parameters.
 			MediaRange = Struct.new(:mime_type, :parameters) do
 				def parameters_string
 					return '' if parameters == nil or parameters.empty?
@@ -94,7 +53,7 @@ module HTTP
 				end
 				
 				def to_s
-					@to_s || "#{mime_type}#{parameters_string}"
+					"#{mime_type}#{parameters_string}"
 				end
 				
 				alias to_str to_s
@@ -151,7 +110,7 @@ module HTTP
 			HTTP_ACCEPT = 'HTTP_ACCEPT'.freeze
 			WILDCARD_MEDIA_RANGE = MediaRange.new("*/*", {}).freeze
 			
-			# Parse the list of browser preferred content types and return ordered by priority. If no `Accept:` header is specified, the behaviour is the same as if `Accept: */*` was provided.
+			# Parse the list of browser preferred content types and return ordered by priority. If no `Accept:` header is specified, the behaviour is the same as if `Accept: */*` was provided (according to RFC).
 			def self.browser_preferred_media_types(env)
 				if accept_content_types = env[HTTP_ACCEPT]
 					accept_content_types.strip!

data/lib/http/accept/media_types/map.rb

@@ -0,0 +1,86 @@
+# Copyright, 2016, 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.
+
+module HTTP
+	module Accept
+		module MediaTypes
+			# Map a set of mime types to objects.
+			class Map
+				WILDCARD = "*/*".freeze
+				
+				def initialize
+					@media_types = {}
+				end
+				
+				def freeze
+					unless frozen?
+						@media_types.freeze
+						@media_types.each{|key,value| value.freeze}
+						
+						super
+					end
+				end
+				
+				# Given a list of content types (e.g. from browser_preferred_content_types), return the best converter. Media types can be an array of MediaRange or String values.
+				def for(media_types)
+					media_types.each do |media_range|
+						mime_type = case media_range
+							when String then media_range
+							else media_range.mime_type
+						end
+						
+						if object = @media_types[mime_type]
+							return object, media_range
+						end
+					end
+					
+					return nil
+				end
+				
+				def []= media_range, object
+					@media_types[media_range] = object
+				end
+				
+				def [] media_range
+					@media_types[media_range]
+				end
+				
+				# Add a converter to the collection. A converter can be anything that responds to #content_type. Objects will be considered in the order they are added, subsequent objects cannot override previously defined media types. `object` must respond to #split('/', 2) which should give the type and subtype.
+				def << object
+					type, subtype = object.split('/', 2)
+					
+					# We set the default if not specified already:
+					@media_types[WILDCARD] = object if @media_types.empty?
+					
+					if type != '*'
+						@media_types["#{type}/*"] ||= object
+						
+						if subtype != '*'
+							@media_types["#{type}/#{subtype}"] ||= object
+						end
+					end
+					
+					return self
+				end
+			end
+		end
+	end
+end
+

data/lib/http/accept/sort.rb

@@ -21,6 +21,7 @@
 module HTTP
 	module Accept
 		module Sort
+			# This sorts items with higher priority first, and keeps items with the same priority in the same relative order.
 			def self.by_quality_factor(items)
 				# We do this to get a stable sort:
 				items.sort_by.with_index{|object, index| [-object.quality_factor, index]}

data/lib/http/accept/version.rb

@@ -20,6 +20,6 @@
 
 module HTTP
 	module Accept
-		VERSION = "1.3.0"
+		VERSION = "1.4.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-accept
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - lib/http/accept/content_type.rb
 - lib/http/accept/languages.rb
 - lib/http/accept/media_types.rb
+- lib/http/accept/media_types/map.rb
 - lib/http/accept/parse_error.rb
 - lib/http/accept/quoted_string.rb
 - lib/http/accept/sort.rb