teckel 0.2.0 → 0.7.0

data/spec/rb27/pattern_matching_spec.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+@warning = Warning[:experimental]
+Warning[:experimental] = false
+
+require 'support/dry_base'
+require 'support/fake_models'
+
+RSpec.describe "Ruby 2.7 pattern matches for Result and Chain" do
+  module TeckelChainPatternMatchingTest
+    class CreateUser
+      include ::Teckel::Operation
+
+      result!
+
+      input  Types::Hash.schema(name: Types::String, age: Types::Coercible::Integer.optional)
+      output Types.Instance(User)
+      error  Types::Hash.schema(message: Types::String, errors: Types::Array.of(Types::Hash))
+
+      def call(input)
+        user = User.new(name: input[:name], age: input[:age])
+        if user.save
+          success!(user)
+        else
+          fail!(message: "Could not save User", errors: user.errors)
+        end
+      end
+    end
+
+    class LogUser
+      include ::Teckel::Operation
+
+      result!
+
+      input Types.Instance(User)
+      error none
+      output input
+
+      def call(usr)
+        Logger.new(File::NULL).info("User #{usr.name} created")
+        success! usr
+      end
+    end
+
+    class AddFriend
+      include ::Teckel::Operation
+
+      result!
+
+      settings Struct.new(:fail_befriend)
+
+      input Types.Instance(User)
+      output Types::Hash.schema(user: Types.Instance(User), friend: Types.Instance(User))
+      error  Types::Hash.schema(message: Types::String)
+
+      def call(user)
+        if settings&.fail_befriend
+          fail!(message: "Did not find a friend.")
+        else
+          success!(user: user, friend: User.new(name: "A friend", age: 42))
+        end
+      end
+    end
+
+    class Chain
+      include Teckel::Chain
+
+      step :create, CreateUser
+      step :log, LogUser
+      step :befriend, AddFriend
+    end
+  end
+
+  describe "Operation Result" do
+    context "success" do
+      specify "pattern matching with keys" do
+        x =
+          case TeckelChainPatternMatchingTest::AddFriend.call(User.new(name: "bob", age: 23))
+          in { success: false, value: value }
+            ["Failed", value]
+          in { success: true, value: value }
+            ["Success result", value]
+          else
+            raise "Unexpected Result"
+          end
+
+        expect(x).to contain_exactly("Success result", hash_including(:friend, :user))
+      end
+    end
+
+    context "failure" do
+      specify "pattern matching with keys" do
+        result =
+          TeckelChainPatternMatchingTest::AddFriend.
+          with(befriend: :fail).
+          call(User.new(name: "bob", age: 23))
+
+        x =
+          case result
+          in { success: false, value: value }
+            ["Failed", value]
+          in { success: true, value: value }
+            ["Success result", value]
+          else
+            raise "Unexpected Result"
+          end
+
+        expect(x).to contain_exactly("Failed", hash_including(:message))
+      end
+
+      specify "pattern matching array" do
+        result =
+          TeckelChainPatternMatchingTest::AddFriend.
+          with(befriend: :fail).
+          call(User.new(name: "bob", age: 23))
+
+        x =
+          case result
+          in [false, value]
+            ["Failed", value]
+          in [true, value]
+            ["Success result", value]
+          else
+            raise "Unexpected Result"
+          end
+        expect(x).to contain_exactly("Failed", hash_including(:message))
+      end
+    end
+  end
+
+  describe "Chain" do
+    context "success" do
+      specify "pattern matching with keys" do
+        x =
+          case TeckelChainPatternMatchingTest::Chain.call(name: "Bob", age: 23)
+          in { success: false, step: :befriend, value: value }
+              ["Failed", value]
+          in { success: true, value: value }
+            ["Success result", value]
+          else
+            raise "Unexpected Result"
+          end
+        expect(x).to contain_exactly("Success result", hash_including(:friend, :user))
+      end
+
+      specify "pattern matching array" do
+        x =
+          case TeckelChainPatternMatchingTest::Chain.call(name: "Bob", age: 23)
+          in [false, :befriend, value]
+              "Failed in befriend with #{value}"
+          in [true, _, value]
+            "Success result"
+          end
+        expect(x).to eq("Success result")
+      end
+    end
+
+    context "failure" do
+      specify "pattern matching with keys" do
+        result =
+          TeckelChainPatternMatchingTest::Chain.
+          with(befriend: :fail).
+          call(name: "bob", age: 23)
+
+        x =
+          case result
+          in { success: false, step: :befriend, value: value }
+              "Failed in befriend with #{value}"
+          in { success: true, value: value }
+            "Success result"
+          end
+        expect(x).to eq("Failed in befriend with #{ {message: "Did not find a friend."} }")
+      end
+
+      specify "pattern matching array" do
+        result =
+          TeckelChainPatternMatchingTest::Chain.
+          with(befriend: :fail).
+          call(name: "Bob", age: 23)
+
+        x =
+          case result
+          in [false, :befriend, value]
+              "Failed in befriend with #{value}"
+          in [true, value]
+            "Success result"
+          end
+        expect(x).to eq("Failed in befriend with #{ {message: "Did not find a friend."} }")
+      end
+    end
+  end
+end
+
+Warning[:experimental] = @warning

data/spec/result_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'support/dry_base'
+require 'support/fake_models'
+
+module TeckelResultTest
+  class MissingResultImplementation
+    include Teckel::Result
+    def initialize(value, success); end
+  end
+end
+
+RSpec.describe Teckel::Result do
+  describe "missing initialize" do
+    specify "raises NotImplementedError" do
+      result = TeckelResultTest::MissingResultImplementation["value", true]
+      expect { result.successful? }.to raise_error(NotImplementedError, "Result object does not implement `successful?`")
+      expect { result.failure? }.to raise_error(NotImplementedError, "Result object does not implement `successful?`")
+      expect { result.value }.to raise_error(NotImplementedError, "Result object does not implement `value`")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'simplecov_json_formatter'
+  SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
+  SimpleCov.start do
+    add_filter %r{^/spec/}
+  end
+end
+
+require "teckel"
+require "teckel/chain"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.formatter = config.files_to_run.size > 1 ? :progress : :documentation
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/dry_base.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'dry-types'
+require 'dry-struct'
+
+module Types
+  include Dry.Types()
+end

data/spec/support/fake_db.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FakeDB
+  Rollback = Class.new(RuntimeError)
+
+  def self.transaction
+    yield
+  rescue Rollback
+    # doing rollback ...
+    raise
+  end
+end

data/spec/support/fake_models.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class User
+  def initialize(name:, age:)
+    @name, @age = name, age
+  end
+  attr_reader :name, :age
+
+  def save
+    !underage?
+  end
+
+  def errors
+    underage? ? [{ age: "underage" }] : nil
+  end
+
+  def underage?
+    @age <= 18
+  end
+end

data/spec/teckel_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Teckel do
+  it "has a version number" do
+    expect(Teckel::VERSION).not_to be nil
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teckel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Robert Schulze
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,39 +88,57 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/pages.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
-- DEVELOPMENT.md
-- Gemfile
 - LICENSE
+- LICENSE_LOGO
 - README.md
-- Rakefile
-- bin/console
-- bin/rake
-- bin/rspec
-- bin/rubocop
-- bin/setup
 - lib/teckel.rb
 - lib/teckel/chain.rb
+- lib/teckel/chain/config.rb
+- lib/teckel/chain/result.rb
+- lib/teckel/chain/runner.rb
+- lib/teckel/chain/step.rb
 - lib/teckel/config.rb
-- lib/teckel/none.rb
+- lib/teckel/contracts.rb
 - lib/teckel/operation.rb
-- lib/teckel/operation/results.rb
+- lib/teckel/operation/config.rb
+- lib/teckel/operation/result.rb
+- lib/teckel/operation/runner.rb
 - lib/teckel/result.rb
 - lib/teckel/version.rb
