what_is_this 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1112bb7dbac5f06df1fe1f7ebde61e4168499cc60760a68a5cad074eaca11981
-  data.tar.gz: ffc5c584ea9a08f64a6e5946ac4e8768fde004c5c8ccf4f0ded93ab50d2c9d6b
+  metadata.gz: 29cd24ea75288081beea53193b57bc165fa2a892bafb90587b7d3bbe0b1425c2
+  data.tar.gz: a57d2dd84df593b79813bb8559246813d1611b84e3e86b9f9d837d45115bbb6d
 SHA512:
-  metadata.gz: 16d3ada75e602b8104464c02bcf0bd2b8b4c368977dfe5dee3cb4af88625c80925b4d262e33753d0e3d0b0e71dd2ca8ad1e74765bb2241f993f3f9c6f1e2c0f9
-  data.tar.gz: 591a65e4f463af5ac6dceba653845c679323550fda7b4b52ce7c37958402c9e87201490ffc46d1b2e1278af276b1b4e4493d8e571ebf586428f9d3a9d1ea5f79
+  metadata.gz: f008c6c14f4cdc300d31155dbb6a034458a41bef044a779deb1fec426f314863907d3ec58bbb9c9b212e692ee444e8e261939e21a1bcb420c573463725fbdc84
+  data.tar.gz: b150566f6a2605f797679e183bd5fc4d09fac2cb7557ce9d51919b3088dac3a6f27dd9727e351cfbfd529184f8a9d03105cf4ff4dc342a266fe2b025af04a466

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    what_is_this (0.1.0)
+    what_is_this (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/bin/what_is_this

@@ -1,4 +1,3 @@
 #!/ usr/bin/env ruby
 require_relative "../lib/what_is_this"
-
 CLI.introduction

data/config/environment.rb

@@ -0,0 +1,5 @@
+require 'cgi'
+require 'open-uri'
+require 'nokogiri'
+
+

data/lib/what_is_this/Advanced_Search.rb

@@ -1,5 +1,5 @@
 class CLI::AdvancedSearch
-    attr_accessor :name, :markup, :downloads
+    attr_accessor :name, :markup, :downloads, :id
     @@spacing = "\n\n\n"
     @@message_spacing = "         "
     @@current_query = ""
@@ -7,18 +7,20 @@ class CLI::AdvancedSearch
 
     @@all = []
 
-    def initialize(name = nil, markup = nil, downloads = nil )
+    def initialize(name = nil, markup = nil, downloads = nil, id = nil )
         @name = name
         @markup = markup
         @downloads = downloads
+        @id = id
         @@all << self
     end
     def self.new_from_query
-        Approx_Scraper.approx_names(@doc).each_with_index do |each, index|
+        CLI::Approx_Scraper.approx_names(@doc).each_with_index do |each, index|
             self.new(
-                Approx_Scraper.approx_names(@doc)[index],
-                Approx_Scraper.approx_markups(@doc)[index],
-                Approx_Scraper.approx_downloads(@doc)[index]
+                CLI::Approx_Scraper.approx_names(@doc)[index],
+                CLI::Approx_Scraper.approx_markups(@doc)[index],
+                CLI::Approx_Scraper.approx_downloads(@doc)[index],
+                index + 1
             )
         end
         display_data
@@ -57,6 +59,7 @@ class CLI::AdvancedSearch
    
     def self.advanced_search_scrape(query, page = 1)
         url = "https://rubygems.org/search?page=#{page}&query=#{query}"
+        puts url
         @doc = Nokogiri::HTML(open(url)) 
         self.new_from_query
 
@@ -77,6 +80,23 @@ class CLI::AdvancedSearch
             self.advanced_search_properties
         end
     end
+    def self.post_search_query
+        search_results_found = CLI::Scraper_Tools.page(@doc)
+        max_pages = (search_results_found / 30).ceil
+
+        puts "Displaying page #{@@page} out of #{max_pages}"
+        temp_page = @@page
+        @@page = CLI::Scraper_Tools.navigate(@@page, max_pages, @@all)
+        
+        if (temp_page != @@page)
+            self.clear_all_instances
+        end
+        self.advanced_search_scrape(@@current_query, @@page)
+
+    end
+    def self.clear_all_instances
+        @@all = []
+    end
     def self.display_data
         puts "======================================================="
         begin
@@ -85,6 +105,8 @@ class CLI::AdvancedSearch
                 @@all.each do |each|
                     puts "---------------------------------"
                     puts ''
+                    puts "##{each.id}"
+                    puts ''
                     puts "About: #{each.name}"
                     puts ''
                     puts "Markup: #{each.markup}"
@@ -93,46 +115,23 @@ class CLI::AdvancedSearch
                     puts ''
                     puts "---------------------------------"
                 end
-                search_results_found = @@all.length
-                puts "#{search_results_found} results found"
-                puts Approx_Scraper.page(@doc)
-                if (Approx_Scraper.check_pagination(@doc) != "")
-                    @@page = self.navigate(@@page)
-                    self.advanced_search_scrape(@@current_query, @@page)
-                end
-                self.restart
+                
+            if (CLI::Scraper_Tools.check_pagination(@doc) != "")
+                self.post_search_query
+                
+            end
+                CLI.restart
             else
                 puts "0 search results found"
                 self.restart
             end
         rescue => error
             puts error.message
-            self.retry
-        end
-        
-    end
-    def self.navigate(page)
-        puts @@spacing + @@message_spacing + "To navigate type 'forward'(f) or 'back'(b), or 'home' to go back"
-        input = gets.chomp.to_str.downcase
-        case input
-        when "forward", "f"
-            self.forward(page)
-        when "back", "b"
-            self.back(page)
-        when "home"
-            CLI.restart
-        else
-            puts "Unrecognised command, try again"
-            self.navigate
+            CLI::Scraper_Tools.retry
+            self.restart
         end
-
-    end
-    def self.forward(page)
-        page += 1
         
     end
-    def self.back(page)
-        page -=1 unless page < 1
-    end
+    
 
 end

data/lib/what_is_this/Approx_Scraper.rb

@@ -1,5 +1,5 @@
 class CLI::Approx_Scraper
-    attr_accessor :name, :markup, :downloads
+    attr_accessor :name, :markup, :downloads, :id
     @@page = 1
     @@current_query = ""
 
@@ -11,20 +11,25 @@ class CLI::Approx_Scraper
         @doc = Nokogiri::HTML(open(url))
         self.new_from_query
     end
-    def initialize(name=nil, markup=nil, downloads=nil)
+    def initialize(name=nil, markup=nil, downloads=nil, id=nil)
         @name = name
         @markup = markup
         @downloads = downloads
+        @id = id
         @@all << self
     end
     def self.new_from_query
+        
         approx_names(@doc).each_with_index do |each, index|
             self.new(
                 approx_names(@doc)[index],
                 approx_markups(@doc)[index],
-                approx_downloads(@doc)[index]
+                approx_downloads(@doc)[index],
+                index + 1
+
             )
         end
+        
         display_approx
     end
     def self.approx_names(doc)
@@ -42,22 +47,26 @@ class CLI::Approx_Scraper
         
         
     end
-    def self.page(doc)
-        doc.css('.gems__meter').text
-        puts doc.css('.gems__meter').text
-        
-    end
-    def self.check_pagination(doc)
-        
-        doc.css(".pagination").text
+    def self.post_search_query
+        search_results_found = CLI::Scraper_Tools.page(@doc)
+        max_pages = (search_results_found / 30).ceil
+
+        puts "Displaying page #{@@page} out of #{max_pages}"
+        temp_page = @@page
+        @@page = CLI::Scraper_Tools.navigate(@@page, max_pages, @@all)
         
-    end
-    def self.retry
-        puts "Unable to complete request, please try again: "
+        if (temp_page != @@page)
+            self.clear_all_instances
+        end
+        self.get_approximate_data(@@current_query, @@page)
+
     end
     def self.approx_downloads(doc)
         doc.css('.gems__gem__downloads__count').text.gsub(/[[:space:]]/, ' ').gsub(/Downloads/, '').split()
     end
+    def self.clear_all_instances
+        @@all = []
+    end
     def self.display_approx
         puts "======================================================="
         begin
@@ -65,6 +74,8 @@ class CLI::Approx_Scraper
             @@all.each do |each|
                 puts "---------------------------------"
                 puts ''
+                puts "##{each.id}"
+                puts ''
                 puts "About: #{each.name}"
                 puts ''
                 puts "Markup: #{each.markup}"
@@ -73,22 +84,18 @@ class CLI::Approx_Scraper
                 puts ''
                 puts "---------------------------------"
             end
-            search_results_found = @@all.length
-            puts "#{search_results_found} results found"
-            puts self.page(@doc)
-            if (self.check_pagination(@doc) != "")
-                @@page = AdvancedSearch.navigate(@@page)
-                self.get_approximate_data(@@current_query, @@page)
+            if (CLI::Scraper_Tools.check_pagination(@doc) != "")
+                self.post_search_query
 
             end
-            self.restart
+            CLI.restart
         else
             puts "0 search results found"
-            self.restart
+            CLI::Advanced_Search.restart
         end
     rescue => error
         puts error.message
-        self.retry
+        CLI::Scraper_Tools.retry
     end
     end
 

data/lib/what_is_this/CLI.rb

@@ -0,0 +1,89 @@
+require_relative '../../config/environment.rb'
+
+class CLI
+    @@spacing = "\n\n\n"
+    @@message_spacing = "         "
+    def self.introduction
+    
+    
+    introduction_message = '
+                              $$\                   $$\             $$\                     $$\     $$\       $$\           
+                              $$ |                  $$ |            \__|                    $$ |    $$ |      \__|          
+                $$\  $$\  $$\ $$$$$$$\   $$$$$$\  $$$$$$\           $$\  $$$$$$$\         $$$$$$\   $$$$$$$\  $$\  $$$$$$$\ 
+                $$ | $$ | $$ |$$  __$$\  \____$$\ \_$$  _|  $$$$$$\ $$ |$$  _____|$$$$$$\ \_$$  _|  $$  __$$\ $$ |$$  _____|
+                $$ | $$ | $$ |$$ |  $$ | $$$$$$$ |  $$ |    \______|$$ |\$$$$$$\  \______|  $$ |    $$ |  $$ |$$ |\$$$$$$\  
+                $$ | $$ | $$ |$$ |  $$ |$$  __$$ |  $$ |$$\         $$ | \____$$\           $$ |$$\ $$ |  $$ |$$ | \____$$\ 
+                \$$$$$\$$$$  |$$ |  $$ |\$$$$$$$ |  \$$$$  |        $$ |$$$$$$$  |          \$$$$  |$$ |  $$ |$$ |$$$$$$$  |
+                 \_____\____/ \__|  \__| \_______|   \____/         \__|\_______/            \____/ \__|  \__|\__|\_______/ '
+
+        introduction_message.each_char {|c| putc c ; sleep 0.0015}
+        puts @@spacing + @@message_spacing + "Welcome to what-is-this! To begin please type either dependencies, install, search or quit:"
+        start
+    end
+    def self.start
+        input = CGI.escape(gets.chomp.downcase.strip)
+        puts @@spacing
+        case input
+            when 'search'
+                puts @@spacing + @@message_spacing + 'Would you like your search to be approximate(approx), advanced, exact or back to return?'
+
+                input = CGI.escape(gets.chomp.downcase.strip)
+                case input
+                when 'back'
+                    self.restart
+                when 'approximate', 'approx'
+                    approximate_search
+                when 'exact'
+                    search
+                when 'advanced'
+                    AdvancedSearch.advanced_search_properties
+                else
+                    puts @@spacing + @@message_spacing + 'Command not recognised. Try again:'
+                    restart
+                end
+            when 'install'
+                install
+            when 'dependencies'
+                Dependencies.display_dependencies
+            when 'quit'
+                quit
+            else
+                puts @@spacing + @@message_spacing + 'Command not recognised, try again!'
+                start
+            end
+    end
+    def self.approximate_search
+        puts  @@spacing + @@message_spacing + "Please input your search term:"
+        query = CGI.escape(gets.chomp.downcase.strip)
+        Approx_Scraper.get_approximate_data(query)
+        restart
+    end
+    def self.search
+        puts @@spacing + @@message_spacing + "Enter gem you would like to know about"
+        query = CGI.escape(gets.chomp.downcase.strip)
+        Scraper.getData(query)
+        restart
+    end
+    def self.install
+        puts @@spacing + @@message_spacing + "Enter the gem that you would like to install and save as a dependency or back to return"
+        input = CGI.escape(gets.chomp)
+        case input
+        when 'back'
+            restart
+        else
+            Install.install(input)
+        end
+        restart
+    end
+    def self.quit
+        puts @@message_spacing + "Thanks for using 'what-is-this'... seeya!" + @@spacing
+        exit 1
+    end
+    def self.restart 
+        puts @@spacing + @@message_spacing + 'To continue, type either dependencies, install, search, or quit:'
+        start
+    end
+    
+
+    
+end

data/lib/what_is_this/Install.rb

@@ -1,12 +1,16 @@
-require_relative '../config/environment.rb'
 class CLI::Install
-    
-    def self.install(input)
+    @@spacing = "\n\n\n"
+    @@message_spacing = "         "
+
+    def self.install
         puts @@spacing + @@message_spacing + "Enter the gem that you would like to install and save as a dependency"
         input = CGI.escape(gets.chomp)
+        self.run_sys_command(input)
+    end
+    def self.run_sys_command(input)
         system("bundle add #{input}") 
         puts @@spacing + @@message_spacing + "Gem installed!"
+
     end
     
-    
 end

data/lib/what_is_this/Scraper_Tools.rb

@@ -0,0 +1,95 @@
+class CLI::Scraper_Tools
+    @@spacing = "\n\n\n"
+    @@message_spacing = "         "
+    
+    def self.page(doc)
+        returned_gems = doc.css('.gems__meter').text.split()
+        returned_gems[4].to_i
+
+    end
+    def self.check_pagination(doc)
+        
+        doc.css(".pagination").text
+        
+    end
+    def self.retry
+        puts "Unable to complete request, please try again: "
+    end
+    
+    def self.navigate(page, max_pages, all)
+        puts @@spacing + @@message_spacing + "For commands type: --help"
+        help_message = @@spacing + @@message_spacing + "
+        - forward, f => Go to next page \n
+        - back, b => Go to previous page \n
+        - first => Return to first page \n
+        - last => Go to last page \n
+        - page [number] => Jump to a certain page \n
+        - install [number] => Install a certain gem as a dependency \n
+        - inspect [number] => See full description of gem \n
+        - home => Returns to start screen \n
+        "
+        input = gets.chomp.to_str.downcase
+        
+        case input
+            when "--help"
+                puts help_message
+                self.navigate(page, max_pages, all)
+            when "forward", "f"
+               page = self.forward(page, max_pages)
+            when "back", "b"
+                page = self.back(page)
+            when "home"
+                CLI::Approx_Scraper.clear_all_instances
+                CLI::AdvancedSearch.clear_all_instances
+                CLI.restart
+                
+            when "first"
+                page = 1
+            when "last"
+                page = max_pages
+            when /page [0-9]+/
+                install_num = input.split()
+                page = install_num[1].to_s.to_i
+            when /install [0-9]+/
+                install_num = input.split()
+                install_num = install_num[1].to_s.to_i - 1
+                CLI::Install.run_sys_command(all[install_num].name.to_s)
+            when /inspect [0-9]/
+                inspect_num = input.split()
+                inspect_num = inspect_num[1].to_s.to_i - 1
+                CLI::Scraper.getData((all[inspect_num].name.to_s))
+                puts "Would you like to install this gem?(Y/N)"
+                input = gets.chomp
+                case input
+                    when "y"
+                        CLI::Install.run_sys_command(all[inspect_num].name.to_s)
+                        puts "Restarting"
+                        CLI.restart
+                    when "n"
+                        puts "Please continue or select --help for help"
+                    else
+                        puts "Input not recognised, try again"
+                        self.navigate(page, max_pages, all)
+
+                end
+
+                
+            else
+                puts "Unrecognised command, try again"
+                self.navigate(page, max_pages, all)
+        end
+        page
+    end
+    def self.forward(page, max_pages)
+        page += 1 unless page >= max_pages
+        page
+        
+    end
+    def self.back(page)
+        page -=1 unless page <= 1
+        page
+    end
+    
+    
+    
+end

data/lib/what_is_this/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhatIsThis
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/what_is_this.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "what_is_this/version"
+require_relative "what_is_this/CLI"
+require_relative "what_is_this/Scraper_Tools"
 require_relative "what_is_this/Advanced_Search"
 require_relative "what_is_this/Approx_Scraper"
 require_relative "what_is_this/Dependencies"
@@ -8,87 +10,5 @@ require_relative "what_is_this/Install"
 require_relative "what_is_this/Scraper"
 
 module WhatIsThis
-  class Error < StandardError; end
-  @@spacing = "\n\n\n"
-    @@message_spacing = "         "
-    def self.introduction
-    
-    
-    introduction_message = '
-                              $$\                   $$\             $$\                     $$\     $$\       $$\           
-                              $$ |                  $$ |            \__|                    $$ |    $$ |      \__|          
-                $$\  $$\  $$\ $$$$$$$\   $$$$$$\  $$$$$$\           $$\  $$$$$$$\         $$$$$$\   $$$$$$$\  $$\  $$$$$$$\ 
-                $$ | $$ | $$ |$$  __$$\  \____$$\ \_$$  _|  $$$$$$\ $$ |$$  _____|$$$$$$\ \_$$  _|  $$  __$$\ $$ |$$  _____|
-                $$ | $$ | $$ |$$ |  $$ | $$$$$$$ |  $$ |    \______|$$ |\$$$$$$\  \______|  $$ |    $$ |  $$ |$$ |\$$$$$$\  
-                $$ | $$ | $$ |$$ |  $$ |$$  __$$ |  $$ |$$\         $$ | \____$$\           $$ |$$\ $$ |  $$ |$$ | \____$$\ 
-                \$$$$$\$$$$  |$$ |  $$ |\$$$$$$$ |  \$$$$  |        $$ |$$$$$$$  |          \$$$$  |$$ |  $$ |$$ |$$$$$$$  |
-                 \_____\____/ \__|  \__| \_______|   \____/         \__|\_______/            \____/ \__|  \__|\__|\_______/ '
-
-        introduction_message.each_char {|c| putc c ; sleep 0.0015}
-        puts @@spacing + @@message_spacing + "Welcome to what-is-this! To begin please type either dependencies, install, search or quit:"
-        start
-    end
-    def self.start
-        input = CGI.escape(gets.chomp.downcase.strip)
-        puts @@spacing
-        case input
-            when 'search'
-                puts @@spacing + @@message_spacing + 'Would you like your search to be approximate(approx), advanced, exact or back to return?'
-
-                input = CGI.escape(gets.chomp.downcase.strip)
-                case input
-                when 'back'
-                    self.restart
-                when 'approximate', 'approx'
-                    approximate_search
-                when 'exact'
-                    search
-                when 'advanced'
-                    AdvancedSearch.advanced_search_properties
-                else
-                    puts @@spacing + @@message_spacing + 'Command not recognised. Try again:'
-                    restart
-                end
-            when 'install'
-                install
-            when 'dependencies'
-                Dependencies.display_dependencies
-            when 'quit'
-                quit
-            else
-                puts @@spacing + @@message_spacing + 'Command not recognised, try again!'
-                start
-            end
-    end
-    def self.approximate_search
-        puts  @@spacing + @@message_spacing + "Please input your search term:"
-        query = CGI.escape(gets.chomp.downcase.strip)
-        Approx_Scraper.get_approximate_data(query)
-        restart
-    end
-    def self.search
-        puts @@spacing + @@message_spacing + "Enter gem you would like to know about"
-        query = CGI.escape(gets.chomp.downcase.strip)
-        Scraper.getData(query)
-        restart
-    end
-    def self.install
-        puts @@spacing + @@message_spacing + "Enter the gem that you would like to install and save as a dependency or back to return"
-        input = CGI.escape(gets.chomp)
-        case input
-        when 'back'
-            restart
-        else
-            Install.install(input)
-        end
-        restart
-    end
-    def self.quit
-        puts @@message_spacing + "Thanks for using 'what-is-this'... seeya!" + @@spacing
-        exit 1
-    end
-    def self.restart 
-        puts @@spacing + @@message_spacing + 'To continue, type either dependencies, install, search, or quit:'
-        start
-    end
+  
 end

data/what_is_this.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["D-Justice"]
   spec.email = ["justice.damian96@gmail.com"]
 
-  spec.summary = "CLI that allows the user all the functionality of RubyGems.org within the terminal."
-  spec.description = "CLI that allows the user all the functionality of RubyGems.org within the terminal."
+  spec.summary = "CLI that allows the user all the functionality of RubyGems.org within the terminal. To begin, simply type 'what_is_this in your project folder after installing the gem."
+  spec.description = "CLI that allows the user all the functionality of RubyGems.org within the terminal. To begin, simply type 'what_is_this in your project folder after installing the gem."
   spec.homepage = "https://github.com/D-Justice/what-is-this"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "bin"
+  spec.executables = ["what_is_this"]
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem

metadata

@@ -1,20 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: what_is_this
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - D-Justice
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-01-02 00:00:00.000000000 Z
 dependencies: []
 description: CLI that allows the user all the functionality of RubyGems.org within
-  the terminal.
+  the terminal. To begin, simply type 'what_is_this in your project folder after installing
+  the gem.
 email:
 - justice.damian96@gmail.com
-executables: []
+executables:
+- what_is_this
 extensions: []
 extra_rdoc_files: []
 files:
@@ -26,12 +28,15 @@ files:
 - bin/console
 - bin/setup
 - bin/what_is_this
+- config/environment.rb
 - lib/what_is_this.rb
 - lib/what_is_this/Advanced_Search.rb
 - lib/what_is_this/Approx_Scraper.rb
+- lib/what_is_this/CLI.rb
 - lib/what_is_this/Dependencies.rb
 - lib/what_is_this/Install.rb
 - lib/what_is_this/Scraper.rb
+- lib/what_is_this/Scraper_Tools.rb
 - lib/what_is_this/version.rb
 - sig/what_is_this.rbs
 - what_is_this.gemspec
@@ -58,5 +63,6 @@ rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: CLI that allows the user all the functionality of RubyGems.org within the
-  terminal.
+  terminal. To begin, simply type 'what_is_this in your project folder after installing
+  the gem.
 test_files: []