typed_operation 1.0.0.pre2 → 1.0.0

data/lib/typed_operation/result.rb

@@ -0,0 +1,39 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+require_relative "result/success"
+require_relative "result/failure"
+require_relative "result/adapters/built_in"
+require_relative "result/adapters/dry_monads"
+require_relative "result/mixin"
+
+module TypedOperation
+  # Result types for representing success and failure outcomes.
+  #
+  # TypedOperation provides built-in Success and Failure types that work
+  # out of the box. You can also configure it to use Dry::Monads or a
+  # custom adapter.
+  #
+  # @example Default usage (built-in types)
+  #   result = MyPipeline.call(input)
+  #   result.success?  # => true or false
+  #   result.value!    # => the value (raises on failure)
+  #
+  # @example Configure to use Dry::Monads
+  #   TypedOperation.configure do |config|
+  #     config.result_adapter = :dry_monads
+  #   end
+  #
+  # @example Pattern matching
+  #   case result
+  #   in Success[value]
+  #     handle_success(value)
+  #   in Failure[error]
+  #     handle_failure(error)
+  #   end
+  #
+  module Result
+    # Alias for easy access to UnwrapError from Result module
+    UnwrapError = TypedOperation::UnwrapError
+  end
+end

data/lib/typed_operation/version.rb

@@ -1,3 +1,7 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
 module TypedOperation
-  VERSION = "1.0.0.pre2"
+  #: String
+  VERSION = "1.0.0"
 end

data/lib/typed_operation.rb

@@ -1,24 +1,37 @@
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2.0")
-  require "polyfill-data"
-end
+# rbs_inline: enabled
 
 require "literal"
 
 require "typed_operation/version"
 require "typed_operation/railtie" if defined?(Rails::Railtie)
+require "typed_operation/result"
+require "typed_operation/configuration"
 require "typed_operation/operations/introspection"
 require "typed_operation/operations/parameters"
 require "typed_operation/operations/partial_application"
-require "typed_operation/operations/callable"
 require "typed_operation/operations/lifecycle"
-require "typed_operation/operations/deconstruct"
-require "typed_operation/operations/attribute_builder"
+require "typed_operation/operations/property_builder"
+require "typed_operation/operations/executable"
+require "typed_operation/operations/composition"
 require "typed_operation/curried"
+require "typed_operation/instrumentation"
+require "typed_operation/explainable"
 require "typed_operation/immutable_base"
 require "typed_operation/base"
 require "typed_operation/partially_applied"
 require "typed_operation/prepared"
+require "typed_operation/callable_resolver"
+require "typed_operation/chains/chained_operation"
+require "typed_operation/chains/sequence_chain"
+require "typed_operation/chains/splat_chain"
+require "typed_operation/chains/smart_chain"
+require "typed_operation/chains/map_chain"
+require "typed_operation/chains/fallback_chain"
+require "typed_operation/context"
+require "typed_operation/pipeline"
 
+# TypedOperation provides a framework for defining type-safe, composable operations
+# with support for partial application, currying, and parameter validation.
 module TypedOperation
   class InvalidOperationError < StandardError; end
 

metadata

@@ -1,17 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: typed_operation
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre2
+  version: 1.0.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
-dependencies: []
-description: TypedOperation is a command pattern implementation where inputs can be
-  defined with runtime type checks. Operations can be partially applied.
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Command pattern, which is callable, and can be partially applied, curried
+  and has typed parameters. Authorization to execute via action_policy if desired.
 email:
 - stevegeek@gmail.com
 executables: []
@@ -20,7 +39,6 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- Rakefile
 - lib/generators/USAGE
 - lib/generators/templates/operation.rb
 - lib/generators/templates/operation_test.rb
@@ -28,21 +46,45 @@ files:
 - lib/generators/typed_operation/install/install_generator.rb
 - lib/generators/typed_operation/install/templates/application_operation.rb
 - lib/generators/typed_operation_generator.rb
-- lib/tasks/typed_operation_tasks.rake
 - lib/typed_operation.rb
+- lib/typed_operation/action_policy_auth.rb
 - lib/typed_operation/base.rb
+- lib/typed_operation/callable_resolver.rb
+- lib/typed_operation/chains/chained_operation.rb
+- lib/typed_operation/chains/fallback_chain.rb
+- lib/typed_operation/chains/map_chain.rb
+- lib/typed_operation/chains/sequence_chain.rb
+- lib/typed_operation/chains/smart_chain.rb
+- lib/typed_operation/chains/splat_chain.rb
+- lib/typed_operation/configuration.rb
+- lib/typed_operation/context.rb
 - lib/typed_operation/curried.rb
+- lib/typed_operation/explainable.rb
 - lib/typed_operation/immutable_base.rb
-- lib/typed_operation/operations/attribute_builder.rb
-- lib/typed_operation/operations/callable.rb
-- lib/typed_operation/operations/deconstruct.rb
+- lib/typed_operation/instrumentation.rb
+- lib/typed_operation/instrumentation/trace.rb
+- lib/typed_operation/instrumentation/tree_formatter.rb
+- lib/typed_operation/operations/composition.rb
+- lib/typed_operation/operations/executable.rb
 - lib/typed_operation/operations/introspection.rb
 - lib/typed_operation/operations/lifecycle.rb
 - lib/typed_operation/operations/parameters.rb
 - lib/typed_operation/operations/partial_application.rb
+- lib/typed_operation/operations/property_builder.rb
 - lib/typed_operation/partially_applied.rb
+- lib/typed_operation/pipeline.rb
+- lib/typed_operation/pipeline/builder.rb
+- lib/typed_operation/pipeline/chainable_wrapper.rb
+- lib/typed_operation/pipeline/empty_pipeline_chain.rb
+- lib/typed_operation/pipeline/step_wrapper.rb
 - lib/typed_operation/prepared.rb
 - lib/typed_operation/railtie.rb
+- lib/typed_operation/result.rb
+- lib/typed_operation/result/adapters/built_in.rb
+- lib/typed_operation/result/adapters/dry_monads.rb
+- lib/typed_operation/result/failure.rb
+- lib/typed_operation/result/mixin.rb
+- lib/typed_operation/result/success.rb
 - lib/typed_operation/version.rb
 homepage: https://github.com/stevegeek/typed_operation
 licenses:
@@ -50,7 +92,6 @@ licenses:
 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
@@ -58,15 +99,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.18
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
-summary: TypedOperation is a command pattern implementation
+summary: TypedOperation is a command pattern with typed parameters, which is callable,
+  and can be partially applied.
 test_files: []

data/Rakefile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "bundler/setup"
-require "rake/testtask"
-
-ENV["NO_RAILS"] = "true"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/typed_operation/**/*_test.rb"]
-end
-
-require "standard/rake"
-
-task default: %i[test standard]

data/lib/tasks/typed_operation_tasks.rake

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

data/lib/typed_operation/operations/attribute_builder.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module TypedOperation
-  module Operations
-    class AttributeBuilder
-      def initialize(typed_operation, parameter_name, type_signature, options)
-        @typed_operation = typed_operation
-        @name = parameter_name
-        @signature = type_signature
-        @optional = options[:optional]
-        @positional = options[:positional]
-        @reader = options[:reader] || :public
-        @default_key = options.key?(:default)
-        @default = options[:default]
-
-        prepare_type_signature_for_literal
-      end
-
-      def define(&converter)
-        @typed_operation.attribute(
-          @name,
-          @signature,
-          default: default_value_for_literal,
-          positional: @positional,
-          reader: @reader,
-          &converter
-        )
-      end
-
-      private
-
-      def prepare_type_signature_for_literal
-        @signature = Literal::Types::NilableType.new(@signature) if needs_to_be_nilable?
-        union_with_nil_to_support_nil_default
-        validate_positional_order_params! if @positional
-      end
-
-      # If already wrapped in a Nilable then don't wrap again
-      def needs_to_be_nilable?
-        @optional && !type_nilable?
-      end
-
-      def type_nilable?
-        @signature.is_a?(Literal::Types::NilableType)
-      end
-
-      def union_with_nil_to_support_nil_default
-        @signature = Literal::Union.new(@signature, NilClass) if has_default_value_nil?
-      end
-
-      def has_default_value_nil?
-        default_provided? && @default.nil?
-      end
-
-      def validate_positional_order_params!
-        # Optional ones can always be added after required ones, or before any others, but required ones must be first
-        unless type_nilable? || @typed_operation.optional_positional_parameters.empty?
-          raise ParameterError, "Cannot define required positional parameter '#{@name}' after optional positional parameters"
-        end
-      end
-
-      def default_provided?
-        @default_key
-      end
-
-      def default_value_for_literal
-        if has_default_value_nil? || type_nilable?
-          -> {}
-        else
-          @default
-        end
-      end
-    end
-  end
-end

data/lib/typed_operation/operations/callable.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module TypedOperation
-  module Operations
-    module Callable
-      def self.included(base)
-        base.extend(CallableMethods)
-      end
-
-      module CallableMethods
-        def call(...)
-          new(...).call
-        end
-
-        def to_proc
-          method(:call).to_proc
-        end
-      end
-
-      include CallableMethods
-
-      def call
-        raise InvalidOperationError, "You must implement #call"
-      end
-    end
-  end
-end

data/lib/typed_operation/operations/deconstruct.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module TypedOperation
-  module Operations
-    module Deconstruct
-      def deconstruct
-        attributes.values
-      end
-
-      def deconstruct_keys(keys)
-        h = attributes.to_h
-        keys ? h.slice(*keys) : h
-      end
-    end
-  end
-end