canoe 0.2.1 → 0.3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d6318d9757575b6e8f3f118e161ca06bb08655f26e7531e33c31d63f26aa18
-  data.tar.gz: 5cb8230a80e4bb2f03b8afb3dbebea90fccfd4b97bafa652502b2161e70ce374
+  metadata.gz: 7c1916c0ee5ce05d67222c84f93ac7e41de04895ffb523b1a5435276c6f8e11f
+  data.tar.gz: f3b69717aed857c30f8154fb1f63126b8f84c42081890ef1be75c6d2a7250735
 SHA512:
-  metadata.gz: 9501ebdd1d4ef09e6bfaede0c712044d665650b2a9d07dcfe490fe35afc378dae1d66429dc5919e217b48f4d3df9156611a4c496c64ebe3916870fc2da48453a
-  data.tar.gz: 848272aacd562ef7bc05ae50bd948a4221721b9432be46acb669e8ee6bb4f5a27e7e7ed57d5e6b64d83fce52be6a882955324f0c782b9e9252611ed29ba50cf8
+  metadata.gz: adae82066e778ae3756d970b75fb87784087e25996051c9cd5dd5ad75f265c09418eeb5c4387db9b0c9c125d1b1739461f1f0a0dfc72cde9f1914a65023eb030
+  data.tar.gz: 7d31ba373cf0a9a7f41178a153ee8fd7f9eb442a2698ec464c5ea9ca247b9816765f2bc17db1d0902209c6e6e4ff4bc238a4d7e9fa59cf74ba29a841bf519c3b

data/lib/canoe.rb

@@ -4,7 +4,16 @@ 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']
     @cmd = CmdParser.new options
   end
 

data/lib/cmd.rb

@@ -2,6 +2,9 @@ require_relative "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
         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
+  ##
+  # @name: String
+  # @flgs: Array of String
   def initialize(name, flgs)
     @name = name
-    @flags = flgs
+    @linking_flags = flgs.filter {|f| f.start_with? "-l"}
+    @compiling_flags = flgs - @linking_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,88 @@
+##
+# 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": {
+                  "opt": "-O2",
+                  "debug": "-g",
+                  "std": "-std=c++17"
+              }
+          }
+        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,11 +29,19 @@ 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|
@@ -40,7 +61,12 @@ class DepAnalyzer
       return true
     else
       deps[file].each do |f|
-        return true if mark(f, build_time, deps)
+        return @recompiles[f] if @processed[f]
+        @processed[f] = true
+        if mark(f, build_time, deps)
+          @recompiles[f] = true
+          return true 
+        end
       end
     end
     false
@@ -49,7 +75,11 @@ class DepAnalyzer
   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.rb

@@ -1,11 +1,11 @@
 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'
+require_relative 'coloring'
 
 class WorkSpace
   include Err
@@ -18,7 +18,9 @@ class WorkSpace
                 
                 canoe build: compile current project (execute this command in project directory)
 
-                canoe generate: generate dependency relationship and store it in '.canoe.deps'
+                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)
                 
@@ -27,7 +29,8 @@ class WorkSpace
                 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 dep: show current dependency relationships of current project
                 
                 canoe verion: version information
 
