fern-parameters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dff3f8750786b2ca71fff701a73504323362f86
+  data.tar.gz: be2919d7d59d2106ff61abe724902365d46429d2
+SHA512:
+  metadata.gz: fdec1c3fd8f503383ce2b39571817198b16cda1a55d7ce2f179355331b750e34441b7218696ba465c6c33bce0751ca28c4c4230e7b0aa1c2a58e2b256a144459
+  data.tar.gz: 201b1b355ba20c24082b98a355db68b2555ea1282b3d088f52bc4a54f59c24349b5be72b0dfd3243d30ca3bf377358fe7fd644584710bd27ad15a343c1fe7d7a

data/lib/fern/parameters/dsl.rb

@@ -0,0 +1,28 @@
+require 'fern/api'
+
+module Fern
+  module Parameters
+    module Dsl
+      def self.included(receiver)
+        receiver.extend(ClassMethods)
+      end
+
+      module ClassMethods
+      end
+
+      def params(&block)
+        @controller.fern[@name][:params] = {}
+        instance_eval(&block)
+      end
+
+      def param(name, type = :string, **opts)
+        @controller.fern[@name][:params][name] = {
+          type: type,
+          constraints: opts
+        }
+      end
+    end
+  end
+end
+
+Fern::Api::Endpoint.class_eval { include Fern::Parameters::Dsl }

data/lib/fern/parameters/errors.rb

@@ -0,0 +1,22 @@
+module Fern
+  module Parameters
+    class Errors
+      def initialize
+        @errors = {}
+      end
+
+      def add(param, message)
+        @errors[param] ||= []
+        @errors[param] << message
+      end
+
+      def any?
+        @errors.any?
+      end
+
+      def [](param)
+        @errors[param]
+      end
+    end
+  end
+end

data/lib/fern/parameters/invalid.rb

@@ -0,0 +1,11 @@
+module Fern
+  module Parameters
+    class Invalid < StandardError
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+      end
+    end
+  end
+end

data/lib/fern/parameters/parameters.rb

@@ -0,0 +1,40 @@
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'fern/parameters/invalid'
+require 'fern/parameters/validator'
+
+module Fern
+  module Parameters
+    class Parameters
+      delegate :keys,
+        :key?,
+        :has_key?,
+        :values,
+        :has_value?,
+        :value?,
+        :empty?,
+        :include?,
+        :as_json,
+        :[],
+        :to_h,
+        to: :@parameters
+
+      def initialize(parameters, config)
+        @parameters = parameters.with_indifferent_access
+        @config = config.deep_symbolize_keys!
+      end
+
+      def validated
+        validator = Validator.new(@config)
+        validator.validate(@parameters)
+
+        if validator.errors.any?
+          raise Invalid.new(validator.errors), 'invalid parameters'
+        end
+
+        self.class.new(validator.declared, @config)
+      end
+    end
+  end
+end

data/lib/fern/parameters/validator.rb

@@ -0,0 +1,141 @@
+require 'active_support/core_ext/module'
+require 'active_support/inflector'
+
+require 'fern/parameters/invalid'
+require 'fern/parameters/errors'
+
+module Fern
+  module Parameters
+    class Validator
+      attr_accessor :errors
+      attr_accessor :declared
+
+      def initialize(config)
+        @config = config
+        @errors = Errors.new
+        @declared = {}
+      end
+
+      def validate(params)
+        @config.each do |name, config|
+          if params.key?(name)
+            @declared[name] = validate_constraints(
+              name,
+              params[name],
+              config
+            )
+          else
+            @declared[name] = config[:default] if config.key?(:default)
+            if config[:required] && @declared[name].nil?
+              @errors.add(name, 'is required')
+            end
+          end
+        end
+      end
+
+      private
+
+      def validate_constraints(name, raw_val, config)
+        val = validate_type(name, raw_val, config[:type], config)
+
+        return if val.nil?
+
+        validate_numeric_constraints(name, val, config)
+        validate_inclusion(name, val, config)
+
+        val
+      end
+
+      def parse_type(val, type, array = false)
+        meth = "validate_#{type}"
+        if array
+          parsed = val.map { |el| send(meth, el) }
+          return nil unless parsed.all? { |el| !el.nil? } && parsed
+          parsed
+        else
+          send(meth, val)
+        end
+      end
+
+      def validate_boolean(val)
+        if val.casecmp('true').zero?
+          true
+        elsif val.casecmp('false').zero?
+          false
+        end
+      end
+
+      def validate_date(val)
+        Date.parse(val)
+      rescue ArgumentError
+      end
+
+      def validate_datetime(val)
+        Time.parse(val)
+      rescue ArgumentError
+      end
+
+      def validate_float(val)
+        Float(val)
+      rescue ArgumentError
+      end
+
+      def validate_inclusion(name, val, constraints)
+        return unless constraints.key?(:values)
+        return if constraints[:values].include?(val)
+        @errors.add(name, "must be one of #{constraints[:values]}")
+      end
+
+      def validate_integer(val)
+        Integer(val)
+      rescue ArgumentError
+      rescue TypeError
+      end
+
+      def validate_max(name, val, max)
+        return unless val > max
+        @errors.add(name, "must be less than or equal to #{max}")
+      end
+
+      def validate_min(name, val, min)
+        return unless val < min
+        @errors.add(name, "must be greater than or equal to #{min}")
+      end
+
+      def validate_numeric(name, val)
+        validate_float(val) || @errors.add(name, 'must be a number')
+      end
+
+      def validate_numeric_constraints(name, val, constraints)
+        return unless constraints.key?(:min) || constraints.key?(:max)
+        validate_numeric(name, val)
+        validate_min(name, val, constraints[:min]) if constraints.key?(:min)
+        validate_max(name, val, constraints[:max]) if constraints.key?(:max)
+      end
+
+      def validate_string(val)
+        val
+      end
+
+      def validate_type(name, val, type, config)
+        parsed = parse_type(val, type, config[:constraints][:array])
+        if parsed.nil?
+          if config[:constraints][:array]
+            @errors.add(name, "is not an array of #{pluralize(type)}")
+          else
+            @errors.add(name, "is not #{indefinite_articlerize(type)}")
+          end
+        end
+        parsed
+      end
+
+      def pluralize(word)
+        ActiveSupport::Inflector.pluralize(word)
+      end
+
+      def indefinite_articlerize(word)
+        %w[a e i o u].include?(word[0].downcase) ? "an #{word}" : "a #{word}"
+      end
+    end
+  end
+end

data/lib/fern/parameters/version.rb

@@ -0,0 +1,5 @@
+module Fern
+  module Parameters
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/fern/parameters.rb

@@ -0,0 +1,22 @@
+require 'fern/parameters/dsl'
+require 'fern/parameters/invalid'
+require 'fern/parameters/parameters'
+
+module Fern
+  module Parameters
+    extend ActiveSupport::Concern
+
+    included do
+      def params
+        config = fern[action_name.to_sym][:params]
+        @_params ||= Parameters.new(request.parameters, config)
+      end
+
+      def params=(val)
+        @_params = Parameters.new(val.to_hash)
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) { include Fern::Parameters }

data/lib/fern-parameters.rb

@@ -0,0 +1 @@
+require 'fern/parameters'

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: fern-parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Kestell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: fern-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: fern-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Typed parameters for Fern.
+email: kyle@kestell.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fern-parameters.rb
+- lib/fern/parameters.rb
+- lib/fern/parameters/dsl.rb
+- lib/fern/parameters/errors.rb
+- lib/fern/parameters/invalid.rb
+- lib/fern/parameters/parameters.rb
+- lib/fern/parameters/validator.rb
+- lib/fern/parameters/version.rb
+homepage: https://github.com/kkestell/fern-parameters
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Fern Parameters
+test_files: []