apipie-rails 0.9.4 → 1.0.0

data/CHANGELOG.md

@@ -4,24 +4,35 @@
 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.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)
+* Take into account validator options for `required` ParamDescription [#863](https://github.com/Apipie/apipie-rails/pull/863) (Panos Dalitsouris)
+* Replace `get_resource_name` with `get_resource_id` [#864](https://github.com/Apipie/apipie-rails/pull/864) (Panos Dalitsouris)
+* Namespace swagger configuration [#862](https://github.com/Apipie/apipie-rails/pull/862) (Panos Dalitsouris)
+* Allow boolean array `[true, false]` to be a valid argument for BooleanValidator [#848](https://github.com/Apipie/apipie-rails/pull/848) (Panos Dalitsouris)
+* Fix swagger warnings [#865](https://github.com/Apipie/apipie-rails/pull/865) (Panos Dalitsouris)
+* Update README - Adds the new Integer option you added recently to the documentation here. [#866](https://github.com/Apipie/apipie-rails/pull/866) (Jeremy Lupoli)
+* [Rubocop] More Rubocop Auto corrections [#859](https://github.com/Apipie/apipie-rails/pull/859)
+
 ## [v0.9.4](https://github.com/Apipie/apipie-rails/tree/v0.9.4) (2023-04-11)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.3...v0.9.4)
-* [Fix] Separate nested resource name [#855](https://github.com/Apipie/apipie-rails/pull/855)[#455](https://github.com/Apipie/apipie-rails/issues/455) (Panos Dalitsouris)
-* [Rubocop] Disable a few Rubocop Rules, run Rubocop with ruby 3.2 [#851](https://github.com/Apipie/apipie-rails/pull/851)[#853](https://github.com/Apipie/apipie-rails/pull/853)[#840](https://github.com/Apipie/apipie-rails/pull/840)[#841](https://github.com/Apipie/apipie-rails/pull/841) (Panos Dalitsouris)
-* [Rubocop] More Rubocop Auto corrections [#858](https://github.com/Apipie/apipie-rails/pull/858)[#849](https://github.com/Apipie/apipie-rails/pull/849)[#850](https://github.com/Apipie/apipie-rails/pull/850)[#844](https://github.com/Apipie/apipie-rails/pull/844)[#846](https://github.com/Apipie/apipie-rails/pull/846)[#834](https://github.com/Apipie/apipie-rails/pull/834)[#847](https://github.com/Apipie/apipie-rails/pull/847) (Rubocop Challenger)
+* [Fix] Separate nested resource name [#855](https://github.com/Apipie/apipie-rails/pull/855), [#455](https://github.com/Apipie/apipie-rails/issues/455) (Panos Dalitsouris)
+* [Rubocop] Disable a few Rubocop Rules, run Rubocop with ruby 3.2 [#851](https://github.com/Apipie/apipie-rails/pull/851), [#853](https://github.com/Apipie/apipie-rails/pull/853), [#840](https://github.com/Apipie/apipie-rails/pull/840), [#841](https://github.com/Apipie/apipie-rails/pull/841) (Panos Dalitsouris)
+* [Rubocop] More Rubocop Auto corrections [#858](https://github.com/Apipie/apipie-rails/pull/858), [#849](https://github.com/Apipie/apipie-rails/pull/849), [#850](https://github.com/Apipie/apipie-rails/pull/850), [#844](https://github.com/Apipie/apipie-rails/pull/844), [#846](https://github.com/Apipie/apipie-rails/pull/846), [#834](https://github.com/Apipie/apipie-rails/pull/834), [#847](https://github.com/Apipie/apipie-rails/pull/847) (Rubocop Challenger)
 
 ## [v0.9.3](https://github.com/Apipie/apipie-rails/tree/v0.9.3) (2023-03-08)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.2...v0.9.3)
-* [Feature] Allow Apipie::ParamDescription to be marked as deprecated [#819](https://github.com/Apipie/apipie-rails/pull/819)[#811](https://github.com/Apipie/apipie-rails/pull/811) (Panos Dalitsouris)
+* [Feature] Allow Apipie::ParamDescription to be marked as deprecated [#819](https://github.com/Apipie/apipie-rails/pull/819), [#811](https://github.com/Apipie/apipie-rails/pull/811) (Panos Dalitsouris)
 * [Fix] Make html markup thread safe ([#822](https://github.com/Apipie/apipie-rails/issues/822)) (Adam Růžička)
 * [Feature] Allow action matcher strategy to be configured [#821](https://github.com/Apipie/apipie-rails/pull/821) (Panos Dalitsouris)
 * [CI] Run Rubocop when opening PR [#826](https://github.com/Apipie/apipie-rails/pull/826) (Panos Dalitsouris)
 * [CI] Green rubocop - Fix after rubocop challenger upgrade [#829](https://github.com/Apipie/apipie-rails/pull/829) (Mathieu Jobin)
-* [Rubocop] More Rubocop Auto corrections [#818](https://github.com/Apipie/apipie-rails/pull/818)[#825](https://github.com/Apipie/apipie-rails/pull/825)[#827](https://github.com/Apipie/apipie-rails/pull/827)[#837](https://github.com/Apipie/apipie-rails/pull/837)[#839](https://github.com/Apipie/apipie-rails/pull/839) (Rubocop Challenger)
+* [Rubocop] More Rubocop Auto corrections [#818](https://github.com/Apipie/apipie-rails/pull/818), [#825](https://github.com/Apipie/apipie-rails/pull/825), [#827](https://github.com/Apipie/apipie-rails/pull/827), [#837](https://github.com/Apipie/apipie-rails/pull/837), [#839](https://github.com/Apipie/apipie-rails/pull/839) (Rubocop Challenger)
 
 ## [v0.9.2](https://github.com/Apipie/apipie-rails/tree/v0.9.2) (2023-02-07)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.1...v0.9.2)
-* [Rubocop] More Rubocop Auto corrections [#795](https://github.com/Apipie/apipie-rails/pull/795)[#781](https://github.com/Apipie/apipie-rails/pull/781)[#791](https://github.com/Apipie/apipie-rails/pull/791)[#788](https://github.com/Apipie/apipie-rails/pull/788) (Rubocop Challenger)
+* [Rubocop] More Rubocop Auto corrections [#795](https://github.com/Apipie/apipie-rails/pull/795), [#781](https://github.com/Apipie/apipie-rails/pull/781), [#791](https://github.com/Apipie/apipie-rails/pull/791), [#788](https://github.com/Apipie/apipie-rails/pull/788) (Rubocop Challenger)
 * [Fix] Can't include translation in full description ([#446](https://github.com/Apipie/apipie-rails/issues/446)) [#808](https://github.com/Apipie/apipie-rails/pull/808) (Peter Nagy)
 * [Refactor] Move swagger param description creation [#810](https://github.com/Apipie/apipie-rails/pull/810) (Panos Dalitsouris)
 * [Rubocop] Redo rubocop TODOs, set HashSyntax config to most used style [#814](https://github.com/Apipie/apipie-rails/pull/814) (Mathieu Jobin)

data/README.rst

@@ -1205,7 +1205,7 @@ after the ``apipie_validations`` before_action.
 
 TypeValidator
 -------------
-Check the parameter type. Only String, Hash and Array are supported
+Check the parameter type. Only String, Integer, Hash and Array are supported
 for the sake of simplicity. Read more to find out how to add
 your own validator.
 
@@ -1664,7 +1664,7 @@ Swagger-Specific Configuration Parameters
 
 There are several configuration parameters that determine the structure of the generated swagger file:
 
-``config.swagger_content_type_input``
+``config.generator.swagger.content_type_input``
     If the value is ``:form_data`` - the swagger file will indicate that the server consumes the content types
     ``application/x-www-form-urlencoded`` and ``multipart/form-data``.  Non-path parameters will have the
     value ``"in": "formData"``.  Note that parameters of type Hash that do not have any fields in them will *be ommitted*
@@ -1677,52 +1677,52 @@ There are several configuration parameters that determine the structure of the g
     You can specify the value of this configuration parameter as an additional input to the rake command (e.g.,
     ``rake apipie:static_swagger_json[2.0,form_data]``).
 
-``config.swagger_json_input_uses_refs``
-    This parameter is only relevant if ``swagger_content_type_input`` is ``:json``.
+``config.generator.swagger.json_input_uses_refs``
+    This parameter is only relevant if ``swagger.content_type_input`` is ``:json``.
 
     If ``true``: the schema of the ``"in": "body"`` parameter of each method is given its own entry in the ``definitions``
     section, and is referenced using ``$ref`` from the method definition.
 
     If ``false``: the body parameter definitions are inlined within the method definitions.
 
-``config.swagger_include_warning_tags``
+``config.generator.swagger.include_warning_tags``
     If ``true``: in addition to tagging methods with the name of the resource they belong to, methods for which warnings
     have been issued will be tagged with.
 
-``config.swagger_suppress_warnings``
+``config.generator.swagger.suppress_warnings``
     If ``false``: no warnings will be suppressed
 
     If ``true``: all warnings will be suppressed
 
     If an array of values (e.g., ``[100,102,107]``), only the warnings identified by the numbers in the array will be suppressed.
 
-``config.swagger_api_host``
+``config.generator.swagger.api_host``
     The value to place in the swagger host field.
 
     Default is ``localhost:3000``
 
     If ``nil`` then then host field will not be included.
 
-``config.swagger_allow_additional_properties_in_response``
+``config.generator.swagger.allow_additional_properties_in_response``
     If ``false`` (default):  response descriptions in the generated swagger will include an ``additional-properties: false``
     field
 
     If ``true``:  the ``additional-properties: false`` field will not be included in response object descriptions
 
-``config.swagger_schemes``
+``config.generator.swagger.schemes``
     An array of transport schemes that the API supports.
     This can include any combination of ``http``, ``https``, ``ws`` and ``wss``.
     By default to encourage good security practices, ``['https']`` is specified.
 
 
-``config:swagger_security_definitions``
+``config:swagger.security_definitions``
     If the API requires authentication, you can specify details of the authentication mechanisms supported as a (Hash) value here.
     See [https://swagger.io/docs/specification/2-0/authentication/] for details of what values can be specified
     By default, no security is defined.
 
-``config.swagger_global_security``
+``config.generator.swagger.global_security``
     If the API requires authentication, you can specify which of the authentication mechanisms are supported by all API operations as an Array of hashes here.
-    This should be used in conjunction with the mechanisms defined by ``swagger_security_definitions``.
+    This should be used in conjunction with the mechanisms defined by ``swagger.security_definitions``.
     See [https://swagger.io/docs/specification/2-0/authentication/] for details of what values can be specified
     By default, no security is defined.
 

data/app/controllers/apipie/apipies_controller.rb

@@ -39,12 +39,12 @@ module Apipie
         I18n.locale = @language
 
         if should_render_swagger
-          prev_warning_value = Apipie.configuration.swagger_suppress_warnings
+          prev_warning_value = Apipie.configuration.generator.swagger.suppress_warnings
           begin
-            Apipie.configuration.swagger_suppress_warnings = true
+            Apipie.configuration.generator.swagger.suppress_warnings = true
             @doc = Apipie.to_swagger_json(params[:version], params[:resource], params[:method], @language)
           ensure
-            Apipie.configuration.swagger_suppress_warnings = prev_warning_value
+            Apipie.configuration.generator.swagger.suppress_warnings = prev_warning_value
           end
         else
           @doc = Apipie.to_json(params[:version], params[:resource], params[:method], @language)
@@ -119,7 +119,7 @@ module Apipie
           authorize_resource(resource)
         end
       else
-        @doc[:docs][:resources].select do |_resource_name, resource|
+        @doc[:docs][:resources].select do |_resource_id, resource|
           authorize_resource(resource)
         end
       end

data/lib/apipie/apipie_module.rb

@@ -8,14 +8,14 @@ module Apipie
     @application ||= Apipie::Application.new
   end
 
-  def self.to_json(version = nil, resource_name = nil, method_name = nil, lang = nil)
+  def self.to_json(version = nil, resource_id = nil, method_name = nil, lang = nil)
     version ||= Apipie.configuration.default_version
-    app.to_json(version, resource_name, method_name, lang)
+    app.to_json(version, resource_id, method_name, lang)
   end
 
-  def self.to_swagger_json(version = nil, resource_name = nil, method_name = nil, lang = nil, clear_warnings = true)
+  def self.to_swagger_json(version = nil, resource_id = nil, method_name = nil, lang = nil, clear_warnings = true)
     version ||= Apipie.configuration.default_version
-    app.to_swagger_json(version, resource_name, method_name, lang, clear_warnings)
+    app.to_swagger_json(version, resource_id, method_name, lang, clear_warnings)
   end
 
   def self.json_schema_for_method_response(controller_name, method_name, return_code, allow_nulls)

data/lib/apipie/application.rb

@@ -25,10 +25,6 @@ module Apipie
       @resource_descriptions.keys.sort
     end
 
-    def set_resource_id(controller, resource_id)
-      @controller_to_resource_id[controller] = resource_id
-    end
-
     def rails_routes(route_set = nil, base_url = "")
       if route_set.nil? && @rails_routes
         return @rails_routes
@@ -83,8 +79,8 @@ module Apipie
       versions = controller_versions(controller) if versions.empty?
 
       versions.each do |version|
-        resource_name_with_version = "#{version}##{get_resource_name(controller)}"
-        resource_description = get_resource_description(resource_name_with_version)
+        resource_id_with_version = "#{version}##{get_resource_id(controller)}"
+        resource_description = get_resource_description(resource_id_with_version)
 
         if resource_description.nil?
           resource_description = define_resource_description(controller, version)
@@ -100,24 +96,24 @@ module Apipie
         resource_description.add_method_description(method_description)
       end
 
-      return ret_method_description
+      ret_method_description
     end
 
     # create new resource api description
     def define_resource_description(controller, version, dsl_data = nil)
       return if ignored?(controller)
 
-      resource_name = get_resource_name(controller)
-      resource_description = @resource_descriptions[version][resource_name]
+      resource_id = get_resource_id(controller)
+      resource_description = @resource_descriptions[version][resource_id]
       if resource_description
         # we already defined the description somewhere (probably in
         # some method. Updating just meta data from dsl
         resource_description.update_from_dsl_data(dsl_data) if dsl_data
       else
-        resource_description = Apipie::ResourceDescription.new(controller, resource_name, dsl_data, version)
+        resource_description = Apipie::ResourceDescription.new(controller, resource_id, dsl_data, version)
 
-        Apipie.debug("@resource_descriptions[#{version}][#{resource_name}] = #{resource_description}")
-        @resource_descriptions[version][resource_name] ||= resource_description
+        Apipie.debug("@resource_descriptions[#{version}][#{resource_id}] = #{resource_description}")
+        @resource_descriptions[version][resource_id] ||= resource_description
       end
 
       return resource_description
@@ -158,28 +154,28 @@ module Apipie
     #
     # There are two ways how this method can be used:
     # 1) Specify both parameters
-    #   resource_name:
+    #   resource_id:
     #       controller class - UsersController
     #       string with resource name (plural) and version - "v1#users"
     #   method_name: name of the method (string or symbol)
     #
     # 2) Specify only first parameter:
-    #   resource_name: string containing both resource and method name joined
+    #   resource_id: string containing both resource and method name joined
     #   with '#' symbol.
     #   - "users#create" get default version
     #   - "v2#users#create" get specific version
-    def get_method_description(resource_name, method_name = nil)
-      if resource_name.is_a?(String)
-        crumbs = resource_name.split('#')
+    def get_method_description(resource_id, method_name = nil)
+      if resource_id.is_a?(String)
+        crumbs = resource_id.split('#')
         if method_name.nil?
           method_name = crumbs.pop
         end
-        resource_name = crumbs.join("#")
-        resource_description = get_resource_description(resource_name)
-      elsif resource_name.respond_to? :apipie_resource_descriptions
-        resource_description = get_resource_description(resource_name)
+        resource_id = crumbs.join("#")
+        resource_description = get_resource_description(resource_id)
+      elsif resource_id.respond_to? :apipie_resource_descriptions
+        resource_description = get_resource_description(resource_id)
       else
-        raise ArgumentError.new("Resource #{resource_name} does not exists.")
+        raise ArgumentError.new("Resource #{resource_id} does not exists.")
       end
       resource_description&.method_description(method_name.to_sym)
     end
@@ -200,15 +196,15 @@ module Apipie
           return @resource_descriptions[version][crumbs.last]
         end
       else
-        resource_name = get_resource_name(resource)
+        resource_id = get_resource_id(resource)
         if version
-          resource_name = "#{version}##{resource_name}"
+          resource_id = "#{version}##{resource_id}"
         end
 
-        if resource_name.nil?
+        if resource_id.nil?
           return nil
         end
-        resource_description = get_resource_description(resource_name)
+        resource_description = get_resource_description(resource_id)
         if resource_description && resource_description.controller.to_s == resource.to_s
           return resource_description
         end
@@ -231,7 +227,7 @@ module Apipie
 
     def remove_method_description(resource, versions, method_name)
       versions.each do |version|
-        resource = get_resource_name(resource)
+        resource = resource_id(resource)
         if resource_description = get_resource_description("#{version}##{resource}")
           resource_description.remove_method_description(method_name)
         end
@@ -243,7 +239,6 @@ module Apipie
       @resource_descriptions = ActiveSupport::HashWithIndifferentAccess.new { |h, version| h[version] = {} }
       @controller_to_resource_id = {}
       @param_groups = {}
-      @swagger_generator = Apipie::SwaggerGenerator.new(self)
 
       # what versions does the controller belong in (specified by resource_description)?
       @controller_versions = Hash.new { |h, controller| h[controller.to_s] = [] }
@@ -261,36 +256,41 @@ module Apipie
     def json_schema_for_method_response(version, controller_name, method_name, return_code, allow_nulls)
       method = @resource_descriptions[version][controller_name].method_description(method_name)
       raise NoDocumentedMethod.new(controller_name, method_name) if method.nil?
-      @swagger_generator.json_schema_for_method_response(method, return_code, allow_nulls)
+
+      Apipie::SwaggerGenerator
+        .json_schema_for_method_response(method, return_code, allow_nulls)
     end
 
     def json_schema_for_self_describing_class(cls, allow_nulls)
-      @swagger_generator.json_schema_for_self_describing_class(cls, allow_nulls)
+      Apipie::SwaggerGenerator
+        .json_schema_for_self_describing_class(cls, allow_nulls)
     end
 
-    def to_swagger_json(version, resource_name, method_name, lang, clear_warnings = false)
-      return unless valid_search_args?(version, resource_name, method_name)
+    def to_swagger_json(version, resource_id, method_name, language, clear_warnings = false)
+      return unless valid_search_args?(version, resource_id, method_name)
 
-      # if resource_name is blank, take just resources which have some methods because
-      # we dont want to show eg ApplicationController as resource
-      # otherwise, take only the specified resource
-      _resources = resource_descriptions[version].inject({}) do |result, (k,v)|
-         if resource_name.blank?
-           result[k] = v unless v._methods.blank?
-         else
-           result[k] = v if k == resource_name
-         end
-         result
-       end
+      resources =
+        Apipie::Generator::Swagger::ResourceDescriptionsCollection
+        .new(resource_descriptions)
+        .filter(
+          resource_id: resource_id,
+          method_name: method_name,
+          version: version
+        )
 
-      @swagger_generator.generate_from_resources(version,_resources, method_name, lang, clear_warnings)
+      Apipie::SwaggerGenerator.generate_from_resources(
+        resources,
+        version: version,
+        language: language,
+        clear_warnings: clear_warnings
+      )
     end
 
-    def to_json(version, resource_name, method_name, lang)
+    def to_json(version, resource_id, method_name, lang)
 
-      return unless valid_search_args?(version, resource_name, method_name)
+      return unless valid_search_args?(version, resource_id, method_name)
 
-      _resources = if resource_name.blank?
+      _resources = if resource_id.blank?
         # take just resources which have some methods because
         # we dont want to show eg ApplicationController as resource
         resource_descriptions[version].inject({}) do |result, (k,v)|
@@ -298,7 +298,7 @@ module Apipie
           result
         end
       else
-        [@resource_descriptions[version][resource_name].to_json(method_name, lang)]
+        [@resource_descriptions[version][resource_id].to_json(method_name, lang)]
       end
 
       url_args = Apipie.configuration.version_in_url ? version : ''
@@ -368,7 +368,23 @@ module Apipie
       Apipie.configuration.validate? || ! Apipie.configuration.use_cache? || Apipie.configuration.force_dsl?
     end
 
+    # @deprecated Use {#get_resource_id} instead
     def get_resource_name(klass)
+      ActiveSupport::Deprecation.warn(
+        <<~HEREDOC
+          Apipie::Application.get_resource_name is deprecated.
+          Use `Apipie::Application.get_resource_id instead.
+        HEREDOC
+      )
+
+      get_resource_id(klass)
+    end
+
+    def set_resource_id(controller, resource_id)
+      @controller_to_resource_id[controller] = resource_id
+    end
+
+    def get_resource_id(klass)
       if klass.class == String
         klass
       elsif @controller_to_resource_id.key?(klass)
@@ -413,14 +429,14 @@ module Apipie
 
     private
 
-    # Make sure that the version/resource_name/method_name are valid combination
-    # resource_name and method_name can be nil
-    def valid_search_args?(version, resource_name, method_name)
+    # Make sure that the version/resource_id/method_name are valid combination
+    # resource_id and method_name can be nil
+    def valid_search_args?(version, resource_id, method_name)
       return false unless self.resource_descriptions.key?(version)
-      if resource_name
-        return false unless self.resource_descriptions[version].key?(resource_name)
+      if resource_id
+        return false unless self.resource_descriptions[version].key?(resource_id)
         if method_name
-          resource_description = self.resource_descriptions[version][resource_name]
+          resource_description = self.resource_descriptions[version][resource_id]
           return false unless resource_description.valid_method_name?(method_name)
         end
       end

data/lib/apipie/configuration.rb

@@ -1,5 +1,6 @@
 module Apipie
   class Configuration
+    extend Forwardable
 
     attr_accessor :app_name, :app_info, :copyright, :compress_examples,
       :markup, :disqus_shortname,
@@ -8,19 +9,21 @@ module Apipie
       :validate, :validate_value, :validate_presence, :validate_key, :action_on_non_validated_keys, :authenticate, :doc_path,
       :show_all_examples, :process_params, :update_checksum, :checksum_path,
       :link_extension, :record, :languages, :translate, :locale, :default_locale,
-      :persist_show_in_doc, :authorize, :ignore_allow_blank_false,
-      :swagger_include_warning_tags, :swagger_content_type_input, :swagger_json_input_uses_refs,
-      :swagger_suppress_warnings, :swagger_api_host, :swagger_generate_x_computed_id_field,
-      :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs,
-      :swagger_schemes, :swagger_security_definitions, :swagger_global_security
+      :persist_show_in_doc, :authorize, :ignore_allow_blank_false
+
+    def_delegators :swagger, *Apipie::Generator::Swagger::Config.deprecated_methods
+
+    def swagger
+      Apipie::Generator::Swagger::Config.instance
+    end
+
+    def generator
+      Apipie::Generator::Config.instance
+    end
 
     alias validate? validate
     alias required_by_default? required_by_default
     alias namespaced_resources? namespaced_resources
-    alias swagger_include_warning_tags? swagger_include_warning_tags
-    alias swagger_json_input_uses_refs? swagger_json_input_uses_refs
-    alias swagger_responses_use_refs? swagger_responses_use_refs
-    alias swagger_generate_x_computed_id_field? swagger_generate_x_computed_id_field
 
     # matcher to be used in Dir.glob to find controllers to be reloaded e.g.
     #
@@ -55,21 +58,22 @@ module Apipie
 
     def reload_controllers?
       @reload_controllers = Rails.env.development? unless defined? @reload_controllers
-      return @reload_controllers && @api_controllers_matcher
+
+      @reload_controllers && @api_controllers_matcher
     end
 
     def validate_value
-      return (validate? && @validate_value)
+      validate? && @validate_value
     end
     alias validate_value? validate_value
 
     def validate_presence
-      return (validate? && @validate_presence)
+      validate? && @validate_presence
     end
     alias validate_presence? validate_presence
 
     def validate_key
-      return (validate? && @validate_key)
+      validate? && @validate_key
     end
     alias validate_key? validate_key
 
@@ -77,7 +81,7 @@ module Apipie
       @process_params
     end
     # set to true if you want to use pregenerated documentation cache and avoid
-    # generating the documentation on runtime (usefull for production
+    # generating the documentation on runtime (useful for production
     # environment).
     # You can generate the cache by running
     #
@@ -109,7 +113,7 @@ module Apipie
     end
 
     # array of controller names (strings) (might include actions as well)
-    # to be ignored # when generationg the documentation
+    # to be ignored # when generating the documentation
     # e.g. %w[Api::CommentsController Api::PostsController#post]
     attr_writer :ignored
     def ignored
@@ -187,17 +191,6 @@ module Apipie
       @translate = lambda { |str, locale| str }
       @persist_show_in_doc = false
       @routes_formatter = RoutesFormatter.new
-      @swagger_content_type_input = :form_data  # this can be :json or :form_data
-      @swagger_json_input_uses_refs = false
-      @swagger_include_warning_tags = false
-      @swagger_suppress_warnings = false #[105,100,102]
-      @swagger_api_host = "localhost:3000"
-      @swagger_generate_x_computed_id_field = false
-      @swagger_allow_additional_properties_in_response = false
-      @swagger_responses_use_refs = true
-      @swagger_schemes = [:https]
-      @swagger_security_definitions = {}
-      @swagger_global_security = []
     end
   end
 end

data/lib/apipie/dsl_definition.rb

@@ -51,9 +51,6 @@ module Apipie
     end
 
     module Resource
-      # by default, the resource id is derived from controller_name
-      # it can be overwritten with.
-      #
       #    resource_id "my_own_resource_id"
       def resource_id(resource_id)
         Apipie.set_resource_id(@controller, resource_id)
@@ -529,8 +526,10 @@ module Apipie
       alias apipie_update_params apipie_update_methods
 
       def _apipie_concern_subst
-        @_apipie_concern_subst ||= {:controller_path => self.controller_path,
-                                    :resource_id => Apipie.get_resource_name(self)}
+        @_apipie_concern_subst ||= {
+          controller_path: self.controller_path,
+          resource_id: Apipie.get_resource_id(self)
+        }
       end
 
       def _apipie_perform_concern_subst(string)

data/lib/apipie/extractor/collector.rb

@@ -19,7 +19,7 @@ module Apipie
       def ignore_call?(record)
         return true unless record[:controller]
         return true if @ignored.include?(record[:controller].name)
-        return true if @ignored.include?("#{Apipie.get_resource_name(record[:controller].name)}##{record[:action]}")
+        return true if @ignored.include?("#{Apipie.resource_id(record[:controller].name)}##{record[:action]}")
         return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
       end
 
@@ -33,7 +33,7 @@ module Apipie
       end
 
       def add_to_records(record)
-        key = "#{Apipie.get_resource_name(record[:controller])}##{record[:action]}"
+        key = "#{Apipie.get_resource_id(record[:controller])}##{record[:action]}"
         @records[key] << record
       end
 

data/lib/apipie/extractor.rb

@@ -154,7 +154,7 @@ module Apipie
       def update_api_descriptions
         apis_from_docs = all_apis_from_docs
         @apis_from_routes.each do |(controller, action), new_apis|
-          method_key = "#{Apipie.get_resource_name(controller.safe_constantize || next)}##{action}"
+          method_key = "#{Apipie.get_resource_id(controller.safe_constantize || next)}##{action}"
           old_apis = apis_from_docs[method_key] || []
           new_apis.each do |new_api|
             new_api[:path]&.sub!(/\(\.:format\)$/,"")

data/lib/apipie/generator/config.rb

@@ -0,0 +1,12 @@
+module Apipie
+  module Generator
+    # Configuration interface for generators
+    class Config
+      include Singleton
+
+      def swagger
+        Apipie::Generator::Swagger::Config.instance
+      end
+    end
+  end
+end

data/lib/apipie/generator/swagger/computed_interface_id.rb

@@ -0,0 +1,23 @@
+# The {Apipie::Generator::Swagger::ComputedInterfaceId.id} is a number that is
+# uniquely derived from the list of operations added to the swagger definition (in an order-dependent way).
+# it can be used for regression testing, allowing some differentiation between changes that
+# result from changes to the input and those that result from changes to the generation
+# algorithms.
+#
+# @note At the moment, this only takes operation ids into account, and ignores
+# parameter definitions, so it's only partially useful.
+class Apipie::Generator::Swagger::ComputedInterfaceId
+  include Singleton
+
+  def initialize
+    @computed_interface_id = 0
+  end
+
+  def add!(operation_id)
+    @computed_interface_id = Zlib.crc32("#{@computed_interface_id} #{operation_id}")
+  end
+
+  def id
+    @computed_interface_id
+  end
+end