rails-param-validation 0.1.0

data/lib/rails-param-validation/validators/regex.rb

@@ -0,0 +1,37 @@
+module RailsParamValidation
+
+  class RegexValidator < Validator
+    def initialize(schema)
+      super schema
+    end
+
+    def matches?(path, data)
+      if data.is_a?(String) || data.is_a?(Symbol)
+        data = data.to_s
+        match = data.match self.schema
+        if match && match.to_s.size == data.size
+          return MatchResult.new data
+        else
+          return MatchResult.new nil, path, "String does not match the required pattern"
+        end
+      else
+        MatchResult.new nil, path, "Expected a string matching the given pattern"
+      end
+    end
+
+    def to_openapi
+      { type: :string, pattern: self.schema.source }
+    end
+  end
+
+  class RegexValidatorFactory < ValidatorFactory
+    def supports?(schema)
+      schema.is_a? Regexp
+    end
+
+    def create(schema)
+      RegexValidator.new schema
+    end
+  end
+
+end

data/lib/rails-param-validation/validators/string.rb

@@ -0,0 +1,31 @@
+module RailsParamValidation
+
+  class StringValidator < Validator
+    def initialize(schema)
+      super schema
+    end
+
+    def matches?(path, data)
+      if data.is_a?(String) || data.is_a?(Symbol) || data.is_a?(Numeric) || data.is_a?(TrueClass) || data.is_a?(FalseClass)
+        MatchResult.new data.to_s
+      else
+        MatchResult.new nil, path, "Expected a string"
+      end
+    end
+
+    def to_openapi
+      { type: :string }
+    end
+  end
+
+  class StringValidatorFactory < ValidatorFactory
+    def supports?(schema)
+      schema == String || schema == Symbol
+    end
+
+    def create(schema)
+      StringValidator.new schema
+    end
+  end
+
+end

data/lib/rails-param-validation/validators/uuid.rb

@@ -0,0 +1,39 @@
+module RailsParamValidation
+
+  class UuidValidator < Validator
+    REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+
+    def initialize(schema)
+      super schema
+    end
+
+    def matches?(path, data)
+      if data.is_a?(String) || data.is_a?(Symbol)
+        data = data.to_s
+        match = data.match REGEX
+        if match
+          return MatchResult.new data
+        else
+          return MatchResult.new nil, path, "String does not match a uuid v4 scheme"
+        end
+      else
+        MatchResult.new nil, path, "Expected a uuid (v4)"
+      end
+    end
+
+    def to_openapi
+      { type: :string, format: :uuid }
+    end
+  end
+
+  class UuidValidatorFactory < ValidatorFactory
+    def supports?(schema)
+      schema == Uuid
+    end
+
+    def create(schema)
+      UuidValidator.new schema
+    end
+  end
+
+end

data/lib/rails-param-validation/version.rb

@@ -0,0 +1,3 @@
+module RailsParamValidation
+  VERSION = "0.1.0"
+end

data/lib/rails-param-validation.rb

@@ -0,0 +1,42 @@
+require_relative './rails-param-validation/version'
+
+require_relative './rails-param-validation/types/types'
+
+require_relative './rails-param-validation/validator_factory'
+
+require_relative './rails-param-validation/validators/integer'
+require_relative './rails-param-validation/validators/float'
+require_relative './rails-param-validation/validators/boolean'
+require_relative './rails-param-validation/validators/string'
+require_relative './rails-param-validation/validators/uuid'
+require_relative './rails-param-validation/validators/regex'
+require_relative './rails-param-validation/validators/date'
+require_relative './rails-param-validation/validators/datetime'
+require_relative './rails-param-validation/validators/custom_type'
+require_relative './rails-param-validation/validators/constant'
+require_relative './rails-param-validation/validators/array'
+require_relative './rails-param-validation/validators/object'
+require_relative './rails-param-validation/validators/optional'
+require_relative './rails-param-validation/validators/hash'
+require_relative './rails-param-validation/validators/alternatives'
+
+require_relative './rails-param-validation/rails/extensions/annotation_extension' unless defined?(Rails)
+require_relative './rails-param-validation/rails/rails' if defined?(Rails)
+
+module RailsParamValidation
+  ValidatorFactory.register IntegerValidatorFactory.new
+  ValidatorFactory.register FloatValidatorFactory.new
+  ValidatorFactory.register BooleanValidatorFactory.new
+  ValidatorFactory.register StringValidatorFactory.new
+  ValidatorFactory.register UuidValidatorFactory.new
+  ValidatorFactory.register DateTimeValidatorFactory.new
+  ValidatorFactory.register DateValidatorFactory.new
+  ValidatorFactory.register CustomTypeValidatorFactory.new
+  ValidatorFactory.register RegexValidatorFactory.new
+  ValidatorFactory.register OptionalValidatorFactory.new
+  ValidatorFactory.register ObjectValidatorFactory.new
+  ValidatorFactory.register ArrayValidatorFactory.new
+  ValidatorFactory.register AlternativesValidatorFactory.new
+  ValidatorFactory.register ConstantValidatorFactory.new
+  ValidatorFactory.register HashValidatorFactory.new
+end

