typed_operation 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53850ead13d940ad019c674a59e7831ba89da9ec70168d6a81de50711f343523
-  data.tar.gz: e76a1321066eff1a9034aeaab66140d58732eeab7adf30ff8d51f455ce68f483
+  metadata.gz: c80a027434c29b23257b43e03eeb8acb61a3ac300a59e0c04068ffada1dd4aa6
+  data.tar.gz: 6b78a70b2a46710746129f8dac3a403bdc692c761c93f3ec111bf09efec8a70e
 SHA512:
-  metadata.gz: 057de15499ac13647de16cd3905d23ddf390b00d0951449061e1fc30020ba0c2e546d1c1f38495911012177604740f5c3947426c94ee9dd9763f94df9629ae17
-  data.tar.gz: f73dd9c04f0e5c3f87861c4d086059d595c296cc85783a85d9c13ef03f04ff7f87f46a4ec0b5cb1f9e9123d9f23ee0274a61d89f534ac666ad778db2f592dee0
+  metadata.gz: 35baa03191cfa29e1786de975d7f8d2baf62040859922544f0d79109a8f088996521e85e3dce0c66bde1f7dd5bb2b62a5332cb7841a63a1ebe4b369d48005bb6
+  data.tar.gz: ebf8aea46fb0d3dcd72aa846b772f228aca21be2e04695989266218e9303e9b7760770d67f53f57ca231b41b7f502ad5145bf621a0648c6706b6e741a8e6c80e

data/README.md

@@ -1,13 +1,10 @@
 # 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.
+Result format of the operation is up to you, but plays nicely with `Dry::Monads`. 
 
 ### Examples:
 
@@ -15,6 +12,8 @@ A base operation class:
 
 ```ruby
 class ApplicationOperation < ::TypedOperation::Base
+  include Dry::Monads[:result, :do]
+  
   param :initiator, ::RegisteredUser, allow_nil: true
 
   private
@@ -96,6 +95,35 @@ Or install it yourself as:
 $ gem install typed_operation
 ```
 
+### 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
+bin/rails g typed_operation TestOperation
+```
+
+You can optionally specify the directory to generate the operation in:
+
+```ruby
+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/USAGE

@@ -0,0 +1,25 @@
+Operation Generator
+===================
+
+Description:
+------------
+This generator creates an 'TypedOperation' class that inherits from ApplicationOperation.
+
+Command:
+--------
+rails generate typed_operation NAME [options]
+
+Arguments:
+----------
+NAME: The class name of the Operation class to be generated, e.g. 'MyOperation'.
+
+Options:
+--------
+--path=path/to/directory: The path to the directory in which the operation class should be generated. The generated class will be namespaced according to the provided path.
+
+Example:
+--------
+rails generate typed_operation MyOperation --path=app/operations
+
+This will create the following file:
+app/operations/my_operation.rb

data/lib/generators/templates/operation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+<% if namespace_name.present? %>
+module <%= namespace_name %>
+  class <%= name %> < ::ApplicationOperation
+    # Replace with implementation...
+    param :my_param, String, convert: true
+    param :an_optional_param, Integer, allow_nil: true
+
+    def prepare
+      # Prepare...
+    end
+
+    def call
+      # Perform...
+      "Hello World!"
+    end
+  end
+end
+<% else %>
+class <%= name %> < ::ApplicationOperation
+  # Replace with implementation...
+  param :my_param, String, convert: true
+  param :an_optional_param, Integer, allow_nil: true
+
+  def prepare
+    # Prepare...
+  end
+
+  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

@@ -0,0 +1,21 @@
+Install Generator
+=================
+
+Description:
+------------
+This generator installs a `ApplicationOperation` class which is your base class for all Operations.
+
+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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+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
+        template "application_operation.rb", "app/operations/application_operation.rb"
+      end
+
+      private
+
+      def include_dry_monads?
+        options[:dry_monads]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ApplicationOperation < ::TypedOperation::Base
+<% 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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+class TypedOperationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :path, type: :string, default: "app/operations"
+
+  def generate_operation
+    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
+
+  def namespace_name
+    namespace_path = options[:path].gsub(/^app\/[^\/]*\//, "")
+    namespace_path.split("/").map(&:camelize).join("::")
+  end
+end

data/lib/typed_operation/base.rb

@@ -1,11 +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
@@ -34,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
 
@@ -42,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/railtie.rb

@@ -1,4 +1,8 @@
 module TypedOperation
   class Railtie < ::Rails::Railtie
+    generators do
+      require "generators/typed_operation/install/install_generator"
+      require "generators/typed_operation_generator"
+    end
   end
 end

data/lib/typed_operation/version.rb

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

data/lib/typed_operation.rb

@@ -4,7 +4,6 @@ require "typed_operation/base"
 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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -45,26 +45,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: dry-monads
+  name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.0'
   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
+        version: '3.0'
+description: TypedOperation is a command pattern implementation where inputs can be
+  defined with runtime type checks. Operations can be partially applied.
 email:
 - stevegeek@gmail.com
 executables: []
@@ -74,6 +69,13 @@ files:
 - MIT-LICENSE
 - README.md
 - 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
+- lib/generators/typed_operation_generator.rb
 - lib/tasks/typed_operation_tasks.rake
 - lib/typed_operation.rb
 - lib/typed_operation/base.rb