misogi 0.1.0

data/lib/misogi/rule/rspec.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Misogi
+  module Rule
+    # RSpecの規約に従ってspecファイルとテスト対象の対応をチェックするルール
+    # 例:
+    #   spec/models/user_spec.rb -> Userクラスのテストを含むべき
+    #   spec/services/admin/user_creator_spec.rb -> Admin::UserCreatorクラスのテストを含むべき
+    class RSpec < Base
+      def initialize
+        super
+        @active_support_available = check_active_support
+      end
+
+      # RSpecのディレクトリとソースディレクトリのマッピング
+      DIRECTORY_MAPPINGS = {
+        "spec/models" => "app/models",
+        "spec/controllers" => "app/controllers",
+        "spec/helpers" => "app/helpers",
+        "spec/mailers" => "app/mailers",
+        "spec/jobs" => "app/jobs",
+        "spec/services" => "app/services",
+        "spec/decorators" => "app/decorators",
+        "spec/presenters" => "app/presenters",
+        "spec/validators" => "app/validators",
+        "spec/policies" => "app/policies",
+        "spec/channels" => "app/channels",
+        "spec/mailboxes" => "app/mailboxes",
+        "spec/lib" => "lib"
+      }.freeze
+
+      # @param file_path [String] 検証対象のファイルパス
+      # @param parsed_content [ParsedContent] パース結果（RSpecでは使用しない）
+      # @return [Array<Violation>] 検出された違反のリスト
+      def validate(file_path, _parsed_content)
+        return [] unless file_path.start_with?("spec/") && file_path.end_with?("_spec.rb")
+        return [] unless File.exist?(file_path)
+
+        content = File.read(file_path)
+        violations = []
+
+        # ファイル内容からdescribeの対象を抽出
+        described_namespaces = extract_described_namespaces(content)
+
+        if described_namespaces.empty?
+          violations << violation(
+            file_path: file_path,
+            message: "RSpec.describe または describe が見つかりません"
+          )
+          return violations
+        end
+
+        # 各describe対象について期待されるspecファイルパスを計算
+        spec_base_path = find_spec_base_path(file_path)
+        return [] unless spec_base_path
+
+        expected_paths = described_namespaces.map do |namespace|
+          namespace_to_spec_path(namespace, spec_base_path)
+        end
+
+        # 実際のファイルパスが期待されるパスのいずれかと一致するか確認
+        unless expected_paths.include?(file_path)
+          expected_paths_str = expected_paths.map { |p| "`#{p}`" }.join(" または ")
+          described_str = described_namespaces.join(", ")
+          violations << violation(
+            file_path: file_path,
+            message: "テスト対象 '#{described_str}' のspecファイルは #{expected_paths_str} に配置すべきです"
+          )
+        end
+
+        violations
+      end
+
+      private
+
+      # ファイル内容からdescribeの対象（テスト対象のクラス/モジュール）を抽出
+      # @param content [String] ファイルの内容
+      # @return [Array<String>] 抽出された名前空間のリスト
+      def extract_described_namespaces(content)
+        namespaces = []
+
+        # RSpec.describe ClassName または describe ClassName の形式を抽出
+        # 定数名（::で区切られた大文字始まりの識別子）をキャプチャ
+        pattern = /(?:RSpec\.)?describe\s+([A-Z][A-Za-z0-9]*(?:::[A-Z][A-Za-z0-9]*)*)/
+
+        content.scan(pattern) do |match|
+          namespaces << match[0]
+        end
+
+        namespaces.uniq
+      end
+
+      # specファイルのベースパスを見つける
+      # @param file_path [String] specファイルのパス
+      # @return [String, nil] ベースパス
+      def find_spec_base_path(file_path)
+        DIRECTORY_MAPPINGS.each_key do |spec_path|
+          return spec_path if file_path.start_with?(spec_path)
+        end
+        nil
+      end
+
+      # 名前空間から期待されるspecファイルパスを生成する
+      # @param namespace [String] 名前空間（例: "Foo::Bar"）
+      # @param spec_base_path [String] specのベースパス（例: "spec/models"）
+      # @return [String] 期待されるspecファイルパス
+      def namespace_to_spec_path(namespace, spec_base_path)
+        # 名前空間をパーツに分割
+        parts = namespace.split("::")
+
+        # 各パーツをスネークケースに変換
+        snake_parts = parts.map { |part| underscore(part) }
+
+        # spec_base_pathと結合して_spec.rbを追加
+        "#{File.join(spec_base_path, *snake_parts)}_spec.rb"
+      end
+
+      # ActiveSupportが利用可能かチェック
+      # @return [Boolean] ActiveSupportが利用可能かどうか
+      def check_active_support
+        # Rails環境が読み込まれている場合は、ActiveSupportも利用可能
+        return true if defined?(::Rails)
+
+        # Rails環境がない場合は、ActiveSupportを直接読み込んでみる
+        require "active_support/inflector"
+        true
+      rescue LoadError
+        false
+      end
+
+      # キャメルケースをスネークケースに変換
+      # @param str [String] キャメルケースの文字列
+      # @return [String] スネークケースの文字列
+      def underscore(str)
+        if @active_support_available
+          # ActiveSupportが利用可能な場合はそれを使用（inflectionsを考慮）
+          ActiveSupport::Inflector.underscore(str)
+        else
+          # フォールバック: 単純な変換
+          str
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .downcase
+        end
+      end
+    end
+  end
+end

data/lib/misogi/rule/ruby_standard.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Misogi
+  module Rule
+    # Ruby一般の規約に従ってファイルパスとクラス/モジュール名の対応をチェックするルール
+    # 例:
+    #   lib/foo/bar.rb -> Foo::Bar
+    #   lib/foo.rb -> Foo
+    class RubyStandard < Base
+      # @param base_path [String] 基準となるディレクトリパス（デフォルト: "lib"）
+      def initialize(base_path: "lib")
+        super()
+        @base_path = base_path
+      end
+
+      # @param file_path [String] 検証対象のファイルパス
+      # @param parsed_content [ParsedContent] パース結果
+      # @return [Array<Violation>] 検出された違反のリスト
+      def validate(file_path, parsed_content)
+        return [] unless file_path.start_with?(@base_path)
+
+        violations = []
+
+        if parsed_content.empty?
+          violations << violation(
+            file_path: file_path,
+            message: "ファイルにクラスまたはモジュールが定義されていません"
+          )
+          return violations
+        end
+
+        # 定義されている各名前空間について期待されるパスを計算
+        expected_paths = parsed_content.namespaces.map do |namespace|
+          namespace_to_path(namespace)
+        end
+
+        # 実際のファイルパスが期待されるパスのいずれかと一致するか確認
+        unless expected_paths.include?(file_path)
+          expected_paths_str = expected_paths.map { |p| "`#{p}`" }.join(" または ")
+          defined_namespaces = parsed_content.namespaces.join(", ")
+          violations << violation(
+            file_path: file_path,
+            message: "名前空間 '#{defined_namespaces}' は #{expected_paths_str} に配置すべきです"
+          )
+        end
+
+        violations
+      end
+
+      private
+
+      # 名前空間から期待されるファイルパスを生成する
+      # @param namespace [String] 名前空間（例: "Foo::Bar"）
+      # @return [String] 期待されるファイルパス
+      def namespace_to_path(namespace)
+        # 名前空間をパーツに分割
+        parts = namespace.split("::")
+
+        # 各パーツをスネークケースに変換
+        snake_parts = parts.map { |part| underscore(part) }
+
+        # base_pathと結合して.rbを追加
+        "#{File.join(@base_path, *snake_parts)}.rb"
+      end
+
+      # キャメルケースをスネークケースに変換
+      # @param str [String] キャメルケースの文字列
+      # @return [String] スネークケースの文字列
+      def underscore(str)
+        str
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .downcase
+      end
+    end
+  end
+end

