netlinx-workspace 0.3.0 → 1.0.0

data/lib/netlinx/workspace/system_file.rb

@@ -0,0 +1,98 @@
+require 'rexml/document'
+
+module NetLinx
+  # A file node in a NetLinx::System.
+  class SystemFile
+    attr_accessor :system
+    attr_accessor :name
+    attr_accessor :path
+    attr_accessor :description
+    attr_accessor :type
+    # Array of D:P:S strings that this file maps to.
+    attr_accessor :devices
+    
+    # @option kwargs [NetLinx::System] :system This file's parent system node.
+    # @option kwargs [String] :name ('') Identifiable name.
+    # @option kwargs [String] :path ('') Relative file path.
+    # @option kwargs [String] :description ('')
+    # @option kwargs [:master,:source,:include,:duet,:tko,:module,:ir,:tp4,:tp5] :type (:master)
+    def initialize **kwargs
+      @system      = kwargs.fetch :system,      nil
+      
+      @name        = kwargs.fetch :name,        ''
+      @path        = kwargs.fetch :path,        ''
+      @description = kwargs.fetch :description, ''
+      @type        = kwargs.fetch :type,        :master
+      
+      @devices = []
+      
+      system_file_element = kwargs.fetch :element, nil
+      parse_xml_element system_file_element if system_file_element
+    end
+    
+    # Add a device that uses this file.
+    # @param device [String] D:P:S string.
+    def << device
+      devices << device
+    end
+    
+    # @return the SystemFile's name.
+    def to_s
+      @name
+    end
+    
+    # @return [REXML::Element] an XML element representing this file.
+    def to_xml_element
+      REXML::Element.new('File').tap do |file|
+        file.attributes['CompileType'] = 'Netlinx'
+        
+        file.attributes['Type'] = type_lookup[type]
+        
+        file.add_element('Identifier').tap { |e| e.text = name }
+        file.add_element('FilePathName').tap { |e| e.text = path }
+        file.add_element('Comments').tap { |e| e.text = description }
+        
+        @devices.each do |dps|
+          file.add_element('DeviceMap').tap do |e|
+            text = dps.include?(':') ? "Custom [#{dps}]" : dps
+            e.attributes['DevAddr'] = text
+            e.add_element('DevName').text = text
+          end
+        end
+      end
+    end
+    
+    private
+    
+    # @return lookup table for symbol to XML NetLinx file types.
+    def type_lookup
+      {
+        master:  'MasterSrc',
+        source:  'Source',
+        include: 'Include',
+        duet:    'DUET',
+        tko:     'TKO',
+        module:  'Module',
+        ir:      'IR',
+        tp4:     'TP4',
+        tp5:     'TP5',
+      }
+    end
+    
+    def parse_xml_element system_file
+      # Load system file params.
+      @name        = system_file.elements['Identifier'].text.strip || ''
+      @type        = type_lookup.invert[system_file.attributes['Type']] || :master
+      @path        = system_file.elements['FilePathName'].text.strip || ''
+      @description = system_file.elements['Comments'].text || ''
+      
+      system_file.each_element 'DeviceMap' do |device_map|
+        dev_addr = device_map.attributes['DevAddr']
+        @devices.push dev_addr.include?(':') ?
+          dev_addr.match(/.*?\[(.*?)\]/)[1] :
+          dev_addr
+      end
+    end
+    
+  end
+end

data/lib/netlinx/workspace/yaml.rb

@@ -0,0 +1,217 @@
+require 'yaml'
+
+module NetLinx
+  class Workspace
+    # Configure NetLinx workspaces with YAML.
+    class YAML
+      
+      # @return {NetLinx::Workspace}
+      def self.parse string
+        yaml = ::YAML.load string
+        yaml_systems = yaml['systems']
+        
+        workspace = NetLinx::Workspace.new
+        
+        if yaml_systems
+          # Load systems into an implicit project and workspace.
+          workspace.name = yaml_systems.first['name']
+          project = NetLinx::Project.new name: yaml_systems.first['name']
+          workspace << project
+          
+          parse_systems project, yaml_systems
+        else
+          # An explicit workspace is defined.
+          workspace.name = yaml['name'] if yaml['name']
+          workspace.description = yaml['description'] if yaml['description']
+          
+          yaml_projects = yaml['projects']
+          yaml_projects.each do |yaml_project|
+            workspace << NetLinx::Project.new.tap do |project|
+              project.name           = yaml_project['name'] if yaml_project['name']
+              project.designer       = yaml_project['designer'].to_s if yaml_project['designer']
+              project.dealer         = yaml_project['dealer'].to_s if yaml_project['dealer']
+              project.sales_order    = yaml_project['sales_order'].to_s if yaml_project['sales_order']
+              project.purchase_order = yaml_project['purchase_order'].to_s if yaml_project['purchase_order']
+              project.description    = yaml_project['description'] if yaml_project['description']
+              
+              parse_systems project, yaml_project['systems']
+            end
+          end
+        end
+        
+        # Ensure exactly one system in the workspace is set active.
+        a_system_is_active = false
+        workspace.projects.each do |project|
+          project.systems.each do |system|
+            if a_system_is_active
+              system.active = false
+              next
+            else
+              a_system_is_active = true if system.active
+            end
+          end
+        end
+        
+        # No active systems. Set the first one active automatically.
+        workspace.projects.first.systems.first.active = true \
+          unless a_system_is_active \
+          or workspace.projects.empty? \
+          or workspace.projects.first.systems.empty?
+        
+        workspace
+      end
+      
+      # @return {NetLinx::Workspace}
+      def self.parse_file file
+        parse File.open(file, 'r').read
+      end
+      
+      private
+      
+      # @return [String] File name without the path or extension.
+      def self.to_file_name path
+        File.basename(path).gsub(/\.\w+\z/, '')
+      end
+      
+      def self.add_file_to_system system, file_path, type
+        puts "WARNING: Nonexistent file #{file_path}" unless File.exists? file_path
+        
+        NetLinx::SystemFile.new(
+          path: file_path,
+          name: to_file_name(file_path),
+          type: type
+        ).tap { |system_file| system << system_file }
+      end
+      
+      def self.attach_devices system_file, yaml_node
+        devices = yaml_node['dps']
+        return unless devices
+        
+        devices = [devices] unless devices.is_a? Array
+        
+        system_file.devices = devices.map do |d|
+          # Convert to string if YAML parses the DPS as date/time.
+          d.is_a?(String) ? d : [d / 3600, d % 3600 / 60, d % 60].join(':')
+        end
+      end
+      
+      def self.parse_connection_node system, connection_node
+        case connection_node
+        when String
+          if connection_node =~ /\Acom\d+(?::|\z)/i
+            # Serial Connection
+            com_port, baud_rate = connection_node.split ':'
+            system.com_port = com_port.downcase.to_sym
+            system.baud_rate = baud_rate.to_i if baud_rate
+          else
+            # IP Connection
+            ip_address, ip_port = connection_node.split ':'
+            system.ip_address = ip_address
+            system.ip_port = ip_port.to_i if ip_port
+          end
+        when Hash
+          if connection_node['host']
+            # IP Connection
+            system.ip_address = connection_node['host']
+            system.ip_port = connection_node['port'] if connection_node['port']
+          else
+            # Serial Connection
+            system.com_port = connection_node['port'].downcase.to_sym
+            system.baud_rate = connection_node['baud_rate'] if connection_node['baud_rate']
+            system.data_bits = connection_node['data_bits'] if connection_node['data_bits']
+            system.stop_bits = connection_node['stop_bits'] if connection_node['stop_bits']
+            system.parity = connection_node['parity'].downcase.to_sym if connection_node['parity']
+          end
+        end
+      end
+      
+      def self.parse_systems project, yaml_systems
+        yaml_systems.each do |yaml_system|
+          project << NetLinx::System.new.tap do |system|
+            system.name = yaml_system['name'] if yaml_system['name']
+            system.active = yaml_system['active'] || false
+            system.id = yaml_system['id'] if yaml_system['id']
+            system.description = yaml_system['description'] if yaml_system['description']
+            
+            root = yaml_system['root'] # File system root directory.
+            
+            parse_connection_node system, yaml_system['connection']
+            
+            # Auto-include master source file.
+            master_src_path = yaml_system['axs'] || "#{system.name}.axs"
+            master_src_path = "#{root}/#{master_src_path}" if root
+            add_file_to_system system, master_src_path, :master
+            
+            yaml_excluded_files = yaml_system['excluded_files']
+            
+            # Auto-include 'include' directory.
+            include_path = 'include/**/*.axi'
+            include_path = "#{root}/#{include_path}" if root
+            include_files = Dir[include_path]
+            include_files -= Dir[*yaml_excluded_files] if yaml_excluded_files
+            include_files.each do |file_path|
+              add_file_to_system system, file_path, :include
+            end
+            
+            # Additional include paths.
+            yaml_files = yaml_system['includes']
+            if yaml_files
+              files = Dir[*yaml_files]
+              files -= Dir[*yaml_excluded_files] if yaml_excluded_files
+              
+              files.each do |file_path|
+                add_file_to_system system, file_path, :include
+              end
+            end
+            
+            # Auto-include 'module' directory.
+            module_path = 'module/**/*.{tko,jar}'
+            module_path = "#{root}/#{module_path}" if root
+            module_files = Dir[module_path]
+            module_files -= Dir[*yaml_excluded_files] if yaml_excluded_files
+            module_files.each do |file_path|
+              add_file_to_system system, file_path, 
+                (File.extname(file_path) == '.jar') ?
+                  :duet :
+                  File.extname(file_path)[1..-1].downcase.to_sym
+            end
+            
+            # Additional module paths.
+            yaml_files = yaml_system['modules']
+            if yaml_files
+              files = Dir[*yaml_files]
+              files -= Dir[*yaml_excluded_files] if yaml_excluded_files
+              
+              files.each do |file_path|
+                add_file_to_system system, file_path, File.extname(file_path)[1..-1].downcase.to_sym
+              end
+            end
+            
+            # Touch panel files.
+            yaml_touch_panels = yaml_system['touch_panels']
+            if yaml_touch_panels
+              yaml_touch_panels.each do |yaml_touch_panel|
+                file_path = "touch_panel/#{yaml_touch_panel['path']}"
+                file_path = "#{root}/#{file_path}" if root
+                add_file_to_system(system, file_path, File.extname(file_path)[1..-1].downcase.to_sym)
+                  .tap { |file| attach_devices file, yaml_touch_panel }
+              end
+            end
+            
+            # IR files.
+            yaml_ir_files = yaml_system['ir']
+            if yaml_ir_files
+              yaml_ir_files.each do |yaml_ir|
+                file_path = "ir/#{yaml_ir['path']}"
+                file_path = "#{root}/#{file_path}" if root
+                add_file_to_system(system, file_path, :ir)
+                  .tap { |file| attach_devices file, yaml_ir }
+              end
+            end
+          end
+        end
+      end
+      
+    end
+  end
+end

data/license.txt

@@ -1,4 +1,4 @@
-Copyright 2013 Alex McLain
+Copyright 2013-2015 Alex McLain
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netlinx-workspace
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex McLain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netlinx-compile
@@ -16,70 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: fivemat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -111,20 +125,28 @@ dependencies:
 description: This library provides a developer API for working with NetLinx Studio
   workspaces in Ruby. It also adds compiler support to the NetLinx Compile gem for
   these workspaces.
-email: alex@alexmclain.com
-executables: []
+email:
+- alex@alexmclain.com
+executables:
+- netlinx-workspace
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/netlinx-workspace
 - doc/NetLinx.html
 - doc/NetLinx/Compile.html
 - doc/NetLinx/Compile/Extension.html
 - doc/NetLinx/Compile/Extension/APW.html
 - doc/NetLinx/Project.html
+- doc/NetLinx/Rake.html
+- doc/NetLinx/Rake/Workspace.html
+- doc/NetLinx/Rake/Workspace/CreateWorkspaceConfig.html
+- doc/NetLinx/Rake/Workspace/GenerateAPW.html
 - doc/NetLinx/System.html
 - doc/NetLinx/SystemFile.html
 - doc/NetLinx/Workspace.html
+- doc/NetLinx/Workspace/YAML.html
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css
@@ -140,14 +162,17 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
-- lib/netlinx-workspace.rb
 - lib/netlinx/compile/extension/apw.rb
-- lib/netlinx/project.rb
-- lib/netlinx/system.rb
-- lib/netlinx/system_file.rb
+- lib/netlinx/rake/workspace.rb
+- lib/netlinx/rake/workspace/create_workspace_config.rb
+- lib/netlinx/rake/workspace/generate_apw.rb
 - lib/netlinx/workspace.rb
+- lib/netlinx/workspace/project.rb
+- lib/netlinx/workspace/system.rb
+- lib/netlinx/workspace/system_file.rb
+- lib/netlinx/workspace/yaml.rb
 - license.txt
-homepage: https://sourceforge.net/projects/netlinx-workspace/
+homepage: https://github.com/amclain/netlinx-workspace
 licenses:
 - Apache 2.0
 metadata: {}
@@ -167,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A library for working with AMX NetLinx Studio workspaces in Ruby.