netlinx-erb 1.1.0 → 2.0.0

data/doc/method_list.html

@@ -100,35 +100,47 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="NetLinx/ERB/Helpers.html#execute_erb-instance_method" title="NetLinx::ERB::Helpers#execute_erb (method)">#execute_erb</a></span>
-    <small>NetLinx::ERB::Helpers</small>
+    <span class='object_link'><a href="NetLinx/ERB.html#execute-class_method" title="NetLinx::ERB.execute (method)">execute</a></span>
+    <small>NetLinx::ERB</small>
   </li>
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="NetLinx/ERB.html#generate_axi_files_from_template-class_method" title="NetLinx::ERB.generate_axi_files_from_template (method)">generate_axi_files_from_template</a></span>
+    <small>NetLinx::ERB</small>
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#generate_constant_ivars-instance_method" title="NetLinx::ERB::Helpers#generate_constant_ivars (method)">#generate_constant_ivars</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#generate_variable_ivars-instance_method" title="NetLinx::ERB::Helpers#generate_variable_ivars (method)">#generate_variable_ivars</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#group-instance_method" title="NetLinx::ERB::Helpers#group (method)">#group</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#hiqnet_empty-instance_method" title="NetLinx::ERB::Helpers#hiqnet_empty (method)">#hiqnet_empty</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateERB.html#initialize-instance_method" title="NetLinx::Rake::ERB::GenerateERB#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::ERB::GenerateERB</small>
+  </li>
+  
+
   <li class="r2 ">
     <span class='object_link'><a href="NetLinx/Rake/ERB/Lines.html#initialize-instance_method" title="NetLinx::Rake::ERB::Lines#initialize (method)">#initialize</a></span>
     <small>NetLinx::Rake::ERB::Lines</small>
@@ -136,14 +148,14 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateRPC.html#initialize-instance_method" title="NetLinx::Rake::ERB::GenerateRPC#initialize (method)">#initialize</a></span>
-    <small>NetLinx::Rake::ERB::GenerateRPC</small>
+    <span class='object_link'><a href="NetLinx/Rake/ERB/Push.html#initialize-instance_method" title="NetLinx::Rake::ERB::Push#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::ERB::Push</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateERB.html#initialize-instance_method" title="NetLinx::Rake::ERB::GenerateERB#initialize (method)">#initialize</a></span>
-    <small>NetLinx::Rake::ERB::GenerateERB</small>
+    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateRPC.html#initialize-instance_method" title="NetLinx::Rake::ERB::GenerateRPC#initialize (method)">#initialize</a></span>
+    <small>NetLinx::Rake::ERB::GenerateRPC</small>
   </li>
   
 
@@ -154,8 +166,8 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateERB.html#name-instance_method" title="NetLinx::Rake::ERB::GenerateERB#name (method)">#name</a></span>
-    <small>NetLinx::Rake::ERB::GenerateERB</small>
+    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateRPC.html#name-instance_method" title="NetLinx::Rake::ERB::GenerateRPC#name (method)">#name</a></span>
+    <small>NetLinx::Rake::ERB::GenerateRPC</small>
   </li>
   
 
