swaggard 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dd5439e8bfa3577b6585d2f5bc85eca2de86b7f41df02425f7d3083f97db6c4
-  data.tar.gz: 472f444aa3a5f99f0d6f867d55a80141a81848a24af6ca29366f979dfc8c4656
+  metadata.gz: 8f1057b0a7cf432113d8b58f3bb1857dd4f3fc72b2f916e7dd7342878b6f0192
+  data.tar.gz: 732909ca2cab511875bf16403f83d4f5a00e796ad211ce49e83dd5af96eceb4b
 SHA512:
-  metadata.gz: d7ccfd568ffde678cafae6be6b2551823d24ba2e3f2d5ecaf8f04231c14d271b25223c9dcaab12ab4dd97ac1b93d1490045f6b6812af662def8d3faf628443c0
-  data.tar.gz: 7c08c85b64918c6fe0806af1e224e0e3daeec20704f1617f65b21f8908bc79881d1a9ae01f4b25afe14efd7d7070bb97603a0523bbaf685724679f15b866998f
+  metadata.gz: 778991418f4c1640172aa9cb306070a5562b4cc1f9736b6f0bbed659e8a9f4c10d269dec050389cb8c4e8e8d480d164bc6f75fbf8b53a002bf057e55a1debe41
+  data.tar.gz: c1c8c9944b66ef1f736d1a323d3484aaab883f62fba843e5bcf442d0ff60fbb3fab728b367be25772e794def8f3c604bae7f64d66a3c1a8ba8dcf3de127c55f8

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.merge(Swaggard.configuration.definitions).map { |id, definition| [id, definition.to_doc(@definitions)] }]
       }
     end
 

data/lib/swaggard/configuration.rb

@@ -23,8 +23,6 @@ module Swaggard
                 :default_response_status_code, :excluded_paths, :path_parameter_description,
                 :ignore_put_if_patch_exists
 
-    attr_reader :custom_types
-
     def swagger_version
       @swagger_version ||= '2.0'
     end
@@ -149,6 +147,14 @@ module Swaggard
       custom_types[name] = definition
     end
 
+    def definitions
+      @definitions ||= {}
+    end
+
+    def add_definition(definition)
+      definitions[definition.id] = definition
+    end
+
     def path_parameter_description
       @path_parameter_description ||= ->(path_parameter) { "Scope response to #{path_parameter.name}" }
     end

data/lib/swaggard/engine.rb

@@ -1,19 +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] 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
-
 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/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 = Swaggard::Parsers::Property.run(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/parsers/property.rb

@@ -0,0 +1,21 @@
+require_relative '../swagger/property'
+
+module Swaggard
+  module Parsers
+    module Property
+      def self.run(yard_object)
+        name = yard_object.name.dup
+        options_and_description = yard_object.text&.dup || ''
+
+        options_and_description.gsub!("\n", ' ')
+        options, description = options_and_description.match(/\A(\[.*\])?(.*)\Z/).captures
+        options = options ? options.gsub(/\[?\]?\s?/, '').split(',') : []
+        description = description.strip
+        required = name.gsub!(/^!/, '')
+        type = Parsers::Type.run(yard_object.types.first)
+
+        Swaggard::Swagger::Property.new(name, type, description, required.present?, options)
+      end
+    end
+  end
+end

data/lib/swaggard/parsers/type.rb

@@ -0,0 +1,15 @@
+require_relative '../swagger/type'
+
+module Swaggard
+  module Parsers
+    module Type
+      def self.run(string)
+        parts = string.split(/[<>]/)
+        name = parts.last
+        is_array = parts.grep(/array/i).any?
+
+        Swaggard::Swagger::Type.new(name, is_array)
+      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

@@ -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/parameters/body.rb

@@ -1,11 +1,10 @@
 require_relative 'base'
-require_relative '../type'
+require_relative '../../parsers/type'
 
 module Swaggard
   module Swagger
     module Parameters
       class Body < Base
-
         attr_reader :definition
 
         def initialize(operation_name)
@@ -51,9 +50,7 @@ module Swaggard
 
         private
 
-
         class Property
-
           attr_reader :id
 
           def initialize(string)
@@ -83,13 +80,11 @@ module Swaggard
 
             @id = name
             @description = description if description.present?
-            @type = Type.new([data_type])
+            @type = Parsers::Type.run(data_type)
             @required = required
             @options = options
           end
-
         end
-
       end
     end
   end

data/lib/swaggard/swagger/parameters/query.rb

@@ -1,10 +1,10 @@
 require_relative 'base'
+require_relative '../../parsers/type'
 
 module Swaggard
   module Swagger
     module Parameters
       class Query < Base
-
         def initialize(string)
           @in = 'query'
           parse(string)
@@ -37,12 +37,11 @@ module Swaggard
 
           @name = name
           @description = description
-          @type = Type.new([data_type])
+          @type = Parsers::Type.run(data_type)
           @is_required = required.present?
           @allow_multiple = allow_multiple.present?
           @options = options
         end
-
       end
     end
   end

data/lib/swaggard/swagger/property.rb

@@ -3,23 +3,13 @@ require_relative 'type'
 module Swaggard
   module Swagger
     class Property
-
       attr_reader :id, :type, :description
 
-      def initialize(yard_object)
-        name = yard_object.name.dup
-        options_and_description = yard_object.text&.dup || ''
-
-        options_and_description.gsub!("\n", ' ')
-        options, description = options_and_description.match(/\A(\[.*\])?(.*)\Z/).captures
-        options = options ? options.gsub(/\[?\]?\s?/, '').split(',') : []
-        description = description.strip
-        required = name.gsub!(/^!/, '')
-
+      def initialize(name, type, description = '', required = false, options = [])
         @id = name
-        @type = Type.new(yard_object.types)
+        @type = type
         @description = description
-        @required = required.present?
+        @required = required
         @options = options
       end
 
@@ -33,7 +23,6 @@ module Swaggard
         result['enum'] = @options if @options.present?
         result
       end
-
     end
   end
 end

data/lib/swaggard/swagger/type.rb

@@ -12,14 +12,16 @@ module Swaggard
         'boolean'   => { 'type' => 'boolean' },
         'date'      => { 'type' => 'string',  'format' => 'date' },
         'date-time' => { 'type' => 'string',  'format' => 'date-time' },
+        'datetime'  => { 'type' => 'string',  'format' => 'date-time' },
         'password'  => { 'type' => 'string',  'format' => 'password' },
         'hash'      => { 'type' => 'object' }
       }
 
       attr_reader :name
 
-      def initialize(types)
-        parse(types)
+      def initialize(name, is_array = false)
+        @name = name.to_s
+        @is_array = is_array
       end
 
       def to_doc
@@ -32,14 +34,6 @@ module Swaggard
 
       private
 
-      def parse(types)
-        parts = types.first.split(/[<>]/)
-
-        @name = parts.last
-        @is_array = parts.grep(/array/i).any?
-      end
-
-
       def basic_type?
         BASIC_TYPES.has_key?(@name.downcase)
       end

data/lib/swaggard/version.rb

@@ -1,3 +1,3 @@
 module Swaggard
-  VERSION = '1.1.0'
+  VERSION = '1.3.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)
@@ -119,7 +120,6 @@ module Swaggard
 
         tags.each do |tag|
           @tags << [tag, operations]
-          # [tag.controller_class.controller_path] ||= { tag: tag, operations: operations }
         end
       end
 
@@ -136,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.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adrian Gomez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,7 +168,9 @@ files:
 - lib/swaggard/engine.rb
 - lib/swaggard/parsers/controller.rb
 - lib/swaggard/parsers/models.rb
+- lib/swaggard/parsers/property.rb
 - lib/swaggard/parsers/routes.rb
+- lib/swaggard/parsers/type.rb
 - lib/swaggard/swagger/definition.rb
 - lib/swaggard/swagger/operation.rb
 - lib/swaggard/swagger/parameters/base.rb
@@ -192,7 +194,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 +201,7 @@ homepage: https://github.com/adrian-gomez/swaggard
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,19 +216,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