dox 2.0.0.beta3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d606ce8e741ff8f4844e0a0f2bff86cda870356417fb20254dad8030865f21
-  data.tar.gz: 3d57f29f50c860c4d5781e5990b398e984461d8b8239b3b82885d5df89fc8414
+  metadata.gz: c4cb190cdb908fc6f132913d43624c470ab3f495f8875fdf9b8fb311f7d9dc15
+  data.tar.gz: cd95ecb21307695857b2164834703c1cc2fcee8f2675721054fdde257f6b4fbf
 SHA512:
-  metadata.gz: 3c520ed0ca05c9b2eab780ef3feef96a937277912ad97e460ded62cd4dfa2c455675a937ccb299b8776140b6f38657aacc67c3430e6c3e0004f7e2af53a20da3
-  data.tar.gz: 7b288f580fa957a06764cc9d0df09c6fb6d914d43743b4fe58ee0666f614e96ad34cdf9a0f90069d5805fa7360e124f922d658d7c485811e5c9a3afe01ca7d3c
+  metadata.gz: 3c6f7b2b5497fca67e55b06fa037b0c677c4d6ec552fc117674f25b46bbb30aed430bf3290e951a2fa66b32a8280629953f341f8a3c62e76308be4145855ac0d
+  data.tar.gz: e8204b56a371f816da95cd240f52f04d30f6d46346111fb35ea393337c07ebdd9a3abe04190e52014613ec411efcaafcd31d2aeb094759a7b8fcf4e551b0708e

data/CHANGES.md

@@ -9,13 +9,14 @@ Change:
 - BREAKING CHANGE Base structure is now defined in .json format
 - BREAKING CHANGE Output is written to a .json file
 - BREAKING CHANGE Html is rendered with Redoc instead of Aglio
-- Renamed Dox.config.desc_folder_path -> Dox.config.descriptions_location
-- Depricated Dox.config.header_file_path
+- Renamed `Dox.config.desc_folder_path` -> `Dox.config.descriptions_location`
+- Depricated `Dox.config.header_file_path`
+- Removed `endpoint` method from document resource block
 
 New:
-- Added Dox.config.title
-- Added Dox.config.header_description
-- Added Dox.config.version
+- Added `Dox.config.title`
+- Added `Dox.config.header_description`
+- Added `Dox.config.version`
 
 ## Version 1.2.0
 

data/README.md

@@ -83,7 +83,6 @@ module Docs
       # define common resource data for each action
       document :api do
         resource 'Bids' do
-          endpoint '/bids'
           group 'Bids'
           desc 'bids.md'
         end
@@ -181,7 +180,6 @@ You can omit defining the resource group, if you don't have any description for
 #### Resource
 Resource contains actions and is defined with:
 - **name** (required)
-- **endpoint** (required)
 - **group** (required; to associate it with the related group)
 - desc (optional; inline string or relative filepath)
 
@@ -189,7 +187,6 @@ Example:
 ``` ruby
 document :bids do
   resource 'Bids' do
-    endpoint '/bids'
     group 'Bids'
     desc 'bids/bids.md'
   end
@@ -205,7 +202,6 @@ document :bids_common do
   end
 
   resource 'Bids' do
-    endpoint '/bids'
     group 'Bids'
     desc 'bids/bids.md'
   end

data/dox.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-rails'
   spec.add_development_dependency 'pry-stack_explorer'
   spec.add_runtime_dependency 'rails', '>= 4.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov'

data/lib/dox/config.rb

@@ -8,6 +8,7 @@ module Dox
     attr_accessor :api_version
     attr_accessor :title
     attr_accessor :header_description
+    attr_accessor :groups_order
     attr_reader :descriptions_location
 
     def descriptions_location=(folder_path)

data/lib/dox/dsl/resource.rb

@@ -16,7 +16,6 @@ module Dox
 
         raise(Dox::Errors::InvalidResourceError, 'Resource name is required!') if @name.blank?
         raise(Dox::Errors::InvalidResourceError, 'Resource group is required!') if @group.blank?
-        raise(Dox::Errors::InvalidResourceError, 'Resource endpoint is required!') if @endpoint.blank?
       end
 
       def config
@@ -24,7 +23,6 @@ module Dox
           resource_name: @name.presence,
           resource_desc: @desc.presence,
           resource_group_name: @group.presence,
-          resource_endpoint: @endpoint.presence,
           apidoc: true
         }
       end

data/lib/dox/entities/resource.rb

@@ -1,14 +1,13 @@
 module Dox
   module Entities
     class Resource
-      attr_reader :name, :desc, :endpoint, :group
+      attr_reader :name, :desc, :group
       attr_accessor :actions
 
       def initialize(details)
         @name = details[:resource_name]
         @group = details[:resource_group_name]
         @desc = details[:resource_desc]
-        @endpoint = details[:resource_endpoint]
         @actions = {}
       end
     end

data/lib/dox/printers/document_printer.rb

@@ -15,6 +15,8 @@ module Dox
           group_printer.print(resource_group)
         end
 
+        order_groups
+
         @output.puts(JSON.pretty_generate(spec))
       end
 
@@ -42,6 +44,14 @@ module Dox
       def group_printer
         @group_printer ||= ResourceGroupPrinter.new(spec)
       end
+
+      def order_groups
+        return if (Dox.config.groups_order || []).empty?
+
+        spec['x-tagGroups'] = spec['x-tagGroups'].sort_by do |tag|
+          Dox.config.groups_order.index(tag[:name]) || 100
+        end
+      end
     end
   end
 end

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '2.0.0.beta3'.freeze
+  VERSION = '2.0.0'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta3
+  version: 2.0.0
 platform: ruby
 authors:
 - Melita Kokot
 - Vedran Hrnčić
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,16 +113,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - melita.kokot@gmail.com
 - vrabac266@gmail.com
@@ -241,7 +241,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -252,13 +252,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Generates API documentation for rspec in OpenAPI format.
 test_files: []