netlinx-erb 1.0.0 → 1.1.0

data/lib/netlinx/rake/erb.rb

@@ -1,6 +1,8 @@
 
 require 'yard'
 require 'netlinx/rake/compile'
+require 'netlinx/rake/workspace/create_workspace_config'
+require 'netlinx/rake/workspace/generate_apw'
 require 'netlinx/rake/src'
 
 require_relative 'erb/generate_erb'
@@ -12,7 +14,10 @@ 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_erb
+NetLinx::Rake::ERB::GenerateRPC.new :generate_rpc => :generate_apw
+
+NetLinx::Rake::Workspace::CreateWorkspaceConfig.new
+NetLinx::Rake::Workspace::GenerateAPW.new :generate_apw => :generate_erb
 
 # Generate Ruby documentation.
 YARD::Rake::YardocTask.new :doc do |t|

data/license.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Alex McLain and Joe McIlvain
+Copyright (c) 2014-2015 Alex McLain and Joe McIlvain
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netlinx-erb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex McLain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netlinx-compile
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: netlinx-src
   requirement: !ruby/object:Gem::Requirement
@@ -155,11 +155,13 @@ description: A code generation utility for AMX NetLinx control systems.
 email:
 - alex@alexmclain.com
 - joe.eli.mac@gmail.com
-executables: []
+executables:
+- netlinx-erb
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/netlinx-erb
 - doc/Array.html
 - doc/Hash.html
 - doc/HashHelpers.html
@@ -202,10 +204,7 @@ files:
 - lib/netlinx/rake/erb/generate_rpc.rb
 - lib/netlinx/rake/erb/lines.rb
 - license.txt
-- template/Gemfile
-- template/README.md
-- template/Rakefile
-- template/rpc.axi
+- template.zip
 homepage: https://github.com/amclain/netlinx-erb
 licenses:
 - MIT
@@ -226,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A code generation utility for AMX NetLinx control systems.

data/template/Gemfile

@@ -1,9 +0,0 @@
-source "https://rubygems.org"
-
-gem 'netlinx-erb'
-
-# Development Tools
-# -----------------
-# gem 'rspec'
-# gem 'rspec-its'
-# gem 'fivemat'

data/template/README.md

@@ -1,130 +0,0 @@
-This file can be viewed as HTML at:
-doc/index.html
-
-----------------------------------------------------------------------
-
-This project uses inline Ruby scripting (ERB) to generate substantial portions
-of the NetLinx files. These files end in ***.axi.erb***, and the `.erb` extension
-is dropped when the script is compiled.
-
-***MODIFICATIONS*** to the project should be performed in the `.axi.erb` files, as
-their `.axi` counterparts are regenerated when the project is compiled.
-This means that proficiency in the Ruby programming language is *REQUIRED*
-to make changes to this project. There are plenty of online tutorials and
-books about Ruby for a programmer to learn the skills required to maintain
-this project within several weeks. See the development section below.
-
-***COMPILING*** the project is a simple process with the right
-build tools, which are listed below.
-
-----------------------------------------------------------------------
-
-## Build Tools
-
-
-In addition to the AMX developer tools, the following are required:
-
-
-### NetLinx ERB
-
-[NetLinx ERB](https://github.com/amclain/netlinx-erb) is the code generation
-framework used by this project. The installation process below should
-automatically install this package. For information regarding its usage, see:
-
-* [Readme](https://github.com/amclain/netlinx-erb/blob/master/README.md)
-* [API Documentation](http://www.rubydoc.info/gems/netlinx-erb)
-
-### Ruby Installer
-
-> http://rubyinstaller.org/downloads
-
-Ruby 2.0.0-p451 was used for this project.
-Higher versions will probably be compatible.
-
-The DEVKIT listed on the download page should
-also be installed.
-
-
-### Ruby Gems
-
-Rake and Bundler are required.
-
-From the command line:
-
-	gem install rake bundler
-
-
-### Building The Project
-
-From the command line in the project's `amx` directory:
-
-	bundle
-	bundle exec rake
-
-The files will be auto-generated and compiled, at which point
-they can be loaded onto the master with the AMX FileTransfer2
-utility or NetLinx Studio.
-
-
-
-## Development
-
-Although it is possible to maintain this project with a standard text
-editor, or possibly NetLinx Studio, it is far easier with a few
-additional tools.
-
-
-### Sublime Text 3
-
-> http://www.sublimetext.com/3
-
-
-### Sublime Text AMX NetLinx Plugin
-
-> http://sourceforge.net/p/sublime-netlinx/wiki/install-via-version-control
-	
-This plugin, available for Sublime Text, allows for syntax highlighting of the
-`.axi.erb` files and makes the inline Ruby blocks significantly easier to view.
-
-Note: At the time of this writing the syntax highlighting is under development
-in the `dev` branch of the plugin repository. However, it will ideally be merged
-into `default` by the time this project needs to be maintained.
-
-
-### Rake
-
-> https://github.com/jimweirich/rake
-
-Installed via `gem install rake`.
-
-This is the program that launches the automated tasks.
-
-	Build system:
-	
-		`bundle exec rake`
-	
-	Run tests, generate doc:
-	
-		`bundle exec test'
-
-
-### RSpec
-
-> https://relishapp.com/rspec
-	
-Installed via `bundle update`.
-
-RSpec is a tool used to run tests on Ruby code, as well as serve as documentation.
-There are many tutorials on	RSpec online, including their website listed above.
-
-
-### Pry
-
-> http://pryrepl.org
-
-Installed via:
-
-	gem install pry
-	gem install rb-readline
-
-Pry is a handy interactive terminal to manipluate running code.

data/template/Rakefile

@@ -1,11 +0,0 @@
-
-# ------------------------------------------------------------
-#   This file contains a set of automated tasks.
-#   See project documentation at: doc/index.html
-#   
-#   Run `rake` from the command line to compile this project.
-#   
-#   Run `rake --task` from the command line to see all
-#   available tasks for this project.
-# ------------------------------------------------------------
-require 'netlinx/rake/erb'

data/template/rpc.axi

@@ -1,148 +0,0 @@
-(***********************************************************
-    Remote Procedure Call (Troubleshoot by calling functions)
-************************************************************)
-/*---------------------------------------------------------------------------
-The MIT License (MIT)
-
-Copyright (c) 2014 Alex McLain and Joe McIlvain
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
----------------------------------------------------------------------------*/
-
-#if_not_defined PS_RPC
-#define PS_RPC 1
-(***********************************************************)
-(* System Type : NetLinx                                   *)
-(***********************************************************)
-(*           DEVICE NUMBER DEFINITIONS GO BELOW            *)
-(***********************************************************)
-DEFINE_DEVICE
-
-#if_not_defined vdvRPC
-// Virtual Debugging Device to receive RPC strings from user on.
-// This can also be overridden in the master source code file if necessary.
-vdvRPC = 34500:1:0;
-#end_if
-
-(***********************************************************)
-(*              CONSTANT DEFINITIONS GO BELOW              *)
-(***********************************************************)
-DEFINE_CONSTANT
-
-(***********************************************************)
-(*                    INCLUDES GO BELOW                    *)
-(***********************************************************)
-
-(***********************************************************)
-(*              DATA TYPE DEFINITIONS GO BELOW             *)
-(***********************************************************)
-DEFINE_TYPE
-
-(***********************************************************)
-(*              VARIABLE DEFINITIONS GO BELOW              *)
-(***********************************************************)
-DEFINE_VARIABLE
-
-(***********************************************************)
-(*         SUBROUTINE/FUNCTION DEFINITIONS GO BELOW        *)
-(***********************************************************)
-
-
-///
-// User input string parsing functions
-
-// Parse and return the name of the function from the given input string 
-define_function char[255] rpc_function_name(char input[])
-{
-    return rpc_get_arg(0, lower_string(input));
-}
-
-// Parse and return the nth argument of the function
-define_function char[255] rpc_get_arg(integer index, char input[])
-{
-    integer start;
-    integer end;
-    integer i;
-    char output[255];
-    
-    end = 0;
-    for (i = 0; i <= index; i++)
-    {
-        start = end;
-        end = find_string(input, ' ', end+1);
-    }
-    
-    return mid_string(input, start+1, end-start-1);
-}
-
-// Parse and return the nth argument of the function as a string (same as rpc_get_arg)
-define_function char[255] rpc_get_arg_s(integer index, char input[])
-{
-    return rpc_get_arg(index, input);
-}
-
-// Parse and return the nth argument of the function as an integer
-define_function integer rpc_get_arg_i(integer index, char input[])
-{
-    return atoi(rpc_get_arg(index, input));
-}
-
-
-///
-// Output logging functions
-
-// Print the string return value of the function call
-define_function rpc_log(char output[])
-{
-    print(LOG_LEVEL_INFO, "'RPC function returned string: ', output");
-}
-
-// Print the string return value of the function call
-define_function rpc_log_s(char output[])
-{
-    print(LOG_LEVEL_INFO, "'RPC function returned string: ', output");
-}
-
-// Print the integer return value of the function call
-define_function rpc_log_i(integer output)
-{
-    print(LOG_LEVEL_INFO, "'RPC function returned integer: ', itoa(output)");
-}
-
-
-(***********************************************************)
-(*                 STARTUP CODE GOES BELOW                 *)
-(***********************************************************)
-DEFINE_START
-
-(***********************************************************)
-(*                   THE EVENTS GO BELOW                   *)
-(***********************************************************)
-DEFINE_EVENT
-
-(***********************************************************)
-(*                 THE MAINLINE GOES BELOW                 *)
-(***********************************************************)
-DEFINE_PROGRAM
-
-(***********************************************************)
-(*                     END OF PROGRAM                      *)
-(*          DO NOT PUT ANY CODE BELOW THIS COMMENT         *)
-(***********************************************************)
-#end_if