pry-doc 0.6.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c3545540a708f50be59360dfa68a102ad4dbd5fd
-  data.tar.gz: a18cfc4d067a54f802752910ed80548288aea22e
+SHA256:
+  metadata.gz: f6073f2a11f2a53536d734f67326598e7bbb6cc4b353fcac80c50296b6cacc2b
+  data.tar.gz: d769c7c9b394abc2e489d55775b17d238a38e12cac190c313bb0b1209f92a871
 SHA512:
-  metadata.gz: b9362fea2cf197810c4ec31fbf53035d94540865dcab1a9a53965d6bdb48b8c0379617604e43f1acf1cc003e2adf1beaca61f364bbad4869d3576ff6703f05a7
-  data.tar.gz: 5e6dc588a2fce74f62fd74287c9a50996f88f052f117658e8b1bb3a8238806de5f97488153bd5452f8e7777ab62d9a42a08b90536a7286a6b82c57f18506422d
+  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

@@ -8,3 +8,9 @@ pkg/
 *.gem
 Gemfile.lock
 *~
+sample.bundle
+
+.bundle/
+vendor/bundle/
+
+rubies

data/CHANGELOG.md

@@ -1,6 +1,74 @@
 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
+  ([#87](https://github.com/pry/pry-doc/pull/87))
+* Fixed MRI 2.0 regression ([#88](https://github.com/pry/pry-doc/pull/88))
+
+### [v0.12.0][v0.12.0] (January 21, 2018)
+
+* Added suport for Ruby 2.5 docs ([#75](https://github.com/pry/pry-doc/pull/75))
+
+### [v0.11.1][v0.11.1] (August 8, 2017)
+
+* Specified minimum required Ruby version in the gemspec
+  ([#70](https://github.com/pry/pry-doc/pull/70))
+
+### [v0.11.0][v0.11.0] (August 8, 2017)
+
+* **IMPORTANT:** Drop support for Ruby 1.9.3
+  ([#68](https://github.com/pry/pry-doc/pull/68))
+* Stopped raising exception when Pry Doc doesn't support current Ruby version
+  (we print a warning instead) ([#65](https://github.com/pry/pry-doc/pull/65))
+
+### [v0.10.0][v0.10.0] (December 31, 2016)
+
+* Added support for Ruby 2.4 docs
+  ([#46](https://github.com/pry/pry-doc/pull/46))
+
+### [v0.9.0][v0.9.0] (June 30, 2016)
+
+* **Important:** Added support for Ruby 2.3 docs
+  ([#35](https://github.com/pry/pry-doc/pull/35))
+* Warn when Pry Doc doesn't support current Ruby version
+  ([#31](https://github.com/pry/pry-doc/pull/31))
+
+### v0.8.0 (June 14, 2015)
+
+* Reverted to 0.6.0 approach for packaging Ruby core docs.
+* Generated docs for Ruby 2.2
+
+### v0.7.0 (April 1, 2014)
+
+* 0.7.0 tried a new approach to packaging Ruby core docs, which turned out to
+  have issues with cross-version compatibility. It's since been yanked.
+
 ### v0.6.0 (March 8, 2014)
 
 * **Important:** dropped Ruby 1.8.7 support.
@@ -42,3 +110,13 @@ Pry Doc changelog
 * Signed the gem with a cryptographic signature
 
 [yard648]: https://github.com/lsegal/yard/issues/648
+[v0.9.0]: https://github.com/pry/pry-doc/releases/tag/v0.9.0
+[v0.10.0]: https://github.com/pry/pry-doc/releases/tag/v0.10.0
+[v0.11.0]: https://github.com/pry/pry-doc/releases/tag/v0.11.0
+[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,5 +1,7 @@
 ![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]
 
@@ -12,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
 --------
 
@@ -39,11 +43,7 @@ for methods and classes implemented in C.
 Limitations
 -----------
 
-Pry Doc supports the following Rubies:
-
-* MRI 1.9
-* MRI 2.0
-* MRI 2.1
+Pry Doc supports Ruby 2.0 and above.
 
 Getting Help
 ------------
@@ -53,10 +53,11 @@ Simply file an issue or visit `#pry` at `irc.freenode.net`.
 License
 -------
 
-The project uses the MIT Licencse. See LICENSE file for more information.
+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

@@ -1,3 +1,9 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec
+
 dlext = RbConfig::CONFIG['DLEXT']
 direc = File.dirname(__FILE__)
 
@@ -7,18 +13,24 @@ require 'latest_ruby'
 require 'rake/clean'
 require "#{direc}/lib/#{PROJECT_NAME}/version"
 
-desc "run tests"
-task :test do
-  sh "bacon -k #{direc}/spec/pry-doc_spec.rb"
+desc "start pry with fixture c file"
+task :pry_fixture do
+  sh %{pry -I./lib -r pry-doc -e "Pry::CInternals::CodeFetcher.ruby_source_folder = './spec/fixtures/c_source'"}
 end
-task :spec => :test
 
-task :default => :test
+desc "start pry with pry-doc code loaded"
+task :pry do
+  sh "pry -I./lib -r pry-doc"
+end
 
+desc "generate fixture etags"
+task :etags do
+  sh 'etags --no-members spec/fixtures/c_source/*.c -o spec/fixtures/c_source/TAGS'
+end
 desc "reinstall gem"
 task :reinstall => :gems do
   sh "gem uninstall pry-doc" rescue nil
-  sh "gem install #{direc}/pkg/pry-doc-#{PryDoc::VERSION}.gem"
+  sh "gem install #{direc}/pkg/pry-doc-#{PryDoc::VERSION}.gem --no-document"
 end
 
 desc "build all platform gems at once"
@@ -73,7 +85,7 @@ def generate_yard
 end
 
 def replace_existing_docs(ver)
-  system %|mkdir -p ../../../lib/pry-doc/core_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
 
@@ -90,11 +102,6 @@ def generate_docs_for(ruby_ver, latest_ruby)
   clean_up
 end
 
-desc "Generate the latest Ruby 1.9 docs"
-task "gen19" do
-  generate_docs_for('19', Latest.ruby19)
-end
-
 desc "Generate the latest Ruby 2.0 docs"
 task "gen20" do
   generate_docs_for('20', Latest.ruby20)
@@ -104,3 +111,43 @@ desc "Generate the latest Ruby 2.1 docs"
 task "gen21" do
   generate_docs_for('21', Latest.ruby21)
 end
+
+desc "Generate the latest Ruby 2.2 docs"
+task "gen22" do
+  generate_docs_for('22', Latest.ruby22)
+end
+
+desc "Generate the latest Ruby 2.3 docs"
+task "gen23" do
+  generate_docs_for('23', Latest.ruby23)
+end
+
+desc "Generate the latest Ruby 2.4 docs"
+task "gen24" do
+  generate_docs_for('24', Latest.ruby24)
+end
+
+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