pry-doc 0.13.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4dc34490bf3602ab9a0e1ceb908c2832fa57b595
-  data.tar.gz: 90d48f62fa7fe2d8d76f027bada60f2f21053cb3
+SHA256:
+  metadata.gz: f6073f2a11f2a53536d734f67326598e7bbb6cc4b353fcac80c50296b6cacc2b
+  data.tar.gz: d769c7c9b394abc2e489d55775b17d238a38e12cac190c313bb0b1209f92a871
 SHA512:
-  metadata.gz: f1fb2e9e3eef41468a2fe0197b8b5682209caf339c037dd639976303c61839dbe39cb3b42d7a49a21ba15d44f5b732ea90e275acac32803e4ef5f44d0aa38dbd
-  data.tar.gz: c34a7ad63c5d73fc96991f0ece09efacdc50b23f097a4b5b83c7464963d6eaa995e7e27a081b824fe62498e1de74c1d38657778c85c2151e805f2672d2e4c558
+  metadata.gz: 2f1e51125226b6aa0625c336f04ab06eae312875d32f5d2cef8938ffb83077b69a160a264927fa79999f49596a9bfb3049384f61f24a48bc05c5b26cd34ea826
+  data.tar.gz: 90dc46503c7a94b8fd92e0c8be2c78ed4004991bfaf5c21aac4821b6a8b1564fdb6d56647f309b65ec37be800d1aa720f27556708355886c4f5d007bf47bf3dc

data/.circleci/config.yml

@@ -0,0 +1,119 @@
+version: 2
+references:
+  repo_restore_cache: &repo_restore_cache
+    restore_cache:
+      keys:
+        - repo-{{ .Environment.CIRCLE_SHA1 }}
+
+  repo_save_cache: &repo_save_cache
+    save_cache:
+      key: repo-{{ .Environment.CIRCLE_SHA1 }}-{{ epoch }}
+      paths:
+        - ~/pry-doc
+
+  bundle_install: &bundle_install
+    run:
+      name: Install Bundler dependencies
+      command: bundle install --path ~/pry-doc/vendor/bundle --jobs 15
+
+  unit: &unit
+    run:
+      name: Run unit tests
+      command: bundle exec rake
+
+jobs:
+  "ruby-2.0":
+    docker:
+      - image: kyrylo/ruby-2.0.0p648
+    working_directory: /home/circleci/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.1":
+    docker:
+      - image: circleci/ruby:2.1
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.2":
+    docker:
+      - image: circleci/ruby:2.2
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.3":
+    docker:
+      - image: circleci/ruby:2.3
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.4":
+    docker:
+      - image: circleci/ruby:2.4
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.5":
+    docker:
+      - image: circleci/ruby:2.5
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.6":
+    docker:
+      - image: circleci/ruby:2.6
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-2.7":
+    docker:
+      - image: circleci/ruby:2.7.0
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+  "ruby-3.0":
+    docker:
+      - image: circleci/ruby:3.0
+    working_directory: ~/pry-doc
+    steps:
+      - checkout
+      - <<: *repo_restore_cache
+      - <<: *bundle_install
+      - <<: *unit
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - "ruby-2.0"
+      - "ruby-2.1"
+      - "ruby-2.2"
+      - "ruby-2.3"
+      - "ruby-2.4"
+      - "ruby-2.5"
+      - "ruby-2.6"
+      - "ruby-2.7"
+      - "ruby-3.0"

data/.gitignore

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

data/CHANGELOG.md

@@ -3,6 +3,28 @@ Pry Doc changelog
 
 ### master
 
+### [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))
+* Fixed ``NoMethodError: undefined method `namespace_name'``
+  ([#97](https://github.com/pry/pry-doc/pull/97))
+
+### [v1.0.0][v1.0.0] (December 27, 2018)
+
+* Added suport for Ruby 2.6 docs ([#90](https://github.com/pry/pry-doc/pull/90))
+
 ### [v0.13.5][v0.13.5] (November 8, 2018)
 
 * Fixed deprecation warnings emitted by Pry v0.12.0
@@ -94,3 +116,7 @@ Pry Doc changelog
 [v0.11.1]: https://github.com/pry/pry-doc/releases/tag/v0.11.1
 [v0.12.0]: https://github.com/pry/pry-doc/releases/tag/v0.12.0
 [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

data/README.md

@@ -1,8 +1,9 @@
 ![Pry Doc][logo]
 
+[![Circle Build Status](https://circleci.com/gh/pry/pry-doc.svg?style=shield)](https://circleci.com/gh/pry/pry-doc)
+
 * Repository: [https://github.com/pry/pry-doc][repo]
 * Wiki: [https://github.com/pry/pry-doc/wiki][wiki]
-* [![Build Status](https://travis-ci.org/pry/pry-doc.svg?branch=master)](https://travis-ci.org/pry/pry-doc)
 
 Description
 -----------
@@ -13,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
 --------
 
@@ -54,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
 
@@ -131,3 +131,23 @@ desc "Generate the latest Ruby 2.5 docs"
 task "gen25" do
   generate_docs_for('25', Latest.ruby25)
 end
+
+desc "Generate the latest Ruby 2.6 docs"
+task "gen26" do
+  generate_docs_for('26', Latest.ruby26)
+end
+
+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