ruby_doc 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bea0d19c697dddd4a4a635c8ca69683c4b4567e6da992835d3cb376164f5aacf
-  data.tar.gz: c25bc2211e0be444657bbc1dcc5cc2d35a1e0772151219483e5f23e1d98d4321
+  metadata.gz: e38d7022794372628533e6570a4584f9c166c2ac75fc615391f3d26bb77139d2
+  data.tar.gz: b2d43d30a6a837db7e151e8dcb32aaf4c2a9f19066addafc163c58f3f193a5c8
 SHA512:
-  metadata.gz: 380b83296bc8a1bcf5edf9b6bc326403432fc6add4a6ba2557ac3432005fe542e60d22140f7d94e317cb096e30ab35658b7694ccfd5cbc7b4bbb0f4326293383
-  data.tar.gz: 9313cd4ac4162cb14cc52655e969f76ab4dcb8e3336c65e982bd96dc157c31c903675e38cf46f380dd2c9cfe5d757818765a633ec7fe381b607bc559bf11e7d5
+  metadata.gz: 7e311a89f49019a86467a64d50a0a33cf1ede6f8b735550bde2a8193db8daea2aa685bacea7503ea0715460f854aa8c59fec4dc93b3baab6c14d9303fe2e4dfd
+  data.tar.gz: b8c55f4db88df80d45dc65cd59c31a5b70f06564541fe3b901e8fcd5d8f8c1ce295ddba8595fe887964dd9395ba7070fb21819a7d5662bad0ef35541979c61e6

data/Notes.md

@@ -0,0 +1,37 @@
+# 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/README.md

@@ -15,14 +15,18 @@ Ever get tired of leaving your editor / environment to google a method, or more
 [![forthebadge](http://forthebadge.com/images/badges/thats-how-they-get-you.svg)](http://forthebadge.com)
 
 ![image](https://i.imgur.com/NmincSX.gif)
-### Features
-* Search by name
+### Features:
+* Search by Doc title
 * View related methods
 * Browse all Docs (Paginated Output To Terminal)
 * Source Links
 * Easy Navigation (Back To Main On Every Menu)
 * Random Dev Quotes (Ok This One Is Just For Fun Lol)
 
+### Coming Soon:
+* Search by method name ([See Notes](https://github.com/AlphaDaniel/alpha-ruby_doc/blob/master/Notes.md))
+* Multiple Doc sources
+
 ---
 ## INSTALLATION
 

data/lib/ruby_doc/data/data_extras.rb

@@ -146,41 +146,5 @@ module DataExtras
     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/version.rb

@@ -1,3 +1,3 @@
 module RubyDoc
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_doc
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Daniel Nunez
@@ -124,6 +124,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Notes.md
 - README.md
 - Rakefile
 - bin/console