data/lib/misogi/validator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Misogi
+  # ファイルに対してルールを適用し、違反を検出するクラス
+  class Validator
+    attr_reader :rules, :parser
+
+    # @param rules [Array<Rule::Base>] 適用するルールのリスト
+    # @param parser [Parser::Base] 使用するパーサー（デフォルト: Parser::Ruby）
+    def initialize(rules: [], parser: Parser::Ruby.new)
+      @rules = rules
+      @parser = parser
+    end
+
+    # ファイルを検証する
+    # @param file_path [String] 検証対象のファイルパス
+    # @return [Array<Violation>] 検出された違反のリスト
+    def validate_file(file_path)
+      return [] unless parser.parsable?(file_path)
+      return [] unless File.exist?(file_path)
+
+      content = File.read(file_path)
+      parsed_content = parser.parse(content)
+
+      violations = []
+      rules.each do |rule|
+        violations.concat(rule.validate(file_path, parsed_content))
+      end
+
+      violations
+    end
+
+    # 複数のファイルを検証する
+    # @param file_paths [Array<String>] 検証対象のファイルパスのリスト
+    # @return [Array<Violation>] 検出された違反のリスト
+    def validate_files(file_paths)
+      file_paths.flat_map { |file_path| validate_file(file_path) }
+    end
+  end
+end

data/lib/misogi/version.rb

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

data/lib/misogi/violation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Misogi
+  # ファイルパスとコンテンツの検証違反を表すクラス
+  class Violation
+    attr_reader :file_path, :message, :rule_name
+
+    # @param file_path [String] 違反が見つかったファイルパス
+    # @param message [String] 違反の詳細メッセージ
+    # @param rule_name [String] 違反を検出したルール名
+    def initialize(file_path:, message:, rule_name:)
+      @file_path = file_path
+      @message = message
+      @rule_name = rule_name
+    end
+
+    # 違反情報を文字列として表現
+    # @return [String]
+    def to_s
+      "#{file_path}: [#{rule_name}] #{message}"
+    end
+  end
+end

data/lib/misogi.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# 基本的な型定義は即座にロード
+require_relative "misogi/version"
+require_relative "misogi/violation"
+require_relative "misogi/parsed_content"
+
+# Misogiはファイルの内容を解析して、ファイル名やディレクトリ配置が適切かをチェックするlintツールを提供します
+module Misogi
+  class Error < StandardError; end
+
+  # 遅延ロードするクラス/モジュールをautoloadで定義
+  autoload :CLI, "misogi/cli"
+  autoload :Configuration, "misogi/configuration"
+  autoload :Validator, "misogi/validator"
+
+  # ファイルの内容を解析するパーサー
+  module Parser
+    autoload :Base, "misogi/parser/base"
+    autoload :Ruby, "misogi/parser/ruby"
+  end
+
+  # ファイルパスとコード内容の整合性をチェックするルール
+  module Rule
+    autoload :Base, "misogi/rule/base"
+    autoload :RubyStandard, "misogi/rule/ruby_standard"
+    autoload :Rails, "misogi/rule/rails"
+    autoload :RSpec, "misogi/rule/rspec"
+  end
+end

data/sig/misogi.rbs

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: misogi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iyuuya
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: ファイル内で定義されているクラスやモジュールの名前空間と、実際のファイルパスが一致しているかを検証するlintツールです。
+email:
+- yuya.ito@kufu.co.jp
+executables:
+- misogi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".misogi.yml.example"
+- CHANGELOG.md
+- CLAUDE.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/misogi
+- lib/misogi.rb
+- lib/misogi/cli.rb
+- lib/misogi/configuration.rb
+- lib/misogi/parsed_content.rb
+- lib/misogi/parser/base.rb
+- lib/misogi/parser/ruby.rb
+- lib/misogi/rule/base.rb
+- lib/misogi/rule/rails.rb
+- lib/misogi/rule/rspec.rb
+- lib/misogi/rule/ruby_standard.rb
+- lib/misogi/validator.rb
+- lib/misogi/version.rb
+- lib/misogi/violation.rb
+- sig/misogi.rbs
+homepage: https://github.com/kufu-ai/misogi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kufu-ai/misogi
+  source_code_uri: https://github.com/kufu-ai/misogi
+  changelog_uri: https://github.com/kufu-ai/misogi/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: 3.7.2
+specification_version: 4
+summary: ファイルの内容とパスの整合性をチェックするlintツール
+test_files: []