canoe 0.3.1 → 0.3.2.3

data/lib/workspace/clean.rb

@@ -1,27 +1,28 @@
-class WorkSpace
-  def clean
-    self.send "clean_#{@mode.to_s}"
-  end
+module Canoe
+  class WorkSpace
+    # valid options: none, 'all', 'target', 'tests'
+    def clean(arg = 'all')
+      send "clean_#{arg}"
+    end
 
-  private
+    private
 
-  def clean_obj
-    puts "rm -f ./obj/*.o"
-    system "rm -f ./obj/*.o"
-  end
+    def clean_all
+      clean_target
+      clean_obj
+    end
 
-  def clean_target
-    puts "rm -f ./target/*"
-    system "rm -f ./target/*"
-  end
+    def clean_target
+      issue_command 'rm ./target/* -rf'
+    end
 
-  def clean_bin
-    clean_obj
-    clean_target
-  end
+    def clean_obj
+      issue_command 'rm ./obj/* -rf'
+    end
 
-  def clean_lib
-    clean_obj
-    clean_target
+    def clean_tests
+      issue_command 'rm ./obj/test_* -rf'
+      issue_command 'rm ./target/test_* -rf'
+    end
   end
 end

data/lib/workspace/dep.rb

@@ -1,11 +1,13 @@
-class WorkSpace
-  def dep
-    deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
-    deps.each do |k, v|
-      unless v.empty?
+module Canoe
+  class WorkSpace
+    def dep
+      deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
+      deps.each do |k, v|
+        next if v.empty?
+
         puts "#{k.blue} depends on: "
         v.each { |f| puts "    #{f.blue}" }
-        puts ""
+        puts ''
       end
     end
   end

data/lib/workspace/generate.rb

@@ -1,5 +1,10 @@
-class WorkSpace
-  def generate
-    DepAnalyzer.new("./src", @source_suffix, @header_suffix).build_to_file ["./src", "./src/components"], @deps
+module Canoe
+  class WorkSpace
+    def generate
+      DepAnalyzer.new(@src_short, @source_suffix, @header_suffix)
+                 .build_to_file [@src_short, @components_short], @deps
+      DepAnalyzer.new(@tests_short, @source_suffix, @header_suffix)
+                 .build_to_file [@src_short, @components_short], @test_deps
+    end
   end
 end

data/lib/workspace/help.rb

@@ -1,11 +1,14 @@
-class WorkSpace
-  def self.help
-    info = <<~INFO
+module Canoe
+  class WorkSpace
+    def self.help
+      info = <<~INFO
       canoe is a C/C++ project manager, inspired by Rust cargo.
       usage:
           canoe new tada: create a project named 'tada' in current directory
             
           canoe build: compile current project (execute this command in project directory)
+
+          canoe test: build and run tests
       
           canoe generate: generate dependency relationships and store it in '.canoe.deps' file. Alias: update
 
@@ -47,8 +50,12 @@ class WorkSpace
           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
+      build [all|test]:
+          build current project, 'all' builds both target and tests, 'test' builds tests only
+
+      test [tests]:
+          build and run tests
+          [tests]: 'all' for all tests, or a name of a test for a 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
@@ -71,6 +78,7 @@ class WorkSpace
       @author: written by XIONG Ziwei, ICT, CAS
       @contact: noahxiong@outlook.com
     INFO
-    puts info
+      puts info
+    end
   end
 end

data/lib/workspace/make.rb

@@ -1,232 +1,279 @@
-class Makefile
-  def initialize(workspace)
-    @workspace = workspace
-    @all_names = []
-    @common_variables = {}
-    @src_variables = {}
-    @hdr_variables = {}
-    @obj_variables = {}
-    @config = {}
-  end
+# If the project has circular dependency, this command would fail
+module Canoe
+  ##
+  # CanoeMakefile is used to offer makefile generation utilities
+  class CanoeMakefile
+    include WorkSpaceUtil
+    def initialize(workspace)
+      @workspace = workspace
+      @all_names = []
+      @common_variables = {}
+      @src_variables = {}
+      @hdr_variables = {}
+      @obj_variables = {}
+      @config = {}
+    end
 
-  def configure(config)
-    @config = config
-  end
+    def configure(config)
+      @config = config
+    end
 
-  def make!(deps)
-    File.open("Makefile", "w") do |f|
-      if cxx?(get_compiler)
-        make_cxx(f, deps)
-      else
-        make_c(f, deps)
+    def make!(deps)
+      File.open('Makefile', 'w') do |f|
+        if cxx?(get_compiler)
+          make_cxx(f, deps)
+        else
+          make_c(f, deps)
+        end
       end
     end
-  end
 
-  private
+    private
 
-  def get_compiler
-    @config["compiler"]
-  end
+    def get_compiler
+      @config['compiler']
+    end
 
-  def get_header_suffix
-    @workspace.header_suffix
-  end
+    def get_header_suffix
+      @workspace.header_suffix
+    end
 
-  def get_source_suffix
-    @workspace.source_suffix
-  end
+    def get_source_suffix
+      @workspace.source_suffix
+    end
 
-  def get_compiling_flags
-    flags = @config["flags"]["compile"].values.join " "
-    flags + " -I./src/components"
-  end
+    def get_compiling_flags
+      flags = @config['flags']['compile'].values.join ' '
+      flags + ' -I./src/components'
+    end
 
-  def get_ldflags
-    @config["flags"]["link"].values.select { |v| v.start_with?("-L") }.join " "
-  end
+    def get_ldflags
+      @config['flags']['link'].values.select { |v| v.start_with?('-L') }.join ' '
+    end
 
-  def get_ldlibs
-    (@config["flags"]["link"].values - (get_ldflags.split)).join " "
-  end
+    def get_ldlibs
+      (@config['flags']['link'].values - (get_ldflags.split)).join ' '
+    end
 
-  def cxx?(name)
-    return get_compiler.end_with? "++"
-  end
+    def cxx?(name)
+      return get_compiler.end_with? '++'
+    end
 
-  def make_cxx(makefile, deps)
-    make_common(makefile, "CXX", deps)
-  end
+    def make_cxx(makefile, deps)
+      make_common(makefile, 'CXX', deps)
+    end
 
-  def make_c(makefile, deps)
-    make_common(makefile, "CC", deps)
-  end
+    def make_c(makefile, deps)
+      make_common(makefile, 'CC', deps)
+    end
 
-  def make_common(makefile, compiler_prefix, deps)
-    make_compiling_info(makefile, compiler_prefix)
-    define_variables(makefile, deps)
-    make_rules(makefile, deps)
-  end
+    def make_common(makefile, compiler_prefix, deps)
+      make_compiling_info(makefile, compiler_prefix)
+      define_variables(makefile, deps)
+      make_rules(makefile, deps)
+    end
 
-  def make_compiling_info(makefile, compiler_prefix)
-    makefile.puts("#{compiler_prefix}=#{get_compiler}")
-    makefile.puts("#{compiler_prefix}FLAGS=#{get_compiling_flags}")
-    makefile.puts("LDFLAGS=#{get_ldflags}")
-    makefile.puts("LDLIBS=#{get_ldlibs}")
-    makefile.puts ""
-  end
+    def make_compiling_info(makefile, compiler_prefix)
+      makefile.puts("#{compiler_prefix}=#{get_compiler}")
+      makefile.puts("#{compiler_prefix}FLAGS=#{get_compiling_flags}")
+      makefile.puts("LDFLAGS=#{get_ldflags}")
+      makefile.puts("LDLIBS=#{get_ldlibs}")
+      makefile.puts ''
+    end
 
-  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 ""
-    define_hdrs(makefile, src_files)
-    makefile.puts ""
-    define_objs(makefile, src_files)
-    makefile.puts ""
-  end
+    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 ''
+      define_hdrs(makefile, src_files)
+      makefile.puts ''
+      define_objs(makefile, src_files)
+      makefile.puts ''
+      define_tests(makefile, src_files)
+      makefile.puts ''
+    end
 
-  def extract_name(name, prefix)
-    if name.start_with?(prefix)
-      name.delete_suffix(File.extname(name))[prefix.length..].gsub("/", "_")
-    else
-      File.basename(name.split("/")[-1], ".*")
+    def extract_name(name, _)
+      File.basename(file_to_obj(name), '.*')
     end
-  end
 
-  def generate_all_names(files)
-    files.each do |f|
-      name = extract_name(f, @workspace.components_prefix).upcase
-      @all_names << name
-      @src_variables[name] = f
-      @hdr_variables[name] = f.gsub(@workspace.source_suffix, @workspace.header_suffix)
-      @obj_variables[name] = @workspace.obj_prefix + extract_name(f, @workspace.components_prefix) + ".o"
+    def generate_all_names(files)
+      files.each do |f|
+        name = extract_name(f, @workspace.components_prefix).upcase
+        @all_names << name
+        @src_variables[name] = f
+        @hdr_variables[name] = f.gsub @workspace.source_suffix, @workspace.header_suffix
+        @obj_variables[name] = file_to_obj(f)
+      end
     end
-  end
 
-  def define_dirs(makefile)
-    makefile.puts("TARGET_DIR=./target")
-    if @workspace.mode == :bin
-      makefile.puts("TARGET=$(TARGET_DIR)/#{@workspace.name}")
-    else
-      makefile.puts("TARGET=$(TARGET_DIR)/lib#{@workspace.name.downcase}.so")
-    end
-    # note the ending slash
-    makefile.puts("OBJ_DIR=#{@workspace.obj_prefix[..-2]}")
-    makefile.puts("SRC_DIR=#{@workspace.src_prefix[..-2]}")
-    makefile.puts("COMPONENTS_DIR=#{@workspace.components_prefix[..-2]}")
-    makefile.puts ""
-  end
+    def define_dirs(makefile)
+      makefile.puts("TARGET_DIR=./target")
+      if @workspace.mode == :bin
+        makefile.puts("TARGET=$(TARGET_DIR)/#{@workspace.name}")
+      else
+        makefile.puts("TARGET=$(TARGET_DIR)/lib#{@workspace.name.downcase}.so")
+      end
+      # note the ending slash
+      makefile.puts("OBJ_DIR=#{@workspace.obj_prefix[..-2]}")
+      makefile.puts("SRC_DIR=#{@workspace.src_prefix[..-2]}")
+      makefile.puts("COMPONENTS_DIR=#{@workspace.components_prefix[..-2]}")
+      makefile.puts ""
+    end
 
-  def define_srcs(makefile, files)
-    @src_variables.each do |k, v|
-      makefile.puts("SRC_#{k}=#{v}")
+    def define_srcs(makefile, files)
+      @src_variables.each do |k, v|
+        makefile.puts("SRC_#{k}=#{v}")
+      end
     end
-  end
 
-  def define_hdrs(makefile, files)
-    @hdr_variables.each do |k, v|
-      next if k == "MAIN"
-      makefile.puts("HDR_#{k}=#{v}")
+    def define_hdrs(makefile, files)
+      @hdr_variables.each do |k, v|
+        next if k == "MAIN"
+        makefile.puts("HDR_#{k}=#{v}") if File.exist? v
+      end
     end
-  end
 
-  def define_objs(makefile, files)
-    @obj_variables.each do |k, v|
-      makefile.puts("OBJ_#{k}=#{v}")
+    def define_objs(makefile, files)
+      @obj_variables.each do |k, v|
+        makefile.puts("OBJ_#{k}=#{v}")
+      end
+      objs = @obj_variables.keys.map { |k| "$(OBJ_#{k})" }
+      bin_objs = objs.reject { |o| o.start_with? '$(OBJ_TEST'}
+      test_objs = objs - bin_objs
+      makefile.puts ''
+      makefile.puts("OUT_OBJS=#{bin_objs.join ' '}")
+      makefile.puts("TEST_OBJS=#{test_objs.join ' '}")
     end
-    objs = @obj_variables.keys.map { |k| "$(OBJ_#{k})" }.join " "
-    makefile.puts("OBJS=#{objs}")
-    makefile.puts ""
-  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)
+    def define_tests(makefile, files)
+      test_files = files.select { |f| File.basename(f, '.*').start_with? 'test_'}
+      test_files.each do |f|
+        basename = File.basename(f, '.*')
+        test = "#{@workspace.target_short}/#{basename}"
+        makefile.puts("#{basename.upcase}=#{test}")
       end
-      tmp
+      tests = test_files.map do |f|
+        "$(#{File.basename(f, '.*').upcase})"
+      end
+      makefile.puts("TESTS=#{tests.join ' '}")
     end
-  end
 
-  def emit_dependencies(makefile, name, deps)
-    as_str = deps.map do |n|
-      if n == name
-        ["$(SRC_#{n})"] + ["$(HDR_#{n})"] * (name == "MAIN" ? 0 : 1)
+    def get_all_dep_name(file_name, deps)
+      dep = deps[file_name]
+      if dep.empty?
+        []
       else
-        "$(#{n}_DEP)"
+        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
-    end.flatten.join " "
-    makefile.puts("#{name}_DEP=#{as_str}")
-  end
+    end
 
-  def make_dependencies(makefile, deps)
-    dep_variables = Hash[@all_names.map { |n| [n, []] }]
-    reference = Hash[@all_names.map { |n| [n, []] }]
-    @all_names.each do |n|
-      dep_variables[n] = ([n] + get_all_dep_name(@src_variables[n], deps)).uniq
-      reference[n] = ([n] + get_all_dep_name(@src_variables[n], deps)).uniq
+    def emit_dependencies(makefile, name, deps)
+      as_str = deps.map do |n|
+        if n == name
+          ["$(SRC_#{n})"] + ["$(HDR_#{n})"] * (name == "MAIN" ? 0 : 1)
+        else
+          "$(#{n}_DEP)"
+        end
+      end.flatten.join " "
+      makefile.puts("#{name}_DEP=#{as_str}")
     end
 
-    # deduplication
-    dep_variables.each do |k, v|
-      v.each do |n|
-        next if n == k
-        v = v - reference[n] + [n] if v.include? n
+    def make_dependencies(makefile, deps)
+      dep_variables = Hash[@all_names.map { |n| [n, []] }]
+      reference = Hash[@all_names.map { |n| [n, []] }]
+      @all_names.each do |n|
+        dep_variables[n] = ([n] + get_all_dep_name(@src_variables[n], deps)).uniq
+        reference[n] = ([n] + get_all_dep_name(@src_variables[n], deps)).uniq
+      end
+
+      # deduplication
+      dep_variables.each do |k, v|
+        v.each do |n|
+          next if n == k
+          v = v - reference[n] + [n] if v.include? n
+        end
+        dep_variables[k] = v
+      end
+
+      dep_variables.each do |k, v|
+        emit_dependencies(makefile, k, v)
       end
-      dep_variables[k] = v
     end
 
-    dep_variables.each do |k, v|
-      emit_dependencies(makefile, k, v)
+    def make_obj_rules(makefile, deps)
+      cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
+
+      @all_names.each do |n|
+        makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ -c $(SRC_#{n})\n\n")
+      end
     end
-  end
 
-  def make_rules(makefile, deps)
-    make_dependencies(makefile, deps)
-    makefile.puts ""
-    makefile.puts("all: BIN\n")
-    makefile.puts ""
-    cmplr = cxx?(get_compiler) ? "CXX" : "CC"
-    @all_names.each do |n|
-      makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $(OBJ_#{n}) -c $(SRC_#{n})")
-      makefile.puts ""
+    def make_out_rules(makefile, deps)
+      cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
+      if @workspace.mode == :bin
+        makefile.puts("out: $(OUT_OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $(TARGET) $(OUT_OBJS) $(LDFLAGS) $(LDLIBS)")
+      else
+        makefile.puts("out: $(OUT_OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -shared -o $(TARGET) $(OUT_OBJS) -fPIC $(LDFLAGS) $(LDLIBS)")
+      end
+      makefile.puts ''
+      makefile.puts("test: $(TESTS)")
+      makefile.puts ''
+      makefile.puts("all: out test")
+    end
+
+    def make_tests_rules(makefile, deps)
+      cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
+      @all_names.each do |n|
+        next unless n.start_with? 'TEST_'
+        filename = "#{@workspace.tests_short}/#{n.downcase}.#{@workspace.source_suffix}"
+        objs = ["$(OBJ_#{n})"] + extract_one_file_obj(filename, deps).map do |o|
+          "$(OBJ_#{File.basename(o, '.*').upcase})"
+        end
+
+        makefile.puts("$(#{n}): #{objs.join ' '}\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ $^ $(LDFLAGS) $(LDLIBS)")
+        makefile.puts ''
+      end
     end
 
-    if @workspace.mode == :bin
-      makefile.puts("BIN: $(OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $(TARGET) $(wildcard ./obj/*.o) $(LDFLAGS) $(LDLIBS)")
-    else
-      makefile.puts("LIB: $(OBJS)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -shared -o $(TARGET) $(wildcard ./obj/*.o) -fPIC $(LDFLAGS) $(LDLIBS)")
+    def make_clean(makefile)
+      clean = <<~DOC
+            .PHONY: clean
+            clean: 
+            \trm ./target/*
+            \trm ./obj/*.o
+            DOC
+      makefile.puts(clean)
     end
-    makefile.puts ""
 
-    clean = <<~DOC
-      .PHONY: clean
-      clean: 
-      \trm $(TARGET)
-      \trm ./obj/*.o
-    DOC
-    makefile.puts(clean)
+    def make_rules(makefile, deps)
+      make_dependencies makefile, deps
+      makefile.puts ''
+      make_out_rules makefile, deps
+      makefile.puts ''
+      make_obj_rules makefile, deps
+      make_tests_rules makefile, deps
+      makefile.puts ''
+      make_clean makefile
+    end
   end
-end
 
-class WorkSpace
-  def make
-    config = ConfigReader.extract_flags "config.json"
+  class WorkSpace
+    def make
+      config = ConfigReader.extract_flags "config.json"
 
-    deps = File.exist?(@deps) ?
-      DepAnalyzer.read_from(@deps) :
-      DepAnalyzer.new("./src").build_to_fil
+      deps = target_deps.merge tests_deps
 
-    makefile = Makefile.new(self)
-    makefile.configure(config)
-    makefile.make!(deps)
+      makefile = CanoeMakefile.new self
+      makefile.configure config
+      makefile.make! deps
+    end
   end
 end