operation_model_scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a64c450413451bdc2fcbc86bf0ca7c40fe7c2814356936aca49b3820f8ed3a7f
+  data.tar.gz: ef0dafa9c83887c8658320d9e29fe4ff78d17929434614dd9a98cccac04a5b75
+SHA512:
+  metadata.gz: 9b04a2ae19780ec3525b0e65433516817614eece07112677b0ce7398508dac099884a09757cadd7ed6b3c07af88333a9944d2ec90b760cdeb854b88dce4539a6
+  data.tar.gz: 03fb04f46e91cc3ff4aff0cfb4590275ad7aaee909344b084563b6500ed5ab6f9b876e23b391a9fef6328ce2b37103630ddcda4c7d2cac76fb636e8d2fae0290

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, caste, color, religion, or sexual
+identity and orientation.
+
+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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 shu0115
+
+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,79 @@
+# Operation Model Scaffold
+
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+**Operation Model Scaffold** は、Rails アプリケーションにおける **Operations レイヤー** の Scaffold を生成するジェネレータ Gem です。
+
+このツールを使用することで、ビジネスロジックの責務を明確に分離し、保守性と再利用性を高めるためのアーキテクチャ構築をサポートします。
+
+---
+
+## 📌 背景
+
+Rails では、サービスクラスやモデルが肥大化しやすく、ビジネスロジックの所在が曖昧になることがあります。
+
+**Operation Model Scaffold** は、`Operations` レイヤーを導入することで「操作（Operation）」をアプリケーションの構造として明示的に表現できるようにし、以下のような効果をもたらします：
+
+- ドメインロジックの見通しが良くなる
+- 関心の分離（Separation of Concerns）が明確になる
+- テストしやすくなる
+
+---
+
+## ✨ 特徴
+
+- `bin/rails generate operation_model:scaffold` コマンドで `app/models/operations/` を自動生成
+- `README.md` や `utility.rb` などのベースファイルを生成
+- `app/models/` 配下にある全モデルに対応する Operations モジュールを自動生成
+- `application_record.rb` や `utility.rb` など、特定ファイルは自動生成対象から除外
+
+---
+
+## 📦 インストール
+
+Gemfile に以下を追加：
+
+```ruby
+gem 'operation_model_scaffold'
+```
+
+インストール：
+
+```bash
+bundle install
+```
+
+---
+
+## 🚀 使用方法
+
+以下のジェネレータを実行：
+
+```bash
+bin/rails generate operation_model:scaffold
+```
+
+このコマンドにより、以下のような構造が作成されます：
+
+```
+app/models/operations/
+├── README.md                   # Operations レイヤーのガイドライン
+├── user.rb                     # Operations::User モジュール（app/models/user.rb に対応）
+├── post.rb                     # Operations::Post モジュール（app/models/post.rb に対応）
+└── use_cases/
+    └── utility.rb              # 共通ユースケース向けユーティリティ
+```
+
+※ `application_record.rb` や `utility.rb` といった特殊用途のモデルは自動生成の対象外です。
+
+---
+
+## 📄 ライセンス
+
+このプロジェクトは [MIT License](LICENSE.txt) のもとで公開されています。
+
+---
+
+## 👤 作者
+
+- [@shu0115](https://github.com/shu0115)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/operation_model/scaffold_generator.rb

@@ -0,0 +1,35 @@
+require "rails/generators"
+
+module OperationModel
+  class ScaffoldGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def create_operations_readme
+      empty_directory "app/models/operations"
+      empty_directory "app/models/operations/use_cases"
+
+      operation_paths = [
+        { template_name: "README.md",  file_path: "app/models/operations/README.md" },
+        { template_name: "utility.rb", file_path: "app/models/operations/use_cases/utility.rb" },
+      ]
+
+      operation_paths.each do |operation_path|
+        File.exist?(operation_path[:file_path]) ? say_status("skip", operation_path[:file_path], :yellow) : template(operation_path[:template_name], operation_path[:file_path])
+      end
+    end
+
+    def create_model_operations
+      skip_model_names = ['application_record', 'utility']
+      model_files      = Dir.glob("app/models/*.rb")
+
+      model_files.each do |model_file|
+        @model_name   = File.basename(model_file, ".rb")
+
+        template_name = "operation_model.rb.tt"
+        file_path     = "app/models/operations/#{@model_name}.rb"
+
+        (File.exist?(file_path) || skip_model_names.include?(@model_name)) ? say_status("skip", file_path, :yellow) : template(template_name, file_path)
+      end
+    end
+  end
+end

data/lib/generators/operation_model/templates/README.md.tt

@@ -0,0 +1,131 @@
+
+## Operations: アプリケーションの操作を明示的に記述するレイヤー
+
+- このディレクトリには、ビジネスロジックや複数モデルにまたがる処理など、アプリケーション固有の「操作（Operation）」を記述したモジュールを配置します。
+- サービスクラスの乱用を避け、責務と構造を明確に分離するための手法として設計されたのが、この "オペレーションモデル" です。
+
+---
+
+## 📌 基本ルール
+
+- `Operations` は **必ずモジュールとして定義**します（クラスは禁止）。
+
+```ruby
+module Operations::User
+  def self.promote_to_admin(user)
+    # ...
+  end
+end
+```
+
+- **インスタンス化は禁止**：状態を持たない明示的な関数型スタイルを採用します。
+- **Mix-in（include/extend）は禁止**：依存関係を避け、モジュールの独立性を保ちます。
+- **モデルのクラスメソッドの代替として使用**します。
+  - モデルには状態操作や単純な問い合わせだけを残します。
+- **複数のモデルにまたがる処理**は必ず `Operations` に切り出してください。
+
+---
+
+## 📁 ディレクトリ構成例
+
+```
+app/models/operations/
+├── user.rb                      # Operations::User モジュール
+├── use_cases/
+     └── registration.rb        # Operations::UseCases::Registration モジュール
+```
+
+---
+
+## 💡 どういうときに Operations に切り出すか？
+
+### ✅ Operations に書くもの
+
+- 複数のモデルや外部APIにまたがる処理
+- ビジネスルール・状態遷移を伴う手続き的な処理
+- モデルやコントローラに書くと肥大化しやすい操作的ロジック
+- 明確に「〜をする」と言えるユースケース（例：会員登録、退会処理、ポイント付与 など）
+- モデルのクラスメソッドや複雑なインスタンスメソッドの処理は基本的に Operations に切り出す
+
+### ✅ モデルに書くもの
+
+- 定数
+- `belongs_to`、`has_one`、`has_many`などのアソシエーション
+- enumの定義
+- バリデーション
+- `before_save`、`after_destroy`などのコールバック
+  - 複雑な処理になる場合は、コールバックの中でOperationsのメソッドを呼ぶ形にすることも検討する
+- スコープ
+  - 複雑な処理になる場合は、Operationsのメソッドにすることも検討する
+- インスタンスメソッド
+  - 複雑な処理になる場合は、インスタンスメソッドの中でOperationsのメソッドを呼ぶ、もしくはインスタンスメソッドではなくOperationsのメソッドにすることも検討する
+
+---
+
+## 🧭 命名規則と分類
+
+- **操作の対象ごとに名前空間を分ける**
+  -  `Operations::User`：ユーザー関連の操作
+  - `Operations::UseCases::Registration`：会員登録に関する一連の操作
+  - `Operations::UseCases::Purchase`：購入処理関連の操作
+- **メソッド名は「何をするか」が明確に伝わるよう、動詞ベースで命名する（例: `promote_to_admin`, `reset_password`）**
+
+```ruby
+Operations::User.promote_to_admin(user)
+Operations::User.reset_password(user, token)
+Operations::UseCases::Registration.create_user(user_params)
+```
+
+-  **複雑な処理はネストされたモジュールに分割しても良い**
+  - モジュール名とファイルパスを一致させることで、発見性を保ちます。
+
+---
+
+## 📘 使用例
+
+```ruby
+# 管理者権限の付与
+Operations::User.promote_to_admin(user)
+
+# パスワード再設定処理
+Operations::User.reset_password(user, new_password)
+
+# 会員登録処理
+Operations::UseCases::Registration.create_user(user_params)
+```
+
+---
+
+## 🎯 目的と利点
+
+- コードの責務を明確に分離（モデル肥大化・サービスクラス混乱を防止）
+- 「何をするか」がファイルパスとメソッド名から直感的にわかる
+- テストしやすく、再利用しやすい
+- 関数型スタイルで副作用を明示・限定できる
+
+---
+
+## 🧪 テストについて
+
+Operations モジュールは状態を持たないため、RSpec 等のユニットテストで直接メソッドを呼び出すだけで簡単にテストできます。
+
+```ruby
+describe Operations::User do
+  describe ".promote_to_admin" do
+    it "grants admin role to the user" do
+      user = create(:user)
+      expect {
+        Operations::User.promote_to_admin(user)
+      }.to change { user.reload.role }.to("admin")
+    end
+  end
+end
+```
+
+---
+
+## 📝 補足
+
+このディレクトリは、Railsの公式なレイヤー構造（MVC）には存在しませんが、アプリケーション規模の成長に伴って必要になる「ユースケース層」として位置づけられます。
+
+この `Operations` 層により、ビジネスロジックとデータモデルの責務をきれいに分離し、長期的な保守性とテスト性を向上させることが目的です。

data/lib/generators/operation_model/templates/operation_model.rb.tt

@@ -0,0 +1,4 @@
+module Operations::<%= @model_name.camelize %>
+  class << self
+  end
+end

data/lib/generators/operation_model/templates/utility.rb.tt

@@ -0,0 +1,4 @@
+module Operations::Utility
+  class << self
+  end
+end

data/lib/operation_model_scaffold/version.rb

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

data/lib/operation_model_scaffold.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "operation_model_scaffold/version"
+
+module OperationModelScaffold
+  class Error < StandardError; end
+end
+
+require_relative "generators/operation_model/scaffold_generator"

data/operation_model_scaffold.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/operation_model_scaffold/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "operation_model_scaffold"
+  spec.version       = OperationModelScaffold::VERSION
+  spec.authors       = ["shu0115"]
+  spec.email         = ["s.matsumoto0115@gmail.com"]
+
+  spec.summary       = "Rails generator for creating an Operations layer scaffold."
+  spec.description   = "This gem provides a generator to scaffold an Operations layer in your Rails app, helping structure application logic in a modular and maintainable way."
+
+  spec.homepage      = "https://github.com/shu0115/operation_model_scaffold"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shu0115/operation_model_scaffold"
+  spec.metadata["changelog_uri"]   = "https://github.com/shu0115/operation_model_scaffold/releases"
+
+  # allowed_push_host is only needed if you push to a private gem server
+  # It is not required for public RubyGems.org
+  # spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Add runtime dependencies here, if any.
+  spec.add_dependency "rails"
+end

data/sig/operation_model_scaffold.rbs

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: operation_model_scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shu0115
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+description: This gem provides a generator to scaffold an Operations layer in your
+  Rails app, helping structure application logic in a modular and maintainable way.
+email:
+- s.matsumoto0115@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/operation_model/scaffold_generator.rb
+- lib/generators/operation_model/templates/README.md.tt
+- lib/generators/operation_model/templates/operation_model.rb.tt
+- lib/generators/operation_model/templates/utility.rb.tt
+- lib/operation_model_scaffold.rb
+- lib/operation_model_scaffold/version.rb
+- operation_model_scaffold.gemspec
+- sig/operation_model_scaffold.rbs
+homepage: https://github.com/shu0115/operation_model_scaffold
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shu0115/operation_model_scaffold
+  source_code_uri: https://github.com/shu0115/operation_model_scaffold
+  changelog_uri: https://github.com/shu0115/operation_model_scaffold/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rails generator for creating an Operations layer scaffold.
+test_files: []