RubyGems - pry-highlight - Versions diffs - 0.0.1 - Mend

pry-highlight 0.0.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 (4) hide show

data/LICENSE.MIT ADDED

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Conrad Irwin <conrad.irwin@gmail.com>
+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:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+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.

data/README.markdown ADDED

@@ -0,0 +1,81 @@
+The Pry-higlight gem (`gem install pry-highlight`) adds a `higlight` command (aka. `>>`) to Pry.
+This intelligently formats and colourizes the result, so you don't have to.
+Features
+========
+By default this pretty-prints the previous output value:
+    [1] pry(main)> '{"hi":"world"}'
+    => "{\"hi\":\"world\"}"
+    [2] pry(main)> >>
+```javascript
+{
+  "hi": "world"
+}
+```
+It can auto-detect JSON, XML and Ruby code by default:
+    [3] pry(main)> JSON.method(:pretty_print).source
+    => "    def pretty_print(q)\n      q.text inspect\n    end\n"
+    [4] pry(main)> >>
+```ruby
+    def pretty_print(q)
+      q.text inspect
+    end
+```
+You can also tell it which highlighter to use, see [CodeRay's homepage](http://coderay.rubychan.de/) for the full list.
+    [5] pry(main)> "function () {\n    return 'meh';\n}"
+    => "function () {\n    return 'meh';\n}"
+    [6] pry(main)> >> -t javascript
+```javascript
+function () {
+    return 'meh';
+}
+```
+You can give it the value to higlight explicitly:
+    [7] pry(main)> >> "<meta><foo/></meta>"
+```xml
+<?xml version="1.0"?>
+<meta>
+  <foo/>
+</meta>
+```
+In fact, any combination of ruby and a -t flag works :)
+    [8] pry(main)> >> -t html File.read("/var/www/foo.html")
+```html
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+    <h1>It works!</h1>
+  </body>
+</html>
+```
+Even if you try to `>>` a String that isn't understood, you'll still get nice results because newlines will be interpreted correctly:
+    [9] pry(main)> "1 2 3\n4 5 6\n7 8 9\n"
+    => "1 2 3\n4 5 6\n7 8 9\n"
+    [10] pry(main)> >>
+    1 2 3
+    4 5 6
+    7 8 9
+Issues
+=====
+The guessing of type based on the string could do with improvement.
+Meta-foo
+========
+Licensed under the MIT license, contributions and bug-reports welcome :).

data/lib/pry-highlight.rb ADDED

@@ -0,0 +1,66 @@
+Pry::Commands.command ">>", "highlight string output", :shellwords => false do |*args|
+  require 'json'
+  require 'nokogiri'
+  opts = Slop.parse!(args) do |opt|
+    opt.banner unindent <<-BANNER
+      Usage: >> [ -t <type>] <optional ruby code>
+    BANNER
+    opt.on :h, :help do
+      puts opt.help
+    end
+    opt.on :t, :type, true
+  end
+  next if opts[:h]
+  value = target.eval args.join(" ").sub(/\A *\z/, '_')
+  type = opts[:t] ? opts[:t].to_sym : nil
+  begin
+    value = value.to_str
+  rescue NoMethodError
+    Pry.config.print.call(output, value) unless value.respond_to?(:to_str)
+    next
+  end
+  if type == :json || !type && value.start_with?("{") || value.start_with?("[")
+    begin
+      value = JSON.pretty_generate(JSON.parse(value))
+      type = :json
+    rescue Pry::RescuableException => e
+      output.puts "#{e}"
+    end
+  elsif type == :html || !type && value.start_with?("<html")
+    begin
+      value = Nokogiri::HTML(value).to_xhtml.lines.drop(1).join
+      type = :html
+    rescue Pry::RescuableException => e
+      output.puts "#{e}"
+    end
+  elsif type == :xml || !type && value.start_with?("<")
+    begin
+      value = Nokogiri::XML(value).to_xml
+      type = :xml
+    rescue Pry::RescuableException => e
+      output.puts "#{e}"
+    end
+  elsif !type
+    if _pry_.respond_to?(:valid_expression?) && _pry_.valid_expression?(value) ||
+      _pry_.respond_to?(:complete_expression?) && (begin _pry_.complete_expression?(value); true; rescue SyntaxError; false; end)
+      type = :ruby
+    end
+  end
+  if type
+    output.puts CodeRay.scan(value, type).term
+  elsif String === value
+    output.puts value
+  else
+    Pry::Config.print.call(output, value)
+  end
+end
+Pry::Commands.alias_command "highlight", ">>"

metadata ADDED

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: pry-highlight
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease:
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Conrad Irwin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-01-15 00:00:00 -08:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: coderay
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Uses JSON, Nokogiri and CodeRay to highlight and prettify JSON, XML, HTML, Ruby and anything else CodeRay supports!
+email: conrad.irwin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pry-highlight.rb
+- README.markdown
+- LICENSE.MIT
+has_rdoc: true
+homepage: http://github.com/ConradIrwin/pry-highlight
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.6.2
+signing_key:
+specification_version: 3
+summary: Adds a >> command to pretty-print Strings
+test_files: []