annotate_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cbc5209bfbb4f497c00889bc95d34144d8e60e628f2495ffa04e36b14cebccc
+  data.tar.gz: bd791e489c057c52be7057bee4b4e0d8fdb7cd28fac10de187f980daf125a7f7
+SHA512:
+  metadata.gz: 15bd5a3e57f5c48671fad01351acf4b70a20f03ebe4d2d6df70c38b97709f41b11a5060bce9bd9a11daf3f6544429fbda8e9da376de3508c6f1abae9a2d03b05
+  data.tar.gz: 31c6a6bfdad46c5614f0793afd4e1a02e52b913f9a253ccd6b32081e55476cb58997bd39ac63b586529fa850ce1294e7eb357f158a541b27a65abe91d51f85da

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Taeyang Lee
+
+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,33 @@
+# AnnotateModel
+
+AnnotateModel is a lightweight gem to annotate Rails models with database schema information.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+`bundle add annotate_model`
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+`gem install annotate_model`
+
+## Usage
+
+To annotate all models, run:
+
+`annotate_model --all`
+
+To annotate specific models, run:
+
+`annotate_model [model_name1] [model_name2] ...`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/annotate_model

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'annotate_model'
+
+load File.expand_path('config/environment.rb', Dir.pwd)
+
+AnnotateModel::Cli.start(ARGV)

data/lib/annotate_model/annotation_decider.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AnnotateModel
+  class AnnotationDecider
+    def initialize(file)
+      @file = file
+    end
+
+    def annotate?
+      klass = ModelClassGetter.call(@file)
+      return false unless klass
+
+      annotate_conditions(klass).all?
+    end
+
+    private
+
+    def annotate_conditions(klass)
+      [
+        klass.is_a?(Class),
+        klass.respond_to?(:table_exists?) && klass.table_exists?
+      ]
+    end
+  end
+end

data/lib/annotate_model/annotator.rb

@@ -0,0 +1,79 @@
+module AnnotateModel
+  class Annotator
+    def self.annotate(model_names)
+      process_files(AnnotateModel::Finder.model_files!(model_names))
+    rescue ModelFileNotFoundError => e
+      warn e.message
+    end
+
+    def self.annotate_all
+      process_files(AnnotateModel::Finder.all_model_files)
+    end
+
+    def self.process_files(files)
+      run_files = []
+      skipped_files = []
+      failed_files = []
+
+      files.each do |file|
+        result = annotate_file(file)
+        case result
+        when :run
+          run_files << file
+        when :skipped
+          skipped_files << file
+        when :failed
+          failed_files << file
+        end
+      end
+
+      log_results(run_files, skipped_files, failed_files)
+    end
+
+    def self.annotate_file(file)
+      return :failed unless AnnotationDecider.new(file).annotate?
+
+      content = File.read(file)
+      return :skipped if content.include?("# == Schema Information")
+
+      schema_info = fetch_schema_info(file)
+      return :failed unless schema_info
+
+      annotated_content = <<~ANNOTATION + content
+        # == Schema Information
+        #
+        #{schema_info}
+      ANNOTATION
+
+      File.write(file, annotated_content)
+      :run
+    end
+
+    def self.fetch_schema_info(file)
+      model_name = File.basename(file, ".rb").camelize
+      table_name = model_name.tableize
+
+      begin
+        columns = ActiveRecord::Base.connection.columns(table_name)
+      rescue ActiveRecord::StatementInvalid
+        warn "Could not find table '#{table_name}'"
+        return
+      end
+
+      columns.map do |column|
+        "# #{column.name.ljust(10)} :#{column.type}#{' ' * (15 - column.type.to_s.length)}#{column.null ? '' : ' not null'}"
+      end.join("\n")
+    end
+
+    def self.log_results(run_files, skipped_files, failed_files)
+      puts "Annotated files (#{run_files.size}):"
+      run_files.each { |file| puts "  - #{file}" }
+
+      puts "Skipped files (#{skipped_files.size}):"
+      skipped_files.each { |file| puts "  - #{file}" }
+
+      puts "Failed files (#{failed_files.size}):"
+      failed_files.each { |file| puts "  - #{file}" }
+    end
+  end
+end

data/lib/annotate_model/cli.rb

@@ -0,0 +1,25 @@
+module AnnotateModel
+  class Cli
+    def self.start(args)
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: annotate models [options] [model_name]"
+
+        opts.on("-a", "--all", "Annotate all models") do |a|
+          options[:all] = a
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end.parse!(args)
+
+      if options[:all] || args.empty?
+        AnnotateModel::Annotator.annotate_all
+      else
+        AnnotateModel::Annotator.annotate(args)
+      end
+    end
+  end
+end

data/lib/annotate_model/finder.rb

@@ -0,0 +1,22 @@
+module AnnotateModel
+  class Finder
+    def self.model_files!(model_names)
+      model_names.map do |model_name|
+        find_model_file!(model_name)
+      end
+    end
+
+    def self.all_model_files
+      Dir.glob(Rails.root.join("app", "models", "**", "*.rb"))
+    end
+
+    def self.find_model_file(model_name)
+      model_path = Rails.root.join("app", "models", "#{model_name.underscore}.rb")
+      model_path if File.exist?(model_path)
+    end
+
+    def self.find_model_file!(model_name)
+      find_model_file(model_name) || raise(ModelFileNotFoundError, "#{model_name}")
+    end
+  end
+end

data/lib/annotate_model/model_class_getter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module AnnotateModel
+  class ModelClassGetter
+    class << self
+      def call(file)
+        model_name = file_to_model_name(file)
+        begin
+          model_name.constantize
+        rescue NameError
+          nil
+        end
+      end
+
+      private
+
+      def file_to_model_name(file)
+        relative_path = file.sub(Rails.root.join('app', 'models').to_s + '/', '')
+        relative_path.to_s.sub('.rb', '').camelize
+      end
+    end
+  end
+end

data/lib/annotate_model/model_file_not_found_error.rb

@@ -0,0 +1,7 @@
+module AnnotateModel
+  class ModelFileNotFoundError < StandardError
+    def initialize(model_name)
+      super("Model file not found: #{model_name}")
+    end
+  end
+end

data/lib/annotate_model/version.rb

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

data/lib/annotate_model.rb

@@ -0,0 +1,7 @@
+require "optparse"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module AnnotateModel
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: annotate_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taeyang Lee
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-20 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight gem to annotate Rails models based on the database schema.
+email:
+- taeyang91@gmail.com
+executables:
+- annotate_model
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/annotate_model
+- lib/annotate_model.rb
+- lib/annotate_model/annotation_decider.rb
+- lib/annotate_model/annotator.rb
+- lib/annotate_model/cli.rb
+- lib/annotate_model/finder.rb
+- lib/annotate_model/model_class_getter.rb
+- lib/annotate_model/model_file_not_found_error.rb
+- lib/annotate_model/version.rb
+homepage: https://github.com/taeyang91/annotate_model
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/taeyang91/annotate_model
+  source_code_uri: https://github.com/taeyang91/annotate_model
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Annotates Rails models with database schema information.
+test_files: []