ecic 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2941906c52685bf8cdd8dd3c988cb33d954917ce1af810b636a6d05a4a7858c9
-  data.tar.gz: e09506b75b7baaeb904179df7fa2eeb529d71e6084c1d9e150145b40d8ec1f2c
+  metadata.gz: 67af83d0923633a5e2f2397d80a6b1d0afbeefeffef35ae45a769372cc86f58a
+  data.tar.gz: bbc000b8facc774ccb3ab29f4d43afec136bcff984cc473a91c029535b10cdba
 SHA512:
-  metadata.gz: a6cf0330473f92ece3ae09d5448255502e354fce068eba417c9eb8e0c1dc79a1c21791bca6e440cce409f5f58faf2ac9fe1558aa69ba30d4fa742ae4d493487e
-  data.tar.gz: 7403f3d664272bd3bf5a25a6bbba9c534f212a9425f360f5c3f7531d3787452b7c6c2391e45aff9a908ed417a6ff6492dbe8f3315d1cd75ed66e710a4bc8dfb5
+  metadata.gz: 1fa51e7d5d0eca77f46671e5132a4fd2f702d52060b9b4cf297d855e92f1b98c557763901ff77e55aa30b5b7484e3b934579241d1c49374acd20594302b03819
+  data.tar.gz: d82d6f3b344dc308528786951e13be92fb2a42cf7431808c81b9f54cfbe9534a447a3c2f3b9d2ed1d5ce33eaed565464f4c25219c16716ad437d225b27777183

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecic (0.1.0)
+    ecic (0.2.0)
       activesupport
       colorize
       rake
@@ -10,9 +10,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     byebug (10.0.0)
@@ -22,11 +22,11 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.1.5)
-    i18n (0.9.4)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     minitest (5.11.3)
-    rake (12.3.0)
+    rake (12.3.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -61,4 +61,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.16.1
+   1.16.6

data/config/locales/help.en.yaml

@@ -1,15 +1,47 @@
 help:
   new:
-    short: Generate a new project called NAME
+    short: Generate a new project in PATH
     long:  |
-      Creates a new chip project called NAME.
+      Creates a new chip project in PATH.
    
       Example: ecic new my_project
 
-      This creates a new project called 'my_project' in ./my_project
+      This creates a new ECIC project in ./my_project
+  completion:
+    short: Print words for auto-completion
+    long:   |
+      Example:
+
+        ecic completion
+
+      Prints words for TAB auto-completion.
+
+      Examples:
+
+        ecic completion
+        ecic completion generate
+        ecic completion generate design
+
+      To enable TAB auto-completion, add the following to your profile:
+
+        eval $(ecic completion script)
+
+      Auto-completion example usage:
+
+        ecic [TAB]
+        ecic generate [TAB]
+        ecic generate design [TAB]
+        ecic generate design --[TAB]      
+      
+    script:
+      short: Generate script that can be eval to setup auto-completion      
+      long:   |
+        To use, add the following to your ~/.bashrc or ~/.profile
+
+          eval $(ecic completion script)      
+      
   generate:
     short: Generate new testbenches, RTL modules, tests etc.!
-  generators:
     testbench:
       short: Create a new testbench
       long: |

data/lib/ecic.rb

@@ -23,4 +23,7 @@ module Ecic
   autoload :Generate, "ecic/generate"
   autoload :Completion, "ecic/completion"
   autoload :Completer, "ecic/completer"
+  autoload :ProjectGenerator, "ecic/project_generator"
+  autoload :LibraryGenerator, "ecic/library_generator"
+  autoload :Project, "ecic/project"
 end

data/lib/ecic/cli.rb

@@ -8,6 +8,11 @@ module Ecic
         super
         shell.say "To get more help on a specific command, try 'ecic help [COMMAND]'"
       end
+
+      #TBA: Make a function that returns the root folder for the project
+      def root
+        File.expand_path("./tfj2")
+      end
     end
 
     check_unknown_options!
@@ -17,47 +22,57 @@ module Ecic
       true
     end
 
-    #TBA: Make a function that returns the root folder for the project
-    def self.root
-      File.expand_path("./tfj2")
-    end
-    
-#    class_option :verbose, type: :boolean
-#    class_option :noop, type: :boolean
-
     #--------------------------------------------------------------------------
     # NEW command:
     #--------------------------------------------------------------------------
-    long_desc Help.text(:new)
-    desc "new PATH", Help.short_text(:new)
+    desc "new PATH", Help.text('new')['short']
+    long_desc Help.text('new')['long']
     option :verbose, :type => :boolean
     def new(path)
       path = File.expand_path(path)
-      puts "Generating a new project in #{path}"
+      shell.say "Generating a new project in #{path}"
       generator = ProjectGenerator.new
       generator.destination_root = path
       generator.invoke_all
-      #TBA: invoke installation by eg. calling 'bundler install' from within the generate project folder    
+      
+      shell.say "\nTo install the required packages in your project, please run:\n   cd #{path}; bundle install\n", Thor::Shell::Color::BOLD
+      #TBA: invoke installation by eg. calling 'bundler install' from within the generated project folder    
+#      Bundler.with_clean_env do
+#        Dir.chdir(path) do
+#          `bundle install`
+#        end
+#      end
     end
 
-    desc "generate SUBCOMMAND ...ARGS", "sub subcommands"
-    long_desc Help.text(:generate)
+    #--------------------------------------------------------------------------
+    # GENERATE command:
+    #--------------------------------------------------------------------------
+    desc "generate SUBCOMMAND ...ARGS", Help.text('generate')['short']
+    long_desc Help.text('generate')['long']
     subcommand "generate", Generate
 
-    desc "completion *PARAMS", "Print words for auto-completion"
-    long_desc Help.text("completion")
+    #--------------------------------------------------------------------------
+    # COMPLETION command:
+    #--------------------------------------------------------------------------
+    desc "completion *PARAMS", Help.text('completion')['short'], hide: true
+    long_desc Help.text('completion')['long']
     def completion(*params)
       Completer.new(CLI, *params).run
     end
 
-    desc "completion_script", "Generate script that can be eval to setup auto-completion", hide: true
-    long_desc Help.text("completion_script")
+    #--------------------------------------------------------------------------
+    # COMPLETION_SCRIPT command:
+    #--------------------------------------------------------------------------
+    desc "completion_script", Help.text('completion')['script']['short'], hide: true
+    long_desc Help.text('completion')['script']['long']
     def completion_script
       Completer::Script.generate
     end
 
+    #--------------------------------------------------------------------------
+    # VERSION command:
+    #--------------------------------------------------------------------------
     desc 'version', 'Display version'
-    map %w[-v --version] => :version
     def version
       say "#{VERSION}"
     end

data/lib/ecic/completion.rb

@@ -1,13 +1,13 @@
 module Ecic
   class Completion < Command
     desc "script", "generates script that can be eval to setup auto-completion"
-    long_desc Help.text("completion:script")
+    long_desc Help.text('completion')['script']['long']
     def script
       Completer::Script.generate
     end
 
     desc "completions *PARAMS", "prints words for auto-completion"
-    long_desc Help.text("completion:list")
+    long_desc Help.text('completion')['list']['long']
     def list(*params)
       Completer.new(*params).run
     end

data/lib/ecic/generate.rb

@@ -4,27 +4,40 @@ module Ecic
     #--------------------------------------------------------------------------
     # TESTBENCH generator:
     #--------------------------------------------------------------------------
-    class_option :verbose, :type => :boolean
+####    class_option :verbose, :type => :boolean
+####    desc "testbench NAME", Help.text('generate')['testbench']['short']
+####    long_desc Help.text('generate')['testbench']['long']
+####    option :type, :banner => 'vhdl|sv|uvm', :required => true, :desc => 'Speficy the testbench type (VHDL, SystemVerilog or UVM)'
+####    option :just_print, :type => :boolean, :aliases => '-n', :desc => "Don't actually run any commands; just print them."
+####    def testbench(name)
+####      puts "Implement a generator for creating a new testbench"
+####    end
 
-    desc "testbench NAME", Help.short_text("generate:testbench")
-    long_desc Help.text("generate:testbench")
-    option :type, :banner => 'vhdl|sv|uvm', :required => true, :desc => 'Speficy the testbench type (VHDL, SystemVerilog or UVM)'
-    option :just_print, :type => :boolean, :aliases => '-n', :desc => "Don't actually run any commands; just print them."
-    def testbench(name)
-      puts "Implement a generator for creating a new testbench"
-    end
-
-    desc "library NAME...", Help.short_text("generate:library")
-    long_desc Help.text("generate:library")
+    #--------------------------------------------------------------------------
+    # library generator:
+    #--------------------------------------------------------------------------
+    desc "library NAME...", Help.text('generate')['library']['short']
+    long_desc Help.text('generate')['library']['long']
+    
     option :just_print, :type => :boolean, :aliases => '-n', :desc => "Don't actually run any commands; just print them."
 #    def library(names)
     def library(lib_name)
-      generator = LibraryGenerator.new
-      generator.destination_root = Ecic::root
-#      names.each do |lib_name|
-        generator.library_name = lib_name
-        generator.invoke_all
-#      end
+      project_root_path = Ecic::Project::root
+#project_root_path = Dir.pwd
+#if false
+      if project_root_path.nil?
+        shell.error "You must be within an ECIC project before calling this command"
+        exit(1)
+      else
+        shell.say "Generating a new library in #{project_root_path}"
+        generator = LibraryGenerator.new
+        generator.destination_root = project_root_path
+  #      names.each do |lib_name|
+          generator.library_name = lib_name
+          generator.invoke_all
+  #      end
+      end
+
     end
   end
 end

data/lib/ecic/help.rb

@@ -1,14 +1,14 @@
 module Ecic::Help
+  require 'YAML'
   class << self
     def text(namespaced_command)
-      path = namespaced_command.to_s.gsub(':','/')
-      path = File.expand_path("../help/#{path}.md", __FILE__)
-      IO.read(path) if File.exist?(path)
+      hlp = YAML.load(File.read(File.expand_path("../../../config/locales/help.en.yaml", __FILE__)))['help'][namespaced_command]
+#      hlp['short']
     end
-    def short_text(namespaced_command)
-      path = namespaced_command.to_s.gsub(':','/')
-      path = File.expand_path("../help/#{path}_short.md", __FILE__)
-      IO.read(path) if File.exist?(path)
+    def long(namespaced_command)
+      p namespaced_command
+      hlp = YAML.load(File.read(File.expand_path("../../../config/locales/help.en.yaml", __FILE__)))['help'][namespaced_command]
+#      hlp['long']
     end
   end
 end

data/lib/ecic/library_generator.rb

@@ -10,12 +10,11 @@ module Ecic
       File.dirname(__FILE__) + '/../../templates'
     end
 
-#    def create_library_directory
-#      copy_file 'projects/src/design/lib/sources.rb', "src/design/#{@library_name}/sources.rb"
-#    end
+    def create_library_directory
+      copy_file 'project/src/design/lib/sources.rb', "src/design/#{@library_name}/sources.rb"
+    end
 
     def update_library_list
-      #TBA 'src/config' creation is only temporary fix!
       libraries_file = File.expand_path("#{destination_root}/src/config/libraries.rb")
       empty_directory 'src/config' unless File.exist?(File.dirname(libraries_file))      
       create_file libraries_file unless File.exist?(libraries_file)                  

data/lib/ecic/project.rb

@@ -0,0 +1,20 @@
+module Ecic
+
+  class Project
+
+    require 'pathname'
+
+    SCRIPT_ECIC = File.join('config', 'ecic.rb')
+
+    #Function that returns the root directory of a ECIC project
+    def self.root(path = Pathname.new(Dir.pwd))
+      if File.exists?(File.join(path, SCRIPT_ECIC))
+        return path
+      elsif path.root?
+        return nil
+      end
+      return root(path.parent)
+    end
+
+  end
+end

data/lib/ecic/project_generator.rb

@@ -12,24 +12,20 @@ module Ecic
       copy_file 'gitignore', '.gitignore'
       copy_file 'config/project.rb', 'src/config/project.rb'
       copy_file 'config/libraries.rb', 'src/config/libraries.rb'
-      copy_file 'Gemfile', 'Gemfile'
+      copy_file 'config/ecic.rb', 'src/config/ecic.rb'
+      @ruby_version = '2.4.4'
+      template("Gemfile.tt","Gemfile")
     end
 
     def create_output_directories
-      #TBA: Replace these lines with a call to a TestbenchGenerator class
-      empty_directory 'src/testbench/chip'
-      empty_directory 'src/verification/chip'
-
-      copy_file 'src/packages/README.txt', 'src/packages/README.txt'
-      create_file 'src/design/chip/sources.rb'
+      empty_directory 'src/design'
+      create_file 'src/design/.gitkeep' if Dir.empty?("#{destination_root}/src/design")
+      empty_directory 'src/testbench'
+      create_file 'src/testbench/.gitkeep' if Dir.empty?("#{destination_root}/src/testbench")
+      empty_directory 'src/verification'
+      create_file 'src/verification/.gitkeep' if Dir.empty?("#{destination_root}/src/verification")
       empty_directory 'src/external_packages'
-    end
-
-    #Replace this function with a call to a 'VHDLComponentGenerator' class
-    def create_top_entity
-      create_file 'src/design/chip/sources.yaml.erb'
-      create_file 'src/design/chip/chip-rtl_arc.vhd'
-      create_file 'src/design/chip/chip-ent.vhd'
+      create_file 'src/external_packages/.gitkeep' if Dir.empty?("#{destination_root}/src/external_packages")
     end
 
     def git_init

data/lib/ecic/version.rb

@@ -1,3 +1,3 @@
 module Ecic
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/templates/project/Gemfile.tt

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+ruby '<%= @ruby_version %>'
+gem 'ecic'

data/templates/project/config/ecic.rb

@@ -0,0 +1,13 @@
+Ecic.project.configure do
+
+  #Select the default type of RTL files you wish to generate:
+  #VHDL or SystemVerilog:
+  config.generator.library.type.default = 'vhdl'
+  # config.generator.library.type.default = 'sv'   
+
+  config.generator.design.vhdl.combine = ''
+#  config.generator.design.vhdl.combine = 'entity + architecture'
+#  config.generator.design.vhdl.combine = 'entity + component'
+#  config.generator.design.vhdl.combine = 'entity + architecture + component'
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Torben Fox Jacobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -118,6 +118,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -126,7 +127,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/ecic
 - bin/setup
 - config/ecic.yaml
 - config/locales/help.en.yaml
@@ -142,26 +142,19 @@ files:
 - lib/ecic/completion.rb
 - lib/ecic/generate.rb
 - lib/ecic/help.rb
-- lib/ecic/help/completion.md
-- lib/ecic/help/completion_script.md
-- lib/ecic/help/generate/library.md
-- lib/ecic/help/generate/library_short.md
-- lib/ecic/help/generate/testbench.md
-- lib/ecic/help/generate/testbench_short.md
-- lib/ecic/help/new.md
-- lib/ecic/help/new_short.md
 - lib/ecic/library_generator.rb
+- lib/ecic/project.rb
 - lib/ecic/project_generator.rb
 - lib/ecic/version.rb
 - notes.txt
 - spec/lib/cli_spec.rb
 - spec/spec_helper.rb
-- templates/project/Gemfile
+- templates/project/Gemfile.tt
+- templates/project/config/ecic.rb
 - templates/project/config/libraries.rb
 - templates/project/config/project.rb
 - templates/project/gitignore
 - templates/project/src/design/lib/sources.rb
-- templates/project/src/packages/README.txt
 homepage: https://github.com/ic-factory/ecic
 licenses:
 - LGPL-3.0

data/bin/ecic

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "ecic"
-
-Ecic::Cli.start(ARGV)

data/lib/ecic/help/completion.md

@@ -1,22 +0,0 @@
-Example:
-
-  ecic completion
-
-Prints words for TAB auto-completion.
-
-Examples:
-
-  ecic completion
-  ecic completion hello
-  ecic completion hello name
-
-To enable TAB auto-completion, add the following to your profile:
-
-  eval $(ecic completion script)
-
-Auto-completion example usage:
-
-  ecic [TAB]
-  ecic generate [TAB]
-  ecic generate design [TAB]
-  ecic generate design --[TAB]

data/lib/ecic/help/completion_script.md

@@ -1,3 +0,0 @@
-To use, add the following to your ~/.bashrc or ~/.profile
-
-  eval $(ecic completion script)

data/lib/ecic/help/generate/library.md

@@ -1,4 +0,0 @@
-Examples:
-
-  ecic generate library
-  ecic generate library NAME

data/lib/ecic/help/generate/library_short.md

@@ -1 +0,0 @@
-Generate new library

data/lib/ecic/help/generate/testbench.md

@@ -1,4 +0,0 @@
-Examples:
-
-  ecic generate testbench
-  ecic generate testbench NAME

data/lib/ecic/help/generate/testbench_short.md

@@ -1 +0,0 @@
-Generate new testbench

data/lib/ecic/help/new.md

@@ -1,3 +0,0 @@
-Examples:
-
-  ecic new my_project

data/lib/ecic/help/new_short.md

@@ -1 +0,0 @@
-Create new project

data/templates/project/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-ruby '2.1.5'
-gem 'ecic'