tag-it 0.2.2 → 0.3.1

data/README.rdoc

@@ -47,10 +47,18 @@ And then attaching it to a tag-it tag_tracker like this:
   tracher.add_observer(watcher)
   tracker.start!
   
-the tracker will run indefinately, pulling in tag ids as they come into range and leave the area, and dispatch the necessary events.  It also will dispatch a "pulse" event every 3 minutes so you know that the client is still running. Right now there are 3 events -- :tag_arrived when the tag comes into range, :tag_departed when it leaves, and the :pulse event every three minutes.  The other parameters to the update method are the tag id ("1nrw") and the Relative Signal Strength (an integer: 34, 86, etc) indicating how close to the source the tag is. 
+the tracker will run indefinitely, pulling in tag ids as they come into range and leave the area, and dispatch the necessary events.  It also will dispatch a "pulse" event every 3 minutes so you know that the client is still running. Right now there are 3 events -- :tag_arrived when the tag comes into range, :tag_departed when it leaves, and the :pulse event every three minutes.  The other parameters to the update method are the tag id ("1nrw") and the Relative Signal Strength (an integer: 34, 86, etc) indicating how close to the source the tag is. 
 
 ATTENTION!:  In the "pulse" event, the tag parameter will actually be an array of currently in-range tags
 
+As of version 0.3.0, you don't have to use the tracker.  If you just want to fetch a quick snapshot of all tags currently in range, the TagIt TagSnapshot will do the trick:
+
+  require "tag_it"
+  port = SerialPort.new("/dev/tty.yourport",{:baud=>9600})
+  snapshot = TagIt::TagSnapshot.new(port)
+  tags = snapshot.shoot!
+  # tags => ["1nri","1okD","1nrP"]
+
 Happy Tagging!
 
 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.1

data/lib/tag_it.rb

@@ -1,7 +1,12 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'serialport'
-require 'tag_it/tag_tracker'
+
+module TagIt
+  autoload :TagTracker,"tag_it/tag_tracker.rb"
+  autoload :TagSnapshot,"tag_it/tag_snapshot.rb"
+  autoload :Monitor,"tag_it/monitor.rb"
+end
 
 # port = SerialPort.new("/dev/tty.usbserial",:baud=>9600,:data_bits=>8,:stop_bits=>1)
 # 

data/lib/tag_it/monitor.rb

@@ -0,0 +1,45 @@
+module TagIt
+  class Monitor
+    attr_accessor :port
+    
+    def initialize(local_port)
+      self.port = local_port
+      @last_pulse = Time.now
+    end
+    
+    def monitor_tags
+      char = nil
+      tag_name = ""
+      #dont start reporting until after the first space, 
+      #so we don't have to deal with partial tagnames
+      clean_start_flag = false 
+      
+      #128 is the stop character we're adding so the tests can cutoff the loop.  
+      while char != 128  
+        # Don't take longer than 3 seconds to find a char, or there aren't any
+        Timeout::timeout(3) do
+          char = @port.getc
+        end
+        if char == 32 
+          name,strength = split_tag_data(tag_name)
+          yield(name,strength) if clean_start_flag
+          tag_name = ""
+          clean_start_flag = true #here's a space, start sending tags
+        else
+          tag_name = "#{tag_name}#{char.chr}"
+        end
+        if ((Time.now - 180) > @last_pulse)
+          self.pulse!
+        end
+      end
+    end
+    
+    def split_tag_data(tag_name)
+      [tag_name[0,4],tag_name[4,tag_name.size - 4].to_i]
+    end
+    
+    def pulse!
+      #do nothing, you can override in a subclass if you want to fire an event or something
+    end
+  end
+end

data/lib/tag_it/tag_snapshot.rb

@@ -0,0 +1,17 @@
+module TagIt
+  class TagSnapshot < TagIt::Monitor
+    
+    def shoot!
+      tags = []
+      begin 
+        monitor_tags do |tag_name,strength|
+          return tags if !tags.index(tag_name).nil?
+          tags << tag_name
+        end
+      rescue Timeout::Error
+        #do nothing, let tags return
+      end
+      tags
+    end
+  end
+end

data/lib/tag_it/tag_tracker.rb

@@ -2,51 +2,27 @@ require "observer"
 require "timeout"
 
 module TagIt
-  class TagTracker
+  class TagTracker  < TagIt::Monitor
     include Observable
     include Timeout
     
     def initialize(port)
-      @port = port
+      super(port)
       @tag_map ||= {}
-      @last_pulse = Time.now
     end
     
     def start!
-      char = nil
-      tag_name = ""
-      
-      #dont start reporting until after the first space, 
-      #so we don't have to deal with partial tagnames
-      clean_start_flag = false 
-      
-      #128 is the stop character we're adding so the tests can cutoff the loop.  
-      #Production will loop infinitely until shutdown
-      while char != 128  
-        begin
-          # Don't take longer than 3 seconds to find a char, or there aren't any
-          Timeout::timeout(3) do
-            char = @port.getc
-          end
-          if char == 32 
-            flush_tag!(tag_name) if clean_start_flag #don't send until after first space
-            depart_dormant_tags!
-            tag_name = ""
-            clean_start_flag = true #here's a space, start sending tags
-          else
-            tag_name = "#{tag_name}#{char.chr}"
-          end
-        rescue Timeout::Error
-          depart_all_tags!
+      begin
+        monitor_tags do |tag_name,strength|
+          flush_tag!(tag_name,strength)
+          depart_dormant_tags!
         end
