cqs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25ead5f863f480be7c4142451b814639bdc679bb4b12d0403299405d61d43117
+  data.tar.gz: e523eaf75e002bf13514258722a6d9b69929792edb5cfd06bb170c1875a46f2c
+SHA512:
+  metadata.gz: 6eb876b0f9a852087a7f02aef4d4cacff33fb42b2c28844c48dbbb6fffc2f3ba9636c27564fb94857db295438aec5e6fb91bb7640f3209aaddc4e1f2f63ba79c
+  data.tar.gz: 85ce856f0e5ccd0bf8c62398b30070e08ec97f9f33dcbd30945b0e260f9b32345530fd59aead7b4d6a6afc8c2299f2b40c0a491dbe4d007b3c5728ef888d3578

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--exclude_pattern "tmp/**/*.rb"

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-29
+
+- Initial release
+- Provides Command and Query classes
+- Provides Rails generators

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 Enrique Comba Riepenhausen
+
+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,149 @@
+# CQS - Command Query Separation for Ruby (and Rails)
+
+⚠️ This gem (and readme) are still **Work In Progress** ⚠️
+
+Unlike [CQRS](https://martinfowler.com/bliki/CQRS.html), this gem tries to give a framework that allows to separate _Commands_ from _Queries_ in your [Ruby](https://www.ruby-lang.org) programs.
+
+Working on a [Ruby on Rails](http://rubyonrails.org/) application we got tired and frustrated about the `ApplicationService` pattern that is so prevalent in so many [Rails](http://rubyonrails.org/)
+codebases.
+
+Here are a few reasons we did and did not like the pattern:
+
+- A Service can be almost anything
+- We are never sure what the service _really_ does and we end up, if not careful, creating similar services
+- The language got a little muddled
+
+For these reasons we opted for creating a simpler language in our application.
+
+> When requesting information use a **Query**
+>
+> When requesting a change use a **Command**
+
+One thing we did not want to implement (_the reason this is not a [CQRS](https://martinfowler.com/bliki/CQRS.html) implementation_) is the strictness of a pure CQRS implementation (_meaning commands can,
+and many times will, have return values, specially if you consider a #save action in a Rails app_).
+
+
+## Usage
+
+Most of the times we use this gem in a [Ruby on Rails](https://rubyonrails.org) project, so the usage examples will be for Rails. If you use it in plain Ruby projects it will still work, you just won't have
+access to the generators.
+
+We are opinionated with the use of [RSpec](https://rspec.info) to test drive our code. Let us know if you'd like to have other testing tools supported!
+
+### General assumptions
+
+Commands and Queries operate on a `subject`. The subject is passed into the action by the provided methods (`wtih` for commands, and `in` for queries):
+
+```ruby
+FindUser.in(email_address: "test@test.com")
+```
+
+You can register methods to change the way you call your action:
+
+```ruby
+class FindUser
+  include Query
+  register_method :by
+  ...
+```
+
+And then call the action with the method registered:
+
+```ruby
+FindUser.by(email_address: "test@test.com")
+```
+
+This works for both, `Commands` and `Queries`.
+
+The subject is what's passed into the calling method and can be anything you like (_see below to see how it's used_).
+
+### Queries
+
+Imagine you want to create a query to find a user by passing a hash with some of their attributes (`find_by` in Rails).
+
+To save time and setup you'll run the provided generator:
+
+```bash
+rails generate cqs:query FindUser
+```
+
+This will create the following files:
+
+```
+- app/queries/query/find_user.rb
+- spec/queries/query/find_user_spec.rb
+```
+
+The generated `Query` looks like so:
+
+```ruby
+module Query
+  class FindUser
+    include Query
+
+    def answer
+      raise AnswerUnknownApology.new "Please implement #answer"
+    end
+  end
+end
+```
+
+And the corresponding spec:
+
+```ruby
+require "rails_helper"
+
+describe Query::FindUser do
+  it "does something" do
+    pending "test your query"
+  end
+end
+```
+
+First we'd write our spec to ensure our `Query` does what we'd like it to do:
+
+```ruby
+require "rails_helper"
+
+describe Query::FindUser do
+  it "finds a user by their email address" do
+    email_address = { email_address: "test@test.com"}
+    expect(User).to receive(:find_by).with(email_address)
+
+    Query::FindUser.by(email_address)
+  end
+end
+```
+
+and the code to make this pass:
+
+```ruby
+module Query
+  class FindUser
+    include Query
+    register_method :by
+
+    def answer
+      User.find_by(subject)
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle execute rspec` 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cqs. 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/[USERNAME]/cqs/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 CQS project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cqs/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/cqs/base.rb

@@ -0,0 +1,19 @@
+module Cqs
+  class Error < StandardError; end
+
+  module Base
+    def self.included(base)
+      base.prepend InstanceMethods
+    end
+
+    module InstanceMethods
+      def initialize(subject)
+        @subject = subject
+      end
+
+      def subject
+        @subject
+      end
+    end
+  end
+end

data/lib/cqs/command.rb

@@ -0,0 +1,22 @@
+require "cqs/base"
+
+module Command
+  include Cqs::Base
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.register_method :with
+  end
+
+  module ClassMethods
+    def register_method(method_name)
+      define_singleton_method(method_name) do |subject|
+        new(subject).execute
+      end
+    end
+  end
+
+  def execute
+    raise CommandNotFound.new "I'm really sorry, but that command doesn't exist."
+  end
+end

data/lib/cqs/engine.rb

@@ -0,0 +1,6 @@
+require "rails/engine"
+
+module Cqs
+  class Engine < Rails::Engine
+  end
+end

data/lib/cqs/query.rb

@@ -0,0 +1,22 @@
+require "cqs/base"
+
+module Query
+  include Cqs::Base
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.register_method :in
+  end
+
+  module ClassMethods
+    def register_method(method_name)
+      define_singleton_method(method_name) do |subject|
+        new(subject).answer
+      end
+    end
+  end
+
+  def answer
+    raise AnswerUnknownApology.new "I'm really sorry, but I don't have any answer for you."
+  end
+end

data/lib/cqs/version.rb

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

data/lib/cqs.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "cqs/version"
+
+autoload :Command, "cqs/command"
+autoload :Query, "cqs/query"
+
+class CommandNotFound < StandardError; end
+
+class AnswerUnknownApology < StandardError; end

data/lib/generators/cqs/command/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates a new Command
+
+Example:
+    bin/rails generate cqs:command MyCommand
+
+    This will create:
+        app/commands/command/my_command.rb
+        spec/commands/command/my_command_spec.rb

data/lib/generators/cqs/command/command_generator.rb

@@ -0,0 +1,19 @@
+module Cqs::Generators
+  class CommandGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+
+    def create_command_file
+      template "command.rb", File.join(
+        "app/commands/command",
+        "#{file_name}.rb"
+      )
+    end
+
+    def create_command_spec_file
+      template "command_spec.rb", File.join(
+        "spec/commands/command",
+        "#{file_name}_spec.rb"
+      )
+    end
+  end
+end

data/lib/generators/cqs/command/templates/command.rb.tt

@@ -0,0 +1,9 @@
+module Command
+  class <%= class_name %>
+    include Command
+
+    def execute
+      raise CommandNotFound.new "Please implement #execute"
+    end
+  end
+end

data/lib/generators/cqs/command/templates/command_spec.rb.tt

@@ -0,0 +1,7 @@
+require "rails_helper"
+
+describe Command::<%= class_name %> do
+  it "does something" do
+    pending "test your command"
+  end
+end

data/lib/generators/cqs/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Installs cqs
+
+Example:
+  rails generate cqs:install
+
+This will create:
+	app/initializers/cqs.rb

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

@@ -0,0 +1,14 @@
+module Cqs::Generators
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def create_intializer
+      template "cqs.rb.erb", Rails.root.join("config/initializers/cqs.rb")
+    end
+
+    def create_directories
+      empty_directory Rails.root.join("app/commands/command")
+      empty_directory Rails.root.join("app/queries/query")
+    end
+  end
+end

data/lib/generators/cqs/install/templates/cqs.rb.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Command
+end
+
+module Query
+end
+
+Rails.autoloaders.main.push_dir(
+  Rails.root.join("app/commands/command").to_s, namespace: Command
+)
+
+Rails.autoloaders.main.push_dir(
+  Rails.root.join("app/queries/query").to_s, namespace: Query
+)

data/lib/generators/cqs/query/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates a new Query
+
+Example:
+    bin/rails generate cqs:query MyQuery
+
+    This will create:
+        app/queries/query/my_query.rb
+        spec/queries/query/my_query_spec.rb

data/lib/generators/cqs/query/query_generator.rb

@@ -0,0 +1,19 @@
+module Cqs::Generators
+  class QueryGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+
+    def create_query_file
+      template "query.rb", File.join(
+        "app/queries/query",
+        "#{file_name}.rb"
+      )
+    end
+
+    def create_query_spec_file
+      template "query_spec.rb", File.join(
+        "spec/queries/query",
+        "#{file_name}_spec.rb"
+      )
+    end
+  end
+end

data/lib/generators/cqs/query/templates/query.rb.tt

@@ -0,0 +1,9 @@
+module Query
+  class <%= class_name %>
+    include Query
+
+    def answer
+      raise AnswerUnknownApology.new "Please implement #answer"
+    end
+  end
+end

data/lib/generators/cqs/query/templates/query_spec.rb.tt

@@ -0,0 +1,7 @@
+require "rails_helper"
+
+describe Query::<%= class_name %> do
+  it "does something" do
+    pending "test your query"
+  end
+end

data/sig/cqs.rbs

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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: cqs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Enrique Comba Riepenhausen
+bindir: exe
+cert_chain: []
+date: 2024-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: cqs allows you to separate queries from commands for a better segregation
+  of concerns.
+email:
+- enrique@ecomba.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cqs.rb
+- lib/cqs/base.rb
+- lib/cqs/command.rb
+- lib/cqs/engine.rb
+- lib/cqs/query.rb
+- lib/cqs/version.rb
+- lib/generators/cqs/command/USAGE
+- lib/generators/cqs/command/command_generator.rb
+- lib/generators/cqs/command/templates/command.rb.tt
+- lib/generators/cqs/command/templates/command_spec.rb.tt
+- lib/generators/cqs/install/USAGE
+- lib/generators/cqs/install/install_generator.rb
+- lib/generators/cqs/install/templates/cqs.rb.erb
+- lib/generators/cqs/query/USAGE
+- lib/generators/cqs/query/query_generator.rb
+- lib/generators/cqs/query/templates/query.rb.tt
+- lib/generators/cqs/query/templates/query_spec.rb.tt
+- sig/cqs.rbs
+homepage: https://github.com/OurWeeSaas/cqs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OurWeeSaas/cqs
+  source_code_uri: https://github.com/OurWeeSaas/cqs
+  changelog_uri: https://github.com/OurWeeSaas/cqs/CHANGELOG.md
+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.6.0
+specification_version: 4
+summary: Command Query Segregation simplified for ruby (and rails)
+test_files: []