scruby 0.2.7 → 0.2.7.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scruby (0.2.7)
+    scruby (0.2.7.1)
       arguments (~> 0.6)
       live (~> 0.1)
       ruby-osc (~> 0.3)

data/README.rdoc

@@ -8,12 +8,14 @@ SynthDef creation and sending is robust but some features are not implemented su
 livecode.rb executable is located in the bin directory and a TextMate bundle included in extras permits livecoding from TextMate, comunication is 
 thrugh *nix pipes. Similar functionality shouldn't be too dificult to implement from Emacs or Vim.
 
-== INSTALL
+== Install
 
     $ [sudo] gem install scruby
 
+Scruby is just a SuperCollider client so SC must be installed on the system. There's a PPA for installing SC under Ubuntu: https://launchpad.net/~supercollider/+archive/ppa.
 
-== USAGE
+
+== Usage
 
     require 'scruby'
     
@@ -39,11 +41,11 @@ To start a live coding session:
 See http://github.com/maca/live
 
 
-== TODO
+== Todo
 
 Receive OSC messages from SuperCollider
 
-== LICENSE:
+== License:
 
 Copyright (c) 2008 Macario Ortega
 
@@ -59,7 +61,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-
-
-

data/lib/scruby/group.rb

@@ -1,6 +1,5 @@
 module Scruby
   class Group < Node
-    
     def free_all
       send '/g_freeAll', self.id
       self
@@ -15,10 +14,5 @@ module Scruby
       send '/g_dumpTree', self.id, post
       self
     end
-    
-    class << self
-      
-    end
-    
   end
-end
+end

data/lib/scruby/server.rb

@@ -29,21 +29,20 @@ module Scruby
     # The server is a Ruby representation of scsynth which can be a local binary or a remote    
     # server already running.
     # Server class keeps an array with all the instantiated servers
-    #   Options:
-    #     +host+: 
-    #       defaults to 'localhost'
-    #     +port+:
-    #       TCP port defaults to 57111
-    #     +control_buses+
-    #       Number of buses for routing control data defaults to 4096, indices start at 0.
-    #     +audio_buses+
-    #       Number of audio Bus channels for hardware output and input and internal routing, defaults to 128
-    #     +audio_outputs+
-    #       Reserved +buses+ for hardware output, indices available are 0 to +audio_outputs+ - 1 defaults to 8.
-    #     +audio_inputs+
-    #       Reserved +buses+ for hardware input, +audio_outputs+ to (+audio_outputs+ + +audio_inputs+ - 1), defaults to 8.
-    #     +buffers+
-    #       Number of available sample buffers defaults to 1024
+    # 
+    # For more info 
+    #   $ man scsynth
+    # 
+    # @param [Hash] opts the options to create a message with.
+    # @option opts [String] :path ('scsynt' on Linux, '/Applications/SuperCollider/scsynth' on Mac) scsynth binary path
+    # @option opts [String] :host ('localhost') SuperCollider Server address
+    # @option opts [Fixnum] :port (57111) TCP port
+    # @option opts [Fixnum] :control_buses (4096) Number of buses for routing control data, indices start at 0
+    # @option opts [Fixnum] :audio_buses (8) Number of audio Bus channels for hardware output and input and internal routing
+    # @option opts [Fixnum] :audio_outputs (8) Reserved buses for hardware output, indices start at 0
+    # @option opts [Fixnum] :audio_inputs (8) Reserved buses for hardware input, indices starting from the number of audio outputs
+    # @option opts [Fixnum] :buffers (1024) Number of available sample buffers
+    # 
     def initialize opts = {}
       @opts          = DEFAULTS.dup.merge opts
       @buffers       = []
@@ -60,7 +59,7 @@ module Scruby
     def path; @opts[:path]; end
 
     # Boots the local binary of the scsynth forking a process, it will rise a SCError if the scsynth 
-    # binary is not found in /Applications/SuperCollider/scsynth (default Mac OS path) or given path. 
+    # binary is not found in path. 
     # The default path can be overriden using Server.scsynt_path=('path')
     def boot
       raise SCError.new('Scsynth not found in the given path') unless File.exists? path
@@ -179,4 +178,4 @@ module Scruby
 
   class SCError < StandardError
   end
-end
+end

data/lib/scruby/version.rb

@@ -1,3 +1,3 @@
 module Scruby
-  VERSION = "0.2.7"
+  VERSION = "0.2.7.1"
 end

data/lib/scruby.rb

@@ -51,6 +51,7 @@ require "scruby/ugens/operation_ugens"
 require "scruby/ugens/ugens"
 require "scruby/synthdef"
 
+require "scruby/group"
 require "scruby/server"
 require "scruby/ugens/env_gen"
 

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: scruby
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 65
   prerelease: 
   segments: 
   - 0
   - 2
   - 7
-  version: 0.2.7
+  - 1
+  version: 0.2.7.1
 platform: ruby
 authors: 
 - Macario Ortega