docpeeker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 471e8b024954b10da41f3fab2570d872ff469be9
+  data.tar.gz: a681ab6f941047d589b4c79e70dc831ab26730fc
+SHA512:
+  metadata.gz: e6772a99c5caa5346efecbc93f0da716e0ad0c5cbc4b43f6b2649b472d5565a08866637c45410936add59e6f838fb7252085fc13f64de3f85ec9c148dca1c443
+  data.tar.gz: eb0ddf0354f55b687722cb54579dfb37281785babcae268497818767c5675d16e941b91738ee430770418efee1bfed37476264d945585ba03c36a74a0203fb07

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 docpeeker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Connor Harwood
+
+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,29 @@
+# Docpeeker
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docpeeker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docpeeker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/docpeeker/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/docpeeker.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docpeeker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docpeeker"
+  spec.version       = Docpeeker::VERSION
+  spec.authors       = ["Connor Harwood", "Kevin Lee", "Simon Zhang", "Tuan Duong"]
+  spec.email         = ["harwood.connor@gmail.com"]
+  spec.summary       = %q{Quickly find a method in Roby-docs!}
+  spec.description   = %q{Accepts a string and searches Ruby-docs for methods matching that string. It will open tabs in your browser for each match it finds.}
+  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.required_ruby_version = '>= 1.8.7'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'nokogiri'
+  # spec.add_dependency 'open-uri'
+end

data/lib/docpeeker/version.rb

@@ -0,0 +1,3 @@
+module Docpeeker
+  VERSION = "0.0.1"
+end

data/lib/docpeeker.rb

@@ -0,0 +1,72 @@
+require "docpeeker/version"
+require 'nokogiri'
+
+module Docpeeker
+
+  RUBYDOC_URLS = ["http://www.ruby-doc.org/core-2.1.1/Enumerable.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Array.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Hash.html",
+                    "http://www.ruby-doc.org/core-2.1.1/String.html",
+                    "http://www.ruby-doc.org/stdlib-2.1.1/libdoc/set/rdoc/Set.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Bignum.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Object.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Module.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Class.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Numeric.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Float.html",
+                    "http://www.ruby-doc.org/core-2.1.1/File.html",
+                    "http://www.ruby-doc.org/core-2.1.1/IO.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Fixnum.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Range.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Regexp.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Symbol.html",
+                    "http://www.ruby-doc.org/core-2.1.1/Time.html"
+                  ]
+
+  def self.lookup(method_name)
+    RUBYDOC_URLS.each do |base_url|
+      page = objectify_page(base_url)
+      a_array = create_a_array(page)
+      method_append_pairs = pair_down_a_array(a_array)
+      append = find_url_append(method_name, method_append_pairs)
+      final_url = create_final_url(base_url, append)
+      puts "Opening a tab..." if open_tab(final_url)
+    end
+    puts "Done!"
+  end
+
+  private
+
+  def self.objectify_page(url)
+    Nokogiri::HTML(open("#{url}"))  # => creates a nokogiri object of a url
+  end
+
+  def self.create_a_array(nokogiri_page_object)
+    nokogiri_page_object.css('div#method-list-section').css('a')   # => creates an array of <a> elements(as nokogiri objects)
+  end
+
+  def self.grab_method_and_link(a_object)
+    [a_object.text, a_object[:href]] # => creates 2 element array of <a>'s method(as a string, without # in front) and the url-append
+  end
+
+  def self.pair_down_a_array(a_array)
+    text_link_pairs = []
+    a_array.each { |a| text_link_pairs << grab_method_and_link(a) } # => reduces an array of <a> objects to sub-arrays of their method and url-append
+    text_link_pairs
+  end
+
+  def self.find_url_append(desired_method, method_append_pairs)
+    method_append_pairs.each do |pair|
+      return pair[1] if (pair[0] == "##{desired_method}")
+    end
+    false    
+  end
+
+  def self.create_final_url(base_url, append)
+    append ? base_url + append : false
+  end
+
+  def self.open_tab(url)
+    `open #{url};` if url
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: docpeeker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Connor Harwood
+- Kevin Lee
+- Simon Zhang
+- Tuan Duong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: Accepts a string and searches Ruby-docs for methods matching that string.
+  It will open tabs in your browser for each match it finds.
+email:
+- harwood.connor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docpeeker.gemspec
+- lib/docpeeker.rb
+- lib/docpeeker/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: 1.8.7
+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: Quickly find a method in Roby-docs!
+test_files: []