canoe 0.3.3 → 0.3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c8e08b29045ffc655f4dedf9cb358b70e643702dac79a88d81436e39ba9ace1
-  data.tar.gz: 2d5a877f870fa531b236f570c52f3b97ec9fc7efd35c0b05447f1e7e850f47e1
+  metadata.gz: 28de761c23336af9df9ed1117d47f85c22f77abd3030195462d0e43ccba5091c
+  data.tar.gz: f0734ecf77c58d6d86a72835fff2e56e1ff49504be3f2ad7cc3e182e550b5623
 SHA512:
-  metadata.gz: a40625eaafec1023609c210a5d84710433b3d34557fc1079b9a0ca441da60ecfc6316ab4d9e1c40991530c6fb8c49155109561f3663699dfffe3bd23cf6e1c44
-  data.tar.gz: 47fde1b6a149e118d6b835e2d82e55654627a08c98faa2a8535a9e142f29a2eda5b0572da9f43c13084932e70777502df48cd608ac2db27f8586c0538acab5a2
+  metadata.gz: ff0167eca4be655a4cc33258b5dddfa07e7cbad53d6745b38d75eb301c032403d5338e6249f7704dee460dbaa87a3a4141b8f1ca023abcff5af4a660691b4f2c
+  data.tar.gz: f5c494d7cefeefca5e2fd14353f9645479c29f4bb338330ebb9075d103fce73ea678bbb62823053bafdbe3bad497d7b5ecc8a3ca369ff078b937d1e7296e5fbd

data/lib/canoe.rb

@@ -3,20 +3,11 @@ require_relative 'cmd'
 require_relative 'source_files'
 
 module Canoe
+  ##
+  # Main class for building a canoe project
   class Builder
     def initialize
-      options = ['new',
-                 'add',
-                 'build',
-                 'generate',
-                 'make',
-                 'run',
-                 'dep',
-                 'clean',
-                 'version',
-                 'help',
-                 'update',
-                 'test']
+      options = %w[new add build generate make run dep clean version help update test]
       @cmd = CmdParser.new options
     end
 

data/lib/dependence.rb

@@ -1,24 +1,23 @@
 require_relative 'source_files'
 require_relative 'util'
-##
-# 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, e.g. 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.
 module Canoe
+  ##
+  # 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, e.g. 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
     include SystemCommand
 
     class << self
+      include Err
       include WorkSpaceUtil
       def read_from(filename)
         File.open(filename, 'r') do |f|
@@ -34,29 +33,28 @@ module Canoe
 
       def compiling_filter(deps, build_time, src_sfx = 'cpp', hdr_sfx = 'hpp')
         files = []
-        @processed = {}
         @recompiles = {}
         deps.each_key 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
+          # first analyze dependency to discover circular includes
           v.each do |f|
             next unless 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
+
+          next if @recompiles[k]
+
+          if should_recompile?(k, build_time)
+            files << k
+            @recompiles[k] = true
+          end
         end
         files
       end
@@ -64,22 +62,19 @@ module Canoe
       private
 
       def mark(file, build_time, deps)
-        ret = false
         return false unless File.exist? file
-        return true if should_recompile?(file, build_time)
 
+        # first analyze dependency to discover circular includes
         deps[file].each do |f|
-          if @processed[f]
-            ret |= @recompiles[f]
-            next
-          end
-          @processed[f] = true
           if mark(f, build_time, deps)
             @recompiles[f] = true
             return true
           end
+        rescue SystemStackError
+          puts "#{"Fatal: ".red}file #{file} is circularly included"
+          exit false
         end
-        ret
+        true if should_recompile?(file, build_time)
       end
 
       def should_recompile?(file, build_time)

data/lib/source_files.rb

@@ -13,13 +13,11 @@ class SourceFiles
       @files = []
       Dir.each_child(dir) do |f|
         file = "#{dir}/#{f}"
-        if File.file? file
-          if block_given?
-            @files << file.to_s if yield(f)
-          else
-            @files << file.to_s
-          end
-        end
+        next unless File.file?(file)
+
+        add = true
+        add = yield(f) if block_given?
+        @files << file.to_s if add
       end
 
       @files
@@ -32,13 +30,11 @@ class SourceFiles
         file = "#{dir}/#{f}"
         # we don't handle symlinks
         if File.file? file
-          if block_given?
-            @files << "#{file}" if yield(f)
-          else
-            @files << "#{file}"
-          end
+          add = true
+          add = yield(f) if block_given?
+          @files << file if add
         elsif File.directory? file
-          get_all_helper("#{file}", &block)
+          get_all_helper(file, &block)
         end
       end
     end

data/lib/util.rb

@@ -1,3 +1,4 @@
+# Many useful classes to record compiling progress, change file's name and issueing system commands
 require_relative 'coloring'
 
 require 'English'
@@ -59,6 +60,8 @@ module Canoe
     end
   end
 
+  ##
+  # issueing system commands by accepting a command string
   module SystemCommand
     def issue_command(cmd_str)
       puts cmd_str
@@ -72,7 +75,9 @@ module Canoe
       status
     end
   end
-  
+
+  ##
+  # Colorized error messages with abortion
   module Err
     def warn_on_err(err)
       puts <<~ERR

data/lib/workspace/add.rb

@@ -1,4 +1,5 @@
 module Canoe
+  # WorkSpace implementation
   class WorkSpace
     def add(args)
       args.each do |i|

data/lib/workspace/build.rb

@@ -135,7 +135,7 @@ module Canoe
       puts "#{'[BUILDING TARGET]'.magenta}..."
       target = "#{@target}/#{@name}"
       build_time = File.exist?(target) ? File.mtime(target) : Time.new(0)
-      files = DepAnalyzer.compiling_filter target_deps, build_time, @source_suffix, @header_suffix 
+      files = DepAnalyzer.compiling_filter(target_deps, build_time, @source_suffix, @header_suffix)
 
       if files.empty? && File.exist?(target)
         puts "nothing to do, all up to date"

data/lib/workspace/make.rb

@@ -84,7 +84,7 @@ module Canoe
     def define_variables(makefile, deps)
       define_dirs(makefile)
       src_files = deps.keys.select { |f| f.end_with? get_source_suffix }
-      
+
       generate_all_names(src_files)
       define_srcs(makefile, src_files)
       makefile.puts ''
@@ -163,15 +163,20 @@ module Canoe
     end
 
     def get_all_dep_name(file_name, deps)
-      dep = deps[file_name]
-      if dep.empty?
-        []
-      else
-        tmp = dep.map { |n| extract_name(n, @workspace.components_prefix).upcase }
-        dep.each do |d|
-          tmp += get_all_dep_name(d, deps)
+      begin
+        dep = deps[file_name]
+        if dep.empty?
+          []
+        else
+          tmp = dep.map { |n| extract_name(n, @workspace.components_prefix).upcase }
+          dep.each do |d|
+            tmp += get_all_dep_name(d, deps)
+          end
+          tmp
         end
-        tmp
+      rescue SystemStackError
+        puts "#{"Fatal: ".red}file #{file_name} is circularly included"
+        exit false
       end
     end
 
@@ -246,7 +251,7 @@ module Canoe
     def make_clean(makefile)
       clean = <<~DOC
             .PHONY: clean
