ecic 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2227c73d15fbf63a514a2cc236f1162e90215ebc30a703b9f36dc99b1289a57e
-  data.tar.gz: 60e8e2010800a08549c8a96b1d173d491352e7dce15fa54d1cac00ee32393924
+  metadata.gz: c6b9cbccccd5b2673f19c2784227f75efa75bd5dcaa10ec4255dc761b6633ab6
+  data.tar.gz: 5489f7e5ea4cf76bfc226a04db97770306034fffb3a711f5887d995a5958c64e
 SHA512:
-  metadata.gz: 3614ce591502c236baff92a49a616dc2112690ab8b26e93cd8220e216a159642fd830f38415f41240c6cf2b27882044c9896c442da8402c3bbc0397ed56cb4b8
-  data.tar.gz: 44854b5887f98249e5454adc925ca964f93f09912fd22fa6c8785b6e7c4f513c1e01b133adb7d041c5ed6517be844bef89028a99179d86fadaf3bd39148e4dc1
+  metadata.gz: f2179977315b2f98d5ce51935b28f28ac423a2425ef8bd98ebb71c08fd0fa6efadce9ddaf2daa32cf015300606cbc55998345c08ff59077fc6f77c96fd0673a5
+  data.tar.gz: 64c591e207d601b42861694790e91005eb2b8fff36d9ee22c9d892a4aca340d802c82123dceba1c68f00e9d83c82c268ee758767d6d4d619e3de425b7f285930

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecic (0.5.0)
+    ecic (0.6.2)
       activesupport (~> 5.2)
       colorize (~> 0.8)
       rake (~> 12.3)
@@ -22,7 +22,7 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.1.5)
-    i18n (1.1.0)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     minitest (5.11.3)

data/README.md

@@ -32,7 +32,7 @@ The `ecic new` command creates a new ECIC project with a default directory struc
 
     $ ecic new my_project
 
-and the install the dependencies for your new project using Bundler:
+and then install the dependencies for your new project using Bundler:
 
     $ cd ./my_project
     $ bundle install
@@ -215,5 +215,3 @@ To install the ECIC framework onto your local machine, run `bundle exec rake ins
 5. Create new Pull Request
 
 Bug reports and pull requests are most welcome on GitHub at https://github.com/ic-factory/ecic.
-
-

data/config/locales/help.en.yaml

@@ -51,9 +51,9 @@ help:
           eval $(ecic completion script)      
 
   addfile:
-    short: Add existing design and testbench files to the project!
+    short: Add existing design and testbench files to the project
     long: |
-      Add one or more existing design files to a given library in the project!
+      Add one or more existing design files to a given library in the project
 
       Example: ecic addfile --lib=my_lib ./foo/bar/some_design.sv ../toto/kuku.vhd
   
@@ -66,8 +66,12 @@ help:
       
       If an added file is located outside the project folder, an absolute path will be used by default.
 
+  project:
+    short: Print various information about your project
+    root:
+      short: Print path to the root directory of your project
   generate:
-    short: Generate new testbenches, RTL modules, tests etc.!
+    short: Generate new testbenches, RTL modules, tests etc.
 
     testbench:
       short: Create a new testbench

data/lib/ecic.rb

@@ -24,6 +24,7 @@ module Ecic
   autoload :FileAdder, "ecic/file_adder"
   autoload :Completion, "ecic/completion"
   autoload :Completer, "ecic/completer"
+  autoload :ProjectCmd, "ecic/project_cmd"
   autoload :DesignGenerator, "ecic/design_generator"
   autoload :SvDesignGenerator, "ecic/sv_design_generator"
   autoload :ProjectGenerator, "ecic/project_generator"

data/lib/ecic/cli.rb

@@ -8,9 +8,10 @@ module Ecic
         shell.say "Usage: ecic COMMAND [ARGS]"
         shell.say ""
         super
-        shell.say "To get more help on a specific command, try 'ecic help [COMMAND]'"
+        shell.say "Commands may be abbreviated, so long as they are unambiguous."
+        shell.say "E.g. 'ecic p r' is short for 'ecic project root'."
+        shell.say "\nTo get more help on a specific command, try 'ecic help [COMMAND]'"
       end
-
     end
 
     check_unknown_options!
@@ -48,7 +49,12 @@ module Ecic
     desc "generate SUBCOMMAND ...ARGS", Help.text('generate')['short']
     subcommand "generate", Generate
 
-    
+    #--------------------------------------------------------------------------
+    # PROJECT command:
+    #--------------------------------------------------------------------------
+    desc "project SUBCOMMAND ...ARGS", Help.text('project')['short']
+    subcommand "project", ProjectCmd
+
     #--------------------------------------------------------------------------
     # design generator:
     #--------------------------------------------------------------------------
@@ -80,10 +86,8 @@ module Ecic
         shell.error set_color(exc.message, Thor::Shell::Color::RED)
         exit(3)
       end
-      
     end
 
-
     #--------------------------------------------------------------------------
     # COMPLETION command:
     #--------------------------------------------------------------------------
@@ -109,7 +113,7 @@ module Ecic
     def version
       say "#{VERSION}"
     end
-    
+
     #--------------------------------------------------------------------------
     # LIBRARIES command:
     #--------------------------------------------------------------------------
@@ -118,29 +122,36 @@ module Ecic
     option :format, :type => :string, :banner => 'text|json', :desc => 'Specify the output format'
     option :include_source_files, :type => :boolean, :aliases => '-s', :desc => "Include source files for each library"
     def libraries
-      defaults = {
-        "format"       => "text",
-        "include_source_files" => false
-      }
-      opt = defaults.merge(options)
-      
-      root_dir = Project::root
-      if root_dir.nil?
-        shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
+      begin
+        defaults = {
+          "format"       => "text",
+          "include_source_files" => false
+        }
+        opt = defaults.merge(options)
+
+        root_dir = Project::root
+        if root_dir.nil?
+          shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
+          exit(3)
+        end
+        project = Project.new(root_dir)
+        project.load_libraries
+        if opt['include_source_files']
+          project.load_sources
+        end
+        if opt['format'] == 'json'
+          require 'json'
+          say project.libraries.map{ |lib| lib.to_json(:include_source_files => opt['include_source_files']) }.join(",")
+        else
+          say project.libraries.map{ |lib| lib.to_s(:include_source_files => opt['include_source_files']) }.join("\n")
+        end
+
+      rescue Exception => exc
+        shell.error set_color(exc.message, Thor::Shell::Color::RED)
         exit(3)
       end
-      project = Project.new(root_dir)
-      project.load_libraries
-      if opt['include_source_files']
-#        puts "reading source files..."
-        project.load_sources 
-      end
-      if opt['format'] == 'json'
-        require 'json'
-        say project.libraries.map{ |lib| lib.to_json(:include_source_files => opt['include_source_files']) }.join(",") 
-      else
-        say project.libraries.map{ |lib| lib.to_s(:include_source_files => opt['include_source_files']) }.join("\n") 
-      end
+
+
     end
   end
-end
+end

data/lib/ecic/file_adder.rb

@@ -8,9 +8,9 @@ module Ecic
     attr_accessor :library_name, :file_names, :project
 
     def add_files_to_source_list
-      #If a library name is given, then the project must already contain a library with that 
-      #name. Otherwise an error message must be returned, because we do not know if it is a
-      #design or testbench library.
+      #If a library name is given, the project must already contain a library
+      #with that name. Otherwise an error message must be returned, because we
+      #do not know if it is a design or testbench library.
       unless library_name.nil?
         library = project.get_library(library_name)
         raise "Unknown library called '#{library_name}'. Please create the library before adding files to it. " if library.nil?
@@ -18,8 +18,7 @@ module Ecic
       destination_path = Pathname.new(destination_root)      
       file_names.each { |file_name|
         src_file_info = SourceFileInfo.new(project, file_name, library)
-        raise "Library name could not be determined from the path of '#{file_name}'. Make sure the appropriate library has been created and specify it with the --lib option." if src_file_info.library.nil?
-#        puts "lib name=#{src_file_info.library.name}, lib_path = #{src_file_info.library.path}"
+        raise "Library name could not be determined from the path of '#{file_name}'.\nMake sure the appropriate library has been created and specify it with the --lib option - or create an empty sources.rb file in the root directory of the library." if src_file_info.library.nil?
         if create_library_if_missing(src_file_info.library)
           add_src_file(src_file_info, destination_path)
         else

data/lib/ecic/helpers/library_creation_helper.rb

@@ -42,11 +42,11 @@ module Ecic::LibraryCreationHelper
       when nil
         say ""
         return true
-      when is?(:yes), is?(:all), ""
+      when is?(:yes), ""
         return true
       when is?(:no), is?(:skip)
         return false
-      when is?(:always)
+      when is?(:all)
         return @always_create_library = true
       when is?(:quit)
         say "Aborting..."

data/lib/ecic/project_cmd.rb

@@ -0,0 +1,23 @@
+module Ecic
+  class ProjectCmd < Command
+
+    #--------------------------------------------------------------------------
+    # project root:
+    #--------------------------------------------------------------------------
+    desc "rootdir", Help.text('project')['root']['short']
+    def rootdir
+      begin
+        project_root_path = Ecic::Project::root
+        if project_root_path.nil?
+          shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
+          exit(1)
+        else
+         say project_root_path
+        end
+      rescue Exception => exc
+        shell.error set_color(exc.message,Thor::Shell::Color::RED)
+        exit(3)
+      end
+    end
+  end
+end

data/lib/ecic/source_file_info.rb

@@ -85,7 +85,7 @@ module Ecic
       when "src/design"
         return :design
       else
-        return nil
+        return :design
       end
     end
 

data/lib/ecic/version.rb

@@ -1,3 +1,3 @@
 module Ecic
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecic
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Torben Fox Jacobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -149,6 +149,7 @@ files:
 - lib/ecic/library.rb
 - lib/ecic/library_generator.rb
 - lib/ecic/project.rb
+- lib/ecic/project_cmd.rb
 - lib/ecic/project_generator.rb
 - lib/ecic/source_file.rb
 - lib/ecic/source_file_info.rb