teckel 0.1.0 → 0.2.0

data/lib/teckel/operation/results.rb

@@ -2,10 +2,11 @@
 
 module Teckel
   module Operation
-    # Works just like +Teckel::Operation+, but wraps +output+ and +error+ into a +Teckel::Result+.
+    # Works just like {Teckel::Operation}, but wraps +output+ and +error+ into a
+    # {Teckel::Result Teckel::Result}.
     #
-    # A +Teckel::Result+ given as +input+ will get unwrapped, so that the original +value+
-    # gets passed to your Operation code.
+    # If a {Teckel::Result Teckel::Result} is given as +input+, it will get unwrapped,
+    # so that the original {Teckel::Result#value} gets passed to your Operation code.
     #
     # @example
     #
@@ -17,14 +18,13 @@ module Teckel
     #     error  Types::Hash.schema(message: Types::String, errors: Types::Array.of(Types::Hash))
     #
     #     # @param [Hash<name: String, age: Integer>]
-    #     # @return [User | Hash<message: String, errors: [Hash]>]
+    #     # @return [User,Hash<message: String, errors: [Hash]>]
     #     def call(input)
     #       user = User.new(name: input[:name], age: input[:age])
-    #       if user.safe
-    #         # exits early with success, prevents any further execution
-    #         success!(user)
+    #       if user.save
+    #         success!(user) # exits early with success, prevents any further execution
     #       else
-    #         fail!(message: "Could not safe User", errors: user.errors)
+    #         fail!(message: "Could not save User", errors: user.errors)
     #       end
     #     end
     #   end
@@ -43,9 +43,10 @@ module Teckel
     #   # Unwrapping failure input:
     #   CreateUser.call(Teckel::Result.new({name: "Bob", age: 23}, false)).success.is_a?(User) #=> true
     #
-    # @api public
+    # @!visibility public
     module Results
-      module InstanceMethods
+      # Overwrites the defaults {Teckel::Operation::Runner} to un/wrap input, output and error
+      class Runner < Teckel::Operation::Runner
         private
 
         def build_input(input)
@@ -64,7 +65,7 @@ module Teckel
 
       def self.included(receiver)
         receiver.send :include, Teckel::Operation unless Teckel::Operation >= receiver
-        receiver.send :include, InstanceMethods
+        receiver.send :runner, Runner
       end
     end
   end

data/lib/teckel/result.rb

@@ -24,13 +24,13 @@ module Teckel
   #  Teckel::Result.new("some error", false).success("other default") #=> "other default"
   #  Teckel::Result.new("some error", false).success { |value| "Failed: #{value}" } #=> "Failed: some error"
   #
-  # @api public
+  # @!visibility public
   class Result
     # @param value [Mixed] the value/payload of the result.
     # @param success [Bool] whether this is a successful result
     def initialize(value, success)
       @value = value
-      @success = success
+      @success = (!!success).freeze
     end
 
     # @!attribute [r] value

data/lib/teckel/version.rb

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

data/teckel.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "dry-struct", ">= 1.1.1", "< 2"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "yard"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teckel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Schulze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,26 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: dry-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/pages.yml"
 - ".gitignore"
@@ -118,7 +99,6 @@ files:
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -130,6 +110,7 @@ files:
 - lib/teckel.rb
 - lib/teckel/chain.rb
 - lib/teckel/config.rb
+- lib/teckel/none.rb
 - lib/teckel/operation.rb
 - lib/teckel/operation/results.rb
 - lib/teckel/result.rb
@@ -154,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Operations with enforced in/out/err data structures

data/Gemfile.lock

@@ -1,71 +0,0 @@
-PATH
-  remote: .
-  specs:
-    teckel (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    dry-configurable (0.9.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-    dry-container (0.7.2)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.0.5)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-struct (1.2.0)
-      dry-core (~> 0.4, >= 0.4.3)
-      dry-equalizer (~> 0.3)
-      dry-types (~> 1.0)
-      ice_nine (~> 0.11)
-    dry-types (1.2.2)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
-    ice_nine (0.11.2)
-    minitest (5.13.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    yard (0.9.22)
-    yard-doctest (0.1.17)
-      minitest
-      yard
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  dry-struct (>= 1.1.1, < 2)
-  rake (>= 10.0)
-  rspec (~> 3.0)
-  teckel!
-  yard
-  yard-doctest
-
-BUNDLED WITH
-   2.1.2