attentive 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5d4df859acd5086ec5d8144696af41186bdc33f
+  data.tar.gz: 2d5d5fb36e14abd9c2ae64e5cc42407238f97550
+SHA512:
+  metadata.gz: f96291d7ea9b07676a59a958c6a42cc7ef5fad0e0f96a21eba177c6a7c763b052d49dd032f82431612bf89ee75dc9cfb1e068eab8ea1f797878b92d77488be4f
+  data.tar.gz: 626d7dc7de65850872234c5baa4ad921a2d661d5d50dc9e54539435dff1d1dc5b628413a86134ae2d680a1e88e794eed7bd1ea1dcb5dcafc96303819586f415b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in attentive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bob Lail
+
+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,41 @@
+# Attentive
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/attentive`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attentive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attentive
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/attentive.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/attentive.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attentive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attentive"
+  spec.version       = Attentive::VERSION
+  spec.authors       = ["Bob Lail"]
+  spec.email         = ["bob.lailfamily@gmail.com"]
+
+  spec.summary       = %q{A library for matching messages to natural-language listeners}
+  spec.homepage      = "https://github.com/houston/attentive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thread_safe"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-reporters-turn_reporter"
+  spec.add_development_dependency "shoulda-context"
+  spec.add_development_dependency "timecop"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attentive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/contractions.tsv

@@ -0,0 +1,134 @@
+# List of English Contractions
+# https://en.wikipedia.org/wiki/Wikipedia:List_of_English_contractions
+
+ain't	am not
+aren't	are not
+can't	can not
+cannot	can not
+could've	could have
+couldn't	could not
+couldn't've	could not have
+didn't	did not
+doesn't	does not
+don't	do not
+hadn't	had not
+hadn't've	had not have
+hasn't	has not
+haven't	have not
+he'd	he had	he would
+he'd've	he would have
+he'll	he will	he shall
+he's	he is	he has
+he'sn't	he is not	he has not
+how'd	how did	how would
+how'll	how will
+how's	how is	how has	how does
+I'd	I would	I had
+I'd've	I would have
+I'll	I shall	I will
+I'm	I am
+I've	I have
+I'ven't	I have not
+isn't	is not
+it'd	it would	it had
+it'd've	it would have
+it'll	it will	it shall
+it's	it is	it has
+it'sn't	it is not	it has not
+let's	let us
+ma'am	madam
+mightn't	might not
+mightn't've	might not have
+might've	might have
+mustn't	must not
+must've	must have
+needn't	need not
+not've	not have
+o'clock	of the clock
+oughtn't	ought not
+shan't	shall not
+she'd	she had	she would
+she'd've	she would have
+she'll	she shall	she will
+she's	she is	she has
+she'sn't	she is not	she has not
+should've	should have
+shouldn't	should not
+shouldn't've	should not have
+somebody'd	somebody had	somebody would
+somebody'd've	somebody would have
+somebody'dn't've	somebody would not have
+somebody'll	somebody shall	somebody will
+somebody's	somebody is	somebody has
+someone'd	someone had	someone would
+someone'd've	someone would have
+someone'll	someone shall	someone will
+someone's	someone is	someone has
+something'd	something had	something would
+something'd've	something would have
+something'll	something shall	something will
+something's	something is	something has
+that'll	that will
+that's	that is	that has
+there'd	there had	there would
+there'd've	there would have
+there're	there are
+there's	there is	there has
+they'd	they would	they had
+they'dn't	they would not
+they'dn't've	they would not have
+they'd've	they would have
+they'd'ven't	they would have not
+they'll	they shall	they will
+they'lln't've	they will not have
+they'll'ven't	they will have not
+they're	they are
+they've	they have
+they'ven't	they have not
+'tis	it is
+'twas	it was
+wasn't	was not
+we'd	we had	we would
+we'd've	we would have
+we'dn't've	we would not have
+we'll	we will
+we'lln't've	we will not have
+we're	we are
+we've	we have
+weren't	were not
+what'll	what shall	what will
+what're	what are
+what's	what is	what does	what has
+what've	what have
+when's	when is	when has
+where'd	where did
+where's	where is	where does	where has
+where've	where have
+who'd	who would	who had
+who'd've	who would have
+who'll	who shall	who will
+who're	who are
+who's	who is	who has
+who've	who have
+why'll	why will
+why're	why are
+why's	why is	why has
+won't	will not
+won't've	will not have
+would've	would have
+wouldn't	would not
+wouldn't've	would not have
+y'all	you all
+y'all'd've	you all would have
+y'all'dn't've	you all would not have
+y'all'll	you all will
+y'all'lln't	you all will not
+y'all'll've	you all will have
+y'all'll'ven't	you all will have not
+you'd	you had	you would
+you'd've	you would have
+you'll	you shall	you will
+you're	you are
+you'ren't	you are not
+you've	you have
+you'ven't	you have not

data/data/slang.tsv

@@ -0,0 +1,19 @@
+# Slang / Shorthand
+
+bye	goodbye
+gonna	going to
+hi	hello
+ol'	old
+'sup	what is up
+thanks	thank you
+wanna	want to
+mon	monday
+tue	tuesday
+tues	tuesday
+wed	wednesday
+thu	thursday
+thur	thursday
+thurs	thursday
+fri	friday
+sat	saturday
+sun	sunday

data/lib/attentive/composite_entity.rb

@@ -0,0 +1,33 @@
+require "attentive/entity"
+
+module Attentive
+  class CompositeEntity < Entity
+    attr_reader :entities
+
+    @entities = []
+    class << self
+      attr_accessor :entities
+
+      def define(entity_name, *entities)
+        entity_klass = Class.new(Attentive::CompositeEntity)
+        entity_klass.token_name = entity_name
+        entity_klass.entities = entities.map { |entity| Entity[entity] }
+        Entity.register! entity_name, entity_klass
+      end
+    end
+
+    def initialize(*args)
+      super
+      @entities = self.class.entities.map { |entity_klass| entity_klass.new(variable_name) }
+    end
+
+    def matches?(cursor)
+      entities.each do |entity|
+        match = entity.matches?(cursor.dup)
+        return match if match
+      end
+      false
+    end
+
+  end
+end

data/lib/attentive/cursor.rb

@@ -0,0 +1,28 @@
+module Attentive
+  class Cursor
+    attr_reader :tokens, :pos
+
+    def initialize(tokens, pos=0)
+      @tokens = tokens
+      @pos = pos
+    end
+
+    def peek
+      tokens[pos]
+    end
+
+    def pop
+      @pos += 1
+      tokens[pos - 1]
+    end
+
+    def to_s
+      tokens[pos..-1].join
+    end
+
+    def offset
+      peek.pos
+    end
+
+  end
+end

data/lib/attentive/entities/integer.rb

@@ -0,0 +1,5 @@
+require "attentive/entity"
+
+Attentive::Entity.define :integer, %q{(?<integer>\d+)} do |match|
+  match["integer"].to_i
+end

data/lib/attentive/entities/relative_date.rb

@@ -0,0 +1,44 @@
+require "attentive/entity"
+require "date"
+
+weekday_regexp = "(?<weekday>sunday|monday|tuesday|wednesday|thursday|friday|saturday)"
+Attentive::Entity.define :"relative-date",
+    "today",
+    "tomorrow",
+    "yesterday",
+    weekday_regexp,
+    "next #{weekday_regexp}",
+    "last #{weekday_regexp}" do |match|
+
+  today = Date.today
+
+  next_wday = lambda do |wday|
+    days_until_wday = wday - today.wday
+    days_until_wday += 7 if days_until_wday < 0
+    today + days_until_wday
+  end
+
+  if match.matched?("weekday")
+    date = case weekday = match["weekday"]
+    when /^sun/ then next_wday[0]
+    when /^mon/ then next_wday[1]
+    when /^tue/ then next_wday[2]
+    when /^wed/ then next_wday[3]
+    when /^thu/ then next_wday[4]
+    when /^fri/ then next_wday[5]
+    when /^sat/ then next_wday[6]
+    else raise NotImplementedError, "Unrecognize weekday: #{weekday.inspect}"
+    end
+
+    date += 7 if match.to_s.start_with?("next")
+    date -= 7 if match.to_s.start_with?("last")
+    date
+  else
+    case match.to_s
+    when "today" then today
+    when "tomorrow" then today + 1
+    when "yesterday" then today - 1
+    else raise NotImplementedError, "Unrecognize match: #{match.inspect}"
+    end
+  end
+end

data/lib/attentive/entity.rb

@@ -0,0 +1,65 @@
+require "attentive/tokenizer"
+require "attentive/errors"
+
+module Attentive
+  class Entity < Token
+    attr_reader :variable_name
+
+
+    @entities = {}
+    class << self
+      attr_accessor :phrases
+      attr_accessor :token_name
+
+      def [](entity_name)
+        @entities.fetch(entity_name)
+      rescue KeyError
+        raise Attentive::UndefinedEntityError.new("Undefined Entity #{entity_name.inspect}")
+      end
+
+      def define(entity_name, *phrases, &block)
+        entity_klass = Class.new(Attentive::Entity)
+        entity_klass.token_name = entity_name
+        entity_klass.phrases = phrases.map do |phrase|
+          Attentive::Tokenizer.tokenize(phrase, entities: true, regexps: true, ambiguous: false)
+        end
+        entity_klass.send :define_method, :_value_from_match, &block
+        register! entity_name, entity_klass
+      end
+
+      def register!(entity_name, entity_klass)
+        # TODO: raise already registered error
+        @entities[entity_name] = entity_klass
+      end
+    end
+
+
+
+
+    def initialize(variable_name, pos=0)
+      @variable_name = variable_name.to_sym
+      super pos
+    end
+
+    def ==(other)
+      self.class == other.class && self.variable_name == other.variable_name
+    end
+
+    def to_s
+      "{{#{variable_name}:#{self.class.token_name}}}"
+    end
+
+    def entity?
+      true
+    end
+
+    def matches?(cursor)
+      self.class.phrases.each do |phrase|
+        match = Attentive::Matcher.new(phrase, cursor.dup).match!
+        return { variable_name => _value_from_match(match) } if match
+      end
+      false
+    end
+
+  end
+end

data/lib/attentive/errors.rb

@@ -0,0 +1,7 @@
+module Attentive
+  class AmbiguousPhraseError < RuntimeError
+  end
+
+  class UndefinedEntityError < RuntimeError
+  end
+end

data/lib/attentive/listener.rb

@@ -0,0 +1,55 @@
+require "attentive/text"
+require "attentive/tokenizer"
+require "set"
+
+module Attentive
+  class Listener
+    attr_reader :phrases
+
+    def initialize(listeners, args, callback)
+      options = args.last.is_a?(::Hash) ? args.pop : {}
+
+      # Ugh!
+      context_options = options.fetch(:context, {})
+      @required_contexts = context_options.fetch(:in, %i{conversation})
+      @required_contexts = [] if @required_contexts == :any
+      @required_contexts = Set[*@required_contexts]
+      @prohibited_contexts = context_options.fetch(:not_in, %i{quotation})
+      @prohibited_contexts = Set[*@prohibited_contexts]
+
+      @listeners = listeners
+      @callback = callback
+      @phrases = tokenize_phrases!(args)
+    end
+
+    def matches_context?(message)
+      return false unless message.contexts.superset? @required_contexts
+      return false unless message.contexts.disjoint? @prohibited_contexts
+      true
+    end
+
+    def stop_listening!
+      listeners.delete self
+      self
+    end
+
+    def call(e)
+      @callback.call(e)
+    end
+
+  private
+    attr_reader :listeners
+
+    def tokenize_phrases!(phrases)
+      phrases.map do |phrase|
+        tokenize_phrase!(phrase)
+      end
+    end
+
+    def tokenize_phrase!(phrase)
+      # should this be {regexps: false}?
+      Attentive::Tokenizer.tokenize(phrase, entities: true, regexps: true, ambiguous: false)
+    end
+
+  end
+end

data/lib/attentive/listener_collection.rb

@@ -0,0 +1,45 @@
+require "thread_safe"
+require "delegate"
+require "attentive/cursor"
+require "attentive/listener"
+require "attentive/matcher"
+
+module Attentive
+  class ListenerCollection < SimpleDelegator
+
+    def initialize
+      super ThreadSafe::Array.new
+    end
+
+    def listen_for(*args, &block)
+      Listener.new(self, args, block).tap do |listener|
+        push listener
+      end
+    end
+
+    def overhear(*args, &block)
+      Listener.new(self, args, block).tap do |listener|
+        push listener
+      end
+    end
+
+
+
+    def hear(message)
+      listeners = select { |listener| listener.matches_context?(message) }
+
+      # Listen for any known phrase, starting with any token in the message.
+      matches = []
+      message.tokens.each_with_index do |token, i|
+        listeners.each do |listener|
+          listener.phrases.each do |phrase|
+            match = Attentive::Matcher.new(phrase, Cursor.new(message.tokens, i)).match!
+            matches.push match if match
+          end
+        end
+      end
+      matches
+    end
+
+  end
+end

data/lib/attentive/match.rb

@@ -0,0 +1,22 @@
+module Attentive
+  class Match
+
+    def initialize(phrase, attributes={})
+      @phrase = phrase.to_s
+      @match_data = attributes.fetch(:match_data, {})
+    end
+
+    def matched?(variable_name)
+      @match_data.key?(variable_name)
+    end
+
+    def [](variable_name)
+      @match_data.fetch(variable_name)
+    end
+
+    def to_s
+      @phrase
+    end
+
+  end
+end