domakase 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cd8b8459568576f370b30611411ed1c9acd6ed8db5882717ff10401c902ad9a
+  data.tar.gz: 3b6cc8e1e4bbe9d47101aa766c37970c0219e3d373b812331b4e9856f0082fc3
+SHA512:
+  metadata.gz: 7bc2ee7db4e791a4b61b20247e659480c33fd75971aa3feb31d9cceb5e20a870980b6e6a986a4940a4625015bc5f6c70cdc22cd8a3393ebeb9a3824c297f2d23
+  data.tar.gz: a16be9829edbabcc985a6ec40b3447ac1e39b8be2c02480fa882fba51285a91a1d5969169fac2dd0086caeff1e1381cb86e12384ed835280094840d5ff17347d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Patrick McDonald
+
+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,3 @@
+# Domakase
+
+Domain-driven design for Ruby on Rails

data/domakase.gemspec

@@ -0,0 +1,24 @@
+require_relative "lib/domakase/version"
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Patrick McDonald"]
+  gem.email = ["patrick@mcdonald.fyi"]
+  gem.summary = "Domain-driven design for Ruby on Rails"
+  gem.description = "Domain-driven design for Ruby on Rails"
+  gem.homepage = "https://github.com/grapadacious/domakase"
+  gem.license = "MIT"
+
+  gem.files = %w[domakase.gemspec README.md CHANGELOG.md LICENSE] + `git ls-files | grep -E '^lib'`.split("\n")
+  gem.name = "domakase"
+  gem.version = Domakase::VERSION
+  gem.required_ruby_version = ">= 3.3.0"
+
+  gem.metadata = {
+    "homepage_uri" => "https://github.com/grapadacious/domakase",
+    "bug_tracker_uri" => "https://github.com/grapadacious/domakase/issues",
+    "documentation_uri" => "https://github.com/grapadacious/domakase/wiki",
+    "changelog_uri" => "https://github.com/grapadacious/domakase/blob/main/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/grapadacious/domakase",
+    "rubygems_mfa_required" => "true"
+  }
+end

data/lib/domakase/controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Domakase
+  class Controller < ActionController::Base
+    prepend_before_action do
+      lookup_context.prefixes.prepend(controller_name.underscore)
+    end
+
+    prepend_before_action do
+      domain, *module_path, _ = controller_path.split("/")
+      prepend_view_path ::Rails.root.join("app", "domains", domain, "views")
+      prepend_view_path ::Rails.root.join("app", "domains", domain, "views", module_path.join("/"))
+    end
+  end
+end

data/lib/domakase/record.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Domakase
+  # Configure domain models to follow domain-namespaced table naming conventions.
+  #
+  # Given a domain model with the path <tt>app/domains/staff/models/user.rb</tt>, the table name will be <tt>staff_users</tt>.
+  #
+  # This also extends to nested models. So if you have a domain model with the path <tt>app/domains/staff/models/user/session.rb</tt>,
+  # the table name will be <tt>staff_user_sessions</tt>.
+  #
+  # If you would like to provide a custom name for your table instead, you can set your own table name
+  # in the domain definition like you normally would.
+  class Record < ActiveRecord::Base
+    def self.table_name
+      @table_name || model_name.plural
+    end
+
+    def self.table_name=(table_name)
+      @table_name = table_name
+    end
+  end
+end

data/lib/domakase/version.rb

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

data/lib/domakase.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Domakase
+  class InvalidDomainPath < StandardError; end
+
+  class << self
+    def register_all!
+      ::Rails.root.join("app/domains").children.each do |entry|
+        next unless entry.directory?
+
+        register!(entry.split.last)
+      end
+    end
+
+    def register!(name)
+      path = ::Rails.root.join("app/domains/#{name}")
+
+      raise InvalidDomainPath, path unless Dir.exist?(path)
+
+      domain_module = initialize_module(name)
+
+      register("#{path}/controllers", domain_module)
+      register("#{path}/controllers/concerns", domain_module)
+      register("#{path}/jobs", domain_module)
+      register("#{path}/models", domain_module)
+      register("#{path}/models/concerns", domain_module)
+    end
+
+    private
+
+    def initialize_module(name)
+      name = name.to_s.camelize
+
+      Object.const_set(name, Module.new) unless Object.const_defined?(name)
+
+      name.constantize
+    end
+
+    def register(path, namespace)
+      ::Rails.autoloaders.main.push_dir(path, namespace:) if Dir.exist?(path)
+    end
+  end
+end
+

data/lib/generators/domakase/domain/actions.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Domakase
+  module Generators
+    module Domain
+      module Actions
+        private
+
+        def module_namespacing(&block)
+          *modules, _ = @name.split(":").map(&:camelize)
+
+          content = modules.reverse.reduce(capture(&block)) do |content, m|
+            "module #{m}\n#{indent(content).chomp}\nend"
+          end
+
+          concat(content)
+        end
+
+        def class_name
+          "#{file_name.camelize}"
+        end
+
+        def directory_name
+          ""
+        end
+
+        def file_name
+          @name.split(":").last
+        end
+
+        def file_path
+          domain_name, *submodules, _ = @name.split(":")
+
+          subpath = [directory_name, *submodules, "#{file_name}.rb"].compact_blank.join("/")
+
+          ::Rails.root.join("app/domains/#{domain_name}/#{subpath}")
+        end
+      end
+    end
+  end
+end

data/lib/generators/domakase/domain/controller_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "actions"
+
+module Domakase
+  module Generators
+    module Domain
+      class ControllerGenerator < ::Rails::Generators::NamedBase
+        include Actions
+
+        source_root File.expand_path("templates", __dir__)
+
+        def create_controller_file
+          template("controller.rb.erb", file_path)
+        end
+
+        private
+
+        def file_name
+          "#{super}_controller"
+        end
+
+        def directory_name
+          "controllers"
+        end
+      end
+    end
+  end
+end

data/lib/generators/domakase/domain/model_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# frozen_string_literal: true
+
+require_relative "actions"
+
+module Domakase
+  module Generators
+    module Domain
+      class ModelGenerator < ::Rails::Generators::NamedBase
+        include Actions
+
+        source_root File.expand_path("templates", __dir__)
+
+        def create_model_file
+          template("model.rb.erb", file_path)
+        end
+
+        def create_migration_file
+          *prefixes, model_name = name.split(":")
+
+          generate(:migration, "create_#{[*prefixes, model_name.pluralize].join("_")}", inline: true)
+        end
+
+        private
+
+        def directory_name
+          "models"
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/domakase/domain/templates/controller.rb.erb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %> < ::Domakase::Controller
+end
+<% end %>

data/lib/generators/domakase/domain/templates/model.rb.erb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %> < ::Domakase::Record
+end
+<% end %>

data/lib/generators/domakase/domain_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Domakase
+  module Generators
+    class DomainGenerator < ::Rails::Generators::NamedBase
+      def create_domain_files
+        create_file ::Rails.root.join("app/domains/#{file_name}/controllers/concerns/.keep"), ""
+        create_file ::Rails.root.join("app/domains/#{file_name}/models/concerns/.keep"), ""
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: domakase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrick McDonald
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Domain-driven design for Ruby on Rails
+email:
+- patrick@mcdonald.fyi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- domakase.gemspec
+- lib/domakase.rb
+- lib/domakase/controller.rb
+- lib/domakase/record.rb
+- lib/domakase/version.rb
+- lib/generators/domakase/domain/actions.rb
+- lib/generators/domakase/domain/controller_generator.rb
+- lib/generators/domakase/domain/model_generator.rb
+- lib/generators/domakase/domain/templates/controller.rb.erb
+- lib/generators/domakase/domain/templates/model.rb.erb
+- lib/generators/domakase/domain_generator.rb
+homepage: https://github.com/grapadacious/domakase
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/grapadacious/domakase
+  bug_tracker_uri: https://github.com/grapadacious/domakase/issues
+  documentation_uri: https://github.com/grapadacious/domakase/wiki
+  changelog_uri: https://github.com/grapadacious/domakase/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/grapadacious/domakase
+  rubygems_mfa_required: 'true'
+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: 4.0.10
+specification_version: 4
+summary: Domain-driven design for Ruby on Rails
+test_files: []