canoe 0.2.2 → 0.3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f566352f0c1f023e7d5d9481ba4656addf63dfc345efdc4cbdd2f1c5a08197ac
-  data.tar.gz: 2b02a4504909c6ab773124c78466e6c65533d82f3e1e6d926cb3848cf74469c1
+  metadata.gz: acf64e52f86562fbb4103263adf6ac25d3583fdd8cc935df460d6df89ffa4367
+  data.tar.gz: 8f3e6ba476da88e1cd34abffb4bfa70e0ac910fb5bc93977601df49e44a75735
 SHA512:
-  metadata.gz: 266403dfd576dcfc09757c921e49b2b4d6c49fd5dfd1666fb457ba3d29f6c7145524c511740da8e5418781012bec858b1a34bb60aea8f7b9b03cd6f7890016bd
-  data.tar.gz: 21cbee6eb840e3d4d97cc466527819fae84c7ef6b406678a1d97ea0dc5cbd785241ce92349d3045b0c86a829b5eff2a5eb879f7341fda522f1dcbc6fcee789fd
+  metadata.gz: e39ce423d813c64ef43c4440990439463a99dcb724771adc2d4d5db130c8206d7a3801c9fd036ee1477cd5c162f19b3da3dbc123e6114cba5bc7d8c0bf7d03a0
+  data.tar.gz: fe49d0b455bb21deb30b149f08736e2cff7091d8a3d38f87ac395fa1800c8b9abdb7c17594007412f5aacce448da5ebb60fd9a986fbf2ab645737aa59cd9100f

data/bin/canoe

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# require_relative '../lib/canoe'
 require 'canoe'
 
 Canoe.new.parse ARGV

data/lib/canoe.rb

@@ -1,10 +1,20 @@
-require_relative "workspace"
+require_relative "workspace/workspace.rb"
 require_relative "cmd"
 require_relative "source_files"
 
 class Canoe
   def initialize
-    options = ["new", "build", "run", "clean", "help", "add", "generate", "deps", "version"]
+    options = ['new', 
+               'add',
+               'build',
+               'generate',
+               'run',
+               'dep',
+               'clean',
+               'version',
+               'help',
+               'update',
+               'test']
     @cmd = CmdParser.new options
   end
 

data/lib/cmd.rb

@@ -1,7 +1,10 @@
-require_relative "workspace"
+require_relative "workspace/workspace"
 require_relative "err"
 require_relative "config_reader"
 
+##
+# class CmdParser
+#   Parsing command arguments passed to canoe
 class CmdParser
   include Err
   def initialize(options)
@@ -85,9 +88,13 @@ class CmdParser
     get_current_workspace.clean
   end
 
+  def parse_test(args)
+    get_current_workspace.test args
+  end
+
   def parse_version(args)
     puts <<~VER
-        canoe v0.2.1
+        canoe v0.3.0.2
         For features in this version, please visit https://github.com/Dicridon/canoe
         Currently, canoe can do below:
             - project creation

data/lib/coloring.rb

@@ -0,0 +1,23 @@
+##
+# gem Colorize is a great tool, but I don't want add dependencies to Canoe
+class String
+  def self.define_coloring_methods
+    colors = {
+        30 => :black,
+        31 => :red,
+        32 => :green,
+        33 => :yellow,
+        34 => :blue,
+        35 => :magenta,
+        36 => :cyan,
+        37 => :white
+    }
+    colors.each do |k, v|
+      define_method v do
+        "\033[#{k}m#{self}\033[0m"
+      end
+    end
+  end
+
+  define_coloring_methods
+end

data/lib/compiler.rb

@@ -1,29 +1,49 @@
+##
+# class Compiler
+#   Storing compiler name in String and flags as an array
 class Compiler
   attr_reader :name, :flags
-  def initialize(name, flgs)
+  ##
+  # @name: String
+  # @flgs: Array of String
+  def initialize(name, compiling_flags, linking_flags)
     @name = name
-    @flags = flgs
+    @linking_flags = linking_flags
+    @compiling_flags = compiling_flags
   end
 
-  def flags_as_str
-    flags.join " "
+  def compiling_flags_as_str
+    @compiling_flags.join " "
   end
 
-  def append_flag(flag)
-    @flags << flag
+  def linking_flags_as_str
+    @linking_flags.join " "
+  end
+
+
+  def append_compiling_flag(flag)
+    @compiling_flags << flag
+  end
+
+  def append_linking_flag(flag)
+    @linking_flags << flag
   end
 
   def compile(src, out)
-    puts "#{name} -o #{out} #{flags_as_str} -c #{src}"
-    system "#{name} -o #{out} #{flags_as_str} -c #{src}"
+    puts "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
+    system "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
   end
 
