rails-domino 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6dba679e8094d127d345f3e8cd68115192cdf5f701b447bbe9464d0e07d0dc4
+  data.tar.gz: 5041c268a9e5b2e7e45711bc12482802986b0dc20f02b4b55659dd0b95ce1156
+SHA512:
+  metadata.gz: 8472903ef80712086e13011d7e8df94a1117264bc383d672bc9365ef5e96a16869cc82319276c6b75ba970958a52d0414a728e275912d55f44f82a362333a613
+  data.tar.gz: 2b2565ace0fdff4e6ad1bc45c9a4bae69958c11c3928980b9e6dde655467e5ad4e4a45c722882785bc6a6bec79b63e9f3d7ba6ec6b4d194982b63fb6b3d5b5ee

data/lib/domino/base_repository.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Abstract base repository for all models.
+#
+# Subclasses must implement standard CRUD methods.
+class BaseRepository
+  def find_by_id(_id)
+    raise NotImplementedError, "Subclasses must implement find_by_id"
+  end
+
+  def all
+    raise NotImplementedError, "Subclasses must implement all"
+  end
+
+  def create(_attrs)
+    raise NotImplementedError, "Subclasses must implement create"
+  end
+
+  def update(_id, _attrs)
+    raise NotImplementedError, "Subclasses must implement update"
+  end
+
+  def delete(_id)
+    raise NotImplementedError, "Subclasses must implement delete"
+  end
+end

data/lib/domino/base_service.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Abstract base service for all domain logic.
+#
+# Subclasses must implement business operations.
+class BaseService
+  def get(_id)
+    raise NotImplementedError, "Subclasses must implement get"
+  end
+end

data/lib/domino/generators/domino/domino_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+class DominoGenerator < Rails::Generators::NamedBase # rubocop:disable Style/Documentation
+  source_root File.expand_path("templates", __dir__)
+
+  # Accept attributes for model
+  argument :attributes, type: :array, default: [], banner: "field[:type] field[:type]"
+
+  class_option :with_model, type: :boolean, default: false, desc: "Generate ActiveRecord model"
+
+  def create_model
+    return unless options[:with_model]
+
+    generate "model", "#{class_name} #{attributes.join(" ")}"
+  end
+
+  def create_service
+    template "service.rb.tt", File.join("app/services", "#{file_name}_service.rb")
+  end
+
+  def create_repository
+    template "repository.rb.tt", File.join("app/repositories", "#{file_name}_repository.rb")
+  end
+
+  def create_blueprint
+    template "blueprint.rb.tt", File.join("app/mappers", "#{file_name}_blueprint.rb")
+  end
+
+  def create_controller
+    template "controller.rb.tt", File.join("app/controllers", "#{file_name.pluralize}_controller.rb")
+  end
+end

data/lib/domino/generators/domino/templates/blueprint.rb.tt

@@ -0,0 +1,10 @@
+# Blueprint for serializing <%= class_name %> model.
+#
+# @see https://github.com/procore/blueprinter
+#
+class <%= class_name %>Blueprint < Blueprinter::Base
+  identifier :id
+
+  # Fields to expose
+  fields <%= attributes.map { |attr| ":#{attr.split(':').first}" }.join(', ') %>
+end

data/lib/domino/generators/domino/templates/controller.rb.tt

@@ -0,0 +1,50 @@
+# Controller for <%= class_name.pluralize %> API endpoints.
+#
+# Provides RESTful actions for <%= class_name %> resources.
+#
+class <%= class_name.pluralize %>Controller < ApplicationController
+  include Import['<%= file_name %>_service']
+
+  # GET /<%= file_name.pluralize %>
+  # @return [JSON]
+  def index
+    render json: <%= class_name %>Blueprint.render(@<%= file_name %>_service.all)
+  end
+
+  # GET /<%= file_name.pluralize %>/:id
+  # @param id [Integer]
+  # @return [JSON]
+  def show
+    render json: <%= class_name %>Blueprint.render(@<%= file_name %>_service.get(params[:id]))
+  end
+
+  # POST /<%= file_name.pluralize %>
+  # @return [JSON]
+  def create
+    obj = @<%= file_name %>_service.create(user_params)
+    render json: <%= class_name %>Blueprint.render(obj), status: :created
+  end
+
+  # PUT/PATCH /<%= file_name.pluralize %>/:id
+  # @param id [Integer]
+  # @return [JSON]
+  def update
+    obj = @<%= file_name %>_service.update(params[:id], user_params)
+    render json: <%= class_name %>Blueprint.render(obj)
+  end
+
+  # DELETE /<%= file_name %>/:id
+  # @param id [Integer]
+  # @return [JSON]
+  def destroy
+    success = @<%= file_name %>_service.delete(params[:id])
+    head(success ? :no_content : :not_found)
+  end
+
+  private
+
+  # @return [ActionController::Parameters]
+  def user_params
+    params.require(:<%= file_name %>).permit(<%= attributes.map { |a| ":#{a.split(':').first}" }.join(', ') %>)
+  end
+end

data/lib/domino/generators/domino/templates/repository.rb.tt

@@ -0,0 +1,42 @@
+# Repository for <%= class_name %> model.
+#
+# Provides abstracted access to ActiveRecord persistence.
+#
+# @example
+#   repo = <%= class_name %>Repository.new
+#   repo.find_by_id(1)
+#
+class <%= class_name %>Repository < BaseRepository
+  # @param id [Integer]
+  # @return [<%= class_name %>, nil]
+  def find_by_id(id)
+    <%= class_name %>.find_by(id: id)
+  end
+
+  # @return [Array<<%= class_name %>>]
+  def all
+    <%= class_name %>.all
+  end
+
+  # @param attrs [Hash]
+  # @return [<%= class_name %>]
+  def create(attrs)
+    <%= class_name %>.create(attrs)
+  end
+
+  # @param id [Integer]
+  # @param attrs [Hash]
+  # @return [<%= class_name %>, nil]
+  def update(id, attrs)
+    record = <%= class_name %>.find_by(id: id)
+    record.update(attrs) if record
+    record
+  end
+
+  # @param id [Integer]
+  # @return [<%= class_name %>, nil]
+  def delete(id)
+    record = <%= class_name %>.find_by(id: id)
+    record&.destroy
+  end
+end

data/lib/domino/generators/domino/templates/service.rb.tt

@@ -0,0 +1,46 @@
+# Service for business logic around <%= class_name %>.
+#
+# Handles use-case orchestration and business operations.
+#
+# @example
+#   service = <%= class_name %>Service.new(...)
+#   service.get(1)
+#
+class <%= class_name %>Service < BaseService
+  include Import['<%= file_name %>_repository']
+
+  # @param <%= file_name %>_repository [<%= class_name %>Repository]
+  def initialize(<%= file_name %>_repository:)
+    @<%= file_name %>_repository = <%= file_name %>_repository
+  end
+
+  # @param id [Integer]
+  # @return [<%= class_name %>, nil]
+  def get(id)
+    @<%= file_name %>_repository.find_by_id(id)
+  end
+
+  # @param attrs [Hash]
+  # @return [<%= class_name %>]
+  def create(attrs)
+    @<%= file_name %>_repository.create(attrs)
+  end
+
+  # @param id [Integer]
+  # @param attrs [Hash]
+  # @return [<%= class_name %>, nil]
+  def update(id, attrs)
+    @<%= file_name %>_repository.update(id, attrs)
+  end
+
+  # @param id [Integer]
+  # @return [Boolean]
+  def delete(id)
+    !!@<%= file_name %>_repository.delete(id)
+  end
+
+  # @return [Array<<%= class_name %>>]
+  def all
+    @<%= file_name %>_repository.all
+  end
+end

data/lib/domino/scaffolder.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Domino
+  # Scaffolder: handles the generation of model, repository, service, blueprint, and controller files
+  class Scaffolder
+    # Entrypoint: called from Domino.scaffold
+    #
+    # @param tables [Array<String>] optional list of tables to scaffold
+    # @param namespace [String, nil] reserved for future support
+    # @param generate_model [Boolean] whether to run model generation
+    def self.scaffold(tables: nil, namespace: nil, generate_model: true)
+      connection = ActiveRecord::Base.connection
+      tables ||= connection.tables.reject { |t| t == "schema_migrations" }
+
+      tables.each do |table|
+        klass = table.singularize.camelize
+        columns = connection.columns(table)
+        ScaffoldRunner.new(klass, columns, namespace, generate_model).run
+      end
+    end
+  end
+
+  # ScaffoldRunner: handles the actual file generation
+  class ScaffoldRunner
+    def initialize(model_name, columns, namespace, generate_model)
+      @model_name = model_name
+      @columns = columns
+      @namespace = namespace
+      @generate_model = generate_model
+    end
+
+    def run
+      generate_model_file if @generate_model
+      generate_file("repository")
+      generate_file("service")
+      generate_file("blueprint")
+      generate_file("controller")
+    end
+
+    def generate_model_file
+      system("rails generate model #{@model_name} #{column_args.join(" ")}")
+    end
+
+    def column_args
+      @columns.map { |col| "#{col.name}:#{col.sql_type}" unless col.name == "id" }.compact
+    end
+
+    def generate_file(type) # rubocop:disable Metrics/MethodLength
+      require "erb"
+
+      template_path = File.expand_path("../generators/domino/templates/#{type}.rb.tt", __FILE__)
+      raise "Missing template: #{template_path}" unless File.exist?(template_path)
+
+      content = ERB.new(File.read(template_path)).result(binding)
+
+      puts "Generating #{type} for #{@model_name}"
+
+      folder = case type
+               when "blueprint" then "app/mappers"
+               when "controller" then "app/controllers"
+               when "repository" then "app/repositories"
+               when "service" then "app/services"
+               else "app/#{type}s"
+               end
+
+      filename = case type
+                 when "controller"
+                   "#{@model_name.underscore.pluralize}_controller.rb"
+                 else
+                   "#{@model_name.underscore}_#{type}.rb"
+                 end
+
+      FileUtils.mkdir_p(folder)
+      File.write(File.join(folder, filename), content)
+    end
+  end
+end

data/lib/domino/version.rb

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

data/lib/domino.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "domino/version"
+require "domino/scaffolder"
+
+module Domino # rubocop:disable Style/Documentation
+  def self.scaffold(**kwargs)
+    Scaffolder.scaffold(**kwargs)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rails-domino
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kiebor81
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blueprinter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/domino.rb
+- lib/domino/base_repository.rb
+- lib/domino/base_service.rb
+- lib/domino/generators/domino/domino_generator.rb
+- lib/domino/generators/domino/templates/blueprint.rb.tt
+- lib/domino/generators/domino/templates/controller.rb.tt
+- lib/domino/generators/domino/templates/repository.rb.tt
+- lib/domino/generators/domino/templates/service.rb.tt
+- lib/domino/scaffolder.rb
+- lib/domino/version.rb
+homepage: https://github.com/kiebor81/rails-domino
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key: 
+specification_version: 4
+summary: Domain-first service and repository scaffold for Rails. Enforces DDD architecture
+  with Blueprinter and Dry-rb libraries
+test_files: []