marky_markov 0.3.3 → 0.3.4

data/README.md

@@ -1,25 +1,20 @@
 Marky Markov and the Funky Sentences
 ====================================
 
-Marky Markov is a naïve experiment in Markov Chain generation implemented
+Marky Markov is an experiment in Markov Chain generation implemented
 in Ruby. It can be used both from the command-line and as a library within your code.
 
 NOTE: 0.3.0 now uses arrays with multiple entries per word instead of a
 hash key for each word with the value representing number of occurences.
-While a less elegant solution, it leads to faster text generation. We
-are also now using ox instead of yajl-json to store the dictionary
-as yajl-json does not appear to support arrays within hashes properly.
-
-NOTE: In the transition between 0.1.3 to 0.2.0 MarkyMarkov has added the
-ability to generate proper sentences (generate_n_sentences) instead of simply a
-maximum number of words. The command-line app has changed to sentences as its default
-behavior.
+While a less elegant solution, it leads to much faster text generation.
 
 # Installation
 
     gem install marky_markov
 
-# Module Usage
+# Imported Module Usage
+
+## Temporary Dictionary
 
 A basic usage of the TemporaryDictionary, which parses strings and files into a
 temporary dictionary that will not be saved to disk.
@@ -30,7 +25,9 @@ temporary dictionary that will not be saved to disk.
     markov.parse_file "filename.txt"
     puts markov.generate_n_sentences 5
     puts markov.generate_n_words 200
-    markov.clear!
+    markov.clear! # Clear the temporary dictionary.
+  
+## Persistent Dictionary
     
 Dictionary creates or opens a persistent dictionary at a location defined by its 
 initalizer, and will allow you to build and save a dictionary over multiple runs.
@@ -45,6 +42,8 @@ of the dictionary name.
     puts markov.generate_n_sentences 2
     markov.save_dictionary! # Saves the modified dictionary/creates one if it didn't exist.
 
+## generate_20_words
+
 If you keep looking at generate_n_words or generate_n_sentences and wonder why you can't put a
 number in there, well, you can!
 
@@ -65,6 +64,8 @@ creates a dictionary with a depth of three words.
 `{["I", "hope", "this"]     => ["makes"],
   ["hope", "this", "makes"] => ["sense"]`
 
+## Delete a Dictionary
+
 If you want to delete a dictionary you call it upon the Dictionary class itself while
 passing in the filename/location.
 

data/bin/marky_markov

@@ -23,6 +23,9 @@ opt_parser = OptionParser.new do |opts|
   options[:sentencecount] = 5
   opts.on('-c', '--sentencecount NUMBER', 'Set number of sentences generated') do |number|
     options[:sentencecount] = number.to_i
+    if options[:sentencecount] < 1
+      abort("You must enter a number higher than 0. Try 4. Or maybe 10?")
+    end
   end
 
   options[:source] = nil
@@ -81,19 +84,15 @@ when "read"
   end
 when "listen"
   markov = MarkyMarkov::TemporaryDictionary.new
-  begin
-    markov.parse_string(STDIN.tty? ? ARGV[1] : STDIN.read)
-    STDOUT.puts markov.generate_n_sentences(options[:sentencecount])
-  rescue
-    abort("Not enough words to generate a sentence.")
-  end
+  markov.parse_string(STDIN.tty? ? ARGV[1] : STDIN.read)
+  STDOUT.puts markov.generate_n_sentences(options[:sentencecount])
 else
   unless STDIN.tty?
     markov = MarkyMarkov::TemporaryDictionary.new
     markov.parse_string(STDIN.read)
     STDOUT.puts markov.generate_n_sentences(options[:sentencecount])
   else
-    STDERR.puts "Sorry, I don't know how to #{ARGV[0]}."
+    STDERR.puts "Sorry, I don't know how to #{ARGV[0]}." if ARGV[0]
     STDOUT.puts opt_parser
     exit false
   end

data/lib/marky_markov/markov_dictionary.rb

@@ -24,6 +24,8 @@ class MarkovDictionary # :nodoc:
   #
   # @example Adding a word
   #   add_word("Hello", "world")
+  # @example Adding a multi-word dictionary
+  #   add_word("You are", "awesome")
   def add_word(rootword, followedby)
     @dictionary[rootword] ||= []
     @dictionary[rootword] << followedby

data/lib/marky_markov/markov_sentence_generator.rb

@@ -73,7 +73,7 @@ class MarkovSentenceGenerator # :nodoc:
     sentence.concat(random_capitalized_word)
     (wordcount-1).times do
       word = weighted_random(sentence.last(@depth))
-      if punctuation?(word[0])
+      if punctuation?(word)
         sentence[-1] = sentence.last.dup << word
       elsif word.nil?
         sentence.concat(random_capitalized_word)

data/lib/marky_markov/persistent_dictionary.rb

@@ -16,7 +16,7 @@ class PersistentDictionary < MarkovDictionary # :nodoc:
   def initialize(dictionary, depth=2)
     @depth = depth
     unless (1..5).include?(depth)
-      raise DepthNotInRangeError.new("Depth must be between 1 and 5")
+      raise DepthNotInRangeError.new("Depth must be between 1 and 5. For best results, use 2.")
     end
     @dictionarylocation = dictionary
     @split_words = /([.?!])|[\s]+/

data/lib/marky_markov.rb

@@ -4,12 +4,12 @@
 require_relative 'marky_markov/persistent_dictionary'
 require_relative 'marky_markov/markov_sentence_generator'
 
-# @version = 0.3.3
+# @version = 0.3.4
 # @author Matt Furden
 # Module containing TemporaryDictionary and Dictionary for creation of
 # Markov Chain Dictionaries and generating sentences from those dictionaries.
 module MarkyMarkov
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 
   class TemporaryDictionary
     # Create a new Temporary Markov Chain Dictionary and sentence generator for use.

data/marky_markov.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'marky_markov'
-  s.version           = '0.3.3'
-  s.date              = '2012-02-13'
+  s.version           = '0.3.4'
+  s.date              = '2012-02-27'
   s.rubyforge_project = 'marky_markov'
 
   ## Make sure your summary is short. The description may be as long

data/spec/spec_helper.rb

@@ -1 +1,2 @@
-require 'marky_markov'
+require_relative '../lib/marky_markov'
+require 'rspec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marky_markov
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000 Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
-  requirement: &70245354003740 !ruby/object:Gem::Requirement
+  requirement: &70229846255560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70245354003740
+  version_requirements: *70229846255560
 description: ! "MarkyMarkov makes it easy to generate simply Markov Chains based upon
   input from\n  either a source file or a string. While usable as a module in your
   code it can also be called on\n  from the command line and piped into like a standard
@@ -71,4 +71,3 @@ signing_key:
 specification_version: 2
 summary: Simple Markov Chain generation available in the command-line
 test_files: []
-has_rdoc: