typed_operation 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 464b0e645a604caaee0ab2b83f21b56cb0ca7a6b6b69e3475dcce17366ed2c80
-  data.tar.gz: c59c8522a9c8c04be5a589649596b85bd42cb8f4faeae4073230fd42470556ce
+  metadata.gz: 501477c614c107723d1c915099dd06209336708ba5e9672c26622d02a9cd4782
+  data.tar.gz: b5ab846baf478e3cce3fd8ea1752c04ee708c9a7f84d2be6d47d4c9a94505ac5
 SHA512:
-  metadata.gz: 7c42242a9df90fd0751b3e5fcd77a6b71ded4e9bc5cfc7725082e2d1ff200643dce87c10e7f80d2ae2eececb2d00231083396ed1d2aaf10a4fb88e1eaa287aa3
-  data.tar.gz: bfad02c10284d3895956b3390ac6529f1b815286f19e2cb5644ed5b687d01e2248f664cc166925d9db4a521ebb20956143fb9a7c98592c193915cbb812ffd90b
+  metadata.gz: c3c399b74903b5b9e40ab7838c7d20bafa68969d1200bf2afb11457e41437ae8fa823e7afc14fabe71cd290cd798823f97a0918c4a12d50f6a8768ac1a77ea8e
+  data.tar.gz: b1ce5f67d1b87ef907f00904288b25edd678a2afab0f68a5f2c5804831f5d05df0fad134a4c28a4893d3867f61c671d548bf687f37b822ff32754355845d9abd

data/README.md

@@ -10,7 +10,7 @@ Type of result of the operation is up to you, eg you could use [`literal` monads
 
 ```ruby
 gem "literal", github: "joeldrapper/literal", branch: "main"
-gem "typed_operation", "~> 1.0.0.beta1"
+gem "typed_operation", "~> 1.0.0.beta2"
 ```
 
 ## Features
@@ -44,15 +44,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
@@ -521,7 +522,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 +566,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 +713,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 +720,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 +767,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/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,15 @@ 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 self.prop(name, type, kind = :keyword, reader: :public, writer: :public, default: nil)
+        super(name, type, kind, reader:, writer: false, default:)
+      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.beta2"
 end

data/lib/typed_operation.rb

@@ -11,8 +11,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_operation
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-26 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies: []
 description: Command pattern, which is callable, and can be partially applied, curried
   and has typed parameters. Authorization to execute via action_policy if desired.
@@ -32,14 +32,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
@@ -58,14 +57,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
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: TypedOperation is a command pattern with typed parameters, which is callable,

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