lego-nxt 0.2.0

data/lib/nxt/patches/module.rb

@@ -0,0 +1,22 @@
+class Module
+  # Creates an invariant accessor that allows getting and setting from the same
+  # endpoint. It will operate in getter mode if you don't pass any arguments
+  # when calling it, otherwise it will work in setter mode. Useful when needing
+  # to chain methods (you can't chain standard attr_writer methods because
+  # of the `= something` part).
+  def attr_combined_accessor(sym, default = nil)
+    define_method(sym) do |*args|
+      if args.empty?
+        instance_var = :"@#{sym}"
+        if (value = self.instance_variable_get(instance_var))
+          value
+        else
+          self.instance_variable_set(instance_var, default)
+          default
+        end
+      else
+        send(:"#{sym}=", *args)
+      end
+    end
+  end
+end

data/lib/nxt/patches/string.rb

@@ -0,0 +1,29 @@
+class String
+  # Convert the given string to a hexadecimal representation of the same data.
+  # This method is non-destructive, it will return a new copy of the string
+  # convered to hex.
+  def to_hex_str
+    str = ''
+    self.each_byte {|b| str << '0x%02x ' % b}
+    str
+  end
+
+  #
+  def from_hex_str_two
+    data = self.split(' ')
+    str = ''
+    data.each {|h| eval "str += '%c' % #{h}"}
+    str
+  end
+
+  def from_hex_str
+    data = self.split(' ')
+    str = ''
+
+    data.each do |h|
+      str += '%c' % h
+    end
+
+    str
+  end
+end

data/lib/nxt/utils/accessors.rb

@@ -0,0 +1,20 @@
+module NXT
+  module Utils
+    module Accessors
+      def attr_setter(name, options)
+        define_method("#{name}=") do |value|
+          if options.include?(:is)
+            raise TypeError.new('Expected value to be a number') unless duration.is_a?(options[:is])
+          end
+
+          if options.include?(:is_key_in) && !options[:is_key_in].include?(value)
+            raise TypeError.new("Expected value to be one of: :#{options[:is_key_in].keys.join(', :')}")
+          end
+
+          instance_variable_set("@#{name}", value)
+          self
+        end
+      end
+    end
+  end
+end

data/spec/matchers.rb

@@ -0,0 +1,7 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_constant do |expected|
+  match do |actual|
+    actual.class.constants.include?(expected)
+  end
+end

data/spec/nxt/interfaces/serial_port_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe NXT::Interface::SerialPort do
+  before do
+    @device = '/dev/zero'
+    @bad_device = 'hello world'
+  end
+
+  subject do
+    NXT::Interface::SerialPort.new(@device)
+  end
+
+  describe 'constants' do
+    it 'should have a BAUD_RATE constant' do
+      should have_constant(:BAUD_RATE)
+      should have_constant(:DATA_BITS)
+      should have_constant(:STOP_BITS)
+      should have_constant(:PARITY)
+      should have_constant(:READ_TIMEOUT)
+    end
+  end
+
+  describe 'accessors' do
+    it 'should have read/write accessor for @dev' do
+      should respond_to(:dev)
+      should respond_to(:dev=)
+    end
+  end
+
+  describe '#initialize' do
+    it 'should set the device to the incomming argument' do
+      subject.dev.should equal(@device)
+    end
+
+    it 'should raise an exception when trying to connect to invalid dev files' do
+      expect do
+        serial_port = subject.class.new(@bad_device)
+      end.to raise_exception(InvalidDeviceError)
+    end
+  end
+
+  describe '#connect' do
+    it 'should raise an exception when the SerialPort connection failed' do
+      expect do
+        subject.connect
+      end.to raise_exception(SerialPortConnectionError, 'The #{@device} device is not a valid SerialPort')
+    end
+
+    it 'should raise an exception when the SerialPort connection is nil' do
+      ::SerialPort.should_receive(:new).and_return(nil)
+      expect do
+        subject.connect
+      end.to raise_exception(SerialPortConnectionError, "Could not establish a SerialPort connection to #{@device}")
+    end
+
+    it 'should set the flow control and read timeout when the connection is established' do
+      serial_port_stub = stub()
+      serial_port_stub.should_receive(:flow_control=).with(::SerialPort::HARD).once
+      serial_port_stub.should_receive(:read_timeout=).with(subject.class::READ_TIMEOUT).once
+      ::SerialPort.should_receive(:new).and_return(serial_port_stub)
+
+      subject.connect
+    end
+  end
+
+  describe '#send' do
+
+  end
+
+  describe '#receive' do
+
+  end
+end

data/spec/nxt/nxt_brick_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper'
+
+describe NXTBrick do
+  before do
+    @interface = stub(
+      is_a?: true
+    )
+  end
+
+  subject do
+    NXTBrick.new(@interface)
+  end
+
+  describe 'accessors' do
+    it 'should have read/write accessors for @interface' do
+      should respond_to(:interface)
+      should respond_to(:interface=)
+    end
+
+    it 'should have read/write accessors for @options' do
+      should respond_to(:options)
+      should respond_to(:options=)
+    end
+
+    it 'should have a read accessor for @a' do
+      should respond_to(:a)
+      should_not respond_to(:a=)
+    end
+
+    it 'should have a read accessor for @b' do
+      should respond_to(:b)
+      should_not respond_to(:b=)
+    end
+
+    it 'should have a read accessor for @c' do
+      should respond_to(:c)
+      should_not respond_to(:c=)
+    end
+
+    it 'should have a read accessor for @one' do
+      should respond_to(:one)
+      should_not respond_to(:one=)
+    end
+
+    it 'should have a read accessor for @two' do
+      should respond_to(:two)
+      should_not respond_to(:two=)
+    end
+
+    it 'should have a read accessor for @three' do
+      should respond_to(:three)
+      should_not respond_to(:three=)
+    end
+
+    it 'should have a read accessor for @four' do
+      should respond_to(:four)
+      should_not respond_to(:four=)
+    end
+
+    it 'should have a read accessor for @port_identifiers' do
+      should respond_to(:port_identifiers)
+      should_not respond_to(:port_identifiers=)
+    end
+  end
+
+  describe '#initialize' do
+    it 'should raise an exception if an invalid type of interface is given' do
+      interface_stub = stub()
+      interface_stub.should_receive(:is_a?).with(NXT::Interface::Base).once.and_return(false)
+      expect do
+        NXTBrick.new(interface_stub)
+      end.to raise_exception(InvalidInterfaceError)
+    end
+
+    it 'should set the interface to the incomming argument' do
+      subject.interface.should equal(@interface)
+    end
+
+    it 'should set the options to the incomming argument' do
+      options_stub = stub()
+      nxt = NXTBrick.new(@interface, options_stub)
+      nxt.options.should equal(options_stub)
+    end
+
+    it 'should call yield if given a block, passing self' do
+      block_called = false
+
+      NXTBrick.new(@interface) do |nxt|
+        block_called = true
+        nxt.should be_an_instance_of(NXTBrick)
+      end
+
+      block_called.should be_true
+    end
+  end
+
+  describe '#add' do
+    it 'should raise an exception if an invalid type of port is given' do
+      expect do
+        subject.add('not a symbol', :symbol, Class)
+      end.to raise_exception(TypeError, 'Expected port to be a Symbol')
+    end
+
+    it 'should raise an exception if an invalid type of identifier is given' do
+      expect do
+        subject.add(:symbol, 'not a symbol', Class)
+      end.to raise_exception(TypeError, 'Expected identifier to be a Symbol')
+    end
+
+    it 'should raise an exception if an invalid type of klass is given' do
+      expect do
+        subject.add(:symbol, :symbol, 'not a class')
+      end.to raise_exception(TypeError, 'Expected klass to be a Class')
+    end
+
+    it 'should raise an exception if an invalid port number or letter is given' do
+      expect do
+        subject.add(:invalid_port, :symbol, Class)
+      end.to raise_exception(TypeError, 'Expected port to be one of: :a, :b, :c, :one, :two, :three, :four')
+    end
+
+    it 'should create a new instance of the passed klass and store it in the attribute for the given port' do
+      port = :a
+      class_stub = Class.new
+      class_return_stub = stub()
+
+      class_stub.should_receive(:new) do
+        class_return_stub
+      end.with(port).once()
+
+      subject.add(port, :hello, class_stub)
+
+      subject.send(port).should equal(class_return_stub)
+    end
+
+    it 'should raise an exception if the port given is already set' do
+      port = :a
+
+      class_stub = Class.new
+      class_stub.stub(:new)
+      subject.stub(:hello)
+      subject.instance_variable_set(:"@#{port}", 'some value already there')
+
+      expect do
+        subject.add(port, :hello, class_stub)
+      end.to raise_error(PortTakenError, "Port #{port} is already set, call remove first")
+    end
+
+    it 'should raise an exception if trying to use an identifier that is the name of a defined methodz' do
+      port = :a
+      identifier = :hello
+
+      class_stub = Class.new
+      class_stub.stub(:new)
+      subject.stub(identifier)
+
+      expect do
+        subject.add(port, :hello, class_stub)
+      end.to raise_error(InvalidIdentifierError, "Cannot use identifier #{identifier}, a method on NXTBrick is already using it.")
+    end
+
+    it 'should set up the port identifiers correctly' do
+      port = :a
+      identifier = :hello_world
+      class_stub = Class.new
+      class_stub.stub(:new)
+
+      subject.add(port, identifier, class_stub)
+
+      subject.port_identifiers[identifier].should equal(port)
+    end
+  end
+
+  describe '#remove' do
+    it 'should raise an exception if an invalid type of identifier is given' do
+      expect do
+        subject.remove('not a symbol')
+      end.to raise_exception(TypeError, 'Expected identifier to be a Symbol')
+    end
+
+    it 'should remove any matching identifiers' do
+      identifier = :hello_world
+      port_identifiers = {}
+      subject.instance_variable_set(:@port_identifiers, port_identifiers)
+
+      port_identifiers.should_receive(:delete).with(identifier).once()
+      subject.remove(identifier)
+    end
+
+    it 'should return a boolean indicating whether it removed anything' do
+      identifier = :hello_world
+      port_identifiers = {}
+      port_identifiers[identifier] = true
+      subject.instance_variable_set(:@port_identifiers, port_identifiers)
+
+      return_value = subject.remove(identifier)
+      return_value.should be_true
+
+      port_identifiers.should_not include(identifier)
+
+      return_value = subject.remove(identifier)
+      return_value.should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'matchers'
+require 'nxt'
+
+include NXT::Exceptions

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: lego-nxt
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nathan Kleyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: libusb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.6.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: Ruby LEGO Mindstorms NXT 2.0 control via Bluetooth and USB. See http://github.com/nathankleyn/lego-nxt
+  for more information.
+email: nathan@nathankleyn.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Rakefile
+- lib/nxt.rb
+- lib/nxt/connectors/output/motor.rb
+- lib/nxt/connectors/input/color.rb
+- lib/nxt/connectors/input/ultrasonic.rb
+- lib/nxt/connectors/input/touch.rb
+- lib/nxt/exceptions.rb
+- lib/nxt/nxt_brick.rb
+- lib/nxt/commands/program.rb
+- lib/nxt/commands/sound.rb
+- lib/nxt/commands/tone.rb
+- lib/nxt/commands/output.rb
+- lib/nxt/commands/base.rb
+- lib/nxt/commands/input.rb
+- lib/nxt/utils/accessors.rb
+- lib/nxt/patches/string.rb
+- lib/nxt/patches/module.rb
+- lib/nxt/interfaces/usb.rb
+- lib/nxt/interfaces/base.rb
+- lib/nxt/interfaces/serial_port.rb
+- spec/spec_helper.rb
+- spec/matchers.rb
+- spec/nxt/nxt_brick_spec.rb
+- spec/nxt/interfaces/serial_port_spec.rb
+homepage: http://github.com/nathankleyn/lego-nxt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Ruby LEGO Mindstorms NXT 2.0 control via Bluetooth and USB.
+test_files: []
+has_rdoc: