typed_operation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 895e2a58caa6a8a40c35d3eff22b9429fed9f0c49627f275cd583ce0c2fe4bc6
+  data.tar.gz: 794004ac749b5ff9df514827a794ef01917e5ca4bdd2b887a5e8ea06b491a097
+SHA512:
+  metadata.gz: e81f633626fbd914bae0c232c22d1c9b5e44cc2169691fd022c408dbbbad15179062a8d641b03f6165a033c946cde10ad740b971b636c05fc85c7f828ed643c1
+  data.tar.gz: 65e4065dded231777a7b2ed40ef901268da46e7d8403a20edb642d5ea815e15b280a8b46a64d24753de67daab3d7e50b9985fe6bebe6898c19f98386bb8020f8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Stephen Ierodiaconou
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# TypedOperation
+Short description and motivation.
+
+## Usage
+
+An implementation of a Command pattern, which is callable, and can be partially applied (curried).
+
+Inputs to the operation are specified as typed attributes using the `param` method.
+
+Results of the operation are a type of `Dry::Monads::Result` object.
+
+### Examples:
+
+A base operation class:
+
+```ruby
+class ApplicationOperation < ::TypedOperation::Base
+  param :initiator, ::RegisteredUser, allow_nil: true
+
+  private
+
+  def succeeded(value)
+    Success(value)
+  end
+
+  def failed_with_value(value, message: "Operation failed", error_code: nil)
+    failed(error_code || self.class.operation_key, message, value)
+  end
+
+  def failed_with_message(message, error_code: nil)
+    failed(error_code || self.class.operation_key, message)
+  end
+
+  def failed(error_code, message = "Operation failed", value = nil)
+    Failure[error_code, message, value]
+  end
+
+  def failed_with_code_and_value(error_code, value, message: "Operation failed")
+    failed(error_code, message, value)
+  end
+end
+
+```
+
+A simple operation:
+
+```ruby
+class TestOperation < ::ApplicationOperation
+  param :foo, String
+  param :bar, String
+  param :baz, String, convert: true
+
+  def prepare
+    # to setup (optional)
+    puts "lets go!"
+  end
+  
+  def call
+    succeeded("It worked!")
+    # failed_with_message("It failed!")
+  end
+end
+```
+
+```ruby
+TestOperation.(foo: "1", bar: "2", baz: 3)
+# => Success("It worked!")
+
+TestOperation.with(foo: "1").with(bar: "2")
+# => #<TypedOperation::PartiallyApplied:0x000000014a655310 @applied_args={:foo=>"1", :bar=>"2"}, @operation=TestOperation>
+
+TestOperation.with(foo: "1").with(bar: "2").with(baz: 3)
+# => <TypedOperation::Prepared:0x000000012dac6498 @applied_args={:foo=>"1", :bar=>"2", :baz=>3}, @operation=TestOperation>
+
+TestOperation.with(foo: "1").with(bar: "2").with(baz: 3).call
+# => Success("It worked!")
+
+TestOperation.with(foo: "1").with(bar: "2").with(baz: 3).operation
+# => <TestOperation:0x000000014a0048a8 @__attributes=#<TestOperation::TypedSchema foo="1" bar="2" baz="3">>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "typed_operation"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install typed_operation
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/tasks/typed_operation_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :typed_operation do
+#   # Task goes here
+# end

data/lib/typed_operation/base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module TypedOperation
+  class Base
+    include Dry::Monads[:result, :do]
+    include Vident::Typed::Attributes
+
+    class << self
+      def call(...)
+        new(...).call
+      end
+
+      def curry(**args)
+        PartiallyApplied.new(self, **args).curry
+      end
+      alias_method :[], :curry
+      alias_method :with, :curry
+
+      def to_proc
+        method(:call).to_proc
+      end
+
+      def operation_key
+        name.underscore.to_sym
+      end
+
+      # property are required by default, you can fall back to attribute or set allow_nil: true if you want optional
+      def param(name, signature = :any, **options, &converter)
+        attribute(name, signature, **{allow_nil: false}.merge(options), &converter)
+      end
+    end
+
+    def initialize(**attributes)
+      prepare_attributes(attributes)
+      prepare if respond_to?(:prepare)
+    end
+
+    def call
+      raise NotImplementedError, "You must implement #call"
+    end
+
+    def call!
+      call.value!
+    end
+
+    def to_proc
+      method(:call).to_proc
+    end
+
+    private
+
+    def operation_key
+      self.class.operation_key
+    end
+  end
+end

data/lib/typed_operation/partially_applied.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module TypedOperation
+  class PartiallyApplied
+    def initialize(operation, **applied_args)
+      @operation = operation
+      @applied_args = applied_args
+    end
+
+    def curry(**params)
+      all_args = @applied_args.merge(params)
+      # check if required attrs are in @applied_args
+      required_keys = @operation.attribute_names.select { |name| @operation.attribute_metadata(name)[:required] != false }
+      missing_keys = required_keys - all_args.keys
+
+      if missing_keys.size > 0
+        # Partially apply the arguments
+        PartiallyApplied.new(@operation, **all_args)
+      else
+        Prepared.new(@operation, **all_args)
+      end
+    end
+    alias_method :[], :curry
+    alias_method :with, :curry
+
+    def call(...)
+      prepared = curry(...)
+      return prepared.operation.call if prepared.is_a?(Prepared)
+      raise "Cannot call PartiallyApplied operation #{@operation.name} (key: #{@operation.operation_key}), are you expecting it to be Prepared?"
+    end
+  end
+end

data/lib/typed_operation/prepared.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TypedOperation
+  class Prepared < PartiallyApplied
+    def operation
+      @operation.new(**@applied_args)
+    end
+  end
+end

data/lib/typed_operation/railtie.rb

@@ -0,0 +1,4 @@
+module TypedOperation
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/typed_operation/version.rb

@@ -0,0 +1,3 @@
+module TypedOperation
+  VERSION = "0.1.0"
+end

data/lib/typed_operation.rb

@@ -0,0 +1,9 @@
+require "typed_operation/version"
+require "typed_operation/railtie"
+require "typed_operation/base"
+require "typed_operation/prepared"
+require "typed_operation/partially_applied"
+
+module TypedOperation
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: typed_operation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Ierodiaconou
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: vident-typed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: TypedOperation is a command pattern implementation
+email:
+- stevegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/typed_operation_tasks.rake
+- lib/typed_operation.rb
+- lib/typed_operation/base.rb
+- lib/typed_operation/partially_applied.rb
+- lib/typed_operation/prepared.rb
+- lib/typed_operation/railtie.rb
+- lib/typed_operation/version.rb
+homepage: https://github.com/stevegeek/typed_operation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevegeek/typed_operation
+  source_code_uri: https://github.com/stevegeek/typed_operation
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: TypedOperation is a command pattern implementation
+test_files: []