@@ -166,66 +178,72 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateRPC.html#name-instance_method" title="NetLinx::Rake::ERB::GenerateRPC#name (method)">#name</a></span>
-    <small>NetLinx::Rake::ERB::GenerateRPC</small>
+    <span class='object_link'><a href="NetLinx/Rake/ERB/Push.html#name-instance_method" title="NetLinx::Rake::ERB::Push#name (method)">#name</a></span>
+    <small>NetLinx::Rake::ERB::Push</small>
   </li>
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="NetLinx/Rake/ERB/GenerateERB.html#name-instance_method" title="NetLinx::Rake::ERB::GenerateERB#name (method)">#name</a></span>
+    <small>NetLinx::Rake::ERB::GenerateERB</small>
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#print_constant_hash-instance_method" title="NetLinx::ERB::Helpers#print_constant_hash (method)">#print_constant_hash</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#print_device_hash-instance_method" title="NetLinx::ERB::Helpers#print_device_hash (method)">#print_device_hash</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#print_variable_hash-instance_method" title="NetLinx::ERB::Helpers#print_variable_hash (method)">#print_variable_hash</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Hash.html#remap-instance_method" title="Hash#remap (method)">#remap</a></span>
     <small>Hash</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="String.html#remove_comma_after_last_item-instance_method" title="String#remove_comma_after_last_item (method)">#remove_comma_after_last_item</a></span>
     <small>String</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="NetLinx/ERB/Helpers.html#show_control-instance_method" title="NetLinx::ERB::Helpers#show_control (method)">#show_control</a></span>
     <small>NetLinx::ERB::Helpers</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="NetLinx/ERB/HashHelpers.html#tmpl_suffix-instance_method" title="NetLinx::ERB::HashHelpers#tmpl_suffix (method)">#tmpl_suffix</a></span>
     <small>NetLinx::ERB::HashHelpers</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="NetLinx/ERB/HashHelpers.html#tmpl_var_suffix-instance_method" title="NetLinx::ERB::HashHelpers#tmpl_var_suffix (method)">#tmpl_var_suffix</a></span>
     <small>NetLinx::ERB::HashHelpers</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Array.html#to_h-instance_method" title="Array#to_h (method)">#to_h</a></span>
     <small>Array</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="String.html#to_hiqnet-instance_method" title="String#to_hiqnet (method)">#to_hiqnet</a></span>
     <small>String</small>
   </li>

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Wed Feb 25 14:28:07 2015 by
+  Generated on Mon Jun 29 16:09:05 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.3).
 </div>

data/lib/netlinx-erb.rb

@@ -1,22 +1,5 @@
 
-require 'erb'
+# This file is here for 1.x legacy support of projects that
+# require 'netlinx-erb'
 
-require_relative 'netlinx/erb/erb'
-require_relative 'netlinx/erb/hash_helpers'
-require_relative 'netlinx/erb/helpers'
-require_relative 'netlinx/erb/rpc'
-
-
-# :nodoc:
-module NetLinx
-  # NetLinx code generation.
-  module ERB
-  end
-  
-  # :nodoc:
-  module Rake
-    # NetLinx code generation rake tasks.
-    module ERB
-    end
-  end
-end
+require_relative 'netlinx/erb'

data/lib/netlinx/erb.rb

@@ -0,0 +1,22 @@
+
+require 'erb'
+
+require_relative 'erb/erb'
+require_relative 'erb/hash_helpers'
+require_relative 'erb/helpers'
+require_relative 'erb/rpc'
+
+
+# :nodoc:
+module NetLinx
+  # NetLinx code generation.
+  module ERB
+  end
+  
+  # :nodoc:
+  module Rake
+    # NetLinx code generation rake tasks.
+    module ERB
+    end
+  end
+end

data/lib/netlinx/erb/erb.rb

@@ -5,14 +5,79 @@ module NetLinx
   module ERB
     
     # @return a binding for ERB to evaluate code in.
+    # @yieldparam [Module] module the object whose binding is returned.
     # @example
     #   ERB.new(buffer, nil, '%<>-').result(NetLinx::ERB.binding)
-    def self.binding
-      @b ||= Module.new.instance_eval {
-        extend NetLinx::ERB::Helpers
-        # TODO: _config.rb instance variables should be injected here.
-        binding
-      }
+    def self.binding &block
+      Module.new.tap { |mod|
+        mod.instance_eval { extend NetLinx::ERB::Helpers }
+        block.call mod if block_given?
+      }.instance_eval { binding }
+    end
+    
+    # Run ERB on the given template file.
+    # @param template_file [String] file path
+    # @param binding [Binding]
+    # @return [String] ERB output.
+    # @raise [LoadError] template not found
+    def self.execute template_file, binding: NetLinx::ERB.binding
+      raise LoadError, "Template not found: #{template_file}" unless File.exists? template_file
+      $AUTOGEN_HEADER + ::ERB.new(File.read(template_file), nil, '%<>-')
+        .result(binding)
+    end
+    
+    # Generate AXI files for multiple devices based on a template file.
+    # @param devices [Hash] device names, each with a corresponding hash of
+    #   k/v pairs that will be turned into `@tmpl_(key)` for use in the template.
+    # @option kwargs [String] :template_dir ('./include/ui/template') directory
+    #   containing `.axi.erb.tmpl` template files.
+    # @yieldparam [Module] module the object whose binding is used when evaluating
+    #   the template. This can be used to add customized data during evaluation.
+    # 
+    # @example
+    #   # Sample input for `devices` parameter:
+    #   touch_panels = {
+    #       WALL:     { dps: 10001 },
+    #       FLOATING: { dps: 10002 },
+    #   }
+    def self.generate_axi_files_from_template devices, **kwargs, &block
+      template_dir = File.expand_path kwargs.fetch(:template_dir, './include/ui/template')
+      template_files = Dir["#{template_dir}/*.axi.erb.tmpl"]
+      
+      devices.each do |name, params|
+        b = self.binding do |m|
+          m.instance_eval {
+            extend NetLinx::ERB::Helpers
+            
+            # Generate template instance variables.
+            @tmpl_suffix       = name.to_s
+            @tmpl_var_suffix   = name.to_s.downcase # Variable suffix.
+            
+            @tmpl_suffixes     = devices.keys
+            @tmpl_var_suffixes = devices.keys.map &:downcase
+            
+            params.each { |k,v| instance_variable_set :"@tmpl_#{k.to_s.downcase}", v }
+            
+            @dvTP = "dvTP_#{@tmpl_suffix}"
+            
+            # Inject suffix into Hash for helper methods.
+            Hash.instance_variable_set :@tmpl_suffix, @tmpl_suffix
+            Hash.instance_variable_set :@tmpl_var_suffix, @tmpl_var_suffix
+          }
+          
+          block.call m if block_given?
+        end
+        
+        # Generate files.
+        template_files.each do |path|
+            file_base_name = File.basename(path).gsub(/\..*/, '')
+            output_dir = File.expand_path "#{template_dir}/.."
+            output_path = "#{output_dir}/#{file_base_name}-#{name.to_s.downcase.gsub('_', '-')}.axi"
+            
+            puts '   ' + output_path.gsub(Dir.pwd, '')[1..-1] # Print canonical path.
+            File.write output_path, execute(path, binding: b)
+        end
+      end
     end
     
   end

data/lib/netlinx/erb/helpers.rb

@@ -313,16 +313,6 @@ EOS
         str += "\";"
       end
       
-      # Run ERB on the given template file.
-      # @param template_file [String] file path
-      # @return [String] ERB output.
-      # @raise [LoadError] template not found
-      def execute_erb template_file
-        raise LoadError, "Template not found: #{template_file}" unless File.exists? template_file
-        $AUTOGEN_HEADER + ::ERB.new(File.read(template_file), nil, '%<>-')
-          .result(NetLinx::ERB.binding)
-      end
-      
       
       # @group Other
       

data/lib/netlinx/rake/erb.rb

@@ -8,6 +8,7 @@ require 'netlinx/rake/src'
 require_relative 'erb/generate_erb'
 require_relative 'erb/generate_rpc'
 require_relative 'erb/lines'
+require_relative 'erb/push'
 
 
 task :default=>[:generate_rpc, :check_for_docs, :compile, :pack]
@@ -15,6 +16,7 @@ task :default=>[:generate_rpc, :check_for_docs, :compile, :pack]
 NetLinx::Rake::ERB::Lines.new
 NetLinx::Rake::ERB::GenerateERB.new
 NetLinx::Rake::ERB::GenerateRPC.new :generate_rpc => :generate_apw
+NetLinx::Rake::ERB::Push.new
 
 NetLinx::Rake::Workspace::CreateWorkspaceConfig.new
 NetLinx::Rake::Workspace::GenerateAPW.new :generate_apw => :generate_erb

data/lib/netlinx/rake/erb/generate_erb.rb

@@ -24,14 +24,12 @@ module NetLinx
             puts "------------------------------------"
             
             templates = Dir['include/**/*.erb']
-
-            outputs = templates.map { |str| str.gsub /\.erb$/, '' }
-
+            
             templates.each do |template|
               file_name = template.gsub /\.erb$/, ''
               puts "   #{file_name}"
               
-              header = $AUTOGEN_HEADER = <<-HEADER
+              $AUTOGEN_HEADER = <<-HEADER
 (***********************************************************)
 (*                         WARNING                         *)
 (***********************************************************}
@@ -48,11 +46,9 @@ module NetLinx
 {***********************************************************)
 
           HEADER
-              buffer = header + File.read(template)
               
               File.open file_name, 'w+' do |file|
-                file.write ::ERB.new(buffer, nil, '%<>-')
-                  .result(NetLinx::ERB.binding)
+                  file.write NetLinx::ERB.execute(template)
               end
             end
             

data/lib/netlinx/rake/erb/push.rb

@@ -0,0 +1,65 @@
+
+require 'rake'
+require 'rake/tasklib'
+
+module NetLinx
+  module Rake
+    module ERB
+      
+      # Push project to NetLinx master(s).
+      class Push < ::Rake::TaskLib
+        
+        attr_accessor :name
+        
+        def initialize name = :push
+          @name = name
+          yield self if block_given?
+          
+          desc "Push project to NetLinx master(s)."
+          
+          task(name) do
+            require 'netlinx-erb'
+            
+            puts "Pushing files to master(s)..."
+            
+            # AMX BUG:
+            # Make sure FileTransfer isn't running when FTCon.exe is executed.
+            # FileTransfer2.exe fails to terminate if it fails to connect to
+            # a master controller. This causes the first workspace to remain
+            # in memory, even if the workspace settings are changed and
+            # FileTransfer2.exe is executed again. Sometimes it ignores the
+            # kill signal, so the /f flag is used to force termination.
+            # 
+            # Reported to AMX support on 2015-03-30.
+            # Escalation# 26107
+            # If you encounter this bug, report it to AMX:
+            # Support@amx.com or 1-800-932-6993
+            if Gem.win_platform?
+              IO.popen "taskkill /f /im FileTransfer2.exe 2> nul"
+            else
+              IO.popen "killall -q -s KILL FileTransfer2.exe"
+            end
+            
+            sleep 0.25 # Let process terminate.
+            
+            # TODO: Implement ENV['NETLINX_ACTIVE_SYSTEM_ONLY']
+            # TODO: Implement filtering by type:
+            #   code, master files (code, IR), touch panels,
+            #   specific touch panel/device
+            
+            Dir["*.apw"].first.tap do |apw_file|
+              unless apw_file
+                puts "NetLinx workspace file not found."
+                exit
+              end
+              
+              system "FTCon \"#{apw_file}\""
+              puts "Done.\n\n"
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netlinx-erb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alex McLain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netlinx-compile
@@ -176,6 +176,7 @@ files:
 - doc/NetLinx/Rake/ERB/GenerateERB.html
 - doc/NetLinx/Rake/ERB/GenerateRPC.html
 - doc/NetLinx/Rake/ERB/Lines.html
+- doc/NetLinx/Rake/ERB/Push.html
 - doc/NetLinx/Rake/Lines.html
 - doc/RPC.html
 - doc/String.html
@@ -195,6 +196,7 @@ files:
 - doc/method_list.html
 - doc/top-level-namespace.html
 - lib/netlinx-erb.rb
+- lib/netlinx/erb.rb
 - lib/netlinx/erb/erb.rb
 - lib/netlinx/erb/hash_helpers.rb
 - lib/netlinx/erb/helpers.rb
@@ -203,6 +205,7 @@ files:
 - lib/netlinx/rake/erb/generate_erb.rb
 - lib/netlinx/rake/erb/generate_rpc.rb
 - lib/netlinx/rake/erb/lines.rb
+- lib/netlinx/rake/erb/push.rb
 - license.txt
 - template.zip
 homepage: https://github.com/amclain/netlinx-erb
@@ -225,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A code generation utility for AMX NetLinx control systems.