ecic 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a76ed0b791619e00df7b26769de0149cd2c50bf7
-  data.tar.gz: 32bdd099afd3603acb07f92e3d65059693b4308c
+SHA256:
+  metadata.gz: 2941906c52685bf8cdd8dd3c988cb33d954917ce1af810b636a6d05a4a7858c9
+  data.tar.gz: e09506b75b7baaeb904179df7fa2eeb529d71e6084c1d9e150145b40d8ec1f2c
 SHA512:
-  metadata.gz: 00fb2b177b7d849519218ad947caad8885ee6024beed10ea01945bb9aeac43557c3faf3205a7f3012a873a6910ddf3cd7b59b24887e15f5d93d626d20f06a4c3
-  data.tar.gz: 6b9e3d628bb5982c30cabc505be385a80a4bf2fd3ba0e47d4f597c170ce75fc098afe88f340d8378d514dc7e509e158835e63cb3811dfd0f671b065adf07903f
+  metadata.gz: a6cf0330473f92ece3ae09d5448255502e354fce068eba417c9eb8e0c1dc79a1c21791bca6e440cce409f5f58faf2ac9fe1558aa69ba30d4fa742ae4d493487e
+  data.tar.gz: 7403f3d664272bd3bf5a25a6bbba9c534f212a9425f360f5c3f7531d3787452b7c6c2391e45aff9a908ed417a6ff6492dbe8f3315d1cd75ed66e710a4bc8dfb5

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [0.1.0]
+- Initial release.

data/Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in ecic.gemspec
+# Specify your gem dependencies in ecic.gemspec
 gemspec
 
-gem 'thor'
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,37 +1,64 @@
 PATH
   remote: .
   specs:
-    ecic (0.1.4)
+    ecic (0.1.0)
+      activesupport
+      colorize
+      rake
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    docile (1.1.5)
+    i18n (0.9.4)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.13)
+  bundler
+  byebug
+  codeclimate-test-reporter
   ecic!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  thor
+  rspec
 
 BUNDLED WITH
-   1.13.5
+   1.16.1

data/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -1,4 +1,4 @@
-# Easy IC : open-source, cross-platform framework for developing digital ASIC and FPGA designs
+# Easy IC
 
 ## NOTE: this project has just been started. Hence, the description below is what will come in the future, but none of the features have been implemented yet.
 
@@ -183,4 +183,12 @@ To install the ECIC framework onto your local machine, run `bundle exec rake ins
 -->
 ## Contributing
 
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
 Bug reports and pull requests are welcome on GitHub at https://github.com/ic-factory/ecic.
+
+

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-
 task :default => :spec
+
+RSpec::Core::RakeTask.new

data/ecic.gemspec

@@ -13,14 +13,18 @@ Gem::Specification.new do |spec|
   spec.description   = %q{This gem allows you to easily create a new ASIC/FPGA project with a file structure and support tools that ensures consistency between your projects and gets you up to speed in no time. To create a new project simply type 'ecic new PATH'.}
   spec.homepage      = "https://github.com/ic-factory/ecic"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files         = `git ls-files`.split($/)
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+  spec.add_dependency "rake"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec"
 end

data/exe/ecic

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 1
+  exit
+}
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "ecic"
+require "ecic/cli"
+
+Ecic::CLI.start(ARGV)

data/lib/ecic.rb

@@ -13,99 +13,14 @@
 # If the user tries to call the 'generate' command outside a project, 
 # an error message must be returned stating that this command can only be called from within a project.
 
+$:.unshift(File.expand_path("../", __FILE__))
 require "ecic/version"
 
 module Ecic
-  require 'yaml'
-  require 'thor'
-  require 'thor/group'
-  require "ecic/project_generator"
-  require "ecic/library_generator"
-
-  def self.help_text
-    YAML.load(File.read(File.expand_path("../../config/locales/help.en.yaml", __FILE__)))['help']
-  end
-
-  #TBA: Make a function that returns the root folder for the project
-  def self.root
-    File.expand_path("./tfj2")
-  end
-
-  class Generate < Thor
-    #--------------------------------------------------------------------------
-    # TESTBENCH generator:
-    #--------------------------------------------------------------------------
-    class_option :verbose, :type => :boolean
-
-    desc "testbench NAME", Ecic::help_text['generators']['testbench']['short']
-    long_desc Ecic::help_text['generators']['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 "library NAME...", Ecic::help_text['generators']['library']['short']
-    long_desc Ecic::help_text['generators']['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
-    end
-        
-  end  
-
-  class Cli < Thor
-
-    check_unknown_options!
-
-    #Make sure to return non-zero value if an error is thrown.
-    def self.exit_on_failure?
-      true
-    end
-    
-    class << self
-      def help(shell, subcommand = false)
-        shell.say "Usage: ecic COMMAND [ARGS]"
-        shell.say ""
-        super
-        shell.say "To get more help on a specific command, try 'ecic help [COMMAND]'"
-      end
-    end
-
-    #--------------------------------------------------------------------------
-    # VERSION command:
-    #--------------------------------------------------------------------------
-    desc 'version', 'Display version'
-    map %w[-v --version] => :version
-    def version
-      say "#{VERSION}"
-    end
-
-    #--------------------------------------------------------------------------
-    # NEW command:
-    #--------------------------------------------------------------------------
-    long_desc Ecic::help_text['new']['long']
-    desc "new PATH", Ecic::help_text['new']['short']
-    option :verbose, :type => :boolean
-    def new(path)
-      path = File.expand_path(path)
-      puts "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
-      
-    end
-
-    desc "generate SUBCOMMAND ...ARGS", Ecic::help_text['generate']['short']
-    subcommand "generate", Generate
-
-  end
-  
+  autoload :Help, "ecic/help"
+  autoload :Command, "ecic/command"
+  autoload :CLI, "ecic/cli"
+  autoload :Generate, "ecic/generate"
+  autoload :Completion, "ecic/completion"
+  autoload :Completer, "ecic/completer"
 end

data/lib/ecic/cli.rb

@@ -0,0 +1,69 @@
+module Ecic
+  class CLI < Command
+      
+    class << self
+      def help(shell, subcommand = false)
+        shell.say "Usage: ecic COMMAND [ARGS]"
+        shell.say ""
+        super
+        shell.say "To get more help on a specific command, try 'ecic help [COMMAND]'"
+      end
+    end
+
+    check_unknown_options!
+
+    #Make sure to return non-zero value if an error is thrown.
+    def self.exit_on_failure?
+      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)
+    option :verbose, :type => :boolean
+    def new(path)
+      path = File.expand_path(path)
+      puts "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    
+    end
+
+    desc "generate SUBCOMMAND ...ARGS", "sub subcommands"
+    long_desc Help.text(:generate)
+    subcommand "generate", Generate
+
+    desc "completion *PARAMS", "Print words for auto-completion"
+    long_desc Help.text("completion")
+    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")
+    def completion_script
+      Completer::Script.generate
+    end
+
+    desc 'version', 'Display version'
+    map %w[-v --version] => :version
+    def version
+      say "#{VERSION}"
+    end
+  end
+end
+
+
+
+

data/lib/ecic/command.rb

@@ -0,0 +1,47 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module Ecic
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   ecic command help
+        #   ecic command -h
+        #   ecic command --help
+        #   ecic command -D
+        #
+        # as well thor's normal way:
+        #
+        #   ecic help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   ecic version
+        #   ecic --version
+        #   ecic -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/ecic/completer.rb

@@ -0,0 +1,161 @@
+=begin
+Code Explanation:
+
+There are 3 types of things to auto-complete:
+
+  1. command: the command itself
+  2. parameters: command parameters.
+  3. options: command options
+
+Here's an example:
+
+  mycli hello name --from me
+
+  * command: hello
+  * parameters: name
+  * option: --from
+
+When command parameters are done processing, the remaining completion words will be options.  We can tell that the command params are completed based on the method arity.
+
+## Arity
+
+For example, say you had a method for a CLI command with the following form:
+
+  ufo scale service count --cluster development
+
+It's equivalent ruby method:
+
+  scale(service, count) = has an arity of 2
+
+So typing:
+
+  ufo scale service count [TAB] # there are 3 parameters including the "scale" command according to Thor's CLI processing.
+
+So the completion should only show options, something like this:
+
+  --noop --verbose --cluster
+
+## Splat Arguments
+
+When the ruby method has a splat argument, it's arity is negative.  Here are some example methods and their arities.
+
+   ship(service) = 1
+   scale(service, count) = 2
+   ships(*services) = -1
+   foo(example, *rest) = -2
+
+Fortunately, negative and positive arity values are processed the same way. So we take simply take the absolute value of the arity and process it the same.
+
+Here are some test cases, hit TAB after typing the command:
+
+  ecic completion
+  ecic completion hello
+  ecic completion hello name
+  ecic completion hello name --
+  ecic completion hello name --noop
+
+  ecic completion
+  ecic completion sub:goodbye
+  ecic completion sub:goodbye name
+
+## Subcommands and Thor::Group Registered Commands
+
+Sometimes the commands are not simple thor commands but are subcommands or Thor::Group commands. A good specific example is the ufo tool.
+
+  * regular command: ufo ship
+  * subcommand: ufo docker
+  * Thor::Group command: ufo init
+
+Auto-completion accounts for each of these type of commands.
+=end
+module Ufo
+  class Completer
+    autoload :Script, 'ecic/completer/script'
+
+    def initialize(command_class, *params)
+      @params = params
+      @current_command = @params[0]
+      @command_class = command_class # CLI initiall
+    end
+
+    def run
+      if subcommand?(@current_command)
+        subcommand_class = @command_class.subcommand_classes[@current_command]
+        @params.shift # destructive
+        Completer.new(subcommand_class, *@params).run # recursively use subcommand
+        return
+      end
+
+      # full command has been found!
+      unless found?(@current_command)
+        puts all_commands
+        return
+      end
+
+      # will only get to here if command aws found (above)
+      arity = @command_class.instance_method(@current_command).arity.abs
+      if @params.size > arity or thor_group_command?
+        puts options_completion
+      else
+        puts params_completion
+      end
+    end
+
+    def subcommand?(command)
+      @command_class.subcommands.include?(command)
+    end
+
+    # hacky way to detect that command is a registered Thor::Group command
+    def thor_group_command?
+      command_params(raw=true) == [[:rest, :args]]
+    end
+
+    def found?(command)
+      public_methods = @command_class.public_instance_methods(false)
+      command && public_methods.include?(command.to_sym)
+    end
+
+    # all top-level commands
+    def all_commands
+      commands = @command_class.all_commands.reject do |k,v|
+        v.is_a?(Thor::HiddenCommand)
+      end
+      commands.keys
+    end
+
+    def command_params(raw=false)
+      params = @command_class.instance_method(@current_command).parameters
+      # Example:
+      # >> Sub.instance_method(:goodbye).parameters
+      # => [[:req, :name]]
+      # >>
+      raw ? params : params.map!(&:last)
+    end
+
+    def params_completion
+      offset = @params.size - 1
+      offset_params = command_params[offset..-1]
+      command_params[offset..-1].first
+    end
+
+    def options_completion
+      used = ARGV.select { |a| a.include?('--') } # so we can remove used options
+
+      method_options = @command_class.all_commands[@current_command].options.keys
+      class_options = @command_class.class_options.keys
+
+      all_options = method_options + class_options + ['help']
+
+      all_options.map! { |o| "--#{o.to_s.gsub('_','-')}" }
+      filtered_options = all_options - used
+      filtered_options.uniq
+    end
+
+    # Useful for debugging. Using puts messes up completion.
+    def log(msg)
+      File.open("/tmp/complete.log", "a") do |file|
+        file.puts(msg)
+      end
+    end
+  end
+end

data/lib/ecic/completer/script.rb

@@ -0,0 +1,6 @@
+class Ecic::Completer::Script
+  def self.generate
+    bash_script = File.expand_path("script.sh", File.dirname(__FILE__))
+    puts "source #{bash_script}"
+  end
+end

data/lib/ecic/completer/script.sh

@@ -0,0 +1,10 @@
+_ecic() {
+  COMPREPLY=()
+  local word="${COMP_WORDS[COMP_CWORD]}"
+  local words=("${COMP_WORDS[@]}")
+  unset words[0]
+  local completion=$(ecic completion ${words[@]})
+  COMPREPLY=( $(compgen -W "$completion" -- "$word") )
+}
+
+complete -F _ecic ecic

data/lib/ecic/completion.rb

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

data/lib/ecic/generate.rb

@@ -0,0 +1,30 @@
+module Ecic
+  class Generate < Command    
+    
+    #--------------------------------------------------------------------------
+    # TESTBENCH generator:
+    #--------------------------------------------------------------------------
+    class_option :verbose, :type => :boolean
+
+    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")
+    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
+    end
+  end
+end

data/lib/ecic/help.rb

@@ -0,0 +1,14 @@
+module Ecic::Help
+  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)
+    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)
+    end
+  end
+end

data/lib/ecic/help/completion.md

@@ -0,0 +1,22 @@
+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

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

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

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

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

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

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

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

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

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

data/lib/ecic/help/new.md

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

data/lib/ecic/help/new_short.md

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

data/lib/ecic/version.rb

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

data/spec/lib/cli_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Ecic::CLI do
+  before(:all) do
+    @args = "--from Tung"
+  end
+
+  describe "ecic" do
+    it "hello" do
+      out = execute("exe/ecic hello world #{@args}")
+      expect(out).to include("from: Tung\nHello world")
+    end
+
+    it "goodbye" do
+      out = execute("exe/ecic sub goodbye world #{@args}")
+      expect(out).to include("from: Tung\nGoodbye world")
+    end
+
+    commands = {
+      "hell" => "hello",
+      "hello" => "name",
+      "hello -" =>  "--from",
+      "hello name" => "--from",
+      "hello name --" => "--from",
+      "sub goodb" => "goodbye",
+      "sub goodbye" => "name",
+      "sub goodbye name" => "--from",
+      "sub goodbye name --" => "--from",
+      "sub goodbye name --from" => "--help",
+    }
+    commands.each do |command, expected_word|
+      it "completion #{command}" do
+        out = execute("exe/ecic completion #{command}")
+        expect(out).to include(expected_word) # only checking for one word for simplicity
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+ENV["TEST"] = "1"
+
+# CodeClimate test coverage: https://docs.codeclimate.com/docs/configuring-test-coverage
+# require 'simplecov'
+# SimpleCov.start
+
+require "pp"
+require "byebug"
+root = File.expand_path("../", File.dirname(__FILE__))
+require "#{root}/lib/ecic"
+
+module Helper
+  def execute(cmd)
+    puts "Running: #{cmd}" if show_command?
+    out = `#{cmd}`
+    puts out if show_command?
+    out
+  end
+
+  # Added SHOW_COMMAND because DEBUG is also used by other libraries like
+  # bundler and it shows its internal debugging logging also.
+  def show_command?
+    ENV['DEBUG'] || ENV['SHOW_COMMAND']
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helper
+end

metadata

@@ -1,68 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: ecic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Torben Fox Jacobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2018-10-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: This gem allows you to easily create a new ASIC/FPGA project with a file
   structure and support tools that ensures consistency between your projects and gets
   you up to speed in no time. To create a new project simply type 'ecic new PATH'.
 email:
 - ecic@ic-factory.com
-executables: []
+executables:
+- ecic
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -71,12 +131,31 @@ files:
 - config/ecic.yaml
 - config/locales/help.en.yaml
 - ecic.gemspec
+- exe/ecic
 - features_wishlist.md
 - lib/ecic.rb
+- lib/ecic/cli.rb
+- lib/ecic/command.rb
+- lib/ecic/completer.rb
+- lib/ecic/completer/script.rb
+- lib/ecic/completer/script.sh
+- 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_generator.rb
 - lib/ecic/version.rb
 - notes.txt
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb
 - templates/project/Gemfile
 - templates/project/config/libraries.rb
 - templates/project/config/project.rb
@@ -103,9 +182,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: 'Easy-IC : provides a framework for ASIC and FPGA projects that favors convention
   over configuration.'
-test_files: []
+test_files:
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb