canoe 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e9bebbc3472c5f6271c4c019f23bf18779492934ed86411f4d09384e51bfeab
-  data.tar.gz: 9aa82b75a58e0992653ddc5419bf14e129846cc54cc9358f08baa1d2014d8d5a
+  metadata.gz: f6650afffc9e3aa13bb3489b419cd7e4f2b44f1f104be6fdffa77d0b2a66d072
+  data.tar.gz: fef3df6c97065e9274c2f95e2b2993a740d46a563e9e04b7359fbb4b69d4f95d
 SHA512:
-  metadata.gz: fd9be9cc303239eaa9853c177501e460023279a6385094afbe79e55b912257cebe72860633b53503dff96583a61aa88ea6034ce0e741e36f4fce8acce33c2496
-  data.tar.gz: 6ee389790c8490d80ef9742e877fc0de8b13b6b74629361e68f363155c628a0dff1764d066f4608b0b7e7cef72f20b1775c2b214be487b4bdcf943ab1b985c3f
+  metadata.gz: 1c093606ffcc64c3679afc3b8998841e7e1b8e83a2315d5bc8f1ad91e2c3b36d3eac5d649dda55d27287600ba52c9880c2f65b612b65f5fb57dbeac06ddc865b
+  data.tar.gz: 7483c43fa9d8f91c27be1b042f2b151187a867e85fd4cffc57f84b0a01c892583ef3f7d57ad6c816ad50668cabdfcb4e6c955db9c95aba8037ccf30c02eb0054

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/compiler.rb

@@ -1,33 +1,47 @@
+##
+# 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_executable(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(" ")}"
+    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)
-    libs = flags.select {|f| f.start_with?('-l')}
-    puts "#{name} -shared -o #{out}.so #{objs.join(" ")} #{libs.join(" ")}"
-    system "#{name} -shared -o #{out}.so #{objs.join(" ")} #{libs.join(" ")}"
+    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

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,82 +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
-
-  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 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
+  class << self
+    def open_file_and_write(filename, content)
+      File.open(filename, "w") {|f|
+        f.write(content)
+      }
+    end
 
-  def self.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}__
+    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
 
-        #endif
-      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,16 @@ class DepAnalyzer
   end
 
   def self.compiling_filter(deps, build_time, src_sfx='cpp', hdr_sfx='hpp')
-    files = [] 
+    files = []
+    @processed = {}
+    deps.keys.each do |k|
+      @processed[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
         next
       end
       v.each do |f|
@@ -40,6 +58,8 @@ class DepAnalyzer
       return true
     else
       deps[file].each do |f|
+        next if @processed[f]
+        @processed[f] = true
         return true if mark(f, build_time, deps)
       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,5 +1,4 @@
 require 'fileutils'
-require 'open3'
 require_relative 'source_files'
 require_relative 'compiler'
 require_relative 'config_reader'
@@ -84,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"
@@ -92,6 +91,7 @@ class WorkSpace
     @obj = "#{@workspace}/obj"
     @third = "#{@workspace}/third-party"
     @target = "#{@workspace}/target"
+    @tests = "#{@workspace}/tests"
     @mode = mode
     @deps = '.canoe.deps'
 
@@ -115,10 +115,13 @@ class WorkSpace
     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)
+    Dir.chdir(@workspace) do
+      system "git init"
+    end
     puts "workspace #{@workspace} is created"
   end
 
@@ -189,6 +192,17 @@ class WorkSpace
       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)
@@ -227,45 +241,63 @@ class WorkSpace
   end
 
   def link_exectutable(odir, objs)
+    puts "[100%] linking"
     @compiler.link_executable "#{odir}/#{@name}", objs
   end
 
   def link_shared(odir, objs)
+    puts "[100%] linking"
     @compiler.link_shared "#{odir}/lib#{@name}", objs
   end
 
   def build_bin(files, args)
     return if files.empty?
     build_compiler_from_config args
-    build_common files, args
-    link_exectutable('./target', Dir.glob("obj/*.o"))
+    if build_common(files, args)
+      link_exectutable('./target', Dir.glob("obj/*.o"))
+      puts "canoe: building succeeded"
+    else 
+      puts "canoe: building failed"
+    end
   end
 
   def build_lib(files, args)
     return if files.empty?
     build_compiler_from_config args
-    @compiler.append_flag '-fPIC'
-    build_common files, args
-    link_shared('./target', Dir.glob("obj/*.o"))
+    @compiler.append_compiling_flag '-fPIC'
+    if (build_common files, args)
+      link_shared('./target', Dir.glob("obj/*.o"))
+      puts "canoe: building succeeded"
+    else 
+      puts "canoe: building failed"
+    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}%%] compiling #{f}: "
       fname = f.split("/")[-1]
       o = @obj_prefix + fname.delete_suffix(File.extname(fname)) + '.o'
-      compile f, 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}%%] 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
+    flag
   end
 
   def clean_obj

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.