urban_dictionary 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmQ5NjJjOTM5OTBmYWRkMjI0Nzc5ODE5ZGNlZGZiYTljZTNmZjFjZA==
-  data.tar.gz: !binary |-
-    MzQxMDhhNDMxZmNlM2U1ZWUyNjI4OGNmMWEwMjkwOWRlYzQxMjhhZg==
+SHA1:
+  metadata.gz: c4f3029bc9ff059717597149efd3464a53b7be3e
+  data.tar.gz: a4a4aaaedcd3b981d33ec34417c1026a20060a56
 SHA512:
-  metadata.gz: !binary |-
-    NGRmMWY0Y2MwMWM2NWMyYmMwMjI3NTU2ZDcyNjJjOWJkNGI2NDFlZjNlOGVl
-    MGI1ODIyZTAyN2FhODNkYjIyODhiNGQ5NWEzMmI0OTNlZGQ3Yzg4ZDA5Mzg2
-    Y2M3ZjQ4ZDY2ZjZlNDhjNDE4NWEyOWI2YTU0MjI2OWJkMjI2M2Y=
-  data.tar.gz: !binary |-
-    MjZlMWZhMjA2OWMzY2NhZGI0YzFlZGRmNmIwNTA4YzNlZDQyNTFjMzAxODY0
-    NmZiNmJkOWU5MWI0ZDgxNjFmNTQxNzFiYTRjMTM1NDQzZTg5MTYyZDRhNzdl
-    MWVjZTM5ZjVmMmM3NDExOGRmMGY3MzM5ZjRkOTA2YjBhYTZhNmQ=
+  metadata.gz: ec7e8f36aa8631ba8cb6a5db07b4743a1353841d3d25539e3bb9af71a7605765275c2e56d8e66a53dccb66c35a286e04ff990eba99e2f514f29c8448ae9b4117
+  data.tar.gz: a37a3c5ea34dd959a66cc7cf977a46a86c7ae46ff7f76c70c5c3397358043d262cc9f0cd2c42000b03aa2736d4c0b5d790d13084a1f05cbf074536c186af5c96

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0 - 2016-03-01
+- Added support for `-n <number>` or `--definitions=<number>` to limit output
+- Fixed output mangled by carriage returns (`\r`)
+- Added `--format=definition` that only outputs the definitions for a word
+
 ## 1.0.0 - 2016-02-15
 - Fixed broken parsing of Urban Dictionary's new layout
 - Fixed bug where undefined words are displayed as the shrug emoticon (`¯\_(ツ)_/¯`)

data/README.md

@@ -45,7 +45,7 @@ Specify the output format with `--format`. The default is `plain`; `json` is als
       "entries": [
         {
           "definition": "keepin it real to the fullest and super tight.",
-          "example": "end of the convo\rLuke: aight man, peace\rQ: kool homie, keep it one hundred (100)"
+          "example": "end of the convo\nLuke: aight man, peace\nQ: kool homie, keep it one hundred (100)"
         },
         ...
     }

data/lib/urban_dictionary.rb

@@ -26,5 +26,6 @@ module UrbanDictionary
   end
 end
 
+UrbanDictionary::Formatter.register(:definition, UrbanDictionary::DefinitionFormatter)
 UrbanDictionary::Formatter.register(:json, UrbanDictionary::JsonFormatter)
 UrbanDictionary::Formatter.register(:plain, UrbanDictionary::PlainFormatter)

data/lib/urban_dictionary/cli.rb

@@ -68,8 +68,16 @@ module UrbanDictionary
           options[:random] = r
         end
 
+        opts.on("-n", "--definitions=NUMBER", "Limit output to the first n definitions") do |n|
+          options[:limit] = begin
+            Integer(n)
+          rescue ArgumentError
+            raise OptionParser::InvalidArgument, "#{n} is not a valid number of definitions"
+          end
+        end
+
         options[:format] = DEFAULT_FORMAT
-        opts.on("-f", "--format=FORMAT", "Output format (plain, json)") do |f|
+        opts.on("-f", "--format=FORMAT", "Output format (plain, json, definition)") do |f|
           format = f.downcase.to_sym
           unless UrbanDictionary::Formatter.registered.include?(format)
             raise OptionParser::InvalidOption, "#{f} is not a valid format"
@@ -79,8 +87,17 @@ module UrbanDictionary
       end
     end
 
+    def parse
+      begin
+        options[:remaining] = option_parser.parse(@args)
+      rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
+        @stderr.puts e.message
+        exit(1)
+      end
+    end
+
     def run
-      options[:remaining] = option_parser.parse(@args)
+      parse
 
       if options[:remaining].empty? && !options[:random]
         @stdout.puts option_parser.help
@@ -99,6 +116,10 @@ module UrbanDictionary
         exit(1)
       end
 
+      if options[:limit]
+        word = UrbanDictionary::Word.new(word.word, word.entries.first(options[:limit]))
+      end
+
       formatter = UrbanDictionary::Formatter.for(options[:format])
       @stdout.puts(formatter.format(word))
     end

data/lib/urban_dictionary/formatters.rb

@@ -2,6 +2,15 @@ require 'multi_json'
 
 module UrbanDictionary
   class Formatter
+    class Util
+      PATTERN = Regexp.compile(/\r\n|\r|\n/)
+      NEW_LINE = "\n"
+
+      def self.convert_linebreaks(str)
+        str.gsub(PATTERN, NEW_LINE)
+      end
+    end
+
     def self.register(name, klass)
       @formatters ||= {}
       if @formatters.include?(name)
@@ -31,9 +40,9 @@ module UrbanDictionary
       output << '-' * word.size
       output << ''
       word.entries.each_with_index do |entry, i|
-        output << "#{i + 1}. #{entry.definition}"
+        output << "#{i + 1}. #{Util.convert_linebreaks(entry.definition)}"
         output << ""
-        output << "Example: #{entry.example}"
+        output << "Example: #{Util.convert_linebreaks(entry.example)}"
         output << ""
         output << ""
       end
@@ -41,14 +50,20 @@ module UrbanDictionary
     end
   end
 
+  class DefinitionFormatter < Formatter
+    def self.format(word)
+      word.entries.map {|ea| Util.convert_linebreaks(ea.definition) }.join("\n")
+    end
+  end
+
   class JsonFormatter < Formatter
     def self.format(word)
       hsh = {
         :word => word.word,
         :entries => word.entries.map do |entry|
           {
-            :definition => entry.definition,
-            :example => entry.example
+            :definition => Util.convert_linebreaks(entry.definition),
+            :example => Util.convert_linebreaks(entry.example)
           }
         end
       }

data/lib/urban_dictionary/version.rb

@@ -1,3 +1,3 @@
 module UrbanDictionary
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/spec_helper.rb

@@ -5,26 +5,23 @@ require 'shellwords'
 require 'stringio'
 require 'webmock/rspec'
 
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = 'random'
-end
-
-module Test
-  def self.load_fixture(name)
-    File.read(File.expand_path("../html/#{name}", __FILE__))
-  end
-
+module TestHelpers
   class IO < StringIO
     def content
       rewind
       read
     end
+  end
 
-    def include?(str)
-      content.include?(str)
-    end
+  def load_fixture(name)
+    File.read(File.expand_path("../html/#{name}", __FILE__))
+  end
+
+  def mk_word(term, definitions, examples)
+    UrbanDictionary::Word.new(
+      term,
+      Array(definitions).zip(Array(examples)).map {|ea| UrbanDictionary::Entry.new(*ea) }
+    )
   end
 end
 
@@ -35,3 +32,9 @@ class String
   end
 end
 
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.include TestHelpers
+end

data/spec/urban_dictionary/cli_spec.rb

@@ -15,33 +15,32 @@ describe UrbanDictionary::CLI do
   def mk_cli(str, dictionary = nil)
     config = CLI::Config.new(
       :args => str.to_argv,
-      :stdout => Test::IO.new,
-      :stderr => Test::IO.new,
+      :stdout => TestHelpers::IO.new,
+      :stderr => TestHelpers::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")
+      expect(config.stdout.content).to include("Usage: urban_dictionary")
+    end
+
+    it "outputs an error message when an invalid option is provided" do
+      cli, config = mk_cli("--invalid-option")
+      suppress_exit(1) { cli.run }
+      expect(config.stderr.content).to include("invalid option: --invalid-option")
     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'")
+      expect(config.stderr.content).to include("No definition found for 'undefined word'")
     end
 
     it "outputs a word's definition when found" do
@@ -49,7 +48,7 @@ describe UrbanDictionary::CLI do
       dictionary = double("dictionary", :define => word)
       cli, config = mk_cli(word.word, dictionary)
       cli.run
-      expect(config.stdout).to include(word.word)
+      expect(config.stdout.content).to include(word.word)
     end
 
     it "outputs a random word when --random is provided" do
@@ -57,7 +56,7 @@ describe UrbanDictionary::CLI do
       dictionary = double("dictionary", :random_word => random_word)
       cli, config = mk_cli("--random", dictionary)
       cli.run
-      expect(config.stdout).to include(random_word.word)
+      expect(config.stdout.content).to include(random_word.word)
     end
 
     it "accepts --format to specify output format" do
@@ -68,5 +67,15 @@ describe UrbanDictionary::CLI do
       obj = MultiJson.load(config.stdout.content)
       expect(obj).to include("word" => word.word)
     end
+
+    it "accepts -n to limit number of definitions" do
+      word = mk_word("complex word", ["def #1", "def #2", "def #3"], ["example #1", "example #2", "example #3"])
+      dictionary = double("dictionary", :define => word)
+      cli, config = mk_cli("-n 1 #{word.word}", dictionary)
+      cli.run
+      expect(config.stdout.content).to include("def #1")
+      expect(config.stdout.content).not_to include("def #2")
+      expect(config.stdout.content).not_to include("def #3")
+    end
   end
 end

data/spec/urban_dictionary/formatters_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe UrbanDictionary::PlainFormatter do
+  let(:formatter) { UrbanDictionary::PlainFormatter }
+
+  describe "#format" do
+    it "converts carriage returns to new lines" do
+      word = mk_word("term", "definition\rwith CR", "example\rwith CR")
+      output = formatter.format(word)
+      expect(output).to include("definition\nwith CR")
+      expect(output).to include("example\nwith CR")
+    end
+  end
+end
+
+describe UrbanDictionary::DefinitionFormatter do
+  let(:formatter) { UrbanDictionary::DefinitionFormatter }
+  let(:word) { mk_word("term", "definition", "example") }
+
+  describe "#format" do
+    it "includes the definition" do
+      output = formatter.format(word)
+      expect(output).to include(word.entries.first.definition)
+    end
+
+    it "does not include the word" do
+      output = formatter.format(word)
+      expect(output).not_to include(word.word)
+    end
+
+    it "does not include examples" do
+      output = formatter.format(word)
+      expect(output).not_to include(word.entries.first.example)
+    end
+  end
+end
+
+
+describe UrbanDictionary::JsonFormatter do
+  let(:formatter) { UrbanDictionary::JsonFormatter }
+
+  describe "#format" do
+    it "converts carriage returns to new lines" do
+      word = mk_word("term", "definition\rwith CR", "example\rwith CR")
+      output = MultiJson.load(formatter.format(word))
+      expected_output = [
+        {"definition" => "definition\nwith CR", "example" => "example\nwith CR"}
+      ]
+      expect(output["entries"]).to eq(expected_output)
+    end
+  end
+end

data/spec/urban_dictionary/word_spec.rb

@@ -24,8 +24,8 @@ describe UrbanDictionary::Word do
   describe "class method" do
     describe "#from_url" do
       let(:url){ "the_url" }
-      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") }
+      let(:html_with_results){ load_fixture("on_fleek_2016-02-15.html") }
+      let(:html_without_results){ load_fixture("sisyphus_2016-02-15.html") }
 
       it "parses a valid word" do
         word = UrbanDictionary::Word.from_html(html_with_results)

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: urban_dictionary
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Greenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         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
     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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -88,9 +88,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -111,6 +111,7 @@ files:
 - spec/spec_helper.rb
 - spec/urban_dictionary/cli_spec.rb
 - spec/urban_dictionary/entry_spec.rb
+- spec/urban_dictionary/formatters_spec.rb
 - spec/urban_dictionary/word_spec.rb
 - spec/urban_dictionary_spec.rb
 - urban_dictionary.gemspec
@@ -123,17 +124,17 @@ 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: urban_dictionary
-rubygems_version: 2.5.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Interface to urbandictionary.com
@@ -146,5 +147,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/urban_dictionary/cli_spec.rb
 - spec/urban_dictionary/entry_spec.rb
+- spec/urban_dictionary/formatters_spec.rb
 - spec/urban_dictionary/word_spec.rb
 - spec/urban_dictionary_spec.rb