BBB 0.0.1 → 0.0.2

data/spec/circuit_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe BBB::Circuit do
+  let(:circuit) {BBB::Circuit.new}
+  let(:c) { BBB::Circuit.new }
+  # You can't really avoid some integration testing here
+  let(:led) { BBB::Components::Led }
+
+  it "initializes" do
+    lambda{ BBB::Circuit.new }.should_not raise_exception
+  end
+
+  context "#attach" do
+    it "initializes object when passed a class" do
+      c.attach led, as: :led
+      c.components.values.first.class.should eql(led)
+    end
+
+    it "keeps instance when passed an instance" do
+      instance = led.new
+      c.attach instance, as: :instance
+      c.components.values.first.should eql(instance)
+    end
+
+    context "naming" do
+      it "downcases class names" do
+        l = led.new
+        c.attach l, as: :led
+        c.led.should eql(l)
+        c.components[:led].should eql(l)
+      end
+    end
+
+  end
+
+  class TestAttachCircuit < BBB::Circuit
+    def initialize
+      attach BBB::Components::Led, pin: :P8_1, as: :led
+    end
+  end
+
+  it "knows about the attached led" do
+    circuit = TestAttachCircuit.new
+    circuit.respond_to?(:led).should be_true
+  end
+
+end

data/spec/components/led_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe BBB::Components::Led do
+  let(:led) {BBB::Components::Led.new}
+
+  it "initializes off" do
+    led.off?.should be_true
+  end
+
+  it "set state: on" do
+    led.on!
+    led.on?.should be_true
+  end
+
+  it "set state: off" do
+    led.on!
+    led.off!
+    led.off?.should be_true
+  end
+
+  it "check state: on?" do
+    led.off!
+    led.on!
+    led.on?.should be_true
+  end
+
+  it "provides access to state "do
+    led.on!
+    led.state.should eql(:high)
+    led.off!
+    led.state.should eql(:low)
+  end
+
+  context "#pinnable include" do
+    it "responds to pinnable actions" do
+      led.respond_to?(:register_pin_positions)
+    end
+
+    it "sets the right pin position" do
+      led.register_pin_positions(:P8_3)
+      led.pin.position.should eql(:P8_3)
+    end
+  end
+
+end

data/spec/components/pinnable_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe BBB::Components::Pinnable do
+  class DummyComponent
+    include BBB::Components::Pinnable
+
+    def initialize
+      pin = Struct.new(:position)
+      @pins = [pin.new(0), pin.new(1)]
+    end
+  end
+
+  it "knows how to register pins" do
+    comp = DummyComponent.new
+    comp.register_pin_positions(:P8_3, :P8_4)
+    comp.pins[0].position.should eql(:P8_3)
+    comp.pins[1].position.should eql(:P8_4)
+  end
+end

data/spec/gpio/base_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe BBB::GPIO::Base do
+  let(:gpio_81) { BBB::GPIO::Base.new(:p8_3, mock: true) }
+  let(:gpio_base) { BBB::GPIO::Base.new(:p8_3, mock: true) }
+
+  context "Statics values" do
+    [:gpio_path, :gpio_direction_input, :gpio_direction_output,
+     :export_path, :unexport_path, :gpio_pin_dir].each do |method|
+
+      it "#{method.to_s}" do
+        gpio_base.public_send(method).should_not be_nil
+      end
+
+    end
+  end
+
+  it "should be able to mock using StringIO" do
+    BBB::GPIO::Base.new(:p8_3, mock: true).file_class.should eql(StringIO)
+  end
+
+  # Temporarily disabled, because of inability to mock the call to the
+  # gpio files
+  xit "should default to File class" do
+    BBB::GPIO::Base.new(:p8_3).file_class.should eql(File)
+  end
+
+  # Temporarily disabled, because of inability to mock the call to the
+  # gpio files
+  xit "should be able to explicitly set non mock File class" do
+    BBB::GPIO::Base.new(:p8_3, mock: false).file_class.should eql(File)
+  end
+
+  it "should have a file_class" do
+    gpio_base.respond_to?(:file_class).should be_true
+  end
+
+  context "Filesystem functions" do
+    it "should export" do
+      gpio_81.export.should eql(2)
+    end
+
+    it "should unexport" do
+      gpio_81.unexport.should eql(2)
+    end
+  end
+
+end

data/spec/gpio/digital_pin_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe BBB::GPIO::DigitalPin do
+  let(:digital_pin) { BBB::GPIO::DigitalPin }
+  let(:input_pin)   { BBB::GPIO::DigitalPin.new(:p8_9, :input, mock: true) }
+  let(:output_pin)  { BBB::GPIO::DigitalPin.new(:p8_3, :output, mock: true) }
+
+  it "should initialize with a pin number and mode" do
+    lambda{ input_pin }.should_not raise_exception
+  end
+
+  it "should set the pin number" do
+    input_pin.position.should eql(:p8_9)
+  end
+
+  it "should set the mode" do
+    input_pin.mode.should eql(:input)
+  end
+
+  it "initialize with unknown mode pin raises exception" do
+    lambda{ digital_pin.new(:p8_3, "unknown", mock: true) }.should\
+      raise_exception(BBB::UnknownPinModeException)
+  end
+
+  context "direction" do
+    it "input pin" do
+      pin = input_pin
+      pin.direction.should eql(pin.gpio_direction_input)
+    end
+
+    it "output pin" do
+      pin = output_pin
+      pin.direction.should eql(pin.gpio_direction_output)
+    end
+  end
+
+  context "#set mode" do
+    ##
+    # Temporarily disabled because of inability to catch results of
+    # StringIO.open. Possible solution is factoring out the direction_file
+    # argument and then use a real file system call to a different file to test
+    # this.
+    xit "should set input mode" do
+      pin = input_pin
+      pin.set_mode.string.should eql(pin.direction.size)
+    end
+
+    ##
+    # Temporarily disabled because of inability to catch results of
+    # StringIO.open. Possible solution is factoring out the direction_file
+    # argument and then use a real file system call to a different file to test
+    # this.
+    xit "should set output mode" do
+      pin = output_pin
+      pin.set_mode.string.should eql(pin.direction.size)
+    end
+  end
+
+  it "#io input" do
+    pin = input_pin
+    StringIO.should_receive(:open).with(anything, "r")
+    pin.io
+  end
+
+  it "#io output" do
+    pin = output_pin
+    StringIO.should_receive(:open).with(anything, "w+")
+    pin.io
+  end
+
+  it "should not call the io file twice" do
+    pin = output_pin
+    StringIO.should_receive(:open).with(anything, "w+").once.and_return("foo")
+    pin.io; pin.io
+  end
+
+  it "should write :low as 0 to io" do
+    pin = output_pin
+    pin.io.should_receive(:write).with(0)
+    pin.write(:low)
+  end
+
+  it "should write :high as 1 to io" do
+    pin = output_pin
+    pin.io.should_receive(:write).with(1)
+    pin.write(:high)
+  end
+
+  it "should read 1 as :high from io" do
+    pin = output_pin
+    pin.io.should_receive(:read).and_return(1)
+    pin.read.should eql(:high)
+  end
+
+  it "should read 0 as :low from io" do
+    pin = output_pin
+    pin.io.should_receive(:read).and_return(0)
+    pin.read.should eql(:low)
+  end
+end

data/spec/gpio/pin_converter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe BBB::GPIO::PinConverter do
+  let(:converter) { BBB::GPIO::PinConverter.new }
+
+  it "converts DigitalPin input to DigitalPin" do
+    pin = BBB::IO::DigitalPin.new(:input, nil, :P8_3)
+    result = converter.convert(pin, mock: true)
+    result.kind_of?(BBB::GPIO::DigitalPin).should be_true
+    result.mode.should eql(:input)
+  end
+
+  it "converts DigitalPin output to DigitalPin" do
+    pin = BBB::IO::DigitalPin.new(:output, nil, :P8_3)
+    result = converter.convert(pin, mock: true)
+    result.kind_of?(BBB::GPIO::DigitalPin).should be_true
+    result.mode.should eql(:output)
+  end
+end

data/spec/io/digital_pin_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe BBB::IO::DigitalPin do
+  let(:pin) { BBB::IO::DigitalPin.new }
+  it "should initialize" do
+    lambda do
+      BBB::IO::DigitalPin.new
+    end.should_not raise_exception
+  end
+
+  it "should respond to register_position" do
+    pin.respond_to?(:'position=').should be_true
+  end
+end

data/spec/io/mock_pin_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe BBB::IO::MockPin do
+  let(:pin) {BBB::IO::MockPin.new}
+
+  it "responds to read" do
+    pin.respond_to?(:read)
+  end
+
+  it "responds to write" do
+    pin.respond_to?(:write)
+  end
+end

data/spec/io/pinnable_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe BBB::IO::Pinnable do
+  class TestPin
+    include BBB::IO::Pinnable
+  end
+
+  it "registers positions" do
+    pin = TestPin.new
+    pin.position=:P8_3
+    pin.position.should eql(:P8_3)
+  end
+end

data/spec/pin_mapper_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe BBB::PinMapper do
+  let(:mapper) { BBB::PinMapper }
+
+  it "should be able to map" do
+    mapper.map(:P8_3).should eql(38)
+  end
+
+  it "should upcase" do
+    mapper.map(:p8_3).should eql(38)
+  end
+
+  it "should raise an error when requesting an unknown pin" do
+    lambda{ mapper.map(:P10_1) }.should raise_exception(BBB::UnknownPinException)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'BBB'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: BBB
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wilco van Duinkerken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,13 +60,42 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - BBB.gemspec
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
+- examples/led.rb
+- examples/sketches.rb
 - lib/BBB.rb
+- lib/BBB/application.rb
+- lib/BBB/board.rb
+- lib/BBB/circuit.rb
+- lib/BBB/components/led.rb
+- lib/BBB/components/pinnable.rb
+- lib/BBB/exceptions.rb
+- lib/BBB/gpio/base.rb
+- lib/BBB/gpio/digital_pin.rb
+- lib/BBB/gpio/pin_converter.rb
+- lib/BBB/io/digital_pin.rb
+- lib/BBB/io/mock_pin.rb
+- lib/BBB/io/pinnable.rb
+- lib/BBB/pin_mapper.rb
+- lib/BBB/test_board.rb
 - lib/BBB/version.rb
+- spec/application_spec.rb
+- spec/board_spec.rb
+- spec/circuit_spec.rb
+- spec/components/led_spec.rb
+- spec/components/pinnable_spec.rb
+- spec/gpio/base_spec.rb
+- spec/gpio/digital_pin_spec.rb
+- spec/gpio/pin_converter_spec.rb
+- spec/io/digital_pin_spec.rb
+- spec/io/mock_pin_spec.rb
+- spec/io/pinnable_spec.rb
+- spec/pin_mapper_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses:
 - MIT
@@ -91,4 +120,17 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Helper functions to ruby around on the BeagleBone Black
-test_files: []
+test_files:
+- spec/application_spec.rb
+- spec/board_spec.rb
+- spec/circuit_spec.rb
+- spec/components/led_spec.rb
+- spec/components/pinnable_spec.rb
+- spec/gpio/base_spec.rb
+- spec/gpio/digital_pin_spec.rb
+- spec/gpio/pin_converter_spec.rb
+- spec/io/digital_pin_spec.rb
+- spec/io/mock_pin_spec.rb
+- spec/io/pinnable_spec.rb
+- spec/pin_mapper_spec.rb
+- spec/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Wilco van Duinkerken
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.