megahal 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af7cea408577bbc60da09d9ea222afc32fb0624c
+  data.tar.gz: f27c277b75969c4a7bcd94fe6a0de4c56fa68988
+SHA512:
+  metadata.gz: f62986be611257ee349cbc4f48d4e4e170ba94c0853240f592bfdcae63601b7826ac6764391c06085730885e1c415b2040fe0b6d78e7711c1d92be29f290c491
+  data.tar.gz: c1ac5d103372d12a53c8e4d3d8173537fba9730241fc1f0b65cd8db3d99e8e04a083507c077b89e8a6a3b02017fc2c9f7f75d1f86433f0c567020d7e038808f8

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'sooth', '~> 1.0'
+gem 'highline', '~> 1.6'
+gem 'hodel_3000_compliant_logger', '~> 0.1'
+gem 'ruby-progressbar', '~> 1.7'
+gem 'rubyzip', '~> 1.1'
+gem 'cld', '~> 0.7'
+
+group :development do
+  gem 'rspec', '~> 3.1'
+  gem 'yard', '~> 0.8'
+  gem 'rdoc', '~> 4.1'
+  gem 'bundler', '~> 1.7'
+  gem 'jeweler', '~> 2.0'
+  gem 'simplecov', '~> 0.9'
+  gem 'byebug', '~> 3.5'
+end

data/Gemfile.lock

@@ -0,0 +1,100 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    cld (0.7.0)
+      ffi
+    columnize (0.9.0)
+    debugger-linecache (1.2.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.6)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    hodel_3000_compliant_logger (0.1.1)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.2.0)
+    mini_portile (0.6.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    ruby-progressbar (1.7.0)
+    rubyzip (1.1.6)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    sooth (1.0.0)
+    thread_safe (0.3.4)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  byebug (~> 3.5)
+  cld (~> 0.7)
+  highline (~> 1.6)
+  hodel_3000_compliant_logger (~> 0.1)
+  jeweler (~> 2.0)
+  rdoc (~> 4.1)
+  rspec (~> 3.1)
+  ruby-progressbar (~> 1.7)
+  rubyzip (~> 1.1)
+  simplecov (~> 0.9)
+  sooth (~> 1.0)
+  yard (~> 0.8)

data/README.md

@@ -0,0 +1,187 @@
+[![Gratipay](https://img.shields.io/gratipay/Kranzky.svg)](https://gratipay.com/Kranzky/)
+[![Gem Version](https://badge.fury.io/rb/megahal.svg)](http://badge.fury.io/rb/megahal)
+[![Dependency Status](https://gemnasium.com/jasonhutchens/megahal.png)](https://gemnasium.com/jasonhutchens/megahal)
+[![Build Status](https://semaphoreapp.com/api/v1/projects/6889bf33-e547-4200-a4fb-66b339a83d82/307128/shields_badge.svg)](https://semaphoreapp.com/jasonhutchens/megahal)
+[![Code Climate](https://codeclimate.com/github/jasonhutchens/megahal.png)](https://codeclimate.com/github/jasonhutchens/megahal)
+
+MegaHAL
+=======
+
+MegaHAL is a learning chatterbot.
+
+You can run it as a command-line application, or embed it in your own
+application and make calls to it via a simple
+[API](http://rubydoc.info/github/jasonhutchens/megahal/master/frames).
+
+It is built on top of [Sooth](https://github.com/jasonhutchens/sooth), a simple
+stochastic predictive model.
+
+This new version of MegaHAL was written in homage of the original, which I wrote
+around twenty years ago. As these things go, the Ruby version is a fraction of
+the size of the [original C version](https://github.com/pteichman/megahal/blob/master/Megahal/megahal.c).
+
+The oldest record I have of MegaHAL is a USENET post from April 30, 1995,
+which is reproduced at the bottom of this README.
+
+Getting Started
+---------------
+
+Running the command-line version of MegaHAL is simple:
+
+```
+> gem install megahal
+> megahal
++----------------------------------------------------------+
+|                                                          |
+|  #    #  ######   ####     ##    #    #    ##    #       |
+|  ##  ##  #       #    #   #  #   #    #   #  #   #       |
+|  # ## #  #####   #       #    #  ######  #    #  #       |
+|  #    #  #       #  ###  ######  #    #  ######  #       |
+|  #    #  #       #    #  #    #  #    #  #    #  #       |
+|  #    #  ######   ####   #    #  #    #  #    #  ######  |
+|                                                          |
+|    Type "/help" for options and "/quit" to terminate.    |
++----------------------------------------------------------+
+
+Greetings and salutations to thee and thine.
+>
+```
+
+If you type `/help` at the prompt, you'll be presented with a menu:
+
+```
+1. cancel
+2. reset
+3. brain
+4. train
+5. load
+6. save
+7. ignore
+8. quit
+```
+
+Make a selection by typing the number or the name of the menu item:
+
+1. `cancel`: go back without making a selection
+1. `reset`: clear MegaHAL's brain, restoring it to a blank slate
+1. `brain`: choose from a number of existing personalities (see below)
+1. `train`: give MegaHAL a plain text file to learn from
+1. `load`: load a previously saved brain from a file
+1. `save`: save the current MegaHAL brain to a file
+1. `ignore`: prevent MegaHAL from learning from user input; this is good if you want to chat without introducing changes to the brain
+1. `quit`: immediately exit MegaHAL, losing any unsaved changes
+
+If you select the `brain` menu item above, you'll be presented with a list of
+pre-existing MegaHAL brains to choose from:
+
+1. `cancel`: go back without making a selection
+2. `default`: the personality used for the 1998 Loebner competition
+3. `aliens`: Bishop from Aliens!
+4. `ferris`: Mr. Ferris Bueller himself! Bueller! Bueller!
+5. `pepys`: Samuel Pepys, taken from the @samuelpepys Twitter feed
+6. `pulp`: Marsellus Wallace from Pulp Fiction!
+7. `sherlock`: Sherlock Holmes, with quotes taken from all the books
+8. `startrek`: Data from Star Trek (thanks to mbaker)
+9. `starwars`: Threepio from the Star Wars Trilogy!
+
+Example
+-------
+
+Here is an example conversation transcript, taken directly from the `megahal.log` file (which is written each time you interact with MegaHAL):
+
+```
+(brain changed to sherlock holmes)
+MH10: On the strange coincidences, the plannings, the cross-purposes, the wonderful chains of events, working through generations, and leading to the composition of a woman.
+USER: Who are you?
+MH10: You could never guess how I employed my morning, or what I ended by doing.
+USER: Did you play a game?
+MH10: Come, Watson, come! The game is afoot.
+USER: How exciting!
+MH10: Isn't it gorgeous! What do you think of it.
+USER: I think it's great. What are we going to do?
+MH10: I think, perhaps, it is simplicity itself.
+USER: Tell me then.
+MH10: Your statement is, I want you?
+USER: Ummm... no.
+MH10: Yes, certainly.
+USER: I think you're confused.
+MH10: I think that you have been too busy to think of it.
+USER: Are you saying what I think you're saying?
+MH10: You know how to look into it.
+USER: So do you by the sound of it.
+MH10: I have been of material assistance to me for fifty minutes.
+USER: Is this non-stop double entendre?
+MH10: More than that it is a great thing for me to be able to understand that I have ever listened.
+USER: Let's go and do something. Or get a bite to eat.
+MH10: That is interesting.
+USER: Why?
+MH10: Because there are fifty who can reason analytically.
+USER: Name them.
+MH10: My name is Sherlock Holmes.
+USER: And who are the other forty-nine?
+MH10: I want to ascertain.
+USER: You mean that you don't know?
+MH10: Light a cigar and let me see if I can do what you have told me I think that both inferences are permissible.
+USER: Well, it's been interesting. I must leave.
+MH10: No crime, but a very interesting statement.
+USER: Goodbye.
+MH10: You must get home instantly and act.
+MegaHAL Stopped
+```
+
+USENET Announcement from 1995
+-----------------------------
+
+```
+Have a weird conversation with a computer
+-----------------------------------------
+
+Recently I added a feature to my home page allowing the user to "talk" to a
+computer program of mine.  The program was not written very intelligently, so
+most of the time its replies consisted of incoherent babble.
+
+Version 2 came and went, and now version 3 - MegaHAL - is ready for release.
+The new features of the program are:-
+
+* A second-order markov model is used, and it is doubly-linked.  This
+  means that the computers sentences tend to be more grammatical.
+* Punctuation is supported, which segments the sentences realistically.
+* The reply given by the computer is based upon one of the words in
+  the input string.  The word selected is one that maximises the ratio
+  (number of times since word was last used)/(number of times word has
+  appeared).
+* The computers reply is generated from this keyword, and may be up to
+  100 words long.  The reply is generated in such a way that it is
+  impossible to get stuck in infinite loops.
+* The keyword used is highlighted in the reply.
+
+Some example conversations are given below:-
+
+USER: you are crazy
+HAL:  WE *ARE* WEIRD.
+
+USER: What is the meaning of life oh wise one?
+HAL:  *LIFE* IS THE ROOM.
+
+USER: this is not getting us very far
+HAL:  YES I AM *GETTING* BORED OF GLOBAL DOMINATION.
+
+USER: I have no idea.
+HAL:  *NO* IT IS IN HEAVEN.
+USER: Is it really?
+HAL:  YES *IT* IS.
+
+USER: My name is Jason.
+HAL:  I THINK ALAN TURING WAS A GIRLIE, JUST LIKE *MY* DEAR MAMA
+
+The last response was generated from a combination of a discussion
+about Alan Turing, and Monty Python's Lumberjack Song.  Surely this
+must be a sign of intelligence ;^)
+
+Have fun!
+```
+
+Copyright
+---------
+
+Copyright (c) 2014 Jason Hutchens. See UNLICENSE for further details.

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "megahal"
+  gem.homepage = "http://github.com/jasonhutchens/megahal"
+  gem.license = "UNLICENSE"
+  gem.summary = %Q{MegaHAL is a learning chatterbot.}
+  gem.description = %Q{Have a weird conversation with a computer.}
+  gem.email = "jasonhutchens@gmail.com"
+  gem.authors = ["Jason Hutchens"]
+  gem.required_ruby_version = "~> 2.1"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/bin/megahal

@@ -0,0 +1,196 @@
+#!/usr/bin/env ruby
+
+require 'megahal'
+require 'highline/import'
+require 'hodel_3000_compliant_logger'
+require 'ruby-progressbar'
+
+say("<%= color('" + <<-EOS + "', BOLD) %>")
++----------------------------------------------------------+
+|                                                          |
+|  #    #  ######   ####     ##    #    #    ##    #       |
+|  ##  ##  #       #    #   #  #   #    #   #  #   #       |
+|  # ## #  #####   #       #    #  ######  #    #  #       |
+|  #    #  #       #  ###  ######  #    #  ######  #       |
+|  #    #  #       #    #  #    #  #    #  #    #  #       |
+|  #    #  ######   ####   #    #  #    #  #    #  ######  |
+|                                                          |
+|    Type "/help" for options and "/quit" to terminate.    |
++----------------------------------------------------------+
+EOS
+
+class MegaLog
+  def initialize
+    @logger = Hodel3000CompliantLogger.new("megahal.log")
+    @logger.info "MegaHAL Started"
+  end
+  def exit
+    @logger.info "MegaHAL Stopped"
+  end
+  def error(message)
+    @logger.error "(#{message})"
+    message = HighLine.color("(#{message})", :dark, :red)
+    say(message)
+  end
+  def status(message)
+    @logger.info "(#{message})"
+    message = HighLine.color("(#{message})", :dark, :yellow)
+    say(message)
+  end
+  def user(message)
+    @logger.info "USER: #{message}"
+  end
+  def puts(message)
+    @logger.info "MH10: #{message}"
+    message = HighLine.color(message, :bold, :green)
+    say(message)
+  end
+end
+
+log = MegaLog.new
+
+def list_menu(megahal, log)
+  choose do |menu|
+    menu.prompt = "? "
+    menu.choice(:cancel) do
+      log.status('cancelled')
+      return
+    end
+    menu.choice(:default) do
+      megahal.become(:default)
+      log.status('brain changed to the original loebner prize version')
+    end
+    menu.choice(:aliens) do
+      megahal.become(:aliens)
+      log.status('brain changed to bishop from aliens')
+    end
+    menu.choice(:ferris) do
+      megahal.become(:ferris)
+      log.status('brain changed to ferris bueller')
+    end
+    menu.choice(:pepys) do
+      megahal.become(:pepys)
+      log.status('brain changed to samuel pepys')
+    end
+    menu.choice(:pulp) do
+      megahal.become(:pulp)
+      log.status('brain changed to marsellus wallace from pulp fiction')
+    end
+    menu.choice(:sherlock) do
+      megahal.become(:sherlock)
+      log.status('brain changed to sherlock holmes')
+    end
+    menu.choice(:startrek) do
+      megahal.become(:startrek)
+      log.status('brain changed to data from star trek')
+    end
+    menu.choice(:starwars) do
+      megahal.become(:starwars)
+      log.status('brain changed to threepio from star wars')
+    end
+  end
+  log.puts(megahal.reply(nil))
+end
+
+def help_menu(megahal, log)
+  choose do |menu|
+    menu.prompt = "? "
+    menu.choice(:cancel) do
+      log.status('cancelled')
+      return
+    end
+    menu.choice(:reset) do
+      megahal.clear
+      log.status('brain cleared')
+    end
+    menu.choice(:brain) do
+      log.status('show brain menu')
+      list_menu(megahal, log)
+    end
+    menu.choice(:train) do
+      log.status('train on a text file')
+      filename = ask("Filename: ")
+      unless File.exists?(filename)
+        log.error("no such file")
+      else
+        begin
+          bar = ProgressBar.create(title: "Training", total: nil)
+          megahal.train(filename, bar)
+          bar.finish
+          log.status("training succesfull for '#{filename}'")
+          log.puts(megahal.reply(nil))
+        rescue => e
+          log.error(e.message)
+        end
+      end
+    end
+    menu.choice(:load) do
+      log.status('load a brain file')
+      filename = ask("Filename: ")
+      unless File.exists?(filename)
+        log.error("no such file")
+      else
+        begin
+          bar = ProgressBar.create(title: "Loading", total: nil)
+          megahal.load(filename, bar)
+          bar.finish
+          log.status("loading succesfull for '#{filename}'")
+          log.puts(megahal.reply(nil))
+        rescue => e
+          log.error(e.message)
+        end
+      end
+    end
+    menu.choice(:save) do
+      log.status('save a brain file')
+      filename = ask("Filename: ")
+      if File.exists?(filename)
+        log.error("file already exists")
+      else
+        begin
+          bar = ProgressBar.create(title: "Saving", total: nil)
+          megahal.save(filename, bar)
+          bar.finish
+          log.status("saving succesfull for '#{filename}'")
+        rescue => e
+          log.error(e.message)
+        end
+      end
+    end
+    if megahal.learning
+      menu.choice(:ignore) do
+        megahal.learning = false
+        log.status('stop learning from user input')
+      end
+    else
+      menu.choice(:learn) do
+        megahal.learning = true
+        log.status('start learning from user input')
+      end
+    end
+    menu.choice(:quit) do
+      log.status('exiting')
+      exit
+    end
+  end
+end
+
+megahal = MegaHAL.new
+log.puts(megahal.reply(nil))
+begin
+  loop do
+    input = ask("> ").strip
+    log.user(input)
+    if input.downcase =~ /^[\/\\#@](help|menu|info|list|h|\?)$/
+      log.status('show help menu')
+      help_menu(megahal, log)
+    elsif input.downcase =~ /^[\/\\#@](quit|exit|q|x)$/
+      log.status('exiting')
+      exit
+    else
+      log.puts(megahal.reply(input))
+    end
+  end
+ensure
+  log.exit
+end