broi-input 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d4bf01c2fc021ccffa526f54dbffdcb6c08670e70a85727293265a38d47d33
-  data.tar.gz: 11ff7e9d518d43152c5a8a8c6bf02ffa6737dd666d77d94c5d667ca4b27a7d50
+  metadata.gz: 9ec70915468a81f1e76fd79fa968c819a708c8d65040b2feee9da121f6f21458
+  data.tar.gz: 1ba022fe06b37bac5d8d59aa263420cd5069cc481a215c43dbb58c5b2e665093
 SHA512:
-  metadata.gz: 6de0dbefbe0fc3620826d4d84b5fdd70363c0794621701596a1962f475fdbd2cead1cba392e546cb9f7fe86bb34339ec77210ce7559f0eb615022d9352fdc72d
-  data.tar.gz: 51b957814dfdda10fef8beb2291f4d8527a6d606c7158396bb90b99c3b45c43ddb1c37443b5f5cdc651f589bdbd563b1c42eb403a7c04ce52969fe878de8a5e4
+  metadata.gz: 35b14bb7ffa1339d748fb21cc66bb545ff231dde3f78798282199adfc72f192af22cba0e86e9780750948ebc0129f83805bd54a52918596097bd041fb943d603
+  data.tar.gz: 781d9b48dc23b59c32cf24ed7c174e3c04c2dca8de0edaafeada7321e244776cc5a32ddf668888a5a6540518f796362f02adc4eec3d8bd5977c6aaa3a0d96181

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    broi-input (0.1.0)
+    broi-input (0.1.1)
+      dry-monads (~> 1.0)
       dry-struct (~> 0.5)
-      dry-transaction (~> 0.13)
       dry-validation (~> 0.12)
 
 GEM
@@ -21,16 +21,11 @@ GEM
     dry-core (0.4.7)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.2.1)
-    dry-events (0.1.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
     dry-inflector (0.1.2)
     dry-logic (0.4.2)
       dry-container (~> 0.2, >= 0.2.6)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-matcher (0.7.0)
     dry-monads (1.0.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.4)
@@ -40,11 +35,6 @@ GEM
       dry-equalizer (~> 0.2)
       dry-types (~> 0.13)
       ice_nine (~> 0.11)
-    dry-transaction (0.13.0)
-      dry-container (>= 0.2.8)
-      dry-events (>= 0.1.0)
-      dry-matcher (>= 0.7.0)
-      dry-monads (>= 0.4.0)
     dry-types (0.13.2)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
@@ -52,7 +42,7 @@ GEM
       dry-equalizer (~> 0.2)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.4, >= 0.4.2)
-    dry-validation (0.12.0)
+    dry-validation (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
       dry-core (~> 0.2, >= 0.2.1)

data/README.md

@@ -1,43 +1,70 @@
-# Input
+# Broi::Input
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/input`. To experiment with that code, run `bin/console` for an interactive prompt.
+This library provides flexible API to deal with incoming ruby messages. It converts incoming hash onto predefined, structured object by passing it through predefined input validations.
 
-TODO: Delete this and the text above, and describe your gem
+Example:
 
-## Installation
+```ruby
+class PurchaseInput < Broi::Input
+  attribute :product
+  attribute :count, default: 1
+  
+  validate do
+    required(:product).filled(:str?)
+    optional(:count).maybe(:int?) 
+  end
+end
+```
+
+###Processing incoming hash
 
-Add this line to your application's Gemfile:
+You instantiate the input by executing `call` method which, depending on the validation resutls, returns an instance of Broi::Input::Success/Failure.
 
 ```ruby
-gem 'input'
+PurchaseInput.(product: 'Apple')
+#=> #Success(<#PurchaseInput|soft product=#Value('Apple')>)
+
+
+PurchaseInput.(product: 123)
+#=> Failure({:product => ["must be string"])
 ```
 
-And then execute:
+### Soft input struct
 
-    $ bundle
+Regardless of the validation result, you can always obtain soft input result by calling `input` on the result:
 
-Or install it yourself as:
+```ruby
+PurchaseInput.(product: 'Apple').input
+#=> <#PurchaseInput|soft product=#Value('Apple')>
 
-    $ gem install input
+PurchaseInput.(product: 123).input
+#=> <#PurchaseInput|soft product=#InvalidValue(123)>
+```
 
-## Usage
+All the values accessible through the soft input are either `Broi::Input::Value`/`InvalidValue` and they respond to `valid?` and `invalid?` methods.
 
-TODO: Write usage instructions here
+### Strict input
 
-## Development
+You can turn soft input into a strict input by calling `valid!`. Strict input is just typical Dry::Struct:
 
-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.
+```ruby
+PurchaseInput.(product: 'Apple').input.valid!
+#=> <#PurchaseInput product='Apple'>
 
-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).
+PurchaseInput.(product: 123).input.valid!
+#! raises: Broi::Input::Invalid 
+```
 
-## Contributing
+### Validation errors
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/input. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Errors can be collected directly from the processing result.
 
-## License
+```ruby
+PurchaseInput.(product: 'Apple').errors
+#=> {}
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+PurchaseInput.(product: 123).errors
+#=> {:product => ["must be string"])
+```
 
-## Code of Conduct
 
-Everyone interacting in the Input project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/input/blob/master/CODE_OF_CONDUCT.md).

data/input.gemspec

@@ -4,17 +4,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'broi-input'
-  spec.version       = '0.1.1'
+  spec.version       = '0.1.2'
   spec.authors       = ['broisatse']
   spec.email         = ['sklajn@gmail.com']
 
   spec.summary       = 'Simple ruby object to handle user inputs'
-  spec.description   = %q{Destructure incoming user input onto dry struct}
+  spec.description   = 'Destructures incoming user input onto dry struct'
   spec.homepage      = 'https://github.com/BroiSatse/broi-input'
   spec.license       = 'MIT'
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -22,10 +23,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dry-validation', '~> 0.12'
   spec.add_dependency 'dry-struct', '~> 0.5'
+  spec.add_dependency 'dry-monads', '~> 1.0'
 
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'byebug'
 end

data/lib/broi/input/failure.rb

@@ -0,0 +1,16 @@
+module Broi
+  class Input < Dry::Struct::Value
+    class Failure < Dry::Monads::Failure
+      def initialize(input, errors)
+        @input = input
+        super(errors)
+      end
+
+      attr_reader :input
+
+      def errors
+        failure
+      end
+    end
+  end
+end

data/lib/broi/input/invalid_error.rb

@@ -0,0 +1,5 @@
+module Broi
+  class Input < Dry::Struct::Value
+    Invalid = Class.new(StandardError)
+  end
+end

data/lib/broi/input/invalid_value.rb

@@ -0,0 +1,17 @@
+module Broi
+  class Input < Dry::Struct::Value
+    class InvalidValue < Dry::Monads::Failure
+      def inspect
+        "#InvalidValue(#{failure.inspect})"
+      end
+
+      def valid?
+        false
+      end
+
+      def invalid?
+        true
+      end
+    end
+  end
+end

data/lib/broi/input/soft.rb

@@ -0,0 +1,54 @@
+require 'broi/input/invalid_error'
+
+module Broi
+  class Input < Dry::Struct::Value
+    module SoftInput
+      def self.included(mod)
+        mod.extend ClassMethods
+      end
+
+      def valid!
+        self.class.superclass.new Utils.deep_transform_values(attributes, &:value!)
+      rescue Dry::Monads::UnwrapError
+        raise Invalid, 'Called `valid!` on invalid soft input!'
+      end
+
+      def strict?
+        false
+      end
+
+      module ClassMethods
+        def inspect
+          "#{superclass.name}|soft"
+        end
+      end
+    end
+
+    module Soft
+      class << self
+        def [](klass)
+          register[klass]
+        end
+
+        private
+
+        def register
+          @register ||= Hash.new do |hash, klass|
+            hash[klass] = Class.new(klass).include(SoftInput)
+          end
+        end
+      end
+
+      def self.call(input_class, attrs, errors)
+        attrs = input_class.input[attrs]
+        input = Utils.deep_merge(attrs, errors) do |target, _error|
+          InvalidValue.new(target)
+        end
+        input = Utils.deep_transform_values(input) do |value|
+          value.is_a?(InvalidValue) ? value : Value.new(value)
+        end
+        self[input_class].new(input)
+      end
+    end
+  end
+end

data/lib/broi/input/success.rb

@@ -0,0 +1,13 @@
+module Broi
+  class Input < Dry::Struct::Value
+    class Success < Dry::Monads::Success
+      def input
+        value!
+      end
+
+      def errors
+        {}
+      end
+    end
+  end
+end

data/lib/broi/input/utils.rb

@@ -0,0 +1,32 @@
+module Broi
+  class Input < Dry::Struct::Value
+    module Utils
+      extend self
+
+      def deep_transform_values(object, &block)
+        if object.is_a?(Hash)
+          object.transform_values { |value| deep_transform_values(value, &block) }
+        else
+          block.(object)
+        end
+      end
+
+      def deep_merge(target, source, &block)
+        if target.is_a?(Hash) && source.is_a?(Hash)
+          keys = (target.keys + source.keys).uniq
+          keys.map do |key|
+            value = if [target, source].all? { |h| h.key? key }
+              deep_merge(target[key], source[key], &block)
+            else
+              [target[key], source[key]].compact.first
+            end
+            [key, value]
+          end.to_h
+        else
+          block ||= ->(_target, source) { source }
+          block.(target, source)
+        end
+      end
+    end
+  end
+end

data/lib/broi/input/value.rb

@@ -0,0 +1,17 @@
+module Broi
+  class Input < Dry::Struct::Value
+    class Value < Dry::Monads::Success
+      def inspect
+        "#Value(#{value!.inspect})"
+      end
+
+      def valid?
+        true
+      end
+
+      def invalid?
+        false
+      end
+    end
+  end
+end

data/lib/broi/input.rb

@@ -1,10 +1,18 @@
 require 'dry-struct'
-require 'dry/transaction'
 require 'dry/validation'
+require 'dry/monads/result'
+
+require 'broi/input/success'
+require 'broi/input/failure'
+require 'broi/input/utils'
+require 'broi/input/value'
+require 'broi/input/invalid_value'
+require 'broi/input/soft'
+
+require 'byebug'
 
 module Broi
   class Input < Dry::Struct::Value
-    # include Dry::Transaction
 
     module Types
       include Dry::Types.module
@@ -12,10 +20,14 @@ module Broi
 
     transform_keys(&:to_sym)
 
+    def strict?
+      true
+    end
+
     class << self
-      def attribute(name, type = nil, **opts, &block)
-        type ||= Types::Any
-        type = type.optional.meta(omittable: true)
+
+      def attribute(name, **opts, &block)
+        type = Types::Any.optional.meta(omittable: true)
         type = type.default(opts[:default]) if opts.has_key?(:default)
         super(name, type, &block)
       end
@@ -30,10 +42,29 @@ module Broi
 
       def call(params = {})
         result = validation.(params)
+        input = Soft.(self, result.output, result.errors)
+        # output = input[result.output]
+        # input = Utils.deep_merge(output, result.errors) do |target, _error|
+        #   InvalidValue.new(target)
+        # end
+        # input = Utils.deep_transform_values(input) do |value|
+        #   value.is_a?(InvalidValue) ? value : Value.new(value)
+        # end
+        # input = new(input)
         if result.success?
-          Dry::Monads::Success.new new(result.output)
+          Success.new(input)
+        else
+          Failure.new(input, result.errors)
+        end
+      end
+
+      private
+
+      def merge_error(input_value, error)
+        if input_value.is_a? Hash
+
         else
-          Dry::Monads::Failure.new result.errors
+          error ? InvalidValue.new : input_value
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: broi-input
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - broisatse
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +108,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: Destructure incoming user input onto dry struct
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Destructures incoming user input onto dry struct
 email:
 - sklajn@gmail.com
 executables: []
@@ -114,6 +142,13 @@ files:
 - bin/setup
 - input.gemspec
 - lib/broi/input.rb
+- lib/broi/input/failure.rb
+- lib/broi/input/invalid_error.rb
+- lib/broi/input/invalid_value.rb
+- lib/broi/input/soft.rb
+- lib/broi/input/success.rb
+- lib/broi/input/utils.rb
+- lib/broi/input/value.rb
 homepage: https://github.com/BroiSatse/broi-input
 licenses:
 - MIT