urban_dictionary 0.0.2 → 1.0.0

data/spec/urban_dictionary/cli_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe UrbanDictionary::CLI do
+  CLI = UrbanDictionary::CLI
+
+  def suppress_exit(expected_status)
+    begin
+      yield
+      fail "Expected block to exit with status #{expected_status}, but no SystemExit exception was raised"
+    rescue SystemExit => e
+      expect(e.status).to eql(expected_status)
+    end
+  end
+
+  def mk_cli(str, dictionary = nil)
+    config = CLI::Config.new(
+      :args => str.to_argv,
+      :stdout => Test::IO.new,
+      :stderr => Test::IO.new,
+    )
+    config.update(:dictionary, dictionary) unless dictionary.nil?
+    cli = CLI.new(config)
+    [cli, config]
+  end
+
+  def mk_word(term, definitions, examples)
+    UrbanDictionary::Word.new(
+      term,
+      Array(definitions).zip(Array(examples)).map {|ea| UrbanDictionary::Entry.new(*ea) }
+    )
+  end
+
+  describe "#run" do
+    it "outputs help when called with no arguments" do
+      cli, config = mk_cli("")
+      cli.run
+      expect(config.stdout).to include("Usage: urban_dictionary")
+    end
+
+    it "outputs error when word has no definition" do
+      dictionary = double("dictionary", :define => nil)
+      cli, config = mk_cli("undefined word", dictionary)
+      suppress_exit(1) { cli.run }
+      expect(config.stderr).to include("No definition found for 'undefined word'")
+    end
+
+    it "outputs a word's definition when found" do
+      word = mk_word("sample word", "a definition", "an example")
+      dictionary = double("dictionary", :define => word)
+      cli, config = mk_cli(word.word, dictionary)
+      cli.run
+      expect(config.stdout).to include(word.word)
+    end
+
+    it "outputs a random word when --random is provided" do
+      random_word = mk_word("random word", "random definition", "random example")
+      dictionary = double("dictionary", :random_word => random_word)
+      cli, config = mk_cli("--random", dictionary)
+      cli.run
+      expect(config.stdout).to include(random_word.word)
+    end
+
+    it "accepts --format to specify output format" do
+      word = mk_word("a word", "a definition", "a example")
+      dictionary = double("dictionary", :define => word)
+      cli, config = mk_cli("--format=json a word", dictionary)
+      cli.run
+      obj = MultiJson.load(config.stdout.content)
+      expect(obj).to include("word" => word.word)
+    end
+  end
+end

data/spec/urban_dictionary/entry_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe UrbanDictionary::Entry do
   describe "#to_s" do
     it "should print out the formatted example and definition" do
-      UrbanDictionary::Entry.new("pie", "delicious").to_s.should eq("pie\ndelicious")
+      expect(UrbanDictionary::Entry.new("pie", "delicious").to_s).to eq("pie\ndelicious")
     end
   end
 end

data/spec/urban_dictionary/word_spec.rb

@@ -1,34 +1,42 @@
 require "spec_helper"
 
 describe UrbanDictionary::Word do
-  
+
   describe "instance method" do
-    subject{ UrbanDictionary::Word.new("pie", [mock, mock]) }
+    subject{ UrbanDictionary::Word.new("pie", [double, double]) }
+
+    describe '#to_s' do
+      subject { super().to_s }
+      it { should eq("pie") }
+    end
 
-    its(:to_s){ should eq("pie") }
-    its(:size){ should eq(3) }
-    its(:length){ should eq(3) }
+    describe '#size' do
+      subject { super().size }
+      it { should eq(3) }
+    end
+
+    describe '#length' do
+      subject { super().length }
+      it { should eq(3) }
+    end
   end
 
   describe "class method" do
     describe "#from_url" do
       let(:url){ "the_url" }
-      let(:html_with_results){ File.open(File.expand_path("../../html/test_with_results.html", __FILE__)) }
-      let(:html_without_results){ File.open(File.expand_path("../../html/test_without_results.html", __FILE__)) }
-
-      it "should parse a valid word" do
-        UrbanDictionary::Word.should_receive(:open).with(url).and_return(html_with_results)
+      let(:html_with_results){ Test.load_fixture("on_fleek_2016-02-15.html") }
+      let(:html_without_results){ Test.load_fixture("sisyphus_2016-02-15.html") }
 
-        word = UrbanDictionary::Word.from_url(url)
-        word.should be_a(UrbanDictionary::Word)
-        word.word.should eq("test1234")
-        word.entries.length.should eq(1)
-        word.entries.first.should be_an_instance_of(UrbanDictionary::Entry)
+      it "parses a valid word" do
+        word = UrbanDictionary::Word.from_html(html_with_results)
+        expect(word).to be_a(UrbanDictionary::Word)
+        expect(word.word).to eq("on fleek")
+        expect(word.entries.length).to eq(7)
+        expect(word.entries.first).to be_an_instance_of(UrbanDictionary::Entry)
       end
 
-      it "should gracefully handle an unknown word by returning nil" do
-        UrbanDictionary::Word.should_receive(:open).with(url).and_return(html_without_results)
-        UrbanDictionary::Word.from_url(url).should be_nil
+      it "returns nil for unknown words" do
+        expect(UrbanDictionary::Word.from_html(html_without_results)).to be_nil
       end
     end
   end

data/spec/urban_dictionary_spec.rb

@@ -1,31 +1,32 @@
 require "spec_helper"
 
 describe UrbanDictionary do
-  let(:result){ mock :result }
+  let(:result){ double :result }
 
   describe "class method" do
     describe "#define" do
-      it "should delegate to Word#from_url" do
-        UrbanDictionary::Word.should_receive(:from_url).with("#{UrbanDictionary::DEFINE_URL}?term=pie").and_return(result)
-        UrbanDictionary.define("pie").should eq(result)
+      it "delegates to Word#from_url" do
+        expect(UrbanDictionary::Word).to receive(:from_url).with("#{UrbanDictionary::DEFINE_URL}?term=pie").and_return(result)
+        expect(UrbanDictionary.define("pie")).to eq(result)
       end
 
-      it "should url encode the request" do
-        UrbanDictionary::Word.should_receive(:from_url).with("#{UrbanDictionary::DEFINE_URL}?term=asdf%25asdf").and_return(result)
-        UrbanDictionary.define("asdf%asdf").should eq(result)
+      it "URL-encodes the request" do
+        expect(UrbanDictionary::Word).to receive(:from_url).with("#{UrbanDictionary::DEFINE_URL}?term=asdf%25asdf").and_return(result)
+        expect(UrbanDictionary.define("asdf%asdf")).to eq(result)
       end
     end
 
     describe "#random_word" do
-      let(:request){ mock :request }
-      let(:response){ {'location' => 'location'} }
-      let(:http){ mock :http }
+      let(:request){ double :request }
+      let(:url) { 'http://example.com' }
+      let(:response){ {'location' => url } }
+      let(:http){ double :http }
 
       it "should do an HTTP GET to determine the random word" do
-        Net::HTTP.should_receive(:start).with("www.urbandictionary.com", 80).and_yield(http).and_return(response)
-        http.should_receive(:request).with(an_instance_of(Net::HTTP::Get))
-        UrbanDictionary.should_receive(:define).with('location').and_return(result)
-        UrbanDictionary.random_word.should eq(result)
+        expect(Net::HTTP).to receive(:start).with("www.urbandictionary.com", 80).and_yield(http).and_return(response)
+        expect(http).to receive(:request).with(an_instance_of(Net::HTTP::Get))
+        expect(UrbanDictionary::Word).to receive(:from_url).with(url).and_return(result)
+        expect(UrbanDictionary.random_word).to eq(result)
       end
     end
   end

data/urban_dictionary.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = UrbanDictionary::VERSION
   s.authors     = ["Ryan Greenberg"]
   s.email       = ["ryangreenberg@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/ryangreenberg/urban_dictionary"
   s.summary     = "Interface to urbandictionary.com"
   s.description = s.summary
 
@@ -18,8 +18,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "nokogiri", "~> 1.5.2"
+  s.add_runtime_dependency "nokogiri", "~> 1.5"
+  s.add_runtime_dependency "multi_json", "~> 1.0"
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", "~> 3.4"
+  s.add_development_dependency "webmock", "~> 1.22.6"
 end

metadata

@@ -1,36 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: urban_dictionary
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Greenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,19 +55,31 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.22.6
 description: Interface to urbandictionary.com
 email:
 - ryangreenberg@gmail.com
@@ -69,56 +90,61 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/urban_dictionary
 - lib/urban_dictionary.rb
+- lib/urban_dictionary/cli.rb
 - lib/urban_dictionary/entry.rb
+- lib/urban_dictionary/formatters.rb
 - lib/urban_dictionary/version.rb
 - lib/urban_dictionary/word.rb
+- spec/html/add_html_example.rb
+- spec/html/on_fleek_2016-02-15.html
+- spec/html/sisyphus_2016-02-15.html
 - spec/html/test_with_results.html
 - spec/html/test_without_results.html
 - spec/spec_helper.rb
+- spec/urban_dictionary/cli_spec.rb
 - spec/urban_dictionary/entry_spec.rb
 - spec/urban_dictionary/word_spec.rb
 - spec/urban_dictionary_spec.rb
 - urban_dictionary.gemspec
-homepage: ''
+homepage: https://github.com/ryangreenberg/urban_dictionary
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -774214380254322335
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -774214380254322335
 requirements: []
 rubyforge_project: urban_dictionary
-rubygems_version: 1.8.24
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Interface to urbandictionary.com
 test_files:
+- spec/html/add_html_example.rb
+- spec/html/on_fleek_2016-02-15.html
+- spec/html/sisyphus_2016-02-15.html
 - spec/html/test_with_results.html
 - spec/html/test_without_results.html
 - spec/spec_helper.rb
+- spec/urban_dictionary/cli_spec.rb
 - spec/urban_dictionary/entry_spec.rb
 - spec/urban_dictionary/word_spec.rb
 - spec/urban_dictionary_spec.rb

data/Gemfile.lock

@@ -1,28 +0,0 @@
-PATH
-  remote: .
-  specs:
-    urban_dictionary (0.0.2)
-      nokogiri (~> 1.5.2)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    nokogiri (1.5.5)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake
-  rspec
-  urban_dictionary!