teckel 0.0.1 → 0.1.0

data/lib/teckel/result.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Teckel
+  # Wrapper for +output+ and +error+ return values of Operations
+  #
+  # @example asking for status
+  #
+  #   Teckel::Result.new("some output", true).successful? #=> true
+  #   Teckel::Result.new("some output", true).failure? #=> false
+  #
+  #   Teckel::Result.new("some error", false).successful? #=> false
+  #   Teckel::Result.new("some error", false).failure? #=> true
+  #
+  # @example Use +.value+ to get the wrapped value regardless of success state
+  #
+  #   Teckel::Result.new("some output", true).value #=> "some output"
+  #   Teckel::Result.new("some error", false).value #=> "some error"
+  #
+  # @example Use +.success+ to get the wrapped value of a successful result
+  #
+  #  # Note: The +.failure+ method works just the same for successful results
+  #  Teckel::Result.new("some output", true).success #=> "some output"
+  #  Teckel::Result.new("some error", false).success #=> nil
+  #  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
+  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
+    end
+
+    # @!attribute [r] value
+    # @return [Mixed] the value/payload
+    attr_reader :value
+
+    def successful?
+      @success
+    end
+
+    def failure?
+      !@success
+    end
+
+    def failure(default = nil, &block)
+      return @value if !@success
+      return yield(@value) if block
+
+      default
+    end
+
+    def success(default = nil, &block)
+      return @value if @success
+
+      return yield(@value) if block
+
+      default
+    end
+  end
+end

data/lib/teckel/version.rb

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

data/lib/teckel.rb

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 require "teckel/version"
 
 module Teckel
   class Error < StandardError; end
-  # Your code goes here...
 end
+
+require_relative "teckel/config"
+require_relative "teckel/operation"
+require_relative "teckel/result"
+require_relative "teckel/operation/results"
+require_relative "teckel/chain"

data/teckel.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "teckel/version"
 
@@ -8,21 +9,25 @@ Gem::Specification.new do |spec|
   spec.version       = Teckel::VERSION
   spec.authors       = ["Robert Schulze"]
   spec.email         = ["robert@dotless.de"]
+  spec.licenses      = ['Apache-2.0']
 
   spec.summary       = 'Operations with enforced in/out/err data structures'
   spec.description   = 'Wrap your business logic into a common interface with enforced input, output and error data structures'
-  spec.homepage      = "https://github.com/dotless-de/waldi"
+  spec.homepage      = "https://github.com/dotless-de/teckel"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `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) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.1"
+  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"
+  spec.add_development_dependency "yard-doctest"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teckel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Schulze
@@ -16,14 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        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
@@ -52,6 +72,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  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: Wrap your business logic into a common interface with enforced input,
   output and error data structures
 email:
@@ -60,19 +108,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/pages.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
+- DEVELOPMENT.md
 - Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - lib/teckel.rb
+- lib/teckel/chain.rb
+- lib/teckel/config.rb
+- lib/teckel/operation.rb
+- lib/teckel/operation/results.rb
+- lib/teckel/result.rb
 - lib/teckel/version.rb
 - teckel.gemspec
-homepage: https://github.com/dotless-de/waldi
-licenses: []
+homepage: https://github.com/dotless-de/teckel
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -89,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Operations with enforced in/out/err data structures

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.2