netlinx-src 0.1.0 → 0.2.0

data/doc/top-level-namespace.html

@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Wed May  7 18:13:49 2014 by
+  Generated on Mon May 12 11:49:57 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.1).
+  0.8.7.4 (ruby-2.0.0).
 </div>
 
   </body>

data/lib/netlinx/rake/src.rb

@@ -0,0 +1,11 @@
+require 'netlinx/rake/src/pack'
+require 'netlinx/rake/src/unpack'
+require 'netlinx/rake/src/srcignore'
+require 'netlinx/rake/src/mkzip'
+require 'netlinx/rake/src/delzip'
+
+NetLinx::Rake::Pack.new
+NetLinx::Rake::Unpack.new
+NetLinx::Rake::SrcIgnore.new
+NetLinx::Rake::MkZip.new
+NetLinx::Rake::DelZip.new

data/lib/netlinx/rake/src/delzip.rb

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/tasklib'
+require 'netlinx/src/package'
+
+module NetLinx
+  module Rake
+    
+    # Delete .src.zip files.
+    class DelZip < ::Rake::TaskLib
+      
+      attr_accessor :name
+      
+      
+      def initialize name = :delzip
+        @name = name
+        
+        yield self if block_given?
+        
+        define
+      end
+      
+      
+      protected
+      
+      def define
+        desc "Delete .src.zip files."
+        
+        task(name) do
+          Dir['*.src.zip'].each { |file| File.delete file }
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/netlinx/rake/src/mkzip.rb

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/tasklib'
+require 'netlinx/src/package'
+
+module NetLinx
+  module Rake
+    
+    # Copy .src file and append .zip.
+    class MkZip < ::Rake::TaskLib
+      
+      attr_accessor :name
+      
+      
+      def initialize name = :mkzip
+        @name = name
+        
+        yield self if block_given?
+        
+        define
+      end
+      
+      
+      protected
+      
+      def define
+        desc "Copy .src file and append .zip."
+        
+        # TODO: Creates the project .src file if it doesn't exist.
+        
+        task(name) do
+          Dir['*.src'].each { |file| NetLinx::SRC::Package.new(file: file).copy_to_zip }
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/netlinx/rake/src/pack.rb

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rake/tasklib'
+require 'netlinx/src/package'
+require 'netlinx/workspace'
+
+module NetLinx
+  module Rake
+    
+    # Generate a NetLinx .src source code package.
+    class Pack < ::Rake::TaskLib
+      
+      attr_accessor :name
+      
+      
+      def initialize name = :pack
+        @name = name
+        
+        yield self if block_given?
+        
+        define
+      end
+      
+      
+      protected
+      
+      def define
+        desc "Generate a NetLinx .src source code package."
+        
+        task(name) do
+          workspace = NetLinx::Workspace.search
+          file_name = 'package.src'  # Default name if workspace not found.
+          
+          if workspace
+            # Create package with workspace name.
+            file_name = File.basename(workspace.file, '.apw') + '.src'
+          end
+          
+          package = NetLinx::SRC::Package.new file: file_name
+          package.pack
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/netlinx/rake/src/srcignore.rb

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/tasklib'
+require 'netlinx/src/package'
+
+module NetLinx
+  module Rake
+    
+    # Generate a default .srcignore file.
+    class SrcIgnore < ::Rake::TaskLib
+      
+      attr_accessor :name
+      
+      
+      def initialize name = :srcignore
+        @name = name
+        
+        yield self if block_given?
+        
+        define
+      end
+      
+      
+      protected
+      
+      def define
+        desc "Generate a default .srcignore file."
+        
+        task(name) do
+          NetLinx::SRC::Package.new.make_srcignore
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/netlinx/rake/src/unpack.rb

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rake/tasklib'
+require 'netlinx/src/package'
+require 'netlinx/workspace'
+
+module NetLinx
+  module Rake
+    
+    # Unpack a NetLinx .src source code package.
+    class Unpack < ::Rake::TaskLib
+      
+      attr_accessor :name
+      
+      
+      def initialize name = :unpack
+        @name = name
+        
+        yield self if block_given?
+        
+        define
+      end
+      
+      
+      protected
+      
+      def define
+        desc "Unpack a NetLinx .src source code package."
+        
+        task(name) do
+          workspace = NetLinx::Workspace.search
+          file_name = 'package.src'  # Default name if workspace not found.
+          
+          if workspace
+            # Create package with workspace name.
+            file_name = File.basename(workspace.file, '.apw') + '.src'
+          end
+          
+          package = NetLinx::SRC::Package.new file: file_name
+          package.unpack '_extracted'
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/netlinx/src.rb

@@ -0,0 +1,15 @@
+require_relative 'src/package'
+
+
+# :nodoc:
+module NetLinx
+  
+  # Pertaining to .src files.
+  module SRC
+  end
+  
+  # Rake tasks.
+  module Rake
+  end
+  
+end

data/lib/netlinx/src/package.rb

@@ -0,0 +1,154 @@
+require 'zip'
+
+module NetLinx
+  module SRC
+    
+    # A NetLinx .src source code package.
+    class Package
+      
+      # Parameters:
+      #
+      #   Mode:
+      #     :standard - Intelligently package all files pertaining to a
+      #       NetLinx project.
+      #
+      #     :classic  - Emulates the AMX file packager, including only .axs
+      #       and .axi files in the package. Also mimicks the same folder
+      #       structure.
+      #
+      def initialize **kvargs
+        @file                = kvargs.fetch :file, ''
+        @mode                = kvargs.fetch :mode, :standard
+        
+        @warning_file        = '_FILE_EXTRACTION_WARNING.txt'
+      end
+      
+      # Pack the project into a NetLinx .src package.
+      def pack
+        File.delete @file if File.exists? @file
+        
+        files = Dir['**/*'] - Dir[@file] + Dir['.srcignore']
+        
+        # Exclude ignored files.
+        exclusions = load_exclusions.map { |e| Dir[e] }.flatten
+        files = files - exclusions
+        
+        Zip::File.open @file, Zip::File::CREATE do |zip|
+          files.each { |file| zip.add file, file }
+          
+          zip.get_output_stream(@warning_file) { |f|
+            f.puts make_warning_file
+          }
+        end
+      end
+      
+      # Unpack a NetLinx .src project package.
+      # Unpacks to the given directory, if provided.
+      def unpack dir = nil
+        Zip::File.open @file do |zip|
+          zip.each_entry do |e|
+            path = dir.nil? ? e.name : "#{dir}/#{e.name}"
+            e.extract path unless e.name == @warning_file
+          end
+        end
+      end
+      
+      # Load a list of file exclusions (glob format) from .srcignore.
+      def load_exclusions
+        return [] unless File.exists? '.srcignore'
+        
+        lines = File.read('.srcignore').lines.map(&:strip)
+          .reject { |l| l.empty? }          # Remove empty lines.
+          .reject { |l| l.start_with? '#' } # Remove commented lines.
+          .map { |l| l.include?('/') ? l : "**/#{l}" } # Append **/ if a specific path isn't referenced.
+      end
+      
+      # Copy the NetLinx .src file to .zip for easy browsing without unpacking.
+      def copy_to_zip
+        FileUtils.cp @file, "#{@file}.zip"
+      end
+      
+      # Remove the .zip version of this NetLinx .src file if it exists.
+      def remove_zip
+        File.delete "#{@file}.zip" if File.exists? "#{@file}.zip"
+      end
+      
+      # Create a standard .srcignore file in the current directory.
+      # Raises exception if file exists.
+      def make_srcignore
+        raise IOError, "A .srcignore file already exists in this directory." \
+          if File.exists? '.srcignore'
+        
+        string = <<-EOS
+# --------------------------------------------------- #
+#  Files to exclude from .SRC package (glob format).  #
+# --------------------------------------------------- #
+
+# AMX
+
+*.src
+*.tp4
+
+# Graphics
+
+*.ai
+*.bmp
+*.eps
+*.gif
+*.jpg
+*.jpeg
+*.png
+*.psd
+*.svg
+
+# Archives
+
+*.gz
+*.tar
+*.zip
+
+# Documentation
+
+*.pdf
+
+EOS
+          
+          File.write '.srcignore', string
+      end
+      
+      # Returns a string for the unpack warning file.
+      def make_warning_file
+        <<-EOS
+# ---------------------------------------------------------------------- #
+# WARNING:  This archive should be unpacked with the netlinx-src utility #
+# ---------------------------------------------------------------------- #
+
+Download
+--------
+
+http://sourceforge.net/p/netlinx-src/wiki/Home/
+
+
+About
+-----
+
+netlinx-src is a third-party utility for creating and extracting NetLinx
+.src source code package files. Unlike the standard utility that ships
+with NetLinx Studio, netlinx-src will retain the project's folder
+structure when the project is extracted. This becomes increasingly more
+important based on the number of files a project contains.
+
+Packaging a project with netlinx-src is also more comprehensive than
+using the standard utility. Not only is netlinx-src courteous enough
+to package files necessary for maintenance of the system (IR libraries,
+Duet modules, NetLinx modules, etc.), it also features a fine-grained
+file exclusion list that can prevent bulky touch panel files or graphics
+from filling up the disk space on the master.
+EOS
+        .gsub("\n", "\r\n") # Format for readability in Notepad.
+      end
+      
+    end
+    
+  end
+end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: netlinx-src
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex McLain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: netlinx-workspace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.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: rspec
+  name: yard
   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: fivemat
