oschii_ruby 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb0e8b35b66541a40236ea7a4595518d8a9d6727105c2543e74ca5d6fbb8443f
-  data.tar.gz: 1d9c121b90502130c86056f9818dca4b6a81fe9485734e257e9f261891bbe6f8
+  metadata.gz: 578aa88e4dd107c6af19e80da3419deae8fbcc56052cb8272a824f81ceaaddd3
+  data.tar.gz: 9f3b0a12310effb1832975cd5edba9846e2a83550b2df0e8ee4554d6175414a2
 SHA512:
-  metadata.gz: 8b35574e7713cdc5bf13d0e9710894818bc48c72a7a86ade3c6b8688a4449548a2106b01adeb52ac99585f7356f195b4c90999029a0b2aca3c1c6f3d170fb0c0
-  data.tar.gz: 57a436a356063c353d9e8f5a5a18014fce3aa2016b689f50b7daef79cf3efcba1a643d6081fb5669a81e0ddcbb8230735575439e3d1db2dba915d8c13dadb106
+  metadata.gz: 6558856f498bc70b8fa419aa3bb65f43c1cecd66337a2c1bdd3e5b6e8bd3e49f042751f16280370f5f17ef53e4675d9c656e5a33d28423b3f5e2a0f0ee3c2a89
+  data.tar.gz: 1d28d3da39dc9de4326b577d1aa19780ac5d369952ba7274fb441544460714902801f8e3bfaf4fb45d85c24ddf350a9bb89e48877d466259c92128ace69c0bba

data/Gemfile

@@ -9,4 +9,5 @@ gemspec
 group :development do
   gem 'make_menu'
   gem 'byebug'
+  gem 'bump'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oschii_ruby (0.0.1)
+    oschii_ruby (0.0.6)
       activesupport (~> 7.1.2)
       faye-websocket (~> 0.11.3)
       osc-ruby (~> 1.1.4)
@@ -24,6 +24,7 @@ GEM
       tzinfo (~> 2.0)
     base64 (0.2.0)
     bigdecimal (3.1.5)
+    bump (0.10.0)
     byebug (11.1.3)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
@@ -69,6 +70,7 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  bump
   byebug
   make_menu
   oschii_ruby!

data/lib/oschii/component.rb

@@ -0,0 +1,48 @@
+module Oschii
+  class Component
+    def initialize(type, config)
+      @type = type
+      @config = config
+    end
+
+    attr_reader :type, :config
+
+    def name
+      @name ||= config['name']
+    end
+
+    def array_name
+      @array_name ||= "#{type.capitalize}s"
+    end
+
+    def reference
+      "#{type}:#{name}"
+    end
+
+    def routes
+      @routes ||= config['routes'] || config['Routes'] || config['subs'] || config['Subs'] || []
+    end
+
+    def targets
+      return @targets if @targets
+
+      @targets = config['targets'] || config['target'] || config['~'] || []
+      @targets = [@targets] if @targets.is_a?(String)
+
+      routes.each do |route|
+        target_refs = route['targets'] || route['target'] || route['~'] || []
+        target_refs = [target_refs] if target_refs.is_a?(String)
+        @targets += target_refs
+      end
+      @targets.map { |ref| ref.split('/').first }.uniq
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class.name} '#{reference}'>"
+    end
+  end
+end

data/lib/oschii/config.rb

@@ -0,0 +1,183 @@
+require_relative 'component'
+require_relative 'template'
+require 'json'
+
+module Oschii
+  # LOGO = '
+  # ╔═╗┌─┐┌─┐┬ ┬┬┬
+  # ║ ║└─┐│  ├─┤││
+  # ╚═╝└─┘└─┘┴ ┴┴┴'
+
+  COMPONENT_TYPES = %w(Sensor Driver Reporter Listener Monitor State Timer Pixel I2C).freeze
+  I2C = 'I2C'.freeze
+  BASIC_COMPONENT_TYPES = COMPONENT_TYPES.reject { |t| t == I2C }.freeze
+
+  TemplateError = Class.new(StandardError)
+
+  class Config
+    def initialize(json)
+      @config = json.is_a?(String) ? JSON.parse(json) : json
+      @components = {}
+      @startups = []
+      @templates = load_templates
+      @sda = -1
+      @scl = -1
+      @clock = 100_000
+      @name = nil
+      @description = nil
+      build
+    end
+
+    def self.from_file(filename)
+      Config.new(File.read(filename))
+    end
+
+    attr_reader :components, :templates, :scl, :sda, :clock,
+                :name, :description, :config, :startups
+
+    def load_templates
+      Dir.glob("./templates/*.json").map do |filename|
+        conf = JSON.parse(File.read(filename))
+        template = Template.new(
+          conf, conf['name'] || filename.gsub('.json', '').split('/').last
+        )
+        [template.name, template]
+      end.to_h
+    end
+
+    def add_component(comp)
+      components[comp.reference] = comp
+    end
+
+    def build
+
+      @name = config['name']
+      @description = config['description']
+      @startups = config['Startups'] || []
+
+      puts inspect
+
+      BASIC_COMPONENT_TYPES.each do |type|
+        config["#{type}s"]&.each do |comp_def|
+          comp = Component.new(type, comp_def)
+          puts " + #{comp}"
+          add_component comp
+        end
+      end
+
+      if (i2c = config[I2C])
+        @sda = i2c['sdaPin'] || sda
+        @scl = i2c['sclPin'] || scl
+        @clock = i2c['clock'] || clock
+        i2c['modules']&.each do |comp_def|
+          comp = Component.new(I2C, comp_def)
+          puts " + #{comp}"
+          add_component comp
+        end
+      end
+
+      # Get templates defined within this config
+      config['Templates']&.each do |conf|
+        templates[conf['name']] = Template.new(conf)
+      end
+
+      config['Customs']&.each do |custom_def|
+        build_custom_component custom_def
+      end
+
+      build_missing_targets
+
+      self
+    end
+
+    def build_custom_component(custom_def, name_prefix = '', indent = 0)
+      template = templates[custom_def['template']]
+
+      raise TemplateError, "Custom:#{custom_def['name']} - Template '#{custom_def['template']}' not defined" unless template
+
+      puts "#{'  ' * indent}   Custom:#{template.name}:#{name_prefix}#{custom_def['name']}"
+
+      template.build_components(custom_def, name_prefix).each do |comp|
+        puts "#{'  ' * (indent+1)} + #{comp}"
+        add_component comp
+      end
+
+      @startups += template.startups
+
+      template.embedded_customs&.each do |inner_custom_def|
+        build_custom_component inner_custom_def, "#{custom_def['name']}_", indent + 1
+      end
+    end
+
+    def build_missing_targets
+      missing_comps = []
+
+      components.each do |ref, comp|
+        comp.targets.each do |target_ref|
+          next unless components[target_ref].nil?
+
+          type, name = target_ref.split(':')
+          puts name
+          name = name.split('/').first
+          unless name.start_with?('*')
+            new_comp = Component.new(type, { 'name' => name, 'warning' => 'Auto-created by Oschii Parser' })
+            missing_comps << new_comp
+          end
+        end
+      end
+      unless missing_comps.empty?
+        puts
+        puts "WARNING: Creating empty components for unresolved target references."
+        puts "         Output configuration may not be valid!"
+        puts
+
+        missing_comps.uniq do |comp|
+          next if components[comp.reference]
+
+          puts " + #{comp}"
+          add_component comp
+        end
+      end
+    end
+
+    def to_h
+      conf = {}
+
+      conf[:name] = @name if @name
+      conf[:description] = @description if @description
+
+      conf[:Startup] = startups
+
+      components.each do |_ref, comp|
+        if comp.type == I2C
+          conf[I2C] ||= {
+            sdaPin: sda, sclPin: scl, clock: clock, modules: []
+          }
+          conf[I2C][:modules] << comp.config
+        else
+          array = (conf[comp.array_name] ||= [])
+          array << comp.config
+        end
+      end
+      conf
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def to_pretty_json
+      JSON.pretty_generate to_h
+    end
+
+    def inspect
+      "#<#{self.class} '#{name}'>"
+    end
+
+    def to_s
+      components.collect do |_ref, comp|
+        "#{comp.type}:#{comp.name} => #{comp.config}"
+      end.join "\n"
+    end
+  end
+end

data/lib/oschii/device.rb

@@ -6,6 +6,7 @@ require 'faye/websocket'
 require 'eventmachine'
 require 'byebug'
 
+require_relative 'config'
 module Oschii
   DeviceUnavailable = Class.new(StandardError)
   NoConnection = Class.new(StandardError)
@@ -145,7 +146,7 @@ module Oschii
     end
 
     def config
-      @config ||= Oschii::Config.parse(raw_config)
+      @config ||= Oschii::Config.new(raw_config)
     end
 
     def clear!

data/lib/oschii/parser.rb

@@ -0,0 +1,40 @@
+require_relative 'config'
+
+puts Oschii::LOGO
+puts '   P A R S E R'
+puts
+
+if ARGV.empty?
+  puts 'Please specify an input file'
+  exit 0
+end
+
+input_filename = ARGV[0]
+input_filename = "#{input_filename}.json" unless input_filename.end_with? '.json'
+
+unless File.exists? input_filename
+  puts "File '#{input_filename}' not found"
+  exit 0
+end
+
+output_filename = ARGV[1] || "#{input_filename.gsub('.json', '')}_output.json"
+output_filename = "#{output_filename}.json" unless output_filename.end_with? '.json'
+
+begin
+  puts "Parsing '#{input_filename}'...."
+  puts
+  conf = Oschii::Config.from_file(input_filename)
+rescue Oschii::TemplateError => e
+  puts
+  puts "ERROR! #{e.message}"
+  puts
+  exit 1
+end
+
+puts
+puts "Writing '#{output_filename}'...."
+puts
+File.write(output_filename, conf.to_pretty_json)
+
+puts 'OK'
+puts

