dino 0.8 → 0.9

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+script: bundle exec rspec spec

data/README.md

@@ -1,8 +1,10 @@
 # Welcome to Dino
+[![Build Status](https://secure.travis-ci.org/austinbv/dino.png)](http://travis-ci.org/austinbv/dino)
 
 ## Get started in no time
 Dino was designed to help you start working with your Arduino in minutes.
 
+> * `gem install dino`
 > * Burn the file `src/du.ino` to your Arduino
 > ** You can do this in the [Arduino IDE](http://www.arduino.cc/en/Main/software)
 > * Plug in your Arduino and wire the led like in `examples/led/led.png`
@@ -12,3 +14,6 @@ By now you should be blinking away
 
 
 Take a look in the example directory for more information
+
+
+I gave a [talk on this library at RubyConf](http://confreaks.com/videos/1294-rubyconf2012-arduino-the-ruby-way), you can see the slides here: [Arudino The Ruby Way](https://speakerdeck.com/austinbv/arduino-the-ruby-way)

data/Rakefile

@@ -1,2 +1,10 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/examples/button/button.rb

@@ -4,10 +4,10 @@
 # sleep or in someway keep running or your program
 # will exit before any callbacks can be called
 #
-require '../lib/dino'
+require File.expand_path('../../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
-button = Dino::Components::Button.new(pin: 2, board: board)
+button = Dino::Components::Button.new(pin: 13, board: board)
 
 button_down = Proc.new do
   puts "button down"

data/examples/ir_receiver.rb

@@ -4,7 +4,7 @@
 # sleep or in someway keep running or your program
 # will exit before any callbacks can be called
 #
-require '../lib/dino'
+require File.expand_path('../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 ir = Dino::Components::IrReceiver.new(pin: 2, board: board)

data/examples/led/led.rb

@@ -3,7 +3,7 @@
 # every half a second
 #
 
-require '../lib/dino'
+require File.expand_path('../../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 led = Dino::Components::Led.new(pin: 13, board: board)

data/examples/potentiometer.rb

@@ -5,7 +5,7 @@
 # and changes the sleep delay for the LED on/off cycle.  
 #  
 
-require '../lib/dino'
+require File.expand_path('../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 led = Dino::Components::Led.new(pin: 13, board: board)

data/examples/rgb_led.rb

@@ -3,7 +3,7 @@
 # every half a second
 #
 
-require '../lib/dino'
+require File.expand_path('../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 led = Dino::Components::RgbLed.new(pins: {red: 11, green: 10, blue: 9}, board: board)

data/examples/sensor.rb

@@ -4,7 +4,7 @@
 # sleep or in someway keep running or your program
 # will exit before any callbacks can be called
 #
-require '../lib/dino'
+require File.expand_path('../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 sensor = Dino::Components::Sensor.new(pin: 'A0', board: board)

data/examples/servo.rb

@@ -4,8 +4,8 @@
 # sleep or in someway keep running or your program
 # will exit before any callbacks can be called
 #
-$: << File.expand_path('../../lib', __FILE__)
-require '../lib/dino'
+
+require File.expand_path('../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 servo = Dino::Components::Servo.new(pin: 9, board: board)

data/examples/{stepper.rb → stepper/stepper.rb}

@@ -2,7 +2,7 @@
 # This is a simple example to move a stepper motor using the sparkfun easydriver shield: https://www.sparkfun.com/products/10267?
 #
 
-require '../lib/dino'
+require File.expand_path('../../../lib/dino', __FILE__)
 
 board = Dino::Board.new(Dino::TxRx.new)
 stepper = Dino::Components::Stepper.new(board: board, pins: { step: 10, direction: 8 })

data/lib/dino.rb

@@ -1,15 +1,5 @@
+require 'dino/board_not_found'
 require 'dino/version'
 require 'dino/tx_rx'
 require 'dino/board'
-
-require 'dino/components/base_component'
-require 'dino/components/led'
-require 'dino/components/button'
-require 'dino/components/sensor'
-require 'dino/components/rgb_led'
-require 'dino/components/servo'
-require 'dino/components/stepper'
-require 'dino/components/ir_receiver'
-
-module Dino
-end
+require 'dino/components'

data/lib/dino/board_not_found.rb

@@ -0,0 +1,3 @@
+module Dino
+  class BoardNotFound < Exception; end
+end

data/lib/dino/components.rb

@@ -0,0 +1,12 @@
+module Dino
+  module Components
+    require 'dino/components/base_component'
+    autoload :Led,        'dino/components/led'
+    autoload :Button,     'dino/components/button'
+    autoload :Sensor,     'dino/components/sensor'
+    autoload :RgbLed,     'dino/components/rgb_led'
+    autoload :Servo,      'dino/components/servo'
+    autoload :Stepper,    'dino/components/stepper'
+    autoload :IrReceiver, 'dino/components/ir_receiver'
+  end
+end

data/lib/dino/components/base_component.rb

@@ -9,8 +9,18 @@ module Dino
         self.board = options[:board]
 
         raise 'board and pin or pins are required for a component' if self.board.nil? || self.pin.nil?
+        after_initialize(options)
       end
 
+      #
+      # As BaseComponent does a lot of work for you with regarding to setting up, it is
+      # best not to override #initialize and instead define an #after_initialize method
+      # within your subclass.
+      #
+      # @note This method should be implemented in the BaseComponent subclass.
+      #
+      def after_initialize(options={}) ; end
+
       protected
 
       attr_writer :pin, :board

data/lib/dino/components/button.rb

@@ -4,9 +4,7 @@ module Dino
       UP = "01"
       DOWN = "00"
 
-      def initialize(options={})
-        super(options)
-
+      def after_initialize(options={})
         @down_callbacks, @up_callbacks, @state = [], [], UP
 
         self.board.add_digital_hardware(self)

data/lib/dino/components/ir_receiver.rb

@@ -3,9 +3,7 @@ module Dino
     class IrReceiver < BaseComponent
       STABLE = "01"
 
-      def initialize(options={})
-        super(options)
-
+      def after_initialize(options={})
         @flash_callbacks = []
 
         self.board.add_digital_hardware(self)

data/lib/dino/components/led.rb

@@ -1,11 +1,9 @@
 module Dino
   module Components
     class Led < BaseComponent
-      def initialize(options={})
-        super(options)
-
+      def after_initialize(options={})
         set_pin_mode(:out)
-        digital_write(Board::LOW)
+        off
       end
 
       def on

data/lib/dino/components/rgb_led.rb

@@ -2,9 +2,7 @@ module Dino
   module Components
     class RgbLed < BaseComponent
       # options = {board: my_board, pins: {red: red_pin, green: green_pin, blue: blue_pin}
-      def initialize(options={})
-        super(options)
-
+      def after_initialize(options={})
         raise 'missing pins[:red] pin' unless self.pins[:red]
         raise 'missing pins[:green] pin' unless self.pins[:green]
         raise 'missing pins[:blue] pin' unless self.pins[:blue]

data/lib/dino/components/sensor.rb

@@ -1,9 +1,7 @@
 module Dino
   module Components
     class Sensor < BaseComponent
-      def initialize(options={})
-        super(options)
-
+      def after_initialize(options={})
         @data_callbacks = []
         @board.add_analog_hardware(self)
         @board.start_read

data/lib/dino/components/servo.rb

@@ -3,9 +3,7 @@ module Dino
     class Servo < BaseComponent
       attr_reader :position
 
-      def initialize(options)
-        super(options)
-
+      def after_initialize(options={})
         set_pin_mode(:out)
         self.position = 0
       end

data/lib/dino/components/stepper.rb

@@ -2,9 +2,7 @@ module Dino
   module Components
     class Stepper < BaseComponent
 
-      def initialize(options={})
-        super(options)
-
+      def after_initialize(options={})
         raise 'missing pins[:step] pin' unless self.pins[:step]
         raise 'missing pins[:direction] pin' unless self.pins[:direction]
 

data/lib/dino/tx_rx.rb

@@ -12,14 +12,8 @@ module Dino
     end
 
     def io
-      @io ||= tty_devices.map do |device|
-        next if device.match /^cu/
-        begin
-          SerialPort.new("/dev/#{device}", BAUD)
-        rescue
-          nil
-        end
-      end.compact.first
+      raise BoardNotFound unless @io ||= find_arduino
+      @io
     end
 
     def io=(device)
@@ -52,7 +46,22 @@ module Dino
     private
 
     def tty_devices
-      `ls /dev | grep usb`.split(/\n/)
+      if RUBY_PLATFORM.include?("mswin") || RUBY_PLATFORM.include?("mingw")
+        ["COM1", "COM2", "COM3", "COM4"]
+      else
+        `ls /dev`.split("\n").grep(/usb|ACM/).map{|d| "/dev/#{d}"}
+      end
+    end
+
+    def find_arduino
+      tty_devices.map do |device|
+        next if device.match /^cu/
+        begin
+          SerialPort.new(device, BAUD)
+        rescue
+          nil
+        end
+      end.compact.first
     end
   end
-end
+end

data/lib/dino/version.rb

@@ -1,3 +1,3 @@
 module Dino
-  VERSION = "0.8"
+  VERSION = "0.9"
 end

data/spec/lib/board_not_found_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+module Dino
+  describe BoardNotFound do
+    it { should be }
+    it { should be_a Exception }
+  end
+end

data/spec/lib/components/base_component_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 module Dino
   module Components
+
     describe BaseComponent do
+
       it 'should initialize with board and pin' do
         pin = "a pin"
         board = "a board"
@@ -31,6 +33,33 @@ module Dino
           BaseComponent.new(pin: 'some pin')
         }.to raise_exception
       end
+
+      context "when subclassed #after_initialize should be executed" do
+
+        class SpecComponent < BaseComponent
+
+          def sucessfully_initialized? ; @success ; end
+
+          def options ; @options ; end
+
+          def after_initialize(options={})
+            @success = true
+            @options = options
+          end
+        end
+
+        let(:options) { { pin: pin, board: board } }
+        let(:pin) { "a pin" }
+        let(:board) { "a board" }
+
+        it "should call #after_initialize with options" do
+          component = SpecComponent.new(options)
+          component.should be_sucessfully_initialized
+          component.options.should eq options
+        end
+
+      end
+
     end
   end
 end

data/spec/lib/tx_rx_spec.rb

@@ -11,12 +11,30 @@ module Dino
     end
 
     describe '#io' do
-      it 'should instantiate a new SerialPort for each usb tty device found' do
-        subject.should_receive(:tty_devices).and_return(['cu.usb', 'tty1.usb', 'tty2.usb'])
-        SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::BAUD).and_return(mock_serial = mock)
-        SerialPort.should_receive(:new).with('/dev/tty2.usb', TxRx::BAUD).and_return(mock)
+      context "on windows" do
+        it 'should instantiate a new SerialPort for each usb tty device found' do
+          original_platform = RUBY_PLATFORM
+          RUBY_PLATFORM = "mswin"
+          subject.should_receive(:tty_devices).and_return(["COM1", "COM2", "COM3", "COM4"])
+          SerialPort.should_receive(:new).with('COM1', TxRx::BAUD).and_return(mock_serial = mock)
+          SerialPort.should_receive(:new).with('COM2', TxRx::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('COM3', TxRx::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('COM4', TxRx::BAUD).and_return(mock)
 
-        subject.io.should == mock_serial
+          subject.io.should == mock_serial
+          RUBY_PLATFORM = original_platform
+        end
+      end
+
+      context "on unix" do
+        it 'should instantiate a new SerialPort for each usb tty device found' do
+          subject.should_receive(:tty_devices).and_return(['/dev/tty1.usb', '/dev/tty1.usb', '/dev/tty.ACM0'])
+          SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::BAUD).and_return(mock_serial = mock)
+          SerialPort.should_receive(:new).with('/dev/tty1.usb', TxRx::BAUD).and_return(mock)
+          SerialPort.should_receive(:new).with('/dev/tty.ACM0', TxRx::BAUD).and_return(mock)
+
+          subject.io.should == mock_serial
+        end
       end
 
       it 'should use the existing io instance if set' do
@@ -26,6 +44,11 @@ module Dino
         subject.io = '/dev/tty1.usb'
         subject.io.should == mock_serial
       end
+
+      it 'should raise a BoardNotFound exception if there is no board connected' do
+        SerialPort.stub(:new).and_raise
+        expect { subject.io }.to raise_exception BoardNotFound
+      end
     end
 
     describe '#io=' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dino
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
@@ -37,6 +37,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -45,14 +46,18 @@ files:
 - examples/button/button.png
 - examples/button/button.rb
 - examples/ir_receiver.rb
+- examples/led/led.png
 - examples/led/led.rb
 - examples/potentiometer.rb
 - examples/rgb_led.rb
 - examples/sensor.rb
 - examples/servo.rb
-- examples/stepper.rb
+- examples/stepper/stepper.png
+- examples/stepper/stepper.rb
 - lib/dino.rb
 - lib/dino/board.rb
+- lib/dino/board_not_found.rb
+- lib/dino/components.rb
 - lib/dino/components/base_component.rb
 - lib/dino/components/button.rb
 - lib/dino/components/ir_receiver.rb
@@ -63,6 +68,7 @@ files:
 - lib/dino/components/stepper.rb
 - lib/dino/tx_rx.rb
 - lib/dino/version.rb
+- spec/lib/board_not_found_spec.rb
 - spec/lib/board_spec.rb
 - spec/lib/components/base_component_spec.rb
 - spec/lib/components/button_spec.rb
@@ -99,6 +105,7 @@ signing_key:
 specification_version: 3
 summary: Control your arduino through a serial port
 test_files:
+- spec/lib/board_not_found_spec.rb
 - spec/lib/board_spec.rb
 - spec/lib/components/base_component_spec.rb
 - spec/lib/components/button_spec.rb