ducky 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 041b802768c3710cb7c05265067078ee0ddec8b9
+  data.tar.gz: 43b873d162179bdad779857c36744471b861d34a
+SHA512:
+  metadata.gz: 7502c398dcdcd57c2a12d2d47a13e79840bfd69b002397456ecb24039ed53d542f1ceb7ecd0e6282edd29bf9a615cde94fb2efe420348cd289183752d2cf338b
+  data.tar.gz: 3fff1aead271b898277a0672514391da313054a391b1eab9fc46189b13c5771d359330e53fe151f1de278b8bb6d25d134f23203766ae6d9e0191a06db3652055

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ducky.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 medcat
+
+MIT License
+
+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.md

@@ -0,0 +1,76 @@
+# Ducky
+
+Retreives documentation on any core, stdlib, or gem method.  Core and
+stdlib get the added benefit of checking the inheritance chain; for
+gems, it only checks the class.
+
+## Installation
+
+Install it yourself:
+
+    $ gem install ducky
+
+## Usage
+
+Check out
+
+    $ ducky help
+
+The ducky command line has three subcommands: `core`, `stdlib`, or
+`gem`.  `core` expects 1 or 2 parameters; the first is the method to
+lookup, and the second (optional) is the ruby version to look it up
+on.  `stdlib` expects 2 or 3 parameters; the first is the stdlib
+library that the method is under, the second is the method, and
+the third (optional) is the ruby version to look it up on.  `gem`
+expects 2 or 3 parameters; the first is the gem the method is under,
+the second is the method, and the third (optional) is the version of
+the gem to look it up on (by default, selects the latest version).
+
+### Method Value
+
+method values look like `<class><accessor><method>`, where `<class>`
+is the class it's defined on, `<accessor>` is how the method is
+accessed (i.e. one of `.`, `#`, or `::`), and `method` is the method
+name.  `<class>` is optional (it defaults to `Object`); others are
+not.  For example, `Kernel#printf`, `Array.new`, `#object_id` are
+all valid, but `printf`, `Kernel`, and `Array.` are not.
+
+### Examples
+
+    > ducky gem antelope "Antelope::Generator::Base#template"
+    - (void) template(source, destination) {|content| ... } (protected)
+
+    This method returns an undefined value.
+    Copies a template from the source, runs it through erb (in the context of this
+    class), and then outputs it at the destination. If given a block, it will call
+    the block after the template is run through erb with the content from erb; the
+    result of the block is then used as the content instead.
+
+    Parameters:
+     source (String) — the source file. This should be in source_root.
+
+     destination (String) — the destination file. This will be in Ace::Grammar#output.
+
+    Yield Parameters:
+     content (String) — The content that ERB created.
+
+    Yield Returns:
+     (String) — The new content to write to the output.
+
+    > ducky core "Array.new"
+    new(size=0, obj=nil)
+    new(array)
+    new(size) {|index| block }
+
+
+    Returns a new array.
+    # (truncated)
+
+
+## Contributing
+
+1. Fork it ( https://github.com/medcat/ducky/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/ducky

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH << lib unless $LOAD_PATH.include?(lib)
+
+require "ducky"
+
+Ducky::CLI.start(ARGV)

data/ducky.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ducky/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ducky"
+  spec.version       = Ducky::VERSION
+  spec.authors       = ["medcat"]
+  spec.email         = ["redjazz96@gmail.com"]
+  spec.summary       = %q{Lookup documentation.}
+  spec.description   = %q{Lookup documentation for core, stdlib, and gem methods.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/ducky.rb

@@ -0,0 +1,25 @@
+require "ducky/version"
+require "ducky/source"
+require "ducky/sources"
+require "ducky/cli"
+require "ducky/format"
+
+module Ducky
+
+  SOURCES = {
+    :core   => Sources::Core,
+    :stdlib => Sources::StdLib,
+    :gem    => Sources::Gem
+  }
+
+  def lookup(type, *args)
+    source = SOURCES[type]
+    Format.format source.new(*args).lookup
+
+  rescue NoMethodError => e
+    e.message
+  end
+
+  extend self
+
+end

data/lib/ducky/cli.rb

@@ -0,0 +1,25 @@
+require "thor"
+
+module Ducky
+  class CLI < Thor
+
+    desc "core METHOD [VERSION]",
+      "lookup the given method in the given ruby version's core"
+    def core(method, version = RUBY_VERSION)
+      puts Ducky.lookup(:core, method, version)
+    end
+
+    desc "stdlib LIB METHOD [VERSION]",
+      "lookup the given method in the given ruby version's stdlib"
+    def stdlib(lib, method, version = RUBY_VERSION)
+      puts Ducky.lookup(:stdlib, lib, method, version)
+    end
+
+    desc "gem NAME METHOD [VERSION]",
+      "lookup the given method in the given gem version's source"
+    def gem(name, method, version = :guess)
+      puts Ducky.lookup(:gem, name, method, version)
+    end
+
+  end
+end

data/lib/ducky/format.rb

@@ -0,0 +1,42 @@
+module Ducky
+  module Format
+
+    extend self
+
+    def format(information)
+      out = ""
+
+      information[:head].each do |head|
+        out << head << "\n"
+      end
+
+      body = ""
+      information[:body].children.each do |child|
+        content = word_wrap(child.content.gsub(/\s+/, " "))
+        case child.name
+        when "comment", "div"
+        when "text"
+          body << content
+        when "p"
+          body << content << "\n"
+        when /h[1-6]/
+          body << "\n\n" << content << "\n"
+        when "pre"
+          body << "\n\n    " <<
+            child.content.split("\n").join("\n    ") << "\n\n"
+        end
+      end
+
+      out << "\n\n" << body.strip << "\n\n" << information[:footer]
+    end
+
+    # thanks, Rails!
+    def word_wrap(text, options = {})
+      line_width = options.fetch(:line_width, 80)
+
+      text.split("\n").collect! do |line|
+        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
+      end * "\n"
+    end
+  end
+end

data/lib/ducky/source.rb

@@ -0,0 +1,72 @@
+require "nokogiri"
+require "erb"
+
+module Ducky
+  class Source
+
+    include ERB::Util
+
+    def initialize(method)
+      @method = method
+      @receiver, @type, @message = split_method
+    end
+
+    def response
+      @_response ||= source.get(url)
+    end
+
+    def document
+      @_document ||= Nokogiri::HTML(response.body)
+    end
+
+    def lookup
+      raise NotImplementedError
+    end
+
+    private
+
+    def url
+      raise NotImplementedError
+    end
+
+    def handle_error
+      core = self.class.
+        new("#{@method.gsub(@receiver, parent)}", version)
+      core.lookup
+    rescue NoMethodError
+      no_method!
+    end
+
+    def parent
+      no_method!
+    end
+
+    def no_method!
+      raise NoMethodError, "No method named #{@method}"
+    end
+
+    def split_method
+      match = @method.match(/\A(.*)(\.|\#|\:\:)(.*?)\z/)
+      no_method! unless match
+
+      base = if match[1].empty?
+        "Object"
+      else
+        match[1]
+      end
+
+      type = case match[2]
+        when ".", "::"
+          :class
+        when "#"
+          :instance
+        end
+
+      [
+        base.gsub("::", "/"),
+        type,
+        url_encode(match[3])
+      ]
+    end
+  end
+end

data/lib/ducky/sources.rb

@@ -0,0 +1,28 @@
+require "faraday"
+require "faraday_middleware"
+require "ducky/sources/core"
+require "ducky/sources/gem"
+require "ducky/sources/stdlib"
+
+module Ducky
+  module Sources
+
+    RUBY_DOC = Faraday.new(:url => "http://ruby-doc.org") do |conn|
+      conn.use Faraday::Response::RaiseError
+      conn.adapter Faraday.default_adapter
+    end
+
+
+    RUBYDOC_INFO = Faraday.new(:url => "http://rubydoc.info") do |conn|
+      conn.use Faraday::Response::RaiseError
+      conn.adapter Faraday.default_adapter
+    end
+
+    RUBY_GEMS = Faraday.new(:url => "http://rubygems.org") do |conn|
+      conn.use Faraday::Response::RaiseError
+      conn.response :json
+      conn.adapter Faraday.default_adapter
+    end
+
+  end
+end

data/lib/ducky/sources/core.rb

@@ -0,0 +1,77 @@
+module Ducky
+  module Sources
+    class Core < Source
+
+      include ERB::Util
+
+      def initialize(method, version)
+        @method = method
+        @version = version
+
+        super(method)
+      end
+
+      def lookup
+        elements = document.css(selector)
+        information = {
+          :head => [],
+          :body => [],
+          :source => "",
+          :footer => "",
+          :url => url
+        }
+
+        elements.each do |element|
+          element.css(".method-heading").each do |call|
+            information[:head] << call.inner_text.
+              gsub("click to toggle source", "").strip
+          end
+
+          information[:body] = element.
+            css('div:not(.method-source-code):not(.aliases)').last
+          source = element.css('.method-source-code').each do |source|
+            information[:source] = source.content
+          end
+
+          element.css('.aliases').each do |a|
+            information[:footer] << a << "\n"
+          end
+
+          information[:footer].strip!
+        end
+
+        unless elements.any?
+          handle_error
+        else
+          information
+        end
+
+      rescue Faraday::ResourceNotFound
+        no_method!
+      end
+
+      private
+
+      def source
+        RUBY_DOC
+      end
+
+      def selector
+        "#public-#{@type}-method-details " \
+          "##{@message.gsub(/[\W]/, "-").gsub(/\A-/, "")}-method"
+      end
+
+      def url
+        "/core-#{@version}/#{@receiver}.html"
+      end
+
+      def parent
+        @_parent ||= document.css("#parent-class-section p.link a").
+          first.content
+
+      rescue
+        super
+      end
+    end
+  end
+end

data/lib/ducky/sources/gem.rb

@@ -0,0 +1,103 @@
+module Ducky
+  module Sources
+    class Gem < Source
+
+      def initialize(name, method, version = :guess)
+        @name = name
+        @method = method
+        @version = version
+
+        super(method)
+      end
+
+      def lookup
+        methods = document.css('#method_details .method_details')
+        no_method! unless methods.any?
+
+        methods.each do |method|
+          method.css('.signature').each do |sig|
+            information[:head] << sig.inner_text.strip
+          end
+
+          information[:body] = document.
+            css('.docstring .discussion').last
+
+          information[:footer] =
+            create_footer(document.css('.tags').last)
+
+          information[:source] = document.
+            css('.source_code pre.code').last.inner_text
+        end
+
+        information
+
+      rescue Faraday::ResourceNotFound
+        no_method!
+      end
+
+      private
+
+      def create_footer(tags)
+        return unless tags
+        out = ""
+
+        tags.children.each do |tag|
+          case tag.name
+          when "p"
+            out << tag.inner_text.strip
+          when "ul"
+            tag.children.each do |li|
+              li.children.each do |span|
+                content = span.inner_text.gsub(/\s+/, " ")
+
+                out << Format.word_wrap(content, line_width: 71)
+              end
+              out << "\n"
+
+            end
+
+          end
+
+        end
+
+        out
+      end
+
+      def source
+        RUBYDOC_INFO
+      end
+
+      def information
+        @_information ||= {
+          :head => [],
+          :body => [],
+          :source => "",
+          :footer => "",
+          :url => url
+        }
+      end
+
+      def version
+        @_version ||= begin
+          if @version == :guess
+            response = RUBY_GEMS.get("/api/v1/gems/#{@name}.json")
+            response.body["version"]
+          else
+            @version
+          end
+        end
+      end
+
+      def url
+        part = "/gems/#{@name}/#{version}/#{@receiver}"
+        if @type == :class
+          part << "."
+        else
+          part << ":"
+        end
+
+        part << @message
+      end
+    end
+  end
+end

data/lib/ducky/sources/stdlib.rb

@@ -0,0 +1,21 @@
+module Ducky
+  module Sources
+    class StdLib < Core
+
+      def initialize(lib, method, version)
+        @lib = lib
+        super(method, version)
+      end
+
+      private
+
+      def url
+        "/stdlib-#{version}/libdoc/#{@lib}/rdoc/#{receiver}.html"
+      end
+
+      def parent
+        no_method!
+      end
+    end
+  end
+end

data/lib/ducky/version.rb

@@ -0,0 +1,3 @@
+module Ducky
+  VERSION = "0.0.1".freeze
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: ducky
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- medcat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lookup documentation for core, stdlib, and gem methods.
+email:
+- redjazz96@gmail.com
+executables:
+- ducky
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ducky
+- ducky.gemspec
+- lib/ducky.rb
+- lib/ducky/cli.rb
+- lib/ducky/format.rb
+- lib/ducky/source.rb
+- lib/ducky/sources.rb
+- lib/ducky/sources/core.rb
+- lib/ducky/sources/gem.rb
+- lib/ducky/sources/stdlib.rb
+- lib/ducky/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lookup documentation.
+test_files: []