canoe 0.3.2.4 → 0.3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18aa4cddd71a6a2b06ea69ea320de7e75b5a9155685d5f4918b5047faf9a83af
-  data.tar.gz: 488a487b6b2cb872fed7b81e604756c7676e279a3b750e720f3c219aa1f29210
+  metadata.gz: e7002afc65c5738fb7929e1b81cc491b9d7a7196b2ada01f3b6f580ccfe25133
+  data.tar.gz: 48632ed95d610599712de7f84fbfb8108c1195d9460cf1a96b8b22cccb59891c
 SHA512:
-  metadata.gz: c0e5a956513c53ecee63750c6d13b2ff5ebba51716e72e6631aed667962d5df5e0ea3eee064ba0435a6d3f37ebf3cc2d6128bc5fce0145d6952500ef39eac0e4
-  data.tar.gz: 1cf7cd8b486bb92f32c646fa0eebebf94288a97c00362e6af749814c352305a2b3903e4df2ffde3689365d90020522eb681e5e07d9ed486b3a0871a49edb16e7
+  metadata.gz: fa9c3ccf050acd66acd89bdc4b7f4fc280c68e926be7d027cfbb44cecf9f89b51aa7b61b44269f6f7d4a2c2524f4b67e65ba507a074824bba7018940dfb19d82
+  data.tar.gz: 23f4cd1c8e5bb9e57d8bda28974366d7486efca3a5d7c275c1042a27a7c039dd80e699d792330417647a72b3615ba164aba502c7e16097a549fd16b41fc45135

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,19 +1,17 @@
 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

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
@@ -30,14 +28,13 @@ class SourceFiles
     def get_all_helper(dir, &block)
       Dir.each_child(dir) do |f|
         file = "#{dir}/#{f}"
+        # we don't handle symlinks
         if File.file? file
-          if block_given?
-            @files << "#{file}" if yield(f)
-          else
-            @files << "#{file}"
-          end
-        else
-          get_all_helper("#{file}", &block)
+          add = true
+          add = yield(f) if block_given?
+          @files << file if add
+        elsif File.directory? file
+          get_all_helper(file, &block)
         end
       end
     end

data/lib/util.rb

@@ -1,5 +1,8 @@
+# Many useful classes to record compiling progress, change file's name and issueing system commands
 require_relative 'coloring'
 
+require 'English'
+
 module Canoe
   ##
   # Stepper record the progress of a task
@@ -57,13 +60,24 @@ module Canoe
     end
   end
 
+  ##
+  # issueing system commands by accepting a command string
   module SystemCommand
     def issue_command(cmd_str)
       puts cmd_str
-      system cmd_str
+      system(cmd_str)
+    end
+
+    def run_command(cmd_str)
+      puts cmd_str
+      status = system(cmd_str)
+      puts $CHILD_STATUS unless status
+      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/help.rb

@@ -53,9 +53,10 @@ module Canoe
       build [all|test]:
           build current project, 'all' builds both target and tests, 'test' builds tests only
 
-      test [tests]:
+      test [tests] [args]:
           build and run tests
           [tests]: 'all' for all tests, or a name of a test for a single test
+          [args]: args are passed to the single test
         
       run [options]:
           build current project with no specific compilation flags, and run this project, passing [options] as command line arguments to the binary

data/lib/workspace/new.rb

@@ -8,7 +8,8 @@ module Canoe
       end
       Dir.mkdir(@src)
       Dir.mkdir(@components)
-      Dir.mkdir("#{@workspace}/obj")
+      Dir.mkdir(@obj)
+      add_gitignore @obj
       if @mode == :bin
         DefaultFiles.create_main(@src, @source_suffix)
       else
@@ -20,12 +21,23 @@ module Canoe
 
       Dir.mkdir(@third)
       Dir.mkdir(@target)
+      add_gitignore @target      
       Dir.mkdir(@tests)
       Dir.chdir(@workspace) do
-        system 'git init'
-        system 'canoe add tests'
+        issue_command 'git init'
+        issue_command 'canoe add tests'
       end
       puts "workspace #{@workspace.blue} is created"
     end
+
+    private
+
+    def add_gitignore(dir)
+      Dir.chdir(dir) do
+        File.open('.gitignore', 'w') do |f|
+          f.write "*\n!.gitignore\n"
+        end
+      end
+    end
   end
 end

data/lib/workspace/run.rb

@@ -6,7 +6,7 @@ module Canoe
       return unless build
       
       args = args.join ' '
-      issue_command "#{@target_short}/#{@name} #{args}"
+      run_command "#{@target_short}/#{@name} #{args}"
     end
   end
 end

data/lib/workspace/test.rb

@@ -5,20 +5,13 @@ module Canoe
         test_all
         return
       end
-
-      args.each do |arg|
-        case arg
-        when 'all'
-          test_all
-        else
-          test_single arg
-        end
-      end
+      # 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]
+      ret = deps[file].map { |f| f.gsub(".#{@header_suffix}", ".#{@source_suffix}") }
 
       deps[file].each do |f|
         dep = extract_one_file(f, deps)
@@ -44,24 +37,27 @@ module Canoe
       end
     end
 
-    def test_single(name)
+    def test_single(name, args = "")
       rebuild = false;
       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))
       end
 
+      cmd = "#{bin} #{args}"
       if rebuild
         build_compiler_from_config
-        issue_command bin if build_one_test(file, deps)
+        run_command cmd if build_one_test(file, deps)
       else
-        issue_command bin
+        run_command cmd
       end
     end
 
@@ -82,26 +78,22 @@ 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)
+      files = DepAnalyzer.compiling_filter(target_deps, Time.new(0), @source_suffix, @header_suffix)
+      flag = true
+      files << test_file
+
+      files.each do |f|
+        o = file_to_obj(f)
+        flag &= compile f, o
+      end
+
+      abort_on_err("Compiling errors encountered") unless flag;
       link_one_test(test_file, deps)
     end
 
@@ -114,7 +106,7 @@ module Canoe
 
       files.each do |f|
         printf "#{stepper.progress_as_str.green} compiling #{f} "
-        compile_one_test(f, deps)
+        build_one_test(f, deps)
         stepper.step
       end
     end
@@ -131,6 +123,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.2.4
+           canoe v0.3.3.3
            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.2.4
+  version: 0.3.3.3
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.