dry_validation_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bad9db99d8e88991cc8c0665ebdace5ec3179688aa5caa2d3d4b0ee9170b8d1
+  data.tar.gz: 99d855b9b749a4855c4d277ef65bd90f64470e5fde350e11d2bff6494b2a5abf
+SHA512:
+  metadata.gz: d123f46e1a88ce33558a10741504938c945d53c79717f7539992657f7d3c7886cf482546011e0fe6c538d8991a75ba0c06716202aa124c5b6c7923f73ffab73c
+  data.tar.gz: 6780789a9a14924a3323c3148b6b30b513d3996d45fe355fdc90fb62b5d432268a4aec138c85c1da86958e964034181d4c0e4bfc2b05ad272288bba362e2757b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 40
+
+Style/ClassVars:
+  Enabled: false
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at janeterziev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jane-Terziev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# DryValidationParser
+
+Generate a readable hash by parsing the abstract syntax tree of a Dry::Validation::Contract schema
+
+The gem is still work in progress and is not yet fully tested.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry_validation_parser'
+```
+
+And then execute:
+
+    bundle install
+
+After installing, execute the following command:
+
+    rake dry_validation_parser:install
+
+This will generate configuration files in your project under `project/config/initializers`. See Configuration section for more details.
+
+## Usage
+
+#### Parsing a Dry::Validation::Contract
+Lets say we have the following Dry::Validation::Contract definition:
+
+    class TestContract < Dry::Validation::Contract
+        params do
+            required(:some_field).value(:str?, min_size?: 5, max_size?: 10)
+            required(:some_array_of_objects).array(:hash) do
+                required(:some_nested_attribute).value(:str?)
+            end
+            required(:some_array_of_integers).array(:int?)
+            required(:dto).value(:hash) do
+                optional(:some_nested_attribute).maybe(:str?)
+            end
+        end
+    end
+    
+    parser = DryValidationParser::ValidationSchemaParser.new
+
+`parser.call(TestContract)` will set the `keys` of the `parser` object to:
+
+    {
+        :some_field => {
+            :required => true,
+            :type => "string",
+            :description => "Minimum size: 5, Maximum size: 10"
+        },
+         :some_array_of_objects => { 
+            :required => true,
+            :array => true,
+            :type => "array",
+            :keys => {
+                :some_nested_attribute => {
+                    :required=>true, :type=>"string"
+                }
+            }
+         },
+         :some_array_of_integers => {
+            :required=>true, 
+            :array=>true, 
+            :type=>"integer"
+         },
+         :dto => {
+            :required => true,
+            :type => "hash",
+            :keys => {
+                :some_nested_attribute => {
+                    :required => false, 
+                    :"x-nullable"=>true, 
+                    :type=>"string"
+                }
+            }
+         }
+    }
+
+As we can see, the `DryValidationParser::ValidationSchemaParser` goes through all the params defined in the
+schema and generates a hash. The hash is saved in the `keys` attribute of the parser.
+
+The required key in our result will be set to `true` if the field is defined as
+`required(:field_name)`, and `false` if defined as `optional(:field_name)`.
+
+The "x-nullable" key depends on whether we have defined the field as value, maybe or filled.
+
+For nested objects like array of objects or hash, we add a keys field with a definition
+for each field inside the nested hash.
+
+If the field is an array of primitive type, the type field will equal to the primitive type, and a
+array flag will be set on the field.
+
+## Custom Configuration For Your Project
+You can override default configurations by changing the values in the `config/initializers/dry_validation_parser.rb` file generated from the rake command in the Installation section.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Jane-Terziev/dry_validation_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dry_validation_parser/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dry::Validation::Parser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Jane-Terziev/dry_validation_parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/dry_validation_parser/config/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DryValidationParser
+  module Config
+    module Configuration
+      def configuration
+        yield self
+      end
+
+      def define_setting(name, default = nil)
+        class_variable_set("@@#{name}", default)
+
+        define_class_method "#{name}=" do |value|
+          class_variable_set("@@#{name}", value)
+        end
+
+        define_class_method name do
+          class_variable_get("@@#{name}")
+        end
+      end
+
+      private
+
+      def define_class_method(name, &block)
+        (class << self; self; end).instance_eval do
+          define_method name, &block
+        end
+      end
+    end
+  end
+end

data/lib/dry_validation_parser/config/validation_configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DryValidationParser
+  module Config
+    module ValidationConfiguration
+      extend Configuration
+
+      define_setting :enable_required_validation, true
+      define_setting :enable_nullable_validation, true
+      define_setting :enable_enums, true
+      define_setting :enable_descriptions, true
+      define_setting :nullable_type, :"x-nullable"
+    end
+  end
+end

data/lib/dry_validation_parser/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "dry_validation_parser"
+require "rails"
+
+module DryValidationParser
+  class Railtie < Rails::Railtie
+    railtie_name :dry_validation_parser
+
+    rake_tasks do
+      load "dry_validation_parser/tasks/configuration_generator.rake"
+    end
+  end
+end

data/lib/dry_validation_parser/tasks/configuration_generator.rake

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+namespace "dry_validation_parser" do
+  desc "Create a configuration file for Dry Validation"
+  task :create_configuration_file do
+    FileUtils.mkdir_p "#{Dir.pwd}/config/initializers/"
+    puts "Created #{Dir.pwd}/config/initializers/dry_validation_parser.rb"
+    File.open("#{Dir.pwd}/config/initializers/dry_validation_parser.rb", "w") do |file|
+      file.puts 'DryValidationParser::Config::ValidationConfiguration.configuration do |config|
+  config.enable_required_validation = true
+  config.enable_nullable_validation = true
+  config.enable_enums = true
+  config.enable_descriptions = true
+  config.nullable_type = :"x-nullable" # or :nullable
+end'
+    end
+  end
+
+  desc "Create a YAML file for Dry Validation field descriptions"
+  task :create_validation_descriptions_yaml do
+    FileUtils.mkdir_p "#{Dir.pwd}/config/locales/"
+    puts "Created #{Dir.pwd}/config/locales/dry_validation_parser.yml"
+    File.open("#{Dir.pwd}/config/locales/dry_validation_parser.yml", "w") do |file|
+      file.puts 'en:
+  validation:
+    descriptions:
+      eql?: "Must be equal to %<value>s"
+      max_size?: "Maximum size: %<value>s"
+      min_size?: "Minimum size: %<value>s"
+      gteq?: "Greater than or equal to %<value>s"
+      gt?: "Greater than %<value>s"
+      lt?: "Lower than %<value>s"
+      lteq?: "Lower than or equal to %<value>s"
+'
+    end
+  end
+
+  desc "Creates configuration files"
+  task :install do
+    Rake::Task["dry_validation_parser:create_configuration_file"].execute
+    Rake::Task["dry_validation_parser:create_validation_descriptions_yaml"].execute
+  end
+end

data/lib/dry_validation_parser/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "dry/types"
+
+module DryValidationParser
+  module Types
+    include ::Dry.Types()
+  end
+end

data/lib/dry_validation_parser/validation_schema_parser.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module DryValidationParser
+  class ValidationSchemaParser
+    PREDICATE_TO_TYPE = {
+      array?: "array",
+      bool?: "boolean",
+      date?: "date",
+      date_time?: "datetime",
+      decimal?: "float",
+      float?: "float",
+      hash?: "hash",
+      int?: "integer",
+      nil?: "nil",
+      str?: "string",
+      time?: "time"
+    }.freeze
+
+    # @api private
+    attr_reader :keys
+
+    # @api private
+    def initialize
+      @keys = {}
+      @config = Config::ValidationConfiguration
+    end
+
+    # @api private
+    def to_h
+      { keys: keys }
+    end
+
+    # @api private
+    def call(contract, &block)
+      @keys = {}
+      visit(contract.schema.to_ast)
+      instance_eval(&block) if block_given?
+      self
+    end
+
+    # @api private
+    def visit(node, opts = {})
+      meth, rest = node
+      public_send(:"visit_#{meth}", rest, opts)
+    end
+
+    # @api private
+    def visit_set(node, opts = {})
+      target = (key = opts[:key]) ? self.class.new : self
+
+      node.map { |child| target.visit(child, opts) }
+
+      return unless key
+
+      target_info = target.to_h
+      type = keys[key][:array] ? "array" : "hash"
+
+      keys.update(key => { **keys[key], type: type, **target_info })
+    end
+
+    # @api private
+    def visit_and(node, opts = {})
+      left, right = node
+
+      visit(left, opts)
+      visit(right, opts)
+    end
+
+    # Skip or predicate
+    def visit_or(_, _); end
+
+    def visit_not(_node, opts = {})
+      keys[opts[:key]][@config.nullable_type] = true
+    end
+
+    # @api private
+    def visit_implication(node, opts = {})
+      node.each do |el|
+        opts = opts.merge(required: false)
+        visit(el, opts)
+      end
+    end
+
+    # @api private
+    def visit_each(node, opts = {})
+      visit(node, opts.merge(member: true))
+    end
+
+    # @api private
+    def visit_key(node, opts = {})
+      name, rest = node
+      opts = opts.merge(key: name)
+      opts = opts.merge(required: true)
+      visit(rest, opts)
+    end
+
+    # @api private
+    def visit_predicate(node, opts = {})
+      name, rest = node
+      key = opts[:key]
+      if name.equal?(:key?)
+        keys[rest[0][1]] = { required: opts.fetch(:required, true) }
+      elsif name.equal?(:array?)
+        keys[key][:array] = true
+      elsif name.equal?(:included_in?)
+        keys[key][:enum] = rest[0][1]
+        keys[key][:enum] += [nil] if opts.fetch(@config.nullable_type, false)
+      elsif PREDICATE_TO_TYPE[name]
+        keys[key][:type] = PREDICATE_TO_TYPE[name]
+      end
+    end
+  end
+end

data/lib/dry_validation_parser/version.rb

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

data/lib/dry_validation_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "dry_validation_parser/version"
+require_relative "dry_validation_parser/validation_schema_parser"
+require_relative "dry_validation_parser/config/configuration"
+require_relative "dry_validation_parser/config/validation_configuration"
+require_relative "dry_validation_parser/railtie" if defined?(Rails)
+
+module DryValidationParser
+  class Error < StandardError; end
+end

data/sig/dry_validation_parser.rbs

@@ -0,0 +1,4 @@
+module DryValidationParser
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: dry_validation_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jane-Terziev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: |-
+  A parser which converts dry-validation contract schema into a readable hash for further
+  manipulation
+email:
+- janeterziev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dry_validation_parser.rb
+- lib/dry_validation_parser/config/configuration.rb
+- lib/dry_validation_parser/config/validation_configuration.rb
+- lib/dry_validation_parser/railtie.rb
+- lib/dry_validation_parser/tasks/configuration_generator.rake
+- lib/dry_validation_parser/types.rb
+- lib/dry_validation_parser/validation_schema_parser.rb
+- lib/dry_validation_parser/version.rb
+- sig/dry_validation_parser.rbs
+homepage: https://github.com/Jane-Terziev/dry_validation_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Jane-Terziev/dry_validation_parser
+  source_code_uri: https://github.com/Jane-Terziev/dry_validation_parser
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Generate a readable hash from a dry-validation contract schema
+test_files: []