ruby_doc 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87adb893e411ac96818aa6c5a04d8994e11d5aa2736a58fed3f6a2ce59f57ee
-  data.tar.gz: 0a0402c800b03c74cd796b4025dc84579e02cc58eb91d233daf07c85659317b0
+  metadata.gz: 272850ea470347e025462827fb6429c161f1408afb96b87c63bbed09153a4d07
+  data.tar.gz: e0578513904f9a86277d31d5790e95ed181b58df409fdc3ab0170b082b91e973
 SHA512:
-  metadata.gz: 46195b07b8bdb1d452b231245e6b48db6f44462a74dd65c1450f9bddbb3f936129041912ccc22d9184ee93b5879a408c415145e5b089aa21babf3858d3bbfdca
-  data.tar.gz: d0eb31478f4fb7e08d8d988fd9ac041a274bb9c1a556693a97f4af37fbf0f1f402937b99f816a5c487686c7e9df30dd660419321b8fc3f97e4148d34ff87fc95
+  metadata.gz: 62bb04ae57ecbcf6b77c832e367fae050369c8d0746cb97ffd15625efbc0d2d60863c20a130ffea1de2e8f00a61eab95e8012f4b5bc3849561e53b10bce9881b
+  data.tar.gz: 80f48133dbda303531c01e3ac8a7ad3ddf4d44cb79ea65eb22fdaf00969393cbbd3ffd7c280bd72e80396a3a566c28ac6cb500f67131d3bd21673f3d63a4de4c

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    ruby_doc (2.2.0)
+      colorize (~> 0.8.1)
+      nokogiri (~> 1.8, >= 1.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.7, >= 3.7.0)
+  ruby_doc!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -6,12 +6,13 @@
 
 [![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)
-[![Release Date](https://img.shields.io/github/release-date/AlphaDaniel/ruby_doc.svg)](https://github.com/AlphaDaniel/ruby_doc/releases)
-[![Downloads](https://img.shields.io/gem/dt/ruby_doc.svg)](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)
+[![Release Date](https://img.shields.io/github/release-date/AlphaDaniel/ruby_doc.svg?colorB=49C529)](https://github.com/AlphaDaniel/ruby_doc/releases)
+[![GitHub last commit](https://img.shields.io/github/last-commit/AlphaDaniel/alpha-ruby_doc.svg?colorB=49C529)](https://github.com/AlphaDaniel/alpha-ruby_doc/commits/master)
 [![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/)
 
+[![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/ruby_doc?type=total&?&style=social)](https://rubygems.org/gems/ruby_doc)
+
 ---
 ## A CLI Gem That Scrapes Ruby Documentation
 
@@ -31,7 +32,7 @@ Have a query? **Run, Hunt, and Done**. Never lose momentum, keep all things in y
 ## A Look Inside
 [![forthebadge](http://forthebadge.com/images/badges/thats-how-they-get-you.svg)](http://forthebadge.com)
 
-![image](https://i.imgur.com/qAW4sNY.gif)
+![screenshots](https://i.imgur.com/UuEwILB.gif)
 
 ---
 ### Features:
@@ -83,6 +84,10 @@ And then execute
 #### For Yourself:
 
      $ gem install ruby_doc
+     
+And then execute
+
+     $ bundle     
 
 
 ---

data/Rakefile

@@ -3,6 +3,7 @@ require 'rspec/core/rake_task'
 task :default => :spec
 
 require_relative './config/environment'
+Scraper.load_classes and Scraper.load_methods
 
 task :console do
   Pry.start

data/bin/ruby_doc

@@ -1,15 +1,5 @@
 #!/usr/bin/env ruby
-#======================================= 
+#============================================================= 
 require_relative '../config/environment'
-#=======================================
-# if dir does not exist
-if !File.exist?('usr')
-  # Creates usr dir
-  FileUtils::mkdir 'usr'
-  # Creates favorites.txt
-  FileUtils::touch 'usr/favorites.txt'
-end
-#=======================================
-RubyDoc::CLI.start_load
-
-
+#=============================================================
+RubyDoc::CLI.start_load

data/changelog.md

@@ -1,3 +1,9 @@
+v2.1.2 (2018-03-21) 
+------------------
+
+* Patch - Favorites now persist to gem directory, access globally
+* Feature - Reset favorites option on favorites menu.
+
 v2.1.1 (2018-03-01) 
 ------------------
 

data/config/environment.rb

@@ -1,21 +1,27 @@
-#====================Requires===================
+# comment out before push
+# require_relative './patches'
+#====================Requires==============================
 require "bundler/setup"
 require 'fileutils'
 require 'colorize'
 require 'open-uri'
 require 'nokogiri'
-# require_relative './patches'
 require_relative '../lib/ruby_doc/version'
-#======================Cli======================
+#===========================Cli============================ 
 require_relative '../lib/ruby_doc/cli/cli'
 require_relative '../lib/ruby_doc/cli/ui'
-#=====================Data======================
+#===========================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===================
+#=========================DataBase========================= 
 $DocDB = []
-#====================Testing====================
-
-#===============================================
+#========================Favorites========================= 
+def fav_dir
+"#{Gem.path[0]}/gems/ruby_doc-#{RubyDoc::VERSION}/favs.txt"
+end
+FileUtils::touch "#{fav_dir}"
+#=========================Testing========================== 
+# binding.pry
+#========================================================== 

data/lib/ruby_doc/cli/ui.rb

@@ -36,7 +36,10 @@ class UI
     prompt
     input = my_gets
     
-    if input == "m" 
+    if input == "reset!"
+      Processor.reset_favs
+      RubyDoc::CLI.start
+    elsif input == "m" 
       RubyDoc::CLI.start
     elsif input == "exit!"
       exit!
@@ -181,7 +184,7 @@ class UI
   def self.favorites_list 
     # Normalize Favorites List
     list = []
-    File.open("usr/favorites.txt").each do |li| 
+    File.open("#{fav_dir}").each do |li| 
       list << li.chomp
     end
     
@@ -192,8 +195,6 @@ class UI
       
     else
       puts sepL
-      puts favorites_message
-      puts sepB
       
       # Iterated and display normalized favorites list
       list.each_with_index do |f, index| 
@@ -272,16 +273,12 @@ class UI
     puts sepB
     puts "FAVORITES".cyan
     puts sepB
-    puts wrapped("In this early version of the favorites feature there are a few things to note, for this to work properly.", 55)
-    puts "\n"
-    puts wrapped("When you install ruby_doc we create a dir (usr) with a file inside (favorites.txt) in your current directory. In order for favorites to read from this file and output your saved entries this dir/file must remain in your current dir.", 55)
+    puts wrapped("Favorites now persisting to gem directory. Your favorites will be accessible globally throughout all your directories unless/until you uninstall this gem.", 55)
     puts "\n"
-    puts wrapped("If at any point you switch directories and want to have access to your favorites simply copy or move the (usr) dir to the root/top level of the directory you'd like to have access to your ruby_doc favorites in.", 55)
+    puts wrapped("When updating this gem, ruby_doc will check if your favorites file contains any entries (you have favorites saved). If you have entries at the time of the update, it will copy your favorites over to your new (version) gem directory so that you never lose your entries.", 55)
     puts "\n"
-    puts "Please do not modify this file!".red
-    puts wrapped("If you do accidentally, and encounter any problems displaying, do the following. Open the favorites.txt file in your usr dir and make sure each entry is on a new/separate line. If you still have issues you will have to delete your usr folder. When you run ruby_doc again it will check for the usr dir, if it doesn't exist, it will create a new one for you. Would be a good idea to save your entries before deleting usr for reference.", 55)
-    puts "\n"
-    puts wrapped("This is something that obviously will be improved to persist through all your directories in the future, but give me time. Thanks for using RUBY DOC!", 55)
+    puts "Note:".red
+    puts wrapped("The aforementioned 'Update Proof' will not be coded in until the next update but it won't be needed until then regardless so save away.", 55)
     
     puts sepB
     puts "COMING SOON".cyan
@@ -309,6 +306,7 @@ class UI
   
   def self.list_menu(matches) 
     puts "View Doc ".light_cyan + "(".cyan + "#".yellow + ")".cyan 
+    puts "Reset Favorites ".light_cyan + "(".cyan + "reset!".yellow + ")".cyan  if matches.first.is_a?(String)
     puts "Return To ".cyan + "Main Menu ".light_cyan + "(".cyan + "m".yellow + ")".cyan
     puts "Leave".light_cyan + " (".cyan + "exit!".yellow + ")".cyan
     print randQ
@@ -372,7 +370,11 @@ class UI
   end
   
   def self.list_error(matches) 
-    print redH("\n Enter selection number, 'm' for main or 'exit!' to leave ")
+    if matches.first.is_a?(String)
+      print redH("\n Enter '#' to view, 'reset!', 'm' for main or 'exit!' to leave ")
+    else
+      print redH("\n Enter selection number, 'm' for main or 'exit!' to leave ")
+    end
   end
   
   def self.nil_error 
@@ -449,8 +451,12 @@ class UI
     "=".black*56
   end
 #------------------messages-------------------- 
-  def self.favorites_message 
-    "Please Note: ".black + "/usr".light_black + " dir must exist in your current dir for\nthis to work. To learn more go to main menu & enter (".black + "?" + ")".black
+  def self.reset_favs_message
+    puts sepB
+    puts "Favorites Deleted!".red
+    puts "Redirecting to main menu ..."
+    puts sepB
+    sleep(2.5)
   end
   
   def self.redH(str) 

data/lib/ruby_doc/data/data_processor.rb

@@ -31,7 +31,7 @@ class Processor
   def self.save(doc) 
     # if entry does not exist write else inform entry exist
     if uniq(doc) 
-      File.open("usr/favorites.txt", "a"){|l| l.puts doc.name}
+      File.open("#{fav_dir}", "a"){|l| l.puts doc.name}
       puts "\r"
       print doc.name.cyan + " Saved!".light_cyan
       
@@ -46,14 +46,20 @@ class Processor
   
   def self.uniq(doc) # save(doc) Helper Method 
     # read => uniq boolean
-    File.open("usr/favorites.txt").none?{|l| l.chomp == doc.name}
+    File.open("#{fav_dir}").none?{|l| l.chomp == doc.name}
   end
 #===============================Find Fav============================== 
   def self.find_fav(name) 
     doc = $DocDB.find{|doc| doc.name == name}
     
     load_doc(doc) 
-  end  
+  end 
+#==============================Reset Favs============================= 
+  def self.reset_favs 
+    open("#{fav_dir}", File::TRUNC) {}
+    
+    UI.reset_favs_message
+  end
 #================================SEARCH=============================== 
   def self.search(name)
     $DocDB.find_all{|doc| doc.name.downcase.include?(name)}

data/lib/ruby_doc/version.rb

@@ -1,3 +1,3 @@
 module RubyDoc
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/ruby_doc.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'rspec', '~> 3.7', '>= 3.7.0'
-  # spec.add_development_dependency "pry", "~>0.11.3"
-#============================================== 
+#============================================================== 
   spec.add_dependency "colorize", "~>0.8.1"
   spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.1'
-#============================================== 
+#==============================================================   
+  # comment out before push
+  # spec.add_development_dependency "pry", "~>0.11.3"
+#============================================================== 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_doc
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Daniel Nunez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -128,7 +129,6 @@ files:
 - lib/ruby_doc/data/scraper.rb
 - lib/ruby_doc/version.rb
 - ruby_doc.gemspec
-- usr/favorites.txt
 homepage: https://github.com/AlphaDaniel/ruby_doc
 licenses:
 - MIT