rpdoc 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e98e37b15d40a4b7598356183e181e1ee734b155cbc32871ef58484ad0d686c5
-  data.tar.gz: 2cbe2c73a33ac5020b3803892227bb7a3302328a6b20ce9117b331c3df180efe
+  metadata.gz: a1aefef23fd434bcdaf54e5f5410fff34ae86c53a4d3f2a795b06554311c2f67
+  data.tar.gz: bc37d48a0756e244f275412494db34ebd500462346c5956dfed39868f843b707
 SHA512:
-  metadata.gz: 189f8019f4e991a5751ffc4ce591db7b4d6d13eaf3084a13a329af990f1611fff6f8512b66dbdbe8effeb6cb69d1e8a883d3a3ce1e1d84aaa54764db4d0d42b0
-  data.tar.gz: 4dd0cc776f8c175cd2a239d4fe2f72f2bb3e3466b6073aec96f3bcc37f740c1a03db9e503f3a9230a3f490fb249bbf7af390015bfc77a37ef69a6abd2d602dba
+  metadata.gz: 4a1e38d33361a4934dc65176d65bca4a2c8fc872da02c7a1daf82c515c34043e6514682c7aa0975c2480a2076268b74ff14e33e4a3613d8d9a9e99613f9c5c1b
+  data.tar.gz: a0777048f84cfde4a0bfd6ce6c3d8d161f80c0f9280900dda449c34c6eb7317730afc171e3665fa64f9e3cc77121907dc84a28979154624923269632041aeb24

data/.gitlab/issue_templates/Default.md

@@ -0,0 +1,9 @@
+### Deployment Note
+> 1. Release sequence
+> 2. Pre-step (e.g., take care db:migrate step)
+> 3. Post-step (e.g., some rake needs to run)
+
+### Related
+>  External link for reference. (e.g., Redmine)
+* url_link
+* end

data/.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,9 @@
+### Description
+> Anything you want to explain to another developer for helpful code review.
+
+
+### Reviewers
+
+@reviewers
+
+Closes `gitlab issue link`

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,12 @@
+## [0.1.15] - 2023-05-18
+- Add gitlab templates.
+- Update gemspec.
+
+## [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
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpdoc (0.1.13)
+    rpdoc (0.1.14)
       json_requester (~> 1.0)
 
 GEM
@@ -47,6 +47,8 @@ GEM
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     minitest (5.16.3)
+    nokogiri (1.13.8-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
@@ -108,6 +110,7 @@ GEM
     zeitwerk (2.6.1)
 
 PLATFORMS
+  arm64-darwin-20
   x86_64-darwin-19
 
 DEPENDENCIES
@@ -118,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

@@ -132,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.13
+0.1.15

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_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)) }

data/lib/rpdoc/version.rb

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

data/rpdoc.gemspec

@@ -13,6 +13,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/kdan-mobile-software-ltd/rpdoc"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/kdan-mobile-software-ltd/rpdoc",
+    "changelog_uri" => "https://github.com/kdan-mobile-software-ltd/rpdoc/blob/master/CHANGELOG.md"
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - yuntai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_requester
@@ -90,6 +90,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/.keep"
+- ".gitlab/issue_templates/.keep"
+- ".gitlab/issue_templates/Default.md"
+- ".gitlab/merge_request_templates/.keep"
+- ".gitlab/merge_request_templates/Default.md"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -113,7 +118,9 @@ files:
 homepage: https://github.com/kdan-mobile-software-ltd/rpdoc
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/kdan-mobile-software-ltd/rpdoc
+  changelog_uri: https://github.com/kdan-mobile-software-ltd/rpdoc/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -129,7 +136,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