ruby_dictionary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38ecfaba82284e4a4ce77623fd1e47669c2721a7
+  data.tar.gz: f238b5e29403e852e937896ead724ee49a195e92
+SHA512:
+  metadata.gz: b8d4edcda9073f65e951913d4ff9410065a830dbd565f04e6018a4151869bee7e6b03dec6a7e2addb2a6dbd7b395858db3e129559fd848e4d31dc868b0ee0316
+  data.tar.gz: 158cf03a06539b2f39019ef304d5a557aff2831e01bf882e854e5c3c4ec2faec213973358b1e0f92cb489558cac736ed59d996c38ad59fdace7fbb72af18f65f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <github email address>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 ruby_dictionary.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    ruby_dictionary (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruby_dictionary!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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/NOTES.md

@@ -0,0 +1,39 @@
+Building a CLI gem
+
+1. Plan out, imagine UI
+2. Build out project structure
+3. Start with the file run, shebang line, and relative requirements
+4. stub out the interface
+5. Start making things real
+6. Discover objects
+7. Program
+
+
+A command line interface that allows a user to browse Public instance methods for different data types.
+
+user types ruby-dictionary
+
+Welcomes the user
+asks what Class/Mixin the user wants to explore
+prompts for input
+Displays definition of Class
+asks user if they want to display instance methods or class methods
+lists public instance/class/all methods for the selected data type
+
+Which method do you want to learn more about?
+prompts user to enter #method
+returns description and examples
+
+
+I think I should create separate Scraper and Method classes
+
+FINDABLE?
+
+FIND OUT HOW TO REMOVE HTML TAGS FROM DESCRIPTIONS (ie See Also links)
+
+IS THERE A WAY TO SET UP AN ANCHOR IN MY CLI MENU SO THAT WHEN I TYPE EXIT FROM A KLASS MENU IT EXITS THE CLI MENU AND SKIPS TO #GOODBY?
+
+ADJUST/ADD CLEAR ALL METHOD?
+
+
+NEED  TO ADD A CONDITION THAT METHODS SHOULD ONLY BE ADDED TO ALL/INST_METHODS/KLASS_METHODS IF THAT METHOD CANNOT BE FOUND IN THERE.

data/README.md

@@ -0,0 +1,44 @@
+# RubyDictionary
+
+Welcome to the Ruby Dictionary gem. With this gem you will be able to do more than just print a list of methods that can be called on an object. This gem allows you to view methods available to you, and call up a description of each method along with available call sequences and examples scraped straight from ruby-docs.
+
+This gem is powered by the Core API docs for Ruby 2.4.2 found at:
+http://ruby-doc.org/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_dictionary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_dictionary
+
+## Usage
+
+The program opens with a list of ruby classes and mixins. you can navigate to any of the class menus by entering the name or associated number into the command line. From there, follow the simple instructions provided in each menu to navigate through this program and you will have access to the power of the official Ruby core 2.4.2 API  docs right from your command line.
+
+## 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/<github username>/ruby_dictionary. 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).
+
+## Code of Conduct
+
+Everyone interacting in the RubyDictionary project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<github username>/ruby_dictionary/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+#require './lib/ruby_dictionary'
+require "bundler/setup"
+require "ruby_dictionary"
+
+
+CLI.new.call

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/ruby_dictionary/cli.rb

@@ -0,0 +1,119 @@
+# CLI Controller
+require 'pry'
+class CLI
+
+  def call
+    Scraper.scrape_index
+    puts "Welcome to the Ruby Dictionary!"
+    scrape_slow_classes
+    list_klasses
+    main_menu
+    goodbye
+  end
+
+  def scrape_slow_classes
+    @array = Klass.list[0]
+    Scraper.scrape_klass(@array)
+    @enum = Klass.list[2]
+    Scraper.scrape_klass(@enum)
+  end
+
+  def list_klasses
+    Klass.all.each.with_index{|k,i| puts "#{i + 1}. #{k.name}"}
+    puts "\nEnter the Class or Mixin you would like to explore, or type 'exit' to quit"
+  end
+
+  def klass_menu(klass)
+    input = nil
+    puts "\n"
+    puts klass.definition
+    puts "\nEnter 'i' to see a list of public instance methods\nEnter 'c' to see a list of public class methods\nEnter 'all' to see all public methods available\nEnter the name of a method to learn more\nEnter 'menu' or 'back' to go back to the list of Classes and Mixins\nOr enter 'exit' to quit"
+    until input == "menu" || input == "back"
+      input = gets.strip.downcase
+      case
+      when input == "i" || input == "instance"
+        klass.list_inst_methods
+        puts "\n"
+      when input == "c" || input == "class"
+        klass.list_klass_methods
+        puts "\n"
+      when input == "all"
+        klass.list_all_methods
+        puts "\n"
+      when input == "menu" || input == "back"
+        list_klasses
+      when input == "exit"
+        puts "Happy Coding!!!"
+        exit
+      else
+        if klass.find_by_name(input) == nil
+          puts "Im sorry, I can't find a method by that name, try again or type 'menu' to go to the main menu or type 'exit' to quit"
+        else
+          method = klass.find_by_name(input)
+          puts "\n##{method.name}\n"
+          method.callseq.each do |seq|
+            puts seq
+          end
+          puts "\n#{method.description}"
+          if method.examples != ""
+            puts "\nExamples:\n#{method.examples}\n"
+          end
+        end
+      end
+    end
+  end
+
+  def main_menu
+    input = nil
+    until input == "exit"
+
+      input = gets.strip.downcase
+      case input
+      when "list"
+        list_klasses
+      when /array(s)?\b|1/
+        klass_menu(@array)
+      when /dir(s)?\b|2/
+        @dir = Klass.list[1]
+        Scraper.scrape_klass(@dir)
+        klass_menu(@dir)
+      when /enumerable(s)?\b|3/
+        klass_menu(@enum)
+      when /hash(es)?\b|4/
+        @hash = Klass.list[3]
+        Scraper.scrape_klass(@hash)
+        klass_menu(@hash)
+      when /numeric(s)?\b|5/
+        @num = Klass.list[4]
+        Scraper.scrape_klass(@num)
+        klass_menu(@num)
+      when /proc(s)?\b|6/
+        @prok = Klass.list[5]
+        Scraper.scrape_klass(@prok)
+        klass_menu(@prok)
+      when /range(s)?\b|7/
+        @range = Klass.list[6]
+        Scraper.scrape_klass(@range)
+        klass_menu(@range)
+      when /string(s)?\b|8/
+        @string = Klass.list[7]
+        Scraper.scrape_klass(@string)
+        klass_menu(@string)
+      when /symbol(s)?\b|9/
+        @symbol = Klass.list[8]
+        Scraper.scrape_klass(@symbol)
+        klass_menu(@symbol)
+      else
+        if input != "exit"
+          puts "I'm sorry, I didn't get that. Please enter a Class or type 'list' or type 'exit'"
+        end
+      end
+    end
+
+
+    def goodbye
+      puts "Happy Coding!!!"
+    end
+  end
+
+end

data/lib/ruby_dictionary/findable.rb

@@ -0,0 +1,7 @@
+module Findable
+  module InstanceMethods
+    def find_by_name(name)
+      self.all_methods.detect{|m| m.name == name}
+    end
+  end
+end

data/lib/ruby_dictionary/klass.rb

@@ -0,0 +1,64 @@
+class Klass
+  include Findable::InstanceMethods
+  attr_accessor :name, :definition, :url, :method
+  @@all = []
+
+  def initialize(name=nil,definition=nil,url=nil)
+    @name = name
+    @definition = definition
+    @url = url
+    @klass_methods = []
+    @inst_methods = []
+    @all_methods = []
+  end
+
+  def add_inst_method(method)
+    method.klass = self unless method.klass != nil
+    @inst_methods << method unless @inst_methods.include?(method)
+  end
+
+  def add_klass_method(method)
+    method.klass = self unless method.klass != nil
+    @klass_methods << method unless @klass_methods.include?(method)
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.list
+    @@all.each{|k| k.name}
+  end
+
+  def inst_methods
+    @inst_methods
+  end
+
+  def klass_methods
+    @klass_methods
+  end
+
+  def all_methods
+    @all_methods
+  end
+
+  def list_inst_methods
+    @all_methods.each{|m| puts m.name if m.method_type == "Instance"}
+  end
+
+  def list_klass_methods
+    @all_methods.each{|m| puts m.name if m.method_type == "Class"}
+  end
+
+  def list_all_methods
+    @all_methods.each{|m| puts m.name}
+  end
+
+  def clear_method_lists
+    @inst_methods.clear
+    @klass_methods.clear
+    @all_methods.clear
+  end
+
+
+end

data/lib/ruby_dictionary/method.rb

@@ -0,0 +1,28 @@
+class RubyMethod
+  include Findable::InstanceMethods
+  attr_accessor :name, :callseq, :description, :examples, :method_type, :klass
+  @@all = []
+
+  def initialize(name=nil,callseq=nil,description=nil,examples=nil,method_type=nil, klass_name=nil, klass=nil)
+    @name = name
+    @callseq = callseq
+    @description = description
+    @examples = examples
+    @method_type = method_type
+    @klass_name = klass_name
+    @klass = klass
+    #self.klass=(klass_name) unless klass_name == nil
+
+  end
+
+#  def klass=(klass)
+#    binding.pry
+#    @klass = klass
+#    if self.method_type == "Class"
+#      klass.add_klass_method(self)
+#    else
+#      klass.add_inst_method(self)
+#    end
+#  end
+
+end

data/lib/ruby_dictionary/scraper.rb

@@ -0,0 +1,100 @@
+require 'nokogiri'
+require 'uri'
+require 'pry'
+
+class Scraper
+
+  def self.scrape_index
+    doc = Nokogiri::HTML(open("http://ruby-doc.org/core-2.4.2/"))
+    klass_list = doc.css("#class-index .entries p")
+    klass_list.each do |k|
+      if k.css("a").text.match(/(Array\b|Dir\b|Enumerable|Hash|Numeric|Proc\b|Range\b|String|Symbol)/) != nil
+        klass = Klass.new
+        klass.name = k.css("a").text.gsub(/"/,"")
+        href = k.css("a")[0]["href"]
+        page_url = "http://ruby-doc.org/core-2.4.2/"
+        klass.url = URI.join(page_url,href)
+        Klass.all << klass
+      end
+    end
+  end
+
+  def self.scrape_klass(klass)
+    self.scrape_method_names(klass)
+    self.scrape_instance_method_bodies(klass)
+    self.scrape_klass_method_bodies(klass)
+  end
+
+  def self.scrape_method_names(klass)
+    doc = Nokogiri::HTML(open(klass.url))
+    klass.definition = doc.css("div#description p:first-child, div#description p:nth-child(2)").text
+    #.gsub(/<span.{1,25}>|<\/span>/,"").gsub(/<code>|<\/code>/,"").gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<", '&gt;' => ">", '&amp;' => "&")
+    method_list = doc.css("#method-list-section ul.link-list li")
+
+    method_list.each do |mn|
+      method = RubyMethod.new
+      if mn.css("a").text.start_with?(":")
+        method.method_type = "Class"
+        klass.add_klass_method(method)
+      else
+        method.method_type = "Instance"
+        klass.add_inst_method(method)
+      end
+      method.klass = klass
+      method.name = mn.css("a").text.gsub(/#/,"")
+      #.gsub(/&lt;|&gt;|&amp;|#/, '&lt;' => "<", '&gt;' => ">", '&amp;' => "&", '#' => "")
+      klass.all_methods << method
+    end
+  end
+####################################################################################
+  def self.scrape_instance_method_bodies(klass)
+    doc = Nokogiri::HTML(open(klass.url))
+    i=0
+    #if method.method_type == "Instance"
+    public_instance_methods = doc.css("div#public-instance-method-details.method-section .method-detail")
+    public_instance_methods.each do |m|
+
+      klass.inst_methods[i].description = m.css(".method-heading + div p").text
+      #.gsub(/<.{2,5}>|\n/,"").strip.gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<", '&gt;' =>">", '&amp;' => "&")
+      klass.inst_methods[i].examples = m.css("pre.ruby").text
+      #.gsub(/<span class=\"ruby-.{1,12}>|<\/span>/,"").strip.gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<", '&gt;' => ">", '&amp;' => "&")
+
+      call_sequence = []
+      if m.css(".method-heading").length == 1
+          call_sequence << m.css(".method-callseq").text
+          #.gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<",'&gt;' => ">", '&amp;' => "&")
+      else
+        m.css(".method-heading").each do |variant|
+          call_sequence << variant.css(".method-callseq").text
+        end
+      end
+      klass.inst_methods[i].callseq = call_sequence
+      i+=1
+    end
+
+  end
+
+  def self.scrape_klass_method_bodies(klass)
+    doc = Nokogiri::HTML(open(klass.url))
+    public_klass_methods = doc.css("div#public-class-method-details.method-section .method-detail")
+    i=0
+    public_klass_methods.each do |m|
+
+      klass.klass_methods[i].description = m.css(".method-heading + div p").text
+      #.gsub(/<.{2,5}>|\n/,"").strip.gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<", '&gt;' =>">", '&amp;' => "&")
+      klass.klass_methods[i].examples = m.css("pre.ruby").text.strip
+      #.gsub(/<span class=\"ruby-.{1,12}>|<\/span>/,"").strip.gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<", '&gt;' => ">", '&amp;' => "&")
+      call_sequence = []
+      if m.css(".method-heading").length == 1
+        call_sequence << m.css(".method-callseq").text
+        #.gsub(/&lt;|&gt;|&amp;/, '&lt;' => "<",'&gt;' => ">", '&amp;' => "&")
+      else
+        m.css(".method-heading").each do |variant|
+          call_sequence << variant.css(".method-callseq").text
+        end
+      end
+      klass.klass_methods[i].callseq = call_sequence
+      i+=1
+    end
+  end
+end

data/lib/ruby_dictionary/version.rb

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

data/lib/ruby_dictionary.rb

@@ -0,0 +1,11 @@
+require 'nokogiri'
+require 'open-uri'
+require 'pry'
+
+require_relative './ruby_dictionary/findable'
+
+require_relative "./ruby_dictionary/version"
+require_relative './ruby_dictionary/cli'
+require_relative './ruby_dictionary/method'
+require_relative './ruby_dictionary/klass'
+require_relative './ruby_dictionary/scraper'

data/ruby_dictionary.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_dictionary/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_dictionary"
+  spec.version       = RubyDictionary::VERSION
+  spec.authors       = ["Chris Boujoukos"]
+  spec.email         = ["cboujoukos@gmail.com"]
+
+  spec.summary       = %q{Ruby Dictionary}
+  spec.description   = %q{This gem allows the user to look up useful information on public methods right from the command line.}
+  spec.homepage      = "https://github.com/cboujoukos/cli-data-gem-assessment-v-000.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+#  if spec.respond_to?(:metadata)
+#    spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
+#  else
+#    raise "RubyGems 2.0 or newer is required to protect against " \
+#      "public gem pushes."
+#  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~>0"
+
+  spec.add_runtime_dependency "nokogiri"
+end

data/spec.md

@@ -0,0 +1,9 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+    RubyDictionary::CLI class provides CLI for main menu and RubyDictionary::Klass class adds CLI functionality for detailed view
+- [x] Pull data from an external source
+    RubyDictionary::Scraper class scrapes several pages of Ruby Documentation
+- [x] Implement both list and detail views
+    Main menu allows navigation between different Ruby classes and a once a class is selected the user can find more information on any method (thanks to the Findable module).

data/tring_methods

@@ -0,0 +1,26 @@
+
+From: /home/chris/code/portfolio-projects/ruby_dictionary/lib/ruby_dictionary/scraper.rb @ line 29 RubyDictionary::Klass.scrape_string:
+
+    10: def self.scrape_string
+    11:   string_methods = []
+    12:   puts "Welcome to strings!"
+    13:   doc = Nokogiri::HTML(open("http://ruby-doc.org/core-2.4.2/String.html"))
+    14:   #binding.pry
+    15:   instance_methods = doc.css("#public-instance-method-details .method-detail")
+    16:   #binding.pry
+    17: 
+    18:   instance_methods.each do |m|
+    19:     method = self.new
+    20:     #method.name = m.inner_html.split("→ ")[0] # This causes problems for methods that have multiple ways of of being called like slice(index), slice(range), slice(regexp), etc
+    21:     if m["id"].split("-")[0] == /^\d.+/
+    22:       method.name = m.inner_html.split("→ ")[0]
+    23:     else
+    24:       method.name = m["id"].split("-")[0] #this causes problems methods that are stupidly classified as 2A 2A or 3D etc. (anything that comes before #bytes in the public method lists)
+    25:     end
+    26:     string_methods << method
+    27:   end
+    28:   puts "we scraped strings!"
+ => 29:   binding.pry
+    30: 
+    31: end
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ruby_dictionary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Boujoukos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: 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: This gem allows the user to look up useful information on public methods
+  right from the command line.
+email:
+- cboujoukos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/console
+- bin/ruby-dictionary
+- bin/setup
+- lib/ruby_dictionary.rb
+- lib/ruby_dictionary/cli.rb
+- lib/ruby_dictionary/findable.rb
+- lib/ruby_dictionary/klass.rb
+- lib/ruby_dictionary/method.rb
+- lib/ruby_dictionary/scraper.rb
+- lib/ruby_dictionary/version.rb
+- ruby_dictionary.gemspec
+- spec.md
+- tring_methods
+homepage: https://github.com/cboujoukos/cli-data-gem-assessment-v-000.git
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Ruby Dictionary
+test_files: []