marky_markov 0.1.1 → 0.1.2

data/README.md

@@ -33,11 +33,20 @@ of the dictionary name.
     puts markov.generate_n_words 10
     markov.save_dictionary! # Saves the modified dictionary/creates one if it didn't exist.
 
+If you keep look at generate_n_words and wonder why you can't put a
+number in there, well, you can!
+
+    markov.generate_20_words
+
 If you want to delete a dictionary you call it upon the Dictionary class itself while
 passing in the filename/location.
 
     MarkyMarkov::Dictionary.delete_dictionary!('dictionary')
     
+OR you can pass in a MarkyMarkov::Dictionary object directly.
+
+    MarkyMarkov::Dictionary.delete_dictionary!(markov)
+
 
 # Command-Line Usage
 

data/lib/marky_markov.rb

@@ -4,8 +4,12 @@
 require_relative 'marky_markov/persistent_dictionary'
 require_relative 'marky_markov/two_word_sentence_generator'
 
+# @version = 0.1.2
+# @author Matt Furden
+# Module containing TemporaryDictionary and Dictionary for creation of
+# Markov Chain Dictionaries and generating sentences from those dictionaries.
 module MarkyMarkov
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 
   class TemporaryDictionary
     # Create a new Temporary Markov Chain Dictionary and sentence generator for use.
@@ -17,7 +21,7 @@ module MarkyMarkov
       @dictionary = TwoWordDictionary.new
       @sentence = TwoWordSentenceGenerator.new(@dictionary)
     end
-    
+
     # Parses a given file and adds the sentences it contains to the current dictionary.
     #
     # @example Open a text file and add its contents to the dictionary.
@@ -26,16 +30,16 @@ module MarkyMarkov
     def parse_file(location)
       @dictionary.parse_source(location, true)
     end
-    
+
     # Parses a given string and adds them to the current dictionary.
     #
     # @example Add a string to the dictionary.
     #   markov.parse_string "I could really go for some Chicken Makhani."
-    # @param [String] sentence the sentence you want to add to the dictionary.
+    # @param [String] string the sentence you want to add to the dictionary.
     def parse_string(string)
       @dictionary.parse_source(string, false)
     end
-    
+
     # Generates a sentence/sentences of n words using the dictionary generated via
     # parse_string or parse_file.
     #
@@ -46,7 +50,33 @@ module MarkyMarkov
     def generate_n_words(wordcount)
       @sentence.generate(wordcount)
     end
-    
+
+    # Dynamically call generate_n_words if an Int is substituted for
+    # the n in the method call.
+    #
+    # @since 0.1.2
+    # @example Generate a 40 and a 1 word long string of words.
+    #   markov.generate_40_words
+    #   markov.generate_1_word
+    # @return [String] the sentence generated by the dictionary.
+    def method_missing(method_sym, *args, &block)
+      if method_sym.to_s =~ /^generate_(\d*)_word[s]*$/
+        generate_n_words($1.to_i)
+      else
+        super
+      end
+    end
+
+    # Modify respond_to? to include generate_n_words method_missing implementation.
+    def respond_to?(method_sym, include_private = false)
+      if method_sym.to_s =~ /^generate_(\d*)_word[s]*$/
+        true
+      else
+        super
+      end
+    end
+
+
     # Clears the temporary dictionary's hash, useful for keeping
     # the same dictionary object but removing the words it has learned.
     #
@@ -63,11 +93,13 @@ module MarkyMarkov
     #
     # @example Create a new Persistent Dictionary object.
     #   markov = MarkyMarkov::Dictionary.new("#{ENV["HOME"]}/markov_dictionary")
+    attr_reader :dictionarylocation
     def initialize(location)
-      @dictionary = PersistentDictionary.new(location)
+      @dictionarylocation = "#{location}.mmd"
+      @dictionary = PersistentDictionary.new(@dictionarylocation)
       @sentence = TwoWordSentenceGenerator.new(@dictionary)
     end
-    
+
     # Save the Persistent Dictionary file into JSON format for later use.
     #
     # @example Save the dictionary to disk.
@@ -75,17 +107,22 @@ module MarkyMarkov
     def save_dictionary!
       @dictionary.save_dictionary!
     end
-    
-    # Class Method: Takes a dictionary location/name and deletes it from the file-system.
+
+    # Takes a dictionary location/name and deletes it from the file-system.
+    # Alternatively, pass in a MarkyMarkov::Dictionary object in
+    # directly and it will delete that objects dictionary from disk.
     #
-    # @note To ensure that someone doesn't pass in something that shouldn't be deleted by accident,
-    #   the filetype .mmd is added to the end of the supplied arguement, so do not include the
-    #   extension when calling the method.
+    # @note To ensure that someone doesn't pass in something that shouldn't 
+    # be deleted by accident, the filetype .mmd is added to the end of the 
+    # supplied argument, so do not include the extension when calling the method.
     #
     # @example Delete the dictionary located at '~/markov_dictionary.mmd'
     #   MarkyMarkov::Dictionary.delete_dictionary!("#{ENV["HOME"]}/markov_dictionary")
+    # @example Delete the dictionary of the object 'markov'
+    #   MarkyMarkov::Dictionary.delete_dictionary!(markov)
     # @param [String] location location/name of the dictionary file to be deleted.
     def self.delete_dictionary!(location)
+      location += ".mmd" if location.class == String
       PersistentDictionary.delete_dictionary!(location)
     end
   end

data/lib/marky_markov/one_word_dictionary.rb

@@ -18,12 +18,23 @@ class OneWordDictionary
     end
   end
 
+  # Given root word and what it is followed by, it adds them to the dictionary.
+  #
+  # @example Adding a word
+  #   add_word("Hello", "world")
   def add_word(rootword, followedby)
     @dictionary[rootword] ||= Hash.new(0)
     @dictionary[rootword][followedby] ||= 0
     @dictionary[rootword][followedby] += 1
   end
 
+  # Given a source of text, be it a text file (file=true) or a string (file=false)
+  # it will add all the words within the source to the markov dictionary.
+  #
+  # @example Add a text file
+  #   parse_source("text.txt")
+  # @example Add a string
+  #   parse_source("Hi, how are you doing?", false)
   def parse_source(source, file=true)
     # Special case for last word in source file as it has no words following it.
     contents = file ? open_source(source) : contents = source.split

data/lib/marky_markov/one_word_sentence_generator.rb

@@ -4,18 +4,25 @@ class OneWordSentenceGenerator
     @dictionary = dictionary
   end
 
+  # Returns a random word via picking a random key from the dictionary.
+  # In the case of the TwoWordDictionary, it returns two words to ensure
+  # that the sentence will have a valid two word string to pick the next
+  # word from.
+  #
+  # @return [String] a string containing a random dictionary key.
   def random_word
     keys = @dictionary.dictionary.keys
     keys[rand(keys.length)]
   end
 
+  # Returns a word based upon the likelyhood of it appearing after the supplied word.
+  # 
   def weighted_random(lastword)
     # If word has no words in its dictionary (last word in source text file)
     # have it pick a random word to display instead.
     @dictionary.dictionary.fetch(lastword, random_word)
       total = @dictionary.dictionary[lastword].values.inject(:+)
       return random_word if total.nil?
-
       random = rand(total)+1
       @dictionary.dictionary[lastword].each do |word, occurs|
         random -= occurs
@@ -25,6 +32,8 @@ class OneWordSentenceGenerator
       end
   end
 
+  # Generates a sentence of (wordcount) length using the weighted_random function.
+  #
   def generate(wordcount)
     sentence = []
     sentence << random_word

data/lib/marky_markov/persistent_dictionary.rb

@@ -3,11 +3,21 @@ require_relative 'two_word_dictionary'
 
 # @private
 class PersistentDictionary < TwoWordDictionary
+  # Creates a PersistentDictionary object using the supplied dictionary file.
+  #
+  # @note Do not include the .mmd file extension in the name of the dictionary.
+  #   It will be automatically appended.
+  # @param [File] dictionary Name of dictionary file to create/open.
+  # @return [Object] PersistentDictionary object.
+  attr_reader :dictionarylocation
   def initialize(dictionary)
-    @dictionarylocation = "#{dictionary}.mmd"
+    @dictionarylocation = dictionary
     self.open_dictionary
   end
 
+  # Opens the dictionary objects dictionary file.
+  # If the file exists it assigns the contents to a hash, 
+  # otherwise it creates an empty hash.
   def open_dictionary
     if File.exists?(@dictionarylocation)
       File.open(@dictionarylocation,'r') do |f|
@@ -18,6 +28,8 @@ class PersistentDictionary < TwoWordDictionary
     end
   end
 
+  # Saves the PersistentDictionary objects @dictionary hash 
+  # to disk in JSON format.
   def save_dictionary!
     json = Yajl::Encoder.encode(@dictionary)
     File.open(@dictionarylocation, 'w') do |f|
@@ -26,12 +38,18 @@ class PersistentDictionary < TwoWordDictionary
     true
   end
 
-  def self.delete_dictionary!(dictionary=@dictionarylocation[0...-4])
-    mmd = "#{dictionary}.mmd"
-    if File.exists?(mmd)
-      File.delete(mmd)
-      "Deleted #{mmd}"
+  # Deletes the supplied dictionary file.
+  # Can either be passed the dictionary location and name, or a
+  # PersistentDictionary object.
+  def self.delete_dictionary!(dictionary)
+    if dictionary.respond_to?(:dictionarylocation)
+      dictionary = dictionary.dictionarylocation
+    end
+    if File.exists?(dictionary)
+      File.delete(dictionary)
+      "Deleted #{dictionary}"
+    else
+      "#{dictionary} does not exist."
     end
-    false
   end
 end

data/lib/marky_markov/two_word_dictionary.rb

@@ -2,6 +2,13 @@ require_relative 'one_word_dictionary'
 
 # @private
 class TwoWordDictionary < OneWordDictionary
+  # Given a source of text, be it a text file (file=true) or a string (file=false)
+  # it will add all the words within the source to the markov dictionary.
+  #
+  # @example Add a text file
+  #   parse_source("text.txt")
+  # @example Add a string
+  #   parse_source("Hi, how are you doing?", false)
   def parse_source(source, file=true)
     contents = file ? open_source(source) : contents = source.split
     contents.each_cons(3) do |first, second, third|

data/spec/marky_markov/persistent_dictionary_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe PersistentDictionary do
   before do
-    @dict = PersistentDictionary.new("spec/textdict")
+    @dict = PersistentDictionary.new("spec/textdict.mmd")
     @dict.parse_source("spec/test.txt")
   end
 
@@ -11,12 +11,12 @@ describe PersistentDictionary do
 end
 
   it "should be able to load an existing dictionary" do
-    otherdict = PersistentDictionary.new("spec/textdictcompare")
+    otherdict = PersistentDictionary.new("spec/textdictcompare.mmd")
      @dict.dictionary.should eql(otherdict.dictionary)
   end
 
   after do
-    PersistentDictionary.delete_dictionary!("spec/textdict")
+    PersistentDictionary.delete_dictionary!("spec/textdict.mmd")
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marky_markov
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70096919809000 !ruby/object:Gem::Requirement
+  requirement: &70118059271520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70096919809000
+  version_requirements: *70118059271520
 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 stanard
+  code it can also be called on\n  from the command line and piped into like a standard
   UNIX application."
 email: mfurden@gmail.com
 executables:
@@ -38,23 +38,6 @@ extra_rdoc_files:
 files:
 - README.md
 - bin/marky_markov
-- doc/MarkyMarkov.html
-- doc/MarkyMarkov/Dictionary.html
-- doc/MarkyMarkov/TemporaryDictionary.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - lib/marky_markov.rb
 - lib/marky_markov/one_word_dictionary.rb
 - lib/marky_markov/one_word_sentence_generator.rb

data/doc/MarkyMarkov.html

@@ -1,120 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Module: MarkyMarkov
-  
-    &mdash; Documentation by YARD 0.7.5
-  
-</title>
-
-  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
-
-  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
-  relpath = '';
-  if (relpath != '') relpath += '/';
-</script>
-
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-
-
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    
-    <div id="header">
-      <div id="menu">
-  
-    <a href="_index.html">Index (M)</a> &raquo; 
-    
-    
-    <span class="title">MarkyMarkov</span>
-  
-  
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
-      <div id="search">
-  
-    <a id="class_list_link" href="#">Class List</a>
-  
-    <a id="method_list_link" href="#">Method List</a>
-  
-    <a id="file_list_link" href="#">File List</a>
-  
-</div>
-      <div class="clear"></div>
-    </div>
-    
-    <iframe id="search_frame"></iframe>
-    
-    <div id="content"><h1>Module: MarkyMarkov
-  
-  
-  
-</h1>
-
-<dl class="box">
-  
-  
-    
-  
-    
-  
-  
-  
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/marky_markov.rb</dd>
-  
-</dl>
-<div class="clear"></div>
-
-<h2>Defined Under Namespace</h2>
-<p class="children">
-   
-    
-   
-    
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="MarkyMarkov/Dictionary.html" title="MarkyMarkov::Dictionary (class)">Dictionary</a></span>, <span class='object_link'><a href="MarkyMarkov/TemporaryDictionary.html" title="MarkyMarkov::TemporaryDictionary (class)">TemporaryDictionary</a></span>
-    
-  
-</p>
-
-  <h2>Constant Summary</h2>
-  
-    <dl class="constants">
-      
-        <dt id="VERSION-constant" class="">VERSION =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>'</span></span></pre></dd>
-      
-    </dl>
-  
-
-
-
-
-
-
-
-
-
-</div>
-    
-    <div id="footer">
-  Generated on Mon Feb  6 22:18:54 2012 by 
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.5 (ruby-1.9.3).
-</div>
-
-  </body>
-</html>