rspec-api-docs 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eee6ccdbceb3b61271298301b471e3d09a9b7edb
-  data.tar.gz: 8a1e3b753359755cde4ca89586ffd5f3163d3d4e
+  metadata.gz: 921c43cbac7e32c779901db4a5519ad6b5fefbc0
+  data.tar.gz: 68cb6ae49fbf805cb4786ef8494a9466693ea143
 SHA512:
-  metadata.gz: 97555c1200f96e8370b333fc9ff86e5ffb011a782fa51aab4231d74527d1e0d21484bad7326233b7248c3cedb816fc29e1fdc91d851704810ea2a07216e2c98c
-  data.tar.gz: 6f93f8c19a225543f023a737e52a0ac8c6829c7fd62d97ed8f62b8c3e21d5697599e7594f73f41e51e3d5b8be6e15bad7ed1f57ef6be23899577b81fedb44cc5
+  metadata.gz: 97c817ca345c1a021d701fea14a7881ff58f6b57f283ae413067287ff0b0dc7ebc46b9e8fd08761c79f84437b9a4e071b4a02a5f4154178740df3d064fec50ca
+  data.tar.gz: f3ce3df2074ed3032314b78d2c1ec6cdd27f8fccbf31cee4431f98032662bfba8b693cdd8408496de1b3e155e7b082bdbc85de4750e5cdaae66ab63e80fec004

data/lib/rspec_api_docs/after.rb

@@ -5,7 +5,7 @@ require 'rspec_api_docs/after/type_checker'
 module RspecApiDocs
   UndocumentedParameter = Class.new(BaseError)
 
-  class After
+  module After
     Hook = -> (example) do
       metadata = example.metadata[METADATA_NAMESPACE]
       return unless metadata

data/lib/rspec_api_docs/after/type_checker.rb

@@ -1,5 +1,5 @@
 module RspecApiDocs
-  class After
+  module After
     class TypeChecker
       UnknownType = Class.new(BaseError)
       TypeError = Class.new(BaseError)

data/lib/rspec_api_docs/formatter.rb

@@ -1,6 +1,7 @@
 require 'rspec/core/formatters/base_formatter'
 
 require 'rspec_api_docs'
+require 'rspec_api_docs/resource_collection'
 require 'rspec_api_docs/formatter/resource'
 require 'rspec_api_docs/formatter/renderer/json_renderer'
 require 'rspec_api_docs/formatter/renderer/raddocs_renderer'
@@ -18,10 +19,10 @@ module RspecApiDocs
   class Formatter < RSpec::Core::Formatters::BaseFormatter
     RSpec::Core::Formatters.register self, :example_passed, :close
 
-    attr_reader :resources
+    attr_reader :renderer
 
-    def initialize(*args)
-      @resources = {}
+    def initialize(*args, renderer: default_renderer)
+      @renderer = renderer
       super args
     end
 
@@ -31,21 +32,23 @@ module RspecApiDocs
     def example_passed(example_notification)
       rspec_example = example_notification.example
       return unless rspec_example.metadata[METADATA_NAMESPACE]
-      resource = Resource.new(rspec_example)
-      resources[resource.name] ||= resource
-      resources[resource.name].add_example Resource::Example.new(rspec_example)
+      resource_collection.add_example(rspec_example)
     end
 
     # Calls the configured renderer with the stored {Resource}s.
     #
     # @return [void]
     def close(null_notification)
-      renderer.new(resources.values.sort_by { |resource| [resource.precedence, resource.name].join }).render
+      renderer.new(resource_collection.all).render
     end
 
     private
 
-    def renderer
+    def resource_collection
+      @resource_collection ||= ResourceCollection.new
+    end
+
+    def default_renderer
       value = RspecApiDocs.configuration.renderer
 
       case value

data/lib/rspec_api_docs/formatter/resource.rb

@@ -4,6 +4,8 @@ require 'rspec_api_docs/formatter/resource/response_field'
 
 module RspecApiDocs
   class Resource
+    MAX_PRECEDENCE = 9_999
+
     attr_reader :rspec_example
 
     def initialize(rspec_example)
@@ -17,7 +19,7 @@ module RspecApiDocs
     #
     # @return [String]
     def name
-      metadata.fetch(:resource_name, rspec_example.metadata[:example_group][:description])
+      metadata.fetch(:resource_name) { rspec_example.metadata[:example_group][:description] }
     end
 
     # The description of the resource.
@@ -33,7 +35,7 @@ module RspecApiDocs
     #
     # @return [Array<Example>]
     def examples
-      @examples.sort_by { |example| [example.precedence, example.name].join }
+      @examples.sort_by { |example| [example.precedence, example.name] }
     end
 
     # Add an example
@@ -43,9 +45,16 @@ module RspecApiDocs
       @examples << example
     end
 
-    # @return [String, nil]
+    # @return [Integer]
     def precedence
-      metadata[:resource_precedence]
+      @precedence ||= metadata.fetch(:resource_precedence, MAX_PRECEDENCE)
+    end
+
+    # Set the resource precedence
+    #
+    # @return [void]
+    def precedence=(value)
+      @precedence = value
     end
 
     def inspect

data/lib/rspec_api_docs/formatter/resource/example.rb

@@ -4,6 +4,8 @@ require 'rspec_api_docs/formatter/resource/example/deep_hash_set'
 module RspecApiDocs
   class Resource
     class Example
+      MAX_PRECEDENCE = 9_999
+
       attr_reader :example
 
       def initialize(example)
@@ -90,13 +92,13 @@ module RspecApiDocs
         metadata.fetch(:note, {})
       end
 
-      # @return [String, nil]
+      # @return [Integer]
       def precedence
-        metadata[:example_precedence]
+        metadata.fetch(:example_precedence, MAX_PRECEDENCE)
       end
 
       def inspect
-        "#<RspecApiDocs::Resource::Example #{name.inspect}>"
+        "#<RspecApiDocs::Resource::Example #{name.inspect}, precedence: #{precedence.inspect}>"
       end
 
       private

data/lib/rspec_api_docs/resource_collection.rb

@@ -0,0 +1,25 @@
+module RspecApiDocs
+  class ResourceCollection
+    def initialize(resources = {})
+      @resources = resources
+    end
+
+    def all
+      @resources.values.sort_by { |resource| [resource.precedence, resource.name] }
+    end
+
+    def add_example(rspec_example)
+      resource = Resource.new(rspec_example)
+
+      existing_resource = @resources[resource.name]
+      if existing_resource
+        existing_resource.precedence = [existing_resource.precedence, resource.precedence].min
+        resource = existing_resource
+      else
+        @resources[resource.name] = resource
+      end
+
+      resource.add_example Resource::Example.new(rspec_example)
+    end
+  end
+end

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-docs
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - lib/rspec_api_docs/formatter/resource/parameter.rb
 - lib/rspec_api_docs/formatter/resource/response_field.rb
 - lib/rspec_api_docs/rake_task.rb
+- lib/rspec_api_docs/resource_collection.rb
 - lib/rspec_api_docs/version.rb
 - rspec-api-docs.gemspec
 homepage: https://github.com/twe4ked