wtf_ruby 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73becb7f84fda3a2405da82124ef29b69a035e52aaf2bccc67fa21a1b74aa148
+  data.tar.gz: 6803b171f4d496b507e244d8b973739f8642ae7a271005bb34844a91e3825a3e
+SHA512:
+  metadata.gz: 10c34a2d596302d1ab5c949443cb5cfe56093b6d41412f10bd787c4a6bcaed45fe65f269e15399343e1239807b4bc07ef10f2de4152f8aac025fa1447fb19e22
+  data.tar.gz: 3de18210c09b30de304e2dbe3bce6227af4e1cbd4fa2467cdb40b7979c9f946b2064249fad1014e47d3c362a0464add3ccfed71b14b716cd70163ef88360b854

data/bin/wtf_ruby

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/wtf_ruby"
+
+# http://127.0.0.1:4000/
+sesh = WtfRuby::CommandLineInteface.new
+sesh.run 

data/config/environment.rb

@@ -0,0 +1,10 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+require 'fileutils'
+
+require_relative "../lib/wtf_ruby/command_line_interface.rb"
+require_relative "../lib/wtf_ruby/scraper.rb"
+require_relative "../lib/wtf_ruby/class.rb"
+require_relative "../lib/wtf_ruby/meth.rb"

data/lib/wtf_ruby/class.rb

@@ -0,0 +1,51 @@
+
+require 'open-uri'
+
+class WtfRuby::Classy
+
+  attr_accessor :name, :methods, :content
+
+  @@all = []
+
+  def initialize(name)
+    @name = name
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.create_from_collection(list_of_classes)
+
+    list_of_classes.each do |class_name|
+        self.new(class_name)
+
+    end
+  end
+
+  def self.create_methods_for_all_classes
+    self.all.each do |ind_class|
+        ind_class.create_methods_for_instance_of_class
+    end
+  end
+
+
+  def create_methods_for_instance_of_class
+     method_names = WtfRuby::Scraper.scrape_methods(@name)
+     method_contents = WtfRuby::Scraper.scrape_method_content_from_class_page(@name)
+     index_placeholder = 0
+     @methods = []
+     method_contents.each do |content|
+       new_method_of_class = WtfRuby::Meth.new
+       new_method_of_class.name = method_names[index_placeholder]
+       new_method_of_class.headings = content[:headings].split('click to toggle source')
+       new_method_of_class.description = content[:full_description]
+       new_method_of_class.mini_description = content[:mini_description]
+       new_method_of_class.sample_code = content[:code]
+       @methods << new_method_of_class
+       index_placeholder += 1
+    end
+  end
+
+end

data/lib/wtf_ruby/command_line_interface.rb

@@ -0,0 +1,144 @@
+
+require 'nokogiri'
+require 'colorize'
+require 'pry'
+require 'open-uri'
+require 'fileutils'
+class WtfRuby::CommandLineInteface
+
+
+
+    def run
+    make_classes
+    width_check
+    WtfRuby::Scraper.store_offline
+    WtfRuby::Classy.create_methods_for_all_classes
+
+
+      welcome_text
+      first_choice = gets.strip
+      if validate_first_choice_input(first_choice) == { "valid class" => true, "valid method" => true, "inputs" => 2}
+        class_choice = first_choice.split(',')[0].strip
+        selected_class = set_class(class_choice)
+        method_choice = first_choice.split(',')[1].strip
+        display_method(selected_class, method_choice)
+      elsif validate_first_choice_input(first_choice) == { "valid class" => true, "valid method" => false, "inputs" => 1}
+        selected_class = set_class(first_choice)
+        printf_method_list(selected_class)
+        puts 'Please enter the method you wish to view:'
+        method_choice = gets.strip
+        display_method(selected_class, method_choice)
+      elsif validate_first_choice_input(first_choice) == { "valid class" => true, "valid method" => false, "inputs" => 2}
+        selected_class = set_class(first_choice.split(',')[0].strip)
+        printf_method_list(selected_class)
+        puts 'Please enter the method you wish to view:'
+        method_choice = gets.strip
+        display_method(selected_class, method_choice)
+      else
+        puts "Hmmmm... I couldn't make sense of your input.  Let's try this" if first_choice != ''
+        printf_class_list
+        puts 'Please enter the name of the class for which you wish to view available methods:'
+        class_choice= gets.strip
+        selected_class = set_class(class_choice)
+        printf_method_list(selected_class)
+        puts 'Please enter the method you wish to view:'
+        method_choice = gets.strip
+        display_method(selected_class, method_choice)
+
+      end
+  end
+
+  #return a hash that identifies whether the user provided class and method are valid.
+  def validate_first_choice_input(string)
+    inputs = { "valid class" => false, "valid method" => false, "inputs" => 0 }
+    if set_class(string)
+      inputs["valid class"] = true
+      inputs["inputs"] = 1
+    elsif string.include?(',')
+      array = string.split(',')
+      pot_class = array[0].strip
+      pot_method = array[1].strip
+      inputs["inputs"] = array.count
+      if set_class(pot_class)
+        inputs["valid class"] = true
+        if set_method(set_class(pot_class), pot_method)
+          inputs["valid method"] = true
+        end
+      end
+    end
+    inputs
+  end
+
+  def width_check
+    puts 'This gem displays some pretty big lists.  To make sure your terminal window is wide enough expand the view until you have a continuous line on the right side'
+    5.times do
+      printf(" %80s \n", "|")
+    end
+  end
+
+
+  def welcome_text
+    puts "Hello, welcome to what_dis_ruby?.  If you know the class AND method  OR just the class that you wish to look up please enter them as shown below:"
+    puts "Classy and Method: Classy, Method"
+    puts "Just Classy: Classy"
+    puts "Othwerwise, hit enter to see a list of available classes"
+  end
+
+
+
+  def set_method(class_instance, chosen_method_name)
+    class_instance.methods.select { |m| m.name == chosen_method_name}.first
+  end
+
+  def set_class(string)
+    WtfRuby::Classy.all.select { |c| c.name == string}.first
+  end
+
+  def display_method(class_instance, chosen_method_name)
+      m_to_show = set_method(class_instance, chosen_method_name)
+      puts ''
+      puts '  Classy: ' + class_instance.name.colorize(:mode => :bold) + ' Method: ' + m_to_show.name.colorize(:color => :red, :mode => :bold)
+      printf("\t %s \n", m_to_show.mini_description.colorize(:mode => :italic))
+      m_to_show.headings.each do |heading|
+       printf("\t#{heading.colorize(:light_blue)}\n")
+      end
+      m_to_show.sample_code.each do |code|
+          line = code.colorize(:color => :white, :background => :green)
+          printf("\t %-50s \n", line)
+      end
+  end
+
+
+  def printf_method_list(selected_class)
+    counter = 0
+    rows = selected_class.methods.count/3
+    rows.ceil.times do
+      printf(" %2d.%-25s %2d.%-25s %2d.%-25s \n",
+        counter += 1, selected_class.methods[counter - 1].name,
+        counter += 1, selected_class.methods[counter - 1].name,
+        counter += 1, selected_class.methods[counter - 1].name)
+    end
+  end
+
+
+
+  def make_classes
+    class_list = WtfRuby::Scraper.scrape_class
+    WtfRuby::Classy.create_from_collection(class_list)
+
+  end
+
+
+  def printf_class_list
+    counter = 0
+    rows = WtfRuby::Classy.all.count/4
+    rows.ceil.times do
+      printf(" %2d.%-15s %2d.%-15s %2d.%-15s %2d.%-15s \n",
+        counter += 1, WtfRuby::Classy.all[counter - 1].name,
+        counter += 1, WtfRuby::Classy.all[counter - 1].name,
+        counter += 1, WtfRuby::Classy.all[counter - 1].name,
+        counter += 1, WtfRuby::Classy.all[counter - 1].name)
+    end
+  end
+
+end

data/lib/wtf_ruby/meth.rb

@@ -0,0 +1,9 @@
+class WtfRuby::Meth
+#one name, one or more uses, one or more sample_codes
+  attr_accessor :name, :headings, :sample_code, :mini_description, :description
+
+
+
+
+
+end

data/lib/wtf_ruby/scraper.rb

@@ -0,0 +1,114 @@
+require 'open-uri'
+require 'pry'
+require 'nokogiri'
+require 'fileutils'
+
+
+
+class WtfRuby::Scraper
+  @@local_status = false
+  @@dir_two = File.dirname("./fixtures/ruby-doc-site")
+
+#Sets the path for scraping based on the presence of the fixtures directory
+  if File.directory?(@@dir_two)
+    @@core_path = "./fixtures/ruby-doc-site"
+    @@file_type = ".xml"
+    @@local_status = true
+  else
+      @@core_path = "https://ruby-doc.org/core-2.3.1"
+      @@file_type = ".html"
+      @@local_status = false
+
+  end
+
+
+  def self.local_status
+    @@local_status
+  end
+
+
+
+
+
+
+  def self.scrape_class
+  class_names = []
+    if @@local_status == true
+      core_link = "#{@@core_path}/core-2_3_1.xml"
+    else
+      core_link = @@core_path
+    end
+
+    core_page = Nokogiri::HTML(open(core_link))
+      core_page.xpath("//div [@id='class-index']/div[2]/p/a").each do |class_name|
+        if !class_name.children.text.include?("::") && !class_name.children.text.include?("Error") && !class_name.children.text.include?("System")
+          class_names << class_name.text
+
+        end
+    end
+    class_names
+  end
+
+  def self.scrape_methods(class_instance_name)
+     # to break up the method sections use //div [@id='at-method'] [@class='method-detail']
+     methods = []
+     method_link = "#{@@core_path}/#{class_instance_name}#{@@file_type}"
+     method_page = Nokogiri::HTML(open(method_link))
+       method_page.xpath("//div[@id='method-list-section']/ul/li/a").each do |method_name|
+          name = method_name.text.gsub(/[:#]/,'')
+          methods << name
+       end
+      methods
+    end
+
+  def self.scrape_method_content_from_class_page(class_name)
+   methods = []
+   method_link = @@core_path+"/#{class_name}#{@@file_type}"
+   method_page = Nokogiri::HTML(open(method_link))
+     method_page.css(".method-detail").each do |section|
+          method_hash = {}
+          method_hash[:headings] =section.xpath("div [@class='method-heading'] / span").text
+          method_hash[:mini_description] = section.xpath("div / p[1]").text.split("\n").join(' ')
+          method_hash[:full_description] = section.xpath("div / p").text
+          method_hash[:code] = section.css(".ruby").text.split("\n")
+          methods << method_hash
+     end
+    methods
+  end
+
+  def self.store_offline  #Only run after making all the classes
+   if @@local_status == false
+      dir_one = File.dirname("./fixtures")
+      unless File.directory?(dir_one)
+        FileUtils.mkdir_p(dir_one)
+      end
+
+      dir_two = File.dirname("./fixtures/ruby-doc-site")
+      unless File.directory?(dir_two)
+        FileUtils.mkdir_p(dir_two)
+      end
+
+      dir_three = File.dirname("./fixtures/ruby-doc-site/why")
+      unless File.directory?(dir_three)
+        FileUtils.mkdir_p(dir_three)
+      end
+
+      core_file = File.new("./fixtures/ruby-doc-site/core-2_3_1.xml", 'w')
+      home = open("https://ruby-doc.org/core-2.3.1")
+      doc_home = Nokogiri::HTML(home)
+      core_file.write(doc_home)
+      core_file.close
+
+
+      WtfRuby::Classy.all.each do |ind_class|
+        name = ind_class.name
+        t = File.new("./fixtures/ruby-doc-site/#{name}.xml", 'w')
+        html = open("https://ruby-doc.org/core-2.3.1/#{name}.html")
+        doc = Nokogiri::HTML(html)
+        t.write(doc)
+        t.close
+      end
+    end
+  end
+
+end

data/lib/wtf_ruby.rb

@@ -0,0 +1,6 @@
+
+
+module WtfRuby
+
+end
+require_relative '../config/environment.rb'

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: wtf_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- JerYoMat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-22 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem to view ruby classes, their methods and sample code within
+  the command line.
+email:
+- jeremy.emata@gmail.com
+executables:
+- wtf_ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/wtf_ruby
+- config/environment.rb
+- lib/wtf_ruby.rb
+- lib/wtf_ruby/class.rb
+- lib/wtf_ruby/command_line_interface.rb
+- lib/wtf_ruby/meth.rb
+- lib/wtf_ruby/scraper.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Get Ruby Doc class descriptions, methods and sample code.
+test_files: []