@@ -38,11 +41,20 @@ class WorkSpace
 
                 [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
@@ -71,7 +83,7 @@ class WorkSpace
 
   def initialize(name, mode, src_suffix='cpp', hdr_suffix='hpp')
     @name = name
-    @compiler = Compiler.new 'clang++', '-Isrc/components'
+    @compiler = Compiler.new 'clang++', ['-Isrc/components']
     @cwd = Dir.new(Dir.pwd)
     @workspace = "#{Dir.pwd}/#{@name}"
     @src = "#{@workspace}/src"
@@ -79,6 +91,7 @@ class WorkSpace
     @obj = "#{@workspace}/obj"
     @third = "#{@workspace}/third-party"
     @target = "#{@workspace}/target"
+    @tests = "#{@workspace}/tests"
     @mode = mode
     @deps = '.canoe.deps'
 
@@ -91,18 +104,29 @@ class WorkSpace
   end
 
   def new
-    Dir.mkdir(@name)
+    begin
+      Dir.mkdir(@name)
+    rescue
+      abort_on_err "workspace #{@name} already exsits"
+    end
     Dir.mkdir(@src)
     Dir.mkdir(@components)
     Dir.mkdir("#{@workspace}/obj")
-    DefaultFiles.create_main(@src, @source_suffix) if @mode == :bin
+    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
+    # DefaultFiles.create_emacs_dir_local @workspace
 
     Dir.mkdir(@third)
     Dir.mkdir(@target)
-    puts "workspace #{@workspace} is created"
+    Dir.chdir(@workspace) do
+      system "git init"
+    end
+    puts "workspace #{@workspace.blue} is created"
   end
 
   # args are commandline parameters passed to `canoe build`    
@@ -114,7 +138,7 @@ class WorkSpace
     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?
+    if files.empty? && File.exist?(target)
       puts "nothing to do, all up to date"
       return
     end
@@ -136,6 +160,7 @@ class WorkSpace
   end
 
   def run(args)
+    return if @mode == :lib
     build []
     args = args.join " "
     puts "./target/#{@name} #{args}"
@@ -153,7 +178,7 @@ class WorkSpace
         unless Dir.exist? dir
           FileUtils.mkdir dir 
           Dir.chdir(dir) do
-            puts "created " + Dir.pwd
+            puts "created " + Dir.pwd.blue
             create_working_files prefix.join('__'), filename
           end
         end
@@ -165,12 +190,23 @@ class WorkSpace
     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 "#{k.blue} depends on: "
+        v.each {|f| puts "    #{f.blue}"}
         puts ""
       end
     end
   end
+
+  def test(args)
+    args.each do |arg|
+      case arg
+      when "all"
+        test_all
+      else
+        test_single arg        
+      end
+    end
+  end
   
   private
   def create_working_files(prefix, filename)
@@ -208,40 +244,62 @@ class WorkSpace
     @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
+  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, args)
+    # return if files.empty?
     build_compiler_from_config args
+    if build_common(files, args) && link_exectutable('./target', Dir.glob("obj/*.o"))
+        puts "BUILDING SUCCEEDED".green
+    else 
+      puts "building FAILED".red
+    end
+  end
+
+  def build_lib(files, args)
+    # return if files.empty?
+    build_compiler_from_config args
+    @compiler.append_compiling_flag '-fPIC'
+    if (build_common files, args) && link_shared('./target', Dir.glob("obj/*.o"))
+      puts "BUILDING SUCCEEDED".green
+    else 
+      puts "building FAILED".red
+    end
+  end
+
+  def build_common(files, args)
+    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|
-      puts "compiling #{f}"
+      progress = (compiled / total).round(2) * 100
+      printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
       fname = f.split("/")[-1]
-      o = @obj_prefix + fname.delete_suffix(File.extname(fname)) + '.o'
-      compile f, o
+      o = @obj_prefix + File.basename(fname, ".*") + '.o'
+      flag = false unless compile f, o 
+      compiled += 1
     end
     
     comps.each do |f|
-      puts "compiling #{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'
-      compile f, o
+      flag = false unless compile f, o
+      compiled += 1
     end
-    
-    link('./target', Dir.glob("obj/*.o")) unless files.empty?
-  end
-
-  def build_lib
-    puts "build a lib"
+    flag
   end
 
   def clean_obj

metadata

@@ -1,19 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0.1
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-07-11 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,6 +28,7 @@ files:
 - bin/canoe
 - lib/canoe.rb
 - lib/cmd.rb
+- lib/coloring.rb
 - lib/compiler.rb
 - lib/config_reader.rb
 - lib/default_files.rb
@@ -42,7 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -52,5 +58,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: []