hashie/hashie

View on GitHub
lib/hashie/extensions/mash/symbolize_keys.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Hashie
  module Extensions
    module Mash
      # Overrides Mash's default behavior of converting keys to strings
      #
      # @example
      #   class LazyResponse < Hashie::Mash
      #     include Hashie::Extensions::Mash::SymbolizeKeys
      #   end
      #
      #   response = LazyResponse.new("id" => 123, "name" => "Rey").to_h
      #   #=> {id: 123, name: "Rey"}
      #
      # @api public
      module SymbolizeKeys
        # Hook for being included in a class
        #
        # @api private
        # @return [void]
        # @raise [ArgumentError] when the base class isn't a Mash
        def self.included(base)
          raise ArgumentError, "#{base} must descent from Hashie::Mash" unless base <= Hashie::Mash
        end

        private

        # Converts a key to a symbol, if possible
        #
        # @api private
        # @param [<K>] key the key to attempt convert to a symbol
        # @return [Symbol, K]
        def convert_key(key)
          key.respond_to?(:to_sym) ? key.to_sym : key
        end
      end
    end
  end
end