rpdoc 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd4a2fdf6339f7ab5a963d52ad2ccc3950e7edcca3ffbd7882be39e995d1014
-  data.tar.gz: 228c44ebef79a9852e08a736935c9334cb4cd1e8decca079ff5b38c18fa70cee
+  metadata.gz: 6aa96c76973dbdc52d2bf391d6cd1dd9561be44290e83b7a1b81cf02a067f36a
+  data.tar.gz: 0f93b3d7646b53be728867ce218acc78e7672bae09ae8075657311aa5f43d517
 SHA512:
-  metadata.gz: e8480e75031c7dadda942348f6ec22799ac217ea78202aea5c53131ff67298e83d25d7cb5b4430eb3c6b870e2c4362650023c0883efe8b152eb673fd2ed2ea4d
-  data.tar.gz: 792babfa02d6b6a54b52f42124b3e519bad2ee2c9a63b197073dfa075ede8a1e50523d4e9334af1b5776d5ba64ed97e737878b960449f31415c7873d7506f2db
+  metadata.gz: 79ed1646334c6d66e9a144fbe7f3a7212c94184486b0237e162278ad7a89ce1a7699e6b787aa0861083579bcb277cf27a202f0bb4321e2561f38b2724156a00d
+  data.tar.gz: 1d52b4c71c8188b9e51e07cdbf05a31b26231aa0f0af712b496d89b8c0ce494e50c96f8c5636a0b43dc03685e1cec7d90d183ddfb577e00918d49047ead3e488

data/.gitlab-ci.yml

@@ -4,7 +4,7 @@ stages:
 
 rspec:
   stage: rspec
-  image: ruby:3.0.2
+  image: ruby:3.2.1
   script:
     - bundle install
     - RPDOC_ENABLE=false rspec spec -fd
@@ -13,7 +13,7 @@ rspec:
 
 to_gem:
   stage: publish
-  image: ruby:3.0.2
+  image: ruby:3.2.1
   script:
     - mkdir -p ~/.gem
     - touch ~/.gem/credentials

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.1.14] - 2023-02-09
+- Fix File object method `exists` has been removed error at Ruby 3.2.1.
+    - [Removed deprecated Dir.exists? and File.exists?](https://github.com/ruby/ruby/commit/bf97415c02b11a8949f715431aca9eeb6311add2)   
+- Add the notice at README.md
+
+## [0.1.13] - 2022-10-03
+- Clean empty folders by default
+
 ## [0.1.12] - 2022-09-06
 - Handle encoding error
 

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    rpdoc (0.1.11)
+    rpdoc (0.1.14)
       json_requester (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionpack (6.1.7)
+      actionview (= 6.1.7)
+      activesupport (= 6.1.7)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionview (6.1.7)
+      activesupport (= 6.1.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.4.1)
+    activesupport (6.1.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -29,83 +29,88 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
-    diff-lcs (1.4.4)
-    erubi (1.10.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    diff-lcs (1.5.0)
+    erubi (1.11.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
-    i18n (1.8.10)
+    faraday-net_http (3.0.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json_requester (1.0.7)
+    json (2.6.2)
+    json_requester (1.0.8)
       faraday (>= 1.0.0)
-    loofah (2.12.0)
+    loofah (2.19.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    minitest (5.14.4)
-    nokogiri (1.12.5-x86_64-darwin)
+    minitest (5.16.3)
+    nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    railties (6.1.7)
+      actionpack (= 6.1.7)
+      activesupport (= 6.1.7)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.22.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+    thor (1.2.1)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.1)
 
 PLATFORMS
+  arm64-darwin-20
   x86_64-darwin-19
 
 DEPENDENCIES
@@ -116,4 +121,4 @@ DEPENDENCIES
   rubocop (~> 1.0)
 
 BUNDLED WITH
-   2.2.32
+   2.3.4

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Kdan Mobile Software Ltd
+Copyright (c) 2023 Kdan Mobile Software Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -72,6 +72,10 @@ Rpdoc.configure do |config|
   # (Optional) Auto push collection to Postman server or not.
   config.rpdoc_auto_push = false
 
+  # (Optional) Clean empty folders. You can specify folder names which will be ignored when cleaning.
+  config.rpdoc_clean_empty_folders = true
+  config.rpdoc_clean_empty_folders_except = []
+
   # (Optional) Auto push strategy, including :push_and_create and :push_and_update
   config.rpdoc_auto_push_strategy = :push_and_create
 end
@@ -128,6 +132,20 @@ end
 
 4. You can write description for your Postman collection by creating markdown files (named `description.md`) and putting each of them in corresponding location under `rpdoc` folder.
 
+## Notice
+
+If you try to mock the `File.open` method, generating collection data will fail because creating `request.json` use the `File.open` method.
+
+Solution:
+
+You can add code in RSpec.
+
+```ruby
+after(:each) do
+ allow(File).to receive(:open).and_call_original
+end
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION.md

@@ -1 +1 @@
-0.1.12
+0.1.14

data/lib/generators/templates/initializer.rb

@@ -35,6 +35,10 @@ Rpdoc.configure do |config|
   # (Optional) Filename to store RSpec collection json data.
   # config.rpdoc_collection_filename = 'collection.json'
 
+  # (Optional) Clean empty folders. You can specify folder names which will be ignored when cleaning.
+  # config.rpdoc_clean_empty_folders = true
+  # config.rpdoc_clean_empty_folders_except = []
+
   # (Optional) Auto push collection to Postman server or not.
   # config.rpdoc_auto_push = false
 

data/lib/rpdoc/configuration.rb

@@ -19,6 +19,8 @@ module Rpdoc
       :rpdoc_request_filename,
       :rpdoc_description_filename,
       :rpdoc_collection_filename,
+      :rpdoc_clean_empty_folders,
+      :rpdoc_clean_empty_folders_except,
       :rpdoc_auto_push,
       :rpdoc_auto_push_strategy
 
@@ -41,6 +43,10 @@ module Rpdoc
       @rpdoc_request_filename = 'request.json'
       @rpdoc_description_filename = 'description.md'
       @rpdoc_collection_filename = 'collection.json'
+
+      @rpdoc_clean_empty_folders = true
+      @rpdoc_clean_empty_folders_except = []
+
       @rpdoc_auto_push = false
       @rpdoc_auto_push_strategy = :push_and_create # or :push_and_update
     end

data/lib/rpdoc/helper.rb

@@ -6,7 +6,7 @@ RSpec.configure do |config|
     root = Rpdoc.configuration.rpdoc_root
     if Rpdoc.configuration.rpdoc_enable
       raise StandardError.new('Configuration Invalid') unless Rpdoc.configuration.valid?
-      FileUtils.mkdir_p(root) unless File.exists?(root)
+      FileUtils.mkdir_p(root) unless File.exist?(root)
       Dir.glob("#{root}/**/*.json") do |filename|
         File.delete(filename)
       end

data/lib/rpdoc/postman_collection.rb

@@ -10,6 +10,7 @@ module Rpdoc
       @requester = JsonRequester.new(@configuration.postman_host)
 
       @data = generated_collection_data
+      clean_empty_folders_from(@data[:collection][:item])
     end
 
     def push_and_create
@@ -29,6 +30,7 @@ module Rpdoc
       remote_collection_data = remote_collection_data['status'] == 200 ? remote_collection_data.deep_symbolize_keys.slice(:collection) : nil
       
       merged_by(remote_collection_data)
+      clean_empty_folders_from(remote_collection_data[:collection][:item])
       @requester.http_send(:put, path, remote_collection_data, headers)
     end
 
@@ -94,7 +96,7 @@ module Rpdoc
         if item.has_key?(:item)
           clean_generated_responses_from(item[:item])
         elsif item.has_key?(:response)
-          item[:response] = item[:response].reject do |response|
+          item[:response].reject! do |response|
             response.dig(:header)&.pluck(:key)&.include?('RSpec-Location')
           end
         end
@@ -130,5 +132,15 @@ module Rpdoc
         end
       end
     end
+
+    def clean_empty_folders_from(collection_items)
+      return unless @configuration.rpdoc_clean_empty_folders
+      collection_items.reject! do |item|
+        next false if item.has_key?(:request)
+        next false if @configuration.rpdoc_clean_empty_folders_except.include?(item[:name])
+        clean_empty_folders_from(item[:item]) if item[:item].present?
+        item[:item].nil? || item[:item].empty?
+      end
+    end
   end
 end

data/lib/rpdoc/postman_response.rb

@@ -18,10 +18,10 @@ module Rpdoc
     def save
       root_path ||= @configuration.rpdoc_root
       folder_path = "#{root_path}/#{@rspec_example.metadata[:rpdoc_example_folders].join('/')}/#{@rspec_example.metadata[:rpdoc_action_key]}"
-      FileUtils.mkdir_p(folder_path) unless File.exists?(folder_path)
+      FileUtils.mkdir_p(folder_path) unless File.exist?(folder_path)
 
       request_file_path = "#{folder_path}/#{@configuration.rpdoc_request_filename}"
-      File.open(request_file_path, 'w+') { |f| f.write(JSON.pretty_generate(request_data)) } unless File.exists?(request_file_path)
+      File.open(request_file_path, 'w+') { |f| f.write(JSON.pretty_generate(request_data)) } unless File.exist?(request_file_path)
 
       response_file_path = "#{folder_path}/#{@rspec_example.metadata[:rpdoc_example_key]}.json"
       File.open(response_file_path, 'w+') { |f| f.write(JSON.pretty_generate(response_data)) }
@@ -45,7 +45,7 @@ module Rpdoc
         originalRequest: original_request_data,
         status: @rspec_response.status.to_s,
         code: @rspec_response.code.to_i,
-        _postman_previewlanguage: "json",
+        _postman_previewlanguage: 'json',
         header: headers,
       }
       if @rspec_response.headers['Content-Type'].include?('application/json')

data/lib/rpdoc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rpdoc
-  VERSION = "0.1.12"
+  VERSION = "0.1.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - yuntai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_requester
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: RSpec to Postman Documentation Tool