check_everything 0.1.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b122d8de6966ddd03792e3f87a831eb038f5a854
-  data.tar.gz: e59a49a8025d318948e6984e2314f12fe6913120
+  metadata.gz: 4780781db8fef0b550c8f5030cc4739377a73a4b
+  data.tar.gz: 4fc4ea0c7abe0afb8e083bcad632ee8c3dc3392c
 SHA512:
-  metadata.gz: 485ab37271e244ed4efb6eee554acedea3ecb22d5178ef0df91c5c8790222593b3bf0af53f9809e102f2709c678a18952b06e32806d04c7a84ed093503de432c
-  data.tar.gz: 73c5f8693e0ff0c78bcdefad56d265b1905753ea8b8c44c210a06f8d6b7b784e936f1ad0b9bc604058848cf868b41c13d83f24554b5ab748cddb46080033e7df
+  metadata.gz: 2015d412a6e590c2c69f6f7b3b1fc8682c5917fc00c825aee9166863866078db14595738e2fcd02f3668ea6727cbcabb169ffff44ddc329ec5f204a462a22e26
+  data.tar.gz: 1cc5bc85325ae4f2d906fb0d2d624c1815f0b1e60208eb1fb63320e9b8bad0981df8ddba317c40e5912628434e5f1f6fe20b8c70b91f0d29f6a0be82dcc4a487

data/README.md

@@ -1,31 +1,46 @@
 # check_everything
 
 ## Open frequently accessed websites from your command line, in one go!
+####(Also includes the ability to find documentation for the Ruby core classes)
 
 ### Install
 
-Type 'gem install check_everything' into the command line.
+Type `gem install check_everything` into the command line.
 
 ### Run
 
-Type 'check_everything' into the command line to pull up the default URLs.
+Type `check_everything` into the command line to pull up the default URLs.
 
 You can add the following tags (listed in order of precedence; only the first
 will be evaluated):
 
 |   Tag |  Result   |
 |-----|-----|
-|  \-h, \-\-help         | display the help message             |
-|  \-l, \-\-links        | view/edit links and categories       |
-|  \-c, \-\-categories  | view the currently defined categories|
-|  \-a, \-\-all          | open all websites                    |
-|  <category>           | open a specific site group           |
+|  \-h, \-\-help         | display the help message                          |
+|  \-l, \-\-links        | view/edit links and categories                    |
+|  \-r, \-\-ruby         | install Ruby Documentation functionality          |
+|  \-c, \-\-categories   | view the currently defined categories             |
+|  \-a, \-\-all          | open all websites                                 |
+|  <category>    | open a specific site group                        |
+|  <Ruby class>  | open Ruby documentation (if feature is installed) |
 
 
 ### Configure
 
-Input your URLs and customize your categories! Input 'check_everything -l' and
-check out the instructions in the configuration file.
+On your first run, you will be asked to do 2 things:
+
+1. Choose whether to install Ruby Documentation lookup functionality. This will
+give you command-line access to Ruby Documentation for the Core classes. For
+example, to see documentation for array, type `check_everything array`
+
+2. Input your URLs and customize your categories! Check out the instructions in
+the configuration file.
+
+### Update Your Bash Profile (optional)
+
+You can update your Bash profile (~/.bash_profile) with:
+```alias check="check_everything"```
+to just type `check` instead of `check_everything` and make things even simpler!
 
 ### Enjoy!
 

data/lib/check_everything.rb

@@ -1,19 +1,42 @@
+require 'open-uri'
+require 'nokogiri'
+
 class CheckEverything
   KNOWN_TAGS = {
     :help => ['-h','--help'],
     :links => ['-l','--links'],
+    :ruby => ['-r','--ruby'],
     :categories => ['-c', '--categories'],
     :all => ['-a', '--all']
   }
-  LINKFILE = "#{File.expand_path('~')}/.check_everything_links"
+  LINKPATH = "#{File.expand_path('~')}/.check_everything_links"
+  LINKFILE = "#{LINKPATH}/links.txt"
+  RUBYFILE = "#{LINKPATH}/ruby.txt"
 
   def self.run
     @argv = ARGV.map(&:downcase)
+    until ARGV.empty?
+      ARGV.pop
+    end
+    # Only assemble Ruby development library if requested to.
+    @ruby_dev_assemble = false
     # Create a new link file if none has been created yet
-    unless File.exists?(LINKFILE)
-      system("cp #{File.dirname(__FILE__)}/check_everything/links.txt #{LINKFILE}")
+    if !File.exists?(LINKFILE)
+      # If a previous version created a file rather than a directory, move it into
+      # the new directory.
+      if File.exists?(LINKPATH)
+        system("mv #{LINKPATH} #{LINKPATH}2")
+        system("mkdir #{LINKPATH}")
+        system("mv #{LINKPATH}2 #{LINKFILE}")
+      else
+        system("mkdir #{LINKPATH}")
+        system("cp #{File.dirname(__FILE__)}/check_everything/links.txt #{LINKFILE}")
+      end
       @argv = ["-l"]
-      puts "Please customize your installation.",
+      print "Are you a Ruby Dev who will want documentation-checking ",
+        "functionality? [Y/n] "
+      @ruby_dev_assemble = true unless gets.strip.downcase == 'n'
+      puts "\nPlease customize your installation.",
         "This message will only be shown once.",
         "To open again and customize, just enter 'check_everything -l' to open",
         "the link file."
@@ -24,8 +47,10 @@ class CheckEverything
     extract_links
 
     # First check for unknown arguments and print out a helpful message.
-    known_tags = KNOWN_TAGS.values.flatten + @links.keys
-    unmatched_args = @argv.select{ |arg| !known_tags.include?(arg)}
+    known_tags = KNOWN_TAGS.values.flatten + @links.keys + @ruby_links
+    unmatched_args = @argv.select do |arg|
+      !known_tags.any?{|known_tag| known_tag.downcase == arg.downcase}
+    end
     if !unmatched_args.empty?
       puts "\nUnknown option#{@argv.size > 1 ? "s" : nil}: " +
         "#{unmatched_args.join(" ")}"
@@ -40,8 +65,14 @@ class CheckEverything
 
     # Edit the tags and links.
     elsif @argv.any? {|arg| KNOWN_TAGS[:links].include?(arg)}
+      # If asked to build the Ruby Dev file, build it!
+      assemble_ruby_docs_file if @ruby_dev_assemble
+
       system("open #{LINKFILE}")
     
+    elsif @argv.any? {|arg| KNOWN_TAGS[:ruby].include?(arg)}
+      assemble_ruby_docs_file
+
     # Check for errors; don't allow the user to see bad categories or open up
     # websites if the categories are not formatted properly.
     elsif @category_space
@@ -57,7 +88,7 @@ class CheckEverything
     
     # Open up the websites!
     else
-      open
+      open_links
     end
   end
   
@@ -67,9 +98,10 @@ class CheckEverything
     puts
     puts "Available tags:"
     puts "   -h, --help           display the help message"
-    puts "   -l, --links,         view/edit links and categories"
+    puts "   -l, --links          view/edit links and categories"
+    puts "   -r, --ruby           install Ruby Documentation functionality"
     puts "   -c, --categories     view the currently defined categories"
-    puts "   -a, --all            open all websites"
+    puts "   -a, --all            open all websites (will override documentation lookup)"
     puts "   <tags>               open a specific site group"
     puts "                        (multiple are allowed, separated by spaces)"
     puts
@@ -82,7 +114,20 @@ class CheckEverything
     @links.keys.sort.each {|key| puts "  #{key}"}
   end
 
-  def self.open
+  def self.assemble_ruby_docs_file
+    ruby_doc = Nokogiri::HTML(open("http://ruby-doc.org/core/"))
+    class_names = []
+    ruby_doc.css("p.class a").each{|class_name| class_names << class_name.text}
+    class_names.map!{|class_name| class_name.gsub(/::/,"/")}
+
+    system("touch #{File.dirname(__FILE__)}/ruby_doc")
+    File.open("#{File.dirname(__FILE__)}/ruby_doc", 'w') { |f|
+      f.print class_names.join("\n")
+    }
+    system("cp #{File.dirname(__FILE__)}/ruby_doc #{RUBYFILE}")
+  end
+
+  def self.open_links
     @argv << "default" if @argv.empty?
     
     # If -a or --all is specified, select all links.  Otherwise, select specified
@@ -90,7 +135,17 @@ class CheckEverything
     if @argv.any?{|arg| KNOWN_TAGS[:all].include?(arg)}
       links = @links.values.flatten.uniq
     else
-      links = @argv.map{|tag| @links[tag]}.flatten.compact.uniq
+      links = @argv.map{|category| @links[category]}.flatten.compact.uniq
+      # If a Ruby class name has been specified, open documentation for that class.
+      if File.exists?(RUBYFILE)
+        classes = read_file(RUBYFILE).split
+        class_matches = classes.map { |class_name|
+          class_name if @argv.any? {|name| class_name.downcase == name.downcase}
+        }.compact
+        if class_matches.size > 0
+          class_matches.each {|link| links << "ruby-doc.org/core/#{link}.html"}
+        end
+      end
     end
 
     links.each do |url|
@@ -98,7 +153,7 @@ class CheckEverything
       system("open #{url}")
     end
 
-    puts "\nIt's been a pleasure serving up your favorite websites!"
+    puts "\nIt's been a pleasure serving up your websites!"
     puts "Did you know you can use categories to open specific site groups? " +
       "Enter 'check_everything --links' for details.\n" if ARGV.empty?
   end
@@ -126,6 +181,12 @@ class CheckEverything
         }
       end
     end
+
+    @ruby_links = []
+    if File.exists?(RUBYFILE)
+      classes = read_file(RUBYFILE).split
+      classes.each {|class_name| @ruby_links << class_name}
+    end
   end
 
   # Recursive helper method for extract_links

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: check_everything
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Ariel Caplan
@@ -9,7 +9,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-02-12 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 description: Open Frequently Used Websites from the Command Line!
 email: ariel.caplan@flatironschool.com
 executables: