rails-routes-prettier 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215b333061f883042ac0637f1fe843190ceacbd5de06b593bea8e66f772f6e2a
-  data.tar.gz: ea1de7273e437492e2ff3edb4a8a5af5295f230a815e07ff99425ee62869e744
+  metadata.gz: 405a6227c2f35a4232a4f2c5a5a85eef6d47002f41b538ce05a28e220e0e2501
+  data.tar.gz: f01a0ac7faf3ebe1906413a21418914d918e401d15dd9309832d09d0916de715
 SHA512:
-  metadata.gz: 30d06a490816c3acda127c4d28a7ce99492439074b9eff88de5d2e8cedd14aa52e70f55068fbce1024457770c77d39c388feda2a41426575ab8c7ac2f8d9529f
-  data.tar.gz: 4b3f9d8897635dfa8a95a4504b491b26f021db35776aa6901d4856e90ba81ea4026e544b47ba92e91a6b3fd98119271a178df4db3d0ab5f435221d7f1a0d03c4
+  metadata.gz: 2bd0a12417f08f5b356be8fc26273ad72598c3b2f0d5db2f237bf9ee3f48745b61e36d97b57a86135aa65ed445f8a83026a3a7fe3e35ecb61a6ccc1730bf6d9c
+  data.tar.gz: 4d52e9ee8397756b051559ad367c4135e945540c859aab20509dba81f362dc6d27b110c2396581ea304397e801da531b9a4d562bc2835649e1fc3042808ccd7f

data/README.md

@@ -27,7 +27,28 @@ gem install rails-routes-prettier
 
 ## Usage
 
-TODO: Write usage instructions here
+To view the routes in your application, you can use the following code:
+
+```ruby
+Rails::Routes::Prettier.all
+# => [#<Route name: 'root', verb: 'GET', path: '/', controller: 'SwaggerController', action: 'index' req_options: {}>, ...]
+```
+
+This will display all of the routes in your application in a clean and readable format. You can also search for routes by certain fields using the following methods:
+
+- `find_by_name`: Searches for routes by name.
+- `find_by_verb`: Searches for routes by HTTP verb.
+- `find_by_path`: Searches for routes by path.
+- `find_by_req_options`: Searches for routes by requirements options.
+- `find_by_controller`: Searches for routes by controller.
+- `find_by_action`: Searches for routes by action.
+
+For example, you can search for a route with the verb `GET` by using the following code:
+
+```ruby
+Rails::Routes::Prettier.find_by_verb('GET')
+# => [#<Route name: 'root', verb: 'GET', path: '/', controller: 'SwaggerController', action: 'index' req_options: {}>, ...]
+```
 
 ## Development
 

data/lib/rails/routes/prettier/formatter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Rails
+  module Routes
+    module Prettier
+      class Formatter
+        attr_reader :routes
+
+        def initialize
+          @routes = []
+        end
+
+        def section_title(title); end
+
+        def header(routes); end
+
+        def result
+          routes
+        end
+
+        def section(routes)
+          routes.map do |route|
+            @routes << Rails::Routes::Prettier::Objects::Route.new(route)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/routes/prettier/objects/route.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Rails
+  module Routes
+    module Prettier
+      module Objects
+        class Route
+          attr_reader :route
+
+          def initialize(route)
+            @route = route
+          end
+
+          def name
+            route[:name]
+          end
+
+          def verb
+            route[:verb]
+          end
+
+          def path
+            route[:path].gsub(/(\(\.:format\))$/, '')
+          end
+
+          def reqs
+            route[:reqs]
+          end
+
+          def controller
+            return nil if redirect? || custom_router? || basic_auth?
+
+            reqs.split('#').first.split('/').map(&:camelize).join('::').concat('Controller')
+          end
+
+          def action
+            return nil if redirect? || custom_router? || basic_auth?
+
+            reqs.split('#').last.split(' ').first
+          end
+
+          # rubocop:disable Security/Eval
+          def req_options
+            return {} if redirect? || basic_auth?
+
+            begin
+              eval(reqs.split("#{action} ").last)
+            rescue StandardError
+              {}
+            end
+          end
+          # rubocop:enable Security/Eval
+
+          def to_h
+            {
+              name: name,
+              verb: verb,
+              path: path,
+              controller: controller,
+              action: action,
+              req_options: req_options
+            }
+          end
+
+          def to_json(*_args)
+            to_h.to_json
+          end
+
+          # rubocop:disable Layout/LineLength
+          def to_s
+            "<Route name: '#{name}', verb: '#{verb}', path: '#{path}', controller: '#{controller}', action: '#{action}' req_options: #{req_options}>"
+          end
+          # rubocop:enable Layout/LineLength
+
+          def inspect
+            "##{self}"
+          end
+
+          def redirect?
+            reqs.match?(/redirect(.*,|.*$)/)
+          end
+
+          def basic_auth?
+            reqs.start_with?('#<Rack::Auth::Basic')
+          end
+
+          def custom_router?
+            reqs.start_with?('#<')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/routes/prettier/version.rb

@@ -3,7 +3,7 @@
 module Rails
   module Routes
     module Prettier
-      VERSION = '0.1.0'
+      VERSION = '1.0.0'
     end
   end
 end

data/lib/rails/routes/prettier.rb

@@ -1,12 +1,28 @@
 # frozen_string_literal: true
 
 require_relative 'prettier/version'
+require_relative 'prettier/objects/route'
+require_relative 'prettier/formatter'
+require 'rails'
 
 module Rails
   module Routes
     module Prettier
-      class Error < StandardError; end
-      # Your code goes here...
+      class << self
+        SEARCHABLE_FIELDS = %i[name verb path req_options controller action].freeze
+
+        def all
+          ActionDispatch::Routing::RoutesInspector.new(::Rails.application.routes.routes).format(
+            Rails::Routes::Prettier::Formatter.new, {}
+          )
+        end
+
+        SEARCHABLE_FIELDS.each do |field|
+          define_method :"find_by_#{field}" do |value|
+            all.select { |route| route.send(field) == value }
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-routes-prettier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - nejdetkadir
@@ -44,6 +44,8 @@ files:
 - README.md
 - Rakefile
 - lib/rails/routes/prettier.rb
+- lib/rails/routes/prettier/formatter.rb
+- lib/rails/routes/prettier/objects/route.rb
 - lib/rails/routes/prettier/version.rb
 - rails-routes-prettier.gemspec
 - sig/rails/routes/prettier.rbs