ruby_doc 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 571d2f3fb80211c495f5fd0f8aa5190042b1174f6254dd6b3dc9af99ef5cadd8
-  data.tar.gz: 8eda5a9cc02ce582202f47040d7e81078775898999f3ce4e661d6858a4ae016e
+  metadata.gz: 23787b43ce20d4680b93a29e6a7721ea68995abdde3c16bb0393de33c14f5c06
+  data.tar.gz: 01326f6b467e6fd4b6e7b57c58b0e04ded7c0b24baf1b9648bf1543284fab932
 SHA512:
-  metadata.gz: 5d191f54742c6129c793669f5e662cee156ac1ba6c104f12fad129c8c8a1b43c96965637d9448339809e6f5b9c0cd8f10e242a6171eee5f317ebc0898ae62a39
-  data.tar.gz: 3e2b2b6146323ecd503f4d7072005a2c03c6521393f4e9df8d7bee2bb4c43a4c079add28834f16108c2b4cfb0240c23d3ad9e4575170f72156f2ca631096dcdf
+  metadata.gz: 9589e5b3c8d6d75f68ef31c9f8976a4cc15da85acc4fddaa83544a84d5440493edbbe95b8a4ab0a8618d455c535a1640162d336915c2c3f980cbe83922db7aac
+  data.tar.gz: d5f3ac5eca09fb1a85a7e4df0cb9f726cc0690ebda230645325088a60d755ba3afb269285d616ef97a01b20d8f8b2d7b15a952cc75877f9423b080e5a33e3946

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.3
+branches:
+  only:
+    - master

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_doc (2.0.2)
+    ruby_doc (2.0.3)
       colorize (~> 0.8.1)
       nokogiri (~> 1.8, >= 1.8.1)
 

data/README.md

@@ -4,9 +4,10 @@
 ![fun](http://forthebadge.com/images/badges/powered-by-electricity.svg) 
 ![fun](http://forthebadge.com/images/badges/pretty-risque.svg)
 
-[![Gem Version](https://img.shields.io/gem/v/ruby_doc.svg?&label=latest%20version&?&colorB=3FB911)](https://rubygems.org/gems/ruby_doc)
+[![Build Status](https://img.shields.io/travis/AlphaDaniel/ruby_doc.svg)](https://travis-ci.org/AlphaDaniel/ruby_doc)
+[![Gem Version](https://img.shields.io/gem/v/ruby_doc.svg?&label=version&?&colorB=brightgreen)](https://rubygems.org/gems/ruby_doc)
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/ruby_doc?type=total&color=brightgreen)](https://rubygems.org/gems/ruby_doc)
 [![GitHub last commit](https://img.shields.io/github/last-commit/AlphaDaniel/alpha-ruby_doc.svg)](https://github.com/AlphaDaniel/alpha-ruby_doc/commits/master)
-[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/ruby_doc/?type=total&color=brightgreen)](https://rubygems.org/gems/ruby_doc)
 [![Changelog](https://img.shields.io/badge/change-log-blue.svg)](https://github.com/AlphaDaniel/alpha-ruby_doc/blob/master/changelog.md)
 [![Site](https://img.shields.io/badge/Alpha-Coding-blue.svg?&colorB=0F80C0&?&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAIAAACQKrqGAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyFpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw%2FeHBhY2tldCBiZWdpbj0i77u%2FIiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8%2BIDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTQyIDc5LjE2MDkyNCwgMjAxNy8wNy8xMy0wMTowNjozOSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIChXaW5kb3dzKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo4OUY5MDgyNzE4RjQxMUU4QjBCREE1NUVCQkYxMDJFMiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDo4OUY5MDgyODE4RjQxMUU4QjBCREE1NUVCQkYxMDJFMiI%2BIDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjg5RjkwODI1MThGNDExRThCMEJEQTU1RUJCRjEwMkUyIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjg5RjkwODI2MThGNDExRThCMEJEQTU1RUJCRjEwMkUyIi8%2BIDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY%2BIDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8%2BLUvNgAAAAkRJREFUeNocUFtP02AY7td%2BbVfoGFvHzmxjgzEOc0ETb0BvQCFMgfhzvPAQNPwSEm%2BJiTEBEhQvxDsUOQSyMoSxso2Vtmv7de3qp%2B%2FFk%2FfiyXMCoUg4Gk0kUtn00NDau9cHh8dvVt%2B7Tof39uuaYtlOQ6riZ3h0ggqHIwEh1BcIsiwTHBgYTCSqUj0UifC8j4a0CwDDsMg0EDLB3EKJ6%2B0LCIKnh%2Ff5fE3pcndnW2%2FrNMOEI7HceBFZmKafHv%2BGPV4%2F62Ep2tPLewkKbn7%2BdHEuEv%2FPdpyphzNewJuIR2mDHM3nUqlkUOj3%2B%2F33p4r3CgVMgpDCOJLLPV2YG5%2BcrNfrlfIZXH310nEcXddlVfv29Uuz2finZzsYGYo8Odjf3Nm9vhAtsw1xCWRZXaxEgoOf%2BxzHZTMZRVUASZ5Xzre3tm5bius62IeifcGjsnh1c%2BsCcrH0TPD3tzXVw3oUrT09PfN2dU2W78TymWkalAWAcqcCSBuW1ek4zdplRRQ1Q7%2BRpOdLK%2FmJQiQ%2BGIzG2qpG4kCQAkqrURHLDOFqqlqTpNOTE0AQeCbbtmVNjSXTC8svIM6k3MldlyiMhR8Ux%2FMjqXQ282F9HUJ6aXklGhZasrz365DDkt0O6iDD1NXF%2BVmG5apX1x83NnieJwgXWR3HcTOp5HAyjvfBxSDOWHr0OB6Nmggh2%2BF4H0lSXar9p9YIBEMcyxTH8s3WLbQMIxYfnJ19gveq3jRqij4zvzQgBE6PDve%2B%2F%2BjhPMPZNMuwtOv%2BFWAADfsWB%2FHBnC4AAAAASUVORK5CYII%3D)](http://a1phacoding.com/)
 

data/Rakefile

@@ -1,8 +1,11 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 task :default => :spec
 
 require_relative './config/environment'
 
 task :console do
   Pry.start
-end
+end
+
+RSpec::Core::RakeTask.new

data/changelog.md

@@ -1,3 +1,9 @@
+v2.0.3 (2018-02-24)
+------------------
+
+* Patch - Fixed repeat methods
+* User X - Made default doc view short with option to view full by request. Felt was a cleaner look and helps avoid extra scrolling if user chooses wrong doc index #. 
+
 v2.0.2 (2018-02-23)
 ------------------
 

data/lib/ruby_doc/cli/ui.rb

@@ -5,6 +5,10 @@ class UI
   def self.my_gets 
     gets.strip.to_s.downcase
   end
+  
+  def self.clear 
+    system "clear" or system "cls"
+  end
 #==================Control===================== 
   def self.main_control 
     prompt
@@ -17,9 +21,10 @@ class UI
     elsif input == "exit!" 
       exit!
     elsif input == "?" 
+      clear
       learn_more
     else 
-      matches = Processor.search(input)
+      matches = Processor.search(input) 
       
       search_error if matches.empty?
       search_list(matches) if matches
@@ -31,6 +36,8 @@ class UI
     input = my_gets
     
     case input
+    when "full" 
+      display_class(doc, "full")
     when "1" 
       method_list(doc)
     when "m" 
@@ -106,12 +113,20 @@ class UI
   end
 #==================Display===================== 
 #-------------------docs----------------------- 
-  def self.display_class(doc) 
+  def self.display_class(doc, view="short") 
     UI.sepL
     puts "TITLE: ".cyan + doc.name.upcase 
     puts "TYPE: ".cyan + doc.type.upcase
     puts "\nDESCRIPTION:".cyan 
-    puts doc.documentation
+    
+    if view == "short"
+      puts wrapped(doc.short) 
+      puts view_full
+      
+    elsif view == "full"
+      puts doc.documentation
+    end
+    
     puts "Methods: ".cyan + "#{doc.methods.count}".yellow
     puts "Source: #{doc.url}".red 
     puts sepR
@@ -120,10 +135,6 @@ class UI
     display_class_control(doc)
   end
   
-  def self.view_full
-  "\nTo View Full Documentation Enter 'full'\n".cyan
-  end # put back in strings
-  
   def self.display_method(doc) 
     UI.sepL
     puts "Title: ".cyan + doc.name.upcase 
@@ -205,6 +216,8 @@ class UI
 #-----------------learn more------------------- 
   def self.learn_more 
     puts "\n" + sepB
+    puts wrapped("Alot in store for this section. For now more so a placeholder but feel free to see what's on the way, and what's been done below.").black
+    puts sepB
     puts "COMING SOON".cyan
     puts sepB
     puts "\n" + Scraper.coming_soon + "\n"
@@ -214,18 +227,18 @@ class UI
     puts sepB
     puts "\n" + Scraper.changelog
     
-    main_menu
+    main_menu("learn")
     main_control
   end
 #===================Menus====================== 
-  def self.main_menu 
+  def self.main_menu(from="default") 
     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
     sepB
-    puts "Enter '?' to Learn More about Alpha Ruby-Doc".black
+    puts "Enter '?' to Learn More about Alpha Ruby-Doc".black unless from == "learn"
     print cyanH("\n If You're Searching... Single Word Inputs Only Please ")
   end
   
@@ -271,14 +284,15 @@ class UI
   end
   
   def self.search_error 
-    puts "\nNO CIGAR!".red
+    puts sepB
+    puts "NO 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
-    sepB
+    puts sepB
     
-    puts "\nNOT SURE?".red
+    puts "NOT SURE?".red
     puts "You can always browse with ".black + "'b'" + " & learn something new.".black + ":)"
-    sepB
+    puts sepB
     
     print redH("\n Try a new word, enter 'b' to browse, or 'exit!' to leave ")
     main_control
@@ -288,7 +302,7 @@ class UI
     print redH("\n Enter selection number, 'm' for main or 'exit!' to leave ")
   end
   
-  def self.nil_error
+  def self.nil_error 
     print redH("\n Enter selection number, 'm' for main or 'exit!' to leave ")
   end
   
@@ -317,8 +331,9 @@ class UI
   end
 #============================================== 
                                         #CANDY
-#===============Quote Scraper================== 
-  def self.randQ
+#================== Quotes===================== 
+  def self.randQ 
+    puts sepB
     html = Nokogiri::HTML(open("https://fortrabbit.github.io/quotes/"))
     container = html.search(".row.gutter-l.wrap")
     
@@ -373,10 +388,14 @@ class UI
     "https://ruby-doc.org/core-2.4.3/"
   end
   
-  # view_full here
-  
+  def self.view_full 
+    puts sepB
+    puts "To View Full Documentation Enter".cyan + " full".yellow
+    puts sepB
+  end 
+    
   # currently not being used
-  def self.wrapped(s, width=78) 
+  def self.wrapped(s, width=60) 
 	  lines = []
 	  line = ""
 	 

data/lib/ruby_doc/data/data_processor.rb

@@ -29,7 +29,7 @@ class Processor
   end
 #================================SEARCH=============================== 
   def self.search(name)
-    matches = $DocDB.find_all{|doc| doc.name.downcase.include?(name)}
+    $DocDB.find_all{|doc| doc.name.downcase.include?(name)}
   end
 #=====================================================================
 end

data/lib/ruby_doc/data/scraper.rb

@@ -29,7 +29,7 @@ class Scraper < UI
       type = "Method"
       
       # assigns - Method :names, :urls
-      doc = Meth.new("Method", name, url) if method_uniq(url) 
+      doc = Meth.new("Method", name, url) if method_uniq(name) 
       # keeps copy in DocDB
       $DocDB << doc if doc_uniq(name)
       
@@ -43,7 +43,7 @@ class Scraper < UI
 #--------------------------documentation--------------------------------- 
     container = html.search("#description")
     
-    short = container.search("p")[0].text + UI.view_full
+    short = container.search("p")[0].text + "\n"
     
     text = "" 
     container.search("p, pre, h2").each {|p| text << p.text + "\n\n"} 
@@ -81,7 +81,6 @@ class Scraper < UI
       
       # assign 
       doc.documentation = text
-    # default
     else
       container = html.search(selector)[0]
     
@@ -97,19 +96,19 @@ class Scraper < UI
     Klass.all.none?{|klass| klass.url == url}
   end
   
-  def self.method_uniq(url) 
-    Meth.all.none?{|method| method.url == url}
+  def self.method_uniq(name)  
+    Meth.all.none?{|method| method.name == name}
   end
   
-  def self.doc_uniq(url) 
-    $DocDB.none?{|doc| doc.url == url}
+  def self.doc_uniq(name) 
+    $DocDB.none?{|doc| doc.name == name}
   end
   
   def self.class_method_uniq(doc, method)
     doc.methods.none?{|m| m == method }
   end 
-#======================================================================== 
-  def self.coming_soon
+#===========================LEARN MORE=================================== 
+  def self.coming_soon 
     html = Nokogiri::HTML(open("https://github.com/AlphaDaniel/ruby_doc/blob/master/README.md")) 
     
     list = ""

data/lib/ruby_doc/version.rb

@@ -1,3 +1,3 @@
 module RubyDoc
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_doc
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Daniel Nunez
@@ -120,6 +120,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock