ruby_doc 2.2.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 272850ea470347e025462827fb6429c161f1408afb96b87c63bbed09153a4d07
4
- data.tar.gz: e0578513904f9a86277d31d5790e95ed181b58df409fdc3ab0170b082b91e973
3
+ metadata.gz: e4fe15e521dcd2056a921187fed53cdbc186409b199619afc4253dbe4637fa22
4
+ data.tar.gz: cac283c304f1f74ee940397909d2a84262e5093c19aa0639be3c0112c15d16fd
5
5
  SHA512:
6
- metadata.gz: 62bb04ae57ecbcf6b77c832e367fae050369c8d0746cb97ffd15625efbc0d2d60863c20a130ffea1de2e8f00a61eab95e8012f4b5bc3849561e53b10bce9881b
7
- data.tar.gz: 80f48133dbda303531c01e3ac8a7ad3ddf4d44cb79ea65eb22fdaf00969393cbbd3ffd7c280bd72e80396a3a566c28ac6cb500f67131d3bd21673f3d63a4de4c
6
+ metadata.gz: 2d6db1dee06e3e531a84472bb796b258edaa1c2337e410d367f101909ce3c63f20c1bf729965142593b58c08cfe3e6eeba8f23c89ddd5c40ba0f9fb07cf63486
7
+ data.tar.gz: 8eb7eec03fa49c4b984ba1b253a0aa1181f01fc9a795d9622ae4fb25115bf7561fd006bf12b41b9fa41a2eecbf76c836e9b03bd45e75029b09cd675f356b357a
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- ruby_doc (2.2.0)
4
+ ruby_doc (2.2.1)
5
5
  colorize (~> 0.8.1)
6
6
  nokogiri (~> 1.8, >= 1.8.1)
7
7
 
data/README.md CHANGED
@@ -4,7 +4,8 @@
4
4
  ![fun](http://forthebadge.com/images/badges/powered-by-electricity.svg)
5
5
  ![fun](http://forthebadge.com/images/badges/pretty-risque.svg)
6
6
 
7
- [![Build Status](https://img.shields.io/travis/AlphaDaniel/ruby_doc.svg)](https://travis-ci.org/AlphaDaniel/ruby_doc)
7
+ <!--[![Build Status](https://img.shields.io/travis/AlphaDaniel/ruby_doc.svg)](https://travis-ci.org/AlphaDaniel/ruby_doc)-->
8
+
8
9
  [![Gem Version](https://img.shields.io/gem/v/ruby_doc.svg?&label=version&?&colorB=brightgreen)](https://rubygems.org/gems/ruby_doc)
9
10
  [![Release Date](https://img.shields.io/github/release-date/AlphaDaniel/ruby_doc.svg?colorB=49C529)](https://github.com/AlphaDaniel/ruby_doc/releases)
10
11
  [![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)
@@ -20,9 +21,9 @@
20
21
 
21
22
  **THE ULTIMATE RUBY DEVELOPER REFERENCING TOOL!**
22
23
 
23
- **Alpha Ruby Doc** aims to make Ruby referencing quick and painless. This gem scrapes Ruby documentation and allows users to quickly reference Ruby classes, modules and methods all on your terminal in STYLE!
24
+ **Alpha Ruby Doc** aims to make Ruby referencing quick and painless. This gem scrapes Ruby documentation and allows developers to quickly search or browse full documentation for classes, modules and/or methods. Including syntax examples, source Code, and even source links.
24
25
 
25
- Features include Search by Name, Paginated Browsing, Full documentation including Syntax and Source Code, Save to Favorites, Source Links, Seamless Navigation, and more.
26
+ Features include Search by Name, Paginated Browsing, Full documentation including Syntax and Source Code, Save to Favorites (persists), Source Links, Seamless Navigation, and more.
26
27
 
27
28
  Have a query? **Run, Hunt, and Done**. Never lose momentum, keep all things in your line of sight, and get right back to coding!
28
29
 
@@ -40,7 +41,7 @@ Have a query? **Run, Hunt, and Done**. Never lose momentum, keep all things in y
40
41
 
41
42
  ✓ Full documentation including description, syntax and source code!
42
43
 
43
- ✓ Save Docs to Favorites! for quick referencing
44
+ ✓ Save Docs to Favorites! for quick referencing (Persists)
44
45
 
45
46
  ✓ Browse all Documentation (Paginated Output To Terminal)
46
47
 
@@ -108,6 +109,10 @@ To Learn More (From Main Menu)
108
109
  To List Favorites (From Main Menu)
109
110
 
110
111
  $ *
112
+
113
+ To Reset Favorites (From Favorites Menu)
114
+
115
+ $ reset!
111
116
 
112
117
  ---
113
118
  ## Contributing
data/Rakefile CHANGED
@@ -3,7 +3,6 @@ require 'rspec/core/rake_task'
3
3
  task :default => :spec
4
4
 
5
5
  require_relative './config/environment'
6
- Scraper.load_classes and Scraper.load_methods
7
6
 
8
7
  task :console do
9
8
  Pry.start
@@ -1,4 +1,9 @@
1
- v2.1.2 (2018-03-21)
1
+ v2.2.1 (2018-03-21)
2
+ ------------------
3
+
4
+ * Patch - Favorites file path fix
5
+
6
+ v2.2.0 (2018-03-21)
2
7
  ------------------
3
8
 
4
9
  * Patch - Favorites now persist to gem directory, access globally
@@ -1,5 +1,4 @@
1
- # comment out before push
2
- # require_relative './patches'
1
+ require_relative './patches'
3
2
  #====================Requires==============================
4
3
  require "bundler/setup"
5
4
  require 'fileutils'
@@ -19,9 +18,11 @@ require_relative '../lib/ruby_doc/data/data_processor'
19
18
  $DocDB = []
20
19
  #========================Favorites=========================
21
20
  def fav_dir
22
- "#{Gem.path[0]}/gems/ruby_doc-#{RubyDoc::VERSION}/favs.txt"
21
+ File.expand_path("../favs.txt", __dir__)
22
+ # "#{Gem.path[0]}/gems/ruby_doc-#{RubyDoc::VERSION}/favs.txt"
23
23
  end
24
24
  FileUtils::touch "#{fav_dir}"
25
25
  #=========================Testing==========================
26
- # binding.pry
27
- #==========================================================
26
+
27
+ #==========================================================
28
+
@@ -1,15 +1,9 @@
1
1
  require_relative './environment'
2
+ #=============================================================
2
3
 
3
- require 'pry'
4
4
  #========================pry patches==========================
5
- #QUICK NEXT PRY
6
- Pry::Commands.alias_command 'n', 'exit'
7
- # hit next bind with 'x' instead of 'exit'
8
- # CUSTOMIZE: replace 'x' in code above with 'your_preference'
9
- #-------------------------------------------------------------
10
- #QUICK EXIT
11
- def x; exit!; end
12
- # exit pry session with 'x' instead of 'exit!'
13
- # CUSTOMIZE: replace 'xx' in code above with 'your_preference'
5
+ # comment out before push
6
+ # require 'pry'
7
+ # Pry::Commands.alias_command 'n', 'exit'
8
+ # def x; exit!; end
14
9
  #=============================================================
15
-
File without changes
@@ -3,7 +3,7 @@ class UI
3
3
  attr_reader :counter #For Loading Anim
4
4
  #===================Input======================
5
5
  def self.my_gets
6
- gets.strip.to_s.downcase
6
+ STDIN.gets.strip.to_s.downcase
7
7
  end
8
8
 
9
9
  def self.clear
@@ -1,3 +1,3 @@
1
1
  module RubyDoc
2
- VERSION = "2.2.0"
2
+ VERSION = "2.2.1"
3
3
  end
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ["daniel.nunez.nyc@gmail.com"]
11
11
 
12
12
  spec.summary = %q{THE ULTIMATE RUBY DEVELOPER REFERENCING TOOL!}
13
- spec.description = %q{Ruby Doc aims to make Ruby referencing quick and painless. This gem scrapes Ruby documentation and allows users to quickly reference Ruby classes, modules and methods all on your terminal in STYLE! Features include Search by Name, Paginated Browsing, Full documentation including Syntax and Source Code, Save to Favorites, Source Links, Seamless Navigation, and more. Have a query? Run, Hunt, and Done. Never lose momentum, keep all things in your line of sight, and get right back to coding!}
13
+ spec.description = %q{The ultimate Ruby developer tool. This gem scrapes Ruby documentation for quick referencing. Search or browse full documentation for classes, modules and/or methods. Including syntax examples, source Code, and even source links. Have a query? Run, Hunt, and Done. Never lose momentum, keep all things in your line of sight, and get right back to coding!}
14
14
  spec.homepage = "https://github.com/AlphaDaniel/ruby_doc"
15
15
  spec.license = "MIT"
16
16
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ruby_doc
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.0
4
+ version: 2.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel Nunez
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-03-21 00:00:00.000000000 Z
11
+ date: 2018-03-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -92,13 +92,11 @@ dependencies:
92
92
  - - ">="
93
93
  - !ruby/object:Gem::Version
94
94
  version: 1.8.1
95
- description: Ruby Doc aims to make Ruby referencing quick and painless. This gem scrapes
96
- Ruby documentation and allows users to quickly reference Ruby classes, modules and
97
- methods all on your terminal in STYLE! Features include Search by Name, Paginated
98
- Browsing, Full documentation including Syntax and Source Code, Save to Favorites,
99
- Source Links, Seamless Navigation, and more. Have a query? Run, Hunt, and Done.
100
- Never lose momentum, keep all things in your line of sight, and get right back to
101
- coding!
95
+ description: The ultimate Ruby developer tool. This gem scrapes Ruby documentation
96
+ for quick referencing. Search or browse full documentation for classes, modules
97
+ and/or methods. Including syntax examples, source Code, and even source links. Have
98
+ a query? Run, Hunt, and Done. Never lose momentum, keep all things in your line
99
+ of sight, and get right back to coding!
102
100
  email:
103
101
  - daniel.nunez.nyc@gmail.com
104
102
  executables:
@@ -121,6 +119,7 @@ files:
121
119
  - changelog.md
122
120
  - config/environment.rb
123
121
  - config/patches.rb
122
+ - favs.txt
124
123
  - lib/ruby_doc/cli/cli.rb
125
124
  - lib/ruby_doc/cli/ui.rb
126
125
  - lib/ruby_doc/data/class.rb