-            clean: 
+            clean:
             \trm ./target/*
             \trm ./obj/*.o
             DOC

data/lib/workspace/test.rb

@@ -8,17 +8,21 @@ module Canoe
       # we don't handle spaces
       test_single(args[0], args[1..].join(" "))
     end
-    
+
     # extract one test file's dependency
     def extract_one_file(file, deps)
-      ret = deps[file]
-
-      deps[file].each do |f|
-        dep = extract_one_file(f, deps)
-        dep.each do |d|
-          ret << d unless ret.include?(d)
+      ret = deps[file].map { |f| f.gsub(".#{@header_suffix}", ".#{@source_suffix}") }
+      begin
+        deps[file].each do |f|
+          dep = extract_one_file(f, deps)
+          dep.each do |d|
+            ret << d unless ret.include?(d)
+          end
         end
-      end
+      rescue SystemStackError
+        puts "#{"Fatal: ".red}file #{file} is circularly included"
+        exit false
+      end      
       ret.map { |f| f.gsub(".#{@header_suffix}", ".#{@source_suffix}") }
     end
 
@@ -42,10 +46,11 @@ module Canoe
       bin = "#{@target_short}/test_#{name}"
 
       rebuild ||= !File.exist?(bin)
-      
+
       file = "#{@tests_short}/test_#{name}.#{@source_suffix}"
+      abort_on_err "No test file exists for #{name}" unless File.exist?(file)
       rebuild ||= File.mtime(bin) < File.mtime(file)
-      
+
       deps = fetch_all_deps
       extract_one_file(file, deps).each do |f|
         rebuild ||= File.mtime(bin) < File.mtime(f) || File.mtime(bin) < File.mtime(hdr_of_src(f))
@@ -77,26 +82,28 @@ module Canoe
       end.min
     end
 
-    # @deps is the dependency hash for tests
-    # cyclic dependency is not handled
-    # compiler should first be built
-    def compile_one_test(test_file, deps)
-      extract_one_file(test_file, deps).each do |f|
-        o = file_to_obj(f)
-        next if File.exist?(o) && File.mtime(o) > File.mtime(f) && File.mtime(o) > File.mtime(hdr_of_src(f))
-
-        compile(f, o)
-      end
-      compile(test_file, file_to_obj(test_file))
-    end
-
     def link_one_test(test_file, deps)
       target = "#{@target_short}/#{File.basename(test_file, '.*')}"
       @compiler.link_executable target, extract_one_file_obj(test_file, deps) + [file_to_obj(test_file)]
     end
 
-    def build_one_test(test_file, deps)
-      compile_one_test(test_file, deps)
+    def build_one_test(test_file, deps, indent = "")
+      files = DepAnalyzer.compiling_filter(target_deps, Time.new(0), @source_suffix, @header_suffix)
+      flag = true
+      files << test_file
+
+      stepper = Stepper.new(files.size, files.size)
+
+      files.each do |f|
+        o = file_to_obj(f)
+        printf "#{indent}#{stepper.progress_as_str.green} compiling #{f.yellow}: "
+        flag &= compile f, o
+        stepper.step
+      end
+      abort_on_err("Compiling errors encountered") unless flag;
+      
+      printf "#{indent}#{stepper.progress_as_str.green} compiling finished\n"
+      puts "#{indent}[100%]".green + " linking"
       link_one_test(test_file, deps)
     end
 
@@ -108,8 +115,8 @@ module Canoe
       stepper = Stepper.new fetch_all_test_files.size, files.size
 
       files.each do |f|
-        printf "#{stepper.progress_as_str.green} compiling #{f} "
-        compile_one_test(f, deps)
+        printf "#{stepper.progress_as_str.green} building #{File.basename(f, "." + @source_suffix).yellow}:\n"
+        build_one_test(f, deps, "    ")
         stepper.step
       end
     end
@@ -126,6 +133,7 @@ module Canoe
     end
 
     def build_test
+      build_compiler_from_config
       puts "#{'[COMPILING TESTS]'.magenta}..."
       return unless test_build_time
 

data/lib/workspace/version.rb

@@ -2,7 +2,7 @@ module Canoe
   class WorkSpace
     def self.version
       puts <<~VER
-           canoe v0.3.3
+           canoe v0.3.3.4
            For features in this version, please visit https://github.com/Dicridon/canoe
            Currently, canoe can do below:
                - project creation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.3.4
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-12-19 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.