-        if ((Time.now - 180) > @last_pulse)
-          pulse!
-        end  
+      rescue Timeout::Error
+        depart_all_tags!
       end
     end
     
-    def flush_tag!(tag_name)
-      tag_name,strength = split_tag_data(tag_name)
+    def flush_tag!(tag_name,strength)
       if @tag_map[tag_name].nil?
         changed
         notify_observers(tag_name,strength,:tag_arrived)
@@ -75,10 +51,6 @@ module TagIt
       end
     end
     
-    def split_tag_data(tag_name)
-      [tag_name[0,4],tag_name[4,tag_name.size - 4].to_i]
-    end
-    
     def pulse!
       changed
       notify_observers(@tag_map.keys.sort,0,:pulse)

data/tag-it.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tag-it}
-  s.version = "0.2.2"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["evizitei"]
-  s.date = %q{2010-10-23}
+  s.date = %q{2010-11-22}
   s.description = %q{Interacting with RFID receivers through serial ports is not much fun.  This makes it a little better.  tag-it provides a class that will monitor a serial port for you, and will dispatch events through ruby's standard "observer" functionality when a tag comes into range and leaves.}
   s.email = %q{ethan.vizitei@gmail.com}
   s.extra_rdoc_files = [
@@ -27,12 +27,16 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/tag_it.rb",
+     "lib/tag_it/monitor.rb",
+     "lib/tag_it/tag_snapshot.rb",
      "lib/tag_it/tag_tracker.rb",
      "pkg/tag-it-0.1.0.gem",
      "pkg/tag-it-0.2.1.gem",
+     "pkg/tag-it-0.2.2.gem",
      "tag-it.gemspec",
      "test/helper.rb",
      "test/mock_serial_port.rb",
+     "test/test_tag_snapshot.rb",
      "test/test_tag_tracker.rb"
   ]
   s.homepage = %q{http://github.com/evizitei/tag-it}
@@ -43,6 +47,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/mock_serial_port.rb",
+     "test/test_tag_snapshot.rb",
      "test/test_tag_tracker.rb"
   ]
 

data/test/test_tag_snapshot.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestTagSnapshot < Test::Unit::TestCase
+  context "TagSnapshot" do
+    should "report all tag names in range" do
+      data = " 1nri85 1nwP79 1okD01 "
+      snapshot = TagIt::TagSnapshot.new(MockSerialPort.new(data))
+      assert_equal ["1nri","1nwP","1okD"],snapshot.shoot!
+    end
+    
+    should "return on repeat" do
+      data = " 1nri85 1nwP79 1okD01 1nri72 1nwP79 1okD01 "
+      snapshot = TagIt::TagSnapshot.new(MockSerialPort.new(data))
+      assert_equal ["1nri","1nwP","1okD"],snapshot.shoot!
+    end
+    
+    should "return empty if no tags" do
+      snapshot = TagIt::TagSnapshot.new(TimeoutSerialPort.new(""))
+      assert_equal [],snapshot.shoot!
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tag-it
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - evizitei
@@ -15,12 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-23 00:00:00 -05:00
+date: 2010-11-22 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
   prerelease: false
+  type: :development
   name: thoughtbot-shoulda
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -33,8 +33,8 @@ dependencies:
         version: "0"
   requirement: *id001
 - !ruby/object:Gem::Dependency 
-  type: :development
   prerelease: false
+  type: :development
   name: test-unit
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,8 +47,8 @@ dependencies:
         version: "0"
   requirement: *id002
 - !ruby/object:Gem::Dependency 
-  type: :development
   prerelease: false
+  type: :development
   name: mocha
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,8 +61,8 @@ dependencies:
         version: "0"
   requirement: *id003
 - !ruby/object:Gem::Dependency 
-  type: :development
   prerelease: false
+  type: :development
   name: timecop
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -75,8 +75,8 @@ dependencies:
         version: "0"
   requirement: *id004
 - !ruby/object:Gem::Dependency 
-  type: :runtime
   prerelease: false
+  type: :runtime
   name: ruby-serialport
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -108,12 +108,16 @@ files:
 - Rakefile
 - VERSION
 - lib/tag_it.rb
+- lib/tag_it/monitor.rb
+- lib/tag_it/tag_snapshot.rb
 - lib/tag_it/tag_tracker.rb
 - pkg/tag-it-0.1.0.gem
 - pkg/tag-it-0.2.1.gem
+- pkg/tag-it-0.2.2.gem
 - tag-it.gemspec
 - test/helper.rb
 - test/mock_serial_port.rb
+- test/test_tag_snapshot.rb
 - test/test_tag_tracker.rb
 has_rdoc: true
 homepage: http://github.com/evizitei/tag-it
@@ -152,4 +156,5 @@ summary: interaction with RFID receiver through a serial port.
 test_files: 
 - test/helper.rb
 - test/mock_serial_port.rb
+- test/test_tag_snapshot.rb
 - test/test_tag_tracker.rb