dry-operation_generators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa2ca41a11677ba216e23c6d2dfc745ef36aac45c4ac31706e7292f97d877578
+  data.tar.gz: 25cebb74e7ca7b6f5597beb459e855bda57a2b8ec7c24d2b129d98e0ea6c71e0
+SHA512:
+  metadata.gz: 14d1177d692a0b6c95bf7f9dd7fe95503bf403a7afafd799418107e3f9687ba0d447951a23ba6b1a1fe721be999d2ee0444baa4151a6163d521e5d1cc358e8fb
+  data.tar.gz: 2e8e4cdd4f0463cbf5a42a4ba2aa7af1798017db0fb5668fd68e5e6c3998b5156d40355614b18c31db8053c421d08f89bf55af80dbdf57f1afcc1ee4d35a7d07

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-03-15 13:30:02 UTC using RuboCop version 1.60.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 44
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 16
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/dry-operations.rb'
+
+# Offense count: 9
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 26
+
+# Offense count: 3
+RSpec/MultipleExpectations:
+  Max: 3

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at joel.azemar@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Joel Azemar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/PRIVATE_NOTES.md

@@ -0,0 +1,18 @@
+# Build Gem
+
+> gem build
+
+# Publish Gem
+
+> gem push uuid_v7-0.1.0.gem
+
+# Tag
+
+>  mv -v *.gem gems/
+
+> git add . && git stash save "Initial Release"
+
+> git tag -a v0.1.0 main -m "Version 0.1.0"
+
+> git push --tags
+

data/README.md

@@ -0,0 +1,156 @@
+# Operation Generators
+
+Operation Generators is a utility library designed to streamline and expedite the development process within the Dry RB ecosystem by automating the creation of a comprehensive set of files required for new Business Logic actions.
+
+Reducing manual boilerplate code and enforcing a unified code structure enhances productivity and consistency while minimizing the potential for errors.
+
+The following files are generated for the action `Create` of the resource `User`:
+
+```shell
+components/identity/operations/users/create/
+├── action.rb
+├── contract.rb
+├── operation.rb
+├── register.rb
+├── repository.rb
+├── schema.rb
+└── validation.rb
+```
+
+For those files, we need their test counterpart.
+
+```shell
+test/components/identity/operations/users/create/
+├── acction_test.rb
+├── contract_test.rb
+├── operation_test.rb
+├── register_test.rb
+├── repository_test.rb
+├── schema_test.rb
+└── validation_test.rb
+```
+
+Please check out [TestUnit Generators](https://github.com/orgs/joel/dry-operation_generators-test_unit)
+
+Concerning the volume on file needed, the generator will help to reduce the burden and lower the boilerplate of adding a new action. On top of that, it helps reduce typos and make code more unified.
+
+It aims to speed up the development.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add operation_generators
+
+If Bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install operation_generators
+
+NOTE: The gem needs to be required as `operations`
+
+    $ gem "operation_generators", require: "operations"
+
+Otherwise, you can require "operations" on your code.
+
+## Usage
+
+Once installed, you can print out the Rails Generators Help:
+
+```shell
+rails generate --help
+```
+
+You should see
+
+```shell
+Operations:
+  operations:setup
+```
+
+You will need to run the Setup to make the generators available in the Host Application.
+
+```shell
+rails generate operations:setup --force
+# => initializer  operation_generators.rb
+```
+
+Now the Generators should appear:
+
+```shell
+Operations:
+  operations:action
+  operations:contract
+  operations:operation
+  operations:register
+  operations:repository
+  operations:schema
+  operations:validation
+```
+
+You can print the help for any generator:
+
+```shell
+rails generate operations:<generator name> --help
+```
+
+And the special ones:
+
+```shell
+Operations:
+  operations:install
+  operations:scaffold
+  operations:setup
+```
+
+### Install Generator
+
+The `install` generator needs to be run to install the shared files, such as `app/operations/application_contract.rb` of `app/operations/application_schema.rb` that generator might merge into `setup` in the future. Still, I feel it serves a different purpose, and I like to run it separately.
+
+### Scaffold Generator
+
+The `scaffold` generator calls all the generators at once.
+
+```shell
+rails generate operations:scaffold user create firstname:string{optional} --component identity/users --force
+      create  components/identity/operations/users/create/action.rb
+      invoke  test_unit
+      create    test/components/identity/operations/users/create/contract_test.rb
+      create  components/identity/operations/users/base/contract.rb
+      create  components/identity/operations/users/create/contract.rb
+      invoke  test_unit
+      create    test/components/identity/operations/users/create/schema_test.rb
+      create  components/identity/operations/users/base/schema.rb
+      create  components/identity/operations/users/create/schema.rb
+      create  components/identity/operations/users/create/validation.rb
+      create  components/identity/operations/users/create/repository.rb
+      create  components/identity/operations/users/create/register.rb
+      invoke  test_unit
+      create    test/components/identity/operations/users/create/operation_test.rb
+      create  components/identity/operations/users/create/operation.rb
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+There is a generator of generators you can use to quickly add a new generator:
+
+```shell
+./bin/generator <generator name> --no-dry_run
+```
+
+That provides the skeleton for the new generator. Note that the test suite should still run after the generated files.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/orgs/joel/dry-operation_generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joel/dry-operation_generators/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Isms project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joel/dry-operation_generators/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ["-A"] # auto_correct
+end
+
+task default: %i[spec rubocop]

data/config/initializers/dry_schema.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+# Could be acheived with:
+
+# Dry::Schema.load_extensions(:info)
+
+# UserSchema.info.keys
+
+# NOTE: The info data structure is not stable yet and may change before 2.0.0 depending on the user feedback. ^
+
+module ExtractKeysFromSchema
+  def key_list
+    key_map.keys.map { |key| key.name.to_sym }
+  end
+end
+
+Dry::Schema.Params.class.include(ExtractKeysFromSchema)

data/lib/dry-operations.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "operations"

data/lib/operations/create_generator.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+begin
+  require "thor/group"
+rescue LoadError
+  puts "Thor is not available.\nIf you ran this command from a git checkout " \
+       "of Rails, please make sure thor is installed,\nand run this command " \
+       "as `ruby #{$PROGRAM_NAME} #{(ARGV | ["--dev"]).join(" ")}`"
+  exit
+end
+
+require "active_support/inflector"
+
+module Operations
+  class CreateGenerator < Thor::Group
+    include Thor::Actions
+
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+
+    desc "Create a new Generator (Generator of generators)"
+
+    source_root File.expand_path(".", __dir__)
+
+    class_option :force, type: :boolean, default: false
+    class_option :hook_for_test_framework, type: :boolean, default: true
+    class_option :dry_run, type: :boolean, default: true
+
+    argument :name, type: :string, required: true, desc: "Name of the generator"
+
+    def plural_name
+      name.pluralize
+    end
+
+    def singular_name
+      name.singularize
+    end
+
+    def class_name
+      singular_name.capitalize
+    end
+
+    def copy_generator_files
+      return if options[:dry_run]
+
+      template "templates/template_generator.rb.erb", "lib/operations/generators/#{name}_generator.rb"
+      template "templates/template_generator_spec.rb.erb",
+               "spec/operations/generators/#{name}_generator_spec.rb"
+
+      create_file "lib/operations/generators/#{name}/templates/#{name}.rb.erb" do
+        "This is #{name}.rb.erb"
+      end
+    end
+  end
+end
+
+# ./bin/generator <generator name> --no-dry_run
+Operations::CreateGenerator.start(ARGV)

data/lib/operations/generators/action/templates/action.rb.erb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "dry/transaction/operation"
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class Action
+
+      include Dry::Transaction::Operation
+
+      def call(params)
+        instance, input = params.values_at(:instance, :input)
+        <%- case verb -%>
+        <%- when /create|update/ -%>
+        <%- if @reference_parsed_fields.empty? %>
+        attributes = input.dup # use except or slice to filter out unwanted attributes
+        <%- else %>
+        attributes = input.dup.except(
+          :id, :created_at, :updated_at, <%= @reference_parsed_fields.map { |f| ":#{f.foreign_key}" }.join(", ") %>
+        ) # use except or slice to filter out unwanted attributes
+        <%- end %>
+        # Recommended to use slice to filter out unwanted attributes
+        # attributes = input.dup.slice(
+        #   TODO: whitelisted attributes here
+        # )
+
+        instance.assign_attributes(attributes)
+
+        <%- @reference_parsed_fields.each do |field| -%>
+        instance.<%= field.name %> = <%= field.class_name %>.find_by(<%= Operations.configuration.primary_key_name %>: input[:<%= field.foreign_key %>])
+        <%- end -%>
+        <%- end -%>
+
+        # Here comes the Busniness Logic
+
+        <%- case verb -%>
+        <%- when "destroy" -%>
+        if instance.destroy
+        <%- else %>
+        if instance.save
+        <%- end -%>
+          Success(instance)
+        else
+          Failure(instance)
+        end
+      end
+
+    end
+  end
+end

data/lib/operations/generators/action_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class ActionGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      source_root File.expand_path("action/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "action.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/action.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/contract/templates/base/contract.rb.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# The domain validation logic is in the contract, not the schema.
+
+module <%= class_name.pluralize %>
+  module Base
+    class Contract < ApplicationContract
+
+      # Add common rules here
+      # rule(:email).validate(:email_format)
+
+    end
+  end
+end

data/lib/operations/generators/contract/templates/contract.rb.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class Contract < Dry::Validation::Contract
+
+      params(Base::Schema, Schema)
+
+      # Add domain validation rules here
+
+      <%- @reference_parsed_fields.each do |field| -%>
+      rule(:<%= field.foreign_key %>) do
+        key.failure("must exist") if <%= field.class_name %>.where(<%= Operations.configuration.primary_key_name %>: value).none?
+      end
+      <%- end -%>
+
+    end
+  end
+end

data/lib/operations/generators/contract_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class ContractGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      desc "Generates contract for operation"
+
+      hook_for :test_framework, as: "operations:contract"
+
+      source_root File.expand_path("contract/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "base/contract.rb.erb", "#{root_file_path}/operations/#{plural_name}/base/contract.rb"
+        template "contract.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/contract.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/install/templates/application_contract.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApplicationContract < Dry::Validation::Contract
+  register_macro(:email_format) do
+    next unless value
+
+    key.failure("not a valid email format") unless /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i.match?(value)
+  end
+end

data/lib/operations/generators/install/templates/application_schema.rb.tt

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationSchema < Dry::Schema::Params
+end

data/lib/operations/generators/install/templates/dry_schema.rb.tt

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+# Could be acheived with:
+
+# Dry::Schema.load_extensions(:info)
+
+# UserSchema.info.keys
+
+# NOTE: The info data structure is not stable yet and may change before 2.0.0 depending on the user feedback. ^
+
+module ExtractKeysFromSchema
+  def key_list
+    key_map.keys.map { |key| key.name.to_sym }
+  end
+end
+
+Dry::Schema.Params.class.include(ExtractKeysFromSchema)

data/lib/operations/generators/install/templates/dry_types.rb.tt

@@ -0,0 +1,5 @@
+require "dry-types"
+
+module Types
+  include Dry.Types()
+end

data/lib/operations/generators/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("install/templates", __dir__)
+
+      desc "This generator installs the operations setup."
+
+      def copy_setup_files
+        copy_file "application_contract.rb.tt", "app/operations/application_contract.rb"
+        copy_file "application_schema.rb.tt", "app/operations/application_schema.rb"
+        copy_file "dry_schema.rb.tt", "config/initializers/dry_schema.rb"
+        copy_file "dry_types.rb.tt", "config/initializers/dry_types.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/operation/templates/operation.rb.erb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "dry/transaction/operation"
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class Operation
+
+      include Dry::Transaction(container: Register)
+
+      <%- case verb -%>
+      <%- when /create|update/ -%>
+      step :validate_inputs,   with: "<%= plural_name %>.<%= verb %>.validation"
+      <%- end -%>
+      <%- case verb -%>
+      <%- when "create" -%>
+      step :initialize_record, with: "<%= plural_name %>.<%= verb %>.repository"
+      <%- when /update|destroy/ -%>
+      step :fecth_record, with: "<%= plural_name %>.<%= verb %>.repository"
+      <%- end -%>
+
+      step :<%= verb %>_record,     with: "<%= plural_name %>.<%= verb %>.action"
+
+    end
+  end
+end

data/lib/operations/generators/operation_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class OperationGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      desc "Generates operation for operation"
+
+      hook_for :test_framework, as: "operations:operation"
+
+      source_root File.expand_path("operation/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "operation.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/operation.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/register/templates/register.rb.erb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class Register
+
+      extend Dry::Container::Mixin
+
+      namespace "<%= plural_name %>.<%= verb %>" do
+        <%- unless verb == "destroy" -%>
+        register "validation" do
+          Validation.new
+        end
+        <%- end -%>
+
+        register "repository" do
+          Repository.new
+        end
+
+        register "action" do
+          Action.new
+        end
+      end
+
+    end
+  end
+end

data/lib/operations/generators/register_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class RegisterGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      source_root File.expand_path("register/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "register.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/register.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/repository/templates/repository.rb.erb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "dry/transaction/operation"
+require "dry/monads"
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class Repository
+
+      include Dry::Transaction::Operation
+
+      def call(input)
+        <%- case verb -%>
+        <%- when "create" -%>
+        instance = <%= class_name %>.new
+        <%- when /update|destroy/ -%>
+        instance = <%= class_name %>.find_by!(uuid: input[:id])
+        <%- end -%>
+
+        if instance
+          Success({instance:, input:})
+        else
+          Failure({input:})
+        end
+      end
+
+    end
+  end
+end

data/lib/operations/generators/repository_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class RepositoryGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      source_root File.expand_path("repository/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "repository.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/repository.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/scaffold_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      def call_generators
+        invoke "operations:action", [name, verb, fields], options if defined?(Dry::Validation)
+        unless verb == "destroy" || !defined?(Dry::Transaction)
+          invoke "operations:contract",   [name, verb, fields],
+                 options
+        end
+        unless verb == "destroy" || !defined?(Dry::Schema)
+          invoke "operations:schema",     [name, verb, fields],
+                 options
+        end
+        unless verb == "destroy" || !defined?(Dry::Validation)
+          invoke "operations:validation", [name, verb, fields],
+                 options
+        end
+        invoke "operations:repository", [name, verb, fields], options if defined?(Dry::Transaction)
+        invoke "operations:register",   [name, verb, fields], options if defined?(Dry::Container)
+        invoke "operations:operation",  [name, verb, fields], options if defined?(Dry::Transaction)
+      end
+
+      class << self
+        def start(args, config)
+          ActionGenerator.start(args, config)     if defined?(Dry::Validation)
+          ContractGenerator.start(args, config)   if defined?(Dry::Transaction)
+          SchemaGenerator.start(args, config)     if defined?(Dry::Schema)
+          ValidationGenerator.start(args, config) if defined?(Dry::Validation)
+          RepositoryGenerator.start(args, config) if defined?(Dry::Transaction)
+          RegisterGenerator.start(args, config)   if defined?(Dry::Container)
+          OperationGenerator.start(args, config)  if defined?(Dry::Transaction)
+        end
+      end
+    end
+  end
+end

data/lib/operations/generators/schema/templates/base/schema.rb.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Sanitizes, coerces and type-checks input data
+
+module <%= class_name.pluralize %>
+  module Base
+    Schema = Dry::Schema.Params do
+
+      # Add Common Fields Here
+    end
+  end
+end

data/lib/operations/generators/schema/templates/schema.rb.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Sanitizes, coerces and type-checks input data
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    Schema = Dry::Schema.Params do
+      <%- if verb =~ /update|all/ -%>
+      required(:id).filled(:<%= Operations.configuration.primary_key_type %>)
+      <%- end -%>
+      <%- @regular_parsed_fields.each do |field| -%>
+      <%= field.requirement %>(:<%= field.name %>).filled(:<%= field.type %>)
+      <%- end -%>
+      <%- @reference_parsed_fields.each do |field| -%>
+      <%= field.requirement %>(:<%= field.foreign_key %>).filled(:<%= Operations.configuration.primary_key_type %>)
+      <%- end -%>
+    end
+  end
+end

data/lib/operations/generators/schema_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class SchemaGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      desc "Generates schema for operation"
+
+      hook_for :test_framework, as: "operations:schema"
+
+      source_root File.expand_path("schema/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "base/schema.rb.erb", "#{root_file_path}/operations/#{plural_name}/base/schema.rb"
+        template "schema.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/schema.rb"
+      end
+    end
+  end
+end

data/lib/operations/generators/setup/templates/generators.rb.tt

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "operations"
+
+Operations.configure do |config|
+  # config.primary_key_name   = :id       # default :id
+  # config.primary_key_type   = :integer  # default :integer
+  # config.foreign_key_suffix = "_id"     # default "_id"
+end
+
+require "operations/generators/install_generator"    if defined?(Dry)
+require "operations/generators/scaffold_generator"   if defined?(Dry)
+require "operations/generators/schema_generator"     if defined?(Dry::Schema)
+require "operations/generators/action_generator"     if defined?(Dry::Transaction)
+require "operations/generators/contract_generator"   if defined?(Dry::Validation)
+require "operations/generators/validation_generator" if defined?(Dry::Validation)
+require "operations/generators/repository_generator" if defined?(Dry::Transaction)
+require "operations/generators/register_generator"   if defined?(Dry::Container)
+require "operations/generators/operation_generator"  if defined?(Dry::Transaction)

data/lib/operations/generators/setup_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class SetupGenerator < ::Rails::Generators::Base
+      hook_for :test_framework, as: "operations:setup" # Should call test_unit:operations:setup but doesn't ¯\_(ツ)_/¯
+
+      def copy_initializer_file
+        initializer "operation_generators.rb", File.read(File.expand_path("setup/templates/generators.rb.tt", __dir__))
+      end
+    end
+  end
+end

data/lib/operations/generators/validation/templates/validation.rb.erb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry/transaction/operation"
+require "dry/validation"
+require "dry/validation/contract"
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class Validation
+
+      include Dry::Transaction::Operation
+
+      def call(input)
+        params = Contract.new.call(input)
+
+        return Failure(params.errors) if params.failure?
+
+        Success(input)
+      end
+
+    end
+  end
+end

data/lib/operations/generators/validation_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class ValidationGenerator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      source_root File.expand_path("validation/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "validation.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/validation.rb"
+      end
+    end
+  end
+end

data/lib/operations/templates/template_generator.rb.erb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    class <%= class_name %>Generator < Rails::Generators::NamedBase
+      include Base::Generators::BaseGenerator
+
+      desc "Generates <%= singular_name %> for operation"
+
+      <%- if options["hook_for_test_framework"] -%>
+      hook_for :test_framework, as: "operations:<%= singular_name %>"
+      <%- end -%>
+
+      source_root File.expand_path("<%= singular_name %>/templates", __dir__)
+
+      def generate_files
+        super
+
+        template "<%= singular_name %>.rb.erb", "#{root_file_path}/operations/#{plural_name}/#{verb}/<%= singular_name %>.rb"
+      end
+    end
+  end
+end

data/lib/operations/templates/template_generator_spec.rb.erb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Operations
+  module Generators
+    RSpec.describe <%= class_name %>Generator, type: :generator do
+      setup_default_destination
+
+      tests described_class
+
+      let(:<%= singular_name %>_path) { "app/operations/users/create/<%= singular_name %>.rb" }
+
+      subject(:<%= singular_name %>_generator) do
+        run_generator(
+          %w[
+            user
+            create
+          ]
+        )
+      end
+
+      it "copy templates" do
+        <%= singular_name %>_generator
+
+        expect(File).to exist("#{destination_root}/#{<%= singular_name %>_path}")
+      end
+
+      it "uses the expected template files" do
+        <%= singular_name %>_generator
+
+        expect(content_for(<%= singular_name %>_path)).to match(/This is <%= singular_name %>.rb.erb/)
+      end
+
+      context "with component option" do
+        let(:<%= singular_name %>_path) { "components/identity/operations/users/create/<%= singular_name %>.rb" }
+
+        subject(:<%= singular_name %>_generator) do
+          run_generator(
+            %w[
+              user
+              create
+              --component identity/users
+            ]
+          )
+        end
+
+        it "copy templates" do
+          <%= singular_name %>_generator
+
+          expect(File).to exist("#{destination_root}/#{<%= singular_name %>_path}")
+        end
+      end
+    end
+  end
+end

data/lib/operations/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Operations
+  VERSION = "0.1.0"
+end

data/lib/operations.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/dry-operations.rb")
+loader.setup
+
+require "rails/generators"
+
+require "operations/generators/setup_generator"
+
+require "operations/base"
+
+module Operations
+end

data/operation_generators.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/operations/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dry-operation_generators"
+  spec.version = Operations::VERSION
+  spec.authors = ["Joel Azemar"]
+  spec.email = ["joel.azemar@gmail.com"]
+
+  spec.summary = "Generates Dry RB operation files"
+  spec.homepage = "https://github.com/joel/generators"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-operation_generators-base"
+  spec.add_dependency "rails"
+  spec.add_dependency "zeitwerk"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/sig/operations.rbs

@@ -0,0 +1,4 @@
+module Operations
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: dry-operation_generators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Azemar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-operation_generators-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- PRIVATE_NOTES.md
+- README.md
+- Rakefile
+- config/initializers/dry_schema.rb
+- lib/dry-operations.rb
+- lib/operations.rb
+- lib/operations/create_generator.rb
+- lib/operations/generators/action/templates/action.rb.erb
+- lib/operations/generators/action_generator.rb
+- lib/operations/generators/contract/templates/base/contract.rb.erb
+- lib/operations/generators/contract/templates/contract.rb.erb
+- lib/operations/generators/contract_generator.rb
+- lib/operations/generators/install/templates/application_contract.rb.tt
+- lib/operations/generators/install/templates/application_schema.rb.tt
+- lib/operations/generators/install/templates/dry_schema.rb.tt
+- lib/operations/generators/install/templates/dry_types.rb.tt
+- lib/operations/generators/install_generator.rb
+- lib/operations/generators/operation/templates/operation.rb.erb
+- lib/operations/generators/operation_generator.rb
+- lib/operations/generators/register/templates/register.rb.erb
+- lib/operations/generators/register_generator.rb
+- lib/operations/generators/repository/templates/repository.rb.erb
+- lib/operations/generators/repository_generator.rb
+- lib/operations/generators/scaffold_generator.rb
+- lib/operations/generators/schema/templates/base/schema.rb.erb
+- lib/operations/generators/schema/templates/schema.rb.erb
+- lib/operations/generators/schema_generator.rb
+- lib/operations/generators/setup/templates/generators.rb.tt
+- lib/operations/generators/setup_generator.rb
+- lib/operations/generators/validation/templates/validation.rb.erb
+- lib/operations/generators/validation_generator.rb
+- lib/operations/templates/template_generator.rb.erb
+- lib/operations/templates/template_generator_spec.rb.erb
+- lib/operations/version.rb
+- operation_generators.gemspec
+- sig/operations.rbs
+homepage: https://github.com/joel/generators
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Generates Dry RB operation files
+test_files: []