what_is_this 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1112bb7dbac5f06df1fe1f7ebde61e4168499cc60760a68a5cad074eaca11981
+  data.tar.gz: ffc5c584ea9a08f64a6e5946ac4e8768fde004c5c8ccf4f0ded93ab50d2c9d6b
+SHA512:
+  metadata.gz: 16d3ada75e602b8104464c02bcf0bd2b8b4c368977dfe5dee3cb4af88625c80925b4d262e33753d0e3d0b0e71dd2ca8ad1e74765bb2241f993f3f9c6f1e2c0f9
+  data.tar.gz: 591a65e4f463af5ac6dceba653845c679323550fda7b4b52ce7c37958402c9e87201490ffc46d1b2e1278af276b1b4e4493d8e571ebf586428f9d3a9d1ea5f79

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in what_is_this.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    what_is_this (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  what_is_this!
+
+BUNDLED WITH
+   2.2.33

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 D-Justice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# WhatIsThis
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/what_is_this`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'what_is_this'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install what_is_this
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/what_is_this.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "what_is_this"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/what_is_this

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

data/lib/what_is_this/Advanced_Search.rb

@@ -0,0 +1,138 @@
+class CLI::AdvancedSearch
+    attr_accessor :name, :markup, :downloads
+    @@spacing = "\n\n\n"
+    @@message_spacing = "         "
+    @@current_query = ""
+    @@page = 1
+
+    @@all = []
+
+    def initialize(name = nil, markup = nil, downloads = nil )
+        @name = name
+        @markup = markup
+        @downloads = downloads
+        @@all << self
+    end
+    def self.new_from_query
+        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]
+            )
+        end
+        display_data
+    end
+
+    def self.advanced_search_properties
+        puts @@spacing + @@message_spacing + "This is advanced search, please input name, summary, description, downloads, and when it was last updated or put nothing to skip a section"
+        puts @@spacing + "Name: (ie: active OR action)"
+        name = gets.chomp
+        name != "" ? name = "name: #{name} " : name = ""
+
+        puts "Summary: (ie: ORM, NoSQL)"
+        summary = gets.chomp
+        summary != "" ? summary = "summary: #{summary} " : summary = ""
+
+        puts "Description: (ie: associations AND validations)"
+        description = gets.chomp
+        description != "" ?  description = "description: #{description} " : description = ""
+
+        puts "Downloads: (ie: >20000)"
+        downloads = gets.chomp
+        downloads != "" ? downloads = "downloads: #{downloads} " : downloads = ""
+
+        puts "Last Updated: (ie: >2021-12-12)"
+        updated = gets.chomp
+        updated != "" ? updated = "updated: #{updated} " : updated = ""
+
+        query = CGI.escape((name + summary + description + downloads + updated).strip)
+
+        puts "YOUR QUERY IS: " + query
+
+        query.gsub!("++", "+")
+        @@current_query = query
+        self.advanced_search_scrape(query)
+    end
+   
+    def self.advanced_search_scrape(query, page = 1)
+        url = "https://rubygems.org/search?page=#{page}&query=#{query}"
+        @doc = Nokogiri::HTML(open(url)) 
+        self.new_from_query
+
+    end
+    def self.retry
+        puts "Unable to complete request, please try again: "
+        advanced_search_properties
+    end
+    def self.restart
+        puts "Search another term? (y/n)"
+        input = gets.chomp.downcase
+    case input
+        when "y"
+            self.advanced_search_properties
+        when "n"
+            CLI.restart
+        else
+            self.advanced_search_properties
+        end
+    end
+    def self.display_data
+        puts "======================================================="
+        begin
+            if (@@all.length >= 1)
+                
+                @@all.each do |each|
+                    puts "---------------------------------"
+                    puts ''
+                    puts "About: #{each.name}"
+                    puts ''
+                    puts "Markup: #{each.markup}"
+                    puts ''
+                    puts "Downloads: #{each.downloads}"
+                    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
+            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
+        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

@@ -0,0 +1,96 @@
+class CLI::Approx_Scraper
+    attr_accessor :name, :markup, :downloads
+    @@page = 1
+    @@current_query = ""
+
+    @@all = []
+
+    def self.get_approximate_data(query, page = 1)
+        @@current_query = query
+        url = "https://rubygems.org/search?page=#{page}&query=#{query}"
+        @doc = Nokogiri::HTML(open(url))
+        self.new_from_query
+    end
+    def initialize(name=nil, markup=nil, downloads=nil)
+        @name = name
+        @markup = markup
+        @downloads = downloads
+        @@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]
+            )
+        end
+        display_approx
+    end
+    def self.approx_names(doc)
+        begin
+            doc.css('h2').css('.gems__gem__name').text.gsub(/[[:space:]]/, ' ').gsub(/[0-9].\S+/, '').split()
+        rescue => error
+            puts "I hit an error"
+            puts error.message
+        end
+    end
+    def self.approx_markups(doc)
+        doc.css('.gems__gem__desc').map do |i|
+            "#{i.text} "
+        end
+        
+        
+    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
+        
+    end
+    def self.retry
+        puts "Unable to complete request, please try again: "
+    end
+    def self.approx_downloads(doc)
+        doc.css('.gems__gem__downloads__count').text.gsub(/[[:space:]]/, ' ').gsub(/Downloads/, '').split()
+    end
+    def self.display_approx
+        puts "======================================================="
+        begin
+            if (@@all.length >= 1)
+            @@all.each do |each|
+                puts "---------------------------------"
+                puts ''
+                puts "About: #{each.name}"
+                puts ''
+                puts "Markup: #{each.markup}"
+                puts ''
+                puts "Downloads: #{each.downloads}"
+                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)
+
+            end
+            self.restart
+        else
+            puts "0 search results found"
+            self.restart
+        end
+    rescue => error
+        puts error.message
+        self.retry
+    end
+    end
+
+
+end

data/lib/what_is_this/Dependencies.rb

@@ -0,0 +1,53 @@
+class CLI::Dependencies
+    @@spacing = "\n\n\n"
+    @@message_spacing = "         "
+    @@dependencies = []
+    
+    def self.display_dependencies
+        print = false
+        text = File.readlines('Gemfile.lock').each do |line|
+            line = line.to_str
+            if (line == "DEPENDENCIES\n")
+                print = true
+            else
+                if (line == "BUNDLED WITH\n")
+                    print = false
+                elsif (print == true)
+                    if (!@@dependencies.include?(line.split[0]))
+                        @@dependencies << line.split[0] unless line.split[0].nil?
+                    end
+                    puts line
+
+                    
+                end
+            end
+            
+        end
+        self.enquire
+    end
+    def self.enquire
+        puts @@message_spacing + "List the gem you would like to delete, or type 'back'" + @@spacing
+        p @@dependencies
+        input = gets.chomp
+        case input
+        when "back"
+            CLI.restart
+        else 
+            if (@@dependencies.include?(input))
+
+                system("gem uninstall #{input}")
+                system("bundle remove #{input}")
+                system("bundle install")
+                @@dependencies.delete(input)
+                self.display_dependencies
+                
+            else
+                puts @@message_spacing + "Command not recognised. Try again" + @@spacing
+                self.enquire
+            end
+            
+        
+        end
+    end
+
+end

data/lib/what_is_this/Install.rb

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

data/lib/what_is_this/Scraper.rb

@@ -0,0 +1,36 @@
+class CLI::Scraper
+    attr_accessor :name, :markup, :downloads
+    
+    def initialize(name = nil, markup = nil, downloads = nil)
+        @name = name
+        @markup = markup
+        @downloads = downloads
+    end
+    
+    def self.getData(name)
+        @doc = Nokogiri::HTML(open("https://rubygems.org/gems/#{name}"))
+        instance = self.new(name, self.markup, self.downloads)
+        exact_display(instance)
+    end
+    def self.markup
+        @doc.css('#markup').text.strip
+    end
+    def self.downloads
+        @doc.css('.gem__downloads').first.text.strip
+    end
+    def self.exact_display(instance)
+        query = instance.name.split(' ')
+        query = query.map do |word|
+            word.capitalize
+        end.flatten
+        puts "======================================================="
+        puts "--------#{query}--------"
+        puts ''
+        puts "About: #{self.markup}"
+        puts ''
+        puts "Downloads: #{self.downloads}"
+        puts ''
+        puts "---------------------------------"
+    end
+
+end

data/lib/what_is_this/version.rb

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

data/lib/what_is_this.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "what_is_this/version"
+require_relative "what_is_this/Advanced_Search"
+require_relative "what_is_this/Approx_Scraper"
+require_relative "what_is_this/Dependencies"
+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/sig/what_is_this.rbs

@@ -0,0 +1,4 @@
+module WhatIsThis
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/what_is_this.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/what_is_this/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "what_is_this"
+  spec.version = WhatIsThis::VERSION
+  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.homepage = "https://github.com/D-Justice/what-is-this"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (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.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: what_is_this
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- D-Justice
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-28 00:00:00.000000000 Z
+dependencies: []
+description: CLI that allows the user all the functionality of RubyGems.org within
+  the terminal.
+email:
+- justice.damian96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/what_is_this
+- lib/what_is_this.rb
+- lib/what_is_this/Advanced_Search.rb
+- lib/what_is_this/Approx_Scraper.rb
+- lib/what_is_this/Dependencies.rb
+- lib/what_is_this/Install.rb
+- lib/what_is_this/Scraper.rb
+- lib/what_is_this/version.rb
+- sig/what_is_this.rbs
+- what_is_this.gemspec
+homepage: https://github.com/D-Justice/what-is-this
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []