ruby_doc 1.1.5 → 2.0.0

data/lib/ruby_doc/data/class.rb

@@ -0,0 +1,18 @@
+class Klass
+#=======================properties================================ 
+  attr_accessor :type, :name, :url, :short, :description, :methods
+#-----------------------------------------------------------------  
+  @@all = []
+  def self.all; @@all; end 
+#=================================================================
+  # count = 125
+  def initialize(type, name, url) 
+    self.type = type
+    self.name = name
+    self.url = url
+    @@all << self
+    self.methods = []
+  end
+#=================================================================
+end
+

data/lib/ruby_doc/data/data_processor.rb

@@ -0,0 +1,35 @@
+class Processor  
+#=============================Browse Pages============================ 
+  def self.page1 
+    UI.browse_list($DocDB[0..499], "Page1")
+  end
+  
+  def self.page2 
+    UI.browse_list($DocDB[500..999], "Page2")
+  end
+  
+  def self.page3 
+    UI.browse_list($DocDB[1000..1499], "Page3")
+  end
+  
+  def self.last 
+    UI.browse_list($DocDB[1500..$DocDB.count], "Last")
+  end
+#===============================Load Doc============================== 
+  def self.load_doc(doc) 
+    if !doc.nil?
+      Scraper.load_class_doc(doc) if doc.type == "Class" || doc.type == "Module"
+      Scraper.load_method_doc(doc) if doc.type == "Method"
+      
+      UI.display_class(doc) if doc.type == "Class" || doc.type == "Module"
+      UI.display_method(doc) if doc.type == "Method"
+    else 
+      UI.nil_error
+    end
+  end
+#================================SEARCH=============================== 
+  def self.search(name)
+    matches = $DocDB.find_all{|doc| doc.name.downcase.include?(name)}
+  end
+#=====================================================================
+end

data/lib/ruby_doc/data/method.rb

@@ -0,0 +1,20 @@
+class Meth
+#============================================================           
+  attr_accessor :type, :name, :url, :doc
+#------------------------------------------------------------  
+  @@all = []
+  def self.all; @@all; end 
+#============================================================
+  # count 1839
+  def initialize(type="n/a", name, url) 
+    self.type = type
+    self.name = name
+    self.url = url
+    @@all << self
+  end
+#============================================================
+  def self.find_by(url) 
+    Meth.all.find{|m| m.url == url}
+  end
+#============================================================
+end

data/lib/ruby_doc/data/scraper.rb

@@ -0,0 +1,139 @@
+class Scraper < UI 
+#===========================Load Classes================================= 
+  def self.load_classes 
+    @counter = 0 #For Loading anim
+    loading_message#
+    
+    html = Nokogiri::HTML(open("https://ruby-doc.org/core-2.4.3/"))
+    icontainer = html.search("#class-index .entries")
+    
+    icontainer.search("p").each do |li| 
+      name = li.search("a").text
+      url = prefix + li.search("a")[0]["href"]
+      type = li["class"].capitalize
+      
+      # assigns - Klass :names, :urls
+      doc = Klass.new(type, name, url) if class_uniq(url)
+      # keeps copy in DocDB
+      $DocDB << doc if doc_uniq(url)
+    end  
+  end 
+#===========================Load Methods================================= 
+  def self.load_methods 
+    html = Nokogiri::HTML(open("https://ruby-doc.org/core-2.4.3/"))
+    icontainer = html.search("#method-index .entries")
+    
+    icontainer.search("a").each do |li|
+      name = li.text
+      url = prefix + li["href"]
+      type = "Method"
+      
+      # assigns - Method :names, :urls
+      doc = Meth.new("Method", name, url) if method_uniq(url) 
+      # keeps copy in DocDB
+      $DocDB << doc if doc_uniq(name)
+      
+      @counter += 1 #For Loading anim
+      loading_animation#
+    end
+  end 
+#==========================Load Class Doc================================ 
+  def self.load_class_doc(doc) 
+    html = Nokogiri::HTML(open(doc.url))
+#------------------------------------------------------------------------ 
+    # documentation
+    container = html.search("#description")
+    
+    short = container.search("p")[0].text + expand
+    
+    description = "" 
+    container.search("p, pre, h2").each {|p| description << p.text + "\n\n"} 
+    
+    # assign 
+    doc.short = short
+    doc.description = description
+#------------------------------------------------------------------------ 
+    # methods
+    methods = html.search("ul.link-list a")
+    
+    methods.each do |m| 
+      url = doc.url + m["href"] 
+      method = Meth.find_by(url) 
+      
+      doc.methods << method if class_method_uniq(doc, method)
+    end
+  end
+#=========================Load Method Doc================================ 
+  def self.load_method_doc(method) 
+    html = Nokogiri::HTML(open(method.url))
+#------------------------------------------------------------------------ 
+    # documentation
+    selector = "#"+method.url.gsub(/.+#method.{3}/, "")+"-method"
+    
+    if html.search("#{selector}").first["class"].include?("method-alias")
+      
+      conn = html.search("#{selector}").first.search("a")[1]["href"] 
+      rebuild = "#"+ conn.gsub(/.+#method.{3}/, "")+"-method" 
+      
+      container = html.search(rebuild)[0] 
+    
+      doc = "" 
+      doc << html.search("#{selector} div.aliases").first.text + "\n\n" 
+      container.search("p, pre, h2").each {|p| doc << p.text + "\n\n" }  
+      
+      # assign 
+      method.doc = doc
+    else
+      container = html.search(selector)[0]
+    
+      doc = "" 
+      container.search("p, pre, h2").each {|p| doc << p.text + "\n\n" } 
+      
+      # assign 
+      method.doc = doc
+    end 
+  end 
+#=======================================================================# 
+                                                             #HELPERS
+#======================================================================== 
+  def self.class_uniq(url) 
+    Klass.all.none?{|klass| klass.url == url}
+  end
+  
+  def self.method_uniq(url) 
+    Meth.all.none?{|method| method.url == url}
+  end
+  
+  def self.doc_uniq(url) 
+    $DocDB.none?{|doc| doc.url == url}
+  end
+  
+  def self.class_method_uniq(doc, method)
+    doc.methods.none?{|m| m == method }
+  end
+#------------------------------------------------------------------------ 
+  def self.prefix 
+    "https://ruby-doc.org/core-2.4.3/"
+  end
+  
+  def self.expand
+  "\nTo View Full Documentation Enter 'expand'".yellow
+  end
+#======================================================================== 
+  def self.changelog
+    html = Nokogiri::HTML(open("https://github.com/AlphaDaniel/ruby_doc/blob/master/changelog.md")) 
+    
+    puts html.search("#readme").text.gsub("\n    ", "").gsub("\n\n\n  ", "")
+  end
+  
+  def self.coming_soon
+    html = Nokogiri::HTML(open("https://github.com/AlphaDaniel/ruby_doc")) 
+    
+    list = ""
+    html.search("div#readme ul li").each do |li| 
+       list << ">> ".cyan + li.text + "\n"
+    end
+    list
+  end
+#======================================================================== 
+end

data/lib/ruby_doc/version.rb

@@ -1,3 +1,3 @@
 module RubyDoc
-  VERSION = "1.1.5"
+  VERSION = "2.0.0"
 end

data/ruby_doc.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["daniel.nunez.nyc@gmail.com"]
 
   spec.summary       = %q{A CLI Gem that scrapes Ruby documentation.}
-  spec.description   = %q{Ever get tired of leaving your editor/environment to google a method, or more in depth info on a class or module? This gem aims to make Ruby referencing quick and more importantly, LOCAL. Ruby Doc scrapes Ruby documentation and allows users to quickly reference Ruby Language methods and additional information all on your terminal. Have a query? run, hunt, and done. Never lose momentum, keep all things in your line of sight and get right back to coding. Enjoy.}
-  spec.homepage      = "https://github.com/AlphaDaniel/Alpha-Ruby_Doc"
+  spec.description   = %q{Ever get tired of leaving your editor/environment to google a method, or more in depth info on a class or module? \nThis gem aims to make Ruby referencing quick and more importantly, LOCAL. \n\nRuby Doc scrapes Ruby documentation and allows users to quickly reference Ruby Language methods and additional information all on your terminal. Have a query? run, hunt, and done. Never lose momentum, keep all things in your line of sight and get right back to coding. Enjoy.}
+  spec.homepage      = "https://github.com/AlphaDaniel/ruby_doc"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_doc
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel Nunez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,8 +107,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.1
 description: Ever get tired of leaving your editor/environment to google a method,
-  or more in depth info on a class or module? This gem aims to make Ruby referencing
-  quick and more importantly, LOCAL. Ruby Doc scrapes Ruby documentation and allows
+  or more in depth info on a class or module? \nThis gem aims to make Ruby referencing
+  quick and more importantly, LOCAL. \n\nRuby Doc scrapes Ruby documentation and allows
   users to quickly reference Ruby Language methods and additional information all
   on your terminal. Have a query? run, hunt, and done. Never lose momentum, keep all
   things in your line of sight and get right back to coding. Enjoy.
@@ -124,7 +124,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- Notes.md
 - README.md
 - Rakefile
 - bin/console
@@ -132,16 +131,16 @@ files:
 - bin/setup
 - changelog.md
 - config/environment.rb
-- lib/ruby_doc/data/data_extras.rb
-- lib/ruby_doc/data/doc.rb
-- lib/ruby_doc/data/meth.rb
-- lib/ruby_doc/data/scrapers.rb
-- lib/ruby_doc/ui/CLI.rb
-- lib/ruby_doc/ui/UI.rb
-- lib/ruby_doc/ui/ui_extras.rb
+- config/patches.rb
+- lib/ruby_doc/cli/cli.rb
+- lib/ruby_doc/cli/ui.rb
+- lib/ruby_doc/data/class.rb
+- lib/ruby_doc/data/data_processor.rb
+- lib/ruby_doc/data/method.rb
+- lib/ruby_doc/data/scraper.rb
 - lib/ruby_doc/version.rb
 - ruby_doc.gemspec
-homepage: https://github.com/AlphaDaniel/Alpha-Ruby_Doc
+homepage: https://github.com/AlphaDaniel/ruby_doc
 licenses:
 - MIT
 metadata: {}

data/Notes.md

@@ -1,37 +0,0 @@
-# NOTES:
-
-### SEARCH BY METHOD FEATURE:
-For now the search feature only searches all doc objects (iterating Doc.all)
-I would like to improve this to also search through all Meth objects.
-The issue here explained below...
-
-Population of all methods can only be done through scraping each individual
-doc page for all its meth urls. In this site, methods are spread out 
-and not available in their entirety, in a singular container or list. 
-
-Roadmap: In this CLI I pre-load all docs through Scraper.loadDOCS in 
-environment.rb before my exec is ran. When user first lands at UI.greeting
-all docs (objects) are already loaded.
-
-To initiate the scrape I need to retrieve a method for instantiation, 
-I pass in a Doc class object's url attribute. Since, as previously stated,
-ALL methods do not live in one place... The logical solution would be to 
-iterate through Doc.all, pass (obj).url to block and call Scraper.load_doc_page()
-passing in every iteration. This would essentially instantiate meth objects 
-for all methods included on all doc pages.
-
-2 big issues arise with this fact. The first and most important URI will not 
-let me iterate and open each page (redirection open loop error). 2nd, 
-even if we did we would be opening, scraping, and iterating through 
-2403 different site pages. As you can imagine this would not be practical
-
-Plan for improvement:
-I will be researching a way to patch this error so as to allow the iteration
-and if successful decide on implementation based on run time.
-
-If unsuccessful I will be looking into changing my scrapers to point to 
-http://ruby-doc.org/ which was my initial plan with this CLI. As this is 
-my very first CLI the layout of this site was a bit intimidating at first glance
-as far as scraping successfully. At the completetion of this CLI I am now 
-a lot more confident in my abilities so this will most likely be the way 
-I go. 

data/lib/ruby_doc/data/data_extras.rb

@@ -1,151 +0,0 @@
-module DataExtras # = foreign method
-#===================================================================== 
-                                                              #HELPERS
-#===================================================================== 
-  #@all set/get maker for Doc & Meth 
-  def self.extended(base) 
-    base.class_variable_set(:@@all, [])
-  end
-  
-  def all 
-    self.class_variable_get(:@@all)
-  end
-  
-  #UIExtras Shuttles 
-  def self.uie 
-    RubyDoc::CLI::UI
-  end
-  
-  def uie 
-    RubyDoc::CLI::UI
-  end
-#===================================================================== 
-                                                            #PAGINATOR
-#===================================================================== 
-  #PageLister
-  def list(page) 
-    page.each_with_index{|doc, index| uie.outputD(doc, index)}
-  end
-  
-  def self.list(page) 
-    page.each_with_index{|doc, index| uie.outputD(doc, index)}
-  end
-  
-  #PageShuttle
-  def self.nextPage(currentPg) 
-    case currentPg
-    when "Page1" 
-      page2
-    when "Page2" 
-      page3
-    when "Page3" 
-      page4
-    when "Page4" 
-      last
-    end
-  end
-#==============================PaginateAll============================ 
-  def paginateALL 
-    uie.sepL#
-    list(Doc.all[0..499])#
-    puts uie.sepR#
-    
-    uie.browseMenu#
-    uie.browseControl("Page1", Doc.all[0..499])#
-  end
-#================================Page 2=============================== 
-  def self.page2
-    uie.sepL#
-    list(Doc.all[500..999])#
-    puts uie.sepR#
-    
-    uie.browseMenu#
-    uie.browseControl("Page2", Doc.all[500..999])#
-  end
-#================================Page 3=============================== 
-  def self.page3
-    uie.sepL#
-    list(Doc.all[1000..1499])#
-    puts uie.sepR#
-    
-    uie.browseMenu#
-    uie.browseControl("Page3", Doc.all[1000..1499])#
-  end
-#================================Page 4=============================== 
-  def self.page4
-    uie.sepL#
-    list(Doc.all[1500..1999])#
-    puts uie.sepR#
-    
-    uie.browseMenu#
-    uie.browseControl("Page4", Doc.all[1500..1999])#
-  end
-#===============================Page Last============================= 
-  def self.last
-    uie.sepL#
-    list(Doc.all[2000..Doc.all.length])#
-    puts uie.sepR#
-    
-    uie.viewMenu#
-    uie.browseControl("Last", Doc.all[2000..Doc.all.length])#
-  end 
-#==============================Display Doc============================ 
-  def display(doc)
-    Scraper.loadDocPage(doc)#Load
-    
-    uie.sepL#
-    puts "Title: ".cyan + doc.name.upcase
-    puts "Type: ".cyan + doc.type.upcase
-    puts "\nDescription:".cyan
-    description = doc.description
-    puts uie.wrapped(description, 55)
-    puts "\nMethods: ".cyan + "#{doc.methods.count}".yellow
-    puts "Source: #{doc.url}".red 
-    puts uie.sepR#
-    
-    uie.docMenu(doc)#
-    uie.docControl(doc)#
-  end
-#==============================List Meths============================= 
-  def listMeths(doc)
-    uie.sepL#
-    doc.methods.each_with_index do |meth, index|  
-      puts "#{index + 1}. ".yellow + meth.cyan
-    end 
-    puts uie.sepR#
-    
-    uie.viewMenu#
-    uie.methListControl(doc)#
-  end
-#=============================Display Meth============================ 
-  def displayMeth(byName)
-    meth = Meth.find(byName)
-    Scraper.loadMethPage(meth)#Load
-    
-    uie.sepL#
-    puts "Title: ".cyan + meth.name.upcase
-    puts "Type: ".cyan + meth.type.upcase
-    puts "\nDescription:".cyan
-    description = meth.description
-    puts uie.wrapped(description, 55)
-    puts "\nSource: #{meth.url}".red
-    puts uie.sepR#
-    
-    uie.methMenu#
-    uie.methControl#
-    
-    RubyDoc::CLI.start if iN == "m"
-  end
-#=============================SUPER SEARCH============================ 
-  def superSEARCH(name)
-    uie.sepL#
-    matches = Doc.all.find_all{|doc| doc.name.downcase.include?(name)}
-    
-    uie.searchControl(matches)#
-    puts uie.sepR#
-    
-    uie.viewMenu#
-    uie.choiceControl(matches)#
-  end
-#=====================================================================
-end