ruby_doc 1.1.5 → 2.0.0

data/lib/ruby_doc/data/doc.rb

@@ -1,16 +0,0 @@
-class Doc
-#========================modules=========================== 
-  extend DataExtras #sets/gets @@all
-  #inheriting: paginate, display(doc), listMeths(doc)
-#=======================properties========================= 
-  attr_accessor :name, :url, :description, :type, :methods
-#==========================================================
-  #DocCount = 2403
-  def initialize(name, url) 
-    self.name = name
-    self.url = url
-    @@all << self
-    self.methods = []
-  end
-#==========================================================
-end

data/lib/ruby_doc/data/meth.rb

@@ -1,18 +0,0 @@
-class Meth
-#========================modules=========================== 
-  extend DataExtras #sets/gets @@all
-#=================properties===================           
-  attr_accessor :name, :url, :description, :type, :docs
-#==============================================
-  def initialize(name, url) 
-    self.name = name
-    self.url = url
-    @@all << self
-    self.docs = []
-  end
-#==============================================
-  def self.find(name) 
-    self.all.find{|meth| meth.name.downcase == name.downcase}
-  end
-#==============================================
-end

data/lib/ruby_doc/data/scrapers.rb

@@ -1,81 +0,0 @@
-class Scraper 
-  extend UIExtras 
-  #inheriting: loading_message, loading_animation
-  
-  #See "HELPERS"(line62) for additional methods
-#==================Load Docs=================== 
-  def self.loadDOCS 
-    @counter = 0 #For Loading anim
-    loading_message#
-    
-    html = Nokogiri::HTML(open("https://apidock.com/ruby/browse"))
-    container = html.search(".hover_list")
-    
-    container.search("a").each do |doc|
-      name = doc.text
-      url = prefix + doc.attribute("href").value
-      
-      # assigns - Doc :names, :urls
-      Doc.new(name, url) if docUniq(name)
-      
-      @counter += 1 #For Loading anim
-      loading_animation#
-    end
-  end 
-#===================DocPage==================== 
-  def self.loadDocPage(doc) 
-    #Scrape1 
-    doc_page = Nokogiri::HTML(open(doc.url))
-    #prerequisites
-    doc_page.search(".description p")[0..1].search("em").remove
-    container = doc_page.search("#related")
-    container.search("li").search(".related_header").remove
-    
-    # assigns - Doc :description, :type
-    doc.description = parse(doc_page.search(".description p")[0..1].text)
-    doc.type = doc_page.search(".title_prefix span").text
-    #========================================== 
-    #Scrape2
-    container.search("li").map do |m|
-      name = m.search("a").text
-      url = prefix + m.search("a").attribute("href").value
-      
-      # assigns - Meth :name, :url >> Doc :methods
-      method = Meth.new(name, url) if methUniq(name)
-      doc.methods << name if methsUniq(doc.methods, name)
-    end
-    doc #doc instance
-  end
-#==================MethPage==================== 
-  def self.loadMethPage(meth)
-    url = Nokogiri::HTML(open(meth.url))
-    url.search(".description p")[0..1].search("em").remove
-    
-    # assigns - Meth :description, :type
-    meth.description = parse(url.search(".description p")[0..1].text)
-    meth.type = url.search(".title_prefix span").text
-  end
-#============================================== 
-                                       #HELPERS
-#============================================== 
-  def self.parse(des) 
-    des.gsub(/[\n]/, ' ').gsub('  ',' ')
-  end
-  
-  def self.docUniq(name) 
-    Doc.all.none?{|doc| doc.name == name}
-  end
-  
-  def self.methUniq(name) 
-    Meth.all.none?{|meth| meth.name == name}
-  end
-  
-  def self.methsUniq(col,name) 
-    col.none?{|meth| meth == name}
-  end
-  
-  def self.prefix 
-    "https://apidock.com"
-  end
-#============================================== 
-end

data/lib/ruby_doc/ui/CLI.rb

@@ -1,20 +0,0 @@
-module RubyDoc
-#============================================== 
-  module CLI
-#===============Load Init Data================#
-    def self.iLoad 
-      puts "\nThanks For Using ALPHA™ Ruby Docs!".cyan
-      puts "One Moment Please As We Set Things Up\n".cyan
-      Scraper.loadDOCS
-      start
-    end
-#============================================== 
-    def self.start 
-      UI.signature#
-      UI.greeting
-    end
-#============================================== 
-  end
-#==============================================
-end 
-

data/lib/ruby_doc/ui/UI.rb

@@ -1,39 +0,0 @@
-#==================requires==================== 
-require_relative './ui_extras'
-require_relative '../data/data_extras.rb'
-#============================================== 
-module RubyDoc::CLI
-#==================modules===================== 
-  class UI 
-    extend UIExtras#
-    #inheriting: mainMenu, mainControl, signature
-    extend DataExtras
-    #inheriting: paginateALL, superSEARCH(),
-    #displayMeth(), display()
-#============================================== 
-    def self.greeting 
-      mainMenu#
-      mainControl# =>
-    end
-    
-    def self.main_Shuttle(iN) 
-      case iN 
-      when "b" 
-        paginateALL 
-      when "exit!"
-        exit!
-      else
-        superSEARCH(iN)
-      end
-    end
-    
-    def self.search_Shuttle(iN, matches) 
-      iN == "m" ? greeting : display(matches[iN.to_i-1])
-    end
-    
-    def self.meth_Shuttle(iN, doc) 
-      displayMeth(doc.methods[iN.to_i-1])
-    end
-#============================================== 
-  end
-end 

data/lib/ruby_doc/ui/ui_extras.rb

@@ -1,257 +0,0 @@
-module UIExtras 
-    attr_reader :counter #For Loading Anim
-#============================================== 
-                                    #IMPORTANT!
-#==================Shuttle===================== 
-  def main 
-    RubyDoc::CLI.start
-  end
-#==================Control===================== 
-  def mainControl 
-    prompt
-    iN = alphaGets
-    iN.split.size > 1 ? mainError : RubyDoc::CLI::UI.main_Shuttle(iN)  
-  end
-  
-  def browseControl(currentPg, docRange) 
-    prompt
-    iN = alphaGets
-    
-    case iN
-    when "n"
-      DataExtras.nextPage(currentPg) 
-    when "m"
-      main 
-    when "exit!"
-      exit!
-    end
-    # else
-    !iN.to_i.between?(1,docRange.count) ? browseError(iN, currentPg, docRange) : Doc.display(docRange[iN.to_i-1])
-  end
-  
-  def searchControl(matches) 
-    matches == [] ? searchError : matches.each_with_index{|doc, index| outputD(doc, index)}
-  end
-  
-  def choiceControl(matches) 
-    prompt
-    iN = alphaGets
-    
-    if iN == "m" 
-      main
-    elsif iN == "exit!"
-      exit!
-    elsif !iN.to_i.between?(1,matches.count)
-      choiceError(matches)
-    else 
-      RubyDoc::CLI::UI.search_Shuttle(iN, matches)
-    end   
-  end
-  
-  def docControl(doc) 
-    prompt
-    iN = alphaGets
-    
-    case iN
-    when "1" 
-      Doc.listMeths(doc)
-    when "m" 
-      main
-    when "exit!"
-        exit!
-    else 
-      docError(doc)
-    end 
-  end
-  
-  def methControl 
-    prompt
-    iN = alphaGets
-    
-    case iN
-    when "m" 
-      main
-    when "exit!"
-      exit!
-    else 
-      methError
-    end 
-  end
-  
-  def methListControl(doc) 
-    prompt
-    iN = alphaGets
-    
-    if iN == "m" 
-      main
-    elsif iN == "exit!" 
-      exit!
-    elsif !iN.to_i.between?(1,doc.methods.count) ? methListError(doc) : RubyDoc::CLI::UI.meth_Shuttle(iN, doc)
-    end
-  end
-#===================Error====================== 
-  def mainError 
-    sleep(0.1)
-    print redH("\n Input Must Be 1 Word or b Try Again ")
-    mainControl
-  end
-  
-  def browseError(iN, currentPg, docRange)
-    if currentPg == "Last"
-      choiceError(docRange)
-      browseControl(currentPg, docRange)
-    else
-      print redH("\n Enter a number between 1 and #{docRange.count} n for next or m for main ")
-      browseControl(currentPg, docRange)
-    end
-  end
-  
-  def searchError 
-    puts "NO MATCH!".red
-    puts "If you are searching for a ".black + "Method" + ", enter the ".black + "Class" + " or".black + "\nModule" + " it belongs to instead. This limitation will be ".black + "\naddressed in future update".black
-    puts "=".black*56
-    
-    puts "Example: ".red + "Find".black + " 'reverse'" + " by searching".black + " 'String'"
-    mess = "'Reverse' method will be included in the doc's Methods:# (Additionally feel free to browse all docs)".black
-    puts wrapped(mess, 70).black
-    
-    print redH("\n Try A New Word or 'b' To Browse ")
-    mainControl
-  end
-  
-  def choiceError(matches) 
-    print redH("\n Enter a number between 1 and #{matches.count} or m for main ")
-    choiceControl(matches)
-  end
-  
-  def docError(doc)
-    print redH("\n Please enter '1' or 'm' ")
-    docControl(doc)
-  end
-  
-  def methError
-    print redH("\n Please enter 'm' to return to main menu ")
-    methControl
-  end
-  
-  def methListError(doc) 
-    print redH("\n Enter a number between 1 and #{doc.methods.count} or m for main ")
-    methListControl(doc)
-  end
-#===================Menus====================== 
-  def mainMenu 
-    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 type".cyan + " 'b'".yellow + " to browse instead.".cyan + " Happy Hunting!".cyan
-    print cyanH("\n If You're Searching... Single Word Inputs Only Please ")
-  end
-  
-  def browseMenu 
-    puts "To ".cyan + "View An Item ".yellow + "From This List (Enter Doc Number eg.".cyan + "'1'".yellow + ")".cyan
-    puts "To ".cyan + "Browse Next Page ".yellow + "(Enter ".cyan + "'n'".yellow + ")".cyan
-    puts "\nBack to".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")\n".cyan
-    print randQ
-  end
-  
-  def viewMenu 
-    puts "To ".cyan + "View An Item ".yellow + "From This List (Enter ID Number eg.".cyan + "'1'".yellow + ")".cyan
-    puts "\nBack to".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")\n".cyan
-    print randQ
-  end
-
-  def docMenu(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 + ")\n".cyan
-    print randQ
-  end
-  
-  def methMenu 
-    puts "To Return To".cyan + " Main Menu".yellow + " (Enter ".cyan + "'m'".yellow + ")\n".cyan
-    print randQ
-  end
-#===================Input====================== 
-  def prompt 
-    print " >> ".cyan
-  end
-  
-  def alphaGets 
-    gets.strip.to_s.downcase
-  end
-#==================Display===================== 
-  def outputD(doc, index)
-    puts "#{index + 1}. ".yellow + doc.name.cyan
-  end
-#============================================== 
-                                        #CANDY
-#===============Quote Scraper================== 
-  def 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 loading_message 
-    puts cyanH(" Loading Database ") + " ☠️"
-  end
-  # Goes inside iterator - last line
-  def loading_animation 
-    loading = ""
-    print loading << ". ".cyan if 
-    counter == 100 || counter == 200 || counter == 300 || counter == 400 || 
-    counter == 500 || counter == 600 || counter == 700 || counter == 800 || 
-    counter == 900 || counter == 1000 || counter == 1100 || counter == 1200 || 
-    counter == 1300 || counter == 1400 || counter == 1500 || counter == 1600 || 
-    counter == 1700 || counter == 1800 || counter == 1900 || counter == 2000 || 
-    counter == 2100 || counter == 2200 || counter == 2300 || counter == 2320 || 
-    counter == 2340 || counter == 2360 || counter == 2380 || counter == 2400
-  end
-#=================Separators=================== 
-  def sepL 
-    puts "=".cyan*28 + "=".white*28
-  end
-    
-  def sepR 
-    "=".white*28 + "=".cyan*28
-  end
-#==================Strings===================== 
-  def 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
-
-  def cyanH(str)
-    str.colorize(color: :white, background: :cyan)
-  end#cyan highlight
-  
-  def redH(str)
-    str.colorize(color: :white, background: :red)
-  end#red highlight
-#=================Signature==================== 
-  def signature 
-    puts "\n"+"=".white*28 + "=".cyan*28 
-puts %q(               ALPHA™ 
-               ╦═╗╦ ╦╔╗ ╦ ╦  ╔╦╗╔═╗╔═╗╔═╗
-               ╠╦╝║ ║╠╩╗╚╦╝   ║║║ ║║  ╚═╗
-               ╩╚═╚═╝╚═╝ ╩   ═╩╝╚═╝╚═╝╚═╝).cyan end
-#==============================================
-end
-