data/lib/oschii/session.rb

@@ -5,3 +5,15 @@ include Oschii
 if ENV['OSCHII_AUTO_POPULATE']
   populate
 end
+
+if ENV['OSCHII_AUTO_LOOKUP']
+  def method_missing(m, *args, &block)
+    return if @cloud.nil?
+
+    node = cloud.get(m)
+
+    return node unless node.nil?
+
+    raise NameError
+  end
+end

data/lib/oschii/template.rb

@@ -0,0 +1,96 @@
+module Oschii
+  class Template
+    def initialize(config, name = nil)
+      @config = config
+      @name = name || config['name']
+      @params = {}
+      @embedded_customs = []
+      @startups = []
+    end
+
+    attr_reader :config, :name, :params, :embedded_customs, :startups
+
+    def fill_params(json)
+      string = json.to_json
+
+      params.each do |name, value|
+        case value
+        when Integer, Float, TrueClass, FalseClass
+          string.gsub! "\"${#{name}}\"", "#{value}"
+        else
+          string.gsub! "${#{name}}", "#{value}"
+        end
+      end
+
+      JSON.parse(string)
+    end
+
+    def build_components(custom_config, name_prefix = '')
+      bind_params custom_config
+
+      @embedded_customs = []
+
+      config["Customs"]&.each do |inner_custom_def|
+        @embedded_customs << fill_params(inner_custom_def)
+      end
+
+      BASIC_COMPONENT_TYPES.map do |type|
+        config["#{type}s"]&.map do |comp|
+          comp_conf = comp.dup
+
+          comp_conf['name'] = "#{name_prefix}#{custom_config['name']}_#{comp['name']}"
+
+          string = comp_conf.to_json
+
+          params.each do |name, value|
+            case value
+            when Integer, Float, TrueClass, FalseClass
+              string.gsub! "\"${#{name}}\"", "#{value}"
+            else
+              string.gsub! "${#{name}}", "#{value}"
+            end
+          end
+
+          # Expand in-Template Component References
+          string.gsub!(':@', ":#{name_prefix}#{custom_config['name']}_")
+
+          Component.new(type, JSON.parse(string))
+        end
+      end.flatten.compact
+    end
+
+    def param_names
+      config.to_s.scan(/\$\{\w+}/).collect do |tag|
+        tag.gsub('${', '').gsub('}', '')
+      end.uniq
+    end
+
+
+    def bind_params(custom_config)
+      missing_params = []
+      param_names.each do |param|
+        value = custom_config[param]
+        if value
+          params[param] = value
+        else
+          missing_params << param
+        end
+      end
+
+      unless missing_params.empty?
+        missing_params.each do |param|
+          puts "No value for '#{param}'"
+        end
+        raise Oschii::TemplateError, "Custom:#{custom_config['name']}: Missing parameters"
+      end
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class} '#{name}'>"
+    end
+  end
+end

data/lib/oschii/version.rb

@@ -1,3 +1,3 @@
 module Oschii
-  VERSION = '0.0.1'
+  VERSION = '0.0.6'
 end

data/lib/oschii.rb

@@ -11,8 +11,7 @@ module Oschii
   ╔═╗┌─┐┌─┐┬ ┬┬┬
   ║ ║└─┐│  ├─┤││
   ╚═╝└─┘└─┘┴ ┴┴┴
-  -- R U B Y ---
-  #{VERSION.center(14)}
+  #{"ruby gem #{VERSION}".center(14)}
 
 ".freeze
 
@@ -40,16 +39,6 @@ module Oschii
     @serial ||= cloud.find_serial
   end
 
-  def method_missing(m, *args, &block)
-    return if @cloud.nil?
-
-    node = cloud.get(m)
-
-    return node unless node.nil?
-
-    raise NameError
-  end
-
   def send_osc(ip, address, *values, port: 3333)
     OSC::Client.new(ip, port).send(OSC::Message.new(address, *values.to_a))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oschii_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Barri Mason
@@ -104,12 +104,16 @@ files:
 - Gemfile.lock
 - lib/oschii.rb
 - lib/oschii/cloud.rb
+- lib/oschii/component.rb
+- lib/oschii/config.rb
 - lib/oschii/device.rb
 - lib/oschii/http_device.rb
 - lib/oschii/osc_monitor.rb
+- lib/oschii/parser.rb
 - lib/oschii/serial_device.rb
 - lib/oschii/servlets.rb
 - lib/oschii/session.rb
+- lib/oschii/template.rb
 - lib/oschii/version.rb
 homepage: https://rubygems.org/gems/oschii_ruby
 licenses: