canoe 0.3.3.2 → 0.3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74d6ddb337f4f8d2b52f18e5f6d3f2925211481dd5ad139ba555675bf434d356
-  data.tar.gz: 9828b9850dc35c90ba98a93f3b63a53df1ac102ba0c3c5ae41716f1f670e702d
+  metadata.gz: e7002afc65c5738fb7929e1b81cc491b9d7a7196b2ada01f3b6f580ccfe25133
+  data.tar.gz: 48632ed95d610599712de7f84fbfb8108c1195d9460cf1a96b8b22cccb59891c
 SHA512:
-  metadata.gz: bbd6271cff5a4a5c6342918b9b9c1420216016d185a8979d7d177ce78a3e01e26d4984dc69c90aec0706824fd14e6be0dd9cfb1fb612988bad9412241e16326f
-  data.tar.gz: 0e39977c7d620b0cc5b8fc55ab9e6b79049c9ca01534e75ef2f856d5fd2005e56102337aeb19e34800d948058e83c6e74af54e51bf6f646fe61edbd002e14c40
+  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
@@ -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/test.rb

@@ -90,7 +90,7 @@ module Canoe
 
       files.each do |f|
         o = file_to_obj(f)
-        flag = false unless compile f, o
+        flag &= compile f, o
       end
 
       abort_on_err("Compiling errors encountered") unless flag;

data/lib/workspace/version.rb

@@ -2,7 +2,7 @@ module Canoe
   class WorkSpace
     def self.version
       puts <<~VER
-           canoe v0.3.3.2
+           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.3.2
+  version: 0.3.3.3
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-10 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.