File: sanitizer.rb

package info (click to toggle)
ruby-jekyll-github-metadata 2.15.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 712 kB
  • sloc: ruby: 2,355; javascript: 107; sh: 41; makefile: 6
file content (61 lines) | stat: -rw-r--r-- 1,872 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# frozen_string_literal: true

module Jekyll
  module GitHubMetadata
    module Sanitizer
      extend self
      # Sanitize an object.
      # When the resource is either `false`, `true`, `nil` or a number,
      #   it returns the resource as-is. When the resource is an array,
      #   it maps over the entire array, sanitizing each of its values.
      #   When the resource responds to the #to_hash method, it returns
      #   the value of #sanitize_resource (see below). If none of the
      #   aforementioned conditions are met, the return value of #to_s
      #   is used.
      #
      # resource - an Object
      #
      # Returns the sanitized resource.
      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
      def sanitize(resource)
        case resource
        when Array
          resource.map { |item| sanitize(item) }
        when Numeric, Time
          resource
        when FalseClass
          false
        when TrueClass
          true
        when NilClass
          nil
        when String
          resource
        when Value
          resource.render
        else
          if resource.respond_to?(:to_hash)
            sanitize_resource(resource)
          else
            resource.to_s
          end
        end
      end
      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength

      # Sanitize the Sawyer Resource or Hash
      # Note: the object must respond to :to_hash for this to work.
      # Consider using #sanitize instead of this method directly.
      #
      # resource - an Object which responds to :to_hash
      #
      # Returns the sanitized sawyer resource or hash as a hash.
      def sanitize_resource(resource)
        resource.to_hash.each_with_object({}) do |(k, v), result|
          result[k.to_s] = sanitize(v)
          result
        end
      end
    end
  end
end