pry-doc 1.1.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9077dff28bd218f1f4117a66f95247af9ec057e39ede41f2a7c8bb347b48985d
4
- data.tar.gz: 89dd99ad4846ccc4af2edaf49beed86dc8a713d649c880e291a639c6f8a6c1a3
3
+ metadata.gz: 69b6b1ec10073c3ad15fbf42ce809ca717c0678c852f36dd75e1babc7045bb6f
4
+ data.tar.gz: f42809c0a103acb458fd604a62770ee25d397b1b6a0d33d5248eab878fc01406
5
5
  SHA512:
6
- metadata.gz: e6edf0a18e6edd4a0714d1f69475369db2ffb4d264d8338fe1b26f207772de4588e15e9768b853d1eb62f845ace69442b5c271af110b976029ff3a33f5907740
7
- data.tar.gz: d896b20e0e163aaf2714f1031c69d2c63e30826deb47dd740c439b2e7e14f7b4e57007dd6b896df512e6309a55186858be749c5dcb431124905555179eacce0d
6
+ metadata.gz: 9a74bbf760a3eb9661674e8dd863ddcdbd7474e7f8e34f5040709e9795bc9c3783507058b22382a44ecf954ae2d8b19f9f378ba66afadb4ae0ca7ecb32657362
7
+ data.tar.gz: '084dc6e19185ef377607d066ec036301fe7bd90d238ff76ab07647b8ea5bac4e25967a66930df8f0f47df49186dfa4c4a44c1f949d5b2c210b893d1cb267be29'
@@ -0,0 +1,38 @@
1
+ name: pry-doc
2
+
3
+ on: [push]
4
+
5
+ permissions:
6
+ contents: read
7
+
8
+ jobs:
9
+ test:
10
+ strategy:
11
+ matrix:
12
+ os: [ubuntu-latest]
13
+ ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2]
14
+
15
+ runs-on: ${{ matrix.os }}
16
+
17
+ steps:
18
+ - uses: actions/checkout@v3
19
+
20
+ - name: Update package list
21
+ run: sudo apt-get update
22
+
23
+ - name: Install cURL Headers
24
+ run: sudo apt-get install libcurl4 libcurl4-openssl-dev
25
+
26
+ - uses: ruby/setup-ruby@v1
27
+ with:
28
+ ruby-version: ${{ matrix.ruby }}
29
+ bundler-cache: true
30
+
31
+ - name: Install Bundler dependencies
32
+ run: bundle install
33
+
34
+ - name: Display Ruby version
35
+ run: ruby -v
36
+
37
+ - name: Unit tests
38
+ run: bundle exec rake
data/.gitignore CHANGED
@@ -12,3 +12,5 @@ sample.bundle
12
12
 
13
13
  .bundle/
14
14
  vendor/bundle/
15
+
16
+ rubies
data/CHANGELOG.md CHANGED
@@ -3,6 +3,22 @@ Pry Doc changelog
3
3
 
4
4
  ### master
5
5
 
