cue_dsl 1.0.0

data/lib/cue_dsl.rb

@@ -0,0 +1,211 @@
+# lib/cue_dsl.rb
+require_relative "cue_dsl/version"
+require_relative "cue_dsl/errors"
+require_relative "cue_dsl/parameter"
+require_relative "cue_dsl/filter_bank"
+require_relative "cue_dsl/chain"
+require_relative "cue_dsl/device"
+require_relative "cue_dsl/matrix"
+require_relative "cue_dsl/connect"
+require_relative "cue_dsl/cue"
+require_relative "cue_dsl/receivers_loader"
+require_relative "cue_dsl/devices_config"
+require_relative "cue_dsl/cheatsheet"
+
+module CueDSL
+  class << self
+    attr_accessor :reset_system, :cheatsheet_path, :cue_numbers_path
+
+    def configure
+      yield self
+    end
+
+    def run(dsl_path, receivers_path: nil, devices_path: nil, out: $stdout, cheatsheet: nil)
+      receivers_path ||= File.join(File.dirname(dsl_path), "receivers.txt")
+      devices_path   ||= File.join(File.dirname(dsl_path), "devices.yml")
+      cheatsheet     ||= cheatsheet_path
+      Context.new(
+        dsl_path: dsl_path, receivers_path: receivers_path,
+        devices_path: devices_path, out: out, cheatsheet: cheatsheet
+      ).run
+    end
+  end
+
+  class Context
+    attr_reader :config, :receivers, :devices, :matrix, :system_params, :reset_verbs, :cues
+
+    def initialize(dsl_path:, receivers_path:, devices_path:, out:, cheatsheet:)
+      @dsl_path   = dsl_path
+      @out        = out
+      @cheatsheet = cheatsheet
+      @receivers  = ReceiversLoader.load(receivers_path)
+      @config     = DevicesConfig.load(devices_path)
+      @system_params = @receivers.system_params
+      @reset_verbs   = @receivers.reset_verbs
+      @cues       = []
+      @current_cue = nil
+      build_devices
+    end
+
+    def build_devices
+      @devices = {}
+      @receivers.devices.each do |prefix, params|
+        entry = @config.entries[prefix] or
+          raise ConfigurationError, "devices.yml: missing entry for #{prefix}"
+        dev = Device.new(
+          name: prefix, label: entry.label,
+          inputs: entry.inputs, outputs: entry.outputs,
+          parameters: params, filter_count: entry.filter_count
+        )
+        params.each_value { |p| dev.register_filter_fc(p) if p.kind == :filter_fc }
+        @devices[prefix] = dev
+      end
+      @matrix = Matrix.new(
+        rows: @config.matrix_rows, cols: @config.matrix_cols,
+        parameters: @receivers.matrix_params
+      )
+      @devices["MTX"] = @matrix
+    end
+
+    def run
+      instance_eval(File.read(@dsl_path), @dsl_path, 1)
+    
+      lines, index = render_all
+    
+      lines.each { |l| @out.puts l }
+    
+      if @cheatsheet
+        File.write(@cheatsheet, Cheatsheet.render(
+          devices: @devices.values.reject { |d| d.is_a?(Matrix) },
+          matrix: @matrix,
+          system_params: @system_params,
+          reset_verbs: @reset_verbs
+        ))
+      end
+    
+      if CueDSL.cue_numbers_path
+        File.write(CueDSL.cue_numbers_path, index.join("\n") + "\n")
+      end
+    end
+    
+    def render_all
+      lines = []
+      index = []
+      global_reset = CueDSL.reset_system != false
+    
+      @cues.each_with_index do |cue, i|
+        cue_reset = cue.reset_system?
+        cue_reset = global_reset if cue_reset.nil?
+    
+        first_line = lines.length
+        index << "#{first_line} #{escape(cue.name)}" if cue_reset
+    
+        nxt = @cues[i + 1]
+        preview = nxt ? "#{i + 1} - #{nxt.name}" : nil
+    
+        cue.render(index: i, matrix: @matrix,
+                   reset_system: cue_reset,
+                   preview: preview).each { |l| lines << l }
+      end
+    
+      [lines, index]
+    end
+    
+    private
+    
+    def escape(str)
+      str.gsub(/[ ,;]/) { |m| "\\#{m}" }
+    end
+
+    public
+    # ---- DSL verbs -------------------------------------------------------
+
+    def cue(name, reset_system: nil, &block)
+      line = caller_locations(1, 1).first.lineno
+      c = Cue.new(name, line, reset_system: reset_system)
+      @cues << c
+      prev = @current_cue
+      @current_cue = c
+      instance_eval(&block) if block
+      @current_cue = prev
+      c
+    end
+
+    def connect(*tokens)
+      raise Error, "connect outside cue" if @current_cue.nil?
+      raise ConnectionError,
+            "connect takes a chain like `dry >> filter`" if tokens.length != 1
+
+      chain = tokens.first
+      chain = Chain.new([chain]) if chain.is_a?(Device)
+      unless chain.is_a?(Chain)
+        raise ConnectionError, "connect expects a Chain, got #{chain.inspect}"
+      end
+      raise ConnectionError, "connect needs >=2 devices" if chain.devices.length < 2
+
+      @current_cue.record_chain_marker(chain.devices)
+      chain.devices.each do |d|
+        @current_cue.add_device(d)
+        d.bind(@current_cue)
+      end
+    end
+
+    def reset(sym)
+      raise Error, "reset outside cue" if @current_cue.nil?
+      raise Error, "unknown reset :#{sym}" unless @reset_verbs.include?(sym)
+      @current_cue.record_reset("reset_#{sym}_recv bang")
+    end
+
+    def comment(text, kind: :hash)
+      raise Error, "comment outside cue" if @current_cue.nil?
+      @current_cue.record_comment("#{kind == :gui ? '##' : '#'} #{text}")
+    end
+
+    def system
+      raise Error, "system outside cue" if @current_cue.nil?
+      SystemAccess.new(@current_cue, @system_params)
+    end
+
+    def method_missing(name, *args, &blk)
+      key = name.to_s.upcase
+      if @devices.key?(key)
+        dev = @devices[key]
+        if @current_cue && !dev.is_a?(Matrix)
+          @current_cue.add_device(dev)
+          dev.bind(@current_cue)
+        elsif @current_cue && dev.is_a?(Matrix)
+          dev.bind(@current_cue)
+        end
+        return dev
+      end
+      super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @devices.key?(name.to_s.upcase) || super
+    end
+
+    class SystemAccess
+      AUTO_EMITTED = {
+        header_message: "cue name",
+        preview_cue:    "the next cue's name"
+      }.freeze
+
+      def initialize(cue, params)
+        @cue = cue
+        params.each do |sym, param|
+          if AUTO_EMITTED.key?(sym)
+            define_singleton_method(sym) do |*|
+              raise Error, "system.#{sym} is emitted automatically from #{AUTO_EMITTED[sym]}; " \
+                           "do not call it manually"
+            end
+          else
+            define_singleton_method(sym) do |value|
+              @cue.record_system(param.emit(value))
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: cue_dsl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nicola Bernardini
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Define live-electronics cues in Ruby; emit a Pure Data [text sequence]
+  stream on STDOUT, a cheatsheet and a cue line number index.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/run.rb
+- lib/cue_dsl.rb
+- lib/cue_dsl/chain.rb
+- lib/cue_dsl/cheatsheet.rb
+- lib/cue_dsl/connect.rb
+- lib/cue_dsl/cue.rb
+- lib/cue_dsl/device.rb
+- lib/cue_dsl/devices_config.rb
+- lib/cue_dsl/errors.rb
+- lib/cue_dsl/filter_bank.rb
+- lib/cue_dsl/matrix.rb
+- lib/cue_dsl/parameter.rb
+- lib/cue_dsl/receivers_loader.rb
+- lib/cue_dsl/version.rb
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.14
+specification_version: 4
+summary: A DSL for generating Pure Data text sequence cue lists
+test_files: []