literate_randomizer 0.3.0 → 0.3.1

data/README.md

@@ -27,11 +27,11 @@ Example:
     lr.word
     # => "frivolous" 
 
-    lr.sentance
+    lr.sentence
     # => "Muscular arms round opening of sorts while Lord John Roxton." 
 
     lr.paragraph
-    # => "Tapped by his feet and the sign of the woods partly! Promoters might find such a row some rough hulking creatures we get a! Prove to think if we killed him state visit http While. Trusted ourselves and leaving the temperature ranges from the. Formally declared that if he will want to a howling the. Attentive neutrality. Helped to place where we heard the wide slow-moving clay-tinted stream and his. Itself as yet I was one circle of leathery wings as will understand." 
+    # => "Fulmination against the wandering that the woes of this. Particular package of the back to matchwood. File with hideous jaws of Southampton. Adventure and he. Skewered on to pledge." 
 
     puts lr.paragraphs
 
@@ -57,23 +57,23 @@ When creating a randomizer, there are a few options. The source_material should
 
     LiterateRandomizer.paragraph(options={})
       :first_word => nil - the start word
-      :words => range or int - number of words in sentance
-      :sentances => range or int - number of sentances in paragraph
-      :punctuation => nil - punction to end the sentance with (nil == randomly selected from punctuation_distribution)
+      :words => range or int - number of words in sentence
+      :sentences => range or int - number of sentences in paragraph
+      :punctuation => nil - punction to end the sentence with (nil == randomly selected from punctuation_distribution)
 
 **paragraphs** options:
 
     LiterateRandomizer.paragraphs(options={})
       :first_word => nil - the first word of the paragraph
-      :words => range or int - number of words in sentance
-      :sentances => range or int - number of sentances in paragraph
+      :words => range or int - number of words in sentence
+      :sentences => range or int - number of sentences in paragraph
       :punctuation => nil - punction to end the paragraph with (nil == randomly selected from punctuation_distribution)
       :paragraphs => range or int - number of paragraphs in paragraph
       :join => "\n\n" - join the paragraphs. if :join => false, returns an array of the paragraphs
 
 Advanced example:
 
-    lr.paragraph :sentances => 5, :words => 3..8, :first_word => "A", :punctuation => "!!!"
+    lr.paragraph :sentences => 5, :words => 3..8, :first_word => "A", :punctuation => "!!!"
     # => "A dense mob of our. Gods on that Challenger. Invariably to safety though. Weaponless but it my! Some bandy-legged lurching creature!!!"       
 
 If you just want to use a single, global instance, you can initialize and access it this way:
@@ -83,11 +83,11 @@ If you just want to use a single, global instance, you can initialize and access
     LiterateRandomizer.global(options={})
 
     # after the first call, options are ignored and the existing randomizer is returned
-    LiterateRandomizer.global.sentance
+    LiterateRandomizer.global.sentence
     # => "Muscular arms round opening of sorts while Lord John Roxton." 
 
     # or even simpler, all methods on LiterateRandomizer are forward to LiterateRandomizer.global:
-    LiterateRandomizer.paragraph(:sentances => 3, :words => 3)
+    LiterateRandomizer.paragraph(:sentences => 3, :words => 3)
     # => "Drama which would. Wrong fashion which. Throw them there."
 
 ## Contributing

data/lib/literate_randomizer/markov.rb

@@ -1,11 +1,12 @@
-#source: http://openmonkey.com/blog/2008/10/23/using-markov-chains-to-provide-english-language-seed-data-for-your-rails-application/
-# Tim Riley
-# Gemified by Shane Brinkman-Davis
+# Inspiration:
+#   http://openmonkey.com/blog/2008/10/23/using-markov-chains-to-provide-english-language-seed-data-for-your-rails-application/
+#   by Tim Riley
+# by Shane Brinkman-Davis
 
 module LiterateRandomizer
 class MarkovChain
   DEFAULT_PUNCTUATION_DISTRIBUTION = %w{. . . . . . . . . . . . . . . . ? !}
-  PREPOSITION_REGEX = /^(the|to|and|a|in|that|it|if|is|was|for|on|as|an)$/
+  PREPOSITION_REGEX = /^(had|the|to|or|and|a|in|that|it|if|of|is|was|for|on|as|an|your|our|my|per|until)$/
   attr_accessor :randomizer, :init_options, :punctuation_distribution
   attr_reader :markov_words, :words, :first_words
 
@@ -41,7 +42,7 @@ class MarkovChain
     word.chars.first.upcase+word[1..-1]
   end
 
-  def source_sentances
+  def source_sentences
     source_material.split(/([.?!"]\s|--| ')+/)
   end
 
@@ -56,8 +57,8 @@ class MarkovChain
     @markov_words = {}
     @words = {}
     @first_words = {}
-    source_sentances.each do |sentance|
-      word_list = scrub_word_list sentance
+    source_sentences.each do |sentence|
+      word_list = scrub_word_list sentence
       @first_words[word_list[0]] = true
       word_list.each_with_index do |word, index|
         @words[word] = true
@@ -128,13 +129,13 @@ class MarkovChain
     @cached_word_keys[rand(@cached_word_keys.length)]
   end
 
-  # return a random first word of a sentance
+  # return a random first word of a sentence
   def first_word 
     @cached_first_word_keys ||= first_words.keys
     @cached_first_word_keys[rand(@cached_first_word_keys.length)]
   end
 
-  # return a random first word of a sentance
+  # return a random first word of a sentence
   def markov_word 
     @cached_markov_word_keys ||= markov_words.keys
     @cached_markov_word_keys[rand(@cached_markov_word_keys.length)]
@@ -151,12 +152,12 @@ class MarkovChain
     words
   end
   
-  # return a random sentance
+  # return a random sentence
   # options:
   #   * :first_word => nil - the start word
-  #   * :words => range or int - number of words in sentance
-  #   * :punctuation => nil - punction to end the sentance with (nil == randomly selected from punctuation_distribution)
-  def sentance(options={})
+  #   * :words => range or int - number of words in sentence
+  #   * :punctuation => nil - punction to end the sentence with (nil == randomly selected from punctuation_distribution)
+  def sentence(options={})
     word = options[:first_word] || self.markov_word
     num_words_option = options[:words] || (3..15)
     count = rand_count num_words_option
@@ -174,25 +175,25 @@ class MarkovChain
   # return a random paragraph
   # options:
   #   * :first_word => nil - the first word of the paragraph
-  #   * :words => range or int - number of words in sentance
-  #   * :sentances => range or int - number of sentances in paragraph
+  #   * :words => range or int - number of words in sentence
+  #   * :sentences => range or int - number of sentences in paragraph
   #   * :punctuation => nil - punction to end the paragraph with (nil == randomly selected from punctuation_distribution)
   def paragraph(options={})
-    count = rand_count options[:sentances] || (5..15)
+    count = rand_count options[:sentences] || (5..15)
 
     count.times.collect do |i|
       op = options.clone
       op.delete :punctuation unless i==count-1
       op.delete :first_word unless i==0
-      sentance op
+      sentence op
     end.join(" ")
   end
 
   # return random paragraphs
   # options:
   #   * :first_word => nil - the first word of the paragraph
-  #   * :words => range or int - number of words in sentance
-  #   * :sentances => range or int - number of sentances in paragraph
+  #   * :words => range or int - number of words in sentence
+  #   * :sentences => range or int - number of sentences in paragraph
   #   * :paragraphs => range or int - number of paragraphs in paragraph
   #   * :join => "\n\n" - join the paragraphs. if :join => false, returns an array of the paragraphs
   #   * :punctuation => nil - punction to end the paragraph with (nil == randomly selected from punctuation_distribution)

data/lib/literate_randomizer/version.rb

@@ -1,3 +1,3 @@
 module LiterateRandomizer
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/literate_randomizer_spec.rb

@@ -21,37 +21,37 @@ describe LiterateRandomizer do
     new_lr.words.length.should == 9143
   end
 
-  it "first_words.length should be the number words starting sentances in the file" do
+  it "first_words.length should be the number words starting sentences in the file" do
     new_lr.first_words.length.should == 754
   end
 
-  it "source_sentances.length should be the number of sentances in the file" do
-    new_lr.source_sentances.length.should == 10699
-    new_lr.source_sentances.length.should > new_lr.first_word.length
+  it "source_sentences.length should be the number of sentences in the file" do
+    new_lr.source_sentences.length.should == 10699
+    new_lr.source_sentences.length.should > new_lr.first_word.length
   end
 
   it "word should return a random word" do
     new_lr.word.should == "own"
   end
 
-  it "sentance should return a random sentance" do
-    new_lr.sentance.should == "Bad form of my own chances are a riding-whip."
+  it "sentence should return a random sentence" do
+    new_lr.sentence.should == "Bad form of my own chances are a riding-whip."
   end
 
-  it "sentance length should work" do
-    new_lr.sentance(:words => 1).should == "Bad."
-    new_lr.sentance(:words => 3).should == "Bad money if."
-    new_lr.sentance(:words => 5).should == "Bad money if ever come."
-    new_lr.sentance(:words => 7).should == "Bad money if ever come outwards at."
-    new_lr.sentance(:words => 9).should == "Bad money if ever come outwards at the side."
-    new_lr.sentance(:words => 2..7).should == "Bad job for a final credit."
+  it "sentence length should work" do
+    new_lr.sentence(:words => 1).should == "Bad."
+    new_lr.sentence(:words => 3).should == "Bad money if."
+    new_lr.sentence(:words => 5).should == "Bad money if ever come."
+    new_lr.sentence(:words => 7).should == "Bad money if ever come outwards at."
+    new_lr.sentence(:words => 9).should == "Bad money if ever come outwards at the side."
+    new_lr.sentence(:words => 2..7).should == "Bad job for a final credit."
   end
 
   it "successive calls should vary" do
     lr = new_lr
-    lr.sentance.should == "Bad form of my own chances are a riding-whip."
-    lr.sentance.should == "Hit you chaps think of battle Our young fellah when in Streatham."
-    lr.sentance.should == "Upward curves which should be through the whole tribe."
+    lr.sentence.should == "Bad form of my own chances are a riding-whip."
+    lr.sentence.should == "Hit you chaps think of battle Our young fellah when in Streatham."
+    lr.sentence.should == "Upward curves which should be through the whole tribe."
   end
 
   it "paragraph should work" do
@@ -59,16 +59,16 @@ describe LiterateRandomizer do
   end
 
   it "first_word should work" do
-    new_lr.paragraph(:sentances => 5, :words=>3).should == "Bad money if. Discreetly vague way. Melee in that. Hopin that dreadful. Executive and hold."
-    new_lr.paragraph(:sentances => 2..4, :words=>3).should == "Bad money if. Discreetly vague way. Melee in that."
+    new_lr.paragraph(:sentences => 5, :words=>3).should == "Bad money if. Discreetly vague way. Melee in that. Hopin that dreadful. Executive and hold."
+    new_lr.paragraph(:sentences => 2..4, :words=>3).should == "Bad money if. Discreetly vague way. Melee in that."
   end
 
   it "first_word should work" do
-    new_lr.paragraph(:first_word => "A",:sentances => 5, :words=>3).should == "A roaring rumbling. Instanced a journalist. Eight after to-morrow. Hopin that dreadful. Executive and hold."
+    new_lr.paragraph(:first_word => "A",:sentences => 5, :words=>3).should == "A roaring rumbling. Instanced a journalist. Eight after to-morrow. Hopin that dreadful. Executive and hold."
   end
 
   it "punctuation should work" do
-    new_lr.paragraph(:punctuation => "!!!",:sentances => 5, :words=>3).should == "Bad money if. Discreetly vague way. Melee in that. Hopin that dreadful. Executive and hold!!!"
+    new_lr.paragraph(:punctuation => "!!!",:sentences => 5, :words=>3).should == "Bad money if. Discreetly vague way. Melee in that. Hopin that dreadful. Executive and hold!!!"
   end
 
   it "global_randomizer_should work" do
@@ -79,13 +79,13 @@ describe LiterateRandomizer do
     LiterateRandomizer.respond_to?(:paragraph).should == true
     LiterateRandomizer.respond_to?(:fonsfoaihdsfa).should == false
     LiterateRandomizer.word.should == "own"
-    LiterateRandomizer.sentance.should == "Beak filled in the side of Vertebrate Evolution and up into private."
-    LiterateRandomizer.paragraph.should == "GUTENBERG-tm concept of their rat-trap grip upon Challenger of the carrying of! Precipices of me! Telling you with great enterprise upon their own eventual goal and it in a liar. The complete your. Historical architecture elaborated slowly defined our heads there came upon their leathery. Their signs of. Elusive enemies while beneath the main river up in it because on a boiling."
+    LiterateRandomizer.sentence.should == "Beak filled in the side of Vertebrate Evolution and up into private."
+    LiterateRandomizer.paragraph.should == "GUTENBERG-tm concept of their rat-trap grip upon Challenger of the carrying of selfishness! Telling you with great enterprise upon their own eventual goal and it in a liar. The complete your consent. Reporters down at a tangle of the huge flippers behind us in writing. Chandeliers in those huge wings of this agreement and Ipetu. Taken the gray eyes were general laws of what. Variety of photographs said for the words?"
   end
 
   it "global_randomizer_should forwarding should work" do
-    LiterateRandomizer.paragraphs(:words =>2, :sentances => 2).should == "Bad money. Instanced a.\n\nFLAIL OF. Melee in.\n\nHit you. Executive and.\n\nHopes and. Puffing red-faced."
-    LiterateRandomizer.paragraphs(:words =>2, :sentances => 2, :join=>"--").should == "Pick holes. Telling you.--Mend it. Considerate of!--Albany and! Fame or?--The weak. Prime mover."
-    LiterateRandomizer.paragraphs(:words =>2, :sentances => 2, :join=>false).should == ["Reporters down. Again the.", "Their position. Dressing down.", "Chandeliers in. Although every."]
+    LiterateRandomizer.paragraphs(:words =>2, :sentences => 2).should == "Bad money. Instanced a.\n\nFLAIL OF. Melee in.\n\nHit you. Executive and.\n\nHopes and. Puffing red-faced."
+    LiterateRandomizer.paragraphs(:words =>2, :sentences => 2, :join=>"--").should == "Pick holes. Telling you.--Mend it. Considerate of!--Albany and! Fame or?--The weak. Prime mover."
+    LiterateRandomizer.paragraphs(:words =>2, :sentences => 2, :join=>false).should == ["Reporters down. Again the.", "Their position. Dressing down.", "Chandeliers in. Although every."]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: literate_randomizer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors: