pry-doc-notebook 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7759be3468b7ed9e07417614a66148c6ac293794e6f5c6e95401c26a8dbce467
+  data.tar.gz: 808fce6848061a0405c3648ddabad0ab0b55ddeb34babb5428d0d34fb9d308b7
+SHA512:
+  metadata.gz: 69f09adee769eef6bb6cedd569a8f5d5d010e1ec3619a7a111a58efd14caf9772825518da2ae84bd7fab47f655a216e42b77db09faeef17c3447bee680a1fd7a
+  data.tar.gz: 65e17d54e561babe8523306f0a78c6f481900846647ece05fd57479a282ce4674cc249fb280b230a7d66acc9d2f448db6b267132c7f8486f0a279781546f35b1

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Style/RedundantReturn:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+First version.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pry-doc-notebook.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    pry-doc-notebook (0.1.0)
+      pry
+      pry-doc
+      yard
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.12.0)
+    pry (0.12.2)
+      coderay (~> 1.1)
+      method_source (~> 0.9.0)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  pry-doc-notebook!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,16 @@
+# Pry::Doc::Notebook
+
+Pry Doc Notebook is a Pry REPL plugin for IRuby Notebook. It provides a `?` commands.
+With help of the plugin the commands are be able to display documentation with html format.
+
+## Installation
+
+    $ gem install pry-doc-notebook
+
+## Usage
+
+![Usage](readme_img/usage.png)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zheng-yongping/pry-doc-notebook.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pry-doc-notebook"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pry-doc-notebook.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'pry-doc-notebook/version'
+require_relative 'pry-doc-notebook/yri'
+require_relative 'pry-doc-notebook/html_syntax_highlight'
+
+require 'yard'
+
+module PryDocNotebook
+  YARD::Templates::Engine.register_template_path("#{File.dirname(__FILE__)}/templates")
+
+  Pry::Commands.create_command '?' do
+    group 'Introspection'
+    description 'View yard documentation.'
+    banner YRI::USAGE
+
+    def process(name)
+      YRI.new.display(name)
+    end
+  end
+end

data/lib/pry-doc-notebook/html_syntax_highlight.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'rouge'
+
+module PryDocNotebook
+
+  class ModifiedPastie < Rouge::CSSTheme
+    # Modified by Rouge::Themes::Pastie
+    # See https://github.com/rouge-ruby/rouge/blob/master/lib/rouge/themes/pastie.rb
+
+    style Comment,                   :fg => '#408080'
+    style Comment::Preproc,          :fg => '#cc0000', :bold => true
+    style Comment::Special,          :fg => '#cc0000', :bg => '#fff0f0', :bold => true
+
+    style Error,                     :fg => '#a61717', :bg => '#e3d2d2'
+    style Generic::Error,            :fg => '#aa0000'
+
+    style Generic::Heading,          :fg => '#333333'
+    style Generic::Subheading,       :fg => '#666666'
+
+    style Generic::Deleted,          :fg => '#000000', :bg => '#ffdddd'
+    style Generic::Inserted,         :fg => '#000000', :bg => '#ddffdd'
+
+    style Generic::Emph,             :italic => true
+    style Generic::Strong,           :bold => true
+
+    style Generic::Lineno,           :fg => '#888888'
+    style Generic::Output,           :fg => '#888888'
+    style Generic::Prompt,           :fg => '#555555'
+    style Generic::Traceback,        :fg => '#aa0000'
+
+    style Keyword,                   :fg => '#008800', :bold => true
+    style Keyword::Pseudo,           :fg => '#008800'
+    style Keyword::Type,             :fg => '#888888', :bold => true
+
+    style Num,                       :fg => '#0000dd', :bold => true
+
+    style Str,                       :fg => '#dd2200'
+    style Str::Escape,               :fg => '#0044dd'
+    style Str::Interpol,             :fg => '#3333bb'
+    style Str::Other,                :fg => '#22bb22'
+    #style Str::Regex,                :fg => '#008800', :bg => '#fff0ff'
+    # The background color on regex really doesn't look good, so let's drop it
+    style Str::Regex,                :fg => '#008800'
+    style Str::Symbol,               :fg => '#aa6600'
+
+    style Name::Attribute,           :fg => '#336699'
+    style Name::Builtin,             :fg => '#003388'
+    style Name::Class,               :fg => '#bb0066', :bold => true
+    style Name::Constant,            :fg => '#003366', :bold => true
+    style Name::Decorator,           :fg => '#555555'
+    style Name::Exception,           :fg => '#bb0066', :bold => true
+    style Name::Function,            :fg => '#0066bb', :bold => true
+    #style Name::Label,              :fg => '#336699', :italic => true
+    # Name::Label is used for built-in CSS properties in Rouge, so let's drop italics
+    style Name::Label,               :fg => '#336699'
+    style Name::Namespace,           :fg => '#bb0066', :bold => true
+    style Name::Property,            :fg => '#336699', :bold => true
+    style Name::Tag,                 :fg => '#bb0066', :bold => true
+    style Name::Variable,            :fg => '#336699'
+    style Name::Variable::Global,    :fg => '#dd7700'
+    style Name::Variable::Instance,  :fg => '#3333bb'
+
+    style Operator::Word,            :fg => '#008800'
+
+    style Text,                      {}
+    style Text::Whitespace,          :fg => '#bbbbbb'
+  end
+
+  YARD::Templates::Helpers::HtmlHelper.class_eval do
+    def respond_to_missing?(name, include_all)
+      if name =~ /^html_syntax_highlight_(\w+)/
+        lang = $1.to_sym
+        return Rouge::Lexers.constants.include?(lang)
+      end
+      super
+    end
+
+    def method_missing(name, *args, &block)
+      if name =~ /^html_syntax_highlight_(\w+)/
+        lang = $1.to_sym
+        if Rouge::Lexers.constants.include?(lang)
+          lexer = Rouge::Lexers.const_get(lang).new
+          formatter = Rouge::Formatters::HTMLInline.new(ModifiedPastie)
+          return formatter.format(lexer.lex(*args))
+        end
+      end
+      super
+    end
+
+    def html_syntax_highlight_ruby(source)
+      html_syntax_highlight_Ruby(source)
+    end
+  end
+end

data/lib/pry-doc-notebook/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PryDocNotebook
+  VERSION = '0.1.1'
+end

data/lib/pry-doc-notebook/yri.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'rubygems'
+
+module PryDocNotebook
+  class YRI < YARD::CLI::YRI
+    USAGE = <<~USAGE
+      Usage: ? <Path to object>
+      Example: ? String#gsub
+    USAGE
+
+    def display(name)
+      if name.nil? || name.strip.empty?
+        puts USAGE
+        return nil
+      end
+
+      object = find_object(name)
+      if object
+        IRuby.display object.format(format: :html), mime: 'text/html'
+      else
+        puts "No documentation for `#{name}'"
+      end
+      return nil
+    end
+
+    private
+
+    def pry_doc_yardoc_path
+      ruby_version = RUBY_VERSION[0...3].sub!('.', '')
+      pry_doc_path = Gem.loaded_specs['pry-doc'].full_gem_path
+      return "#{pry_doc_path}/lib/pry-doc/docs/#{ruby_version}"
+    end
+
+    def find_object(name)
+      @search_paths.unshift(@cache[name]) if @cache[name]
+      @search_paths.unshift(YARD::Registry.yardoc_file)
+      @search_paths.unshift(pry_doc_yardoc_path)
+
+      @search_paths.each do |path|
+        next unless File.exist?(path)
+
+        YARD::Registry.load(path)
+        obj = try_load_object(name, path)
+        return obj if obj
+      end
+      return nil
+    end
+  end
+end

data/lib/templates/default/docstring/html/setup.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+def code_add_border(html)
+  doc = Nokogiri::HTML::DocumentFragment.parse(html)
+  doc.search('pre.code').each do |pre|
+    pre['style'] = 'border: 1px solid #cfcfcf;'\
+                   'border-radius: 2px;'\
+                   'margin: 0.5em;'\
+                   'padding: 0.3em;'
+  end
+  doc.to_html
+end

data/lib/templates/default/docstring/html/text.erb

@@ -0,0 +1 @@
+<%= code_add_border(htmlify(docstring_text)) %>

data/lib/templates/default/method_details/html/method_signature.erb

@@ -0,0 +1,25 @@
+<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <% if object.tags(:overload).size == 1 %>
+    <%= signature(object.tag(:overload), false) %>
+  <% elsif object.tags(:overload).size > 1 %>
+    <% object.tags(:overload).each do |overload| %>
+      <span class="overload" style="display: block;"><%= signature(overload, false) %></span>
+    <% end %>
+  <% else %>
+    <%= signature(object, false) %>
+  <% end %>
+
+  <% if object.aliases.size > 0 %>
+    <span class="aliases">Also known as:
+    <span class="names"><%= object.aliases.map {|o|
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+
+  <% if owner != object.namespace %>
+    <span class="not_defined_here">
+      Originally defined in <%= object.namespace.type %>
+        <%= linkify object, owner.relative_path(object.namespace) %>
+    </span>
+  <% end %>
+</h3>

data/lib/templates/default/method_details/html/setup.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+def detect_language(filename)
+  case File.extname(filename).downcase
+  when '.c' then 'C'
+  when '.py' then 'Python'
+  when '.rb' then 'Ruby'
+  when '.c++', '.cpp', '.cxx' then 'Cpp'
+  end
+end

data/lib/templates/default/method_details/html/source.erb

@@ -0,0 +1,12 @@
+<div class="source_code" style="border: 1px solid #cfcfcf; border-radius: 2px">
+  <table>
+    <tr style="background: inherit;">
+      <td style="border-right: 1px solid #cfcfcf;">
+        <pre class="lines" style="color: #999"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
+      </td>
+      <td style="text-align: left;">
+        <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source, detect_language(object.file) %></pre>
+      </td>
+    </tr>
+  </table>
+</div>

data/pry-doc-notebook.gemspec

@@ -0,0 +1,49 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pry-doc-notebook/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pry-doc-notebook"
+  spec.version       = PryDocNotebook::VERSION
+  spec.authors       = ["zheng-yongping"]
+  spec.email         = ["zheng-yongping@hotmail.com"]
+
+  spec.summary       = %q{Provides YARD and extended documentation support for Pry in IRuby Notebook}
+  spec.description   = <<~DESCR
+    Pry Doc Notebook is a Pry REPL plugin for IRuby Notebook. It provides a `?` commands.
+    With help of the plugin the commands are be able to display documentation with html format.
+  DESCR
+
+  spec.homepage      = "https://github.com/zheng-yongping/pry-doc-notebook"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/zheng-yongping/pry-doc-notebook"
+    spec.metadata["changelog_uri"] = "https://github.com/zheng-yongping/pry-doc-notebook/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency 'yard', '~> 0.9'
+  spec.add_dependency 'pry', '~> 0.12'
+  spec.add_dependency 'pry-doc', '~> 1.0'
+  spec.add_dependency 'rouge', '~> 3.11'
+  spec.add_dependency 'nokogiri', '~> 1.10'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: pry-doc-notebook
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- zheng-yongping
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: |
+  Pry Doc Notebook is a Pry REPL plugin for IRuby Notebook. It provides a `?` commands.
+  With help of the plugin the commands are be able to display documentation with html format.
+email:
+- zheng-yongping@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pry-doc-notebook.rb
+- lib/pry-doc-notebook/html_syntax_highlight.rb
+- lib/pry-doc-notebook/version.rb
+- lib/pry-doc-notebook/yri.rb
+- lib/templates/default/docstring/html/setup.rb
+- lib/templates/default/docstring/html/text.erb
+- lib/templates/default/method_details/html/method_signature.erb
+- lib/templates/default/method_details/html/setup.rb
+- lib/templates/default/method_details/html/source.erb
+- pry-doc-notebook.gemspec
+- readme_img/usage.png
+homepage: https://github.com/zheng-yongping/pry-doc-notebook
+licenses: []
+metadata:
+  homepage_uri: https://github.com/zheng-yongping/pry-doc-notebook
+  source_code_uri: https://github.com/zheng-yongping/pry-doc-notebook
+  changelog_uri: https://github.com/zheng-yongping/pry-doc-notebook/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides YARD and extended documentation support for Pry in IRuby Notebook
+test_files: []