-  def link(out, objs)
-    libs = flags.select {|f| f.start_with?('-l')}
-    puts "#{name} -o #{out} #{objs.join(" ")} #{libs.join(" ")}"
-    system "#{name} -o #{out} #{objs.join(" ")} #{libs.join(" ")}"
+  def link_executable(out, objs)
+    puts "#{name} -o #{out} #{objs.join(" ")} #{linking_flags_as_str}"
+    system "#{name} -o #{out} #{objs.join(" ")} #{linking_flags_as_str}"
   end
 
+  def link_shared(out, objs)
+    puts "#{name} -shared -o #{out}.so #{objs.join(" ")} #{linking_flags_as_str}"
+    system "#{name} -shared -o #{out}.so #{objs.join(" ")} #{linking_flags_as_str}"
+  end
+  
   def inspect
     puts "compiler name: #{name.inspect}"
     puts "compiler flags: #{flags.inspect}"

data/lib/config_reader.rb

@@ -1,5 +1,8 @@
 require 'json'
 
+##
+# class ConfigReader
+#   Just read a json file
 class ConfigReader
   def self.extract_flags(file)
     abort_on_err("config file #{file} does not exsit") unless File.exists? file

data/lib/default_files.rb

@@ -1,70 +1,93 @@
+##
+# class DefaultFiles
+#   A singleton class to generate header and souce files.
+#   TODO: consider using class source_file.rb in Pareater
 class DefaultFiles
-  def self.open_file_and_write(filename, content)
-    File.open(filename, "w") {|f|
-      f.write(content)
-    }
-  end
+  class << self
+    def open_file_and_write(filename, content)
+      File.open(filename, "w") do |f|
+        f.write(content)
+      end
+    end
 
-  def self.create_config(path, src_sfx='cpp', hdr_sfx='hpp')
-    open_file_and_write(
-      "#{path}/config.json", 
-      <<~CONFIG
-        {
-            "compiler": "clang++",
-            "header-suffix": "#{hdr_sfx}",
-            "source-suffix": "#{src_sfx}",
-            "flags": {
-                "opt": "-O2",
-                "debug": "-g",
-                "std": "-std=c++17"
-            }
-        }
-      CONFIG
-    )
-  end
+    def create_config(path, src_sfx='cpp', hdr_sfx='hpp')
+      open_file_and_write(
+        "#{path}/config.json", 
+        <<~CONFIG
+          {
+              "compiler": "clang++",
+              "header-suffix": "#{hdr_sfx}",
+              "source-suffix": "#{src_sfx}",
+              "flags": {
+                  "compile": {
+                      "opt": "-O2",
+                      "debug": "-g",
+                      "std": "-std=c++17"
+                  },
+                  "link": {
+                    
+                  }
+              }
+          }
+        CONFIG
+      )
+    end
 
-  def self.create_main(path, suffix='cpp')
-    open_file_and_write(
-      "#{path}/main.#{suffix}",
-      <<~DOC
-        #include <iostream>
-        int main(int argc, char *argv[]) {
-            std::cout << "hello world!" << std::endl;
-        }
-      DOC
-    )
-  end
+    def create_main(path, suffix='cpp')
+      open_file_and_write(
+        "#{path}/main.#{suffix}",
+        <<~DOC
+          #include <iostream>
+          int main(int argc, char *argv[]) {
+              std::cout << "hello world!" << std::endl;
+          }
+        DOC
+      )
+    end
 
-  def self.create_emacs_dir_local(path)
-    open_file_and_write(
-      "#{path}/.dir-locals.el",
-      <<~DOC
-        ((nil . ((company-clang-arguments . ("-I./src/components/"
-                                             "-I./components/"))))
-         (nil . ((company-c-headers-path-user . ("./src/components/"
-                                 "./components/")))))
-      DOC
-    )
-  end
+    def create_lib_header(path, lib_name, suffix='hpp')
+      open_file_and_write(
+        "#{path}/#{lib_name}.#{suffix}",
+        <<~DOC
+          #ifndef __#{lib_name.upcase}__
+          #define __#{lib_name.upcase}__
+         
+          #endif
+        DOC
+      )
+    end
 
-  def self.create_cpp(filename, src_sfx='cpp', hdr_sfx='hpp')
-    open_file_and_write(
-      "#{filename}.#{src_sfx}", 
-      <<~DOC
-                #include "#{filename}.#{hdr_sfx}"
-            DOC
-    )
-  end
+    # def create_emacs_dir_local(path)
+    #   open_file_and_write(
+    #     "#{path}/.dir-locals.el",
+    #     <<~DOC
+    #       ((nil . ((company-clang-arguments . ("-I./src/components/"
+    #                                            "-I./components/"))))
+    #        (nil . ((company-c-headers-path-user . ("./src/components/"
+    #                                "./components/")))))
+    #     DOC
+    #   )
+    # end
 
-  def self.create_hpp(workspace, prefix, filename, hdr_sfx='hpp')
-    open_file_and_write(
-      "#{filename}.#{hdr_sfx}",
-      <<~DOC
-        #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
-        #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+    def create_cpp(filename, src_sfx='cpp', hdr_sfx='hpp')
+      open_file_and_write(
+        "#{filename}.#{src_sfx}", 
+        <<~DOC
+          #include "#{filename}.#{hdr_sfx}"
+        DOC
+      )
+    end
 
-        #endif
-      DOC
-    )
+    def create_hpp(workspace, prefix, filename, hdr_sfx='hpp')
+      open_file_and_write(
+        "#{filename}.#{hdr_sfx}",
+        <<~DOC
+          #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+          #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+          
+          #endif
+        DOC
+      )
+    end
   end
 end

data/lib/dependence.rb

@@ -1,6 +1,19 @@
 require_relative 'source_files'
 require_relative 'err'
 
+##
+# class DepAnalyzer
+#   This class is the key component of canoe, which offers file dependency analysis functionality. 
+#     A DepAnalyzer takes a directory as input, sources files and corresponding header files in this
+#     directory should have same name, i.e. test.cpp and test.hpp.
+#     DepAnalyzer would read every source file and recursively process user header files included in this source file to
+#     find out all user header files this source file depends on.
+#     Based on dependencies built in previous stage, DepAnalyzer determines which files should be recompiled and return
+#     these files to caller.
+#
+#     Dependencies could be written to a file to avoid wasting time parsing all files, Depanalyzer would read from
+#     this file to construct dependencies. But if sources files included new headers or included headers are revmoed,
+#     Depanalyzer should rebuild the whole dependencies.
 class DepAnalyzer
   include Err
   def self.read_from(filename)
@@ -16,16 +29,26 @@ class DepAnalyzer
   end
 
   def self.compiling_filter(deps, build_time, src_sfx='cpp', hdr_sfx='hpp')
-    files = [] 
+    files = []
+    @processed = {}
+    @recompiles = {}
+    deps.keys.each do |k|
+      @processed[k] = false
+      @recompiles[k] = false
+    end
     deps.each do |k, v|
       next if k.end_with? ".#{hdr_sfx}"
       if should_recompile?(k, build_time)
         files << k
+        @processed[k] = true
+        @recompiles[k] = true
         next
       end
       v.each do |f|
         if mark(f, build_time, deps) || mark(f.sub(".#{hdr_sfx}", ".#{src_sfx}"), build_time, deps)
           files << k
+          @processed[k] = true
+          @recompiles[k] = true
           break
         end
       end
@@ -35,21 +58,34 @@ class DepAnalyzer
 
   private
   def self.mark(file, build_time, deps)
+    ret = false
     return false unless File.exists? file
     if should_recompile?(file, build_time)
       return true
     else
       deps[file].each do |f|
-        return true if mark(f, build_time, deps)
+        if @processed[f]
+          ret |= @recompiles[f]
+          next
+        end
+        @processed[f] = true
+        if mark(f, build_time, deps)
+          @recompiles[f] = true
+          return true 
+        end
       end
     end
-    false
+    ret
   end
 
   def self.should_recompile?(file, build_time) 
     judge = build_time
     if build_time == Time.new(0)
-      objfile = "./obj/#{File.basename(file, ".*")}.o"
+      objfile = if file.start_with?("./src/components")
+                  './obj/' + file.delete_suffix(File.extname(file))['./src/components/'.length..].gsub('/', '_') + '.o'
+                else
+                  "./obj/#{File.basename(file, ".*")}.o"
+                end
       return true unless File.exists? objfile
       judge = File.mtime(objfile)
     end

data/lib/err.rb

@@ -1,7 +1,8 @@
+require_relative 'coloring'
 module Err
   def warn_on_err(err)
     puts <<~ERR
-           Warning: 
+           #{"Waring: ".yellow}
                #{err}
            try 'canoe help' for more information
          ERR
@@ -9,11 +10,11 @@ module Err
 
   def abort_on_err(err)
     abort <<~ERR
-            Fatal: 
+            #{"Fatal: ".red}
                 #{err}
             try 'canoe help' for more information
          ERR
   end
 
   module_function :warn_on_err, :abort_on_err
-end
+end

data/lib/source_files.rb

