typed_operation 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3c88c55bf10a3d9d6582adfbb253c94a1fd6cf287794089775c9a8dbf1dfd86
-  data.tar.gz: baee565ac599fb5351d1758fe720587e6793114c8ec830cbe3db6d5dc40b2d61
+  metadata.gz: c80a027434c29b23257b43e03eeb8acb61a3ac300a59e0c04068ffada1dd4aa6
+  data.tar.gz: 6b78a70b2a46710746129f8dac3a403bdc692c761c93f3ec111bf09efec8a70e
 SHA512:
-  metadata.gz: 32a92d0277fee468925bd0a3c5b4b377ebb8107b3202ea13f1c23925532df4665efffaac90e76c32060f629cb9a476e654abba406e80c28da7bcf590e504c445
-  data.tar.gz: 82d9ae76e6ba43564a3632d577ddf99ab92758c4b44cfad985a812b121c1c63efee7ceba0d92e1839c8fc6b5a0476a4914d4a33fdeca6a84bce9f0caca6c7789
+  metadata.gz: 35baa03191cfa29e1786de975d7f8d2baf62040859922544f0d79109a8f088996521e85e3dce0c66bde1f7dd5bb2b62a5332cb7841a63a1ebe4b369d48005bb6
+  data.tar.gz: ebf8aea46fb0d3dcd72aa846b772f228aca21be2e04695989266218e9303e9b7760770d67f53f57ca231b41b7f502ad5145bf621a0648c6706b6e741a8e6c80e

data/README.md

@@ -4,7 +4,7 @@ An implementation of a Command pattern, which is callable, and can be partially
 
 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.
+Result format of the operation is up to you, but plays nicely with `Dry::Monads`. 
 
 ### Examples:
 
@@ -12,6 +12,8 @@ A base operation class:
 
 ```ruby
 class ApplicationOperation < ::TypedOperation::Base
+  include Dry::Monads[:result, :do]
+  
   param :initiator, ::RegisteredUser, allow_nil: true
 
   private
@@ -93,12 +95,19 @@ Or install it yourself as:
 $ gem install typed_operation
 ```
 
-## Add an `ApplicationOperation` to your project
+### Add an `ApplicationOperation` to your project
 
 ```ruby
 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)
+
+```ruby
+bin/rails g typed_operation:install --dry_monads
+```
+
 ## Generate a new Operation
 
 ```ruby
@@ -113,6 +122,8 @@ bin/rails g typed_operation TestOperation --path=app/operations
 
 The default path is `app/operations`.
 
+The generator will also create a test file.
+
 ## Contributing
 Contribution directions go here.
 

data/lib/generators/templates/operation.rb

@@ -4,7 +4,8 @@
 module <%= namespace_name %>
   class <%= name %> < ::ApplicationOperation
     # Replace with implementation...
-    param :param1, String, convert: true
+    param :my_param, String, convert: true
+    param :an_optional_param, Integer, allow_nil: true
 
     def prepare
       # Prepare...
@@ -12,13 +13,15 @@ module <%= namespace_name %>
 
     def call
       # Perform...
+      "Hello World!"
     end
   end
 end
 <% else %>
 class <%= name %> < ::ApplicationOperation
   # Replace with implementation...
-  param :param1, String, convert: true
+  param :my_param, String, convert: true
+  param :an_optional_param, Integer, allow_nil: true
 
   def prepare
     # Prepare...
@@ -26,6 +29,7 @@ class <%= name %> < ::ApplicationOperation
 
   def call
     # Perform...
+    "Hello World!"
   end
 end
 <% end %>

data/lib/generators/templates/operation_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+<% if namespace_name.present? %>
+module <%= namespace_name %>
+  class <%= name %>Test < ActiveSupport::TestCase
+    def setup
+      @operation = <%= name %>.new(my_param: "test")
+    end
+
+    test 'should raise ParameterError if my_param is nil' do
+      assert_raises(ParameterError) do
+        <%= name %>.new(my_param: nil)
+      end
+    end
+
+    test 'should convert my_param if it is not a string' do
+      assert_equal <%= name %>.new(my_param: 123).my_param, "123"
+    end
+
+    test 'call returns after operation' do
+      result = @operation.call
+      assert_equal result, "Hello World!"
+    end
+  end
+end
+<% else %>
+  class <%= name %>Test < ActiveSupport::TestCase
+    def setup
+      @operation = <%= name %>.new(my_param: "test")
+    end
+
+    test 'should raise ParameterError if my_param is nil' do
+      assert_raises(ParameterError) do
+        <%= name %>.new(my_param: nil)
+      end
+    end
+
+    test 'should convert my_param if it is not a string' do
+      assert_equal <%= name %>.new(my_param: 123).my_param, "123"
+  end
+
+  test 'call returns after operation' do
+    result = @operation.call
+    assert_equal result, "Hello World!"
+  end
+end
+<% end %>

data/lib/generators/typed_operation/install/USAGE

@@ -9,5 +9,13 @@ Command:
 --------
 rails generate typed_operation:install
 
+Options:
+--------
+--dry_monads: if specified the ApplicationOperation will include dry-monads Result and Do notation.
+
+Example:
+--------
+rails generate typed_operation:install
+
 This will create the following file:
 app/operations/application_operation.rb

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

@@ -5,10 +5,18 @@ require "rails/generators/base"
 module TypedOperation
   module Install
     class InstallGenerator < Rails::Generators::Base
+      class_option :dry_monads, type: :boolean, default: false
+
       source_root File.expand_path("templates", __dir__)
 
       def copy_application_operation_file
-        copy_file "application_operation.rb", "app/operations/application_operation.rb"
+        template "application_operation.rb", "app/operations/application_operation.rb"
+      end
+
+      private
+
+      def include_dry_monads?
+        options[:dry_monads]
       end
     end
   end

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

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
 class ApplicationOperation < ::TypedOperation::Base
-  # Common properties & methods for operations of this application...
+<% if include_dry_monads? -%>
+  include Dry::Monads[:result, :do]
+
+  def call!
+    call.value!
+  end
+
+<% end -%>
+  # Other common parameters & methods for Operations of this application...
+  # ...
 end

data/lib/generators/typed_operation_generator.rb

@@ -8,10 +8,14 @@ class TypedOperationGenerator < Rails::Generators::NamedBase
   class_option :path, type: :string, default: "app/operations"
 
   def generate_operation
-    template_path = File.join(self.class.source_root, "operation.rb")
-    dest_path = File.join(options[:path], "#{file_name}.rb")
-
-    template(template_path, dest_path)
+    template(
+      File.join(self.class.source_root, "operation.rb"),
+      File.join(options[:path], "#{file_name}.rb")
+    )
+    template(
+      File.join(self.class.source_root, "operation_test.rb"),
+      File.join("test/", options[:path].gsub(/\Aapp\//, ""), "#{file_name}_test.rb")
+    )
   end
 
   private

data/lib/typed_operation/base.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "dry/monads"
 require "vident/typed"
 require "vident/typed/attributes"
 
 module TypedOperation
   class Base
-    include Dry::Monads[:result, :do]
     include Vident::Typed::Attributes
 
     class << self
@@ -35,7 +33,11 @@ module TypedOperation
     end
 
     def initialize(**attributes)
-      prepare_attributes(attributes)
+      begin
+        prepare_attributes(attributes)
+      rescue ::Dry::Struct::Error => e
+        raise ParameterError, e.message
+      end
       prepare if respond_to?(:prepare)
     end
 
@@ -43,10 +45,6 @@ module TypedOperation
       raise NotImplementedError, "You must implement #call"
     end
 
-    def call!
-      call.value!
-    end
-
     def to_proc
       method(:call).to_proc
     end

data/lib/typed_operation/version.rb

@@ -1,3 +1,3 @@
 module TypedOperation
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/typed_operation.rb

@@ -5,5 +5,5 @@ require "typed_operation/partially_applied"
 require "typed_operation/prepared"
 
 module TypedOperation
-  # Your code goes here...
+  class ParameterError < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_operation
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,26 +58,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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 where inputs can be
   defined with runtime type checks. Operations can be partially applied.
 email:
@@ -91,6 +71,7 @@ files:
 - Rakefile
 - lib/generators/USAGE
 - lib/generators/templates/operation.rb
+- lib/generators/templates/operation_test.rb
 - lib/generators/typed_operation/install/USAGE
 - lib/generators/typed_operation/install/install_generator.rb
 - lib/generators/typed_operation/install/templates/application_operation.rb