verilog 0.0.5 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08658e8cfe6d74a85ae7877363158517e08705c3
+  data.tar.gz: 9ab6a88186f8c4f2cd5028361056da5590b1e5a5
+SHA512:
+  metadata.gz: a64da72fbcf90052ff2ef5384977c9547e14b9c7e0d4cd4bba53fd93c60758fd86e947bf95860e8325592ecb9ba0ca8777017cc19ae60f1f0650bc7a8f481547
+  data.tar.gz: c3537cd238133fe2976c2d9d006272482bc23b4b8d5e4ec892a2fc00fca8ad77f65b1eccf74582dc9fb06be26a92605300ca8bbcbfdbd4e13fb3958a1506f290

data/README.md

@@ -1,6 +1,8 @@
 Verilog
 =======
 
+[![Gem Version](https://badge.fury.io/rb/verilog.png)](http://badge.fury.io/rb/verilog)
+
 Install
 -------
 

data/lib/verilog.rb

@@ -3,8 +3,9 @@ libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 module Verilog
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end
 
+require 'verilog/file_list'
 require 'verilog/file'
 require 'verilog/path'

data/lib/verilog/file_list.rb

@@ -0,0 +1,99 @@
+module Verilog
+
+  class FileList
+    attr_reader :files
+
+    ## Expected usage
+    # Use FileList to create an array of files included in design
+    # FileList is then used to create a Path, which loads the files into memory
+    # FileList and Path are separated in case you want a file list with out actually having to open the files
+    def initialize( a_filelist='' )
+      @files = []
+      unless ( a_filelist == '')
+        parse_list!( a_filelist )
+      end
+    end
+
+    ## Unsure of the name for this
+    # open : it does open the file but not like other open calls
+    # load : opens file and loads content, load! does not imply what it modifies
+    # parse_list is descriptive but not what it modifies
+
+    def parse_list( filelist )
+      temp_files = []
+      ## Splat (*) filelist into Array if single string
+      [*filelist].each do |item|
+        abort( "FileList parse_list item not found : #{item}") unless ::File.exist?( item )
+        ::IO.readlines( item ).each do |line|
+          ## Remove // or # comments 
+          line = strip_comments( line )
+
+          ## Expand Environment variables in strings
+          line = expand_envvars( line )
+          
+          ## -incdir, include the entire contents of listed directory
+          if line.match(/^\s*-incdir\s+(\S+)\s*/)
+            temp_files << incdir($1)
+
+          ## Recurse on -f (file.f including other files.f)
+          elsif line.match(/^\s*-f\s+(\S+)\s*/)
+            temp_files << parse_list($1)
+
+          ## Ignore Whitespace
+          elsif line.match(/^\s$/)
+            next
+         
+          ## Append file list line to list of files
+          else
+            temp_files << line.strip
+          end
+        end
+      end
+
+      ## Recursion embeds arrays, return flat file list
+
+      return temp_files.flatten
+    end
+
+    def parse_list!( filelist )
+      files.push( *parse_list( filelist ) )
+    end
+      
+    def to_path
+      new_path = Path.new
+
+      self.files.each do |f|
+        new_path.load_file( f )
+      end
+
+      return new_path
+    end
+
+    private
+
+
+    def incdir( in_string )
+      ## returns array of files and links
+      inc_list = []
+      
+      Dir.glob( ::File.join(in_string, '*') ).select do |item|
+        if ::File.file?( item ) or ::File.symlink?( item )
+          inc_list << item
+        end
+      end
+
+      return inc_list
+    end
+
+    def expand_envvars( in_string )
+      return in_string.gsub(/\$(\w+)/) { ENV[$1] }
+    end
+
+    def strip_comments( in_string )
+      return in_string.gsub(/(\/\/|#).*$/, '')
+    end
+
+  end
+
+end
+

data/spec/fixtures/file.list

@@ -0,0 +1,13 @@
+
+file_one.txt
+file_two.txt
+
+// Pullin Secondary File list
+-f ./secondary_file.list
+
+file_three.txt
+
+// Include full contents of a folder
+-incdir inc_dir_test
+
+file_four.txt

data/spec/fixtures/secondary_file.list

@@ -0,0 +1,3 @@
+
+secondary_file_list_file1
+secondary_file_list_file2

data/spec/verilog_file_list_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'pp'
+
+describe Verilog do
+
+  it "Load file.list with init" do
+    test_path = File.join( File.dirname( __FILE__ ), 'fixtures' )
+    ## Set working directory for relative file.list includes
+    Dir.chdir( test_path )
+
+    list_one = Verilog::FileList.new( File.join( test_path, 'file.list' ) )
+    answer = 
+      ["file_one.txt",
+      "file_two.txt",
+      "secondary_file_list_file1",
+      "secondary_file_list_file2",
+      "file_three.txt",
+      "inc_dir_test/incdir_file_one.txt",
+      "inc_dir_test/incdir_file_two.txt",
+      "file_four.txt",
+      ]
+    
+    list_one.files.inspect.should    == answer.inspect
+    
+  end
+  it "Load file.list with parse list" do
+    test_path = File.join( File.dirname( __FILE__ ), 'fixtures' )
+    ## Set working directory for relative file.list includes
+    Dir.chdir( test_path )
+
+    #No bang method, returns array.
+    list_one = Verilog::FileList.new().parse_list( File.join( test_path, 'file.list' ) )
+    answer = 
+      ["file_one.txt",
+      "file_two.txt",
+      "secondary_file_list_file1",
+      "secondary_file_list_file2",
+      "file_three.txt",
+      "inc_dir_test/incdir_file_one.txt",
+      "inc_dir_test/incdir_file_two.txt",
+      "file_four.txt",
+      ]
+    
+    list_one.inspect.should    == answer.inspect
+    
+  end
+
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verilog
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Morgan Prior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies: []
 description: File helpers with specific functions for Verilog HDL
 email: verilog_gem@amaras-tech.co.uk
@@ -20,36 +19,41 @@ files:
 - README.md
 - Rakefile
 - lib/verilog/file.rb
+- lib/verilog/file_list.rb
 - lib/verilog/path.rb
 - lib/verilog.rb
+- spec/fixtures/file.list
+- spec/fixtures/inc_dir_test/incdir_file_one.txt
+- spec/fixtures/inc_dir_test/incdir_file_two.txt
+- spec/fixtures/secondary_file.list
 - spec/fixtures/test_four.vh
 - spec/fixtures/test_one.v
 - spec/fixtures/test_three.v
 - spec/spec_helper.rb
+- spec/verilog_file_list_spec.rb
 - spec/verilog_file_spec.rb
 - spec/verilog_path_spec.rb
 homepage: http://amaras-tech.co.uk/software/verilog
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helpers for working with verilog files
 test_files: []