annotate_model 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfe01af59acdb784fe61f48a4bb623e63a27aca48a843b8a66db1bb2329a2af
-  data.tar.gz: 9abd685d77a61a462f6ada1af4822ea1e9d77ef656061d6f2eca39bdab355784
+  metadata.gz: 702f03dcd1fc38f6e6d05d4f9c49b0c13f8491629f0c6999c1176ee2e51042a9
+  data.tar.gz: 6b12bfc2604b2fe1947f44bf4f489605c12ab54afd9f6bf3321b69c588ce2a08
 SHA512:
-  metadata.gz: dedfd1261bd55bc14d447019478223c699ee7b5922254848772a3a8243e0b0874ba32d065ed02105f5f59e3a4ca7763cf2bc24cdab50b13fc0fe55bbf4dce218
-  data.tar.gz: 8a98c76426119678016dda6d058b8026d108cca62013da16fd7a2b7e134ebd1b8d4a6df3910075315c63ed888379c227b23a139d8919f19a0f5be473cfc3d3cd
+  metadata.gz: 74b2b1467ac782f82d9c94ad0f8c0a3d82f713161990b38c9f1eec7a3fa23e34f97883c2659822dca343c693ae466a4db0a591ec08cf61f7bd940e4fbe494dc7
+  data.tar.gz: 14542f117a30d48faa47e79df28c971b01be998fffc0db4bd7d40d6f9b2d5be9c5d1d360fa6710382af8baa53e49ae17a5869454b52695b999cdca18060942bf

data/README.md

@@ -1,7 +1,10 @@
-# AnnotateModel [![Gem Version](https://badge.fury.io/rb/annotate_model.svg)](https://badge.fury.io/rb/annotate_model)
+# AnnotateModel [![Gem Version][]][gem-version]
 
 AnnotateModel is a lightweight gem to annotate Rails models with database schema information.
 
+[Gem Version]: https://badge.fury.io/rb/annotate_model.svg?v=1
+[gem-version]: https://rubygems.org/gems/annotate_model
+
 ## Example
 
 Here's an example of the schema information in your model file after annotation:
@@ -16,6 +19,18 @@ class Product < ApplicationRecord
 end
 ```
 
+```ruby
+# == Schema Information
+#
+# id         :integer         not null
+# name       :string
+# email      :string
+# created_at :datetime        not null
+# updated_at :datetime        not null
+class Admin::User < ApplicationRecord
+end
+```
+
 ## Installation
 
 Add this line to the application's Gemfile:
@@ -36,11 +51,19 @@ gem install annotate_model
 
 To annotate all models, run:
 
-`bundle exec annotate_model --all`
+`bundle exec annotate_model`
 
 To annotate specific models, run:
 
-`bundle exec annotate_model [model_name1] [model_name2] ...`
+`bundle exec annotate_model Product Admin::User`
+
+## Skipping Annotation
+
+If you want to skip annotation for a specific model, add the following skip flag to the model file:
+
+```ruby
+# == annotate_model:skip
+```
 
 ## Development
 

data/lib/annotate_model/annotation_decider.rb

@@ -2,11 +2,15 @@
 
 module AnnotateModel
   class AnnotationDecider
+    SKIP_FLAG = "# == annotate_model:skip"
+
     def initialize(file)
       @file = file
     end
 
     def annotate?
+      return false if skip_flag_present?
+
       begin
         klass = @file.model_name.constantize
       rescue NameError
@@ -18,6 +22,10 @@ module AnnotateModel
 
     private
 
+    def skip_flag_present?
+      File.foreach(@file.to_s).any? { |line| line.include?(SKIP_FLAG) }
+    end
+
     def annotate_conditions(klass)
       [
         klass.is_a?(Class),

data/lib/annotate_model/annotator.rb

@@ -12,7 +12,6 @@ module AnnotateModel
 
     def self.process_files(files)
       run_files = []
-      skipped_files = []
       failed_files = []
 
       files.each do |file|
@@ -20,18 +19,16 @@ module AnnotateModel
         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)
+      log_results(run_files, failed_files)
     end
 
     def self.annotate_file(file)
-      return :failed unless AnnotationDecider.new(file).annotate?
+      return :skipped unless AnnotationDecider.new(file).annotate?
 
       content = File.read(file.to_s)
       return :skipped if content.include?("# == Schema Information")
@@ -50,12 +47,10 @@ module AnnotateModel
     end
 
     def self.fetch_schema_info(file)
-      table_name = file.model_name.tableize
-
       begin
-        columns = ActiveRecord::Base.connection.columns(table_name)
+        columns = ActiveRecord::Base.connection.columns(file.table_name)
       rescue ActiveRecord::StatementInvalid
-        warn "Could not find table '#{table_name}'"
+        warn "Could not find table '#{file.table_name}'"
         return
       end
 
@@ -64,15 +59,13 @@ module AnnotateModel
       end.join("\n")
     end
 
-    def self.log_results(run_files, skipped_files, failed_files)
-      puts "Annotated files (#{run_files.size}):"
+    def self.log_results(run_files, failed_files)
+      puts "Annotated files:"
       run_files.each { |file| puts "  - #{file.relative_path}" }
 
-      puts "Skipped files (#{skipped_files.size}):"
-      skipped_files.each { |file| puts "  - #{file.relative_path}" }
-
-      puts "Failed files (#{failed_files.size}):"
+      puts "Failed files:"
       failed_files.each { |file| puts "  - #{file.relative_path}" }
+      puts "#{run_files.size} runs, #{failed_files.size} failures"
     end
   end
 end

data/lib/annotate_model/model_file.rb

@@ -11,10 +11,28 @@ module AnnotateModel
       @file_path.relative_path_from(Rails.root).to_s
     end
 
+    # Returns the model name corresponding to the model file path.
+    #
+    # @return [String] the model name corresponding to the model file path.
+    #
+    # @example
+    #   For a file path "app/models/admin/user.rb", it returns "Admin::User".
+    #   For a file path "app/models/product.rb", it returns "Product".
     def model_name
       @file_path.relative_path_from(Rails.root.join('app', 'models')).to_s.sub('.rb', '').camelize
     end
 
+    # Returns the table name corresponding to the model file path.
+    #
+    # @return [String] the table name corresponding to the model file path.
+    #
+    # @example
+    #   For a file path "app/models/admin/user.rb", it returns "admin_users".
+    #   For a file path "app/models/product.rb", it returns "products".
+    def table_name
+      @file_path.relative_path_from(Rails.root.join('app', 'models')).to_s.sub('.rb', '').classify.tableize.sub('/', '_')
+    end
+
     def to_s
       @file_path.to_s
     end

data/lib/annotate_model/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotate_model
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Taeyang Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies: []
 description: A lightweight gem to annotate Rails models based on the database schema.
 email: