awesome_annotate 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f47508ed24d0bf2374190e00d9f23032797e1fac1740d91283d392eb970ed8c
-  data.tar.gz: c76db1996bb2cee959f473c063c30b280077fc7b3fe64cd7c592b99eca4e7dd9
+  metadata.gz: 14fd05f02d2e589431ee8ca8b52911aa1365e2daebcb835e78b9cbfaf2198e69
+  data.tar.gz: 8a5de3f58b1c8f0cb94a8737b9ca01c9988868c8a797c8382f53dd6cf060cb8c
 SHA512:
-  metadata.gz: d92baaa7dee1ebde3c1f5713e235a5f78ab4c3ea3f546e03f0de0fdacff286e493ddc7f94cbc18031341a98c009740300930004fd7eca0aa39fe87721be1f29d
-  data.tar.gz: ff3d7e4fc5b3e448de8e2b08feff317f20c7e4e7fc920e86dae9859fb7c0843df8d7c2f945decb886ac48c364ec85d46cc250155553cf491a8c93f22f432bf6e
+  metadata.gz: 7584be12529764fc8a172dd29672331842eb2cb00371bafad1691c67206386452ccc8a8e28c42e0f55bca49522a5b944cd1b56cc55c74cb608c60ec194dba6ca
+  data.tar.gz: 51d1c40aeba22f1f941da7539e6ee489dbce49d60b7af457ea08650e933a36c276943b522fd58c412caced26699b547aefdfea68d0747b6e56886811898ada76

data/CHANGELOG.md

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

data/lib/awesome_annotate/cli.rb

@@ -1,34 +1,27 @@
-require 'active_record'
 require 'awesome_annotate'
+require 'awesome_annotate/model'
+require 'awesome_annotate/route'
+require 'awesome_annotate/version'
 require 'thor'
 
 module AwesomeAnnotate
   class CLI < Thor
     include Thor::Actions
 
-    desc 'model [model name]', 'annotate your model'
-    def model(model_name)
-      rails_env_file = Pathname.new('./config/environment.rb')
-      abort "Rails application path is required" unless rails_env_file.exist?
-
-      apply rails_env_file.to_s
-
-      name = model_name.singularize.camelize
-      klass = Object.const_get(name)
-
-      return puts 'This model does not inherit activerecord' unless klass < ActiveRecord::Base
-
-      column_names = klass.column_names
-      model_dir = Pathname.new('app/models')
-      file_path = "#{model_dir.to_s}/#{model_name}.rb"
-
-      return puts "Model file not found" unless File.exist?(file_path)
+    map %w[--version -v] => :print_version
+    desc "--version, -v", "print the version"
+    def print_version
+      say AwesomeAnnotate::VERSION
+    end
 
-      insert_into_file file_path, :before => / class #{klass} \n|class #{klass} .*\n / do
-        "# Columns: #{column_names.join(', ')}\n"
-      end
+    desc 'model [model_name]', 'annotate your model'
+    def model(model_name)
+      AwesomeAnnotate::Model.new.annotate(model_name)
+    end
 
-      puts "annotate #{model_name.pluralize} table columns in #{file_path}"
+    desc 'routes', 'annotate your route'
+    def routes
+      AwesomeAnnotate::Route.new.annotate
     end
 
     private
@@ -36,9 +29,5 @@ module AwesomeAnnotate
     def self.exit_on_failure?
       true
     end
-
-    def self.source_root
-      Dir.pwd
-    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/route.rb

@@ -0,0 +1,55 @@
+require 'active_record'
+require 'thor'
+
+module AwesomeAnnotate
+  class Route < Thor
+    include Thor::Actions
+
+    desc 'annotate all routes', 'annotate your routes'
+    def annotate
+      abort "Rails application path is required" unless env_file_path.exist?
+
+      apply env_file_path.to_s
+
+      inspector = ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes)
+      formatter = ActionDispatch::Routing::ConsoleFormatter::Sheet.new
+
+      routes = inspector.format(formatter, {})
+      route_message = parse_routes(routes)
+
+      insert_file_before_class(route_file_path, route_message)
+
+      say "annotate routes in #{route_file_path}"
+    end
+
+    private
+
+    def env_file_path
+      Pathname.new('config/environment.rb')
+    end
+
+    def route_file_path
+      Pathname.new('config/routes.rb')
+    end
+
+    def parse_routes(routes)
+      split_routes = routes.split(/\r\n|\r|\n/)
+      parse_routes = split_routes.map do |route|
+        "# #{route}\n"
+      end
+      parse_routes.push("\n")
+      parse_routes.unshift("#---This is route annotate---\n#\n")
+      parse_routes.join
+    end
+
+    def insert_file_before_class(file_path, message)
+      insert_into_file file_path, :before => "Rails.application.routes.draw do\n" do
+        message
+      end
+    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.1"
+  VERSION = "0.1.3"
 end

metadata

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