dryer_factories 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18286ce2561d13272e7fbd832db21eeaecbff6ff36c71e66f492ad7e10fca800
+  data.tar.gz: e01e177bbfacd57ab481e87401582b84d4e29ae6468bdd8a787932f05d53c0f1
+SHA512:
+  metadata.gz: 0c2587adad52a5703f84dd7a16fced350f95d9577a0cd6579a910e78455d56e0a31471e0625590bf1a5763bff65313930ba3e941fffed370c6724626a643b9e2
+  data.tar.gz: 2e3d26a0a4e5d1f2a533d368eb929fab80d05619c317e8157cc297f5684c1480cf13083a96b26fdd35f7be3fabc9a5a83501e1b908d260b684cf8dd1d75dc0ea

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+Copyright (c) 2023 John Bernier
+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,76 @@
+
+# Dryer Factories
+Dryer Factories generates test data from an instance of [Dry::Validation::Contract](https://dry-rb.org/gems/dry-validation/1.10/)
+
+## Installation
+add the following to you gemfile
+```
+gem "dryer_factories"
+```
+
+## Usage
+```
+test "POST 200 - successfully creating a user" do
+    request = Dryer::Factories::BuildFromContract.call(
+      ApiResources::Users::Post.request_contract
+    )
+    post ApiResources::Users::Post.url, params: request.as_json
+
+    assert_response :success
+end
+```
+
+## Features
+### Built in Generators
+This gem currently only provides default generators for `String` `Hash` and `Array` types. Support for other types will be added as needed.
+[Documentation for the built in dry types](https://dry-rb.org/gems/dry-types/1.7/built-in-types/)
+
+
+### Custom Types and Generators
+You can create new types based on the existing `Dry::Types` and then provide
+a lambda function for your generator as part of the type's metadata
+
+Example:
+```
+module Contracts
+    module Types
+        dry_types = Dry::Types(default: :params)
+        Email = dry_types::String.meta(
+            generator: lambda { Faker::Internet.email }
+        )
+        Password = dry_types::String.meta(
+            generator: lambda { Faker::Internet.password }
+        )
+    end
+end
+```
+
+## Limitations
+Type contstraints and that are not encoded in the custom generator are ignored.
+For example:
+```
+    required(:contacts).value(:array, min_size?: 3)
+```
+will not cause the generator to create an array of length 3, it will generate an
+array of length 1.
+For arrays specifically, there is currently no way to generate an array larger
+than length 1.
+
+## Development
+This gem is set up to be developed using [Nix](https://nixos.org/)
+Once you have nix installed you can run
+`make bundle`
+to install all dependencies and
+`make dev-shell`
+to enter the development environment.
+
+## Contributing
+Please create a github issue to report any problems using the Gem.
+Thanks for your help in making testing easier for everyone!
+
+## Versioning
+Dryer Factories follows Semantic Versioning 2.0 as defined at https://semver.org.
+
+## License
+This code is free to use under the terms of the MIT license.
+

data/dryer_factories.gemspec

@@ -0,0 +1,35 @@
+#require File.expand_path('lib/dryer/factories/version.rb', __dir__)
+Gem::Specification.new do |spec|
+  spec.name                  = 'dryer_factories'
+
+  # this should be imported from lib/dryer/factories/version.rb
+  # but I am having nix issues with importing the version file
+  # when this file is evaluated
+  #spec.version               = Dryer::Factories::Version 
+  spec.version               = "0.0.2"
+  spec.authors               = ['John Bernier']
+  spec.email                 = ['john.b.bernier@gmail.com']
+  spec.summary               = 'Generate payloads from dry-validation definitions'
+  spec.description           = <<~DOC
+    An extension of the Dry family of gems (dry-rb.org).
+    This gem can generate valid payloads for contracts defined using the
+    dry-validation gem.
+  DOC
+  spec.homepage              = 'https://github.com/jbernie2/dryer-factories'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 3.0.0'
+  spec.files = Dir[
+    'README.md',
+    'LICENSE',
+    'CHANGELOG.md',
+    'lib/**/*.rb',
+    'dryer_factories.gemspec',
+    '.github/*.md',
+    'Gemfile'
+  ]
+  spec.add_dependency "dry-validation", "~> 1.10"
+  spec.add_dependency "dry-types", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "debug", "~> 1.8"
+end

data/lib/dryer/factories/build_from_contract.rb

@@ -0,0 +1,39 @@
+require_relative "./simple_service.rb"
+require_relative "./generated_payload.rb"
+require_relative "./fields/build.rb"
+
+module Dryer
+  module Factories
+    class BuildFromContract < SimpleService
+      def initialize(contract)
+        @contract = contract
+        check_contract_type!
+      end
+
+      def check_contract_type!
+        raise(
+          "#{self.class}.call: Argument must be an instance "+
+          "or subclass of Dry::Validation::Contract"
+        ) unless contract.respond_to?(:ancestors) &&
+          contract.ancestors.include?(Dry::Validation::Contract)
+      end
+
+      def call
+        gen_object = Object.new
+        contract.schema.types.inject({}) do |fields, (field_name, field_type)|
+          fields.merge(Fields::Build.call(
+            name: field_name.to_sym,
+            type: field_type
+          ))
+        end.then do |fields|
+          GeneratedPayload.new(
+            contract: contract,
+            fields: fields
+          )
+        end
+      end
+
+      attr_reader :contract
+    end
+  end
+end

data/lib/dryer/factories/fields/build.rb

@@ -0,0 +1,48 @@
+require_relative "../simple_service.rb"
+
+module Dryer
+  module Factories
+    module Fields
+      class Build < SimpleService
+        def initialize(name:, type:)
+          @name = name
+          @type = type
+        end
+
+        def call
+          build_field(name, type)
+        end
+
+        private
+
+        def build_field(field_name, field_type)
+          { field_name => build_field_value(field_type) }
+        end
+
+        def build_field_value(field_type)
+          generator = field_type.meta[:generator]
+          if generator
+            generator.call
+          else
+            case field_type.type.name
+            when "String"
+              SecureRandom.uuid.to_s
+            when "Hash"
+              generate_hash(field_type)
+            when "Array"
+              [ build_field_value(field_type.type.member) ]
+            end
+          end
+        end
+
+        def generate_hash(field_type)
+          field_type.keys.inject({}) do |hash, k|
+            hash.merge(build_field(k.name, k.type))
+          end
+        end
+
+        attr_reader :name, :type
+      end
+    end
+  end
+end

data/lib/dryer/factories/generated_payload.rb

@@ -0,0 +1,33 @@
+module Dryer
+  module Factories
+    class GeneratedPayload
+      def initialize(contract:, fields:)
+        @contract = contract
+        @fields = fields
+        create_instance_variables
+      end
+
+      def create_instance_variables
+        fields.inject(self) do |obj, (name, value)|
+          self.define_singleton_method(name.to_sym) { value }
+        end
+      end
+
+      def to_h
+        fields
+      end
+
+      def as_json
+        to_h
+      end
+
+      def to_json
+        to_h.to_json
+      end
+
+      attr_reader :contract
+      private
+      attr_reader :fields
+    end
+  end
+end

data/lib/dryer/factories/simple_service.rb

@@ -0,0 +1,13 @@
+module Dryer
+  module Factories
+    class SimpleService
+      def self.call(*args)
+        if args.length == 1 && args[0].is_a?(Hash)
+          new(**args[0]).call
+        else
+          new(*args).call
+        end
+      end
+    end
+  end
+end

data/lib/dryer/factories/version.rb

@@ -0,0 +1,5 @@
+module Dryer
+  module Factories
+    VERSION = '0.0.1'
+  end
+end

data/lib/dryer_factories.rb

@@ -0,0 +1 @@
+require_relative "./dryer/factories/build_from_contract.rb"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: dryer_factories
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Bernier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: |
+  An extension of the Dry family of gems (dry-rb.org).
+  This gem can generate valid payloads for contracts defined using the
+  dry-validation gem.
+email:
+- john.b.bernier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- dryer_factories.gemspec
+- lib/dryer/factories/build_from_contract.rb
+- lib/dryer/factories/fields/build.rb
+- lib/dryer/factories/generated_payload.rb
+- lib/dryer/factories/simple_service.rb
+- lib/dryer/factories/version.rb
+- lib/dryer_factories.rb
+homepage: https://github.com/jbernie2/dryer-factories
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Generate payloads from dry-validation definitions
+test_files: []