ruby_doc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b09601af432f79494e4d3f0c09b02784dd3f0af1f760e004e9357ab88e042c5b
+  data.tar.gz: 76d41e4142c9f62c59032232e2041c71c6bd4fac536773353f9270711a287f4d
+SHA512:
+  metadata.gz: a72e71471748518ef5774a953c95ea54c874b15db028c5c4bb391ba655c0e06f6e425eb099f0c5c680886f8cb466f944e37d2bb8282e5c38bb5f27e6c695ff9a
+  data.tar.gz: 596a152273eaa76311f7a480761351535c429fc155db81e355d18025bf96073fc57dffe971b4a0a73c0978d30739a25cc9b2ea5660c4508c7c984fc74cb7e987

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Attack Notes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daniel.nunez.nyc@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby_doc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    ruby_doc (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    require_all (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  colorize
+  nokogiri
+  rake (~> 10.0)
+  require_all
+  ruby_doc!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alpha Daniel
+
+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,18 @@
+# Alpha Ruby Doc
+[![forthebadge](http://forthebadge.com/images/badges/powered-by-electricity.svg)](http://forthebadge.com)
+[![forthebadge](http://forthebadge.com/images/badges/pretty-risque.svg)](http://forthebadge.com)
+
+## Installation
+
+<!--![image](https://i.imgur.com/AeHWQj8.gif) -->
+<img src="https://i.imgur.com/AeHWQj8.gif" alt="image" width="790" height="170">
+
+```
+01010000 01101111 01101001 01101110 01110100 01110011 00100000 01100110 01101111 01110010 00100000 01100100 01101001 01101100 01101001 01100111 01100101 01101110 01100011 01100101 00100000 01101101 01111001 00100000 01100110 01110010 01101001 01100101 01101110 01100100 00100001 0001010 01000001 01110011 00100000 01100001 00100000 01110010 01100101 01110111 01100001 01110010 01100100 00100000 01101000 01100101 01110010 01100101 00100111 01110011 00100000 01101101 01111001 00100000 01000111 01100101 01101101 00100000 01000100 01100101 01110011 01100011 01110010 01101001 01110000 01110100 01101001 01101111 01101110 00101110 0001010 0001010 01010100 01101000 01101001 01110011 00100000 01110111 01101001 01101100 01101100 00100000 01100010 01100101 00100000 01100001 00100000 01000011 01001100 01001001 00100000 01000111 01100101 01101101 00100000 01110100 01101000 01100001 01110100 00100000 01110011 01100011 01110010 01100001 01110000 01100101 01110011 00100000 01010010 01110101 01100010 01111001 00100000 01100100 01101111 01100011 01110101 01101101 01100101 01101110 01110100 01100001 01110100 01101001 01101111 01101110 00100000 01100001 01101110 01100100 00100000 01100001 01101100 01101100 01101111 01110111 01110011 00100000 01110101 01110011 01100101 01110010 01110011 00100000 01110100 01101111 00100000 01110001 01110101 01101001 01100011 01101011 01101100 01111001 00100000 01110010 01100101 01100110 01100101 01110010 01100101 01101110 01100011 01100101 00100000 01010010 01110101 01100010 01111001 00100000 01001100 01100001 01101110 01100111 01110101 01100001 01100111 01100101 00100000 01101101 01100101 01110100 01101000 01101111 01100100 01110011 00100000 01100001 01101110 01100100 00100000 01100001 01100100 01100100 01101001 01110100 01101001 01101111 01101110 01100001 01101100 00100000 01101001 01101110 01100110 01101111 01110010 01101101 01100001 01110100 01101001 01101111 01101110 00101110 00100000 01010100 01101000 01101001 01110011 00100000 01110111 01101001 01101100 01101100 00100000 01100010 01100101 00100000 01110100 01101000 01100101 00100000 01100110 01101001 01110010 01110011 01110100 00100000 01101001 01101110 00100000 01100001 00100000 01110011 01100101 01110010 01101001 01100101 01110011 00100000 01101111 01100110 00100000 01000111 01100101 01101101 01110011 00100000 01110100 01101000 01100001 01110100 00100000 01100001 01100011 01100011 01101111 01101101 01110000 01101100 01101001 01110011 01101000 00100000 01110100 01101000 01100101 00100000 01110011 01100001 01101101 01100101 00100000 01100110 01101111 01110010 00100000 01101111 01110100 01101000 01100101 01110010 00100000 01101100 01100001 01101110 01100111 01110101 01100001 01100111 01100101 01110011 00101110 0001010 0001010 01000011 01101000 01100101 01100011 01101011 00100000 01000010 01100001 01100011 01101011 00100000 01010011 01101111 01101111 01101110 00101100 0001010 00101101 01000001 01101100 01110000 01101000 01100001 01000100 01100001 01101110 01101001 01100101 01101100
+```
+
+## But Seriously .... Check Back Soon
+
+![image](https://images.huffingtonpost.com/2013-08-23-tumblr_m08celcrnT1r3isxuo1_500.gif)
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative '../lib/environment'
+
+require "irb"
+
+IRB.start(__FILE__)
+

data/bin/ruby_doc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require_relative '../lib/environment'
+
+RubyDoc::CLI.iLoad
+
+

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+# Do any other automated setup that you need to do here

data/lib/environment.rb

@@ -0,0 +1,11 @@
+#===========Requires==========
+require 'require_all'
+require 'colorize'
+require 'pry'
+# require_all 'bin'
+require_all 'lib'
+#===========Scraping==========
+require 'open-uri'
+require 'nokogiri'
+#===========Patches===========
+def x; exit!; end #Quit Exit

data/lib/ruby_doc/data/data_extras.rb

@@ -0,0 +1,184 @@
+module DataExtras
+#==================important=================== 
+  #@all set/get maker 
+  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
+  
+  #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
+#===================================================================== 
+                                                            #PAGINATOR
+#===================================================================== 
+  def self.nextPage(currentPg)
+    case currentPg
+    when "Page1" 
+      page2
+    when "Page2" 
+      page3
+    when "Page3" 
+      page4
+    when "Page4" 
+      last
+    end
+  end
+#================================Page 1=============================== 
+  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
+=begin 
+  # NOTES: For now this 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. 
+=end
+#=====================================================================
+end

data/lib/ruby_doc/data/doc.rb

@@ -0,0 +1,20 @@
+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
+#==========================================================
+  def self.find(name)
+    self.all.find{|doc| doc.name.downcase == name.downcase}
+  end
+#==========================================================
+end

data/lib/ruby_doc/data/meth.rb

@@ -0,0 +1,18 @@
+class Meth
+#==================modules===================== 
+  extend DataExtras #sets/get @@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

@@ -0,0 +1,81 @@
+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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,28 @@
+module RubyDoc::CLI
+#==================modules===================== 
+  class UI 
+    extend UIExtras#
+    #inheriting: mainMenu, mainControl
+    extend DataExtras
+    #inheriting: paginateALL, superSEARCH(),
+    #displayMeth(), display()
+#============================================== 
+    def self.greeting 
+      mainMenu#
+      mainControl#
+    end
+    
+    def self.main_Shuttle(iN) 
+      iN == "b" ? paginateALL : superSEARCH(iN)
+    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

@@ -0,0 +1,247 @@
+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 
+    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.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
+    else 
+      docError(doc)
+    end 
+  end
+  
+  def methControl 
+    prompt
+    iN = alphaGets
+    
+    case iN
+    when "m" 
+      main
+    else 
+      methError
+    end 
+  end
+  
+  def methListControl(doc) 
+    prompt
+    iN = alphaGets
+    
+    if iN == "m" 
+      main
+    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
+

data/lib/ruby_doc/version.rb

@@ -0,0 +1,3 @@
+module RubyDoc
+  VERSION = "1.0.0"
+end

data/ruby_doc.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_doc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_doc"
+  spec.version       = RubyDoc::VERSION
+  spec.authors       = ["Daniel Nunez"]
+  spec.email         = ["daniel.nunez.nyc@gmail.com"]
+
+  spec.summary       = %q{A CLI Gem that scrapes Ruby documentation for quick referencing. This will be the first in a series of Gems that accomplish the same for other languages.}
+  spec.description   = %q{Ever get tired of leaving your editor/environment to google a method? This gem aims to make Ruby referencing quick and more importantly, LOCAL! Enjoy.}
+  spec.homepage      = "https://github.com/AlphaDaniel/alpha-ruby_docs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = ['ruby_doc']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "require_all"
+  spec.add_development_dependency "colorize"
+  spec.add_development_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: ruby_doc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Nunez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  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: colorize
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ever get tired of leaving your editor/environment to google a method?
+  This gem aims to make Ruby referencing quick and more importantly, LOCAL! Enjoy.
+email:
+- daniel.nunez.nyc@gmail.com
+executables:
+- ruby_doc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/ruby_doc
+- bin/setup
+- lib/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
+- lib/ruby_doc/version.rb
+- ruby_doc.gemspec
+homepage: https://github.com/AlphaDaniel/alpha-ruby_docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A CLI Gem that scrapes Ruby documentation for quick referencing. This will
+  be the first in a series of Gems that accomplish the same for other languages.
+test_files: []