netlinx-workspace 0.2.0

data/lib/netlinx/project.rb

@@ -0,0 +1,83 @@
+require 'netlinx/system'
+
+module NetLinx
+  # A collection of NeTLinx systems.
+  # Workspace -> Project -> System
+  class Project
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :dealer
+    attr_accessor :designer
+    attr_accessor :sales_order
+    attr_accessor :purchase_order
+    attr_accessor :workspace        # A reference to the project's parent workspace.
+    attr_accessor :systems
+    
+    def initialize(**kvargs)
+      @name           = kvargs.fetch :name,           ''
+      @description    = kvargs.fetch :description,    ''
+      @dealer         = kvargs.fetch :dealer,         ''
+      @designer       = kvargs.fetch :designer,       ''
+      @sales_order    = kvargs.fetch :sales_order,    ''
+      @purchase_order = kvargs.fetch :purchase_order, ''
+      @workspace      = kvargs.fetch :workspace,      nil
+      
+      @systems = []
+      
+      project_element = kvargs.fetch :element, nil
+      parse_xml_element project_element if project_element
+    end
+    
+    # Alias to add a system.
+    def <<(system)
+      @systems << system
+      system.project = self
+    end
+    
+    # Returns the project name.
+    def to_s
+      @name
+    end
+    
+    # Returns true if the project contains the specified file.
+    def include?(file)
+      included = false
+      
+      systems.each do |system|
+        included = system.include? file
+        break if included
+      end
+      
+      included
+    end
+    
+    # Compile all systems in this project.
+    def compile
+      compiler_results = []
+      @systems.each {|system| compiler_results << (system.compile).first}
+      compiler_results
+    end
+    
+    private
+    
+    def parse_xml_element(project)
+      # Load project params.
+      @name           = project.elements['Identifier'].text.strip
+      @designer       = project.elements['Designer'].text
+      @dealer         = project.elements['DealerID'].text
+      @sales_order    = project.elements['SalesOrder'].text
+      @purchase_order = project.elements['PurchaseOrder'].text
+      @description    = project.elements['Comments'].text
+        
+      # Load systems.
+      project.each_element 'System' do |e|
+        system = NetLinx::System.new \
+          element: e,
+          project:  self
+          
+        @systems << system
+      end
+    end
+    
+  end
+end

data/lib/netlinx/system.rb

@@ -0,0 +1,122 @@
+require 'netlinx/system_file'
+
+module NetLinx
+  # A collection of resources loaded onto a NetLinx master.
+  # Workspace -> Project -> System
+  class System
+    attr_accessor :name
+    attr_accessor :id
+    attr_accessor :description
+    attr_accessor :project        # A reference to the system's parent project.
+    attr_accessor :files
+    
+    def initialize(**kvargs)
+      @name        = kvargs.fetch :name,        ''
+      @id          = kvargs.fetch :id,          ''
+      @description = kvargs.fetch :description, ''
+      @project     = kvargs.fetch :project,     nil
+      
+      @files = []
+      
+      @compiler_target_files  = []
+      @compiler_include_paths = []
+      @compiler_module_paths  = []
+      @compiler_library_paths = []
+      
+      system_element = kvargs.fetch :element, nil
+      parse_xml_element system_element if system_element
+    end
+    
+    # Alias to add a file.
+    def <<(file)
+      @files << file
+      file.system = self
+    end
+    
+    # Returns the system name.
+    def to_s
+      @name
+    end
+    
+    # See Test::NetLinx::Compilable.
+    def compiler_target_files
+      @files
+        .select {|f| f.type == 'MasterSrc'}
+        .map {|f| File.expand_path \
+          f.path,
+          f.system.project.workspace.path
+        }
+    end
+    
+    # See Test::NetLinx::Compilable.
+    def compiler_include_paths
+      @files
+        .select {|f| f.type == 'Include'}
+        .map {|f| File.expand_path \
+          File.dirname(f.path),
+          f.system.project.workspace.path
+        }
+    end
+    
+    # See Test::NetLinx::Compilable.
+    def compiler_module_paths
+      @files
+        .select {|f| f.type == 'Module' || f.type == 'TKO' || f.type == 'DUET'}
+        .map {|f| File.expand_path \
+          File.dirname(f.path),
+          f.system.project.workspace.path
+        }
+    end
+    
+    # See Test::NetLinx::Compilable.
+    def compiler_library_paths
+      []
+    end
+    
+    # Returns true if the project contains the specified file. 
+    def include?(file)
+      included = false
+      
+      @files.each do |f|
+        name_included = f.name.downcase.eql? file.downcase
+        
+        # TODO: This should probably be relative to the workspace path,
+        #       which can be found by traversing @project, @workspace.
+        path_included = file.gsub(/\\/, '/').include? f.path.gsub(/\\/, '/')
+        
+        included = name_included || path_included
+        break if included
+      end
+      
+      included
+    end
+    
+    # Compile this system.
+    def compile
+      # The compiler dependency is only needed if this method is called.
+      require 'netlinx/compiler'
+      
+      compiler = NetLinx::Compiler.new
+      compiler.compile self
+    end
+    
+    private
+    
+    def parse_xml_element(system)
+      # Load system params.
+      @name        = system.elements['Identifier'].text.strip
+      @id          = system.elements['SysID'].text.strip.to_i
+      @description = system.elements['Comments'].text
+      
+      # Create system files.
+      system.each_element 'File' do |e|
+        system_file = NetLinx::SystemFile.new \
+          element: e,
+          system:  self
+        
+        @files << system_file
+      end
+    end
+    
+  end
+end

data/lib/netlinx/system_file.rb

@@ -0,0 +1,36 @@
+module NetLinx
+  class SystemFile
+    attr_accessor :name
+    attr_accessor :type
+    attr_accessor :path
+    attr_accessor :description
+    attr_accessor :system
+    
+    def initialize(**kvargs)
+      @name        = kvargs.fetch :name,        ''
+      @type        = kvargs.fetch :type,        ''
+      @path        = kvargs.fetch :path,        ''
+      @description = kvargs.fetch :description, ''
+      @system      = kvargs.fetch :system,      nil
+      
+      system_file_element = kvargs.fetch :element, nil
+      parse_xml_element system_file_element if system_file_element
+    end
+    
+    # Print the SystemFile's name.
+    def to_s
+      @name
+    end
+    
+    private
+    
+    def parse_xml_element(system_file)
+      # Load system file params.
+      @name        = system_file.elements['Identifier'].text.strip
+      @type        = system_file.attributes['Type']
+      @path        = system_file.elements['FilePathName'].text.strip
+      @description = system_file.elements['Comments'].text
+    end
+    
+  end
+end

data/lib/netlinx/workspace.rb

@@ -0,0 +1,89 @@
+require 'rexml/document'
+require 'netlinx/project'
+
+module NetLinx
+  
+  # A NetLinx Studio workspace.
+  # Collection of projects.
+  # Workspace -> Project -> System
+  class Workspace
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :projects
+    attr_reader   :file
+    
+    def initialize(**kvargs)
+      @name        = kvargs.fetch :name, ''
+      @description = kvargs.fetch :description, ''
+      @projects    = []
+      
+      @file = kvargs.fetch :file, nil
+      load_workspace @file if @file
+    end
+    
+    # Alias to add a project.
+    def <<(project)
+      @projects << project
+      project.workspace = self
+    end
+    
+    # Returns the name of the workspace.
+    def to_s
+      @name
+    end
+    
+    # Directory the workspace resides in.
+    def path
+      File.dirname @file if @file
+    end
+    
+    # Returns true if the workspace contains the specified file.
+    def include?(file)
+      included = false
+      
+      projects.each do |project|
+        included = project.include? file
+        break if included
+      end
+      
+      included
+    end
+    
+    # Compile all projects in this workspace.
+    def compile
+      compiler_results = []
+      
+      @projects.each do |project|
+        project.compile.each {|result| compiler_results << result}
+      end
+      
+      compiler_results
+    end
+    
+    private
+    
+    # Load the workspace from a given NetLinx Studio .apw file.
+    def load_workspace(file)
+      raise LoadError, "File does not exist at:\n#{file}" unless File.exists? file
+      
+      doc = nil
+      File.open file, 'r' do |f|
+        doc = REXML::Document.new f
+      end
+      
+      # Load workspace params.
+      @name        = doc.elements['/Workspace/Identifier'].text.strip
+      @description = doc.elements['/Workspace/Comments'].text
+      
+      # Load projects.
+      doc.each_element '/Workspace/Project' do |e|
+        project = NetLinx::Project.new \
+          element:   e,
+          workspace: self
+          
+        @projects << project
+      end
+    end
+    
+  end
+end

data/lib/netlinx-workspace.rb

@@ -0,0 +1 @@
+require 'netlinx/workspace'

data/license.txt

@@ -0,0 +1,13 @@
+Copyright 2013 Alex McLain
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: netlinx-workspace
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex McLain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netlinx-compile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- license.txt
+- README.html
+- lib/netlinx/compile/extension/apw.rb
+- lib/netlinx/project.rb
+- lib/netlinx/system.rb
+- lib/netlinx/system_file.rb
+- lib/netlinx/workspace.rb
+- lib/netlinx-workspace.rb
+- doc/created.rid
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/search.js
+- doc/js/searcher.js
+- doc/js/search_index.js
+- doc/NetLinx/Compile/Extension/APW.html
+- doc/NetLinx/Compile/Extension.html
+- doc/NetLinx/Compile.html
+- doc/NetLinx/Project.html
+- doc/NetLinx/System.html
+- doc/NetLinx/SystemFile.html
+- doc/NetLinx/Workspace.html
+- doc/NetLinx.html
+- doc/rdoc.css
+- doc/table_of_contents.html
+homepage: https://sourceforge.net/projects/netlinx-workspace/
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A library for working with AMX NetLinx Studio workspaces in Ruby.
+test_files: []