cuscuz 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ebc35ca695cb9e0b92893d76353e52033eac0a6ba9d71b521d61b35cb8b49e
-  data.tar.gz: 25ddaeef78a49b3c1c32741102f7b2262181f7606c07cbee3e7d3b21ba84b2c2
+  metadata.gz: 55366339a2c1e70d25578a30893052e46b7e89f4037bfd09b74f9b0ade29e659
+  data.tar.gz: ab92be4869076ead412f55a0155aaf72abcd0ce3912880c8f1e5cf6826fa8b94
 SHA512:
-  metadata.gz: be1c9c5f8cf195f358e8d9d3d11cf7617009988ee7d85f7a365087c604f3b18b6ca3ed5b13c7939d0dceef5eaba0b10c030b761d9e434fb29eb5cfcd089c7f3e
-  data.tar.gz: bee5292d41e49e4760644d38f7c5f924d98130d054795e4b9259661fec288695050181d99dbd97834deb46308c4611808bcd0ce71750040f3288ec5b2466b1b7
+  metadata.gz: c852f860a595ffd4e00ad8437df56c8a725abd55f0f79b27a1080c427afc36425733bc84f723533a0c5600dbe184e6026414a837f42ce6613b098d603e641013
+  data.tar.gz: 92c91d0a0e56d8f86bdef46d820dff645bf524d7848b70ee85f5a690f40626e23b7008233016ae41c57a7e5962acc8cb96e6f95bef807b5e9c8c233f3040a3b3

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
 
-## [0.0.1] - 2024-03-01
+## [0.1.0] - 2026-05-15
 
 - Initial release

data/CODE_OF_CONDUCT.md

@@ -1,84 +1,10 @@
-# Contributor Covenant Code of Conduct
+# Code of Conduct
 
-## Our Pledge
+"cuscuz" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
 
-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.
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
 
-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 3025661+stephannv@users.noreply.github.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.
+If you have any concerns about behaviour within this project, please contact us at ["contact@gunbolt.org"](mailto:"contact@gunbolt.org").

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 stephann
+Copyright (c) 2026-present Gunbolt Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,24 +1,320 @@
 # Cuscuz
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cuscuz`. To experiment with that code, run `bin/console` for an interactive prompt.
+Cuscuz is a gem for writing business logic objects, similar to interactors, 
+services, operations, use cases, mutations, and commands. It relies heavily on
+the [Literal](https://literal.fun) gem to provide input and output validation.
+Cuscuz was extracted from our project [pikoin](https://github.com/gunbolt/pikoin),
+a simple personal finance tracker.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle add cuscuz --source "https://beta.gem.coop/@gunbolt"
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or put in your Gemfile:
+```ruby
+gem "cuscuz", source: "https://beta.gem.coop/@gunbolt"
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install cuscuz --source "https://beta.gem.coop/@gunbolt"
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+## TL;DR:
+
+```ruby
+class UpdateRecord < Cuscuz::Operation
+  prop :id, Integer
+  prop :attributes, Hash
+
+  Success = Result.success(record: Record)
+  Failure = Result.failure(reason: String, record: Record)
+
+  def call
+    record = Record.find(@id)
+
+    if record.update(@attributes)
+      Success[record:]
+    else
+      Failure[reason: "Invalid record", record:]
+    end
+  end
+end
+
+result = UpdateRecord.call(id: 1, attributes: {title: "Updated Record"})
+
+result.success? # => true
+result.failure? # => false
+result.record   # => #<Record id=1 ...>
+result.class    # => UpdateUser::Success
+
+case result
+in success: true, record:
+  ...
+in failure: true, reason:, record:
+  ...
+end
+
+case result
+in UpdateRecord::Success(record:)
+  ...
+in UpdateRecord::Failure(reason:, record:)
+  ...
+end
+```
+
+## Defining inputs
+Cuscuz uses [Literal::Properties](https://literal.fun/docs/properties.html) to 
+enable input validation for operations. You can read the Literal documentation
+to understand the full API, but here are some basic usage examples:
+
+```ruby
+# required keyword argument of type Integer
+prop :id, Integer
+
+# required keyword argument of type Integer or String
+prop :id, _Union(Integer, String)
+
+# optional keyword argument of type Symbol
+prop :type, _String?
+
+# optional keyword argument of type custom type
+prop :user, _Nilable(User)
+
+# optional keyword argument with default value
+prop :priority, Integer, default: 5
+
+# array
+prop :values, Array
+
+# advanced array
+prop :posts, _Array(Post)
+
+# hash
+prop :attributes, Hash
+
+# advanced hash
+prop :options, _Hash(Symbol, _Union(String, Symbol, Integer, _Boolean))
+
+# Rails relations
+prop :posts, ActiveRecord::Relation(Post)
+```
+
+If you do not provide the correct arguments to the operation, meaningful errors
+will be raised:
+```ruby
+class Sum < Cuscuz::Operation
+  prop :a, Integer
+  prop :b, Integer
+
+  # ...
+end
+
+Sum.call(a: "2", b: 3)
+# Type mismatch (Literal::TypeError)
+#
+# Sum#initialize (from )
+#  a:
+#    Expected: Integer
+#    Actual (String): "2"
+
+Sum.call(a: 2)
+#  missing keyword: :b (ArgumentError)
+```
+
+The inputs can be accessed via instance variables:
+```ruby
+class Sum < Cuscuz::Operation
+  prop :a, Integer
+  prop :b, Integer
+
+  # ...
+   
+  def call
+    puts @a
+    puts @b
+
+    # ...
+  end
+end
+
+Sum.call(a: 5, b: 4)
+# => 5
+# => 4
+```
+
+## Defining the outputs
+Cuscuz operations are required to return either a `Cuscuz::Result::Success` or 
+a `Cuscuz::Result::Failure`. They are subclasses of `Literal::Data`, similar to
+Ruby’s native `Data` class, but with support for property validation through 
+Literal features. You can define them using `Result.success` and 
+`Result.failure`:
+
+```ruby
+class Divide < Cuscuz::Operation
+  prop :a, Integer
+  prop :b, Integer
+
+  Success = Result.success(value: Integer)
+  Failure = Result.failure(reason: String)
+
+  def call
+    if b == 0
+      Failure[reason: "Cannot divide by zero"]
+    else
+      Success[value: a / b]
+    end
+  end
+end
+
+result = Divide.call(a: 10, b: 5)
+result.success? # => true
+result.failure? # => false
+result.value    # => 2
+result.class    # => Divide::Success
+
+result = Divide.call(a: 10, b: 0)
+result.success? # => false
+result.failure? # => true
+result.reason   # => "Cannot divide by zero"
+result.class    # => Divide::Failure
+```
+
+The result object provides the `#success?` and `#failure?` methods, along with
+accessors for its properties.
+
+To instantiate results, you can use either the `.new` or `.[]` method:
+```ruby
+Success[value: 2] == Success.new(value: 2) # => true
+```
+
+If you do not provide the correct arguments, an error will be raised:
+```ruby
+Success[value: "2"] 
+# Type mismatch (Literal::TypeError)
+#
+# Divide::Success#initialize (from )
+#  value:
+#    Expected: Integer
+#    Actual (String): "2"
+
+Success[] # missing keyword: :value (ArgumentError)
+```
+
+If your operation does not return a `Cuscuz::Result::Success` or
+`Cuscuz::Result::Failure`, an error will be raised:
+```ruby
+class MyOperation < Cuscuz::Operation
+  def call
+    return "2"
+  end
+end
+
+MyOperation.call
+# Cuscuz::InvalidResultTypeError: 
+# The operation returned a `String`, it was expected a 
+# `Cuscuz::Result::Success` or `Cuscuz::Result::Failure`
+```
+
+You can define multiple types of successes and/or failures:
+```ruby
+class CreateUser < Cuscuz::Operation
+  prop :attributes, Hash
+
+  ReadyUserResult = Result.success(user:)
+  PendingApprovalResult = Result.success(user:)
+  InvalidAttributesResult = Result.failure(user:)
+  BannedUserResult = Result.failure(user:)
+
+  def call
+    user = User.new(@attributes)
+
+    if banned_emails.include?(user.email)
+      return BannedUserResult[user:]
+    end
+    
+    if user.save
+      if user.workspace.needs_approval?
+        PendingApprovalResult[user:]
+      else
+        ReadyUserResult[user:]
+      end
+    else
+      InvalidAttributesResult[user:]
+    end
+  end
+
+  private
+
+  def banned_emails = ...
+end
+```
+
+## Executing the operation
+Define an instance method named `#call` inside your operation to implement your
+business logic. 
+
+You can execute the operation using the `.call` and `.call!` methods. When 
+using `.call!`, an error will be raised if the operation fails. For example:
+```ruby
+class InviteUser < Cuscuz::Operation
+  prop :role, String
+
+  Success = Result.success
+  Failure = Result.failure
+
+  def call
+    if @role == "admin"
+      Success[]
+    else
+      Failure[]
+    end
+  end
+end
+
+InviteUser.call(role: "admin")  # InviteUser::Success
+InviteUser.call(role: "member") # InviteUser::Failure
+
+InviteUser.call!(role: "admin")  # InviteUser::Success
+InviteUser.call!(role: "member") # raises Cuscuz::FailedOperationError("`InviteUser` execution failed")
+```
+
+## Handle operation result
+You can handle the operation result using `#success?` / `#failure?` or pattern
+matching. For example:
+
+```ruby
+# success?/failure?
+result = CreateUser.call(attributes: user_attributes)
+
+if result.success?
+  puts result.user
+else
+  puts result.reason
+end
+
+# Pattern matching (deconstructing keys)
+case CreateUser.call(attributes: user_attributes)
+in success: true, user:
+  puts user
+in failure: true, reason:
+  puts reason
+end
+
+# Pattern matching (alternative)
+case CreateUser.call(attributes: user_attributes)
+in CreateUser::Succcess(user:)
+  puts user
+in CreateUser::Failure(reason:)
+  puts reason
+end
+```
 
 ## Development
 
@@ -28,7 +324,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cuscuz. 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]/cuscuz/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on Codeberg at https://codeberg.com/gunbolt/cuscuz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://codeberg.com/gunbolt/cuscuz/blob/master/CODE_OF_CONDUCT.md).
+
+Contributions must not include content generated by large language models or other probabilistic tools, including but not limited to Copilot, Claude or ChatGPT. This policy covers code, documentation, pull requests, issues, comments, and any other contributions to the Gunbolt projects.
+
 
 ## License
 
@@ -36,4 +335,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Cuscuz project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cuscuz/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Cuscuz project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://codeberg.com/gunbolt/cuscuz/blob/master/CODE_OF_CONDUCT.md).

data/lib/cuscuz/errors.rb

@@ -0,0 +1,15 @@
+module Cuscuz
+  class Error < StandardError; end
+
+  class InvalidResultTypeError < Error
+    def initialize(result_class)
+      super("The operation returned a `#{result_class}`, it was expected a `Cuscuz::Result::Success` or `Cuscuz::Result::Failure`")
+    end
+  end
+
+  class FailedOperationError < Error
+    def initialize(operation_class)
+      super("`#{operation_class}` execution failed")
+    end
+  end
+end

data/lib/cuscuz/operation.rb

@@ -0,0 +1,47 @@
+module Cuscuz
+  class Operation
+    extend Literal::Properties
+
+    Result = Cuscuz::Result
+
+    RESULT_CLASSES = _Union(Cuscuz::Result::Success, Cuscuz::Result::Failure)
+
+    def self.call(...) = new(...).call
+
+    def self.call!(...) = new(...).call!
+
+    def self.inherited(operation)
+      super
+
+      operation.prepend(Executor)
+    end
+
+    def call
+      raise NoMethodError, "`#call` instance method should be implemented in #{self.class.name}"
+    end
+
+    private
+
+    module Executor
+      def call
+        result = super
+
+        if RESULT_CLASSES === result
+          result
+        else
+          raise InvalidResultTypeError.new(result.class)
+        end
+      end
+
+      def call!
+        result = call
+
+        if result.success?
+          result
+        else
+          raise FailedOperationError.new(self.class)
+        end
+      end
+    end
+  end
+end

data/lib/cuscuz/result.rb

@@ -0,0 +1,31 @@
+module Cuscuz
+  class Result < Literal::Data
+    class Success < Result
+      prop :success, _Boolean, default: true, reader: false, predicate: :public do
+        true
+      end
+
+      prop :failure, _Boolean, default: false, reader: false, predicate: :public do
+        false
+      end
+    end
+
+    class Failure < Result
+      prop :success, _Boolean, default: false, reader: false, predicate: :public do
+        false
+      end
+
+      prop :failure, _Boolean, default: true, reader: false, predicate: :public do
+        true
+      end
+    end
+
+    def self.success(...)
+      Success.define(...)
+    end
+
+    def self.failure(...)
+      Failure.define(...)
+    end
+  end
+end

data/lib/cuscuz/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Cuscuz
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/cuscuz.rb

@@ -1,8 +1,9 @@
-# frozen_string_literal: true
+require "literal"
 
+require_relative "cuscuz/errors"
+require_relative "cuscuz/result"
+require_relative "cuscuz/operation"
 require_relative "cuscuz/version"
 
 module Cuscuz
-  class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,37 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: cuscuz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - stephann
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: literal
+  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'
 email:
-- 3025661+stephannv@users.noreply.github.com
+- stephann@gunbolt.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/cuscuz.rb
+- lib/cuscuz/errors.rb
+- lib/cuscuz/operation.rb
+- lib/cuscuz/result.rb
 - lib/cuscuz/version.rb
-- sig/cuscuz.rbs
-homepage: https://github.com/stephannv/cuscuz
+homepage: https://codeberg.org/gunbolt/cuscuz
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/stephannv/cuscuz
-post_install_message:
+  homepage_uri: https://codeberg.org/gunbolt/cuscuz
+  source_code_uri: https://codeberg.org/gunbolt/cuscuz
+  changelog_uri: https://codeberg.com/gunbolt/cuscuz/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -39,15 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
-summary: 'WIP: summary'
+summary: Cuscuz is a gem for writing business logic objects
 test_files: []

data/.standard.yml

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

data/sig/cuscuz.rbs

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