-- teckel.gemspec
-homepage: https://github.com/dotless-de/teckel
+- spec/chain/around_hook_spec.rb
+- spec/chain/default_settings_spec.rb
+- spec/chain/inheritance_spec.rb
+- spec/chain/none_input_spec.rb
+- spec/chain/results_spec.rb
+- spec/chain_spec.rb
+- spec/config_spec.rb
+- spec/doctest_helper.rb
+- spec/operation/contract_trace_spec.rb
+- spec/operation/default_settings_spec.rb
+- spec/operation/fail_on_input_spec.rb
+- spec/operation/inheritance_spec.rb
+- spec/operation/result_spec.rb
+- spec/operation/results_spec.rb
+- spec/operation_spec.rb
+- spec/rb27/pattern_matching_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+- spec/support/dry_base.rb
+- spec/support/fake_db.rb
+- spec/support/fake_models.rb
+- spec/teckel_spec.rb
+homepage: https://github.com/fnordfish/teckel
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/fnordfish/teckel/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/fnordfish/teckel
+  bug_tracker_uri: https://github.com/fnordfish/teckel/issues
+  documentation_uri: https://www.rubydoc.info/gems/teckel/0.7.0
+  user_docs_uri: https://fnordfish.github.io/teckel/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,15 +146,37 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Operations with enforced in/out/err data structures
-test_files: []
+test_files:
+- spec/chain/around_hook_spec.rb
+- spec/chain/default_settings_spec.rb
+- spec/chain/inheritance_spec.rb
+- spec/chain/none_input_spec.rb
+- spec/chain/results_spec.rb
+- spec/chain_spec.rb
+- spec/config_spec.rb
+- spec/doctest_helper.rb
+- spec/operation/contract_trace_spec.rb
+- spec/operation/default_settings_spec.rb
+- spec/operation/fail_on_input_spec.rb
+- spec/operation/inheritance_spec.rb
+- spec/operation/result_spec.rb
+- spec/operation/results_spec.rb
+- spec/operation_spec.rb
+- spec/rb27/pattern_matching_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+- spec/support/dry_base.rb
+- spec/support/fake_db.rb
+- spec/support/fake_models.rb
+- spec/teckel_spec.rb

data/.codeclimate.yml

@@ -1,3 +0,0 @@
-plugins:
-  rubocop:
-    enabled: true

data/.github/workflows/ci.yml

@@ -1,92 +0,0 @@
-name: CI
-
-on:
-  push:
-    paths:
-      - .github/workflows/ci.yml
-      - lib/**
-      - spec/**
-      - Gemfile
-      - "*.gemspec"
-      - ".rubocop.yml"
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.4.x
-    - name: Install bundler
-      run: gem install bundler
-    - name: Run rubocop
-      run: bin/rubocop -ESD
-
-  cruby:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["2.6.x", "2.5.x", "2.4.x"]
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-    - name: Bundle install
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3 --without tools docs benchmarks
-    - name: Run all tests
-      run: bundle exec rake
-
-  other-ruby:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        image: ["jruby:9.2.9", "ruby:2.7"]
-        include:
-        - image: "ruby:2.7"
-          coverage: "true"
-    container:
-      image: ${{matrix.image}}
-
-    steps:
-      - uses: actions/checkout@v1
-      - name: Install git
-        run: |
-          apt-get update
-          apt-get install -y --no-install-recommends git
-      - name: Download test reporter
-        if: "matrix.coverage == 'true'"
-        run: |
-          mkdir -p tmp/
-          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
-          chmod +x ./tmp/cc-test-reporter
-          ./tmp/cc-test-reporter before-build
-      - name: Bundle install
-        env:
-          COVERAGE: ${{matrix.coverage}}
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3 --without tools docs benchmarks
-      - name: Run all tests
-        env:
-          COVERAGE: ${{matrix.coverage}}
-        run: bundle exec rake
-      - name: Send coverage results
-        if: "matrix.coverage == 'true'"
-        env:
-          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
-          GIT_COMMIT_SHA: ${{github.sha}}
-          GIT_BRANCH: ${{github.ref}}
-          GIT_COMMITTED_AT: ${{github.event.head_commit.timestamp}}
-        run: |
-          GIT_BRANCH=`ruby -e "puts ENV['GITHUB_REF'].split('/', 3).last"` \
-          GIT_COMMITTED_AT=`ruby -r time -e "puts Time.iso8601(ENV['GIT_COMMITTED_AT']).to_i"` \
-          ./tmp/cc-test-reporter after-build -t simplecov