awesome_annotate 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32b0b966e78664837bbf66e85c75e882f6f6ecaff193b7ba0e0d1ce7fae42bc
-  data.tar.gz: d1293087a0c3f44ff72aa9ff4cd6ad02effa90afd8562160c68dbc1267353edb
+  metadata.gz: 231c9ce46ab9f54c995580b73fc46b2f16df5531ab979b0fa9ce7273e34c5fda
+  data.tar.gz: 0752a6de349b42c1658a8a907f503f1a16392a8d894af9436877c6cb83dbe68a
 SHA512:
-  metadata.gz: 28d077b539bcef973f6576576084c809f090f132401cdd8ca0f36eeebe7fd7d4d99d68cd1b7412c470e658f2e80a56959ff886c8543283758ef44ec8296a94c2
-  data.tar.gz: 1a18894e57ef95c194fe94b2c0aedaa5ad183ed64251857328875a274ca23bb76aa7e1419578c6d00b52e3f7e65b5b608d40bd85a6287cea125b909029bb95d8
+  metadata.gz: 37e53bcca2c79b97e551397f0dd6c92ab0c1f2b833edb05175100b0548c00c8b3117ea4aa528ef9f37e604329805f65f98ba9ac48c6bc2661b6395777de3028e
+  data.tar.gz: c38e57f6d68825d3917fa0c9926be4ac7526c5a0154c568afc18b802363bd4af1e7e37e22581ea009a0fa5bdb1ab0f0d3c9f1f5f11f12e21dfc7ee3d89a2862a

data/CHANGELOG.md

@@ -1,14 +1,19 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2024-04-29
+## [0.1.3] - 2024-05-05
 
-- Initial release
+- 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.2] - 2024-05-03
+## [0.1.0] - 2024-04-29
 
-- Add a new feature
-  - --version flag
+- Initial release

data/awesome_annotate.gemspec

@@ -32,11 +32,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "thor"
-  spec.add_dependency "activerecord", "~> 7.1"
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "activerecord", ">= 6.1.0"
 end

data/lib/awesome_annotate/cli.rb

@@ -1,5 +1,6 @@
 require 'awesome_annotate'
 require 'awesome_annotate/model'
+require 'awesome_annotate/route'
 require 'awesome_annotate/version'
 require 'thor'
 
@@ -13,11 +14,18 @@ module AwesomeAnnotate
       say AwesomeAnnotate::VERSION
     end
 
+    map %w[model -m] => :model
     desc 'model [model_name]', 'annotate your model'
     def model(model_name)
       AwesomeAnnotate::Model.new.annotate(model_name)
     end
 
+    map %w[routes -r] => :routes
+    desc 'routes', "Writes application route information to `config/routes.rb`."
+    def routes
+      AwesomeAnnotate::Route.new.annotate
+    end
+
     private
 
     def self.exit_on_failure?

data/lib/awesome_annotate/model.rb

@@ -34,7 +34,7 @@ module AwesomeAnnotate
     end
 
     def insert_file_before_class(file_path, klass, message)
-      insert_into_file file_path, :before => / class #{klass} \n|class #{klass} .*\n / do
+      insert_into_file file_path, :before => /^class\s+\w+\s+<\s+\w+/ do
         message
       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.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_annotate
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - wisdom-plus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -28,16 +28,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 6.1.0
 description: annotate your code with comments (e.g. model schema, routes, etc.)
 email:
 - wisdom.plus.264.dev@gmail.com
@@ -57,6 +57,7 @@ files:
 - 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