typed_operation 1.0.0.beta1 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 464b0e645a604caaee0ab2b83f21b56cb0ca7a6b6b69e3475dcce17366ed2c80
-  data.tar.gz: c59c8522a9c8c04be5a589649596b85bd42cb8f4faeae4073230fd42470556ce
+  metadata.gz: d6d2e6d373445f7a0c186b88963fb6cadb3947f32731f4411fbeb71588e65d63
+  data.tar.gz: 1329be34dbc54ba576c97dae12d82b513696b420ef34885842b6d8b0bb11b643
 SHA512:
-  metadata.gz: 7c42242a9df90fd0751b3e5fcd77a6b71ded4e9bc5cfc7725082e2d1ff200643dce87c10e7f80d2ae2eececb2d00231083396ed1d2aaf10a4fb88e1eaa287aa3
-  data.tar.gz: bfad02c10284d3895956b3390ac6529f1b815286f19e2cb5644ed5b687d01e2248f664cc166925d9db4a521ebb20956143fb9a7c98592c193915cbb812ffd90b
+  metadata.gz: d18d142eddd2506739786b89028a952322b0bf0baded051519107e07ed7db4c2444f9134ec1e6471254e7b86549d98a1766379e139bef50d2577c73d634f3c47
+  data.tar.gz: bfa38ed9df98fc442e92b9f09ebf2aaf29b5fd3c28e9ccb016c64150c28bb3d42b21409b291258137b2efc2ad8b4e904181877a1e92c7eed1661b29d3f2cdd4d

data/README.md

@@ -4,14 +4,7 @@ An implementation of a Command pattern, which is callable, and can be partially
 
 Inputs to the operation are specified as typed attributes (uses [`literal`](https://github.com/joeldrapper/literal)).
 
-Type of result of the operation is up to you, eg you could use [`literal` monads](https://github.com/joeldrapper/literal) or [`Dry::Monads`](https://dry-rb.org/gems/dry-monads/1.3/).
-
-**Note the version described here (~ 1.0.0) is pre-release on Rubygems (v1.0.0 is waiting for a release of `literal`). To use it now you can simply require `literal` from github in your Gemfile:**
-
-```ruby
-gem "literal", github: "joeldrapper/literal", branch: "main"
-gem "typed_operation", "~> 1.0.0.beta1"
-```
+Type of result of the operation is up to you, eg you could use [`Dry::Monads`](https://dry-rb.org/gems/dry-monads/1.3/).
 
 ## Features
 
@@ -44,15 +37,16 @@ class ShelveBookOperation < ::TypedOperation::Base
   # Or if you prefer:
   #   `param :description, String`
 
-  named_param :author_id, Integer, &:to_i
-  named_param :isbn, String
+  # `param` creates named parameters by default
+  param :author_id, Integer, &:to_i
+  param :isbn, String
   
   # Optional parameters are specified by wrapping the type constraint in the `optional` method, or using the `optional:` option
-  named_param :shelf_code, optional(Integer)
+  param :shelf_code, optional(Integer)
   # Or if you prefer:
   #   `named_param :shelf_code, Integer, optional: true`
 
-  named_param :category, String, default: "unknown".freeze
+  param :category, String, default: "unknown".freeze
 
   # optional hook called when the operation is initialized, and after the parameters have been set
   def prepare
@@ -176,8 +170,10 @@ Create an operation by subclassing `TypedOperation::Base` or `TypedOperation::Im
 
 - `TypedOperation::Base` (uses `Literal::Struct`) is the parent class for an operation where the arguments are potentially mutable (ie not frozen).
   No attribute writer methods are defined, so the arguments can not be changed after initialization, but the values passed in are not guaranteed to be frozen.
-- `TypedOperation::ImmutableBase` (uses `Literal::Data`) is the parent class for an operation where the arguments are immutable (frozen on initialization),
-  thus giving a somewhat stronger immutability guarantee (ie that the operation does not mutate its arguments).
+- `TypedOperation::ImmutableBase` (uses `Literal::Data`) is the parent class for an operation where the operation instance is frozen on initialization,
+  thus giving a somewhat stronger immutability guarantee.
+
+> Note: you cannot include `TypedOperation::ActionPolicyAuth` into a `TypedOperation::ImmutableBase`.
 
 The subclass must implement the `#perform` method which is where the operations main work is done.
 
@@ -521,7 +517,8 @@ This is an example of a `ApplicationOperation` in a Rails app that uses `Dry::Mo
 
 class ApplicationOperation < ::TypedOperation::Base
   # We choose to use dry-monads for our operations, so include the required modules
-  include Dry::Monads[:result, :do]
+  include Dry::Monads[:result]
+  include Dry::Monads::Do.for(:perform)
   
   class << self
     # Setup our own preferred names for the DSL methods
@@ -564,6 +561,8 @@ end
 
 ### Using with Action Policy (`action_policy` gem)
 
+> Note, this optional feature requires the `action_policy` gem to be installed and does not yet work with `ImmutableBase`.
+
 Add `TypedOperation::ActionPolicyAuth` to your `ApplicationOperation` (first `require` the module):
 
 ```ruby
@@ -709,40 +708,6 @@ end
 
 Note you are provided the ActionPolicy error object, but you cannot stop the error from being re-raised.
 
-### Using with `literal` monads
-
-You can use the `literal` gem to provide a `Result` type for your operations.
-
-```ruby
-class MyOperation < ::TypedOperation::Base
-  param :account_name, String
-  param :owner, String
-
-  def perform
-    create_account.bind do |account|
-      associate_owner(account).map { account }
-    end
-  end
-
-  private
-
-  def create_account
-    # ...
-    # Literal::Failure.new(:cant_create_account)
-    Literal::Success.new(account_name)
-  end
-  
-  def associate_owner(account)
-    # ...
-    Literal::Failure.new(:cant_associate_owner)
-    # Literal::Success.new("ok")
-  end
-end
-
-MyOperation.new(account_name: "foo", owner: "bar").call
-# => Literal::Failure(:cant_associate_owner)
-```
-
 ### Using with `Dry::Monads`
 
 As per the example in [`Dry::Monads` documentation](https://dry-rb.org/gems/dry-monads/1.0/do-notation/)
@@ -750,14 +715,14 @@ As per the example in [`Dry::Monads` documentation](https://dry-rb.org/gems/dry-
 ```ruby
 class MyOperation < ::TypedOperation::Base
   include Dry::Monads[:result]
-  include Dry::Monads::Do.for(:call)
+  include Dry::Monads::Do.for(:perform, :create_account)
 
   param :account_name, String
   param :owner, ::Owner
   
   def perform
     account = yield create_account(account_name)
-    yield associate_owner(account, owner)
+    yield AnotherOperation.call(account, owner)
 
     Success(account)
   end
@@ -797,8 +762,11 @@ bin/rails g typed_operation:install
 Use the `--dry_monads` switch to `include Dry::Monads[:result]` into your `ApplicationOperation` (don't forget to also 
 add `gem "dry-monads"` to your Gemfile)
 
+Use the `--action_policy` switch to add the `TypedOperation::ActionPolicyAuth` module to your `ApplicationOperation`
+(and you will also need to add `gem "action_policy"` to your Gemfile).
+
 ```ruby
-bin/rails g typed_operation:install --dry_monads
+bin/rails g typed_operation:install --dry_monads --action_policy
 ```
 
 ## Generate a new Operation

data/lib/generators/typed_operation/install/USAGE

@@ -12,6 +12,7 @@ rails generate typed_operation:install
 Options:
 --------
 --dry_monads: if specified the ApplicationOperation will include dry-monads Result and Do notation.
+--action_policy: if specified the ApplicationOperation will include action_policy authorization integration.
 
 Example:
 --------

data/lib/generators/typed_operation/install/install_generator.rb

@@ -6,6 +6,7 @@ module TypedOperation
   module Install
     class InstallGenerator < Rails::Generators::Base
       class_option :dry_monads, type: :boolean, default: false
+      class_option :action_policy, type: :boolean, default: false
 
       source_root File.expand_path("templates", __dir__)
 
@@ -18,6 +19,10 @@ module TypedOperation
       def include_dry_monads?
         options[:dry_monads]
       end
+
+      def include_action_policy?
+        options[:action_policy]
+      end
     end
   end
 end

data/lib/generators/typed_operation/install/templates/application_operation.rb

@@ -1,14 +1,36 @@
 # frozen_string_literal: true
 
 class ApplicationOperation < ::TypedOperation::Base
+<% if include_action_policy? -%>
+  include TypedOperation::ActionPolicyAuth
+
+<% end -%>
 <% if include_dry_monads? -%>
-  include Dry::Monads[:result, :do]
+  include Dry::Monads[:result]
+  include Dry::Monads::Do.for(:perform)
 
+  # Helper to execute then unwrap a successful result or raise an exception
   def call!
     call.value!
   end
 
 <% end -%>
   # Other common parameters & methods for Operations of this application...
-  # ...
+  # Some examples:
+  #
+  #   def self.operation_key
+  #     name.underscore.to_sym
+  #   end
+  #
+  #   def operation_key
+  #     self.class.operation_key
+  #   end
+  #
+  #   # Translation and localization
+  #
+  #   def translate(key, **)
+  #     key = "operations.#{operation_key}.#{key}" if key.start_with?(".")
+  #     I18n.t(key, **)
+  #   end
+  #   alias_method :t, :translate
 end

data/lib/typed_operation/action_policy_auth.rb

@@ -34,7 +34,7 @@ module TypedOperation
         raise ArgumentError, "authorize_via must be called with a valid param name" unless via.all? { |param| parameters.include?(param) }
         @_authorized_via_param = via
 
-        action_type_method = "#{action_type}?".to_sym if action_type
+        action_type_method = :"#{action_type}?" if action_type
         # If an method name is provided, use it
         policy_method = to || action_type_method || raise(::TypedOperation::InvalidOperationError, "You must provide an action type or policy method name")
         @_policy_method = policy_method

data/lib/typed_operation/base.rb

@@ -8,18 +8,6 @@ module TypedOperation
 
     include Operations::Lifecycle
     include Operations::Callable
-    include Operations::Deconstruct
     include Operations::Executable
-
-    class << self
-      def attribute(name, type, special = nil, reader: :public, writer: :public, positional: false, default: nil)
-        super(name, type, special, reader:, writer: false, positional:, default:)
-      end
-    end
-
-    def with(...)
-      # copy to new operation with new attrs
-      self.class.new(**attributes.merge(...))
-    end
   end
 end

data/lib/typed_operation/immutable_base.rb

@@ -8,7 +8,6 @@ module TypedOperation
 
     include Operations::Lifecycle
     include Operations::Callable
-    include Operations::Deconstruct
     include Operations::Executable
   end
 end

data/lib/typed_operation/operations/introspection.rb

@@ -5,25 +5,23 @@ module TypedOperation
     # Introspection methods
     module Introspection
       def positional_parameters
-        literal_attributes.filter_map { |name, attribute| name if attribute.positional? }
+        literal_properties.filter_map { |property| property.name if property.positional? }
       end
 
       def keyword_parameters
-        literal_attributes.filter_map { |name, attribute| name unless attribute.positional? }
+        literal_properties.filter_map { |property| property.name if property.keyword? }
       end
 
       def required_parameters
-        literal_attributes.filter do |name, attribute|
-          attribute.default.nil? # Any optional parameters will have a default value/proc in their Literal::Attribute
-        end
+        literal_properties.filter { |property| property.required? }
       end
 
       def required_positional_parameters
-        required_parameters.filter_map { |name, attribute| name if attribute.positional? }
+        required_parameters.filter_map { |property| property.name if property.positional? }
       end
 
       def required_keyword_parameters
-        required_parameters.filter_map { |name, attribute| name unless attribute.positional? }
+        required_parameters.filter_map { |property| property.name if property.keyword? }
       end
 
       def optional_positional_parameters

data/lib/typed_operation/operations/lifecycle.rb

@@ -4,7 +4,7 @@ module TypedOperation
   module Operations
     module Lifecycle
       # This is called by Literal on initialization of underlying Struct/Data
-      def after_initialization
+      def after_initialize
         prepare if respond_to?(:prepare)
       end
     end

data/lib/typed_operation/operations/parameters.rb

@@ -4,10 +4,19 @@ module TypedOperation
   module Operations
     # Method to define parameters for your operation.
     module Parameters
+      # Override literal `prop` to prevent creating writers (Literal::Data does this by default)
+      def prop(name, type, kind = :keyword, reader: :public, writer: :public, default: nil)
+        if self < ImmutableBase
+          super(name, type, kind, reader:, default:)
+        else
+          super(name, type, kind, reader:, writer: false, default:)
+        end
+      end
+
       # Parameter for keyword argument, or a positional argument if you use positional: true
       # Required, but you can set a default or use optional: true if you want optional
       def param(name, signature = :any, **options, &converter)
-        AttributeBuilder.new(self, name, signature, options).define(&converter)
+        PropertyBuilder.new(self, name, signature, options).define(&converter)
       end
 
       # Alternative DSL

data/lib/typed_operation/operations/{attribute_builder.rb → property_builder.rb}

@@ -2,13 +2,13 @@
 
 module TypedOperation
   module Operations
-    class AttributeBuilder
+    class PropertyBuilder
       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]
+        @optional = options[:optional] # Wraps signature in NilableType
+        @positional = options[:positional] # Changes kind to positional
         @reader = options[:reader] || :public
         @default_key = options.key?(:default)
         @default = options[:default]
@@ -23,11 +23,11 @@ module TypedOperation
         else
           converter
         end
-        @typed_operation.attribute(
+        @typed_operation.prop(
           @name,
           @signature,
+          @positional ? :positional : :keyword,
           default: default_value_for_literal,
-          positional: @positional,
           reader: @reader,
           &coerce_by
         )
@@ -51,7 +51,7 @@ module TypedOperation
       end
 
       def union_with_nil_to_support_nil_default
-        @signature = Literal::Union.new(@signature, NilClass) if has_default_value_nil?
+        @signature = Literal::Types::UnionType.new(@signature, NilClass) if has_default_value_nil?
       end
 
       def has_default_value_nil?

data/lib/typed_operation/version.rb

@@ -1,3 +1,3 @@
 module TypedOperation
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0.beta3"
 end

data/lib/typed_operation.rb

@@ -1,7 +1,3 @@
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2.0")
-  require "polyfill-data"
-end
-
 require "literal"
 
 require "typed_operation/version"
@@ -11,8 +7,7 @@ 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/curried"
 require "typed_operation/immutable_base"

metadata

@@ -1,15 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: typed_operation
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Stephen Ierodiaconou
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-26 00:00:00.000000000 Z
-dependencies: []
+date: 2025-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.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.0.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:
@@ -32,14 +51,13 @@ files:
 - lib/typed_operation/base.rb
 - lib/typed_operation/curried.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/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/prepared.rb
 - lib/typed_operation/railtie.rb
@@ -50,7 +68,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 +75,14 @@ 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.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: TypedOperation is a command pattern with typed parameters, which is callable,
   and can be partially applied.

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