teckel 0.3.0 → 0.4.0

data/.github/workflows/pages.yml

@@ -1,50 +0,0 @@
-name: pages
-
-on:
-  push:
-    branches:
-      - master
-    paths:
-      - .github/workflows/pages.yml
-      - lib/**
-      - README.md
-      - .yardopts
-      - Rakefile
-
-jobs:
-  build-docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Bundle install
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3 --without tools docs benchmarks
-    - name: Build docs
-      run: 'bin/rake docs:yard'
-    - name: config git
-      run: |
-        git config --local user.email "action@github.com"
-        git config --local user.name "GitHub Action"
-    - name: Checkout Pages
-      run: 'git fetch origin gh-pages && git checkout gh-pages'
-    - name: Replace and commit docs
-      run: |
-        rm -rf doc && mv _yardoc doc
-        git add -A doc
-        git commit -m"Update API docs"
-    - name: Replace index
-      run: |
-        git checkout master README.md
-        mv -f README.md index.md
-        if [ ! -z "$(git diff --name-only -- index.md)" ]; then
-        git commit index.md -m"update index"
-        fi
-    - name: Push
-      env:
-        INPUT_GITHUB_TOKEN: "${{ secrets.DEPLOY_TOKEN }}"
-      run: git push https://git:${INPUT_GITHUB_TOKEN}@github.com/fnordfish/teckel.git gh-pages

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-.rubocop-http*
-
-/Gemfile.lock

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,12 +0,0 @@
-inherit_from:
-  - https://relaxed.ruby.style/rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.6.5

data/DEVELOPMENT.md

@@ -1,32 +0,0 @@
-# Development Guidelines
-
-- Keep it simple.
-- Favor easy debug-ability over clever solutions.
-- Aim to be a 0-dependency lib (at runtime)
-
-## Roadmap
-
-- Add "Settings"/Dependency injection for Operations and Chains
-
-    ```
-    MyOp.with(foo: "bar").call("input")
-
-    class MyOp
-      settings Types::Hash.schema(foo: Types::String)
-
-      def call(input)
-        input == "input"
-        settings.foo == "bar"
-      end
-    end
-
-    MyCain.with(:step1) { { foo: "bar" } }.with(:stepX) { { another: :setting} }.call(params)
-    ```
-- Add a dry-monads mixin to wrap Operations and Chains result/error into a Result Monad (for example see https://dry-rb.org/gems/dry-types/master/extensions/monads/)
-    ```
-    MyOp.call("input").to_monad do
-    end
-    ```
-- Check if/how to deal with inheritance 
-- ...
-

data/Gemfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in teckel.gemspec
-gemspec
-
-group :development, :test do
-  gem "dry-struct", ">= 1.1.1", "< 2"
-end
-
-group :test do
-  gem "simplecov", require: false
-end

data/Rakefile

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
-require "yard/doctest/rake"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :docs do
-  Rake::Task["docs:yard"].invoke
-  Rake::Task["docs:yard:doctest"].invoke
-end
-
-namespace :docs do
-  YARD::Rake::YardocTask.new do |t|
-    t.files   = ['lib/**/*.rb']
-    t.options = []
-    t.stats_options = ['--list-undoc']
-  end
-
-  task :fswatch do
-    sh 'fswatch -0 lib | while read -d "" e; do rake docs:yard; done'
-  end
-
-  YARD::Doctest::RakeTask.new do |task|
-    task.doctest_opts = %w[-v]
-    task.pattern = Dir.glob('lib/**/*.rb')
-  end
-end
-
-task :default do
-  Rake::Task["spec"].invoke
-  Rake::Task["docs:yard:doctest"].invoke
-end

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "teckel"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/rake

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-                                           Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path('bundle', __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-                                           Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path('bundle', __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/inline'
-require 'bundler'
-
-# We need the `Bundler.settings.temporary` for a bundler bug:
-# https://github.com/bundler/bundler/issues/7114
-# Will get fixed in bundler version 2.1.0
-Bundler.settings.temporary(frozen: false) do
-  gemfile do
-    source 'https://rubygems.org'
-    gem 'rubocop', '~> 0.78.0'
-    gem 'relaxed-rubocop', '2.4'
-  end
-end
-
-load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/teckel/none.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Teckel
-  # Simple type object for enforcing +input+, +output+ or +error+ data to be
-  # not set (or +nil+)
-  class None
-    class << self
-      # Always return nil
-      # @return nil
-      # @raise [ArgumentError] when called with any non-nil arguments
-      def [](*args)
-        raise ArgumentError, "None called with arguments" if args.any?(&:itself)
-      end
-
-      alias :new :[]
-    end
-  end
-end

data/lib/teckel/operation/results.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Teckel
-  module Operation
-    # Works just like {Teckel::Operation}, but wraps +output+ and +error+ into a
-    # {Teckel::Result Teckel::Result}.
-    #
-    # 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
-    #
-    #   class CreateUser
-    #     include Teckel::Operation::Results
-    #
-    #     input  Types::Hash.schema(name: Types::String, age: Types::Coercible::Integer)
-    #     output Types.Instance(User)
-    #     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]>]
-    #     def call(input)
-    #       user = User.new(name: input[:name], age: input[:age])
-    #       if user.save
-    #         success!(user) # exits early with success, prevents any further execution
-    #       else
-    #         fail!(message: "Could not save User", errors: user.errors)
-    #       end
-    #     end
-    #   end
-    #
-    #   # A success call:
-    #   CreateUser.call(name: "Bob", age: 23).is_a?(Teckel::Result) #=> true
-    #   CreateUser.call(name: "Bob", age: 23).success.is_a?(User) #=> true
-    #
-    #   # A failure call:
-    #   CreateUser.call(name: "Bob", age: 10).is_a?(Teckel::Result) #=> true
-    #   CreateUser.call(name: "Bob", age: 10).failure.is_a?(Hash) #=> true
-    #
-    #   # Unwrapping success input:
-    #   CreateUser.call(Teckel::Result.new({name: "Bob", age: 23}, true)).success.is_a?(User) #=> true
-    #
-    #   # Unwrapping failure input:
-    #   CreateUser.call(Teckel::Result.new({name: "Bob", age: 23}, false)).success.is_a?(User) #=> true
-    #
-    # @!visibility public
-    module Results
-      # Overwrites the defaults {Teckel::Operation::Runner} to un/wrap input, output and error
-      class Runner < Teckel::Operation::Runner
-        private
-
-        def build_input(input)
-          input = input.value if input.is_a?(Teckel::Result)
-          super(input)
-        end
-
-        def build_output(*args)
-          Teckel::Result.new(super, true)
-        end
-
-        def build_error(*args)
-          Teckel::Result.new(super, false)
-        end
-      end
-
-      def self.included(receiver)
-        receiver.send :include, Teckel::Operation unless Teckel::Operation >= receiver
-        receiver.send :runner, Runner
-      end
-    end
-  end
-end

data/teckel.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "teckel/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "teckel"
-  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/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(__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.0"
-  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