dry-operation_generators-rspec 0.2.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8cc055729dfc76da929f79df028240f7f1d06379326f8efb2990c325fddead6
+  data.tar.gz: 1b6436636b53fdd7851c52e4e82e79fb9017cf20467314f35d2c31f77baae537
+SHA512:
+  metadata.gz: c62079fbc3c52597921f0d780ad37b5d4e8189cdeeabcead7d01c55be1047525a8b13a0fe391a3d476759815dc30f26f2b6691ff9773413ceeb3c4ad3a142fb2
+  data.tar.gz: cd4ac8a2d5b1cca41b4883cf25f0bc5c21fdc5b92fd6a221935c3cb0272a46ffbcf3ca95400d008f0f7d92922162230d7a1dbe2964db2c96bd42aafbe684d5b5

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
+  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,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-08-09 12:12:46 UTC using RuboCop version 1.65.1.
+# 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: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'dry-operation_generators-rspec.gemspec'
+
+# 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:
+    - 'Rakefile.rb'
+    - 'lib/dry-operation_generators-rspec.rb'
+
+# Offense count: 1
+RSpec/MessageChain:
+  Exclude:
+    - 'spec/support/pre/rails.rb'
+
+# Offense count: 3
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 1
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/generators/rspec/operations/schema_generator_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 146

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## [Unreleased]
+
+## [0.2.0.alpha1] - 2024-08-09
+
+Complete re-wrtting.
+
+Missing:
+
+Contract
+Operation
+
+## [0.1.0] - 2024-08-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: 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/README.md

@@ -0,0 +1,96 @@
+# Operation Generators RSpec
+
+Operation Generators RSpec is a utility library designed to add the test file to the files required for new Business Logic actions with Dry Rb ecosystem.
+
+This library doesn't make sense without [dry-operation_generators](https://github.com/joel/dry-operation_generators)
+
+Generates the counterpart test files:
+
+```shell
+spec/operations/users/create/
+├── contract_spec.rb
+├── operation_spec.rb
+└── schema_spec.rb
+```
+
+Please check out [operation_generators](https://github.com/joel/dry-operation_generators)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add operation_generators-rspec
+
+If Bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install operation_generators-rspec
+
+NOTE: The gem needs to be required as `rspec`
+
+    $ gem "operation_generators-rspec", require: "rspec"
+
+Otherwise, you can require "rspec" on your code.
+
+## Usage
+
+Once installed, you can print out the Rails Generators Help:
+
+```shell
+rails generate --help
+```
+
+You should see
+
+```shell
+Operations:
+  operations:schema
+
+Rspec:
+  rspec:operations:schema
+```
+
+Now the Generators should appear:
+
+```shell
+Rspec:
+  ...
+  rspec:operations:contract
+  rspec:operations:operation
+  rspec:operations:schema
+  ...
+```
+
+They are automatically call when the generator it's call:
+
+```shell
+rails generate operations:contract user create firstname:string{optional} --test_framework=rspec
+    invoke  rspec
+    create    spec/operations/users/create/contract_spec.rb
+    create  app/operations/users/create/contract.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>
+```
+
+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-rspec. 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-rspec/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-rspec/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/lib/dry-operation_generators-rspec/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DryOperationsGeneratorsRspec
+  VERSION = "0.2.0.alpha1"
+end

data/lib/dry-operation_generators-rspec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "generators/rspec/operations/schema_generator"

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module <%= class_name.pluralize %>
+  module Base
+    class SchemaTest < ActiveSupport::TestCase
+
+      # This method should return attributes with the keys as symbols.
+      # symbolize_keys
+      def model_attributes
+        # attributes_for(:<%= singular_name %>) # More efficient
+        create(:<%= singular_name %>).attributes.symbolize_keys
+      end
+
+      def attributes
+        model_attributes.merge(
+          schema_attributes
+        ).slice(*described_class.key_list)
+        skip("Skipping: Please replace with the correct attributes for this test.")
+      end
+
+      def schema_attributes
+        {
+          # TODO: Add attributes here.
+        }
+      end
+
+      def valid_attributes
+        attributes
+      end
+
+      def invalid_attributes
+        attributes.merge(
+          {
+            # TODO: Add attributes here
+          }
+        )
+        skip("Skipping: Please replace with the correct attributes for this test.")
+      end
+
+      should "not provide attributes that are not defined in the schema" do
+        assert_empty schema_attributes.keys - described_class.key_list
+      end
+
+      context "validations" do
+
+        subject { described_class }
+
+        context "with valid attributes" do
+
+          should "be successful" do
+            assert subject.call(valid_attributes).success?
+          end
+
+        end
+
+        context "with invalid attributes" do
+
+          should "be unsuccessful" do
+            result = subject.call(invalid_attributes)
+            assert result.failure?
+            # assert_equal({:email => ["must be filled"]}, result.errors.to_h) # rubocop:disable Rails/DeprecatedActiveModelErrorsMethods
+            skip("Skipping: Add the correct error messages here.")
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module <%= class_name.pluralize %>
+  module <%= verb.capitalize %>
+    class SchemaTest < ActiveSupport::TestCase
+
+      # This method should return attributes with the keys as symbols.
+      # symbolize_keys
+      # i.e create(:user).attributes.symbolize_keys
+      def model_attributes
+        # attributes_for(:<%= singular_name %>) # More efficient
+        create(:<%= singular_name %>).attributes.symbolize_keys
+      end
+
+      def attributes
+        model_attributes.merge(
+          schema_attributes
+        ).slice(*described_class.key_list)
+        skip("Skipping: Please replace with the correct attributes for this test.")
+      end
+
+      def schema_attributes
+        {
+          <%- if verb =~ /update|all/ -%>
+          id: SecureRandom.uuid_v7,
+          <%- end -%>
+          # TODO: Add attributes here.
+          <%- @reference_parsed_fields.each do |field| -%>
+          <%- case Operations.configuration.primary_key_type -%>
+          <%- when :integer -%>
+          <%= field.foreign_key %>: 42,
+          <%- when /string|uuid/ -%>
+          <%= field.foreign_key %>: SecureRandom.uuid_v7,
+          <%- end -%>
+          <%- end -%>
+          <%- @regular_parsed_fields.each do |field| -%>
+          <%= field.name %>: "<%= field.type %>",
+          <%- end -%>
+        }
+      end
+
+      def valid_attributes
+        attributes
+      end
+
+      def invalid_attributes
+        attributes.merge(
+          {
+            # TODO: Add attributes here
+            <%- @regular_parsed_fields.select { |f| f.requirement == "required" }.each do |field| -%>
+            # <%= field.name %>: nil,
+            <%- end -%>
+          }
+        )
+        skip("Skipping: Please replace with the correct attributes for this test.")
+      end
+
+      should "not provide attributes that are not defined in the schema" do
+        assert_empty schema_attributes.keys - described_class.key_list
+      end
+
+      context "validations" do
+
+        subject { described_class }
+
+        context "with valid attributes" do
+
+          should "be successful" do
+            assert subject.call(valid_attributes).success?
+          end
+
+        end
+
+        context "with invalid attributes" do
+
+          should "be unsuccessful" do
+            result = subject.call(invalid_attributes)
+            assert result.failure?
+            <%- @regular_parsed_fields.select { |f| f.requirement == "required" }.each do |field| -%>
+            # assert_equal({:<%= field.name %> => ["must be filled"]}, result.errors.to_h) # rubocop:disable Rails/DeprecatedActiveModelErrorsMethods
+            <%- end -%>
+            skip("Skipping: Add the correct error messages here.")
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/generators/rspec/operations/schema_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "operations/base"
+
+# hook_for :test_framework, as: "operations:schema"
+# "rspec:operations:schema" => Rspec::Generators::Operations::SchemaGenerator
+
+module Rspec
+  module Generators
+    module Operations
+      class SchemaGenerator < Rails::Generators::NamedBase
+        include ::Operations::Base::Generators::BaseGenerator
+
+        source_root File.expand_path("schema/templates", __dir__)
+
+        desc "Creates a schema test file for the operation"
+
+        def generate_files
+          super
+
+          template "schema_spec.rb.erb", "#{root_test_file_path}/operations/#{plural_name}/#{verb}/schema_spec.rb"
+          template "base/schema_spec.rb.erb", "#{root_test_file_path}/operations/#{plural_name}/base/schema_spec.rb"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: dry-operation_generators-rspec
+version: !ruby/object:Gem::Version
+  version: 0.2.0.alpha1
+platform: ruby
+authors:
+- Joel AZEMAR
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-09 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Write a longer description or delete this line.
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dry-operation_generators-rspec.rb
+- lib/dry-operation_generators-rspec/version.rb
+- lib/generators/rspec/operations/schema/templates/base/schema_spec.rb.erb
+- lib/generators/rspec/operations/schema/templates/schema_spec.rb.erb
+- lib/generators/rspec/operations/schema_generator.rb
+homepage: http://mygemserver.com
+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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []