annotate_model 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f530a132985bc423c3f6a32005be46df58acddc550bdd68dce0658010407d4e7
-  data.tar.gz: d57060bbee598d5914359717d716a80ff3b60463993e62fb15ee66d3843cd723
+  metadata.gz: acaa898d77121490f69c9253e67f0da9788299581ca7baca9a91a02e7dde69d8
+  data.tar.gz: d600bb6a190d68a3aa29b6e3159956b3da07d80bb521ba9feaf65b7e70fb875b
 SHA512:
-  metadata.gz: 6a0f926c606fbfdf0346a9e7e5f2161cbc1315cddd6c03ba3a2b2b6d2e5962564bd9a7cffb905b9e3a25c56a65bdc35dd45e0442687a481f3e950d861792fd1d
-  data.tar.gz: 44a4d4409f9605ce19972c9a111cded649ccdc7c0c6b0c23c8faf66a7e22d9ad79e6e1fcb1cfcacdd7934d22075046d32aee194746ffaeb18ce5c1790eca951b
+  metadata.gz: 8c7757e023d793050a2e4b0f99b0fbca36e3a8f157213c85a1d3b10d81fe751a8876751a7b851af0347bc007b10909301a1b8d3de7927ebab159fad3842fb236
+  data.tar.gz: 7d38492f6fcdfc8ce390c595eb2c6caf398c501d249eb873df835a57342e5fa0fd462a6b4c6087d2f1544b2139c4bf8c7cceee0e413eb792a925233af57ae478

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=2
+[gem-version]: https://rubygems.org/gems/annotate_model
+
 ## Example
 
 Here's an example of the schema information in your model file after annotation:
@@ -12,10 +15,26 @@ Here's an example of the schema information in your model file after annotation:
 # name       :string
 # created_at :datetime        not null
 # updated_at :datetime        not null
+# ==
 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
+```
+
+The annotation block is re-written each time the command runs. The starting line `# == Schema Information` and the ending line `# ==` should never be changed as they are important for the regex match used to remove existing annotations.
+
 ## Installation
 
 Add this line to the application's Gemfile:
@@ -36,11 +55,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

@@ -30,22 +30,26 @@ module AnnotateModel
     def self.annotate_file(file)
       return :skipped unless AnnotationDecider.new(file).annotate?
 
-      content = File.read(file.to_s)
-      return :skipped if content.include?("# == Schema Information")
-
       schema_info = fetch_schema_info(file)
       return :failed unless schema_info
 
+      content = File.read(file.to_s)
+      content = remove_existing_annotation(content)
       annotated_content = <<~ANNOTATION + content
         # == Schema Information
         #
         #{schema_info}
+        # ==
       ANNOTATION
 
       File.write(file.to_s, annotated_content)
       :run
     end
 
+    def self.remove_existing_annotation(content)
+      content.sub(/^# == Schema Information\n(#.*\n)*# ==\n/m, '')
+    end
+
     def self.fetch_schema_info(file)
       begin
         columns = ActiveRecord::Base.connection.columns(file.table_name)

data/lib/annotate_model/version.rb

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

metadata

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