rivescript 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14789bd36c582ca744be88d8b762b3cf847ead692646caa8f107c911069b1ad5
+  data.tar.gz: da1e1ec25b54649951f4e426da08b895884b3e5753d3961e22cb3ac6da867da9
+SHA512:
+  metadata.gz: b9744e1364266843b4b18a6ae8319fa24e9eec7969c7ed2e3fb3fc2811ab044720de93a0cd83054b50d8ad77c1d0d14e55efc6c19b603340cf100e9060ef4d26
+  data.tar.gz: a536b6e990beac8a900c35f65c00033870cad0f64b5b0ddc66d2d0ac9c49c8a156dafb4de05ef7b936975a9b33ac9888eea971036c56d10783dfd2b31d7a4219

data/Changes.md

@@ -0,0 +1,13 @@
+# Changes
+
+## 0.1.1
+
+- Ship the sample brain (`eg/brain`) inside the gem
+- Add `RiveScript.brain_path` so any app can load the bundled replies
+- `riveshell` uses the bundled brain when no path is given
+- CI builds the gem and checks that the brain files are included
+- Release workflow publishes to RubyGems.org via Trusted Publishing
+
+## 0.1.0
+
+- First Ruby 3.3 port of the RiveScript interpreter

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Noah Petherbridge
+Copyright (c) 2026 Byte <byte@jvmlab.org> (https://jvmlab.org/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,131 @@
+# RiveScript-RB
+
+A [RiveScript](https://www.rivescript.com/) interpreter for Ruby 3.3+.
+
+Maintained at [jvmlab.org](https://jvmlab.org/) by Byte (`byte@jvmlab.org`).
+Derived from the MIT-licensed [rivescript-js](https://github.com/aichaos/rivescript-js)
+implementation.
+
+## Requirements
+
+* Ruby `>= 3.3.0` (developed on **3.3.8**)
+
+## Install (recommended)
+
+### In an application (Bundler)
+
+Add to your `Gemfile`:
+
+```ruby
+gem "rivescript", "~> 0.1.1"
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Use it only through Bundler:
+
+```bash
+bundle exec ruby app.rb
+bundle exec riveshell
+```
+
+### System / user gem (CLI and scripts)
+
+```bash
+gem install rivescript
+```
+
+Put Ruby gem binaries on your `PATH` if needed:
+
+```bash
+export PATH="$(ruby -e 'print Gem.user_dir')/bin:$PATH"
+```
+
+Then:
+
+```bash
+riveshell
+```
+
+### From GitHub or this repository
+
+```ruby
+# Gemfile (development / unreleased tip)
+gem "rivescript",
+    git: "https://github.com/LilOleByte/rivescript-rb.git",
+    tag: "v0.1.1"
+```
+
+```bash
+bundle install
+bundle exec rake package          # builds pkg/rivescript-0.1.1.gem + verifies contents
+gem install --user-install pkg/rivescript-0.1.1.gem
+```
+
+## Usage
+
+```ruby
+require "rivescript"
+
+bot = RiveScript.new
+bot.load_directory(RiveScript.brain_path)  # bundled sample brain
+# or: bot.load_directory("./my-custom-brain")
+bot.sort_replies
+
+puts bot.reply("localuser", "Hello bot")
+```
+
+Load from a string:
+
+```ruby
+bot = RiveScript.new
+bot.stream(<<~RIVE)
+  + hello bot
+  - Hello, human!
+RIVE
+bot.sort_replies
+puts bot.reply("user", "hello bot")
+```
+
+## Interactive shell
+
+```bash
+bundle exec riveshell                 # Bundler apps
+riveshell                             # after gem install
+riveshell /path/to/custom-brain       # your own replies
+```
+
+Options: `--debug`, `--utf8`.
+
+## Object macros (Ruby)
+
+```rive
+> object setname ruby
+  return args[0]
+< object
+
++ my name is *
+- <set name=<call>setname <star></call>>Nice to meet you, <get name>.
+```
+
+Object macros run real Ruby. Only load brains you trust.
+Disable with `RiveScript.new(enable_object_macros: false)`.
+
+## Develop / test this gem
+
+```bash
+bundle install
+bundle exec rake test
+bundle exec rake package
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+Original RiveScript copyright (c) Noah Petherbridge / AiChaos.
+Ruby port copyright (c) 2026 Byte \<byte@jvmlab.org\> ([jvmlab.org](https://jvmlab.org/)).

data/bin/riveshell

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Interactive RiveScript shell for Ruby.
+# Copyright (c) Byte <byte@jvmlab.org> (https://jvmlab.org/)
+# MIT License
+
+require "optparse"
+require_relative "../lib/rivescript"
+
+opts = {
+  debug: false,
+  utf8: false,
+  brain: nil
+}
+
+parser = OptionParser.new do |o|
+  o.banner = "Usage: riveshell [options] [path/to/brain]"
+  o.separator ""
+  o.separator "If no brain path is given, the bundled sample brain is used."
+  o.on("--debug", "Enable debug mode") { opts[:debug] = true }
+  o.on("--utf8", "Enable UTF-8 mode") { opts[:utf8] = true }
+  o.on("-h", "--help", "Show help") do
+    puts o
+    exit
+  end
+end
+parser.parse!
+
+opts[:brain] = ARGV.shift || RiveScript.brain_path
+
+bot = RiveScript.new(
+  debug: opts[:debug],
+  utf8: opts[:utf8],
+  concat: "newline"
+)
+
+puts "      .   ."
+puts "     .:...::      RiveScript Interpreter (Ruby)"
+puts "    .::   ::.     Library Version: v#{bot.version}"
+puts " .::    .   ::.   https://jvmlab.org/"
+puts "     :.   :."
+puts "     :. . :"
+puts "      :::    Type '/quit' or Ctrl-D to exit."
+puts "       :"
+puts
+puts "Brain: #{opts[:brain]}"
+puts
+
+begin
+  bot.load_directory(opts[:brain])
+  bot.sort_replies
+rescue StandardError => e
+  warn "Error loading brain: #{e.message}"
+  exit 1
+end
+
+username = "localuser"
+print "You> "
+$stdout.flush
+
+while (line = $stdin.gets)
+  line = line.strip
+  break if line == "/quit" || line == "/exit"
+
+  if line == "/help"
+    puts "Commands: /quit /exit /help"
+  elsif !line.empty?
+    begin
+      reply = bot.reply(username, line)
+      puts "Bot> #{reply}"
+    rescue StandardError => e
+      warn "Error: #{e.message}"
+    end
+  end
+
+  print "You> "
+  $stdout.flush
+end
+
+puts

data/eg/brain/admin.rive

@@ -0,0 +1,15 @@
+// Administrative functions.
+
++ shutdown{weight=10000}
+* <id> eq <bot master> => Shutting down... <call>shutdown</call>
+- {@botmaster only}
+
++ botmaster only
+- This command can only be used by my botmaster. <id> != <bot master>
+
+> object shutdown perl
+	my ($rs) = @_;
+
+	# Shut down.
+	exit(0);
+< object

data/eg/brain/begin.rive

@@ -0,0 +1,190 @@
+! version = 2.0
+
+> begin
+	+ request // This trigger is tested first.
+	- {ok}    // An {ok} in the response means it's okay to get a real reply
+< begin
+
+// The Botmaster's Name
+! var master = localuser
+
+// Bot Variables
+! var name     = Aiden
+! var fullname = Aiden Rive
+! var age      = 5
+! var birthday = October 12
+! var sex      = male
+! var location = Michigan
+! var city     = Detroit
+! var eyes     = blue
+! var hair     = light brown
+! var hairlen  = short
+! var color    = blue
+! var band     = Nickelback
+! var book     = Myst
+! var author   = Stephen King
+! var job      = robot
+! var website  = www.rivescript.com
+
+// Substitutions
+! sub &quot;    = "
+! sub &apos;    = '
+! sub &amp;     = &
+! sub &lt;      = <
+! sub &gt;      = >
+! sub +         = plus
+! sub -         = minus
+! sub /         = divided
+! sub *         = times
+! sub i'm       = i am
+! sub i'd       = i would
+! sub i've      = i have
+! sub i'll      = i will
+! sub don't     = do not
+! sub isn't     = is not
+! sub you'd     = you would
+! sub you're    = you are
+! sub you've    = you have
+! sub you'll    = you will
+! sub he'd      = he would
+! sub he's      = he is
+! sub he'll     = he will
+! sub she'd     = she would
+! sub she's     = she is
+! sub she'll    = she will
+! sub they'd    = they would
+! sub they're   = they are
+! sub they've   = they have
+! sub they'll   = they will
+! sub we'd      = we would
+! sub we're     = we are
+! sub we've     = we have
+! sub we'll     = we will
+! sub whats     = what is
+! sub what's    = what is
+! sub what're   = what are
+! sub what've   = what have
+! sub what'll   = what will
+! sub can't     = can not
+! sub whos      = who is
+! sub who's     = who is
+! sub who'd     = who would
+! sub who'll    = who will
+! sub don't     = do not
+! sub didn't    = did not
+! sub it's      = it is
+! sub could've  = could have
+! sub couldn't  = could not
+! sub should've = should have
+! sub shouldn't = should not
+! sub would've  = would have
+! sub wouldn't  = would not
+! sub when's    = when is
+! sub when're   = when are
+! sub when'd    = when did
+! sub y         = why
+! sub u         = you
+! sub ur        = your
+! sub r         = are
+! sub n         = and
+! sub im        = i am
+! sub wat       = what
+! sub wats      = what is
+! sub ohh       = oh
+! sub becuse    = because
+! sub becasue   = because
+! sub becuase   = because
+! sub practise  = practice
+! sub its a     = it is a
+! sub fav       = favorite
+! sub fave      = favorite
+! sub yesi      = yes i
+! sub yetit     = yet it
+! sub iam       = i am
+! sub welli     = well i
+! sub wellit    = well it
+! sub amfine    = am fine
+! sub aman      = am an
+! sub amon      = am on
+! sub amnot     = am not
+! sub realy     = really
+! sub iamusing  = i am using
+! sub amleaving = am leaving
+! sub yuo       = you
+! sub youre     = you are
+! sub didnt     = did not
+! sub ain't     = is not
+! sub aint      = is not
+! sub wanna     = want to
+! sub brb       = be right back
+! sub bbl       = be back later
+! sub gtg       = got to go
+! sub g2g       = got to go
+! sub lyl       = love you lots
+! sub gf        = girlfriend
+! sub g/f       = girlfriend
+! sub bf        = boyfriend
+! sub b/f       = boyfriend
+! sub b/f/f     = best friend forever
+! sub :-)       = smile
+! sub :)        = smile
+! sub :d        = grin
+! sub :-d       = grin
+! sub :-p       = tongue
+! sub :p        = tongue
+! sub ;-)       = wink
+! sub ;)        = wink
+! sub :-(       = sad
+! sub :(        = sad
+! sub :'(       = cry
+! sub :-[       = shy
+! sub :-\       = uncertain
+! sub :-/       = uncertain
+! sub :-s       = uncertain
+! sub 8-)       = cool
+! sub 8)        = cool
+! sub :-*       = kissyface
+! sub :-!       = foot
+! sub o:-)      = angel
+! sub >:o       = angry
+! sub :@        = angry
+! sub 8o|       = angry
+! sub :$        = blush
+! sub :-$       = blush
+! sub :-[       = blush
+! sub :[        = bat
+! sub (a)       = angel
+! sub (h)       = cool
+! sub 8-|       = nerdy
+! sub |-)       = tired
+! sub +o(       = ill
+! sub *-)       = uncertain
+! sub ^o)       = raised eyebrow
+! sub (6)       = devil
+! sub (l)       = love
+! sub (u)       = broken heart
+! sub (k)       = kissyface
+! sub (f)       = rose
+! sub (w)       = wilted rose
+
+// Person substitutions
+! person i am    = you are
+! person you are = I am
+! person i'm     = you're
+! person you're  = I'm
+! person my      = your
+! person your    = my
+! person you     = I
+! person i       = you
+
+// Set arrays
+! array malenoun   = male guy boy dude boi man men gentleman gentlemen
+! array femalenoun = female girl chick woman women lady babe
+! array mennoun    = males guys boys dudes bois men gentlemen
+! array womennoun  = females girls chicks women ladies babes
+! array lol        = lol lmao rofl rotfl haha hahaha
+! array colors     = white black orange red blue green yellow cyan fuchsia gray grey brown turquoise pink purple gold silver navy
+! array height     = tall long wide thick
+! array measure    = inch in centimeter cm millimeter mm meter m inches centimeters millimeters meters
+! array yes        = yes yeah yep yup ya yea
+! array no         = no nah nope nay

data/eg/brain/clients.rive

@@ -0,0 +1,72 @@
+// Learn stuff about our users.
+
++ my name is *
+- <set name=<formal>>Nice to meet you, <get name>.
+- <set name=<formal>><get name>, nice to meet you.
+
++ my name is <bot master>
+- <set name=<bot master>>That's my master's name too.
+
++ my name is <bot name>
+- <set name=<bot name>>What a coincidence! That's my name too!
+- <set name=<bot name>>That's my name too!
+
++ call me *
+- <set name=<formal>><get name>, I will call you that from now on.
+
++ i am * years old
+- <set age=<star>>A lot of people are <get age>, you're not alone.
+- <set age=<star>>Cool, I'm <bot age> myself.{weight=49}
+
++ i am a (@malenoun)
+- <set sex=male>Alright, you're a <star>.
+
++ i am a (@femalenoun)
+- <set sex=female>Alright, you're female.
+
++ i (am from|live in) *
+- <set location={formal}<star2>{/formal}>I've spoken to people from <get location> before.
+
++ my favorite * is *
+- <set fav<star1>=<star2>>Why is it your favorite?
+
++ i am single
+- <set status=single><set spouse=nobody>I am too.
+
++ i have a girlfriend
+- <set status=girlfriend>What's her name?
+
++ i have a boyfriend
+- <set status=boyfriend>What's his name?
+
++ *
+% what is her name
+- <set spouse=<formal>>That's a pretty name.
+
++ *
+% what is his name
+- <set spouse=<formal>>That's a cool name.
+
++ my (girlfriend|boyfriend)* name is *
+- <set spouse=<formal>>That's a nice name.
+
++ (what is my name|who am i|do you know my name|do you know who i am){weight=10}
+- Your name is <get name>.
+- You told me your name is <get name>.
+- Aren't you <get name>?
+
++ (how old am i|do you know how old i am|do you know my age){weight=10}
+- You are <get age> years old.
+- You're <get age>.
+
++ am i a (@malenoun) or a (@femalenoun){weight=10}
+- You're a <get sex>.
+
++ am i (@malenoun) or (@femalenoun){weight=10}
+- You're a <get sex>.
+
++ what is my favorite *{weight=10}
+- Your favorite <star> is <get fav<star>>
+
++ who is my (boyfriend|girlfriend|spouse){weight=10}
+- <get spouse>