6
+ ### [v1.4.0][v1.4.0] (January 4, 2022)
7
+
8
+ * Added Ruby 3.2 support ([#126](https://github.com/pry/pry-doc/pull/126))
9
+
10
+ ### [v1.3.0][v1.3.0] (January 12, 2022)
11
+
12
+ * Added Ruby 3.1 support ([#120](https://github.com/pry/pry-doc/pull/120))
13
+
14
+ ### [v1.2.0][v1.2.0] (March 2, 2021)
15
+
16
+ * Added Ruby 3.0 support ([#107](https://github.com/pry/pry-doc/pull/107))
17
+ * Fixed the `_pry_ is deprecated, use pry_instance instead` deprecation warning
18
+ ([#111](https://github.com/pry/pry-doc/pull/111))
19
+
20
+ ### [v1.1.0][v1.1.0] (March 28, 2020)
21
+
6
22
  * Added Ruby 2.7 support ([#94](https://github.com/pry/pry-doc/pull/94))
7
23
  * Improved Ruby 2.7 suport for certain methods
8
24
  ([#100](https://github.com/pry/pry-doc/pull/100))
@@ -106,3 +122,6 @@ Pry Doc changelog
106
122
  [v0.13.5]: https://github.com/pry/pry-doc/releases/tag/v0.13.5
107
123
  [v1.0.0]: https://github.com/pry/pry-doc/releases/tag/v1.0.0
108
124
  [v1.1.0]: https://github.com/pry/pry-doc/releases/tag/v1.1.0
125
+ [v1.2.0]: https://github.com/pry/pry-doc/releases/tag/v1.2.0
126
+ [v1.3.0]: https://github.com/pry/pry-doc/releases/tag/v1.3.0
127
+ [v1.4.0]: https://github.com/pry/pry-doc/releases/tag/v1.4.0
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  ![Pry Doc][logo]
2
2
 
3
- [![Circle Build Status](https://circleci.com/gh/pry/pry-doc.svg?style=shield)](https://circleci.com/gh/pry/pry-doc)
3
+ [![pry-doc](https://github.com/pry/pry-doc/actions/workflows/test.yml/badge.svg)](https://github.com/pry/pry-doc/actions/workflows/test.yml)
4
4
 
5
5
  * Repository: [https://github.com/pry/pry-doc][repo]
6
6
  * Wiki: [https://github.com/pry/pry-doc/wiki][wiki]
@@ -14,11 +14,13 @@ for Pry.
14
14
  Installation
15
15
  ------------
16
16
 
17
- All you need is to install the gem. The `pry-doc` plugin will be detected and
18
- used automatically.
17
+ Install the gem using the below command.
19
18
 
20
19
  gem install pry-doc
21
20
 
21
+ To automatically load `pry-doc` upon starting `pry`, add the command `require 'pry-doc'` to your `pryrc`.
22
+ You can read more about it in Pry's [README file][pry-overview].
23
+
22
24
  Synopsis
23
25
  --------
24
26
 
@@ -55,6 +57,7 @@ The project uses the MIT License. See LICENSE file for more information.
55
57
 
56
58
  [logo]: http://img-fotki.yandex.ru/get/6724/98991937.13/0_9faaa_26ec83af_orig "Pry Doc"
57
59
  [pry]: https://github.com/pry/pry
60
+ [pry-overview]: https://github.com/pry/pry#overview
58
61
  [show-source]: http://img-fotki.yandex.ru/get/9303/98991937.13/0_9faac_aa86e189_orig "show-source extended by Pry Doc"
59
62
  [show-doc]: http://img-fotki.yandex.ru/get/9058/98991937.13/0_9faab_68d7a43a_orig "show-doc extended by Pry Doc"
60
63
  [repo]: https://github.com/pry/pry-doc
data/Rakefile CHANGED
@@ -85,7 +85,7 @@ def generate_yard
85
85
  end
86
86
 
87
87
  def replace_existing_docs(ver)
88
- system %|mkdir -p ../../../lib/pry-doc/docs/#{ver} && cp -r .yardoc/* "$_"|
88
+ system %|mkdir -p ../../../lib/pry-doc/docs/#{ver} && cp -r .yardoc/* ../../../lib/pry-doc/docs/#{ver}|
89
89
  Dir.chdir(File.expand_path(File.dirname(__FILE__)))
90
90
  end
91
91
 
@@ -141,3 +141,18 @@ desc "Generate the latest Ruby 2.7 docs"
141
141
  task "gen27" do
142
142
  generate_docs_for('27', Latest.ruby27)
143
143
  end
144
+
145
+ desc "Generate the latest Ruby 3.0 docs"
146
+ task "gen30" do
147
+ generate_docs_for('30', Latest.ruby30)
148
+ end
149
+
150
+ desc "Generate the latest Ruby 3.1 docs"
151
+ task "gen31" do
152
+ generate_docs_for('31', Latest.ruby31)
153
+ end
154
+
155
+ desc "Generate the latest Ruby 3.2 docs"
156
+ task "gen32" do
157
+ generate_docs_for('32', Latest.ruby32)
158
+ end