yard-rails_plugin 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ee5828356df79f9af3841f7af240528c7492e282006ea6aadd898e722e5fc51
-  data.tar.gz: 233988e9b1e65313f07e71f7883cd3a95e054f7b9eca51e108d16945d29ff62f
+  metadata.gz: e88656913ac29d98c067db26b3947b6267ab4d5dc1a4b21a0985127604ab39ac
+  data.tar.gz: de9a523a1c980e8c1ffba286fcc702216a3be1906902121d65bb01da382a8026
 SHA512:
-  metadata.gz: 5259b1ea921d2edf76559a0e35d1d984361db8ccca868200490bafd057d16e419b1f25df3baf663db311396cc4abeb26437343458ec51b7d17ac597353de7c51
-  data.tar.gz: 047d79b8493048018b46f92a40223d9a24734ec15331b38a83b7672b9a0d2bc634fa6396aff1adb24e075af5b5436f8d0adb3875de891ab5f1cc87c1e9ab5a2e
+  metadata.gz: 4405d5d9d4969b61c1a4934b1de53b9d3d926c79410539e4172929869f2f5f8bb22c539f0ede99c005819f34aa9c316a3b2208d3da09f12e384cf7c29cca0279
+  data.tar.gz: 546a576c1ffe817254263c8c9e2b48f1e96b5562e909cedbedebd0f6fe55d61fc2d270b0476c0efccbde1cef4c5ebe3117b8211e3b4b1f28aa5c611f6a78a6b1

data/.rubocop.yml

@@ -0,0 +1,109 @@
+---
+AllCops:
+    Exclude:
+        - 'node_modules/**/*'
+        - 'tmp/**/*'
+        - 'vendor/**/*'
+        - '.git/**/*'
+        - 'db/schema.rb'
+        - 'db/data_schema.rb'
+        - 'db/data/*my*.rb'
+        - '**/*.rake'
+        - 'storage/**/*'
+        - '**/shims/**'
+        - '**.py'
+        - bin/**
+    NewCops: enable
+
+Layout/EndOfLine:
+    EnforcedStyle: lf
+Layout/EmptyLinesAroundAttributeAccessor:
+    Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+    Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+    Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+    Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+    Enabled: true
+Lint/MissingSuper:
+    Exclude:
+        - 'lib/creds.rb'
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+    Enabled: true
+Lint/PercentStringArray:
+    Exclude:
+        - 'config/initializers/secure_headers.rb'
+Lint/RaiseException:
+    Enabled: true
+Lint/StructNewOverride:
+    Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+    Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+    Enabled: true
+Metrics/AbcSize:
+    Enabled: false
+Metrics/ClassLength:
+  Exclude:
+    - "test/*/*"
+Metrics/MethodLength:
+    Enabled: false
+Metrics/BlockLength:
+    Exclude:
+        - 'config/initializers/secure_headers.rb'
+Style/AccessorGrouping:
+    Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+    Enabled: true
+Style/ArrayCoercion:
+    Enabled: true
+Style/BisectedAttrAccessor:
+    Enabled: true
+Style/CaseLikeIf:
+    Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+    Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+    Enabled: true
+Style/ExponentialNotation:
+    Enabled: true
+Style/HashAsLastArrayItem:
+    Enabled: true
+Style/HashLikeCase:
+    Enabled: true
+Style/HashEachMethods:
+    Enabled: true
+Style/HashTransformKeys:
+    Enabled: true
+Style/HashTransformValues:
+    Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+    Enabled: true
+Style/NilLambda: # (new in 1.3)
+    Enabled: true
+Style/RedundantAssignment:
+    Enabled: true
+Style/RedundantFetchBlock:
+    Enabled: true
+Style/RedundantFileExtensionInRequire:
+    Enabled: true
+Style/RedundantRegexpCharacterClass:
+    Enabled: true
+Style/RedundantRegexpEscape:
+    Enabled: true
+Style/RescueStandardError:
+    Enabled: true
+Style/SlicingWithRange:
+    Enabled: true
+Style/SwapValues: # (new in 1.1)
+    Enabled: true

data/lib/yard-rails_plugin/routes.rb

@@ -7,23 +7,24 @@ module YARD
     module Plugin
       # Handles Rails's route documentations
       class Routes
-        # rubocop:disable Metrics/AbcSize
-        # rubocop:disable Metrics/MethodLength
         def initialize
           puts '[rails-plugin] Analyzing Routes...'
           @routes = load_routes.collect do |route|
-            next if route[:path] =~ '/rails/info/properties|^/assets'
+            next if route.path.spec.to_s =~ %r{/rails/*|^/assets|^/cable}
 
             reqs = route.requirements.dup
 
-            return { name: route.name.to_s,
-                     verb: route.verb.to_s,
-                     path: route.path.spec.to_s,
-                     action: reqs[:action],
-                     controller: get_controller(reqs),
-                     rack_app: get_rack_app(route),
-                     constraints: get_constraints(reqs) }
+            next if reqs.blank?
+
+            { name: route.name.to_s,
+              verb: route.verb.to_s,
+              path: route.path.spec.to_s,
+              action: reqs[:action],
+              controller: get_controller(reqs),
+              rack_app: get_rack_app(route),
+              constraints: get_constraints(reqs) }
           end
+          @routes.compact!
         end
 
         def generate_routes_description_file(filename)
@@ -39,73 +40,74 @@ module YARD
                 <th>Endpoint</th>
                 <th>Destination</th>
               </tr>
-              <% i = 0;
-              @routes.each do |r|
-                odd_or_even = (i.even? ? 'even' : 'odd')
-                destination = if r[:rack_app]
-                  "<pre>#{r[:rack_app].inspect} #{r[:constraints]}</pre>"
-                else
-                  "{#{r[:controller]} #{r[:controller]}}##{r[:action]}  #{r[:constraints]}"
-                end
-                endpoint = r[:path].gsub(/(:|\*)\w+/) do |m|
-                  "<span style='font-family: monospace; color: green'>#{m}</span>"
-                end
-                i += 1
+              <% @routes.each_with_index do |r, i|
+                next if r == nil
               %>
-              <tr class='#{odd_or_even}'>
-                <td><%= r[:name]%></td>
-                <td><%= r[:verb]%></td>
-                <td><%= endpoint%></td>
-                <td><%= destination%></td>
-              </tr>"
+              <tr class='<%=(i.even? ? 'even' : 'odd')%>'>
+                <td><%= r[:name] %></td>
+                <td><%= r[:verb] %></td>
+                <td><%= r[:path].gsub(/(:|\*)\w+/) do |m|
+                  "<span style='font-family: monospace; color: green'>#{m}</span>"
+                end %></td>
+                <td><%= r[:rack_app].present? ? "<pre>#{r[:rack_app].inspect} #{r[:constraints]}</pre>" :
+                  "{#{r[:controller]} #{r[:controller]}}##{r[:action]}  #{r[:constraints]}" %></td>
+              </tr>
               <% end %>
               </table>
             </body>
-          </html>').gsub(/^  /, '')
+          </html>).gsub(/^\s+/, '')
           erb = ERB.new(template, trim_mode: '%<>')
 
-          File.write(File.join(Dir.pwd, filename), erb.result)
+          b = binding
+
+          File.write(
+            File.join(Dir.pwd, filename),
+            erb.result(b)
+          )
         end
-        # rubocop:enable Metrics/MethodLength
 
         def enrich_controllers
           @routes.each do |r|
             next unless r[:controller]
 
             node = YARD::Registry.resolve(nil, r[:controller], true)
+            next if node.nil?
+
             (node[:routes] ||= []) << r
 
             next unless r[:action]
 
             node = YARD::Registry.resolve(nil, "#{r[:controller]}##{r[:action]}", true)
+            next if node.nil?
+
             (node[:routes] ||= []) << r
           end
         end
-      end
 
-      private
+        private
 
-      def load_routes
-        ::Rails.application.reload_routes!
-        ::Rails.application.routes.routes
-      end
+        def load_routes
+          ::Rails.application.reload_routes!
+          ::Rails.application.routes.routes
+        end
 
-      def get_controller(reqs)
-        return unless reqs[:controller]
+        def get_controller(reqs)
+          return unless reqs[:controller]
 
-        "#{reqs[:controller].upcase.gsub('_', '').gsub('/', '::')}_Controller"
-      end
+          "#{reqs[:controller].camelize}Controller"
+        end
 
-      def get_constraints(reqs)
-        return unless reqs.except(:controller, :action).present?
+        def get_constraints(reqs)
+          return if reqs.except(:controller, :action).blank?
 
-        reqs.except(:controller, :action).inspect
-      end
+          reqs.except(:controller, :action).inspect
+        end
 
-      def get_rack_app(route)
-        return unless route.app.is_a?('ActionDispatch::Routing')
+        def get_rack_app(route)
+          return unless route.app.is_a?(ActionDispatch::Routing)
 
-        route.app.inspect
+          route.app.inspect
+        end
       end
     end
   end

data/lib/yard-rails_plugin/version.rb

@@ -3,7 +3,7 @@
 module YARD
   module Rails
     module Plugin
-      VERSION = '0.0.3'
+      VERSION = '0.1.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-rails_plugin
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Peter Nagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -68,6 +68,7 @@ files:
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - Gemfile
@@ -85,7 +86,7 @@ files:
 - templates/default/method_details/html/params.erb
 - templates/default/method_details/html/routes.erb
 - templates/default/method_details/setup.rb
-- yard-rails-plugin.gemspec
+- yard-rails_plugin.gemspec
 homepage: https://github.com/Meter-reader/yard-rails_plugin
 licenses:
 - MIT