appfuel 0.2.0

data/lib/appfuel/validation.rb

@@ -0,0 +1,80 @@
+require_relative 'validation/validator'
+require_relative 'validation/validator_pipe'
+
+module Appfuel
+  module Validation
+    class << self
+      # Dsl used create and register validators in the app container. The key
+      # needs to be the fully qualified feature or global.
+      #
+      #
+      # @example define 'global.foo' do
+      #            required(:test).filled(:str?)
+      #          end
+      #
+      #          this will add a validator in 'global.validators.foo'
+      #
+      # @example define 'auth.foo' do
+      #            required(:test).filled(:str?)
+      #          end
+      #
+      #          this will add a validator in 'features.auth.validators.foo'
+      #
+      # @param key [String] qualified key to global or feature namespace
+      # @param opts [Hash] options
+      # @return Validator
+      def define(name, opts = {}, &block)
+        key, basename = build_validator_key(name)
+        container     = Appfuel.app_container
+        validator     = build_validator(basename, opts, &block)
+        container.register(key, validator)
+      end
+
+      # Turns the block of code given into a Dry::Validation schema or formi
+      # which is then used to create our validator.
+      #
+      # @param name [String] key used to register this validator in the container
+      # @param opts [Hash] options to configure validator
+      # @option type [String] form or schema for dry validation
+      # @option fail_fast [Bool] tells the system to fail right away
+      # @return Validator
+      def build_validator(name, opts = {}, &block)
+        fail_fast   = opts[:fail_fast] == true ? true : false
+        schema_type = (opts.fetch(:type) { 'form' }).to_s.downcase
+
+        schema = create_dry_validator(schema_type, &block)
+        Validator.new(name, schema, fail_fast: fail_fast)
+      end
+
+      # Factory method create Dry::Validation::Schema or
+      # Dry::Validation::Schema::Form objects
+      #
+      # @param type [String] form or schema
+      def create_dry_validator(type, &block)
+        unless ['form', 'schema'].include?(type)
+          fail "validator type must 'form' or 'schema' (#{type}) given"
+        end
+
+        fail "block is required to build a validator" unless block_given?
+
+        method = type.capitalize
+        Dry::Validation.send(method, &block)
+      end
+      private
+
+      # Construct a full qualified namespace key to register a validator with.
+      # The basename of that key is used when creating the valdiator so it
+      # is returned with the key.
+      #
+      # @param name [String] partial namespace string of container key
+      # @return [Array] the fully qualified key and the basename
+      def build_validator_key(name)
+        key, *parts = name.to_s.split('.')
+        key = "features.#{key}" unless key == 'global'
+        ["#{key}.validators.#{parts.join('.')}", parts.last]
+      end
+
+    end
+  end
+end
+

data/lib/appfuel/validation/validator.rb

@@ -0,0 +1,59 @@
+module Appfuel
+  module Validation
+    # Any validator that is run for an action or command will be created with
+    # this class. It service to abstract away Dry::Validation, the library we
+    # use from the system that runs all the validators. This allows us to use
+    # validators along side things like validator pipes without the system
+    # having to care.
+    class Validator
+      attr_reader :name, :schema
+
+      # @param name [String] used to register this validator in a container
+      # @param schema [Dry::Validation::Schema] the actual validator
+      # @param fail_fast [Bool] tell the system how to fail
+      # @return [Validator]
+      def initialize(name, schema, fail_fast: false)
+        @name = name
+        unless schema.respond_to?(:call)
+          fail ArgumentError, "schema must implement :call"
+        end
+        @schema = schema
+
+        fail_fast == true ? enable_fail_fast : disable_fail_fast
+      end
+
+      # Ensures the system will stop validating when this validator fails
+      #
+      # @return [Bool]
+      def enable_fail_fast
+        @fail_fast = true
+      end
+
+      # Ensures the system will continue validating when errors exist
+      #
+      # @return [Bool]
+      def disable_fail_fast
+        @fail_fast = false
+      end
+
+      # @return [Bool]
+      def fail_fast?
+        @fail_fast
+      end
+
+
+      # Delegate's to the Dry::Validation schema to validate the inputs
+      #
+      # @param inputs [Hash]
+      # @return [Dry::Validation::Result]
+      def call(inputs)
+        schema.call(inputs)
+      end
+
+      # Tell this system this is not a validation pipe
+      def pipe?
+        false
+      end
+    end
+  end
+end

data/lib/appfuel/validation/validator_pipe.rb

@@ -0,0 +1,47 @@
+module Appfuel
+  module Validation
+    # A pipe is just a lambda that take two arguments. It is designed to
+    # live between two validators in an array and maninuplate the output
+    # of the first validator to satisfy the secord. It is needed when
+    # you want to use two reusable validators that don't quite work
+    # togather.
+    class ValidatorPipe
+      attr_reader :name, :dependencies, :code
+
+      #
+      # @param name [String] key used for errors & containers
+      # @param dependencies [Hash] for dependency injection
+      # @return [ValidatorPipe]
+      def initialize(name, dependencies = {}, &block)
+        unless block_given?
+          fail ArgumentError, "block is required"
+        end
+
+        unless block.arity == 2
+          fail ArgumentError, "validator pipe block needs two params"
+        end
+
+        @name = name
+        @code = block
+        @dependencies = dependencies
+      end
+
+      # Because validator and pipe live togather in the same array. The
+      # system runner needs to be able to tell them apart.
+      #
+      # @return [TrueCase]
+      def pipe?
+        true
+      end
+
+      # Delegate call to the actual pipe lambda
+      #
+      # @param inputs [Hash]
+      # @param data [Dry::Container] dependency injection container
+      # @return [Hash] new inputs for the next validator
+      def call(inputs, data = Dry::Container.new)
+        code.call(inputs, data)
+      end
+    end
+  end
+end

data/lib/appfuel/version.rb

@@ -0,0 +1,3 @@
+module Appfuel
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,335 @@
+--- !ruby/object:Gem::Specification
+name: appfuel
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Robert Scott-Buccleuch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry-awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.6.1
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+description: A library that allows you to isolate your business code
+email:
+- rsb.code@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- appfuel.gemspec
+- bin/console
+- bin/setup
+- lib/appfuel.rb
+- lib/appfuel/application.rb
+- lib/appfuel/application/app_container.rb
+- lib/appfuel/application/container_class_registration.rb
+- lib/appfuel/application/container_key.rb
+- lib/appfuel/application/qualify_container_key.rb
+- lib/appfuel/application/root.rb
+- lib/appfuel/cli_msg_request.rb
+- lib/appfuel/configuration.rb
+- lib/appfuel/configuration/definition_dsl.rb
+- lib/appfuel/configuration/file_loader.rb
+- lib/appfuel/configuration/populate.rb
+- lib/appfuel/configuration/search.rb
+- lib/appfuel/db_model.rb
+- lib/appfuel/domain.rb
+- lib/appfuel/domain/criteria.rb
+- lib/appfuel/domain/domain_name_parser.rb
+- lib/appfuel/domain/dsl.rb
+- lib/appfuel/domain/entity.rb
+- lib/appfuel/domain/entity_collection.rb
+- lib/appfuel/domain/expr.rb
+- lib/appfuel/domain/value_object.rb
+- lib/appfuel/errors.rb
+- lib/appfuel/feature.rb
+- lib/appfuel/feature/action_loader.rb
+- lib/appfuel/feature/initializer.rb
+- lib/appfuel/handler.rb
+- lib/appfuel/handler/action.rb
+- lib/appfuel/handler/base.rb
+- lib/appfuel/handler/command.rb
+- lib/appfuel/handler/inject_dsl.rb
+- lib/appfuel/handler/validator_dsl.rb
+- lib/appfuel/initialize.rb
+- lib/appfuel/initialize/initializer.rb
+- lib/appfuel/msg_request.rb
+- lib/appfuel/predicates.rb
+- lib/appfuel/presenter.rb
+- lib/appfuel/presenter/base.rb
+- lib/appfuel/repository.rb
+- lib/appfuel/repository/base.rb
+- lib/appfuel/repository/initializer.rb
+- lib/appfuel/repository/mapper.rb
+- lib/appfuel/repository/mapping_dsl.rb
+- lib/appfuel/repository/mapping_entry.rb
+- lib/appfuel/repository/mapping_registry.rb
+- lib/appfuel/repository_runner.rb
+- lib/appfuel/request.rb
+- lib/appfuel/response.rb
+- lib/appfuel/response_handler.rb
+- lib/appfuel/root_module.rb
+- lib/appfuel/run_error.rb
+- lib/appfuel/storage.rb
+- lib/appfuel/storage/db.rb
+- lib/appfuel/storage/db/active_record_model.rb
+- lib/appfuel/storage/db/mapper.rb
+- lib/appfuel/storage/db/migration_initializer.rb
+- lib/appfuel/storage/db/migration_runner.rb
+- lib/appfuel/storage/db/migration_tasks.rb
+- lib/appfuel/storage/db/repository.rb
+- lib/appfuel/storage/db/repository_query.rb
+- lib/appfuel/storage/file.rb
+- lib/appfuel/storage/file/base.rb
+- lib/appfuel/storage/memory.rb
+- lib/appfuel/storage/memory/mapper.rb
+- lib/appfuel/storage/memory/repository.rb
+- lib/appfuel/types.rb
+- lib/appfuel/validation.rb
+- lib/appfuel/validation/validator.rb
+- lib/appfuel/validation/validator_pipe.rb
+- lib/appfuel/version.rb
+homepage: https://github.com/rsb/appfuel
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Appfuel decouples your business code from its API framework
+test_files: []