RubyGems - pry-doc - Versions diffs - 0.5.0 → 0.5.1 - Mend

pry-doc 0.5.0 → 0.5.1

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.

Files changed (9) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11f38a31ba3ead1b864b64cba1b7146472936140
-  data.tar.gz: 7749f753ea7c619c50058b0f7f4595e0818c2b89
+  metadata.gz: fa855e924fac8a0f2f7175001c299f893d90dbde
+  data.tar.gz: 2bc036797815fbdaaca39319292cfddd46ef7576
 SHA512:
-  metadata.gz: fe8b6222f6973e2930491082358fc98b56977c6f58ab1183387794ad3b50d0691780ae499265caea57c97c92612fd6f825f69ef668dcee86149780749f3e774e
-  data.tar.gz: 2bd90d59d35e767ff1b3811a27def8b6a453e2c17e0f57b1e84cc0ec802a8b2d75fdf80d086ecd1c36ef5a24d08d5bcaea8c90c4f66bd3f461a430d74f17828d
+  metadata.gz: e68884b7a98c31daa988926cbc20324d6661ec0e57ad550fc8e3a480b36ebd74ee5ec0a74bd4001814f40bd2097fb50acdb2ab72b208687b8b071f0f5ed0b45e
+  data.tar.gz: 55360cd98cdd98bcfe6d667f78ef5c27e097956130059888692a53b5c88eaf791c1ffce628c62824943201d8122b630ae2eeb2e81598841b2d2467d4510a644e

checksums.yaml.gz.sig CHANGED Viewed

Binary file

data.tar.gz.sig CHANGED Viewed

Binary file

data/CHANGELOG.md CHANGED Viewed

@@ -1,6 +1,12 @@
 Pry Doc changelog
 =================
+### v0.5.1 (December 26, 2013)
+* **Important:** previous version `v0.5.0` does _not_ support Ruby 2.1.0. This
+  version does!
+* Pry Doc has a logo now (embedded in the README)
 ### v0.5.0 (December 25, 2013)
 * **Important:** added support for Ruby 2.1.0. The docs are super fresh!

data/README.md CHANGED Viewed

@@ -1,73 +1,64 @@
-pry-doc
-=======
+![Pry Doc][logo]
-(C) John Mair (banisterfiend) 2013
+* Repository: [https://github.com/pry/pry-doc][repo]
+* Wiki: [https://github.com/pry/pry-doc/wiki][wiki]
-_Provides YARD and extended documentation support for Pry_
+Description
+-----------
-* Install the [gem](https://rubygems.org/gems/pry-doc): `gem install pry-doc`
-* Read the [documentation](http://rdoc.info/github/pry/pry-doc/master/file/README.md)
-* See the [source code](http://github.com/pry/pry-doc)
+Pry Doc is a plugin for [Pry][pry]. It provides extended documentation support
+for Pry.
-Example: Provide access to Ruby core documentation and source code from within Pry
---------
+Installation
+------------
-    [1] pry(main)> show-doc puts
+All you need is to install the gem. The `pry-doc` plugin will be detected and
+used automatically.
-    From: io.c (C Method):
-    Owner: Kernel
-    Visibility: private
-    Signature: puts(*arg1)
-    Number of lines: 3
+    gem install pry-doc
-    Equivalent to
+Synopsis
+--------
-        $stdout.puts(obj, ...)
-    [2] pry(main)> show-source puts
+Pry Doc extends two core Pry commands: `show-doc` and `show-source` (aliased as
+`?` and `$` respectively).
-    From: io.c (C Method):
-    Owner: Kernel
-    Visibility: private
-    Number of lines: 8
+For example, in vanilla Pry it’s impossible to get the documentation for the
+`loop` method (it’s a method, by the way). However, Pry Doc solves that problem.
-    static VALUE
-    rb_f_puts(int argc, VALUE *argv, VALUE recv)
-    {
-        if (recv == rb_stdout) {
-        return rb_io_puts(argc, argv, recv);
-        }
-        return rb_funcall2(rb_stdout, rb_intern("puts"), argc, argv);
-    }
-    [3] pry(main)>
+![show-source][show-doc]
-Contact
--------
+Let's check the source code of the `loop` method.
-Problems or questions contact me at [github](http://github.com/banister)
+![show-doc][show-source]
+Generally speaking, you can retrieve most of the MRI documentation and
+accompanying source code. Pry Doc is also smart enough to get any documentation
+for methods and class implemented in C.
-License
--------
+Limitations
+-----------
-(The MIT License)
+Pry Doc supports the following Rubies:
-Copyright (c) 2013 John Mair (banisterfiend)
+* MRI 1.8
+* MRI 1.9
+* MRI 2.0
+* MRI 2.1
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Getting Help
+------------
+Simply file an issue or visit `#pry` at `irc.freenode.net`.
+License
+-------
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The project uses the MIT Licencse. See LICENSE file for more information.
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+[logo]: http://img-fotki.yandex.ru/get/6724/98991937.13/0_9faaa_26ec83af_orig "Pry Doc"
+[pry]: https://github.com/pry/pry
+[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
+[wiki]: https://github.com/pry/pry-doc/wiki

data/lib/pry-doc.rb CHANGED Viewed

@@ -6,13 +6,24 @@ direc = File.dirname(__FILE__)
 require "#{direc}/pry-doc/version"
 require "yard"
+module PryDoc
+  def self.load_yardoc(version)
+    path = "#{File.dirname(__FILE__)}/pry-doc/core_docs_#{ version }"
+    YARD::Registry.load_yardoc(path)
+  end
+end
 case RUBY_VERSION
+when /\A2\.1/
+  PryDoc.load_yardoc('21')
 when /\A2\.0/
-  YARD::Registry.load_yardoc("#{File.dirname(__FILE__)}/pry-doc/core_docs_20")
+  PryDoc.load_yardoc('20')
 when /\A1\.9/
-  YARD::Registry.load_yardoc("#{File.dirname(__FILE__)}/pry-doc/core_docs_19")
+  PryDoc.load_yardoc('19')
 else
-  YARD::Registry.load_yardoc("#{File.dirname(__FILE__)}/pry-doc/core_docs_18")
+  PryDoc.load_yardoc('18')
 end
 class Pry

data/lib/pry-doc/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module PryDoc
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-doc
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
@@ -29,7 +29,7 @@ cert_chain:
   WgU0k85lanm1mxaZwCtAWgtppKhbDM2xI74woW7PaGRF4JaeF7kV601CFs7UxVy2
   sooul8M+4MWStBzb
   -----END CERTIFICATE-----
-date: 2013-12-25 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -1475,7 +1475,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key:
 specification_version: 4
 summary: Provides YARD and extended documentation support for Pry

metadata.gz.sig CHANGED Viewed

Binary file