natter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13f97d6f2534d07f6f183f0bbd8a11ef49bab3a8
-  data.tar.gz: 7ff275a13e6e7aa256abb16f2a148f2c510b465a
+  metadata.gz: d23d6a31af6c237271183dfa0f5fc968e69189ff
+  data.tar.gz: 6dfcab88b1e463843c39bb65ba3c3e22d0aeaa8b
 SHA512:
-  metadata.gz: 2eb357fc794b72db7015fdf2a8411184b03480cb94370e4a43aa4688c6d4bad64a8cc2869d69c71aacc9bbb7fa083ec0f6161647dd44ca4a624436be4bb08446
-  data.tar.gz: ff00c69847b2a7c05d691840b35082fcd2e2f8abf808d6a3db71aa35b48dfa7f2841eb8165127f346c02a6cdc526f568fb365f907f584053ccfc4f874fd026d3
+  metadata.gz: 447999c1be544e5c8296568f6c291b2490b382a118bc1036f29dbde1ddc7e544e8928c89d3068c96e8583c4b99900e31611bac8ccefacaafc373107ffb96cc4e
+  data.tar.gz: d2c2db34529b8b8fabf91b1c91dfe50968f10e66ce1148d3abff0c6c98219cf32ae86fb7d28127b9061ff469024185f5cfc1d81857043d7acfd5a153857e69c1

data/lib/natter/parser.rb

@@ -1,5 +1,5 @@
 module Natter
-  # Public: The parser is the main workhorse, responsible for deriving the 
+  # Public: The parser is the main workhorse, responsible for deriving the
   # intent from an utterance.
   class Parser
     def initialize
@@ -8,6 +8,7 @@ module Natter
       @intent_cache = Hash.new # key = utterance, value = Intent
       @rules = Hash.new # key = rule regex pattern, value = Rule object
     end
+
     # Public: Adds a regex-based Rule to the parser.
     #
     # rule - The Natter::Rule to add.
@@ -20,9 +21,21 @@ module Natter
       @rules[rule.pattern] = rule
     end
 
+    # Public: Adds one or more regex-based Rules to the parser.
+    # A convenience method.
+    #
+    # rules - Either a Natter::Rule or an array of Natter::Rules.
+    def add_rules(rules)
+      if rules.kind_of?(Array)
+        rules.each { |rule| add_rule(rule) }
+      else
+        add_rule(rules)
+      end
+    end
+    
     # Public: Adds a pre-computed utterance/intent pair to the parser.
-    # Used when a specific utterance(s) match a predetermined intent. This saves 
-    # overhead as there is no regex processing required. These utterances are 
+    # Used when a specific utterance(s) match a predetermined intent. This saves
+    # overhead as there is no regex processing required. These utterances are
     # evaluated before the regex rules.
     # Multiple examples can be added at once.
     # Adding an utterance that already exists will overwrite the old one.
@@ -37,12 +50,12 @@ module Natter
     # add_utterance(['what time is it', 'what is the time'] => Intent.new('currentTime'))
     # add_utterance(
     #   'night night' => Intent.new('goodnight'),
-    #   'lock the door' => Intent.new('lock') 
+    #   'lock the door' => Intent.new('lock')
     # )
     #
     # Returns nothing.
     def add_utterance(example)
-      raise ArgumentError, "Expected {utterance => Intent} or {[utterances] => Intent}" unless example.is_a?(Hash) 
+      raise ArgumentError, "Expected {utterance => Intent} or {[utterances] => Intent}" unless example.is_a?(Hash)
       example.map do |utterance, intent|
         if utterance.kind_of?(Array)
           utterance.each { |phrase| @known_utterances[phrase] = intent }
@@ -51,7 +64,7 @@ module Natter
         end
       end
     end
-    
+
     # Public: Analyse an utterance and return any matching intents.
     #
     # utterance - The natural language string to analyse
@@ -59,17 +72,17 @@ module Natter
     #             utterance/intent pairs to return rather than re-parsing.
     #             (default: true)
     #
-    # Returns an Intent, an array of Intents or nil if the intent cannot be 
+    # Returns an Intent, an array of Intents or nil if the intent cannot be
     # determined.
     def parse(text, use_cache = true)
       raise ArgumentError, "Cannot parse thin air!" unless text.length > 0
-      
+
       # Store the original string for later
       original = text
 
       # Tidy up the string for parsing
       utterance = purify(original)
-      
+
       if @known_utterances.has_key?(utterance)
         return @known_utterances[utterance]
       end
@@ -86,7 +99,7 @@ module Natter
         else
           intent = intent_from_match(rule, m)
           if intent then intents << intent end
-        end      
+        end
       end
 
       if intents.empty? then return nil end
@@ -100,9 +113,9 @@ module Natter
       return intents
     end
 
-    # Internal: Determines the confidence of each intent in the passed array 
+    # Internal: Determines the confidence of each intent in the passed array
     # and then sorts them based on the calculated confidence values.
-    # Basically, if we have more than one intent then whichever intent has the 
+    # Basically, if we have more than one intent then whichever intent has the
     # greatest number of entities is likely to be the best match.
     #
     # intents - An array of Intent objects.
@@ -144,7 +157,7 @@ module Natter
     # rule      - The Rule definining this intent.
     # m         - The positive regex match.
     #
-    # Returns Intent. 
+    # Returns Intent.
     def intent_from_match(rule, m)
       if m.named_captures.empty?
         # No capture groups found. Double-check the rule doesn't need any entities
@@ -162,7 +175,7 @@ module Natter
             e = Entity.new(entity.name, entity.type, m.named_captures[entity.name].strip)
             intent.entities << e
           else
-            # Found a named capture group that doesn't match an entity defined 
+            # Found a named capture group that doesn't match an entity defined
             # in the rule
             return nil
           end
@@ -289,7 +302,7 @@ module Natter
     end
 
     # Expand the contractions within this string.
-    # 
+    #
     # Examples
     #
     # t = "I'm hot"
@@ -303,4 +316,4 @@ module Natter
       return result.strip
     end
   end
-end
+end

data/lib/natter/version.rb

@@ -1,3 +1,3 @@
 module Natter
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Garry Pettet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2017-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic