awesome_annotate 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14fd05f02d2e589431ee8ca8b52911aa1365e2daebcb835e78b9cbfaf2198e69
-  data.tar.gz: 8a5de3f58b1c8f0cb94a8737b9ca01c9988868c8a797c8382f53dd6cf060cb8c
+  metadata.gz: add6a26de84b0dab25e21c0c60213a8d0c6aef0109a552faf635fdfb745e5bcb
+  data.tar.gz: 6a9494f2aeafe2e163c59f1544f181da0d39aef6736851412580c1b59231631a
 SHA512:
-  metadata.gz: 7584be12529764fc8a172dd29672331842eb2cb00371bafad1691c67206386452ccc8a8e28c42e0f55bca49522a5b944cd1b56cc55c74cb608c60ec194dba6ca
-  data.tar.gz: 51d1c40aeba22f1f941da7539e6ee489dbce49d60b7af457ea08650e933a36c276943b522fd58c412caced26699b547aefdfea68d0747b6e56886811898ada76
+  metadata.gz: 9654317d619c0d5e4706b1a5fb1f6899a123a3f8b6acb79c29d744d65ed5c6d1a895e9cbd835653e1d33de80055c75a24e0f38fd365d2e58112738cf2e70b763
+  data.tar.gz: 807524f834b4087643d8fc2e2477ebd271f6eac9a989d947b9ac3dd693259baf7890187e3201293d4e809f6dfef9f7abe05542f3a287e17af0a527d54d955acc

data/.rspec_status

@@ -0,0 +1,11 @@
+example_id                                           | status | run_time        |
+---------------------------------------------------- | ------ | --------------- |
+./spec/awesome_annotate_spec.rb[1:1]                 | passed | 0.00031 seconds |
+./spec/lib/awesome_annotate/cli_spec.rb[1:3:1]       | passed | 0.00185 seconds |
+./spec/lib/awesome_annotate/model_spec.rb[1:1:1:1:1] | passed | 0.19755 seconds |
+./spec/lib/awesome_annotate/model_spec.rb[1:1:1:2:1] | passed | 0.00078 seconds |
+./spec/lib/awesome_annotate/model_spec.rb[1:1:1:3:1] | passed | 0.00018 seconds |
+./spec/lib/awesome_annotate/model_spec.rb[1:1:2:1]   | passed | 0.00008 seconds |
+./spec/lib/awesome_annotate/route_spec.rb[1:1:1:1:1] | passed | 0.00303 seconds |
+./spec/lib/awesome_annotate/route_spec.rb[1:1:1:2:1] | passed | 0.0005 seconds  |
+./spec/lib/awesome_annotate/route_spec.rb[1:1:2:1]   | passed | 0.00009 seconds |

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

@@ -14,12 +14,14 @@ 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
 
-    desc 'routes', 'annotate your route'
+    map %w[routes -r] => :routes
+    desc 'routes', "Writes application route information to `config/routes.rb`."
     def routes
       AwesomeAnnotate::Route.new.annotate
     end

data/lib/awesome_annotate/error.rb

@@ -0,0 +1,2 @@
+
+class NotFoundError < StandardError; end

data/lib/awesome_annotate/model.rb

@@ -1,15 +1,22 @@
 require 'active_record'
 require 'thor'
+require_relative 'error'
 
 module AwesomeAnnotate
   class Model < Thor
     include Thor::Actions
 
+    def initialize(params = {})
+      super()
+      @env_file_path = Pathname.new(params[:env_file_path] || 'config/environment.rb')
+      @model_dir = Pathname.new(params[:model_dir] || 'app/models')
+    end
+
     desc 'model [model name]', 'annotate your model'
     def annotate(model_name)
-      abort "Rails application path is required" unless env_file_path.exist?
+      raise "Rails application path is required" unless @env_file_path.exist?
 
-      apply env_file_path.to_s
+      apply @env_file_path.to_s
 
       klass = klass_name(model_name)
 
@@ -25,16 +32,12 @@ module AwesomeAnnotate
 
     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
+      insert_into_file file_path, :before => /^class\s+\w+\s+<\s+\w+/ do
         message
       end
     end
@@ -44,10 +47,11 @@ module AwesomeAnnotate
     end
 
     def model_file_path(model_name)
-      file_path = "#{model_dir}/#{model_name}.rb"
+      file_path = "#{@model_dir}/#{model_name}.rb"
 
       unless File.exist?(file_path)
-        return say "Model file not found"
+        say "Model file not found"
+        raise NotFoundError
       end
 
       return file_path
@@ -55,10 +59,11 @@ module AwesomeAnnotate
 
     def klass_name(model_name)
       name = model_name.singularize.camelize
-      klass = Object.const_get(name)
+      return Object.const_get(name)
 
     rescue NameError
       say "Model not found"
+      raise NotFoundError
     end
 
     def self.source_root

data/lib/awesome_annotate/route.rb

@@ -5,11 +5,17 @@ module AwesomeAnnotate
   class Route < Thor
     include Thor::Actions
 
+    def initialize(params = {})
+      super()
+      @env_file_path = Pathname.new(params[:env_file_path] || 'config/environment.rb')
+      @route_file_path = Pathname.new(params[:route_file_path] || 'config/routes.rb')
+    end
+
     desc 'annotate all routes', 'annotate your routes'
     def annotate
-      abort "Rails application path is required" unless env_file_path.exist?
+      raise "Rails application path is required" unless @env_file_path.exist?
 
-      apply env_file_path.to_s
+      apply @env_file_path.to_s
 
       inspector = ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes)
       formatter = ActionDispatch::Routing::ConsoleFormatter::Sheet.new
@@ -17,20 +23,14 @@ module AwesomeAnnotate
       routes = inspector.format(formatter, {})
       route_message = parse_routes(routes)
 
-      insert_file_before_class(route_file_path, route_message)
+      raise "Route file not found" unless @route_file_path.exist?
 
-      say "annotate routes in #{route_file_path}"
-    end
+      insert_file_before_class(@route_file_path, route_message)
 
-    private
-
-    def env_file_path
-      Pathname.new('config/environment.rb')
+      say "annotate routes in #{@route_file_path}"
     end
 
-    def route_file_path
-      Pathname.new('config/routes.rb')
-    end
+    private
 
     def parse_routes(routes)
       split_routes = routes.split(/\r\n|\r|\n/)

data/lib/awesome_annotate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_annotate
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - wisdom-plus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-09-03 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
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rspec_status"
 - ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt
@@ -56,6 +57,7 @@ files:
 - exe/awesome_annotate
 - lib/awesome_annotate.rb
 - lib/awesome_annotate/cli.rb
+- lib/awesome_annotate/error.rb
 - lib/awesome_annotate/model.rb
 - lib/awesome_annotate/route.rb
 - lib/awesome_annotate/version.rb