@@ -1,3 +1,6 @@
+##
+# class SourceFiles
+#   A simple class to assist collect all files or some files in a directory.
 class SourceFiles
   class << self
     def get_all(dir, &block)

data/lib/workspace/add.rb

@@ -0,0 +1,26 @@
+class WorkSpace
+  def add(args)
+    args.each do |i|
+      dir = @components
+      filenames = i.split("/")
+      prefix = []
+      filenames.each do |filename|
+        dir += "/#{filename}"
+        prefix << filename
+        unless Dir.exist? dir
+          FileUtils.mkdir dir 
+          Dir.chdir(dir) do
+            puts "created " + Dir.pwd.blue
+            create_working_files prefix.join('__'), filename
+          end
+        end
+      end
+    end
+  end
+
+private
+  def create_working_files(prefix, filename)
+    DefaultFiles.create_cpp filename, @source_suffix, @header_suffix
+    DefaultFiles.create_hpp @name, prefix, filename, @header_suffix
+  end
+end

data/lib/workspace/build.rb

@@ -0,0 +1,130 @@
+class WorkSpace
+  # args are commandline parameters passed to `canoe build`, 
+  # could be 'all', 'test', 'target' or empty
+  def build(args)
+    case args[0]
+    when "all"
+      build_all
+    when "test"
+      build_test
+    else
+      build_target
+    end
+  end
+
+private
+  def build_flags(flags, config) 
+    config.values.each do |v|
+      case v
+      when String
+        flags << v
+      when Array
+        v.each do |o|
+          flags << o
+        end
+      else
+        abort_on_err "unknown options in config.json, #{v}"
+      end
+    end
+  end
+
+  def build_compiler_from_config
+    Dir.chdir(@workspace) do
+      flags = ConfigReader.extract_flags "config.json"
+      compiler_name = flags['compiler'] ? flags['compiler'] : "clang++"
+      abort_on_err "compiler #{compiler_name} not found" unless File.exists?("/usr/bin/#{compiler_name}")
+      compiler_flags = ['-Isrc/components']
+      linker_flags = []
+
+      c_flags, l_flags = flags['flags']['compile'], flags['flags']['link']
+      build_flags(compiler_flags, c_flags)
+      build_flags(linker_flags, l_flags)
+
+      @compiler = Compiler.new compiler_name, compiler_flags, linker_flags
+    end
+  end
+
+  def compile(f, o)
+    @compiler.compile f, o
+  end
+
+  def link_exectutable(odir, objs)
+    puts "#{"[100%]".green} linking"
+    @compiler.link_executable "#{odir}/#{@name}", objs
+  end
+
+  def link_shared(odir, objs)
+    puts "#{"[100%]".green} linking"
+    @compiler.link_shared "#{odir}/lib#{@name}", objs
+  end
+
+  def build_bin(files)
+    # return if files.empty?
+    build_compiler_from_config
+    if build_common(files) && link_exectutable('./target', Dir.glob("obj/*.o"))
+        puts "BUILDING SUCCEEDED".green
+    else 
+      puts "building FAILED".red
+    end
+  end
+
+  def build_lib(files)
+    # return if files.empty?
+    build_compiler_from_config
+    @compiler.append_compiling_flag '-fPIC'
+    if build_common(files) && link_shared('./target', Dir.glob("obj/*.o"))
+      puts "BUILDING SUCCEEDED".green
+    else 
+      puts "building FAILED".red
+    end
+  end
+
+  def build_common(files)
+    all = SourceFiles.get_all('./src') {|f| f.end_with? @source_suffix}
+    total = all.size.to_f
+    compiled = total - files.size
+    comps = files.select {|f| f.start_with? @components_prefix}
+    srcs = files - comps
+    flag = true;
+    
+    srcs.each do |f|
+      progress = (compiled / total).round(2) * 100
+      printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
+      fname = f.split("/")[-1]
+      o = @obj_prefix + File.basename(fname, ".*") + '.o'
+      flag = false unless compile f, o 
+      compiled += 1
+    end
+
+    comps.each do |f|
+      progress = (compiled / total).round(2) * 100
+      printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
+      o = @obj_prefix + f.delete_suffix(File.extname(f))[@components_prefix.length..]
+                         .gsub('/', '_') + '.o'
+      flag = false unless compile f, o
+      compiled += 1
+    end
+    flag
+  end
+
+  def build_all
+    build_target
+    build_test
+  end
+
+  def build_target
+    deps = File.exist?(@deps) ? 
+           DepAnalyzer.read_from(@deps) :
+           DepAnalyzer.new('./src').build_to_file(['./src', './src/components'], @deps)
+    target = "./target/#{@name}"
+    build_time = File.exist?(target) ? File.mtime(target) : Time.new(0)
+    files = DepAnalyzer.compiling_filter(deps, build_time, @source_suffix, @header_suffix)
+
+    if files.empty? && File.exist?(target)
+      puts "nothing to do, all up to date"
+      return
+    end
+
+    self.send "build_#{@mode.to_s}", files
+  end
+end

data/lib/workspace/clean.rb

@@ -0,0 +1,26 @@
+class WorkSpace
+  def clean
+    self.send "clean_#{@mode.to_s}"
+  end
+  
+private    
+  def clean_obj
+    puts "rm -f ./obj/*.o"
+    system "rm -f ./obj/*.o"
+  end
+
+  def clean_target
+    puts "rm -f ./target/*"
+    system "rm -f ./target/*"
+  end
+
+  def clean_bin
+    clean_obj
+    clean_target
+  end
+
+  def clean_lib
+    clean_obj
+    clean_target
+  end
+end

data/lib/workspace/dep.rb

@@ -0,0 +1,12 @@
+class WorkSpace
+  def dep
+    deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
+    deps.each do |k, v|
+      unless v.empty?
+        puts "#{k.blue} depends on: "
+        v.each {|f| puts "    #{f.blue}"}
+        puts ""
+      end
+    end
+  end
+end

data/lib/workspace/generate.rb

@@ -0,0 +1,6 @@
+class WorkSpace
+  def generate
+    DepAnalyzer.new('./src', @source_suffix, @header_suffix)
+               .build_to_file ['./src', './src/components'], @deps
+  end
+end

data/lib/workspace/help.rb

@@ -0,0 +1,71 @@
+class WorkSpace
+  def self.help
+    info = <<~INFO
+            canoe is a C/C++ project manager, inspired by Rust cargo.
+            usage:
+                canoe new tada: create a project named 'tada' in current directory
+                  
+                canoe build: compile current project (execute this command in project directory)
+  
+                canoe generate: generate dependency relationships and store it in '.canoe.deps' file. Alias: update
+
+                canoe update: udpate dependency relationships and store it in '.canoe.deps' file. 
+                    
+                canoe run: compile and execute current project (execute this command in project directory)
+                  
+                canoe clean: remove all generated object files and binary files
+                  
+                canoe help: show this help message
+  
+                canoe add tada: add a folder named tada under workspace/components,
+                  
+                canoe dep: show current dependency relationships of current project
+                  
+                canoe verion: version information
+  
+            new project_name [mode] [suffixes]:
+                create a new project with project_name.
+                In this project, four directories obj, src, target and third-party will be generated in project directory.
+                in src, directory 'components' will be generated if [mode] is '--lib', an extra main.cpp will be generated if [mode] is '--bin'
+  
+                [mode]: --lib for a library and --bin for executable binaries
+                [suffixes]: should be in 'source_suffix:header_suffix" format, notice the ':' between two suffixes
+            add component_name:
+                add a folder named tada under workspace/components.
+                two files tada.hpp and tada.cpp would be craeted and intialized. File suffix may differ according users' specifications.
+                if component_name is a path separated by '/', then canoe would create folders and corresponding files recursively.
+  
+            generate: 
+                generate dependence relationship for each file, this may accelarate
+                `canoe buid` command. It's recommanded to execute this command everytime
+                headers are added or removed from any file.
+                
+            update:
+                this command is needed because '.canoe.deps' is actually a cache of dependency relationships so that canoe doesn't have to analyze all the files when building a project.
+                So when a file includes new headers or some headers are removed, users have to use 'canoe udpate'
+                to update dependency relationships.
+    
+            build [options]:
+                build current project, arguments in [options] will be passed to C++ compiler
+              
+            run [options]:
+                build current project with no specific compilation flags, and run this project, passing [options] as command line arguments to the binary
+  
+            clean:
+                remove all generated object files and binary files
+    
+            help:
+                show this help message
+  
+            verion: 
+                display version information
+    
+            dep:
+                display file dependencies in a better readable way
+    
+            @author: written by XIONG Ziwei, ICT, CAS
+            @contact: noahxiong@outlook.com
+        INFO
+    puts info
+  end
+end

data/lib/workspace/new.rb

@@ -0,0 +1,28 @@
+class WorkSpace
+  def new
+    begin
+      Dir.mkdir(@name)
+    rescue
+      abort_on_err "workspace #{@name} already exsits"
+    end
+    Dir.mkdir(@src)
+    Dir.mkdir(@components)
+    Dir.mkdir("#{@workspace}/obj")
+    if @mode == :bin
+      DefaultFiles.create_main(@src, @source_suffix) 
+    else
+      DefaultFiles.create_lib_header(@src, @name, @header_suffix)
+    end
+    File.new("#{@workspace}/.canoe", "w")
+    DefaultFiles.create_config @workspace, @source_suffix, @header_suffix
+    # DefaultFiles.create_emacs_dir_local @workspace
+    
+    Dir.mkdir(@third)
+    Dir.mkdir(@target)
+    Dir.mkdir(@tests)
+    Dir.chdir(@workspace) do
+      system "git init"
+    end
+    puts "workspace #{@workspace.blue} is created"
+  end
+end

data/lib/workspace/run.rb

@@ -0,0 +1,9 @@
+class WorkSpace
+  def run(args)
+    return if @mode == :lib
+    build []
+    args = args.join " "
+    puts "./target/#{@name} #{args}"
+    exec "./target/#{@name} #{args}"
+  end
+end

data/lib/workspace/test.rb

@@ -0,0 +1,39 @@
+class WorkSpace
+public
+  def test(args)
+    if args.empty?
+      test_all
+      return
+    end
+
+    args.each do |arg|
+      case arg
+      when "all"
+        test_all
+      else
+        test_single arg        
+      end
+    end
+  end
+
+private
+  def test_all
+    puts "tests all"
+  end
+
+  def test_single(name)
+    puts "#{@tests}/bin/test_#{name}"
+    # system "./#{@tests}/bin/test_#{name}"
+  end
+  
+  ##
+  # how to build:
+  # each test file tests one or more components, indicated by included headers
+  # find corresponding object file in ../obj and link them to test file
+  # TODO
+  def build_test
+    build
+    deps = DepAnalyzer.new('./tests').build_to_file(['./src', './src/components', './tests', './tests/common'], './tests/.canoe.deps')
+    puts deps
+  end
+end

data/lib/workspace/update.rb

@@ -0,0 +1,5 @@
+class WorkSpace
+  def update
+    generate
+  end
+end

data/lib/workspace/version.rb

@@ -0,0 +1,13 @@
+class WorkSpace
+  def version
+  puts <<~VER
+    canoe v0.3.0.2
+    For features in this version, please visit https://github.com/Dicridon/canoe
+    Currently, canoe can do below:
+        - project creation
+        - project auto build and run (works like Cargo for Rust)
+       - project structure management
+    by XIONG Ziwei
+    VER
+    end
+end

data/lib/workspace/workspace.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+require_relative '../source_files'
+require_relative '../compiler'
+require_relative '../config_reader'
+require_relative '../default_files'
+require_relative '../err'
+require_relative '../dependence'
+require_relative '../coloring'
+
+
+class WorkSpace
+  include Err
+  attr_reader :name, :cwd
+
+  def initialize(name, mode, src_suffix='cpp', hdr_suffix='hpp')
+    @name = name
+    @compiler = Compiler.new 'clang++', ['-Isrc/components'], []
+    @cwd = Dir.new(Dir.pwd)
+    @workspace = "#{Dir.pwd}/#{@name}"
+    @src = "#{@workspace}/src"
+    @components = "#{@src}/components"
+    @obj = "#{@workspace}/obj"
+    @third = "#{@workspace}/third-party"
+    @target = "#{@workspace}/target"
+    @tests = "#{@workspace}/tests"
+    @mode = mode
+    @deps = '.canoe.deps'
+
+    @src_prefix = './src/'
+    @components_prefix = './src/components/'
+    @obj_prefix = './obj/'
+
+    @source_suffix = src_suffix
+    @header_suffix = hdr_suffix
+  end
+
+  def inspect 
+    puts "name is #{@name}"
+    puts "name is #{@workspace}"
+  end
+end
+
+require_relative 'help'
+require_relative 'new'
+require_relative 'add'
+require_relative 'build'
+require_relative 'generate'
+require_relative 'run'
+require_relative 'dep'
+require_relative 'clean'
+require_relative 'version'
+require_relative 'update'
+require_relative 'test'

metadata

@@ -1,19 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0.2
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies: []
-description: |
-  Tired of writing Makefile, CMakeList and even SConstruct? Let Canoe help you wipe them out.
+description: |+
+  Canoe offers project management and building facilities to C/C++ projects.
+
+  If you are tired of writing Makefile, CMakeList and even SConstruct, please let Canoe help you wipe them out.
+
   Similar to Cargo for Rust, Canoe offers commands such as new, build, run, etc. to help you generate a C/C++ project and build it automatically.
-  No more Makefiles, Canoe would analyze dependencies and build like our old friend make if you follow a few conventions over file names
+
+  Different from tools like Scons and Blade, Canoe requires users to write NO building scripts, Canoe would analyze dependencies and build like our old friend 'make' if a few conventions over file names are followed.
+
 email: noahxiong@outlook.com
 executables:
 - canoe
@@ -23,13 +28,25 @@ files:
 - bin/canoe
 - lib/canoe.rb
 - lib/cmd.rb
+- lib/coloring.rb
 - lib/compiler.rb
 - lib/config_reader.rb
 - lib/default_files.rb
 - lib/dependence.rb
 - lib/err.rb
 - lib/source_files.rb
-- lib/workspace.rb
+- lib/workspace/add.rb
+- lib/workspace/build.rb
+- lib/workspace/clean.rb
+- lib/workspace/dep.rb
+- lib/workspace/generate.rb
+- lib/workspace/help.rb
+- lib/workspace/new.rb
+- lib/workspace/run.rb
+- lib/workspace/test.rb
+- lib/workspace/update.rb
+- lib/workspace/version.rb
+- lib/workspace/workspace.rb
 homepage: https://github.com/Dicridon/canoe
 licenses:
 - MIT
@@ -52,5 +69,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: a C/C++ project management and build tool
+summary: a C/C++ project management and building tool
 test_files: []

data/lib/workspace.rb

@@ -1,272 +0,0 @@
-require 'fileutils'
-require 'open3'
-require_relative 'source_files'
-require_relative 'compiler'
-require_relative 'config_reader'
-require_relative 'default_files'
-require_relative 'err'
-require_relative 'dependence'
-
-class WorkSpace
-  include Err
-  attr_reader :name, :cwd
-  def self.help
-    info = <<~INFO
-            canoe is a C/C++ project manager, inspired by Rust cargo.
-            usage:
-                canoe new tada: create a project named 'tada' in current directory
-                
-                canoe build: compile current project (execute this command in project directory)
-
-                canoe generate: generate dependency relationship and store it in '.canoe.deps'
-                
-                canoe run: compile and execute current project (execute this command in project directory)
-                
-                canoe clean: remove all generated object files and binary files
-                
-                canoe help: show this help message
-
-                canoe add tada: add a folder named tada under workspace/components,
-                                two files tada.hpp and tada.cpp would be craeted and intialized
-                
-                canoe verion: version information
-
-            new project_name [mode] [suffixes]:
-                create a new project with project_name.
-                In this project, four directories obj, src, target and third-party will be generated in project directory.
-                in src, directory 'components' will be generated if [mode] is '--lib', an extra main.cpp will be generated if [mode] is '--bin'
-
-                [mode]: --lib for a library and --bin for executable binaries
-                [suffixes]: should be in 'source_suffix:header_suffix" format, notice the ':' between two suffixes
-
-            generate: 
-                generate dependence relationship for each file, this may accelarate
-                `canoe buid` command. It's recommanded to execute this command everytime
-                headers are added or removed from any file.
-
-            build [options]:
-                build current project, arguments in [options] will be passed to C++ compiler
-            
-            run [options]:
-                build current project with no specific compilation flags, and run this project, passing [options] as command line arguments to the binary
-
-            clean:
-                remove all generated object files and binary files
-
-            help:
-                show this help message
-
-            verion: 
-                display version information
-
-            dep:
-                display file dependencies in a better readable way
-
-            @author: written by XIONG Ziwei, ICT, CAS
-            @contact: noahxiong@outlook.com
-        INFO
-    puts info
-  end
-
-
-  def initialize(name, mode, src_suffix='cpp', hdr_suffix='hpp')
-    @name = name
-    @compiler = Compiler.new 'clang++', '-Isrc/components'
-    @cwd = Dir.new(Dir.pwd)
-    @workspace = "#{Dir.pwd}/#{@name}"
-    @src = "#{@workspace}/src"
-    @components = "#{@src}/components"
-    @obj = "#{@workspace}/obj"
-    @third = "#{@workspace}/third-party"
-    @target = "#{@workspace}/target"
-    @mode = mode
-    @deps = '.canoe.deps'
-
-    @src_prefix = './src/'
-    @components_prefix = './src/components/'
-    @obj_prefix = './obj/'
-
-    @source_suffix = src_suffix
-    @header_suffix = hdr_suffix
-  end
-
-  def new
-    Dir.mkdir(@name)
-    Dir.mkdir(@src)
-    Dir.mkdir(@components)
-    Dir.mkdir("#{@workspace}/obj")
-    DefaultFiles.create_main(@src, @source_suffix) if @mode == :bin
-    File.new("#{@workspace}/.canoe", "w")
-    DefaultFiles.create_config @workspace, @source_suffix, @header_suffix
-    DefaultFiles.create_emacs_dir_local @workspace
-
-    Dir.mkdir(@third)
-    Dir.mkdir(@target)
-    puts "workspace #{@workspace} is created"
-  end
-
-  # args are commandline parameters passed to `canoe build`    
-  def build(args)
-    deps = File.exist?(@deps) ? 
-             DepAnalyzer.read_from(@deps) :
-             DepAnalyzer.new('./src').build_to_file(['./src', './src/components'], @deps)
-    target = "./target/#{@name}"
-    build_time = File.exist?(target) ? File.mtime(target) : Time.new(0)
-    files = DepAnalyzer.compiling_filter(deps, build_time, @source_suffix, @header_suffix)
-
-    if files.empty?
-      puts "nothing to do, all up to date"
-      return
-    end
-    
-    self.send "build_#{@mode.to_s}", files, args 
-  end
-
-  def generate
-    DepAnalyzer.new('./src', @source_suffix, @header_suffix)
-               .build_to_file ['./src', './src/components'], @deps
-  end
-
-  def update
-    generate
-  end
-
-  def clean
-    self.send "clean_#{@mode.to_s}"
-  end
-
-  def run(args)
-    build []
-    args = args.join " "
-    puts "./target/#{@name} #{args}"
-    exec "./target/#{@name} #{args}"
-  end
-
-  def add(args)
-    args.each do |i|
-      dir = @components
-      filenames = i.split("/")
-      prefix = []
-      filenames.each do |filename|
-        dir += "/#{filename}"
-        prefix << filename
-        unless Dir.exist? dir
-          FileUtils.mkdir dir 
-          Dir.chdir(dir) do
-            puts "created " + Dir.pwd
-            create_working_files prefix.join('__'), filename
-          end
-        end
-      end
-    end
-  end
-
-  def dep
-    deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
-    deps.each do |k, v|
-      unless v.empty?
-        puts "#{k} depends on: "
-        v.each {|f| puts "    #{f}"}
-        puts ""
-      end
-    end
-  end
-  
-  private
-  def create_working_files(prefix, filename)
-    DefaultFiles.create_cpp filename, @source_suffix, @header_suffix
-    DefaultFiles.create_hpp @name, prefix, filename, @header_suffix
-  end
-
-  def build_compiler_from_config(args)
-    Dir.chdir(@workspace) do
-      flags = ConfigReader.extract_flags "config.json"
-      compiler_name = flags['compiler'] ? flags['compiler'] : "clang++"
-      abort_on_err "compiler #{compiler_name} not found" unless File.exists?("/usr/bin/#{compiler_name}")
-      compiler_flags = ['-Isrc/components'] + args
-      
-      if opts = flags['flags'] 
-        opts.each do |k, v|
-          case v
-          when String
-            compiler_flags << v
-          when Array
-            v.each do |o|
-              compiler_flags << o
-            end
-          else
-            abort_on_err "unknown options in config.json, #{v}"
-          end
-        end
-      end
-
-      @compiler = Compiler.new compiler_name, compiler_flags
-    end
-  end
-
-  def compile(f, o)
-    @compiler.compile f, o
-  end
-
-  def link(odir, objs)
-    status = system "#{@compiler} -o #{odir}/#{@name} #{objs.join(" ")}"
-    unless status
-      puts "compilation failed"
-      return
-    end
-    
-    @compiler.link "#{odir}/#{@name}", objs
-  end
-
-  def build_bin(files, args)
-    build_compiler_from_config args
-    comps = files.select {|f| f.start_with? @components_prefix}
-    srcs = files - comps
-    
-    srcs.each do |f|
-      puts "compiling #{f}"
-      fname = f.split("/")[-1]
-      o = @obj_prefix + fname.delete_suffix(File.extname(fname)) + '.o'
-      compile f, o
-    end
-    
-    comps.each do |f|
-      puts "compiling #{f}"
-      o = @obj_prefix + f.delete_suffix(File.extname(f))[@components_prefix.length..]
-                         .gsub('/', '_') + '.o'
-      compile f, o
-    end
-    
-    link('./target', Dir.glob("obj/*.o")) unless files.empty?
-  end
-
-  def build_lib
-    puts "build a lib"
-  end
-
-  def clean_obj
-    puts "rm -f ./obj/*.o"
-    system "rm -f ./obj/*.o"
-  end
-
-  def clean_target
-    puts "rm -f ./target/*"
-    system "rm -f ./target/*"
-  end
-
-  def clean_bin
-    clean_obj
-    clean_target
-  end
-
-  def clean_lib
-    clean_obj
-    clean_target
-  end
-
-  public
-  def inspect 
-    puts "name is #{@name}"
-    puts "name is #{@workspace}"
-  end
-end