spx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5aabd4bf42589db840b334c70bcd52eab1b804c158d5033cec5380b0aff4ffe
+  data.tar.gz: 8fa38529f785f379e882e0f3da6718d1cc5aeef6b35eb770d0ccc019aebfbcee
+SHA512:
+  metadata.gz: 93b28fa5b6a9ef1c080082715f14b363edd5aad05800951259745052ca283d2fdd1317b6416408cdf5f12a73589db716faadd4a3a055e0343385050270ab0fbc
+  data.tar.gz: 8636c6a04e79fdb206accd802a4991c43d1a317ea34ea02ffd1fb72c00116681b85fdd7cb1953a3127c82e582f5829985f0d31c962e9f2e11dd1ea02ccdb8549

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - spec/fixtures/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 tnantoka
+
+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.

data/README.md

@@ -0,0 +1,40 @@
+# Spx: Sonic Pi eXecutor
+
+Spx is a CLI tool to play or record Sonic Pi code by using Sonic Pi's built-in OSC server.
+
+## Requirements
+
+- [Sonic Pi](https://github.com/sonic-pi-net/sonic-pi) (version 4.5.0 or later)
+- Ruby
+
+## Usage
+
+```bash
+# Help
+gem exec spx
+
+# Test connection to Sonic Pi
+gem exec spx test_connection
+
+# Play Sonic Pi code
+gem exec spx play path/to/sonic-pi-code.rb
+
+# Record Sonic Pi code
+gem exec spx record path/to/sonic-pi-code.rb -o path/to/output.wav
+```
+
+If `gem exec` is not available, you can use the following command instead:
+
+```bash
+gem install -g spx
+spx
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgements
+
+- https://github.com/sonic-pi-net/sonic-pi
+- https://rubygems.org/gems/sonic-pi-cli4

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/spx

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "spx"
+
+Spx::CLI.start(ARGV)

data/lib/spx/cli.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Spx
+  class CLI < Thor
+    class << self
+      def shared_options
+        method_option :sonic_pi_log, aliases: "-l", desc: "Log file to parse port number and token",
+                                     default: "~/.sonic-pi/log/spider.log"
+        method_option :callback_port, aliases: "-p", desc: "UDP port to receive messages from Sonic Pi", default: "3333"
+      end
+    end
+
+    desc "test-connection", "Test connection to Sonic Pi"
+    shared_options
+    def test_connection
+      runner.test_connection.tap do |connected|
+        say connected ? "OK" : "NG"
+      end
+    end
+
+    desc "play SOURCE", "Play a Sonic Pi file"
+    shared_options
+    def play(file)
+      unless runner.test_connection
+        say "Cannot connect to Sonic Pi"
+        return false
+      end
+
+      runner.play(File.read(file))
+    end
+
+    desc "record SOURCE", "Record a Sonic Pi session to a file"
+    shared_options
+    method_option :output, aliases: "-o", desc: "Output file", default: "./output.wav"
+    def record(file)
+      unless runner.test_connection
+        say "Cannot connect to Sonic Pi"
+        return false
+      end
+
+      runner.record(
+        File.read(file),
+        File.expand_path(options[:output])
+      )
+    end
+
+    desc "version", "Show version"
+    def version
+      say Spx::VERSION
+    end
+
+    private
+
+    def runner
+      @runner ||= begin
+        parser = LogParser.new(File.expand_path(options[:sonic_pi_log]))
+        port, token = parser.parse.values_at(:port, :token)
+        Runner.new(port, token, options[:callback_port].to_i)
+      end
+    end
+  end
+end

data/lib/spx/log_parser.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Spx
+  class LogParser
+    def initialize(log_file_path)
+      @log_file_path = log_file_path
+    end
+
+    def parse
+      port = nil
+      token = nil
+
+      File.foreach(@log_file_path) do |line|
+        token ||= line[/Token:\s+(-?\d+)/, 1]&.to_i
+        port ||= line[/:server_port=>(\d+)/, 1]&.to_i
+
+        break if port && token
+      end
+
+      { port: port, token: token }
+    end
+  end
+end

data/lib/spx/runner.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Spx
+  class Runner
+    HOST = "localhost"
+    MESSAGES = {
+      run_code: "/run-code",
+      start_recording: "/start-recording",
+      stop_recording: "/stop-recording",
+      save_recording: "/save-recording",
+      test_callback: "/test-callback",
+      record_callback: "/record-callback"
+    }.freeze
+    TIMES = {
+      test_timeout: 1,
+      stop_margin: 1
+    }.freeze
+
+    def initialize(port, token, callback_port)
+      @port = port
+      @token = token
+      @callback_port = callback_port
+    end
+
+    def test_connection # rubocop:disable Metrics/MethodLength
+      connected = false
+
+      run_with_callback("", MESSAGES[:test_callback]) do
+        connected = true
+      end
+
+      Timeout.timeout(TIMES[:test_timeout]) do
+        loop do
+          sleep 0.1
+          break if connected
+        end
+      end
+
+      true
+    rescue Timeout::Error
+      false
+    end
+
+    def play(code)
+      send_message(MESSAGES[:run_code], code)
+    end
+
+    def record(code, output_file) # rubocop:disable Metrics/MethodLength
+      start_recording
+
+      recorded = false
+
+      run_with_callback(code, MESSAGES[:record_callback]) do
+        sleep TIMES[:stop_margin]
+        stop_recording
+        save_recording(output_file)
+        recorded = true
+      end
+
+      loop do
+        sleep 0.1
+        break if recorded
+      end
+    end
+
+    private
+
+    def start_recording
+      send_message(MESSAGES[:start_recording])
+    end
+
+    def stop_recording
+      send_message(MESSAGES[:stop_recording])
+    end
+
+    def save_recording(file_path)
+      send_message(MESSAGES[:save_recording], file_path)
+    end
+
+    def send_message(type, body = nil)
+      prepared = OSC::Message.new(type, @token, body)
+      client.send(prepared)
+    end
+
+    def client
+      @client ||= OSC::Client.new(HOST, @port)
+    end
+
+    def code_with_callback(code, type)
+      [
+        code,
+        "osc_send 'localhost', 3333, '#{type}'"
+      ].join("\n")
+    end
+
+    def run_with_callback(code, type, &callback)
+      server.add_method(type.dup) do
+        callback.call
+      end
+
+      send_message(
+        MESSAGES[:run_code],
+        code_with_callback(code, type)
+      )
+    end
+
+    def server
+      @server ||= OSC::Server.new(@callback_port).tap do |server|
+        Thread.new { server.run }
+      end
+    end
+  end
+end

data/lib/spx/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spx
+  VERSION = "0.1.0"
+end

data/lib/spx.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "thor"
+require "osc-ruby"
+require "timeout"
+
+require_relative "spx/version"
+
+require_relative "spx/log_parser"
+require_relative "spx/runner"
+require_relative "spx/cli"

data/sig/spx.rbs

@@ -0,0 +1,4 @@
+module Spx
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: spx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tnantoka
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: osc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A CLI tool to play or record Sonic Pi code by using Sonic Pi's built-in
+  OSC server.
+email:
+- tnantoka@bornneet.com
+executables:
+- spx
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/spx
+- lib/spx.rb
+- lib/spx/cli.rb
+- lib/spx/log_parser.rb
+- lib/spx/runner.rb
+- lib/spx/version.rb
+- sig/spx.rbs
+- tmp/.keep
+homepage: https://github.com/tnantoka/spx
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tnantoka/spx
+  source_code_uri: https://github.com/tnantoka/spx
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Sonic Pi eXecutor
+test_files: []