pry-doc 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9077dff28bd218f1f4117a66f95247af9ec057e39ede41f2a7c8bb347b48985d
-  data.tar.gz: 89dd99ad4846ccc4af2edaf49beed86dc8a713d649c880e291a639c6f8a6c1a3
+  metadata.gz: 69b6b1ec10073c3ad15fbf42ce809ca717c0678c852f36dd75e1babc7045bb6f
+  data.tar.gz: f42809c0a103acb458fd604a62770ee25d397b1b6a0d33d5248eab878fc01406
 SHA512:
-  metadata.gz: e6edf0a18e6edd4a0714d1f69475369db2ffb4d264d8338fe1b26f207772de4588e15e9768b853d1eb62f845ace69442b5c271af110b976029ff3a33f5907740
-  data.tar.gz: d896b20e0e163aaf2714f1031c69d2c63e30826deb47dd740c439b2e7e14f7b4e57007dd6b896df512e6309a55186858be749c5dcb431124905555179eacce0d
+  metadata.gz: 9a74bbf760a3eb9661674e8dd863ddcdbd7474e7f8e34f5040709e9795bc9c3783507058b22382a44ecf954ae2d8b19f9f378ba66afadb4ae0ca7ecb32657362
+  data.tar.gz: '084dc6e19185ef377607d066ec036301fe7bd90d238ff76ab07647b8ea5bac4e25967a66930df8f0f47df49186dfa4c4a44c1f949d5b2c210b893d1cb267be29'

data/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: pry-doc
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Update package list
+        run: sudo apt-get update
+
+      - name: Install cURL Headers
+        run: sudo apt-get install libcurl4 libcurl4-openssl-dev
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Install Bundler dependencies
+        run: bundle install
+
+      - name: Display Ruby version
+        run: ruby -v
+
+      - name: Unit tests
+        run: bundle exec rake

data/.gitignore

@@ -12,3 +12,5 @@ sample.bundle
 
 .bundle/
 vendor/bundle/
+
+rubies

data/CHANGELOG.md

@@ -3,6 +3,22 @@ Pry Doc changelog
 
 ### master
 
+### [v1.4.0][v1.4.0] (January 4, 2022)
+
+* Added Ruby 3.2 support ([#126](https://github.com/pry/pry-doc/pull/126))
+
+### [v1.3.0][v1.3.0] (January 12, 2022)
+
+* Added Ruby 3.1 support ([#120](https://github.com/pry/pry-doc/pull/120))
+
+### [v1.2.0][v1.2.0] (March 2, 2021)
+
+* Added Ruby 3.0 support ([#107](https://github.com/pry/pry-doc/pull/107))
+* Fixed the `_pry_ is deprecated, use pry_instance instead` deprecation warning
+  ([#111](https://github.com/pry/pry-doc/pull/111))
+
+### [v1.1.0][v1.1.0] (March 28, 2020)
+
 * Added Ruby 2.7 support ([#94](https://github.com/pry/pry-doc/pull/94))
 * Improved Ruby 2.7 suport for certain methods
   ([#100](https://github.com/pry/pry-doc/pull/100))
@@ -106,3 +122,6 @@ Pry Doc changelog
 [v0.13.5]: https://github.com/pry/pry-doc/releases/tag/v0.13.5
 [v1.0.0]: https://github.com/pry/pry-doc/releases/tag/v1.0.0
 [v1.1.0]: https://github.com/pry/pry-doc/releases/tag/v1.1.0
+[v1.2.0]: https://github.com/pry/pry-doc/releases/tag/v1.2.0
+[v1.3.0]: https://github.com/pry/pry-doc/releases/tag/v1.3.0
+[v1.4.0]: https://github.com/pry/pry-doc/releases/tag/v1.4.0

data/README.md

@@ -1,6 +1,6 @@
 ![Pry Doc][logo]
 
-[![Circle Build Status](https://circleci.com/gh/pry/pry-doc.svg?style=shield)](https://circleci.com/gh/pry/pry-doc)
+[![pry-doc](https://github.com/pry/pry-doc/actions/workflows/test.yml/badge.svg)](https://github.com/pry/pry-doc/actions/workflows/test.yml)
 
 * Repository: [https://github.com/pry/pry-doc][repo]
 * Wiki: [https://github.com/pry/pry-doc/wiki][wiki]
@@ -14,11 +14,13 @@ for Pry.
 Installation
 ------------
 
-All you need is to install the gem. The `pry-doc` plugin will be detected and
-used automatically.
+Install the gem using the below command.
 
     gem install pry-doc
 
+To automatically load `pry-doc` upon starting `pry`, add the command `require 'pry-doc'` to your `pryrc`.
+You can read more about it in Pry's [README file][pry-overview].
+
 Synopsis
 --------
 
@@ -55,6 +57,7 @@ The project uses the MIT License. See LICENSE file for more information.
 
 [logo]: http://img-fotki.yandex.ru/get/6724/98991937.13/0_9faaa_26ec83af_orig "Pry Doc"
 [pry]: https://github.com/pry/pry
+[pry-overview]: https://github.com/pry/pry#overview
 [show-source]: http://img-fotki.yandex.ru/get/9303/98991937.13/0_9faac_aa86e189_orig "show-source extended by Pry Doc"
 [show-doc]: http://img-fotki.yandex.ru/get/9058/98991937.13/0_9faab_68d7a43a_orig "show-doc extended by Pry Doc"
 [repo]: https://github.com/pry/pry-doc

data/Rakefile

@@ -85,7 +85,7 @@ def generate_yard
 end
 
 def replace_existing_docs(ver)
-  system %|mkdir -p ../../../lib/pry-doc/docs/#{ver} && cp -r .yardoc/* "$_"|
+  system %|mkdir -p ../../../lib/pry-doc/docs/#{ver} && cp -r .yardoc/* ../../../lib/pry-doc/docs/#{ver}|
   Dir.chdir(File.expand_path(File.dirname(__FILE__)))
 end
 
@@ -141,3 +141,18 @@ desc "Generate the latest Ruby 2.7 docs"
 task "gen27" do
   generate_docs_for('27', Latest.ruby27)
 end
+
+desc "Generate the latest Ruby 3.0 docs"
+task "gen30" do
+  generate_docs_for('30', Latest.ruby30)
+end
+
+desc "Generate the latest Ruby 3.1 docs"
+task "gen31" do
+  generate_docs_for('31', Latest.ruby31)
+end
+
+desc "Generate the latest Ruby 3.2 docs"
+task "gen32" do
+  generate_docs_for('32', Latest.ruby32)
+end