categoria 0.1.0.pre.beta0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 708dc304bd6e976ef1570ee99cb1208b4814c37fdcff7e0f69ac4d2ce7970e50
+  data.tar.gz: d2db1ff75ae27757941554ee650ea86e5db8fb6a34d715a439e74b2bbc67f4b3
+SHA512:
+  metadata.gz: 84ff6674a0d1c147b13a449c2f816314d1e748263e67bfad5ada878055897398ee60a501d372649718d74e34d3973447553cd45747a098aa9433d6851e137a37
+  data.tar.gz: 3581214bb48972f200f24b59567b2e529fdcf6c3164aa49f3b001d38c6173af89aa182cb240995d2eb058312d28ebeaa61225b195bc7a6150117a7b34ef4246d

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require:
+  - rubocop-rake
+  - rubocop-minitest
+  - rubocop-sorbet
+
+AllCops:
+  TargetRubyVersion: 3.3
+  Exclude:
+    - "**/sorbet/**/*"
+    - "**/bin/**/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/AccessModifierDeclarations:
+  Enabled: true
+  EnforcedStyle: inline
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/CHANGELOG.md

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Yaw Boakye
+
+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,33 @@
+# κατηγορία
+
+i argue that the default way to structure a rails application is bad, and
+subsequently encourages bad design because components of a logical unit are
+spread all over the place: in the `models` directory, the `services` (the
+mechanism the rails community seems to have settled on for bundling executive
+code together), sometimes `concerns`, etc.
+
+look at [discourse][], my favorite rails project of all time, and it's almost
+impossible to figure out the essence of the application. the entries in the
+[`app/models`][dc_models] directory continues to grow with no end in sight. the
+relationships between these models—who works with who and in what
+capacity?—isn't immediately obvious.
+
+categoria fixes this. it regroups data and executive code and separates them
+along domain lines. it's similar in spirit to [phoenix's context][phxc]. the
+point of departure is the following:
+
+**a category/domain doesn't concern itself with the web part of the application.**
+
+### directory structure of a domain
+
+domains live under `app/lib` of the rails application. internally, it is
+organized into three main categories, represented by directories and ruby module
+namespaces:
+
+- `internal`: to be described
+- `command`: to be described
+- `data`: to be described
+
+[discourse]: https:/github.com/discourse/discourse
+[dc_models]: https://github.com/discourse/discourse/tree/main/app/models
+[phxc]: https://hexdocs.pm/phoenix/contexts.html

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/categoria.gemspec

@@ -0,0 +1,48 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "lib/categoria/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "categoria"
+  spec.version = Categoria::VERSION
+  spec.authors = ["Yaw Boakye"]
+  spec.email = ["wheresyaw@gmail.com"]
+
+  spec.summary = "categoria presents a set of generators for domain-driven development in rails"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/yawboakye/categoria"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = %(#{spec.homepage}/CHANGELOG.md)
+
+  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/ features/ .git .github appveyor Gemfile])
+    end
+  end
+
+  spec.require_paths = %(lib)
+
+  spec.add_runtime_dependency     "sorbet-runtime",   "~> 0.5"
+
+  spec.add_development_dependency "debug",            "~> 1.9"
+  spec.add_development_dependency "minitest",         "~> 5.16"
+  spec.add_development_dependency "rake",             "~> 13.0"
+  spec.add_development_dependency "rubocop",          "~> 1.21"
+  spec.add_development_dependency "rubocop-minitest", "~> 0.34"
+  spec.add_development_dependency "rubocop-rake",     "~> 0.6"
+  spec.add_development_dependency "rubocop-sorbet",   "~> 0.7"
+  spec.add_development_dependency "sorbet",           "~> 0.5"
+  spec.add_development_dependency "spoom",            "~> 1.2"
+  spec.add_development_dependency "tapioca",          "~> 0.12"
+
+  spec.add_dependency "rails",                        "~> 7.0"
+  spec.add_dependency "zeitwerk",                     "~> 2.6"
+end

data/lib/categoria/version.rb

@@ -0,0 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
+module Categoria
+  VERSION = "0.1.0-beta0"
+end

data/lib/categoria.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require_relative "categoria/version"
+
+module Categoria
+end

data/lib/generators/categoria/command_generator.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Categoria
+  module Generators
+    class CommandGenerator < ::Rails::Generators::NamedBase; end
+  end
+end

data/lib/generators/categoria/domain_generator.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Categoria
+  module Generators
+    class DomainGenerator < ::Rails::Generators::NamedBase
+      extend T::Sig
+
+      source_root File.expand_path("templates", __dir__)
+
+      def module_name = file_name.capitalize
+
+      sig { void }
+      def setup_new_domain
+        domain_directory_path = "#{Rails.root}/app/lib/#{file_name}"
+        %w[
+          internal/commands
+          internal/models
+          command
+          data
+        ].each do |component_path|
+          full_component_path = "#{domain_directory_path}/#{component_path}"
+
+          empty_directory full_component_path
+          create_file "#{full_component_path}/.keep"
+        end
+
+        create_file "#{domain_directory_path}/description.yml"
+        template \
+          "domain_module.rb.erb",
+          "#{domain_directory_path}.rb"
+      end
+    end
+  end
+end

data/lib/generators/categoria/model_generator.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Categoria
+  module Generators
+    class ModelGenerator < ::Rails::Generators::NamedBase; end
+  end
+end

data/lib/generators/categoria/templates/domain_module.rb.erb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module <%= Rails.application.class.module_parent %>
+  module <%= module_name %>
+  end
+end

data/sig/categoria.rbs

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

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/

data/sorbet/rbi/annotations/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-vendored=true

data/sorbet/rbi/annotations/actionmailer.rbi

@@ -0,0 +1,10 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
+
+class ActionMailer::Base
+  sig { params(headers: T.untyped, block: T.nilable(T.proc.params(arg0: ActionMailer::Collector).void)).returns(Mail::Message) }
+  def mail(headers = nil, &block); end
+end