askoverflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eec69b2633bc533f53adcb6c8fb22786bf7d15e6d1bce934937bf3be3cd59c56
+  data.tar.gz: b9834531f8a885f31a78818b96b5eab946d47b4608fd259aada3abfaaf9741c8
+SHA512:
+  metadata.gz: 1b103d21323949c7cf708b43d5cf2d0584874ac4ab04045123e74248e67e4bd31ea82e8739e79dfb5c3907804f6872626956a712f919832ee9ab1f2b37228303
+  data.tar.gz: 319f8666d71b292d195238f41fb4f40a1a4838005ca9063660972323b47280f461a4cffd06ea274d8a967901c99d6103d7b384f28e5b636894387db915ae1e1c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+# rspec failure tracking
+.rspec_status
+.vscode

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in askoverflow.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    askoverflow (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  askoverflow!
+  bundler (~> 1.17)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 SVR
+
+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,19 @@
+# Askoverflow
+
+AskOverflow is a simple ruby CLI app that allows a user to quickly search stackoverflow, view a simplified results list in the terminal, select a
+result and view it's full question and accepted answer, then return to the results page to read a different result or submit a different search.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/SVRourke/askoverflow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/askoverflow.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "askoverflow/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "askoverflow"
+  spec.version       = Askoverflow::VERSION
+  spec.authors       = ["SVR"]
+  spec.email         = ["samuel@rourke.tech"]
+
+  spec.summary       = %q{commandline tool to search stackoverflow.}
+  spec.description   = %q{commandline tool to search stackoverflow quickly and simply.}
+  spec.homepage      = "https://github.com/SVRourke/askoverflow"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["askoverflow"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.13"
+
+  spec.add_runtime_dependency "nokogiri"
+end

data/bin/askoverflow

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'askoverflow'
+# binding.pry
+
+App.new.run

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "askoverflow"
+
+# 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/lib/askoverflow.rb

@@ -0,0 +1,9 @@
+require "askoverflow/version"
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+require_relative "askoverflow/cli"
+require_relative "askoverflow/result"
+require_relative "askoverflow/scrape"
+require_relative "askoverflow/app"

data/lib/askoverflow/app.rb

@@ -0,0 +1,72 @@
+class App
+    # creates a new CLI and Scrape object upon initialization
+    def initialize
+        @ui = CLI.new
+        @scraper = Scrape.new
+    end
+    # formats  the user's search string into the stackoverflow
+    # url query format
+    def f_query(raw)
+        fq = raw.gsub(" ", "+")
+        return "q=#{fq}"
+    end
+    # take the user's raw search string and return a url
+    def make_url(query)
+        base = 'https://stackoverflow.com/search?'
+        q = f_query(query)
+        answeredOnly = "+hasaccepted%3Atrue"
+        return "#{base}#{q}#{answeredOnly}"
+    end
+    # this is the main program control
+    def run
+        # greets the user on start
+        @ui.greet
+        # main loop
+        running = true
+        while running
+            # preemptively clear Results for multiple searches
+            # prompt the user for their search terms
+            # exit if desired by user
+            # otherwise scrape results from query
+            Result.clear_results
+            @ui.prompt_search
+            query = gets.strip
+            break if query == 'exit'
+            url = make_url(query)
+            @scraper.scrape_results(url)
+            # "viewing loop"
+            # this loop allows the user to return to the results
+            # display or to try a different search
+            # displays scraped results, prompts the user for a
+            # specific result, to return to try another search
+            # or exit the program
+            viewing_results = true
+            while viewing_results
+                @ui.display_results
+                @ui.prompt_result
+                result_id = gets.strip
+                if result_id == 'exit'
+                    running = false 
+                    break
+                end
+                break if result_id == 'back'
+                # Scrapes the specific result, and adds data
+                chosen_result = Result.find_by_id(result_id)
+                @scraper.scrape_specific(chosen_result)
+                # "Specific View Loop"
+                # this loop allows us to view a specific result
+                # and subsequently return to the results list
+                viewing_result = true
+                while viewing_result
+                    @ui.display_question(chosen_result)
+                    @ui.prompt_next
+                    @ui.display_answer(chosen_result)
+                    @ui.prompt_return
+                    break
+                end
+            end
+        end
+        @ui.goodbye
+    end
+end
+# binding.pry

data/lib/askoverflow/cli.rb

@@ -0,0 +1,73 @@
+class CLI
+    # greet, called at program start, greets the user
+    def greet
+        puts "askoverflow"
+    end
+    # displays a thankyou message for the user after exit
+    def goodbye
+        10.times {visual_spacer}
+        puts "Thanks for using AskOverflow-"
+        puts "I hope we helped"
+        visual_spacer
+    end
+    # Helper function used to simplify displaying messages
+    # in a visually pleasing way
+    def visual_spacer
+        3.times {puts ""}
+    end
+    # prompt functions used to print requests for user input
+    # asks the user to search or exit
+    def prompt_search
+        puts "please enter a search or exit: "
+    end
+    # asks user for the id number of their desired result
+    def prompt_result
+        puts "enter the id of a result to read further, back to do a new search or exit to quit"
+    end
+    # asks user to press enter to return to the results page
+    def prompt_return
+        visual_spacer
+        puts "+++enter to return to results+++"
+        visual_spacer
+        gets
+    end
+    # after displaying the full question text
+    # asks user to press enter to display the answer
+    def prompt_next
+        visual_spacer
+        puts "Press enter to read answer"
+        visual_spacer
+        gets
+    end
+    # Display functions, used to display data to the user
+    # display_results displays each result's basic info
+    def display_results
+        Result.all.each_with_index do |r, i|
+            puts "++++++++++++++++++++++++++++++++++++++++++++++++++"
+            puts "|ID:#{i + 1}| #{r.question.slice(0,60)}..."
+            puts "|#{r.answer_count} answer(s) since: #{r.ask_date}"
+            puts "|Tags:\t#{r.tags}"
+            puts "++++++++++++++++++++++++++++++++++++++++++++++++++"
+            puts ""
+        end
+    end
+    # after a result is selected, this displays the result's full question
+    def display_question(result)
+        10.times {visual_spacer}
+        puts "++++++++++++++++++++++++++"
+        puts "+++++++++QUESTION+++++++++"
+        puts "++++++++++++++++++++++++++"
+        puts "#{result.full_q}"
+    end
+    # after a result is selected and the question has been displayed,
+    # this displays the result's full answer.
+    def display_answer(result)
+        4.times {visual_spacer}
+        puts "++++++++++++++++++++++++++"
+        puts "++++++++++ANSWER++++++++++"
+        puts "++++++++++++++++++++++++++"
+        puts "#{result.full_a}"
+    end
+end
+
+

data/lib/askoverflow/result.rb

@@ -0,0 +1,43 @@
+# This is a class used to store the data of
+# each scraped result in a central, easy to
+# access location
+class Result
+    # Attribute Accessors declared for each
+    # piece of information collected from
+    # each result
+    attr_accessor :question, :sample, :tags, :ask_date, :answer_count, :author, :link, :all, :id, :full_q, :full_a
+    # class varible array used to store each
+    # result instance
+    @@all = Array.new
+    # uses metaprogramming and attribut accessors
+    # to assign the values of an initial hash to
+    # the instance's attributes, then shovels the
+    # instance onto @@all
+    def initialize(attributes)
+        attributes.each do |s, v|
+            self.send("#{s}=", v)
+        end
+        @@all << self
+    end
+    # allows the user to access the results via
+    # human friendly indexing ie 1->10 not 0->9
+    def self.find_by_id(id)
+        @@all[id.to_i - 1]
+    end
+    # allows a result's scraped full Q&A to be
+    # added to the instance
+    def add_full(content_hash)
+        content_hash.each do |s, v|
+            self.send("#{s}=", v)
+        end
+    end
+    # deletes all existing Result instances
+    # used when additional searches are performed
+    def self.clear_results
+        @@all.clear
+    end
+    # provides access to the @@all class variable
+    def self.all
+        @@all
+    end
+end

data/lib/askoverflow/scrape.rb

@@ -0,0 +1,36 @@
+class Scrape
+    # helper function used to request and load the document
+    def getDoc(url)
+        Nokogiri::HTML(open(url))
+    end
+    # preliminary scraping function
+    # accepts a url, loads the page, scrapes
+    # the results on the page and creates a new
+    # Result object for each scraped result
+    def scrape_results(url)
+        doc = getDoc(url)
+        doc.css("div.search-result").each do |result|
+            Result.new({
+                :question => result.css(".question-hyperlink").text.strip,
+                :sample => result.css("div.excerpt").text.strip,
+                :ask_date => result.css("span.relativetime").text.strip,
+                :tags => result.css("div.tags").text.strip,
+                :answer_count => result.css("div.status strong").text.strip,
+                :author => result.css("div.started a").text.strip,
+                :link => result.css("a.question-hyperlink").first['href']
+            })
+        end
+    end
+    # Secondary scraping function
+    # accepts a Result instance,
+    # bulids a url using the result's :link
+    # and scrapes the specific result page's
+    # full question and full answer
+    def scrape_specific(result)
+        doc = getDoc("https://stackoverflow.com/#{result.link}")
+        result.add_full({
+            :full_q => doc.css("div.question div.postcell div.post-text").text,
+            :full_a => doc.css("div.answer div.answercell div.post-text").text
+        })
+    end
+end

data/lib/askoverflow/version.rb

@@ -0,0 +1,3 @@
+module Askoverflow
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: askoverflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SVR
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: commandline tool to search stackoverflow quickly and simply.
+email:
+- samuel@rourke.tech
+executables:
+- askoverflow
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- askoverflow.gemspec
+- bin/askoverflow
+- bin/console
+- bin/setup
+- lib/askoverflow.rb
+- lib/askoverflow/app.rb
+- lib/askoverflow/cli.rb
+- lib/askoverflow/result.rb
+- lib/askoverflow/scrape.rb
+- lib/askoverflow/version.rb
+homepage: https://github.com/SVRourke/askoverflow
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: commandline tool to search stackoverflow.
+test_files: []