apipie-rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822d52cddc54c458cc7449d9f881a68ee6766811d740cbc0a6d717f4760b8896
-  data.tar.gz: 37a6bd59c3e1fac91dbcb8ef34078caa28c19b9e27bcad872d70796096dfc67f
+  metadata.gz: 5beee9e3a891140602d1c9a962c9229cbeb60d7e289a95d62a48bfea39b396a9
+  data.tar.gz: 6f096bb6648692ceaa7a05fa095051a26c4bd176e062bf2ad794a9f3b5438261
 SHA512:
-  metadata.gz: a16332ce330bd90cc3a12bc57b5904bc7e66cd0f21dd66fd497903a139fb826c7e4e796fbdf440bb17c48427755d3cd66e548660e3e8a4a549dd8b97f5205db4
-  data.tar.gz: 1ac7735265214806b2beb8d7414c18915a8de995bf55339c93124f5247833284a30d566517ce71266718da3a237769d48c1a02bc1f6d5b11a893908bcc33f4d8
+  metadata.gz: 27f57c84d3b692d40b84ee01740b960d10c9951bdf0e45d936079cd7dc0fac899a0ac90ccd229db6a164549c7238de6bb515f8102b7624342c406a775ee7cbfa
+  data.tar.gz: 4ee73961d9417cfa623d9d84b5dbf7a8afdfcd19afa86f43b72b807dce374a79b456c3c041d953cb5a31d3b5bb5ba4926ccfd6b2d751ee61e36e21fd0ec83776

data/CHANGELOG.md

@@ -4,6 +4,13 @@
 Also deleted the `Gemfile` that was now a broken symlink.
 please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
 
+## [v1.1.0](https://github.com/Apipie/apipie-rails/tree/v1.1.0) (2023-05-16)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.0.0...v1.1.0)
+* Improve performance of route detection [#870](https://github.com/Apipie/apipie-rails/pull/870) (Eric Hankins)
+* Fix startup crash due to typo [#869](https://github.com/Apipie/apipie-rails/pull/869) (Eric Hankins)
+* Skip parse body for pdf responses [#871](https://github.com/Apipie/apipie-rails/pull/871) (Juan Gomez)
+* add missing 'returns' translation [#868](https://github.com/Apipie/apipie-rails/pull/868) (Anthony Robertson)
+
 ## [v1.0.0](https://github.com/Apipie/apipie-rails/tree/v1.0.0) (2023-04-26)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.4...v1.0.0)
 * Refactor Swagger generator [#816](https://github.com/Apipie/apipie-rails/pull/816) (Panos Dalitsouris)

data/config/locales/en.yml

@@ -30,6 +30,7 @@ en:
     headers: Headers
     header_name: Header name
     code: Code
+    returns: Returns
     deprecated: Deprecated
     deprecation_details: Deprecation details
     deprecation:

data/lib/apipie/application.rb

@@ -26,14 +26,13 @@ module Apipie
     end
 
     def rails_routes(route_set = nil, base_url = "")
-      if route_set.nil? && @rails_routes
-        return @rails_routes
-      end
+      return @_rails_routes if route_set.nil? && @_rails_routes
+
       route_set ||= Rails.application.routes
       # ensure routes are loaded
       Rails.application.reload_routes! unless Rails.application.routes.routes.any?
 
-      flatten_routes = []
+      flattened_routes = []
 
       route_set.routes.each do |route|
         # route is_a ActionDispatch::Journey::Route
@@ -42,30 +41,30 @@ module Apipie
         route_app = route.app.app
         if route_app.respond_to?(:routes) && route_app.routes.is_a?(ActionDispatch::Routing::RouteSet)
           # recursively go though the mounted engines
-          flatten_routes.concat(rails_routes(route_app.routes, File.join(base_url, route.path.spec.to_s)))
+          flattened_routes.concat(rails_routes(route_app.routes, File.join(base_url, route.path.spec.to_s)))
         else
           route.base_url = base_url
-          flatten_routes << route
+          flattened_routes << route
         end
       end
 
-      @rails_routes = flatten_routes
+      @_rails_routes = flattened_routes
     end
 
-    # the app might be nested when using contraints, namespaces etc.
-    # this method does in depth search for the route controller
-    def route_app_controller(app, route, visited_apps = [])
-      if route.defaults[:controller]
-        controller_name = "#{route.defaults[:controller]}_controller".camelize
-        controller_name.safe_constantize
+    def rails_routes_by_controller_and_action
+      @_rails_routes_by_controller_and_action = rails_routes.group_by do |route|
+        requirements = route.requirements
+        [requirements[:controller], requirements[:action]]
       end
     end
 
+    def clear_cached_routes!
+      @_rails_routes = nil
+      @_rails_routes_by_controller_and_action = nil
+    end
+
     def routes_for_action(controller, method, args)
-      routes = rails_routes.select do |route|
-        controller == route_app_controller(route.app, route) &&
-            method.to_s == route.defaults[:action]
-      end
+      routes = rails_routes_by_controller_and_action[[controller.name.underscore.chomp('_controller'), method.to_s]] || []
 
       Apipie.configuration.routes_formatter.format_routes(routes, args)
     end
@@ -227,7 +226,7 @@ module Apipie
 
     def remove_method_description(resource, versions, method_name)
       versions.each do |version|
-        resource = resource_id(resource)
+        resource = get_resource_id(resource)
         if resource_description = get_resource_description("#{version}##{resource}")
           resource_description.remove_method_description(method_name)
         end
@@ -482,6 +481,7 @@ module Apipie
     # as this would break loading of the controllers.
     def rails_mark_classes_for_reload
       unless Rails.application.config.cache_classes
+        clear_cached_routes!
         Rails.application.reloader.reload!
         init_env
         reload_examples

data/lib/apipie/extractor/recorder.rb

@@ -48,7 +48,9 @@ module Apipie
         else
           @query = request.query_string
         end
-        @response_data = parse_data(response.body)
+        if response.content_type != 'application/pdf'
+          @response_data = parse_data(response.body)
+        end
         @code = response.code
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/dummy/app/controllers/api/v2/architectures_controller.rb

@@ -22,7 +22,8 @@ module Api
       def update
       end
 
-      api :DELETE, "/architecturess/:id/", "Delete an architecture."
+      api! "Delete an architecture."
+      api_version "2.0" # forces removal of the method description
       def destroy
       end
     end

data/spec/dummy/config/routes.rb

@@ -45,6 +45,12 @@ Dummy::Application.routes.draw do
       get "/pets/returns_response_with_valid_array" => "pets#returns_response_with_valid_array"
       get "/pets/returns_response_with_invalid_array" => "pets#returns_response_with_invalid_array"
       get "/pets/undocumented_method" => "pets#undocumented_method"
+
+      # generate 1000 routes for testing performance of route matching used by api! method
+      # it's okay that these don't go anywhere real
+      1000.times do |i|
+        get "/api/v1/pets/#{i}" => "pets#{i}#show"
+      end
     end
 
     apipie

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack