annotate_model 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cbc5209bfbb4f497c00889bc95d34144d8e60e628f2495ffa04e36b14cebccc
-  data.tar.gz: bd791e489c057c52be7057bee4b4e0d8fdb7cd28fac10de187f980daf125a7f7
+  metadata.gz: 9bfe01af59acdb784fe61f48a4bb623e63a27aca48a843b8a66db1bb2329a2af
+  data.tar.gz: 9abd685d77a61a462f6ada1af4822ea1e9d77ef656061d6f2eca39bdab355784
 SHA512:
-  metadata.gz: 15bd5a3e57f5c48671fad01351acf4b70a20f03ebe4d2d6df70c38b97709f41b11a5060bce9bd9a11daf3f6544429fbda8e9da376de3508c6f1abae9a2d03b05
-  data.tar.gz: 31c6a6bfdad46c5614f0793afd4e1a02e52b913f9a253ccd6b32081e55476cb58997bd39ac63b586529fa850ce1294e7eb357f158a541b27a65abe91d51f85da
+  metadata.gz: dedfd1261bd55bc14d447019478223c699ee7b5922254848772a3a8243e0b0874ba32d065ed02105f5f59e3a4ca7763cf2bc24cdab50b13fc0fe55bbf4dce218
+  data.tar.gz: 8a98c76426119678016dda6d058b8026d108cca62013da16fd7a2b7e134ebd1b8d4a6df3910075315c63ed888379c227b23a139d8919f19a0f5be473cfc3d3cd

data/README.md

@@ -1,26 +1,46 @@
-# AnnotateModel
+# AnnotateModel [![Gem Version](https://badge.fury.io/rb/annotate_model.svg)](https://badge.fury.io/rb/annotate_model)
 
 AnnotateModel is a lightweight gem to annotate Rails models with database schema information.
 
+## Example
+
+Here's an example of the schema information in your model file after annotation:
+```ruby
+# == Schema Information
+#
+# id         :integer         not null
+# name       :string
+# created_at :datetime        not null
+# updated_at :datetime        not null
+class Product < ApplicationRecord
+end
+```
+
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add this line to the application's Gemfile:
 
-`bundle add annotate_model`
+```
+group :development do
+  ...
+  gem "annotate_model"
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it globally:
 
-`gem install annotate_model`
+```sh
+gem install annotate_model
+```
 
 ## Usage
 
 To annotate all models, run:
 
-`annotate_model --all`
+`bundle exec annotate_model --all`
 
 To annotate specific models, run:
 
-`annotate_model [model_name1] [model_name2] ...`
+`bundle exec annotate_model [model_name1] [model_name2] ...`
 
 ## Development
 

data/lib/annotate_model/annotation_decider.rb

@@ -7,8 +7,11 @@ module AnnotateModel
     end
 
     def annotate?
-      klass = ModelClassGetter.call(@file)
-      return false unless klass
+      begin
+        klass = @file.model_name.constantize
+      rescue NameError
+        return false
+      end
 
       annotate_conditions(klass).all?
     end

data/lib/annotate_model/annotator.rb

@@ -33,7 +33,7 @@ module AnnotateModel
     def self.annotate_file(file)
       return :failed unless AnnotationDecider.new(file).annotate?
 
-      content = File.read(file)
+      content = File.read(file.to_s)
       return :skipped if content.include?("# == Schema Information")
 
       schema_info = fetch_schema_info(file)
@@ -45,13 +45,12 @@ module AnnotateModel
         #{schema_info}
       ANNOTATION
 
-      File.write(file, annotated_content)
+      File.write(file.to_s, annotated_content)
       :run
     end
 
     def self.fetch_schema_info(file)
-      model_name = File.basename(file, ".rb").camelize
-      table_name = model_name.tableize
+      table_name = file.model_name.tableize
 
       begin
         columns = ActiveRecord::Base.connection.columns(table_name)
@@ -67,13 +66,13 @@ module AnnotateModel
 
     def self.log_results(run_files, skipped_files, failed_files)
       puts "Annotated files (#{run_files.size}):"
-      run_files.each { |file| puts "  - #{file}" }
+      run_files.each { |file| puts "  - #{file.relative_path}" }
 
       puts "Skipped files (#{skipped_files.size}):"
-      skipped_files.each { |file| puts "  - #{file}" }
+      skipped_files.each { |file| puts "  - #{file.relative_path}" }
 
       puts "Failed files (#{failed_files.size}):"
-      failed_files.each { |file| puts "  - #{file}" }
+      failed_files.each { |file| puts "  - #{file.relative_path}" }
     end
   end
 end

data/lib/annotate_model/finder.rb

@@ -7,12 +7,15 @@ module AnnotateModel
     end
 
     def self.all_model_files
-      Dir.glob(Rails.root.join("app", "models", "**", "*.rb"))
+      files = Dir.glob(Rails.root.join("app", "models", "**", "*.rb")).reject { |file_path| file_path.include?('application_record.rb') }
+      files.map do |file|
+        ModelFile.new(Pathname.new(file))
+      end
     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)
+      ModelFile.new(model_path) if File.exist?(model_path)
     end
 
     def self.find_model_file!(model_name)

data/lib/annotate_model/model_file.rb

@@ -0,0 +1,22 @@
+module AnnotateModel
+  class ModelFile
+    # Initializes a new ModelFile instance.
+    #
+    # @param file_path [Pathname] the file path of the model file
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def relative_path
+      @file_path.relative_path_from(Rails.root).to_s
+    end
+
+    def model_name
+      @file_path.relative_path_from(Rails.root.join('app', 'models')).to_s.sub('.rb', '').camelize
+    end
+
+    def to_s
+      @file_path.to_s
+    end
+  end
+end

data/lib/annotate_model/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Taeyang Lee
@@ -26,7 +26,7 @@ files:
 - 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.rb
 - lib/annotate_model/model_file_not_found_error.rb
 - lib/annotate_model/version.rb
 homepage: https://github.com/taeyang91/annotate_model

data/lib/annotate_model/model_class_getter.rb

@@ -1,23 +0,0 @@
-# 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