natter 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e82826a5f958086cdf0af5610b338c96485193d7
-  data.tar.gz: abcc661c8395a04a9b6efe86ac34d97ecd94e476
+  metadata.gz: 5a6a81b4f77164c15d606c99eca84daf1e6480a7
+  data.tar.gz: b8ba3a671260c6d0af840b52735edf6e51baf5a2
 SHA512:
-  metadata.gz: 989c2bf070947318c652f982308b36af1c54ba65f50f0ff58a7e8949bbb7c2427bcef167e572c01188ab3937a0a6a9d961686f8a7bdd90393d70060eae4caae3
-  data.tar.gz: d3ba8862c8cc6950c41ea17bc5f3cc88febbb16eb8f03059385a79d5012ec872509d92183448a9b3f3356e7be559083d59cb6dd56226baae52f1bcddd215d624
+  metadata.gz: 4a90a933ea1cc37fdf54d55f11b5606ac3f6df89d146d9b016314b3265b953e501fcc0e9bf16dc40a8636d82c3cf11a04162afe19088cb1f61a7b834ec14d433
+  data.tar.gz: 17f4b32482cac81f39f8e5fbdb43540d91db98d58087768cd658de8d5edf9dc3ae4e69ee37a72ce4431d1111a340896254db602c7f3db5d0a066a55d8d50585f

data/lib/natter/rule.rb

@@ -4,14 +4,16 @@ module Natter
   # occurs within an utterance.
 
   class Rule
-    
+    # Identifier for rules added without an owning skill.
+    NO_SKILL = "_None"
+
     # The string name of this rule. Defferent rules can share the same name.
     attr_accessor :name
     # The regex pattern to search for within the an utterance.
     attr_accessor :pattern
     # An array of Entity objects this rule expects. May be empty.
     attr_accessor :entities
-    # The name of the skill that this rule belongs to. May be '' if global.
+    # The name of the skill that this rule belongs to.
     attr_accessor :skill 
   
     # Public: Constructor.
@@ -22,15 +24,16 @@ module Natter
     #            utterance. If this intent contains entities then the regex 
     #            must capture the entities within the utterance as named 
     #            capture groups. See examples below. Default: //
-    # skill    - The name of the skill that this rule belongs to. If none is 
-    #            specified then we'll assume it's a global rule (default: '').
+    # skill    - The name of the skill that this rule belongs to. The first
+    #            letter will be capitalised (e.g. `sonos` => `Sonos`). If none 
+    #            is passed then is set to Rule::NO_SKILL
     # entities - Optional array of Entity objects in the form:
     #            Each entity must have a correspondingly named capture group 
     #            within the regex.
-    def initialize(name, pattern = //, skill = '', *entities)
+    def initialize(name, pattern = //, skill = NO_SKILL, *entities)
       @name = name
       @pattern = pattern
-      @skill = skill
+      skill == NO_SKILL ? @skill = NO_SKILL : @skill = skill.capitalize
       @entities = entities || []
     end
 
@@ -50,16 +53,17 @@ module Natter
       return self
     end
 
-    # Public: Returns this rule's identifier. An identifier is in the format:
-    # skill.name unless skill = '' in which case we return global.name
+    # Public: Returns this rule's identifier. 
+    # An identifier is in the format `skill.name`.
     #
-    # Returns string
+    # Returns a string.
     def identifier
-      "#{@skill == '' ? 'global' : @skill}.#{@name}"
+      "#{@skill}.#{@name}"
     end
 
     # Public: A convenience method to permit prettier building of rules. 
     # Returns the Rule back to the calling method to allowing chaining.
+    # The skill name will be capitalised (e.g. `sonos` => `Sonos`).
     #
     # skill - The name of the skill that this this rule belongs to.
     #
@@ -67,7 +71,7 @@ module Natter
     #
     # def = Rule.new('play').belongs_to('sonos')
     def belongs_to(skill)
-      @skill = skill
+      @skill = skill.capitalize
       return self
     end
 

data/lib/natter/version.rb

@@ -1,3 +1,3 @@
 module Natter
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Garry Pettet