dogeify 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGE1NDE5NzU4NGQxZjFlYjUyMGExNDRkOWFmNjIxN2YyMmNmYzcwNw==
-  data.tar.gz: !binary |-
-    MzlkZjM2ODk1M2E5Yjg3OGU2YjU2NDNiZmJhNTQxMDMwZWFkMDFiYw==
+SHA1:
+  metadata.gz: 919803b45f9326a80f0031d85346a7ee07b6e70a
+  data.tar.gz: ccabf738ebc176f918eb254e0f70d5a696adc94f
 SHA512:
-  metadata.gz: !binary |-
-    NDgwYTc3MDU4YjE4NDE3Nzg0MTA3OWMzNmZlYzYzNTI0NGEyYTBkMTdhNjIz
-    ZDdmMzFkMTY2ZWRiNjkyYjBkMTU0MGI5ZGFhM2NhMDE4ODkyMjE1NTJlZTRh
-    Y2Y0MDliNGRhOTY5NzMzNjJjZmM3MWRiNGQ1ZTNmYzU1MjgyMDE=
-  data.tar.gz: !binary |-
-    N2FiNWVjZThhNDE0NzZiMTUzM2MwZjFlYmJlOTk1MDNjNzYzNWI3NTlmOGZl
-    ODMxZmRhM2NhMmFlZjg0MTZjY2YxNmFhYmI2NzdhMDA0ZDg4NjQ1N2RmZDJk
-    MTljZjhjYmFiZjY5MWNlMjJhNjA5MTQ3NjUzMDYzMzdlYzg3OTQ=
+  metadata.gz: 221241075d5e9e94abf90b6c8da5c86b30e45620d040507478d9bc16c5aff68f9b31717cd87a21b6627b4b55c6ba7de1fb645680bea28102c496840c944838c1
+  data.tar.gz: d5998433beff226cae5afadefeb79f9b522179693ea60c185a8366500c6ccc49e6ae940d8dcb6526ed7860af897d70d3d101aebc38a430ee7fa5a58aa88583d5

data/README.md

@@ -51,6 +51,19 @@ a single require.
 
     require 'dogeify/all'
 
+### Options
+
+For each of the above method calls, an optional `options` hash can be passed in
+to specify additional processing preferences.  Currently, only the `ignore`
+option exists, accepting a string/regex value (or array of string/regex values)
+that should not be converted to doge.
+
+    dogifier.process('My grandmom gave me a sweater for Christmas.', ignore: 'grandmom')
+    # => "so sweater. such christmas. wow."
+
+    'My grandmom gave me a sweater for Christmas'.dogeify(ignore: [/christmas/i, 'sweater'])
+    # => "so grandmom. wow."
+
 ## Contributing
 
 1. Fork it

data/lib/dogeify.rb

@@ -9,11 +9,14 @@ class Dogeify
     @tagger = EngTagger.new
   end
 
-  def process(str)
+  def process(str, options = {})
     # Parse sentences.
     sentences = str.downcase.split(/[\.!?]+/).map(&:strip)
 
     sentences = sentences.map do |sentence|
+      # Ignore any provided patterns.
+      sentence = ignore_patterns(sentence, options[:ignore]) if options[:ignore]
+      
       # Select just the nouns.
       tagged_sentence = tagger.add_tags(sentence)
       phrases = tagger.get_nouns(tagged_sentence).keys rescue []
@@ -46,6 +49,12 @@ class Dogeify
     end
   end
 
+  def ignore_patterns(sentence, patterns)
+    sentence.dup.tap do |sentence|
+      Array(patterns).map { |pattern| sentence.gsub!(pattern, '') }
+    end
+  end
+
   def adjective
     ADJECTIVES[adjective_offset]
   end

data/lib/dogeify/core_ext/array.rb

@@ -1,8 +1,8 @@
 require 'dogeify'
 
 class Array
-  def dogeify
+  def dogeify(options = {})
     dogeify = Dogeify.new
