awesome_annotate 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c32fa3c7c828aa41da8e575479a8d6156d06f6911890e704d605621760f8f3e
-  data.tar.gz: 12d8857e51cf0ad0cc4f2819230236cce845eb54c41704551b81d2bec6422086
+  metadata.gz: b32b0b966e78664837bbf66e85c75e882f6f6ecaff193b7ba0e0d1ce7fae42bc
+  data.tar.gz: d1293087a0c3f44ff72aa9ff4cd6ad02effa90afd8562160c68dbc1267353edb
 SHA512:
-  metadata.gz: 71314f7a69db717c1d689468a1045e4fe5520a24ad98c2723081716b88e46f4268c5eb2949916c5f312016f90c5f103382cdf91adc2280132dd370aa90e0925d
-  data.tar.gz: 191e243909d986426a9b31679d247ffb8c79bbd69f65dd0543459e625e891ed1bd6acd2622c6630ec8efe5f971e6916e9b2428ea22f45046e70e89142e4df43b
+  metadata.gz: 28d077b539bcef973f6576576084c809f090f132401cdd8ca0f36eeebe7fd7d4d99d68cd1b7412c470e658f2e80a56959ff886c8543283758ef44ec8296a94c2
+  data.tar.gz: 1a18894e57ef95c194fe94b2c0aedaa5ad183ed64251857328875a274ca23bb76aa7e1419578c6d00b52e3f7e65b5b608d40bd85a6287cea125b909029bb95d8

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-03-31
+## [0.1.0] - 2024-04-29
 
 - Initial release
+
+## [0.1.1] - 2024-05-02
+
+- Fixed a bug
+
+## [0.1.2] - 2024-05-03
+
+- Add a new feature
+  - --version flag

data/lib/awesome_annotate/cli.rb

@@ -1,30 +1,27 @@
 require 'awesome_annotate'
+require 'awesome_annotate/model'
+require 'awesome_annotate/version'
 require 'thor'
-require 'active_record'
 
 module AwesomeAnnotate
   class CLI < Thor
-    desc "annotate", "annotate your code"
-    def annotate
-      puts "annotate your code"
-      return 'annotate your code'
-      # AwesomeAnnotate::Annotator.new.annotate
+    include Thor::Actions
+
+    map %w[--version -v] => :print_version
+    desc "--version, -v", "print the version"
+    def print_version
+      say AwesomeAnnotate::VERSION
     end
 
-    desc 'model [model name]', 'annotate your model'
+    desc 'model [model_name]', 'annotate your model'
     def model(model_name)
-      name = model_name.singularize.camelize
-      klass = Object.const_get(name)
+      AwesomeAnnotate::Model.new.annotate(model_name)
+    end
 
-      puts 'This is not a model' unless klass < ActiveRecord::Base
+    private
 
-      column_names = klass.column_names
-      model_dir = 'app/models'
-      file_path = "#{model_dir}/#{model_name}.rb"
-      File.open(file_path, 'r') do |file|
-        file.puts "# Columns: #{column_names.join(', ')}"
-      end
-      puts 'annotate your model'
+    def self.exit_on_failure?
+      true
     end
   end
 end

data/lib/awesome_annotate/model.rb

@@ -0,0 +1,68 @@
+require 'active_record'
+require 'thor'
+
+module AwesomeAnnotate
+  class Model < Thor
+    include Thor::Actions
+
+    desc 'model [model name]', 'annotate your model'
+    def annotate(model_name)
+      abort "Rails application path is required" unless env_file_path.exist?
+
+      apply env_file_path.to_s
+
+      klass = klass_name(model_name)
+
+      return say 'This model does not inherit activerecord' unless klass < ActiveRecord::Base
+
+      column_names = column_names(klass)
+      file_path = model_file_path(model_name)
+
+      insert_file_before_class(file_path, klass, "# Columns: #{column_names.join(', ')}\n")
+
+      say "annotate #{model_name.pluralize} table columns in #{file_path}"
+    end
+
+    private
+
+    def env_file_path
+      Pathname.new('config/environment.rb')
+    end
+
+    def model_dir
+      Pathname.new('app/models')
+    end
+
+    def insert_file_before_class(file_path, klass, message)
+      insert_into_file file_path, :before => / class #{klass} \n|class #{klass} .*\n / do
+        message
+      end
+    end
+
+    def column_names(klass)
+      klass.column_names
+    end
+
+    def model_file_path(model_name)
+      file_path = "#{model_dir}/#{model_name}.rb"
+
+      unless File.exist?(file_path)
+        return say "Model file not found"
+      end
+
+      return file_path
+    end
+
+    def klass_name(model_name)
+      name = model_name.singularize.camelize
+      klass = Object.const_get(name)
+
+    rescue NameError
+      say "Model not found"
+    end
+
+    def self.source_root
+      Dir.pwd
+    end
+  end
+end

data/lib/awesome_annotate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_annotate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - wisdom-plus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -56,6 +56,7 @@ files:
 - exe/awesome_annotate
 - lib/awesome_annotate.rb
 - lib/awesome_annotate/cli.rb
+- lib/awesome_annotate/model.rb
 - lib/awesome_annotate/version.rb
 - sig/awesome_annotate.rbs
 homepage: https://github.com/wisdom-plus/awesome_annotate