typed_operation 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 895e2a58caa6a8a40c35d3eff22b9429fed9f0c49627f275cd583ce0c2fe4bc6
-  data.tar.gz: 794004ac749b5ff9df514827a794ef01917e5ca4bdd2b887a5e8ea06b491a097
+  metadata.gz: b3c88c55bf10a3d9d6582adfbb253c94a1fd6cf287794089775c9a8dbf1dfd86
+  data.tar.gz: baee565ac599fb5351d1758fe720587e6793114c8ec830cbe3db6d5dc40b2d61
 SHA512:
-  metadata.gz: e81f633626fbd914bae0c232c22d1c9b5e44cc2169691fd022c408dbbbad15179062a8d641b03f6165a033c946cde10ad740b971b636c05fc85c7f828ed643c1
-  data.tar.gz: 65e4065dded231777a7b2ed40ef901268da46e7d8403a20edb642d5ea815e15b280a8b46a64d24753de67daab3d7e50b9985fe6bebe6898c19f98386bb8020f8
+  metadata.gz: 32a92d0277fee468925bd0a3c5b4b377ebb8107b3202ea13f1c23925532df4665efffaac90e76c32060f629cb9a476e654abba406e80c28da7bcf590e504c445
+  data.tar.gz: 82d9ae76e6ba43564a3632d577ddf99ab92758c4b44cfad985a812b121c1c63efee7ceba0d92e1839c8fc6b5a0476a4914d4a33fdeca6a84bce9f0caca6c7789

data/README.md

@@ -1,7 +1,4 @@
 # TypedOperation
-Short description and motivation.
-
-## Usage
 
 An implementation of a Command pattern, which is callable, and can be partially applied (curried).
 
@@ -96,6 +93,26 @@ Or install it yourself as:
 $ gem install typed_operation
 ```
 
+## Add an `ApplicationOperation` to your project
+
+```ruby
+bin/rails g typed_operation:install
+```
+
+## 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`.
+
 ## 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,31 @@
+# frozen_string_literal: true
+
+<% if namespace_name.present? %>
+module <%= namespace_name %>
+  class <%= name %> < ::ApplicationOperation
+    # Replace with implementation...
+    param :param1, String, convert: true
+
+    def prepare
+      # Prepare...
+    end
+
+    def call
+      # Perform...
+    end
+  end
+end
+<% else %>
+class <%= name %> < ::ApplicationOperation
+  # Replace with implementation...
+  param :param1, String, convert: true
+
+  def prepare
+    # Prepare...
+  end
+
+  def call
+    # Perform...
+  end
+end
+<% end %>

data/lib/generators/typed_operation/install/USAGE

@@ -0,0 +1,13 @@
+Install Generator
+=================
+
+Description:
+------------
+This generator installs a `ApplicationOperation` class which is your base class for all Operations.
+
+Command:
+--------
+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,15 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module TypedOperation
+  module Install
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_application_operation_file
+        copy_file "application_operation.rb", "app/operations/application_operation.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationOperation < ::TypedOperation::Base
+  # Common properties & methods for operations of this application...
+end

data/lib/generators/typed_operation_generator.rb

@@ -0,0 +1,23 @@
+# 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_path = File.join(self.class.source_root, "operation.rb")
+    dest_path = File.join(options[:path], "#{file_name}.rb")
+
+    template(template_path, dest_path)
+  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,5 +1,9 @@
 # frozen_string_literal: true
 
+require "dry/monads"
+require "vident/typed"
+require "vident/typed/attributes"
+
 module TypedOperation
   class Base
     include Dry::Monads[:result, :do]

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.1.0"
+  VERSION = "0.3.0"
 end

data/lib/typed_operation.rb

@@ -1,8 +1,8 @@
 require "typed_operation/version"
 require "typed_operation/railtie"
 require "typed_operation/base"
-require "typed_operation/prepared"
 require "typed_operation/partially_applied"
+require "typed_operation/prepared"
 
 module TypedOperation
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_operation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-06-19 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'
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +78,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-description: TypedOperation is a command pattern implementation
+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 +89,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/USAGE
+- lib/generators/templates/operation.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