+  name: rspec
   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: yard
+  name: fivemat
   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'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   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: ''
@@ -114,17 +128,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- license.txt
 - README.md
-- doc/NetLinx.html
-- doc/NetLinx/ProjectPackage.html
-- doc/_index.html
+- lib/netlinx/rake/src/delzip.rb
+- lib/netlinx/rake/src/mkzip.rb
+- lib/netlinx/rake/src/pack.rb
+- lib/netlinx/rake/src/srcignore.rb
+- lib/netlinx/rake/src/unpack.rb
+- lib/netlinx/rake/src.rb
+- lib/netlinx/src/package.rb
+- lib/netlinx/src.rb
 - doc/class_list.html
 - doc/css/common.css
 - doc/css/full_list.css
 - doc/css/style.css
-- doc/file.README.html
-- doc/file.README.md.html
 - doc/file.license.html
+- doc/file.README.html
 - doc/file_list.html
 - doc/frames.html
 - doc/index.html
@@ -132,10 +151,20 @@ files:
 - doc/js/full_list.js
 - doc/js/jquery.js
 - doc/method_list.html
+- doc/NetLinx/ProjectPackage.html
+- doc/NetLinx/Rake/DelZip.html
+- doc/NetLinx/Rake/MkZip.html
+- doc/NetLinx/Rake/Pack.html
+- doc/NetLinx/Rake/SrcIgnore.html
+- doc/NetLinx/Rake/ToZip.html
+- doc/NetLinx/Rake/Unpack.html
+- doc/NetLinx/Rake/Zip.html
+- doc/NetLinx/Rake.html
+- doc/NetLinx/SRC/Package.html
+- doc/NetLinx/SRC.html
+- doc/NetLinx.html
 - doc/top-level-namespace.html
-- lib/netlinx-src.rb
-- lib/netlinx/project_package.rb
-- license.txt
+- doc/_index.html
 homepage: https://sourceforge.net/projects/netlinx-src/
 licenses:
 - Apache 2.0
@@ -146,19 +175,19 @@ 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.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: A utility for managing NetLinx Source (.src) files.
+summary: A toolset for working with NetLinx source code packages (.src).
 test_files: []
 has_rdoc: