webmachine 1.6.0 → 2.0.0.beta

data/lib/webmachine/decision/conneg.rb

@@ -14,7 +14,7 @@ module Webmachine
       # appropriate media type.
       # @api private
       def choose_media_type(provided, header)
-        types = Array(header).map{|h| h.split(SPLIT_COMMA) }.flatten
+        types = Array(header).map { |h| h.split(SPLIT_COMMA) }.flatten
         requested = MediaTypeList.build(types)
         provided = provided.map do |p| # normalize_provided
           MediaType.parse(p)
@@ -43,7 +43,7 @@ module Webmachine
       # @api private
       def choose_charset(provided, header)
         if provided && !provided.empty?
-          charsets = provided.map {|c| c.first }
+          charsets = provided.map { |c| c.first }
           if charset = do_choose(charsets, header, HAS_ENCODING ? Encoding.default_external.name : kcode_charset)
             metadata[CHARSET] = charset
           end
@@ -62,17 +62,17 @@ module Webmachine
           any_ok = star_priority && star_priority > 0.0
           accepted = requested.find do |priority, range|
             if priority == 0.0
-              provided.delete_if {|tag| language_match(range, tag) }
+              provided.delete_if { |tag| language_match(range, tag) }
               false
             else
-              provided.any? {|tag| language_match(range, tag) }
+              provided.any? { |tag| language_match(range, tag) }
             end
           end
           chosen = if accepted
-                     provided.find {|tag| language_match(accepted.last, tag) }
-                   elsif any_ok
-                     provided.first
-                   end
+            provided.find { |tag| language_match(accepted.last, tag) }
+          elsif any_ok
+            provided.first
+          end
           if chosen
             metadata['Language'] = chosen
             response.headers['Content-Language'] = chosen
@@ -91,14 +91,14 @@ module Webmachine
       # is "-".
       # @api private
       def language_match(range, tag)
-        range.downcase == tag.downcase || tag =~ /^#{Regexp.escape(range)}\-/i
+        range.downcase == tag.downcase || tag =~ /^#{Regexp.escape(range)}-/i
       end
 
       # Makes an conneg choice based what is accepted and what is
       # provided.
       # @api private
       def do_choose(choices, header, default)
-        choices = choices.dup.map {|s| s.downcase }
+        choices = choices.dup.map { |s| s.downcase }
         accepted = PriorityList.build(header.split(SPLIT_COMMA))
         default_priority = accepted.priority_of(default)
         star_priority = accepted.priority_of(STAR)
@@ -112,12 +112,13 @@ module Webmachine
             choices.include?(acceptable.downcase)
           end
         end
-        (chosen && chosen.last) ||  # Use the matching one
+        chosen&.last ||  # Use the matching one
           (any_ok && choices.first) || # Or first if "*"
           (default_ok && choices.include?(default) && default) # Or default
       end
 
       private
+
       # Matches acceptable items that include 'q' values
       CONNEG_REGEX = /^\s*(\S+);\s*q=(\S*)\s*$/.freeze
 
@@ -138,13 +139,13 @@ module Webmachine
       def kcode_charset
         case $KCODE
         when /^U/i
-          "UTF-8"
+          'UTF-8'
         when /^S/i
-          "Shift-JIS"
+          'Shift-JIS'
         when /^B/i
-          "Big5"
-        else #when /^A/i, nil
-          "ASCII"
+          'Big5'
+        else # when /^A/i, nil
+          'ASCII'
         end
       end
 
@@ -157,7 +158,7 @@ module Webmachine
         # Given an acceptance list, create a PriorityList from them.
         def self.build(list)
           new.tap do |plist|
-            list.each {|item| plist.add_header_val(item) }
+            list.each { |item| plist.add_header_val(item) }
           end
         end
 
@@ -166,7 +167,7 @@ module Webmachine
         # Creates a {PriorityList}.
         # @see PriorityList::build
         def initialize
-          @hash = Hash.new {|h,k| h[k] = [] }
+          @hash = Hash.new { |h, k| h[k] = [] }
           @index = {}
         end
 
@@ -185,8 +186,8 @@ module Webmachine
         def add_header_val(c)
           if c =~ CONNEG_REGEX
             choice, q = $1, $2
-            q = "0" << q if q =~ /^\./ # handle strange FeedBurner Accept
-            add(q.to_f,choice)
+            q = '0' << q if /^\./.match?(q) # handle strange FeedBurner Accept
+            add(q.to_f, choice)
           else
             add(1.0, c)
           end
@@ -212,8 +213,8 @@ module Webmachine
         # @yieldparam [Float] q the acceptable item's priority
         # @yieldparam [String] v the acceptable item
         def each
-          @hash.to_a.sort.reverse_each do |q,l|
-            l.each {|v| yield q, v }
+          @hash.to_a.sort.reverse_each do |q, l|
+            l.each { |v| yield q, v }
           end
         end
       end
@@ -232,10 +233,9 @@ module Webmachine
           q = mt.params.delete('q') || 1.0
           add(q.to_f, mt)
         rescue ArgumentError
-          raise MalformedRequest, t('invalid_media_type', :type => c)
+          raise MalformedRequest, t('invalid_media_type', type: c)
         end
       end
-
     end # module Conneg
   end # module Decision
 end # module Webmachine

data/lib/webmachine/decision/falsey.rb

@@ -7,4 +7,3 @@ module Webmachine
     end
   end
 end
-

data/lib/webmachine/decision/flow.rb

@@ -64,7 +64,7 @@ module Webmachine
         if resource.allowed_methods.include?(request.method)
           :b9
         else
-          response.headers["Allow"] = resource.allowed_methods.join(", ")
+          response.headers['Allow'] = resource.allowed_methods.join(', ')
           405
         end
       end
@@ -82,13 +82,13 @@ module Webmachine
         when true
           :b9b
         when false
-          response.body = "Content-MD5 header does not match request body."
+          response.body = 'Content-MD5 header does not match request body.'
           400
         else # not_validated
           if decode64(request.content_md5) == Digest::MD5.hexdigest(request.body)
             :b9b
           else
-            response.body = "Content-MD5 header does not match request body."
+            response.body = 'Content-MD5 header does not match request body.'
             400
           end
         end
@@ -123,7 +123,7 @@ module Webmachine
       CONTENT = /content-/.freeze
       # Okay Content-* Headers?
       def b6
-        decision_test(resource.valid_content_headers?(request.headers.grep(CONTENT)), :b5,  501)
+        decision_test(resource.valid_content_headers?(request.headers.grep(CONTENT)), :b5, 501)
       end
 
       # Known Content-Type?
@@ -158,7 +158,7 @@ module Webmachine
 
       # Acceptable media type available?
       def c4
-        types = resource.content_types_provided.map {|pair| pair.first }
+        types = resource.content_types_provided.map { |pair| pair.first }
         chosen_type = choose_media_type(types, request.accept)
         if !chosen_type
           406
@@ -215,7 +215,7 @@ module Webmachine
         end
         response.headers[CONTENT_TYPE] = chosen_type.to_s
         if !request.accept_encoding
-          choose_encoding(resource.encodings_provided, "identity;q=1.0,*;q=0.5") ? :g7 : 406
+          choose_encoding(resource.encodings_provided, 'identity;q=1.0,*;q=0.5') ? :g7 : 406
         else
           :f7
         end
@@ -229,7 +229,7 @@ module Webmachine
       # Resource exists?
       def g7
         # This is the first place after all conneg, so set Vary here
-        response.headers['Vary'] =  variances.join(", ") if variances.any?
+        response.headers['Vary'] = variances.join(', ') if variances.any?
         decision_test(resource.resource_exists?, :g8, :h7)
       end
 
@@ -240,12 +240,12 @@ module Webmachine
 
       # If-Match: * exists?
       def g9
-        quote(request.if_match) == '"*"' ? :h10 : :g11
+        (quote(request.if_match) == '"*"') ? :h10 : :g11
       end
 
       # ETag in If-Match
       def g11
-        request_etags = request.if_match.split(SPLIT_COMMA).map {|etag| ETag.new(etag) }
+        request_etags = request.if_match.split(SPLIT_COMMA).map { |etag| ETag.new(etag) }
         request_etags.include?(ETag.new(resource.generate_etag)) ? :h10 : 412
       end
 
@@ -271,7 +271,7 @@ module Webmachine
 
       # Last-Modified > I-UM-S?
       def h12
-        resource.last_modified > metadata['If-Unmodified-Since'] ? 412 : :i12
+        (resource.last_modified > metadata['If-Unmodified-Since']) ? 412 : :i12
       end
 
       # Moved permanently? (apply PUT to different URI)
@@ -299,7 +299,7 @@ module Webmachine
 
       # If-none-match: * exists?
       def i13
-        quote(request.if_none_match) == '"*"' ? :j18 : :k13
+        (quote(request.if_none_match) == '"*"') ? :j18 : :k13
       end
 
       # GET or HEAD?
@@ -327,10 +327,10 @@ module Webmachine
 
       # Etag in if-none-match?
       def k13
-        request_etags = request.if_none_match.split(SPLIT_COMMA).map {|etag| ETag.new(etag) }
+        request_etags = request.if_none_match.split(SPLIT_COMMA).map { |etag| ETag.new(etag) }
         resource_etag = resource.generate_etag
         if resource_etag && request_etags.include?(ETag.new(resource_etag))
-           :j18
+          :j18
         else
           :l13
         end
@@ -371,12 +371,12 @@ module Webmachine
 
       # IMS > Now?
       def l15
-        metadata['If-Modified-Since'] > Time.now ? :m16 : :l17
+        (metadata['If-Modified-Since'] > Time.now) ? :m16 : :l17
       end
 
       # Last-Modified > IMS?
       def l17
-        resource.last_modified.nil? || resource.last_modified > metadata['If-Modified-Since'] ? :m16 : 304
+        (resource.last_modified.nil? || resource.last_modified > metadata['If-Modified-Since']) ? :m16 : 304
       end
 
       # POST?
@@ -415,7 +415,7 @@ module Webmachine
         if resource.post_is_create?
           case uri = resource.create_path
           when nil
-            raise InvalidResource, t('create_path_nil', :class => resource.class)
+            raise InvalidResource, t('create_path_nil', class: resource.class)
           when URI, String
             base_uri = resource.base_uri || request.base_uri
             new_uri = URI.join(base_uri.to_s, uri)
@@ -431,7 +431,7 @@ module Webmachine
           when Integer
             return result
           else
-            raise InvalidResource, t('process_post_invalid', :result => result.inspect)
+            raise InvalidResource, t('process_post_invalid', result: result.inspect)
           end
         end
         if response.is_redirect?
@@ -471,7 +471,7 @@ module Webmachine
         if request.get? || request.head?
           add_caching_headers
           content_type = metadata[CONTENT_TYPE]
-          handler = resource.content_types_provided.find {|ct, _| content_type.type_matches?(MediaType.parse(ct)) }.last
+          handler = resource.content_types_provided.find { |ct, _| content_type.type_matches?(MediaType.parse(ct)) }.last
           result = resource.send(handler)
           if Integer === result
             result
@@ -507,9 +507,8 @@ module Webmachine
 
       # New resource?
       def p11
-        !response.headers[LOCATION] ? :o20 : 201
+        (!response.headers[LOCATION]) ? :o20 : 201
       end
-
     end # module Flow
   end # module Decision
 end # module Webmachine

data/lib/webmachine/decision/fsm.rb

@@ -36,11 +36,11 @@ module Webmachine
           when Symbol # Next state
             state = result
           else # You bwoke it
-            raise InvalidResource, t('fsm_broke', :state => state, :result => result.inspect)
+            raise InvalidResource, t('fsm_broke', state: state, result: result.inspect)
           end
         end
       rescue => e
-        Webmachine.render_error(500, request, response, :message => e.message)
+        Webmachine.render_error(500, request, response, message: e.message)
       ensure
         trace_response(response)
       end
@@ -53,11 +53,11 @@ module Webmachine
         resource.handle_exception(e)
         500
       rescue MalformedRequest => e
-        Webmachine.render_error(400, request, response, :message => e.message)
+        Webmachine.render_error(400, request, response, message: e.message)
         400
       end
 
-      def respond(code, headers={})
+      def respond(code, headers = {})
         response.code = code
         response.headers.merge!(headers)
         case code

data/lib/webmachine/decision/helpers.rb

@@ -31,24 +31,24 @@ module Webmachine
         body = response.body
         chosen_charset = metadata[CHARSET]
         chosen_encoding = metadata[CONTENT_ENCODING]
-        charsetter = resource.charsets_provided && resource.charsets_provided.find {|c,_| c == chosen_charset }.last || :charset_nop
+        charsetter = resource.charsets_provided&.find { |c, _| c == chosen_charset }&.last || :charset_nop
         encoder = resource.encodings_provided[chosen_encoding]
         response.body = case body
-                        when String # 1.8 treats Strings as Enumerable
-                          resource.send(encoder, resource.send(charsetter, body))
-                        when IO, StringIO
-                          IOEncoder.new(resource, encoder, charsetter, body)
-                        when Fiber
-                          FiberEncoder.new(resource, encoder, charsetter, body)
-                        when Enumerable
-                          EnumerableEncoder.new(resource, encoder, charsetter, body)
-                        else
-                          if body.respond_to?(:call)
-                            CallableEncoder.new(resource, encoder, charsetter, body)
-                          else
-                            resource.send(encoder, resource.send(charsetter, body))
-                          end
-                        end
+        when String # 1.8 treats Strings as Enumerable
+          resource.send(encoder, resource.send(charsetter, body))
+        when IO, StringIO
+          IOEncoder.new(resource, encoder, charsetter, body)
+        when Fiber
+          FiberEncoder.new(resource, encoder, charsetter, body)
+        when Enumerable
+          EnumerableEncoder.new(resource, encoder, charsetter, body)
+        else
+          if body.respond_to?(:call)
+            CallableEncoder.new(resource, encoder, charsetter, body)
+          else
+            resource.send(encoder, resource.send(charsetter, body))
+          end
+        end
         if body_is_fixed_length?
           ensure_content_length(response)
         else
@@ -60,7 +60,7 @@ module Webmachine
       # Assists in receiving request bodies
       def accept_helper
         content_type = MediaType.parse(request.content_type || 'application/octet-stream')
-        acceptable = resource.content_types_accepted.find {|ct, _| content_type.match?(ct) }
+        acceptable = resource.content_types_accepted.find { |ct, _| content_type.match?(ct) }
         if acceptable
           resource.send(acceptable.last)
         else
@@ -71,10 +71,10 @@ module Webmachine
       # Computes the entries for the 'Vary' response header
       def variances
         resource.variances.tap do |v|
-          v.unshift "Accept-Language" if resource.languages_provided.size > 1
-          v.unshift "Accept-Charset" if resource.charsets_provided && resource.charsets_provided.size > 1
-          v.unshift "Accept-Encoding" if resource.encodings_provided.size > 1
-          v.unshift "Accept" if resource.content_types_provided.size > 1
+          v.unshift 'Accept-Language' if resource.languages_provided.size > 1
+          v.unshift 'Accept-Charset' if resource.charsets_provided && resource.charsets_provided.size > 1
+          v.unshift 'Accept-Encoding' if resource.encodings_provided.size > 1
+          v.unshift 'Accept' if resource.content_types_provided.size > 1
         end
       end
 

data/lib/webmachine/dispatcher/route.rb

@@ -28,6 +28,21 @@ module Webmachine
       # String version of MATCH_ALL, deprecated. Use the symbol instead.
       MATCH_ALL_STR = '*'.freeze
 
+      # Decode a string using the scheme described in RFC 3986 2.1. Percent-Encoding (https://www.ietf.org/rfc/rfc3986.txt)
+      def self.rfc3986_percent_decode(value)
+        s = StringScanner.new(value)
+        result = ''
+        until s.eos?
+          encoded_val = s.scan(/%([0-9a-fA-F]){2}/)
+          result << if encoded_val.nil?
+            s.getch
+          else
+            [encoded_val[1..-1]].pack('H*')
+          end
+        end
+        result
+      end
+
       # Creates a new Route that will associate a pattern to a
       # {Resource}.
       #
@@ -58,25 +73,25 @@ module Webmachine
       #   @yield [req] an optional guard block
       #   @yieldparam [Request] req the request object
       # @see Dispatcher#add_route
-      def initialize(path_spec, *args)
-        if args.last.is_a? Hash
-          bindings = args.pop
+      def initialize(path_spec, *args, &block)
+        bindings = if args.last.is_a? Hash
+          args.pop
         else
-          bindings = {}
+          {}
         end
 
         resource = args.pop
         guards = args
-        guards << Proc.new if block_given?
+        guards << block if block
 
         warn t('match_all_symbol') if path_spec.include? MATCH_ALL_STR
 
         @path_spec = path_spec
-        @guards    = guards
-        @resource  = resource
-        @bindings  =  bindings
+        @guards = guards
+        @resource = resource
+        @bindings = bindings
 
-        raise ArgumentError, t('not_resource_class', :class => resource.name) unless resource < Resource
+        raise ArgumentError, t('not_resource_class', class: resource.name) unless resource < Resource
       end
 
       # Determines whether the given request matches this route and
@@ -94,11 +109,12 @@ module Webmachine
         request.disp_path = request.routing_tokens.join(SLASH)
         request.path_info = @bindings.dup
         tokens = request.routing_tokens
-        depth, trailing = bind(tokens, request.path_info)
+        _depth, trailing = bind(tokens, request.path_info)
         request.path_tokens = trailing || []
       end
 
       private
+
       # Attempts to match the path spec against the path tokens, while
       # accumulating variable bindings.
       # @param [Array<String>] tokens the list of path segments
@@ -125,9 +141,8 @@ module Webmachine
               if spec.first.named_captures.empty?
                 bindings[:captures] = (bindings[:captures] || []) + matches.captures
               else
-                spec.first.named_captures.reduce(bindings) do |bindings, (name, idxs)|
-                  bindings[name.to_sym] = matches.captures[idxs.first-1]
-                  bindings
+                spec.first.named_captures.each_with_object(bindings) do |(name, idxs), bindings|
+                  bindings[name.to_sym] = matches.captures[idxs.first - 1]
                 end
               end
             else
@@ -144,21 +159,6 @@ module Webmachine
           depth += 1
         end
       end
-
-      # Decode a string using the scheme described in RFC 3986 2.1. Percent-Encoding (https://www.ietf.org/rfc/rfc3986.txt)
-      def self.rfc3986_percent_decode(value)
-        s = StringScanner.new(value)
-        result = ''
-        until s.eos?
-          encoded_val = s.scan(/%([0-9a-fA-F]){2}/)
-          result << if encoded_val.nil?
-            s.getch
-          else
-            [encoded_val[1..-1]].pack('H*')
-          end
-        end
-        result
-      end
     end # class Route
   end # module Dispatcher
 end # module Webmachine

data/lib/webmachine/dispatcher.rb

@@ -33,7 +33,7 @@ module Webmachine
       @routes << route
       route
     end
-    alias :add :add_route
+    alias_method :add, :add_route
 
     # Dispatches a request to the appropriate {Resource} in the
     # dispatch list. If a matching resource is not found, a "404 Not
@@ -72,10 +72,11 @@ module Webmachine
     # Find the first route that matches an incoming request
     # @param [Request] request the request to match
     def find_route(request)
-      @routes.find {|r| r.match?(request) }
+      @routes.find { |r| r.match?(request) }
     end
 
     private
+
     def prepare_resource(route, request, response)
       route.apply(request)
       @resource_creator.call(route, request, response)

data/lib/webmachine/errors.rb

@@ -14,23 +14,22 @@ module Webmachine
   # @param [Response] req the response object
   # @param [Hash] options keys to override the defaults when rendering
   #     the response body
-  def self.render_error(code, req, res, options={})
+  def self.render_error(code, req, res, options = {})
     res.code = code
     unless res.body
       title, message = t(["errors.#{code}.title", "errors.#{code}.message"],
-                         { :method => req.method,
-                           :error => res.error}.merge(options))
-      res.body = t("errors.standard_body",
-                   {:title => title,
-                     :message => message,
-                     :version => Webmachine::SERVER_STRING}.merge(options))
+        {method: req.method,
+         error: res.error}.merge(options))
+      res.body = t('errors.standard_body',
+        {title: title,
+         message: message,
+         version: Webmachine::SERVER_STRING}.merge(options))
       res.headers[CONTENT_TYPE] = TEXT_HTML
     end
     ensure_content_length(res)
     ensure_date_header(res)
   end
 
-
   # Superclass of all errors generated by Webmachine.
   class Error < ::StandardError; end
 

data/lib/webmachine/etags.rb

@@ -10,7 +10,7 @@ module Webmachine
 
     def self.new(etag)
       return etag if ETag === etag
-      klass = etag =~ WEAK_ETAG ? WeakETag : self
+      klass = WEAK_ETAG.match?(etag) ? WeakETag : self
       klass.send(:allocate).tap do |obj|
         obj.send(:initialize, etag)
       end
@@ -53,6 +53,7 @@ module Webmachine
     end
 
     private
+
     def unquote(str)
       if str =~ WEAK_ETAG
         unescape_quotes $1

data/lib/webmachine/header_negotiation.rb

@@ -3,19 +3,18 @@
 module Webmachine
   module HeaderNegotiation
     def ensure_date_header(res)
-      if (200..499).include?(res.code)
+      if (200..499).cover?(res.code)
         res.headers[DATE] ||= Time.now.httpdate
       end
     end
 
     def ensure_content_length(res)
       body = res.body
-      case
-      when res.headers[TRANSFER_ENCODING]
-        return
-      when [204, 205, 304].include?(res.code)
+      if res.headers[TRANSFER_ENCODING]
+        nil
+      elsif [204, 205, 304].include?(res.code)
         res.headers.delete CONTENT_LENGTH
-      when body != nil
+      elsif !body.nil?
         res.headers[CONTENT_LENGTH] = body.respond_to?(:bytesize) ? body.bytesize.to_s : body.length.to_s
       else
         res.headers[CONTENT_LENGTH] = '0'

data/lib/webmachine/headers.rb

@@ -10,11 +10,10 @@ module Webmachine
     # @param [Hash] env a hash of CGI-style env/headers
     # @return [Webmachine::Headers]
     def self.from_cgi(env)
-      env.inject(new) do |h,(k,v)|
+      env.each_with_object(new) do |(k, v), h|
         if k =~ CGI_HTTP_MATCH || k =~ CONTENT_TYPE_LENGTH_MATCH
           h[$1.tr(UNDERSCORE, DASH)] = v
         end
-        h
       end
     end
 
@@ -33,7 +32,7 @@ module Webmachine
     #   @param [Object]
     # @return [Webmachine::Headers]
     def self.[](*args)
-      super(super(*args).map {|k, v| [k.to_s.downcase, v]})
+      super(super(*args).map { |k, v| [k.to_s.downcase, v] })
     end
 
     # Fetch a header
@@ -42,7 +41,7 @@ module Webmachine
     end
 
     # Set a header
-    def []=(key,value)
+    def []=(key, value)
       super transform_key(key), value
     end
 
@@ -76,10 +75,11 @@ module Webmachine
 
     # Select matching headers
     def grep(pattern)
-      self.class[select { |k,_| pattern === k }]
+      self.class[select { |k, _| pattern === k }]
     end
 
     private
+
     def transform_key(key)
       key.to_s.downcase
     end