-    map { |item| dogeify.process(item.to_s) }
+    map { |item| dogeify.process(item.to_s, options) }
   end
 end

data/lib/dogeify/core_ext/string.rb

@@ -1,7 +1,7 @@
 require 'dogeify'
 
 class String
-  def dogeify
-    Dogeify.new.process(self)
+  def dogeify(options = {})
+    Dogeify.new.process(self, options)
   end
 end

data/lib/dogeify/version.rb

@@ -1,3 +1,3 @@
 class Dogeify
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/core_ext/array_spec.rb

@@ -4,17 +4,19 @@ describe Array do
   subject { ['My grandmom gave me a sweater for Christmas.', 'I like turtles.', 'I am a banana.'] }
 
   describe '#dogeify' do
+    let(:options) { { ignore: [] } }
+    let(:output) { subject.dogeify(options) }
+
     it 'delegates to Dogeify#process for each element' do
       subject.each do |item|
-        expect_any_instance_of(Dogeify).to receive(:process).with(item).once
+        expect_any_instance_of(Dogeify).to receive(:process).with(item, options).once
       end
 
-      subject.dogeify
+      output
     end
 
     it 'returns an array of strings' do
-      expect(subject.dogeify).to be_an Array
-      expect(subject.dogeify.map(&:class).uniq).to eq [String]
+      expect(output).to be_an_array_of String
     end
   end
 end

data/spec/core_ext/string_spec.rb

@@ -4,13 +4,16 @@ describe String do
   subject { 'My grandmom gave me a sweater for Christmas.' }
 
   describe '#dogeify' do
+    let(:options) { { ignore: [] } }
+    let(:output) { subject.dogeify(options) }
+
     it 'delegates to Dogeify#process' do
-      expect_any_instance_of(Dogeify).to receive(:process).with(subject)
-      subject.dogeify
+      expect_any_instance_of(Dogeify).to receive(:process).with(subject, options)
+      output
     end
 
     it 'returns a string' do
-      expect(subject.dogeify).to be_a String
+      expect(output).to be_a String
     end
   end
 end

data/spec/dogeify_spec.rb

@@ -55,5 +55,26 @@ describe Dogeify do
         expect(output).to include 'queschun'
       end
     end
+
+    describe 'when an ignore option is passed' do
+      let(:input) { '\e[35;47mHello world!\e[0m' }
+      let(:pattern) { /\\e\[\d+(;\d+)?m/ }
+
+      describe 'with a single pattern' do
+        let(:output) { subject.process(input, ignore: pattern) }
+
+        it 'removes the pattern' do
+          expect(output).to start_with 'so world.'
+        end
+      end
+
+      describe 'with multiple patterns' do
+        let(:output) { subject.process(input, ignore: [pattern, /world/]) }
+
+        it 'removes all patterns' do
+          expect(output).to start_with 'wow.'
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,10 @@
 require 'dogeify/all'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+Dir[File.expand_path('spec/support/**/*.rb')].each(&method(:require)) #{ |f| require f }

data/spec/support/matchers/enumerable_matchers.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :be_an_array_of do |expected|
+  match do |actual|
+    actual.is_a?(Array) && actual.map(&:class).uniq == [expected]
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: dogeify
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Huggins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: engtagger
   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'
 - !ruby/object:Gem::Dependency
@@ -42,28 +42,28 @@ dependencies:
   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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Convert everyday boring English into doge speak!
@@ -93,6 +93,7 @@ files:
 - spec/core_ext/string_spec.rb
 - spec/dogeify_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers/enumerable_matchers.rb
 - tasks/debug.rake
 - tasks/rspec.rake
 homepage: ''
@@ -105,17 +106,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: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: English to doge translations
@@ -124,3 +125,4 @@ test_files:
 - spec/core_ext/string_spec.rb
 - spec/dogeify_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers/enumerable_matchers.rb