syllable_counter 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTI2Njc1ODA3Yzk4Yzk5MGNkOGJkOTMyNjI5MmZjYTczZjgzOTIzMg==
-  data.tar.gz: !binary |-
-    NGZjZTFkMjhhODIwMGIwZjAxNTRkYTlhMzQxZDhmYmU2M2M1ZmRjOQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NjYwMTVkNjZhZTEwODljOTkyOTlkN2I1OTZmMjg2ZmY4ZThhODhiMjdhN2Zh
-    MjBjNzc1M2ZmYzAzNjI3ODI2N2UzMGJlMDhiMTM3N2M3OWU1ZDIyNTFmMWM3
-    MjEzYjcyMjFkYTg4OWNmMDAzNzNjY2UwZDgzNDRkNWU2NGRiN2I=
-  data.tar.gz: !binary |-
-    ODdiNWMzMTc4OTkxY2ZiYmVmMWEyZTBkYTFmZWNjMTMxNTI3MDljMmExZWJj
-    ZmY2MWVkMWViNDQ5MzU5Yjc3MWUzNDgzMjcwZTc3ZWExZmEyZjFjMmZiNmRm
-    Y2ZkZjQ0OWE5NmVkMDY5YWU5NjU4NjQxMTIwMzg1MzVhM2M1NTg=
+SHA1:
+  metadata.gz: a420151dfc676f1bda16dd63c6290f0ad99f3ded
+  data.tar.gz: e072ebdde242c9a190b806deccd18cd9fd3351f1
+SHA512:
+  metadata.gz: 67443fef90674bc7d0adb867f5db38aba466e8ad59e455e71282c16bd5a8dd919b58cd2ddb2717c96c31f1acecd673bc93fb0d70c3f2fa88b4687c09c2efeb88
+  data.tar.gz: 32afe674f94c41c84f475fe1f149c613bbb32646cde77cf3c9b4a2f75995f6ee164ec14617c219f56e5507b0916f6f14b72c94f4ae2ee5349124fc6245da1a16

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 To get the number of syllables for a string:
 
-    SyllableCounter.get_syllables("Text to be evaluated goes here")
+    SyllableCounter::Count.get_syllables("Text to be evaluated goes here")
     #=> 10
 
 ## Algorithm
@@ -33,7 +33,7 @@ Suggestions for additions are absolutely welcome!  Email me at kelseymok@gmail.c
 1. Assumes at least one obligatory vowel per syllable
 2. Final /e/ is not realized unless the final /e/ is preceded by an /l/
 or /r/ and a consonant (ie. -dle, -cre).
-3. Final /ed/ suffix is not realized when preceeded by a /t/ or
+3. Final /ed/ suffix is only realized when preceeded by a /t/ or
 /d/
 4. Final /es/ plural suffix is realized after /s/ /z/ /sh/ /dg/ /ch/
 /[aeiou]g/
@@ -46,3 +46,6 @@ Pending
 2. /iu/ combinations are two syllables
 2. Exceptions: "maybe", "Wednesday"
 3. Dialect-specific versions for English
+
+##Contributing
+Submit a pull request!  The code is structured so that you can easily add a rule or an exception and specs.  If the PR hasn't been addressed, feel free to ping me.

data/lib/syllable_counter.rb

@@ -1,26 +1,14 @@
 require "syllable_counter/version"
+require "syllable_counter/rules"
 
 module SyllableCounter
-  class << self
+  class Count
+    def initialize(calculator = SyllableCounter::Calculator.new)
+      @calculator = calculator
+    end
+
     def get_syllables(string)
-      words = string.split()
-      count = 0
-      words.each do |word|
-      if word =~ /e$/
-        if word =~ /[aeiouy][lr]e$/ || word =~ /[^lr]e$/
-          word.sub!(/e$/,"")
-        end
-      end
-      word =~ /[^td]ed$/ ? word.sub!(/ed$/,"") : word
-      word =~ /(s||z||sh||dg||[aeiouy]g||ch)es$/ ? word.sub!(/ed$/,"") : word
-      word =~ /[aeiouy][aeiouy]/ ? word.sub!(/[aeiouy][aeiouy]/,"a") : word
-      vowel_count = word.scan(/[aeiouy]/).count
-      if vowel_count == 0
-        vowel_count = 1
-      end
-      count = count + vowel_count
-      end
-      return count
+      @calculator.execute(string)
     end
   end
 end

data/lib/syllable_counter/calculate.rb

@@ -0,0 +1,28 @@
+require "syllable_counter/version"
+require "syllable_counter/rules"
+
+module SyllableCounter
+  class Calculate
+    def initialize(rule_set = SyllableCounter::Rules::Rules.new)
+      @rule_set = rule_set
+    end
+
+    def execute(string)
+      count = 0
+      string.split.each do |word|
+        if @rule_set.is_exception?(word)
+          count += @rule_set.exceptions[word]
+        else
+          count += validate(@rule_set.execute(word).scan(/[aeiouy%]/).count)
+        end
+      end
+      count
+    end
+
+    protected
+    def validate(count)
+      #all English words must have at least one syllable
+      count == 0 ? 1 : count
+    end
+  end
+end

data/lib/syllable_counter/english_exceptions.rb

@@ -0,0 +1,11 @@
+module SyllableCounter
+  module Rules
+    module EnglishExceptions
+
+      EXCEPTIONS = {
+        "wednesday" => 2,
+        "maybe" => 2
+      }
+    end
+  end
+end

data/lib/syllable_counter/rules.rb

@@ -0,0 +1,71 @@
+require 'syllable_counter/english_exceptions'
+
+module SyllableCounter
+  module Rules
+    class Rules
+      include EnglishExceptions
+
+      def initialize
+
+      end
+
+      def execute(word)
+        parsed_word = clean_input(word)
+        parsed_word = clean_input(word)
+        parsed_word = delete_trailing_e(parsed_word)
+        parsed_word = delete_past_ed(parsed_word)
+        parsed_word = combine_consecutive_vowels(parsed_word)
+        parsed_word = remove_plural_suffix(parsed_word)
+        parsed_word
+      end
+
+      def is_exception?(word)
+        exceptions.keys.include?(word)
+      end
+
+      def exceptions
+        EnglishExceptions::EXCEPTIONS
+      end
+
+      protected
+      def delete_trailing_e(word)
+        #deletes trailing e if preceded by a vowel+[lr] or [^lr]
+        if word =~ /[aeiouy][lr]e$/ || word =~ /[^lr]e$/
+          word.sub!(/e$/,"")
+        end
+        word
+      end
+
+      def delete_past_ed(word)
+        #removes /ed/ suffix except when preceded by /t/ or /d/
+
+        if word =~ /[^td]ed$/
+          word.sub!(/ed$/,"")
+        end
+        word
+      end
+
+      def combine_consecutive_vowels(word)
+        #combines consecutive vowels and replpaces with % placeholder
+
+        while word =~ /[aeiouy%][aeiouy%]/
+          word.sub!(/[aeiouy%][aeiouy%]/,"%")
+        end
+        word
+      end
+
+      def remove_plural_suffix(word)
+        #Final /es/ plural suffix is realized after /s/ /z/ /sh/ /dg/ /ch/ /[aeiou]g/
+        if word =~ /[^([z]|[sh]|[dg]|[ch]|[aeiouy][g]|[s])]es$/
+          word.sub!(/es$/,"")
+        end
+        word
+      end
+
+      private
+      def clean_input(word)
+        word.downcase.strip
+      end
+    end
+  end
+end

data/lib/syllable_counter/version.rb

@@ -1,3 +1,3 @@
 module SyllableCounter
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/spec/calculator_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe SyllableCounter::Calculate do
+
+  let(:rule_set) { SyllableCounter::Rules::Rules.new }
+  subject { described_class.new(rule_set) }
+
+  it "returns a syllable count" do
+    subject.execute("test").should == 1
+    subject.execute("palette").should == 2
+    subject.execute("passes").should == 2
+    subject.execute("table").should == 2
+    subject.execute("foo bar").should == 2
+    subject.execute("wednesday").should == 2
+    subject.execute("maybe").should == 2
+    subject.execute("the quick brown fox").should == 4
+  end
+
+  context "#validate" do
+    it "returns a value of at least 1" do
+      subject.send(:validate, 0) == 1
+      subject.send(:validate, 1) == 1
+      subject.send(:validate, 2) == 2
+    end
+  end
+
+ end

data/spec/rules_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe SyllableCounter::Rules::Rules do
+  subject { described_class.new }
+  context "#delete_trailing_e" do
+    it "removes e" do
+      subject.execute("rule").should == "rul"
+    end
+  end
+
+  context "#delete_past_ed" do
+    it "removes /ed/" do
+      subject.execute("scorched").should == "scorch"
+    end
+
+    it "does not remove /ed/" do
+      subject.execute("padded").should == "padded"
+    end
+  end
+
+  context "#combine_consecutive_vowels" do
+    it "removes consecutive vowels and replaces with %" do
+      subject.execute("you").should == "%"
+    end
+  end
+
+  context "#remove_plural_suffix" do
+    it "removes plural suffix" do
+      subject.execute("passes").should == "passes"
+      subject.execute("apples").should == "appl"
+    end
+  end
+
+  context "#exceptions" do
+    it "returns a hash" do
+      subject.send(:exceptions).should be_a Hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require 'rubygems'
 require 'syllable_counter'
+require 'syllable_counter/rules'
+require 'syllable_counter/english_exceptions'
+require 'syllable_counter/calculate'
 
 def configure_syllable_counter
   Rspec.configure do |config|

data/spec/syllable_counter_spec.rb

@@ -1,81 +1,12 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "Syllables" do
-  describe "#get_syllables" do
-      it "returns number of vowels" do
-        SyllableCounter.get_syllables("test").should == 1
-      end
+describe SyllableCounter::Count do
 
-    context "has two vowels" do
-      it "returns 2" do
-        SyllableCounter.get_syllables("cabin").should == 2
-      end
-    end
+  let(:calculator) { SyllableCounter::Calculate.new }
 
-    context "has a vowel"
+  subject { described_class.new(calculator) }
 
-      context "and an /e/ at the end of the word" do
-        it "returns 1" do
-          SyllableCounter.get_syllables("here").should == 1
-          SyllableCounter.get_syllables("age").should == 1
-        end
-      end
-
-      context "and then consecutive vowels" do
-        it "returns 2" do
-          SyllableCounter.get_syllables("meaty").should == 2
-        end
-      end
-      
-      context "and has an /es/ suffix preceeded by /s z sh dg g ch/" do
-        it "is realized" do
-          SyllableCounter.get_syllables("kansas").should == 2
-          SyllableCounter.get_syllables("sizes").should == 2
-          SyllableCounter.get_syllables("fishes").should == 2
-          SyllableCounter.get_syllables("judges").should == 2
-          SyllableCounter.get_syllables("advantages").should == 4
-          SyllableCounter.get_syllables("churches").should == 2
-        end
-      end
-
-      context "and has an /ed/ suffix preceded by a /t/ or /d/" do
-        it "the /ed/ is realized" do
-          SyllableCounter.get_syllables("coughed").should == 1
-          SyllableCounter.get_syllables("kneaded").should == 2
-        end
-      end
-
-      context "and is one syllable with one trailing /e/" do
-        it "returns 1" do
-          SyllableCounter.get_syllables("the").should == 1
-          SyllableCounter.get_syllables("he").should == 1
-        end
-      end
-
-      context "and has a consonant + /le/ or /re/ ending" do
-        it "the final /e/ is realized" do
-          SyllableCounter.get_syllables("uncomfortable").should == 5
-        end
-      end
+  it "returns a syllable count" do
+    subject.get_syllables("foo bar").should be_kind_of Integer
   end
-
-    context "has a sentence" do
-      it "returns 11" do
-        SyllableCounter.get_syllables("the quick brown fox jumped over the lazy dog").should == 11
-        SyllableCounter.get_syllables("please call stella").should == 4
-        SyllableCounter.get_syllables("ask her to bring these things with her from the store").should == 11
-        SyllableCounter.get_syllables("six spoons of fresh snow peas").should == 6
-        SyllableCounter.get_syllables("five thick slabs of blue cheese").should == 6
-        #SyllablesCounter.get_syllables("and maybe a snack for her brother bob").should == 10
-        SyllableCounter.get_syllables("we also need a small plastic snake for the kids").should == 12
-        SyllableCounter.get_syllables("she can scoop these things into three red bags").should == 10
-        #SyllableCounter.get_syllables("and we will go meet her Wednesday at the train station").should == 13
-      end
-    end
-
-    #context "exceptions" do
-      #it "returns" do
-        #syllables("maybe").should == 2
-      #end
-    #end
- end
+end

data/syllable_counter.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = SyllableCounter::VERSION
   spec.authors       = ["Kelsey Mok"]
   spec.email         = ["kelseymok@gmail.com"]
-  spec.description   = %q{Returns number of syllables (American English) given a string}
-  spec.summary       = %q{Returns number of syllables (American English) given a string}
+  spec.description   = %q{Guesses number of syllables (American English) given a string}
+  spec.summary       = %q{Guesses number of syllables (American English) given a string}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/vendor/bundle/bin/autospec

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'rspec-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'rspec-core', version
+load Gem.bin_path('rspec-core', 'autospec', version)

data/vendor/bundle/bin/htmldiff

@@ -0,0 +1,25 @@
+#!/bin/sh
+'exec' "ruby" '-x' "$0" "$@"
+#!/Users/kelseymok/.rbenv/versions/2.0.0-p0/bin/ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'htmldiff', version)

data/vendor/bundle/bin/ldiff

@@ -0,0 +1,25 @@
+#!/bin/sh
+'exec' "ruby" '-x' "$0" "$@"
+#!/Users/kelseymok/.rbenv/versions/2.0.0-p0/bin/ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'diff-lcs' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
+end
+
+gem 'diff-lcs', version
+load Gem.bin_path('diff-lcs', 'ldiff', version)