data/rails-param-validation.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/rails-param-validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-param-validation"
+  spec.version       = RailsParamValidation::VERSION
+  spec.authors       = ["Oskar Kirmis"]
+  spec.email         = ["oskar.kirmis@posteo.de"]
+
+  spec.summary       = "Automatically validate rails parameter types"
+  spec.description   = "Automatically validate rails parameter types"
+  spec.homepage      = "https://git.iftrue.de/okirmis/rails-param-validation"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://git.iftrue.de/okirmis/rails-param-validation"
+  spec.metadata["changelog_uri"] = "https://git.iftrue.de/okirmis/rails-param-validation"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    if `which git`.strip.size > 0
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    else
+      puts "WARNING: Not adding any files as git is missing."
+    end
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rails-param-validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oskar Kirmis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-08 00:00:00.000000000 Z
+dependencies: []
+description: Automatically validate rails parameter types
+email:
+- oskar.kirmis@posteo.de
+executables:
+- ".keep"
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.keep
+- docs/_config.yml
+- docs/annotations.md
+- docs/getting-started.md
+- docs/image/error-screenshot.png
+- docs/index.md
+- docs/main-idea.md
+- docs/openapi.md
+- docs/type-definition.md
+- lib/rails-param-validation.rb
+- lib/rails-param-validation/errors/missing_parameter_annotation.rb
+- lib/rails-param-validation/errors/no_matching_factory.rb
+- lib/rails-param-validation/errors/param_validation_failed_error.rb
+- lib/rails-param-validation/errors/type_not_found.rb
+- lib/rails-param-validation/rails/action_definition.rb
+- lib/rails-param-validation/rails/annotation_manager.rb
+- lib/rails-param-validation/rails/config.rb
+- lib/rails-param-validation/rails/extensions/annotation_extension.rb
+- lib/rails-param-validation/rails/extensions/custom_type_extension.rb
+- lib/rails-param-validation/rails/extensions/error.template.html.erb
+- lib/rails-param-validation/rails/extensions/validation_extension.rb
+- lib/rails-param-validation/rails/helper.rb
+- lib/rails-param-validation/rails/openapi/openapi.rb
+- lib/rails-param-validation/rails/openapi/routing_helper.rb
+- lib/rails-param-validation/rails/rails.rb
+- lib/rails-param-validation/rails/tasks/openapi.rake
+- lib/rails-param-validation/types/types.rb
+- lib/rails-param-validation/validator.rb
+- lib/rails-param-validation/validator_factory.rb
+- lib/rails-param-validation/validators/alternatives.rb
+- lib/rails-param-validation/validators/array.rb
+- lib/rails-param-validation/validators/boolean.rb
+- lib/rails-param-validation/validators/constant.rb
+- lib/rails-param-validation/validators/custom_type.rb
+- lib/rails-param-validation/validators/date.rb
+- lib/rails-param-validation/validators/datetime.rb
+- lib/rails-param-validation/validators/float.rb
+- lib/rails-param-validation/validators/hash.rb
+- lib/rails-param-validation/validators/integer.rb
+- lib/rails-param-validation/validators/object.rb
+- lib/rails-param-validation/validators/optional.rb
+- lib/rails-param-validation/validators/regex.rb
+- lib/rails-param-validation/validators/string.rb
+- lib/rails-param-validation/validators/uuid.rb
+- lib/rails-param-validation/version.rb
+- rails-param-validation.gemspec
+homepage: https://git.iftrue.de/okirmis/rails-param-validation
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://git.iftrue.de/okirmis/rails-param-validation
+  source_code_uri: https://git.iftrue.de/okirmis/rails-param-validation
+  changelog_uri: https://git.iftrue.de/okirmis/rails-param-validation
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Automatically validate rails parameter types
+test_files: []