swaggard 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3e1aa159808f0d01c9e6759727b97aff8a0cb4c383f441a3ca602e6b302da8b
-  data.tar.gz: 4f3b2511fbd15049e5e8746af31174705544a477b70cc0cbbe30d24563897ee7
+  metadata.gz: 7a49ea847a04d150e7b42923bf6a8290950f5fa18c53deba16907c36a59a664f
+  data.tar.gz: 3986acba75f1b962c13ca5b93ceb2f1481609f3516b5438689822d0916675952
 SHA512:
-  metadata.gz: 244da8fb5d6d234aab95d0b6e1b6bf13fd1dd7f519daf93aa2ff1f21dd05e2d0a886aa1e80f07ae7181d7541fc853b83bf5f711465976577cea725175bb0be36
-  data.tar.gz: c82e666367b0555c8d7de02f785c9045aa53c77c591855afa5e1c093f294c8b69cff7cbcc5a9eb70cdda1004f855cf149148fede20be4f4296515878855aa34c
+  metadata.gz: 3fd5f67a5c03861c8e78a77088f1aa4712a75d9fb251a2c1acb2e597f5609ae81b935d5ac090f5e49ae9dba7ab0a0ceb17be40a553ea183185d3fc88cf14c13f
+  data.tar.gz: db5042eb41674f3f85f94aa860743eed9861eb49d0bc44b9ed02bc36dcb578816552ff44dc2016a61bb01c5f90d71c0b3a31b23f55fd538d8b53403a9ac3cc85

data/README.md

@@ -11,6 +11,8 @@ the supported rails version.
 
 Swaggard Version | Swagger UI Version  | Supported Rails Versions
 ---------------- | ------------------- | ------------------------
+1.1.x            | 2.2.8               | 4 - 6
+1.0.x            | 2.2.8               | 4 - 5
 0.5.x            | 2.2.8               | 4 - 5
 0.4.x            | 2.2.8               | 4
 0.3.x            | 2.1.3               | 4
@@ -43,6 +45,13 @@ Mount your engine
 
 	mount Swaggard::Engine, at: '/api_docs/swagger/'
 
+Make sure the asset pipeline is enabled by either requiring all railties
+or just the sprockets one:
+
+    # config/application.rb
+    
+    require 'sprockets/railtie'
+
 Access your service documentation
 
 	open http://localhost:3000/api_docs/swagger/

data/config/initializers/assets.rb

@@ -1,5 +1,8 @@
-Rails.application.config.assets.precompile += %w[swaggard/application_print.css
-                                                 swaggard/favicon-32x32.png
-                                                 swaggard/favicon-16x16.png
-                                                 swaggard/lang/*.js
-                                                 swaggard/logo_small.png]
+if Rails::Application.instance_methods.include?(:assets_manifest)
+  Rails.application.config.assets.precompile += %w[swaggard/application_print.css
+                                                   swaggard/favicon-32x32.png
+                                                   swaggard/favicon-16x16.png
+                                                   swaggard/lang/*.js
+                                                   swaggard/logo_small.png]
+
+end

data/lib/swaggard/api_definition.rb

@@ -7,7 +7,7 @@ module Swaggard
     def initialize
       @paths        = {}
       @tags         = {}
-      @definitions  = []
+      @definitions  = {}
     end
 
     def add_tag(tag)
@@ -19,7 +19,7 @@ module Swaggard
     def add_operation(operation)
       @paths[operation.path] ||= Swagger::Path.new(operation.path)
       @paths[operation.path].add_operation(operation)
-      @definitions.concat(operation.definitions)
+      @definitions.merge!(operation.definitions)
     end
 
     def ignore_put_if_patch!
@@ -51,7 +51,7 @@ module Swaggard
         'produces'    => Swaggard.configuration.api_formats.map { |format| "application/#{format}" },
         'tags'        => @tags.map { |_, tag| tag.to_doc },
         'paths'       => Hash[@paths.values.map { |path| [format_path(path.path), path.to_doc] }],
-        'definitions' => Hash[@definitions.map { |definition| [definition.id, definition.to_doc] }]
+        'definitions' => Hash[@definitions.map { |id, definition| [id, definition.to_doc(@definitions)] }]
       }
     end
 

data/lib/swaggard/engine.rb

@@ -1,20 +1,23 @@
-unless Rails::Application.instance_methods.include?(:assets_manifest)
-  warn <<-END
-[Swaggard] It seems you are using an api only rails setup, but swaggard
-[Swaggard] neeeds sprockets in order to work so its going to require it.
-[Swaggard] This might have undesired side effects, if thats not  the case
-[Swaggard] you can ignore this warning.
-  END
-  require 'sprockets/railtie'
-end
-
 module Swaggard
   class Engine < ::Rails::Engine
     isolate_namespace Swaggard
 
+    def rake?
+      File.basename($PROGRAM_NAME) == 'rake'
+    end
+
     initializer 'swaggard.finisher_hook', after: :finisher_hook do |app|
       app.reload_routes!
 
+      if Rails.env.development? && !rake? && !app.methods.include?(:assets_manifest)
+        warn <<~END
+        [Swaggard] It seems you are using an api only rails setup, but swaggard
+        [Swaggard] web app needs sprockets in order to work. Make sure to add
+        [Swaggard] require 'sprockets/railtie'.
+        [Swaggard] If you plan to use it
+        END
+      end
+
       Swaggard.configure do |config|
         unless config.controllers_path
           config.controllers_path = "#{app.root}/app/controllers/**/*.rb"

data/lib/swaggard/parsers/controller.rb

@@ -4,23 +4,29 @@ require_relative '../swagger/tag'
 module Swaggard
   module Parsers
     class Controller
-
       def run(yard_objects)
-        tag = nil
+        tags = nil
         operations = {}
 
         yard_objects.each do |yard_object|
           if yard_object.type == :class
-            tag = Swagger::Tag.new(yard_object)
-          elsif tag && yard_object.type == :method
+            tags = get_tags(yard_object)
+          elsif tags && yard_object.type == :method
             name = yard_object.name
             operations[name.to_s] = yard_object
           end
         end
 
-        return tag, operations
+        return tags, operations
       end
 
+      private
+
+      def get_tags(yard_object)
+        tags = yard_object.tags.select { |tag| tag.tag_name == 'tag' }
+
+        tags.map { |tag| Swagger::Tag.new(yard_object, tag) }
+      end
     end
   end
 end

data/lib/swaggard/parsers/models.rb

@@ -6,24 +6,33 @@ module Swaggard
     class Models
 
       def run(yard_objects)
-        definitions = []
+        definitions = {}
 
         yard_objects.each do |yard_object|
-          next unless yard_object.type == :class
+          definition = parse_yard_object(yard_object)
 
-          definition = Swagger::Definition.new(yard_object.path)
+          definitions[definition.id] = definition if definition
+        end
+
+        definitions
+      end
 
+      def parse_yard_object(yard_object)
+        return unless yard_object.type == :class
+
+        Swagger::Definition.new(yard_object.path, ancestors: yard_object.inheritance_tree.map(&:path)).tap do |definition|
           yard_object.tags.each do |tag|
-            property = Swagger::Property.new(tag)
-            definition.add_property(property)
+            case tag.tag_name 
+            when 'attr'
+              property = Swagger::Property.new(tag)
+              definition.add_property(property)
+            when 'ignore_inherited'
+              definition.ignore_inherited = true
+            end
           end
-
-          definitions << definition
         end
-
-        definitions
       end
 
     end
   end
-end
+end

data/lib/swaggard/swagger/definition.rb

@@ -3,13 +3,15 @@ module Swaggard
     class Definition
 
       attr_reader :id
-      attr_writer :description, :title
+      attr_writer :description, :title, :ignore_inherited
 
-      def initialize(id)
+      def initialize(id, ancestors: [])
         @id = id
         @title = ''
         @properties = []
         @description = ''
+        @ancestors = ancestors
+        @ignore_inherited = false
       end
 
       def add_property(property)
@@ -20,15 +22,35 @@ module Swaggard
         @properties.empty?
       end
 
-      def to_doc
+      def properties(definitions)
+        inherited_properties(definitions)
+          .concat(@properties)
+          .uniq { |property| property.id }
+      end
+
+      def inherited_properties(definitions)
+        return [] if @ignore_inherited
+
+        @ancestors.flat_map do |ancestor|
+          definition = definitions[ancestor]
+
+          next unless definition && definition.id != id
+
+          definition.properties(definitions)
+        end.compact
+      end
+
+      def to_doc(definitions)
         {}.tap do |doc|
           doc['title'] = @title if @title.present?
           doc['type']  = 'object'
 
           doc['description'] = @description if @description.present?
 
-          doc['properties'] =  Hash[@properties.map { |property| [property.id, property.to_doc] }]
-          required_properties = @properties.select(&:required?).map(&:id)
+          all_properties = properties(definitions)
+
+          doc['properties'] =  Hash[all_properties.map { |property| [property.id, property.to_doc] }]
+          required_properties = all_properties.select(&:required?).map(&:id)
           doc['required'] = required_properties if required_properties.any?
         end
 

data/lib/swaggard/swagger/operation.rb

@@ -32,7 +32,7 @@ module Swaggard
 
           case yard_tag.tag_name
           when 'operation_id'
-            @operation_id = value
+            @operation_id = "#{@tag.name}.#{value}"
           when 'query_parameter'
             @parameters << Parameters::Query.new(value)
           when 'form_parameter'
@@ -92,8 +92,12 @@ module Swaggard
       end
 
       def definitions
-        @responses.map(&:definition).compact.tap do |definitions|
-          definitions << @body_parameter.definition if @body_parameter
+        @responses.map(&:definition).compact.inject({}) do |definitions, definition|
+          definitions[definition.id] = definition
+        end.tap do |definitions|
+          next unless @body_parameter
+
+          definitions[@body_parameter.definition.id] = @body_parameter.definition
         end
       end
 

data/lib/swaggard/swagger/tag.rb

@@ -1,20 +1,20 @@
 module Swaggard
   module Swagger
     class Tag
-
       attr_accessor :name, :description
 
-      attr_reader :controller_class
+      attr_reader :controller_class, :controller_name, :route
 
-      def initialize(yard_object)
+      def initialize(yard_object, tag)
         controller_name = "#{yard_object.namespace}::#{yard_object.name}"
 
         @yard_name = yard_object.name
         @controller_class = controller_name.constantize
-
-        tag = yard_object.tags.find { |tag| tag.tag_name == 'tag' }
+        @controller_name = controller_class.controller_path
 
         @name =  tag ? tag.text : "#{@controller_class.controller_path}"
+        @name, @route = @name.split(' ')
+
         @description = yard_object.docstring || ''
       end
 
@@ -24,7 +24,6 @@ module Swaggard
           'description' => @description
         }
       end
-
     end
   end
 end

data/lib/swaggard/version.rb

@@ -1,3 +1,3 @@
 module Swaggard
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
 end

data/lib/swaggard.rb

@@ -38,6 +38,7 @@ module Swaggard
       ::YARD::Tags::Library.define_tag('Response description', :response_description)
       ::YARD::Tags::Library.define_tag('Response example', :response_example)
       ::YARD::Tags::Library.define_tag('Response header', :response_header)
+      ::YARD::Tags::Library.define_tag('Ignore inherited attributes', :ignore_inherited)
     end
 
     def get_doc(host = nil)
@@ -61,21 +62,25 @@ module Swaggard
       @api.ignore_put_if_patch! if Swaggard.configuration.ignore_put_if_patch_exists
     end
 
+    def tag_matches?(tag, controller_name, path)
+      matches = tag.controller_name == controller_name
+
+      return matches unless tag.route.present?
+
+      matches && Regexp.new(tag.route).match?(path)
+    end
+
     def build_operation(path, verb, route)
       controller_name = route[:controller]
       action_name = route[:action]
 
-      return unless controllers[controller_name]
-
-      controller_tag = controllers[controller_name][:tag]
+      controller_tag, controller_operations = tags.find { |tag, _operations| tag_matches?(tag, controller_name, path) }
 
       return unless controller_tag
 
-      return unless controllers[controller_name][:operations]
-
-      return unless controllers[controller_name][:operations][action_name]
+      return unless controller_operations[action_name]
 
-      operation_yard_object = controllers[controller_name][:operations][action_name]
+      operation_yard_object = controller_operations[action_name]
 
       return unless operation_yard_object
 
@@ -100,23 +105,25 @@ module Swaggard
       end
     end
 
-    def controllers
-      return @controllers if @controllers
+    def tags
+      return @tags if @tags
 
       parser = Parsers::Controller.new
 
-      @controllers = {}
+      @tags = []
       Dir[configuration.controllers_path].each do |file|
         yard_objects = get_yard_objects(file)
 
-        tag, operations = parser.run(yard_objects)
+        tags, operations = parser.run(yard_objects)
 
-        next unless tag
+        next unless tags
 
-        @controllers[tag.controller_class.controller_path] ||= { tag: tag, operations: operations }
+        tags.each do |tag|
+          @tags << [tag, operations]
+        end
       end
 
-      @controllers
+      @tags
     end
 
     def routes
@@ -129,12 +136,12 @@ module Swaggard
     def parse_models
       parser = Parsers::Models.new
 
-      definitions =[]
+      definitions = {}
       configuration.models_paths.each do |path|
         Dir[path].each do |file|
           yard_objects = get_yard_objects(file)
 
-          definitions.concat(parser.run(yard_objects))
+          definitions.merge!(parser.run(yard_objects))
         end
 
         @api.definitions = definitions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Adrian Gomez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,6 @@ files:
 - spec/fixtures/dummy/config/application.rb
 - spec/fixtures/dummy/config/environments/development.rb
 - spec/fixtures/dummy/config/routes.rb
-- spec/fixtures/dummy/log/development.log
 - spec/fixtures/swagger_schema.json
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb
@@ -200,7 +199,7 @@ homepage: https://github.com/adrian-gomez/swaggard
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,19 +214,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: 'Swaggard: Swagger Rails REST API doc using yard YARD'
 test_files:
-- spec/spec_helper.rb
-- spec/integration/swaggard_spec.rb
-- spec/fixtures/swagger_schema.json
-- spec/fixtures/dummy/app/controllers/pets_controller.rb
-- spec/fixtures/dummy/app/controllers/application_controller.rb
+- spec/fixtures/api.json
 - spec/fixtures/dummy/app/controllers/admin/pets_controller.rb
-- spec/fixtures/dummy/config/routes.rb
-- spec/fixtures/dummy/config/environments/development.rb
+- spec/fixtures/dummy/app/controllers/application_controller.rb
+- spec/fixtures/dummy/app/controllers/pets_controller.rb
 - spec/fixtures/dummy/config/application.rb
-- spec/fixtures/dummy/log/development.log
-- spec/fixtures/api.json
+- spec/fixtures/dummy/config/environments/development.rb
+- spec/fixtures/dummy/config/routes.rb
+- spec/fixtures/swagger_schema.json
+- spec/integration/swaggard_spec.rb
+- spec/spec_helper.rb