iknow_params 2.2.1

data/lib/iknow_params/parser/hash_parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+
+# Simple wrapper to use IknowParams::Parser to extract and verify content from
+# an arbitrary hash
+class IknowParams::Parser::HashParser
+  include IknowParams::Parser
+
+  attr_reader :params
+
+  def initialize(view_hash)
+    @params = ActiveSupport::HashWithIndifferentAccess.new(view_hash)
+  end
+
+  def parse(&block)
+    instance_exec(&block)
+  end
+end

data/lib/iknow_params/serializer.rb

@@ -0,0 +1,361 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/duration'
+require 'active_support/inflector'
+require 'active_support/core_ext/module/delegation'
+require 'tzinfo'
+require 'json-schema'
+
+class IknowParams::Serializer
+  class LoadError < ArgumentError; end
+  class DumpError < ArgumentError; end
+
+  attr_reader :clazz
+
+  def initialize(clazz)
+    @clazz = clazz
+  end
+
+  def dump(val, json: false)
+    matches_type!(val)
+    if json && self.class.json_value?
+      val
+    else
+      val.to_s
+    end
+  end
+
+  def load(_val)
+    raise StandardError.new('unimplemented')
+  end
+
+  def matches_type?(val)
+    val.is_a?(clazz)
+  end
+
+  def matches_type!(val, err: DumpError)
+    unless matches_type?(val)
+      raise err.new("Incorrect type for #{self.class.name}: #{val.inspect}:#{val.class.name}")
+    end
+    true
+  end
+
+  @registry = {}
+  class << self
+    delegate :load, :dump, to: :singleton
+
+    def singleton
+      raise ArgumentError.new("Singleton instance not defined for abstract serializer '#{self.name}'")
+    end
+
+    def json_value?
+      false
+    end
+
+    def for(name)
+      @registry[name.to_s]
+    end
+
+    def for!(name)
+      s = self.for(name)
+      raise ArgumentError.new("No serializer registered with name: '#{name}'") if s.nil?
+      s
+    end
+
+    protected
+
+    def register_serializer(name, serializer)
+      @registry[name] = serializer
+      IknowParams::Parser.register_serializer(name, serializer)
+    end
+
+    private
+
+    def set_singleton!
+      instance = self.new
+      define_singleton_method(:singleton) { instance }
+      IknowParams::Serializer.register_serializer(self.name.demodulize, instance)
+    end
+
+    def json_value!
+      define_singleton_method(:json_value?) { true }
+    end
+  end
+
+  class String < IknowParams::Serializer
+    def initialize
+      super(::String)
+    end
+
+    def load(str)
+      matches_type!(str, err: LoadError)
+      str
+    end
+
+    set_singleton!
+    json_value!
+  end
+
+  class Integer < IknowParams::Serializer
+    def initialize
+      super(::Integer)
+    end
+
+    # JSON only supports floats, so we have to accept a value
+    # which may have already been parsed into a Ruby Float or Integer.
+    def load(str_or_num)
+      raise LoadError.new("Invalid integer: #{str_or_num}") unless [::String, ::Integer].any? { |t| str_or_num.is_a?(t) }
+      Integer(str_or_num)
+    rescue ArgumentError => e
+      raise LoadError.new(e.message)
+    end
+
+    set_singleton!
+    json_value!
+  end
+
+  class Float < IknowParams::Serializer
+    def initialize
+      super(::Float)
+    end
+
+    def load(str)
+      Float(str)
+    rescue TypeError, ArgumentError => _e
+      raise LoadError.new("Invalid type for conversion to Float")
+    end
+
+    set_singleton!
+    json_value!
+  end
+
+  class Boolean < IknowParams::Serializer
+    def initialize
+      super(nil)
+    end
+
+    def load(str)
+      str = str.downcase if str.is_a?(::String)
+
+      if ['false', 'no', 'off', false, '0', 0].include?(str)
+        false
+      elsif ['true', 'yes', 'on', true, '1', 1].include?(str)
+        true
+      else
+        raise LoadError.new("Invalid boolean: #{str.inspect}")
+      end
+    end
+
+    def matches_type?(val)
+      [true, false].include?(val)
+    end
+
+    set_singleton!
+    json_value!
+  end
+
+  class Numeric < IknowParams::Serializer
+    def initialize
+      super(::Numeric)
+    end
+
+    def load(str)
+      Float(str)
+    rescue TypeError, ArgumentError => _e
+      raise LoadError.new("Invalid type for conversion to Numeric")
+    end
+
+    set_singleton!
+    json_value!
+  end
+
+  # Abstract serializer for ISO8601 dates and times
+  class ISO8601 < IknowParams::Serializer
+    def load(str)
+      clazz.parse(str)
+    rescue TypeError, ArgumentError => _e
+      raise LoadError.new("Invalid type for conversion to #{clazz}")
+    end
+
+    def dump(val, json: nil)
+      matches_type!(val)
+      val.iso8601
+    end
+  end
+
+  class Date < ISO8601
+    def initialize
+      super(::Date)
+    end
+
+    set_singleton!
+  end
+
+  class Time < ISO8601
+    def initialize
+      super(::Time)
+    end
+
+    set_singleton!
+  end
+
+  class Duration < ISO8601
+    def initialize
+      super(::ActiveSupport::Duration)
+    end
+
+    set_singleton!
+  end
+
+
+  class Timezone < IknowParams::Serializer
+    def initialize
+      super(::TZInfo::Timezone)
+    end
+
+    def load(str)
+      TZInfo::Timezone.get(str)
+    rescue TZInfo::InvalidTimezoneIdentifier => _e
+      raise LoadError.new("Invalid identifier for TZInfo zone: #{str}")
+    end
+
+    def dump(val, json: nil)
+      matches_type!(val)
+      val.identifier
+    end
+
+    set_singleton!
+  end
+
+  class UUID < String
+    def load(str)
+      matches_type!(str, err: LoadError)
+      super
+    end
+
+    def matches_type?(str)
+      super && /[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/i.match?(str)
+    end
+
+    set_singleton!
+    json_value!
+  end
+
+  # Abstract serializer for JSON structures conforming to a specified
+  # schema.
+  class JsonWithSchema < IknowParams::Serializer
+    attr_reader :schema
+    def initialize(schema, validate_schema: true)
+      @schema          = schema
+      @validate_schema = validate_schema
+      super(nil)
+    end
+
+    def load(structure)
+      structure = JSON.parse(structure) if structure.is_a?(::String)
+      matches_type!(structure, err: LoadError)
+      structure
+    rescue JSON::ParserError => ex
+      raise LoadError.new("Invalid JSON: #{ex.message}")
+    end
+
+    def dump(val, json: false)
+      matches_type!(val)
+      if json
+        val
+      else
+        JSON.dump(val)
+      end
+    end
+
+    def matches_type?(val)
+      JSON::Validator.validate(schema, val, validate_schema: @validate_schema)
+    end
+
+    json_value!
+  end
+
+  # Adds Rails conveniences
+  class JsonWithSchema
+    class Rails < JsonWithSchema
+      def initialize(schema)
+        super(schema, validate_schema: !::Rails.env.production?)
+      end
+
+      def load(structure)
+        super(convert_strong_parameters(structure))
+      end
+
+      private
+
+      def convert_strong_parameters(structure)
+        case structure
+        when ActionController::Parameters
+          structure.to_unsafe_h
+        when Array
+          structure.dup.map { |x| convert_strong_parameters(x) }
+        else
+          structure
+        end
+      end
+    end
+  end
+
+  ## Abstract serializer for `ActsAsEnum` constants.
+  class ActsAsEnum < IknowParams::Serializer
+    def load(str)
+      constant = clazz.value_of(str)
+      if constant.nil?
+        raise LoadError.new("Invalid #{clazz.name} member: '#{str}'")
+      end
+      constant
+    end
+
+    def dump(val, json: nil)
+      matches_type!(val)
+      val.enum_constant
+    end
+
+    def matches_type?(val)
+      return true if super(val)
+      dc = clazz.dummy_class
+      dc.present? && val.is_a?(dc)
+    end
+  end
+
+  ## Abstract serializer for `renum` constants.
+  class Renum < IknowParams::Serializer
+    def load(str)
+      val = clazz.with_name(str)
+      if val.nil?
+        raise LoadError.new("Invalid enumeration constant: '#{str}'")
+      end
+      val
+    end
+
+    def dump(val, json: nil)
+      matches_type!(val)
+      val.name
+    end
+  end
+
+  # Abstract serializer for members of a fixed set of lowercase strings,
+  # case-normalized on parse.
+  class StringEnum < IknowParams::Serializer
+    def initialize(*members)
+      @member_set = members.map(&:downcase).to_set.freeze
+      super(nil)
+    end
+
+    def load(str)
+      val = str.to_s.downcase
+      matches_type!(val, err: LoadError)
+      val
+    end
+
+    def matches_type?(str)
+      str.is_a?(::String) && @member_set.include?(str)
+    end
+  end
+end

data/lib/iknow_params/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IknowParams
+  VERSION = "2.2.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end