paradocs 1.0.22

data/lib/paradocs/policies.rb

@@ -0,0 +1,170 @@
+require_relative './base_policy'
+
+module Paradocs
+  module Policies
+    class Format < Paradocs::BasePolicy
+      attr_reader :message
+
+      def initialize(fmt, msg = "invalid format")
+        @message = msg
+        @fmt = fmt
+      end
+
+      def eligible?(value, key, payload)
+        payload.key?(key)
+      end
+
+      def validate(value, key, payload)
+        !payload.key?(key) || !!(value.to_s =~ @fmt)
+      end
+    end
+  end
+
+  # Default validators
+  EMAIL_REGEXP = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i.freeze
+
+  Paradocs.policy :format, Policies::Format
+  Paradocs.policy :email, Policies::Format.new(EMAIL_REGEXP, 'invalid email')
+
+  Paradocs.policy :noop do
+    eligible do |value, key, payload|
+      true
+    end
+  end
+
+  Paradocs.policy :declared do
+    eligible do |value, key, payload|
+      payload.key? key
+    end
+
+    meta_data do
+      {}
+    end
+  end
+
+  Paradocs.policy :whitelisted do
+    meta_data do
+      {whitelisted: true}
+    end
+  end
+
+  Paradocs.policy :required do
+    message do |*|
+      "is required"
+    end
+
+    validate do |value, key, payload|
+      payload.try(:key?, key)
+    end
+
+    meta_data do
+      {required: true}
+    end
+  end
+
+  Paradocs.policy :present do
+    message do |*|
+      "is required and value must be present"
+    end
+
+    validate do |value, key, payload|
+      case value
+      when String
+        value.strip != ''
+      when Array, Hash
+        value.any?
+      else
+        !value.nil?
+      end
+    end
+
+    meta_data do
+      {present: true}
+    end
+  end
+
+  {
+    gte: [:>=, "greater than or equal to"],
+    lte: [:<=, "less than or equal to"],
+    gt:  [:>, "strictly greater than"],
+    lt:  [:<, "strictly less than"]
+  }.each do |policy, (comparison, text)|
+    klass = Class.new(Paradocs::BasePolicy) do
+      attr_reader :limit
+      define_method(:initialize) do |limit|
+        @limit = limit.is_a?(Proc) ? limit.call : limit
+      end
+
+      define_method(:message) do
+        "value must be #{text} #{limit}"
+      end
+
+      define_method(:validate) do |value, key, _|
+        @key, @value = key, value
+        value.send(comparison, limit)
+      end
+
+      define_method(:meta_data) do
+        meta = super()
+        meta[policy][:limit] = limit
+        binding.pry unless meta.dig(policy, :limit)
+        meta
+      end
+
+      define_singleton_method(:policy_name) do
+        policy
+      end
+    end
+    Paradocs.policy(policy, klass)
+  end
+
+  Paradocs.policy :options do
+    message do |options, actual|
+      "must be one of #{options.join(', ')}, but got #{actual}"
+    end
+
+    eligible do |options, actual, key, payload|
+      payload.key?(key)
+    end
+
+    validate do |options, actual, key, payload|
+      !payload.key?(key) || ok?(options, actual)
+    end
+
+    meta_data do |opts|
+      {options: opts}
+    end
+
+    def ok?(options, actual)
+      [actual].flatten.all?{|v| options.include?(v)}
+    end
+  end
+
+  Paradocs.policy :length do
+    COMPARISONS = {
+      max: [:<=, "maximum"],
+      min: [:>=, "minimum"],
+      eq:  [:==, "exactly"]
+    }.freeze
+
+    message do |options, actual, key|
+      "value must be " + options.each_with_object([]) do |(comparison, limit), obj|
+        obj << "#{COMPARISONS[comparison].last} #{limit} characters"
+      end.join(", ")
+    end
+
+    validate do |options, actual, key, payload|
+      !payload.key?(key) || ok?(options, actual)
+    end
+
+    meta_data do |opts|
+      {length: opts}
+    end
+
+    def ok?(options, actual)
+      options.all? do |comparison, limit|
+        actual.to_s.length.send(COMPARISONS[comparison].first, limit)
+      end
+    end
+  end
+end

data/lib/paradocs/registry.rb

@@ -0,0 +1,42 @@
+require 'paradocs/base_policy'
+
+module Paradocs
+  class ConfigurationError < StandardError; end
+
+  class Registry
+    attr_reader :policies
+
+    def initialize
+      @policies = {}
+    end
+
+    def coercions
+      policies
+    end
+
+    def policy(name, plcy = nil, &block)
+      validate_policy_class(plcy) if plcy
+
+      policies[name] = (plcy || BasePolicy.build(name, :instance_eval, &block))
+      self
+    end
+
+  private
+
+    def validate_policy_class(plcy)
+      plcy_cls = plcy.is_a?(Class) ? plcy : plcy.class
+      if plcy_cls < Paradocs::BasePolicy
+        valid_overriden = plcy_cls.instance_method(:valid?).source_location != Paradocs::BasePolicy.instance_method(:valid?).source_location
+        raise ConfigurationError.new("Overriding #valid? in #{plcy_cls} is forbidden. Override #validate instead") if valid_overriden
+      else
+        required_methods = [:valid?, :coerce, :eligible?, :meta_data, :policy_name] - plcy_cls.instance_methods
+        raise ConfigurationError.new("Policy #{plcy_cls} should respond to #{required_methods}") unless required_methods.empty?
+
+        return plcy unless Paradocs.config.explicit_errors
+        return plcy if plcy_cls.respond_to?(:errors)
+        raise ConfigurationError.new("Policy #{plcy_cls} should respond to .errors method")
+      end
+    end
+  end
+end
+

data/lib/paradocs/results.rb

@@ -0,0 +1,13 @@
+module Paradocs
+  class Results
+    attr_reader :output, :errors, :environment
+
+    def initialize(output, errors, environment)
+      @output, @errors, @environment = output, errors, environment
+    end
+
+    def valid?
+      !errors.keys.any?
+    end
+  end
+end

data/lib/paradocs/schema.rb

@@ -0,0 +1,214 @@
+require "paradocs/context"
+require "paradocs/results"
+require "paradocs/field"
+require "paradocs/extensions/insides"
+
+module Paradocs
+  class Schema
+    include Extensions::Insides
+
+    attr_accessor :environment
+    attr_reader :subschemes
+    def initialize(options={}, &block)
+      @options = options
+      @fields = {}
+      @subschemes = {}
+      @definitions = []
+      @definitions << block if block_given?
+      @default_field_policies = []
+      @ignored_field_keys = []
+      @expansions = {}
+    end
+
+    def schema
+      self
+    end
+
+    def mutation_by!(key, &block)
+      f = @fields.keys.include?(key) ? @fields[key] : field(key).transparent
+      f.mutates_schema!(&block)
+    end
+
+    def subschema(*args, &block)
+      options = args.last.is_a?(Hash) ? args.last : {}
+      name = args.first.is_a?(Symbol) ? args.shift : Paradocs.config.default_schema_name
+      current_schema = subschemes.fetch(name) { self.class.new }
+      new_schema = if block_given?
+        sc = self.class.new(options)
+        sc.definitions << block
+        sc
+      elsif args.first.is_a?(self.class)
+        args.first
+      else
+        self.class.new(options)
+      end
+      subschemes[name] = current_schema.merge(new_schema)
+    end
+
+    def fields
+      apply!
+      @fields
+    end
+
+    def policy(*names, &block)
+      @default_field_policies = names
+      definitions << block if block_given?
+
+      self
+    end
+
+    def ignore(*field_keys, &block)
+      @ignored_field_keys += field_keys
+      @ignored_field_keys.uniq!
+
+      definitions << block if block_given?
+
+      self
+    end
+
+    def clone
+      instance = self.class.new(options)
+      copy_into instance
+    end
+
+    def merge(other_schema)
+      instance = self.class.new(options.merge(other_schema.options))
+
+      copy_into(instance)
+      other_schema.copy_into(instance)
+    end
+
+    def copy_into(instance)
+      instance.policy(*default_field_policies) if default_field_policies.any?
+
+      definitions.each do |d|
+        instance.definitions << d
+      end
+
+      subschemes.each { |name, subsc| instance.subschema(name, subsc) }
+
+      instance.ignore *ignored_field_keys
+      instance
+    end
+
+    def field(field_or_key)
+      f, key = if field_or_key.kind_of?(Field)
+        [field_or_key, field_or_key.key]
+      else
+        [Field.new(field_or_key), field_or_key.to_sym]
+      end
+
+      if ignored_field_keys.include?(f.key)
+        f
+      else
+        @fields[key] = apply_default_field_policies_to(f)
+      end
+    end
+
+    def expand(exp, &block)
+      expansions[exp] = block
+      self
+    end
+
+    def resolve(payload, environment={})
+      @environment = environment
+      context = Context.new(nil, Top.new, @environment, subschemes)
+      output = coerce(payload, nil, context)
+      Results.new(output, context.errors, @environment)
+    end
+
+    def eligible?(value, key, payload)
+      payload.key? key
+    end
+
+    def valid?(*_)
+      true
+    end
+
+    def meta_data
+      {}
+    end
+
+    def coerce(val, _, context)
+      flush!
+      if val.is_a?(Array)
+        val.map.with_index do |v, idx|
+          subcontext = context.sub(idx)
+          out = coerce_one(v, subcontext)
+          resolve_expansions(v, out, subcontext)
+        end
+      else
+        out = coerce_one(val, context)
+        resolve_expansions(val, out, context)
+      end
+    end
+
+    protected
+
+    attr_reader :definitions, :options
+
+    private
+
+    attr_reader :default_field_policies, :ignored_field_keys, :expansions
+
+    def coerce_one(val, context, flds: fields)
+      invoke_subschemes!(val, context, flds: flds)
+      flds.each_with_object({}) do |(_, field), m|
+        r = field.resolve(val, context.sub(field.key))
+        m[field.key] = r.value if r.eligible?
+      end
+    end
+
+    def invoke_subschemes!(payload, context, flds: fields)
+      invoked_any = false
+      # recoursive definitions call depending on payload
+      flds.clone.each_pair do |_, field|
+        next unless field.expects_mutation?
+        subschema_name = field.subschema_for_mutation(payload, context.environment)
+        subschema = subschemes[subschema_name] || context.subschema(subschema_name)
+        next unless subschema # or may be raise error?
+        subschema.definitions.each { |block| self.instance_exec(&block) }
+        invoked_any = true
+      end
+      # if definitions are applied new subschemes may appear, apply them until they end
+      invoke_subschemes!(payload, context, flds: fields) if invoked_any
+    end
+
+    class MatchContext
+      def field(key)
+        Field.new(key.to_sym)
+      end
+    end
+
+    def resolve_expansions(payload, into, context)
+      expansions.each do |exp, block|
+        payload.each do |key, value|
+          match = exp.match(key.to_s)
+          next unless match
+          fld = MatchContext.new.instance_exec(match, &block)
+          next unless fld
+          into.update(coerce_one({fld.key => value}, context, flds: {fld.key => apply_default_field_policies_to(fld)}))
+        end
+      end
+
+      into
+    end
+
+    def apply_default_field_policies_to(field)
+      default_field_policies.reduce(field) {|f, policy_name| f.policy(policy_name) }
+    end
+
+    def apply!
+      return if @applied
+      definitions.each do |d|
+        self.instance_exec(options, &d)
+      end
+      @applied = true
+    end
+
+    def flush!
+      @fields = {}
+      @applied = false
+    end
+  end
+end

data/lib/paradocs/struct.rb

@@ -0,0 +1,102 @@
+require 'paradocs/dsl'
+
+module Paradocs
+  class InvalidStructError < ArgumentError
+    attr_reader :errors
+    def initialize(struct)
+      @errors = struct.errors
+      msg = @errors.map do |k, strings|
+        "#{k} #{strings.join(', ')}"
+      end.join('. ')
+      super "#{struct.class} is not a valid struct: #{msg}"
+    end
+  end
+
+  module Struct
+    def self.included(base)
+      base.send(:include, Paradocs::DSL)
+      base.extend ClassMethods
+    end
+
+    def initialize(attrs = {})
+      @_results = self.class.schema.resolve(attrs)
+      @_graph = self.class.build(@_results.output)
+    end
+
+    def valid?
+      !_results.errors.any?
+    end
+
+    def errors
+      _results.errors
+    end
+
+    # returns a shallow copy.
+    def to_h
+      _results.output.clone
+    end
+
+    def ==(other)
+      other.respond_to?(:to_h) && other.to_h.eql?(to_h)
+    end
+
+    def merge(attrs = {})
+      self.class.new(to_h.merge(attrs))
+    end
+
+    private
+    attr_reader :_graph, :_results
+
+    module ClassMethods
+      def new!(attrs = {})
+        st = new(attrs)
+        raise InvalidStructError.new(st) unless st.valid?
+        st
+      end
+
+      # this hook is called after schema definition in DSL module
+      def paradocs_after_define_schema(schema)
+        schema.fields.keys.each do |key|
+          define_method key do
+            _graph[key]
+          end
+        end
+      end
+
+      def build(attrs)
+        attrs.each_with_object({}) do |(k, v), obj|
+          obj[k] = wrap(k, v)
+        end
+      end
+
+      def paradocs_build_class_for_child(key, child_schema)
+        klass = Class.new do
+          include Struct
+        end
+        klass.schema = child_schema
+        klass
+      end
+
+      def wrap(key, value)
+        field = schema.fields[key]
+        return value unless field
+
+        case value
+        when Hash
+          # find constructor for field
+          cons = field.meta_data[:schema]
+          if cons.kind_of?(Paradocs::Schema)
+            klass = paradocs_build_class_for_child(key, cons)
+            klass.paradocs_after_define_schema(cons)
+            cons = klass
+          end
+          cons ? cons.new(value) : value.freeze
+        when Array
+          value.map{|v| wrap(key, v) }.freeze
+        else
+          value.freeze
+        end
+      end
+    end
+  end
+end

data/lib/paradocs/support.rb

@@ -0,0 +1,47 @@
+require "delegate"
+
+module Support
+  module Tryable #:nodoc:
+    def try(method_name = nil, *args, &b)
+      if method_name.nil? && block_given?
+        if b.arity == 0
+          instance_eval(&b)
+        else
+          yield self
+        end
+      elsif respond_to?(method_name)
+        public_send(method_name, *args, &b)
+      end
+    end
+
+    def try!(method_name = nil, *args, &b)
+      if method_name.nil? && block_given?
+        if b.arity == 0
+          instance_eval(&b)
+        else
+          yield self
+        end
+      else
+        public_send(method_name, *args, &b)
+      end
+    end
+  end
+end
+
+class Object
+  include Support::Tryable
+end
+
+class Delegator
+  include Support::Tryable
+end
+
+class NilClass
+  def try(_method_name = nil, *, **)
+    nil
+  end
+
+  def try!(_method_name = nil, *, **)
+    nil
+  end
+end

data/lib/paradocs/version.rb

@@ -0,0 +1,3 @@
+module Paradocs
+  VERSION = "1.0.22"
+end

data/lib/paradocs/whitelist.rb

@@ -0,0 +1,91 @@
+module Paradocs
+  module Whitelist
+    # Example
+    #   class Foo
+    #     include Paradocs::DSL
+    #     include Paradocs::Whitelist
+    #
+    #     schema(:test) do
+    #       field(:title).type(:string).whitelisted
+    #       field(:age).type(:integer).default(20)
+    #     end
+    #   end
+    #
+    #   foo    = Foo.new
+    #   schema = foo.class.schema(:test)
+    #   params = {title: "title", age: 25}
+    #   foo.filter!(params, schema) # => {title: "title", age: "[FILTERED]"}
+    #
+    FILTERED = "[FILTERED]"
+    EMPTY    = "[EMPTY]"
+
+    def self.included(base)
+      base.include(ClassMethods)
+    end
+
+    module ClassMethods
+      def filter!(payload, source_schema)
+        schema  = source_schema.clone
+        context = Context.new(nil, Top.new, @environment, source_schema.subschemes.clone)
+        resolve(payload, schema, context)
+      end
+
+      def resolve(payload, schema, context)
+        filtered_payload = {}
+        payload.dup.each do |key, value|
+          key    = key.to_sym
+          schema = Schema.new if schema.nil?
+          schema.send(:flush!)
+          schema.send(:invoke_subschemes!, payload, context)
+
+          if value.is_a?(Hash)
+            field_schema = find_schema_by(schema, key)
+            value        = resolve(value, field_schema, context)
+          elsif value.is_a?(Array)
+            value = value.map do |v|
+              if v.is_a?(Hash)
+                field_schema = find_schema_by(schema, key)
+                resolve(v, field_schema, context)
+              else
+                v = FILTERED unless whitelisted?(schema, key)
+                v
+              end
+            end
+          else
+            value = if whitelisted?(schema, key)
+              value
+            elsif value.nil? || value.try(:blank?) || value.try(:empty?)
+              !!value == value ? value : EMPTY
+            else
+              FILTERED
+            end
+            value
+          end
+
+          filtered_payload[key] = value
+        end
+
+        filtered_payload
+      end
+
+      private
+
+      def find_schema_by(schema, key)
+        meta_data = get_meta_data(schema, key)
+        meta_data[:schema]
+      end
+
+      def whitelisted?(schema, key)
+        meta_data = get_meta_data(schema, key)
+        meta_data[:whitelisted] || Paradocs.config.whitelisted_keys.include?(key)
+      end
+
+      def get_meta_data(schema, key)
+        return {} unless schema.respond_to?(:fields)
+        return {} unless schema.fields[key]
+        return {} unless schema.fields[key].respond_to?(:meta_data)
+        meta_data = schema.fields[key].meta_data || {}
+      end
+    end
+  end
+end