ruby_doc 1.1.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce6c50fa59859ab477b3a2bdd0af629adabd6492eb68d988851868893fdbc73a
-  data.tar.gz: 1dbb4fe3ccb1eca4f707e46fbed8a5de498a5b3403e6280ff8388f1a41450d92
+  metadata.gz: 9f6ff52d91baa724d38c4466abfc16202893d12938de22d9f1e81ce08eea6a3e
+  data.tar.gz: ddf9fc4ccdc6c317eee458d0db2453a028896f7b60d98dc81a601a4842768f5c
 SHA512:
-  metadata.gz: d3b691614a0b80c69e82a0240541c8a2ca7045e9e0d673c8762431177106ca5fd76c14cac63d62d7d82bad82a769825d4543f066abf56093fdb6c74b250a5d7b
-  data.tar.gz: 56d76686e5aea2b98c2630d0aaf3d154f3bbf43f2bb54d0a273b196e8783f3b2d079b46d2664599bfd8347d72f65103721a58960de8a3a4edb4b3ce4e68906a6
+  metadata.gz: 13b4329220e11292910429d10b5ee110e9e5383a6a75373aca16e87a04ac8cc9ee030a5233ab7960502147b4a70abb13ebb91166bef719f89523c54198fb3dab
+  data.tar.gz: 2cefcb41740d450e7ef7e296b957e0a5ef6362d549cd8f8d58cadccedfddb177bb7ff2ac16d6971ff614b7bc49e52efc35124cb37f28d942ff064ee25383d418

data/.gitignore

@@ -6,4 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-Attack Notes
+private

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_doc (1.0.5)
+    ruby_doc (2.0.0)
       colorize (~> 0.8.1)
       nokogiri (~> 1.8, >= 1.8.1)
 
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.3)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
-    nokogiri (1.8.1)
+    nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     pry (0.11.3)
       coderay (~> 1.1.0)

data/README.md

@@ -4,10 +4,9 @@
 ![](http://forthebadge.com/images/badges/powered-by-electricity.svg)
 ![](http://forthebadge.com/images/badges/pretty-risque.svg)
 
-![](https://img.shields.io/badge/Init--Release-Jan--2018-orange.svg)
 [![Gem Version](https://badge.fury.io/rb/ruby_doc.svg)](https://badge.fury.io/rb/ruby_doc)
 [![Gem](https://img.shields.io/gem/dt/ruby_doc.svg)](https://rubygems.org/gems/ruby_doc)
-![](https://img.shields.io/badge/gem--series-alpha--docs-blue.svg)
+[![Changelog](https://img.shields.io/badge/change-log-blue.svg)](https://github.com/AlphaDaniel/alpha-ruby_doc/blob/master/changelog.md)
 [![GitHub last commit](https://img.shields.io/github/last-commit/AlphaDaniel/alpha-ruby_doc.svg)](https://github.com/AlphaDaniel/alpha-ruby_doc/commits/master)
 [![](https://img.shields.io/badge/A-C-red.svg)](http://a1phacoding.com/)
 
@@ -26,17 +25,24 @@ Ever get tired of leaving your editor / environment to google a method, or more
 
 ![image](https://i.imgur.com/NmincSX.gif)
 ### Features:
-* Search by Doc title
-* View related methods
-* Browse all Docs (Paginated Output To Terminal)
-* Source Links
-* Easy Navigation
-* Random Dev Quotes (Ok This One Is Just For Fun Lol)
+✓  Search for Ruby Documentation by Class, Module or Method Name
+
+✓  Browse all Documentation (Paginated Output To Terminal)
+
+✓  View Descriptions and Syntax
+
+✓  View Source Code
+
+✓  Source Links Provided
+
+✓  Easy Navigation
+
+✓  Random Dev Quotes (For fun and motivation)
 
 ### Coming Soon:
-* Search by method name ([See Notes](https://github.com/AlphaDaniel/alpha-ruby_doc/blob/master/Notes.md))
 * Multiple Doc sources
-* Display Syntax
+* Save Favorites
+* Add Notes
 
 ---
 ## INSTALLATION
@@ -75,6 +81,10 @@ To exit
 
     $ exit!
     
+To Learn More 
+
+    $ ?
+    
 ---
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
 task :default => :spec
+
+require_relative './config/environment'
+
+task :console do
+  Pry.start
+end

data/bin/ruby_doc

@@ -2,6 +2,6 @@
 require "bundler/setup"
 require_relative '../config/environment'
 
-RubyDoc::CLI.iLoad
+RubyDoc::CLI.start_load
 
 

data/changelog.md

@@ -1,4 +1,14 @@
-Unreleased Changes
+v2.0.0 (2018-02-21)
+------------------
+
+* Improved Data Source 
+* Feature - Search Methods, Classes, and Modules
+* Feature - Focus Highlight on Classes & Modules in Search Matches
+* Feature - Display Syntax
+* Feature - Display Source Code
+* Added Learn More Option in Main Menu with Changelog & Coming Soon
+
+v1.1.5 (2018-02-01)
 ------------------
 
 * Navigation Improved - Exit with (Exit!)

data/config/environment.rb

@@ -1,13 +1,19 @@
-#===========Requires==========
+#====================Requires===================
 require 'colorize'
 require 'open-uri'
 require 'nokogiri'
+require_relative './patches'
 require_relative '../lib/ruby_doc/version'
-require_relative '../lib/ruby_doc/ui/CLI'
-require_relative '../lib/ruby_doc/ui/UI'
-require_relative '../lib/ruby_doc/data/scrapers'
-require_relative '../lib/ruby_doc/data/meth'
-require_relative '../lib/ruby_doc/data/doc'
-#===========Testing===========
-# require 'pry'
-def x; exit!; end #Quit Exit
+#======================Cli======================
+require_relative '../lib/ruby_doc/cli/cli'
+require_relative '../lib/ruby_doc/cli/ui'
+#=====================Data======================
+require_relative '../lib/ruby_doc/data/class'
+require_relative '../lib/ruby_doc/data/method'
+require_relative '../lib/ruby_doc/data/scraper'
+require_relative '../lib/ruby_doc/data/data_processor'
+#====================DataBase===================
+$DocDB = []
+#====================Testing====================
+# Scraper.changelog
+#===============================================

data/config/patches.rb

@@ -0,0 +1,15 @@
+require_relative './environment'
+
+require 'pry'
+#========================pry patches========================== 
+#QUICK NEXT PRY
+Pry::Commands.alias_command 'n', 'exit'
+# hit next bind with 'x' instead of 'exit'
+# CUSTOMIZE: replace 'x' in code above with 'your_preference'
+#------------------------------------------------------------- 
+#QUICK EXIT
+def x; exit!; end  
+# exit pry session with 'x' instead of 'exit!' 
+# CUSTOMIZE: replace 'xx' in code above with 'your_preference'
+#============================================================= 
+

data/lib/ruby_doc/cli/cli.rb

@@ -0,0 +1,16 @@
+module RubyDoc::CLI 
+#======================================================
+  def self.start_load 
+    puts "\nThanks For Using ALPHA™ Ruby Docs!".cyan
+    puts "One Moment Please As We Set Things Up\n".cyan
+    Scraper.load_classes and Scraper.load_methods
+    self.start
+  end
+#------------------------------------------------------  
+  def self.start 
+    UI.signature
+    UI.main_menu
+    UI.main_control
+  end
+#====================================================== 
+end 

data/lib/ruby_doc/cli/ui.rb

@@ -0,0 +1,387 @@
+class UI 
+#=================Properties=================== 
+  attr_reader :counter #For Loading Anim
+#===================Input====================== 
+  def self.my_gets 
+    gets.strip.to_s.downcase
+  end
+#==================Control===================== 
+  def self.main_control 
+    prompt
+    input = my_gets
+    
+    if input.split.size > 1 
+      main_error
+    elsif input == "b" 
+      paginate("start") 
+    elsif input == "exit!" 
+      exit!
+    elsif input == "?" 
+      learn_more
+    else 
+      matches = Processor.search(input)
+      
+      search_error if matches.empty?
+      search_list(matches) if matches
+    end
+  end
+  
+  def self.list_control(matches) 
+    prompt
+    input = my_gets
+    
+    if input == "m" 
+      RubyDoc::CLI.start
+    elsif input == "exit!"
+      exit!
+    elsif !input.to_i.between?(1,matches.count) 
+      list_error(matches)
+    else 
+      Processor.load_doc(matches[input.to_i-1])
+    end 
+    list_control(matches)
+  end
+  
+  def self.display_class_control(doc) 
+    prompt
+    input = my_gets
+    
+    case input
+    when "1" 
+      method_list(doc)
+    when "m" 
+      RubyDoc::CLI.start
+    when "exit!" 
+      exit!
+    else 
+      display_class_error(doc)
+    end 
+  end
+  
+  def self.display_method_control 
+    prompt
+    input = my_gets
+    
+    case input
+    when "m" 
+      RubyDoc::CLI.start
+    when "exit!"
+      exit!
+    else 
+      display_method_error
+    end 
+  end
+  
+  def self.browse_control(identifier, page) 
+    prompt
+    input = my_gets
+    
+    case input
+    when "n" 
+      paginate(identifier) 
+    when "m" 
+      RubyDoc::CLI.start 
+    when "exit!" 
+      exit!
+    end
+    
+    if !input.to_i.between?(1,page.count) 
+      browse_error(input, identifier, page) 
+    else 
+      Processor.load_doc(page[input.to_i-1])
+    end
+  end
+#==================Display===================== 
+  def self.search_list(matches) 
+    UI.sepL
+    matches.each_with_index do |doc, index| 
+      
+      if doc.type == "Class" || doc.type == "Module"
+        li = ["#{index + 1}.".yellow, doc.name.light_cyan]
+      else
+        li = ["#{index + 1}.".yellow, doc.name.cyan]
+      end
+      
+      puts li.join(" ")
+    end
+    puts sepR
+    puts "Classes and Modules are".cyan + " Highlighted".light_cyan
+    puts sepR
+    
+    list_menu(matches)
+    list_control(matches)
+  end
+  
+  def self.display_class(doc) 
+    UI.sepL
+    puts "TITLE: ".cyan + doc.name.upcase 
+    puts "TYPE: ".cyan + doc.type.upcase
+    puts "\nDESCRIPTION:".cyan 
+    puts doc.description
+    puts "Methods: ".cyan + "#{doc.methods.count}".yellow
+    puts "Source: #{doc.url}".red 
+    puts sepR
+    
+    display_class_menu(doc)
+    display_class_control(doc)
+  end
+  
+  def self.method_list(doc) 
+    puts sepR
+    doc.methods.each_with_index do |method, index| 
+      
+      if !method.nil?
+        li = ["#{index + 1}.".yellow, method.name.cyan]
+        puts li.join(" ")
+      end
+       
+    end
+    puts sepR
+    
+    list_menu(doc.methods) 
+    list_control(doc.methods)
+  end
+    
+  def self.display_method(doc) 
+    UI.sepL
+    puts "Title: ".cyan + doc.name.upcase 
+    puts "Type: ".cyan + doc.type.upcase
+    puts "\nDescription:".cyan 
+    puts doc.doc
+    puts "Source: #{doc.url}".red 
+    puts sepR
+     
+    #-----------future fix------------#
+    # description = doc.doc
+    # puts uie.wrapped(description, 55)
+    #-----------future fix------------#
+    
+    display_method_menu 
+    display_method_control
+  end
+  
+  def self.paginate(identifier) 
+    
+    case identifier
+    when "start" 
+      Processor.page1
+    when "Page1" 
+      Processor.page2
+    when "Page2" 
+      Processor.page3
+    when "Page3" 
+      Processor.last
+    end
+    
+  end
+  
+  def self.browse_list(page, identifier) 
+    puts sepL
+    page.each_with_index do |doc, index|  
+      
+      if doc.type == "Class" || doc.type == "Module"
+        li = ["#{index + 1}.".yellow, doc.name.light_cyan]
+      else
+        li = ["#{index + 1}.".yellow, doc.name.cyan]
+      end
+      
+      puts li.join(" ")
+    end
+    
+    if identifier == "Last"
+      puts sepR
+      puts "End of List".red
+    end
+    puts sepR 
+    
+    last_page_menu(page) if identifier == "Last"
+    browse_menu(page) if !(identifier == "Last")
+    
+    browse_control(identifier, page)
+  end
+  
+  def self.learn_more 
+    puts "\nCOMING SOON".cyan
+    puts "=".black*56
+    puts Scraper.coming_soon
+    
+    puts "\nCHANGELOG".cyan
+    puts "=".black*56
+    puts Scraper.changelog
+    
+    main_menu
+    main_control
+  end
+#===================Menus====================== 
+  def self.main_menu 
+    puts sepR#
+    puts "Enter a ".cyan + "word ".yellow + "associated with the Ruby Language & I will ".cyan
+    puts "try to find a match in my database for you.".cyan
+    sepL#
+    puts "\You can also enter".cyan + " 'b'".yellow + " to browse instead.".cyan + " Happy Hunting!".cyan
+    puts "=".black*56
+    puts "Enter '?' to Learn More about Alpha Ruby-Doc".black
+    print cyanH("\n If You're Searching... Single Word Inputs Only Please ")
+  end
+  
+  def self.list_menu(matches) 
+    puts "To ".cyan + "View ".yellow + "(Enter ".cyan + "#".yellow + ")".cyan + " eg. #{matches.count.to_s} for #{matches[matches.count-2].name}".black
+    puts "To return to".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")".cyan
+    puts "To".cyan + " Leave".yellow + " (".cyan + "'exit!'".yellow + ")\n".cyan
+    print randQ
+  end
+  
+  def self.display_class_menu(doc) 
+    puts "To ".cyan + "View Methods ".yellow + "For".cyan + " #{doc.name}".yellow + " (Enter ".cyan + "'1'".yellow + ")".cyan
+    puts "To Return To".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")".cyan
+    puts "To".cyan + " Leave".yellow + " (".cyan + "'exit!'".yellow + ")\n".cyan
+    print randQ
+  end
+  
+  def self.display_method_menu 
+    puts "To Return To".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")".cyan
+    puts "To".cyan + " Leave".yellow + " (".cyan + "'exit!'".yellow + ")\n".cyan
+    print randQ
+  end
+  
+  def self.browse_menu(page) 
+    puts "To ".cyan + "View ".yellow + "(Enter ".cyan + "#".yellow + ")".cyan + " eg. #{page.count.to_s} for #{page[page.count-1].name}".black
+    puts "To ".cyan + "Browse Next Page ".yellow + "(Enter ".cyan + "'n'".yellow + ")".cyan
+    puts "To Return To".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")".cyan
+    puts "To".cyan + " Leave".yellow + " (".cyan + "'exit!'".yellow + ")\n".cyan
+    print randQ
+  end
+  
+  def self.last_page_menu(page)
+    puts "To ".cyan + "View ".yellow + "(Enter ".cyan + "#".yellow + ")".cyan + " eg. #{page.count.to_s} for #{page[page.count-1].name}".black
+    puts "To Return To".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")".cyan
+    puts "To".cyan + " Leave".yellow + " (".cyan + "'exit!'".yellow + ")\n".cyan
+    print randQ
+  end
+#===================Error====================== 
+  def self.main_error 
+    sleep(0.1)
+    print redH("\n Input Must Be 1 Word, 'b' to browse, or 'exit!' to leave ")
+    main_control
+  end
+  
+  def self.search_error 
+    puts "\nNO CIGAR!".red
+    puts "I couldn't find what you're looking for.".black 
+    puts "How about trying a Ruby ".black + "Method" + ", ".black + "Class" + " or ".black + "Module" + " name.".black
+    puts "=".black*56
+    
+    puts "\nNOT SURE?".red
+    puts "You can always browse with ".black + "'b'" + " & learn something new.".black + ":)"
+    puts "=".black*56
+    
+    print redH("\n Try a new word, enter 'b' to browse, or 'exit!' to leave ")
+    main_control
+  end
+  
+  def self.list_error(matches) 
+    print redH("\n Enter selection number, 'm' for main or 'exit!' to leave ")
+  end
+  
+  def self.nil_error
+    print redH("\n Enter selection number, 'm' for main or 'exit!' to leave ")
+  end
+  
+  def self.display_class_error(doc) 
+    print redH("\n Please enter '1' to view methods, 'm' for main, or 'exit!' to leave ")
+    display_class_control(doc)
+  end
+  
+  def self.display_method_error 
+    print redH("\n Please enter 'm' for main menu or 'exit!' to leave ")
+    display_method_control
+  end
+  
+  def self.browse_error(input, identifier, page)  
+    if identifier == "Last"
+      list_error(page)
+      browse_control(identifier, page)
+    else
+      browse_list_error(page)
+      browse_control(identifier, page)
+    end
+  end
+  
+  def self.browse_list_error(page)
+    print redH("\n Enter # to view, 'n' for next page 'm' for main or 'exit!' to leave ")
+  end
+#============================================== 
+                                        #CANDY
+#===============Quote Scraper================== 
+  def self.randQ
+    html = Nokogiri::HTML(open("https://fortrabbit.github.io/quotes/"))
+    container = html.search(".row.gutter-l.wrap")
+    
+    quotes = container.search("p").map {|quote| quote.text.gsub(/[\n]\s+/, "")}
+    quote = " "+ quotes[rand(0..180)]+ " "
+    wrapped(quote, 55).black
+  end
+#=============Loading Animation================ 
+  # Goes above iterator
+  def self.loading_message 
+    puts cyanH(" Loading Database ") + " ☠️"
+  end
+  # Goes inside iterator - last line
+  def self.loading_animation 
+    loading = ""
+    print loading << ". ".cyan if 
+    @counter == 50 || @counter == 100 || @counter == 150 || @counter == 200 || 
+    @counter == 250 || @counter == 300 || @counter == 350 || @counter == 400 || 
+    @counter == 450 || @counter == 500 || @counter == 550 || @counter == 600 || 
+    @counter == 650 || @counter == 700 || @counter == 750 || @counter == 800 || 
+    @counter == 850 || @counter == 900 || @counter == 950 || @counter == 1000 || 
+    @counter == 1150 || @counter == 1200 || @counter == 1250 || @counter == 1300 || 
+    @counter == 1350 || @counter == 1400 || @counter == 1450 || @counter == 1500 
+  end
+#=============Colors/Candy Props=============== 
+  def self.prompt 
+    print " >> ".cyan
+  end
+  
+  def self.sepL 
+    puts "=".cyan*28 + "=".white*28
+  end
+    
+  def self.sepR 
+    "=".white*28 + "=".cyan*28
+  end
+
+  def self.redH(str) 
+    str.colorize(color: :white, background: :red)
+  end#red highlight
+  
+  def self.cyanH(str) 
+    str.colorize(color: :white, background: :cyan)
+  end#cyan highlight
+
+  def self.wrapped(s, width=78) 
+	  lines = []
+	  line = ""
+	 
+	  s.split(/\s+/).each do |word|
+	    if line.size + word.size >= width
+	      lines << line
+	      line = word
+	    elsif line.empty?
+	     line = word
+	    else
+	     line << " " << word
+	   end
+	   end
+	   lines << line if line
+	  return lines.join "\n"
+	end #wrap string
+#=================Signature==================== 
+  def self.signature 
+    puts "\n"+"=".white*28 + "=".cyan*28 
+puts %q(               ALPHA™ 
+               ╦═╗╦ ╦╔╗ ╦ ╦  ╔╦╗╔═╗╔═╗╔═╗
+               ╠╦╝║ ║╠╩╗╚╦╝   ║║║ ║║  ╚═╗
+               ╩╚═╚═╝╚═╝ ╩   ═╩╝╚═╝╚═╝╚═╝).cyan end
+#==============================================
+end