annotate_model 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfe01af59acdb784fe61f48a4bb623e63a27aca48a843b8a66db1bb2329a2af
-  data.tar.gz: 9abd685d77a61a462f6ada1af4822ea1e9d77ef656061d6f2eca39bdab355784
+  metadata.gz: f530a132985bc423c3f6a32005be46df58acddc550bdd68dce0658010407d4e7
+  data.tar.gz: d57060bbee598d5914359717d716a80ff3b60463993e62fb15ee66d3843cd723
 SHA512:
-  metadata.gz: dedfd1261bd55bc14d447019478223c699ee7b5922254848772a3a8243e0b0874ba32d065ed02105f5f59e3a4ca7763cf2bc24cdab50b13fc0fe55bbf4dce218
-  data.tar.gz: 8a98c76426119678016dda6d058b8026d108cca62013da16fd7a2b7e134ebd1b8d4a6df3910075315c63ed888379c227b23a139d8919f19a0f5be473cfc3d3cd
+  metadata.gz: 6a0f926c606fbfdf0346a9e7e5f2161cbc1315cddd6c03ba3a2b2b6d2e5962564bd9a7cffb905b9e3a25c56a65bdc35dd45e0442687a481f3e950d861792fd1d
+  data.tar.gz: 44a4d4409f9605ce19972c9a111cded649ccdc7c0c6b0c23c8faf66a7e22d9ad79e6e1fcb1cfcacdd7934d22075046d32aee194746ffaeb18ce5c1790eca951b

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.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotate_model
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 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: