auto_decorator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 711dd9d73ec942f2a199ab3151470494e23dc08a3b2116b615c748ea4dafe91b
+  data.tar.gz: fa65f54f123227f42f820748df620371dfee653e67b7fca04daeacb28111cfb1
+SHA512:
+  metadata.gz: df20999fee449028a65f637e6fa6c2fa0952327bf10ed08d1b2b71fee8870c636b7f030d6f93af0b0af2ebee789bdbd892ba10710ffe0de5ce4062b14f6cb7b4
+  data.tar.gz: 3b0b18150ebb2abbd65952e7060335eaa2258e8f88d177ea405a7888ee2cf303818d911f879345f640425b75ca7d24eba21cb72a1910ec578821d9474da2b2e4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-02-23
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Alexey Poimtsev
+
+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,131 @@
+# auto_decorator
+
+Convention-based decorator autoloading for Rails models.
+
+Decorators are plain Ruby modules that get automatically included into your model classes based on file naming convention — no configuration required.
+
+> **Why not Draper?** Draper wraps objects in presenter classes. `auto_decorator` adds methods directly to the model. Less indirection, less boilerplate, same result for most use cases.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "auto_decorator"
+```
+
+## Usage
+
+### Convention
+
+Place decorator files in `app/decorators/`. The gem discovers them automatically and includes each module into the matching model class:
+
+| File                                                 | Module                             | Included into             |
+| ---------------------------------------------------- | ---------------------------------- | ------------------------- |
+| `app/decorators/user_decorator.rb`                   | `UserDecorator`                    | `User`                    |
+| `app/decorators/organization_decorator.rb`           | `OrganizationDecorator`            | `Organization`            |
+| `app/decorators/organizations/employee_decorator.rb` | `Organizations::EmployeeDecorator` | `Organizations::Employee` |
+
+### Example
+
+```ruby
+# app/decorators/user_decorator.rb
+module UserDecorator
+  def full_name
+    [first_name, last_name].compact.join(" ")
+  end
+
+  def to_s
+    full_name.presence || email
+  end
+end
+```
+
+```ruby
+# app/decorators/organizations/employee_decorator.rb
+module Organizations
+  module EmployeeDecorator
+    def active?
+      status == "active"
+    end
+  end
+end
+```
+
+Since the modules are included directly into the model, decorated methods are available anywhere the model is used:
+
+```ruby
+user = User.find(1)
+user.full_name  # => "Alice Smith"
+user.to_s       # => "Alice Smith"
+```
+
+### Generator
+
+Scaffold a new decorator with:
+
+```bash
+rails g decorator User
+# → creates app/decorators/user_decorator.rb
+
+rails g decorator Organizations::Employee
+# → creates app/decorators/organizations/employee_decorator.rb
+```
+
+Generated file for `User`:
+
+```ruby
+# frozen_string_literal: true
+
+module UserDecorator
+end
+```
+
+Generated file for `Organizations::Employee`:
+
+```ruby
+# frozen_string_literal: true
+
+module Organizations
+  module EmployeeDecorator
+  end
+end
+```
+
+### Configuration
+
+The gem works with zero configuration. To override defaults:
+
+```ruby
+# config/initializers/auto_decorator.rb
+AutoDecorator.configure do |config|
+  config.decorators_path = "app/decorators"  # relative to Rails.root
+  config.decorator_suffix = "Decorator"
+end
+```
+
+## How it works
+
+On every `config.to_prepare` (triggered on boot and in development on each request):
+
+1. Glob all `*_decorator.rb` files under `decorators_path`
+2. Derive the module name from the file path: `organizations/employee_decorator.rb` → `Organizations::EmployeeDecorator`
+3. Derive the model name by stripping the suffix: `Organizations::EmployeeDecorator` → `Organizations::Employee`
+4. Call `ModelClass.include(DecoratorModule)` — skips if already included
+
+If the model class doesn't exist (e.g. a decorator for a non-existent model), it is silently skipped.
+
+## Compatibility
+
+|       |           |
+| ----- | --------- |
+| Ruby  | ≥ 3.2     |
+| Rails | 7.0 – 8.1 |
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/alec-c4/auto_decorator).
+
+## License
+
+[MIT](LICENSE.txt)

data/lib/auto_decorator/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module AutoDecorator
+  class Configuration
+    attr_accessor :decorators_path, :decorator_suffix
+
+    def initialize
+      @decorators_path = "app/decorators"
+      @decorator_suffix = "Decorator"
+    end
+  end
+end

data/lib/auto_decorator/loader.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module AutoDecorator
+  class Loader
+    def self.call(base_path:, suffix: "Decorator")
+      base = Pathname.new(base_path)
+      Dir.glob(base.join("**/*_#{suffix.downcase}.rb")).each do |file|
+        load_file(file, base, suffix)
+      end
+    end
+
+    def self.load_file(file, base_path, suffix)
+      relative = Pathname.new(file).relative_path_from(base_path).to_s.delete_suffix(".rb")
+      decorator_name = relative.split("/").map { |part| camelize(part) }.join("::")
+      model_name = decorator_name.delete_suffix(suffix)
+
+      load file
+      decorator_module = Object.const_get(decorator_name)
+      model_class = Object.const_get(model_name)
+      return if model_class.include?(decorator_module)
+
+      model_class.include(decorator_module)
+    rescue NameError
+      # Model or decorator constant not found — skip silently
+    end
+    private_class_method :load_file
+
+    def self.camelize(str)
+      str.split("_").map(&:capitalize).join
+    end
+    private_class_method :camelize
+  end
+end

data/lib/auto_decorator/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module AutoDecorator
+  class Railtie < Rails::Railtie
+    initializer "auto_decorator.load" do
+      config.to_prepare do
+        AutoDecorator::Loader.call(
+          base_path: Rails.root.join(AutoDecorator.configuration.decorators_path).to_s,
+          suffix: AutoDecorator.configuration.decorator_suffix
+        )
+      end
+    end
+  end
+end

data/lib/auto_decorator/version.rb

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

data/lib/auto_decorator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "auto_decorator/version"
+require_relative "auto_decorator/configuration"
+require_relative "auto_decorator/loader"
+require_relative "auto_decorator/railtie"
+
+module AutoDecorator
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/generators/auto_decorator/decorator_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module AutoDecorator
+  module Generators
+    class DecoratorGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_decorator_file
+        template "decorator.rb.tt",
+          File.join("app/decorators", class_path.join("/"), "#{file_name}_decorator.rb")
+      end
+
+      private
+
+      def decorator_name
+        "#{class_name.demodulize}Decorator"
+      end
+
+      def namespaces
+        class_name.deconstantize.split("::").reject(&:empty?)
+      end
+    end
+  end
+end

data/lib/generators/auto_decorator/templates/decorator.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+<% namespaces.each_with_index do |ns, i| -%>
+<%= "  " * i %>module <%= ns %>
+<% end -%>
+<%= "  " * namespaces.size %>module <%= decorator_name %>
+<%= "  " * namespaces.size %>end
+<% namespaces.reverse.each_with_index do |_ns, i| -%>
+<%= "  " * (namespaces.size - 1 - i) %>end
+<% end -%>

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: auto_decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Poimtsev
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically includes decorator modules into Rails model classes based
+  on file naming convention. Zero configuration required.
+email:
+- alexey.poimtsev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/auto_decorator.rb
+- lib/auto_decorator/configuration.rb
+- lib/auto_decorator/loader.rb
+- lib/auto_decorator/railtie.rb
+- lib/auto_decorator/version.rb
+- lib/generators/auto_decorator/decorator_generator.rb
+- lib/generators/auto_decorator/templates/decorator.rb.tt
+homepage: https://github.com/alec-c4/auto_decorator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alec-c4/auto_decorator
+  source_code_uri: https://github.com/alec-c4/auto_decorator
+  changelog_uri: https://github.com/alec-c4/auto_decorator/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Convention-based decorator autoloading for Rails models
+test_files: []