fast_osc 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b61fec8aa9b7da4919beb24194add024e7fc96ed
-  data.tar.gz: f3b8f4387da0d02161f4d173b60de999c9851948
+  metadata.gz: f284e9a9b81cb84245fbf2d9a1c7631fb670696d
+  data.tar.gz: 40f36cc032625bc34a9bd4811127fe0d1cae7c49
 SHA512:
-  metadata.gz: d6f8997f138ca1d6a78c3d686cbd24fcd9b29638dae90d817becd9f2a97ced738eb2f33025c5f6a86a0ece2abad5794ffa640bb690a8d92a0850108f8c1fb7cf
-  data.tar.gz: 58723176381c238b7591c82e1ff43f24ae4cb829311b862f03639236d16e47c65bbf914b26e1986ef494d45b799e88f688d680385dd761fb049ecf321ab61094
+  metadata.gz: 9ca15f55e91996ed3435a378985667afe7ffe31156d257873a2d26c68cc5eb295845d025b21339233a7068abc27fc19da2f5e7e1527eb9f54bff6c77d21e1fde
+  data.tar.gz: 3ae9debfc8cfc11bb415ffe052c7346e161bef20e3abd1add9466d174401ebd240fe2ca7deef3f649a7d8cb63169e24fc190865a396c198a404b454d7dcd3edb

data/README.md

@@ -18,8 +18,6 @@ Or install it yourself as:
 
     $ gem install fast_osc
 
-This will only work on a mac at the moment as that's what the `librtosc.a` was compiled on.
-
 ## Is it fast?
 
 Let's see...
@@ -74,10 +72,22 @@ I'll include a better test in the repo in time.
 => "#bundle\x00\x00\x00\x00\x00W*1\x7F\x00\x00\x00\x1C/foo\x00\x00\x00\x00,sif\x00\x00\x00\x00baz\x00\x00\x00\x00\x01@\x00\x00\x00"
 ```
 
+See the test suite for additional methods regarding bundles with timestamps. Bundles are only supported with a single message at present. A timestamp of `nil` is a special case meaning "immediately".
+
+## Running the test suite
+
+```
+$ gem install minitest # or bundle install
+$ rake clean && rake clobber && rake compile && rake test
+```
+
 ## Still todo
 
 * Implement more types
-* add tests at the Ruby level (rtosc C code is already tested)
+* Bring benchmarks into the repo
+* Implement multi message/nested bundles
+* Documentation
+* Travis
 
 ## Development notes
 

data/Rakefile

@@ -1,5 +1,14 @@
 require "bundler/gem_tasks"
 
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec
+
 require 'rake/extensiontask'
 spec = Gem::Specification.load('fast_osc.gemspec')
 Rake::ExtensionTask.new('fast_osc') do |ext|

data/ext/fast_osc/fast_osc_wrapper.c

@@ -166,11 +166,36 @@ VALUE method_fast_osc_encode_single_message(VALUE self, VALUE address, VALUE arg
   return output;
 }
 
-VALUE method_fast_osc_encode_single_bundle(VALUE self, VALUE timestamp, VALUE address, VALUE args) {
+#define JAN_1970 2208988800.0     /* 2208988800 time from 1900 to 1970 in seconds */
+
+uint64_t ruby_time_to_osc_timetag(VALUE rubytime) {
+  uint64_t timetag;
+  double floattime;
+  uint32_t sec;
+  uint32_t frac;
+
+  switch(TYPE(rubytime)) {
+    case T_NIL:
+      timetag = 1;
+      break;
+    default:
+      // convert Time object to ntp
+      floattime = JAN_1970 + NUM2DBL(rb_funcall(rubytime, rb_intern("to_f"), 0));
+
+      sec = NUM2UINT(DBL2NUM(floattime));
+      frac = (int)(fmod(floattime, 1.0) * 4294967296); // * (2 ** 32)
+      timetag = (uint64_t)((uint64_t)sec << 32 | (uint64_t)frac);
+      break;
+  }
+
+  return timetag;
+}
+
+VALUE method_fast_osc_encode_single_bundle(VALUE self, VALUE timetag, VALUE address, VALUE args) {
   VALUE message = method_fast_osc_encode_single_message(self, address, args);
   int bufsize = buffer_size_for_ruby_string(message) + 16;
   int no_of_elems = 1;
-  uint64_t tt = FIX2LONG(timestamp);
+  uint64_t tt = ruby_time_to_osc_timetag(timetag);
   char output_buffer[bufsize];
 
   int len = rtosc_bundle(output_buffer, bufsize, tt, no_of_elems, StringValuePtr(message));

data/fast_osc.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "minitest", "~> 5.0"
+	spec.add_development_dependency "osc-ruby", "~> 1.1.1"
 end

data/lib/fast_osc/version.rb

@@ -1,3 +1,3 @@
 module FastOsc
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/fast_osc_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+require 'osc-ruby'
+require 'date'
+
+class FastOscTest < Minitest::Test
+  def setup
+    @path = "/thisisatest"
+    @args = [1, 2.0, "baz"]
+    @timestamp = Date.parse("1st Jan 1990").to_time
+
+    @msg1 = OSC::Message.new(@path, *@args).encode
+    @encoded_msg1 = @msg1.encode
+  end
+
+  def test_that_it_has_a_version_number
+    refute_nil ::FastOsc::VERSION
+  end
+
+  def test_that_it_encodes_a_single_message
+    msg = FastOsc.encode_single_message(@path, @args)
+
+    assert msg == @encoded_msg1
+  end
+
+  def test_that_it_decodes_a_single_message
+    path, args = FastOsc.decode_single_message(@encoded_msg1)
+
+    assert path == @path
+    assert args == @args
+  end
+
+  def test_that_it_encodes_a_single_bundle
+    bundle1 = OSC::Bundle.new(@timestamp, @msg1).encode
+    bundle2 = FastOsc.encode_single_bundle(@timestamp, @path, @args)
+
+    assert_equal bundle1, bundle2
+  end
+
+  def test_that_it_encodes_a_single_bundle_with_fractional_time
+    bundle1 = OSC::Bundle.new(@timestamp + 0.33, @msg1).encode
+    bundle2 = FastOsc.encode_single_bundle(@timestamp + 0.33, @path, @args)
+
+    assert_equal bundle1, bundle2
+  end
+
+  def test_that_it_encodes_a_single_bundle_with_fractional_time
+    bundle1 = OSC::Bundle.new(@timestamp + 0.3343215, @msg1).encode
+    bundle2 = FastOsc.encode_single_bundle(@timestamp + 0.3343215, @path, @args)
+
+    assert_equal bundle1, bundle2
+  end
+
+  def test_that_it_encodes_a_single_bundle_with_special_immediate_time
+    bundle1 = OSC::Bundle.new(nil, @msg1).encode
+    bundle2 = FastOsc.encode_single_bundle(nil, @path, @args)
+
+    assert_equal bundle1, bundle2
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'fast_osc'
+
+require 'minitest/autorun'
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_osc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Xavier Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: osc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 description: Serialize and deserialize Open Sound Control messages using rtosc
 email:
 - xavriley@hotmail.com
@@ -72,6 +100,8 @@ files:
 - fast_osc.gemspec
 - lib/fast_osc.rb
 - lib/fast_osc/version.rb
+- test/fast_osc_test.rb
+- test/test_helper.rb
 homepage: https://github.com/xavriley/fast_osc
 licenses:
 - MIT
@@ -97,4 +127,6 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Serialize and deserialize Open Sound Control messages
-test_files: []
+test_files:
+- test/fast_osc_test.rb
+- test/test_helper.rb