canoe 0.3.1 → 0.3.2.3

data/lib/workspace/new.rb

@@ -1,28 +1,31 @@
-class WorkSpace
-  def new
-    begin
-      Dir.mkdir(@name)
-    rescue
-      abort_on_err "workspace #{@name} already exsits"
-    end
-    Dir.mkdir(@src)
-    Dir.mkdir(@components)
-    Dir.mkdir("#{@workspace}/obj")
-    if @mode == :bin
-      DefaultFiles.create_main(@src, @source_suffix)
-    else
-      DefaultFiles.create_lib_header(@src, @name, @header_suffix)
-    end
-    File.new("#{@workspace}/.canoe", "w")
-    DefaultFiles.create_config @workspace, @source_suffix, @header_suffix
-    # DefaultFiles.create_emacs_dir_local @workspace
+module Canoe
+  class WorkSpace
+    def new
+      begin
+        Dir.mkdir(@name)
+      rescue SystemCallError
+        abort_on_err "workspace #{@name} already exsits"
+      end
+      Dir.mkdir(@src)
+      Dir.mkdir(@components)
+      Dir.mkdir("#{@workspace}/obj")
+      if @mode == :bin
+        DefaultFiles.create_main(@src, @source_suffix)
+      else
+        DefaultFiles.create_lib_header(@src, @name, @header_suffix)
+      end
+      File.new("#{@workspace}/.canoe", 'w')
+      compiler = @source_suffix == 'c' ? 'clang' : 'clang++'
+      DefaultFiles.create_config @workspace, compiler, @source_suffix, @header_suffix
 
-    Dir.mkdir(@third)
-    Dir.mkdir(@target)
-    Dir.mkdir(@tests)
-    Dir.chdir(@workspace) do
-      system "git init"
+      Dir.mkdir(@third)
+      Dir.mkdir(@target)
+      Dir.mkdir(@tests)
+      Dir.chdir(@workspace) do
+        system 'git init'
+        system 'canoe add tests'
+      end
+      puts "workspace #{@workspace.blue} is created"
     end
-    puts "workspace #{@workspace.blue} is created"
   end
 end

data/lib/workspace/run.rb

@@ -1,9 +1,12 @@
-class WorkSpace
-  def run(args)
-    return if @mode == :lib
-    build []
-    args = args.join " "
-    puts "./target/#{@name} #{args}"
-    exec "./target/#{@name} #{args}"
+module Canoe
+  class WorkSpace
+    def run(args)
+      return if @mode == :lib
+
+      return unless build
+      
+      args = args.join ' '
+      issue_command "#{@target_short}/#{@name} #{args}"
+    end
   end
 end

data/lib/workspace/test.rb

@@ -1,41 +1,144 @@
-class WorkSpace
-  public
+module Canoe
+  class WorkSpace
+    def test(args)
+      if args.empty?
+        test_all
+        return
+      end
 
-  def test(args)
-    if args.empty?
-      test_all
-      return
+      args.each do |arg|
+        case arg
+        when 'all'
+          test_all
+        else
+          test_single arg
+        end
+      end
     end
+    
+    # extract one test file's dependency
+    def extract_one_file(file, deps)
+      ret = deps[file]
 
-    args.each do |arg|
-      case arg
-      when "all"
-        test_all
-      else
-        test_single arg
+      deps[file].each do |f|
+        dep = extract_one_file(f, deps)
+        dep.each do |d|
+          ret << d unless ret.include?(d)
+        end
       end
+      ret.map { |f| f.gsub(".#{@header_suffix}", ".#{@source_suffix}") }
     end
-  end
 
-  private
+    def extract_one_file_obj(file, deps)
+      extract_one_file(file, deps).map do |f|
+        file_to_obj(f)
+      end
+    end
 
-  def test_all
-    puts "tests all"
-  end
+    private
 
-  def test_single(name)
-    puts "#{@tests}/bin/test_#{name}"
-    # system "./#{@tests}/bin/test_#{name}"
-  end
+    def test_all
+      build_test
+      fetch_all_test_files.each do |f|
+        test_single File.basename(f, '.*')['test_'.length..]
+      end
+    end
 
-  ##
-  # how to build:
-  # each test file tests one or more components, indicated by included headers
-  # find corresponding object file in ../obj and link them to test file
-  # TODO
-  def build_test
-    build
-    deps = DepAnalyzer.new("./tests").build_to_file(["./src", "./src/components", "./tests", "./tests/common"], "./tests/.canoe.deps")
-    puts deps
+    def test_single(name)
+      rebuild = false;
+      bin = "#{@target_short}/test_#{name}"
+      rebuild ||= !File.exist?(bin)
+      
+      file = "#{@tests_short}/test_#{name}.#{@source_suffix}"
+      
+      deps = fetch_all_deps
+      extract_one_file(file, deps).push(file).each do |f|
+        rebuild ||= File.mtime(bin) < File.mtime(f)
+      end
+
+      build_compiler_from_config && build_one_test(file, deps) if rebuild
+
+      issue_command bin
+    end
+
+    def fetch_all_test_files
+      Dir.glob("#{@tests_short}/*.#{@source_suffix}").filter do |f|
+        File.basename(f).start_with? 'test_'
+      end
+    end
+
+    def fetch_all_deps
+      target_deps.merge(tests_deps)
+    end
+
+    def test_build_time
+      fetch_all_test_files.map do |f|
+        obj = "#{@target_short}/#{File.basename(f, '.*')}"
+        File.exist?(obj) ? File.mtime(obj) : Time.new(0)
+      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)
+
+        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)
+      link_one_test(test_file, deps)
+    end
+
+    def compile_all_tests(deps)
+      files = DepAnalyzer.compiling_filter(deps, test_build_time, @source_suffix, @header_suffix).select do |f|
+        File.basename(f).start_with?('test_')
+      end
+
+      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)
+        stepper.step
+      end
+    end
+
+    def link_all_tests(deps)
+      all_files = fetch_all_test_files
+
+      stepper = Stepper.new all_files.size, all_files.size
+      fetch_all_test_files.each do |f|
+        printf "#{stepper.progress_as_str.green} linking #{File.basename(f, '.*').yellow}: "
+        link_one_test(f, deps)
+        stepper.step
+      end
+    end
+
+    def build_test
+      puts "#{'[COMPILING TESTS]'.magenta}..."
+      return unless test_build_time
+
+      total_deps = fetch_all_deps
+      compile_all_tests(total_deps)
+      puts "#{'[100%]'.green} compiling done, starts linking..."
+      puts "#{'[LINKING TESTS]'.magenta}..."
+      # compilation and link are separated because they may be separated
+      # by unexpected interrupt like C-c, C-d, etc.
+      # thus unditionally link all tests
+      link_all_tests(total_deps)
+      puts "#{'[100%]'.green} linking done"
+    end
   end
 end

data/lib/workspace/update.rb

@@ -1,5 +1,7 @@
-class WorkSpace
-  def update
-    generate
+module Canoe
+  class WorkSpace
+    def update
+      generate
+    end
   end
 end

data/lib/workspace/version.rb

@@ -0,0 +1,15 @@
+module Canoe
+  class WorkSpace
+    def self.version
+      puts <<~VER
+           canoe v0.3.2.3
+           For features in this version, please visit https://github.com/Dicridon/canoe
+           Currently, canoe can do below:
+               - project creation
+               - project auto build, run and test (works like Cargo for Rust)
+               - project structure management
+           by XIONG Ziwei
+         VER
+    end
+  end
+end

data/lib/workspace/workspace.rb

@@ -1,52 +1,65 @@
-require "fileutils"
-require_relative "../source_files"
-require_relative "../compiler"
-require_relative "../config_reader"
-require_relative "../default_files"
-require_relative "../err"
-require_relative "../dependence"
-require_relative "../coloring"
+require 'fileutils'
+require_relative '../source_files'
+require_relative '../compiler'
+require_relative '../config_reader'
+require_relative '../default_files'
+require_relative '../util'
+require_relative '../dependence'
+require_relative '../coloring'
 
-class WorkSpace
-  include Err
-  attr_reader :name, :cwd, :src_prefix, :components_prefix, :obj_prefix, :source_suffix, :header_suffix, :mode
+module Canoe
+  ##
+  # A workspace resents a C/C++ project
+  # This class is responsible for the main functionality of canoe, such as building and cleaning
+  # TODO
+  #   add a command to generate compile_commands.json so users won't have to install bear
+  class WorkSpace
+    include Err
+    include SystemCommand
+    attr_reader :name, :cwd, :src_prefix, :components_prefix, :obj_prefix,
+                :source_suffix, :header_suffix, :mode, :target_short,
+                :src_short, :components_short, :obj_short, :tests_short
 
-  def initialize(name, mode, src_suffix = "cpp", hdr_suffix = "hpp")
-    @name = name
-    @compiler = Compiler.new "clang++", ["-Isrc/components"], []
-    @cwd = Dir.new(Dir.pwd)
-    @workspace = "#{Dir.pwd}/#{@name}"
-    @src = "#{@workspace}/src"
-    @components = "#{@src}/components"
-    @obj = "#{@workspace}/obj"
-    @third = "#{@workspace}/third-party"
-    @target = "#{@workspace}/target"
-    @tests = "#{@workspace}/tests"
-    @mode = mode
-    @deps = ".canoe.deps"
+    def initialize(name, mode, src_suffix = 'cpp', hdr_suffix = 'hpp', nu = false)
+      @name = name
+      @compiler = Compiler.new 'clang++', ['-Isrc/components'], []
+      @cwd = Dir.new(Dir.pwd)
+      @workspace = Dir.pwd.to_s + (nu ? "/#{@name}" : '')
+      @src = "#{@workspace}/src"
+      @components = "#{@src}/components"
+      @obj = "#{@workspace}/obj"
+      @third = "#{@workspace}/third-party"
+      @target = "#{@workspace}/target"
+      @tests = "#{@workspace}/tests"
+      @mode = mode
+      @deps = '.canoe.deps'
+      @test_deps = '.canoe.test.deps'
 
-    @src_prefix = "./src/"
-    @components_prefix = "./src/components/"
-    @obj_prefix = "./obj/"
+      @target_short = './target'
+      @src_short = './src'
+      @components_short = "#{@src_short}/components"
+      @obj_short = './obj'
+      @tests_short = './tests'
 
-    @source_suffix = src_suffix
-    @header_suffix = hdr_suffix
-  end
+      @src_prefix = './src/'
+      @components_prefix = './src/components/'
+      @obj_prefix = './obj/'
 
-  def inspect
-    puts "name is #{@name}"
-    puts "name is #{@workspace}"
+      @source_suffix = src_suffix
+      @header_suffix = hdr_suffix
+    end
   end
 end
 
-require_relative "help"
-require_relative "new"
-require_relative "add"
-require_relative "build"
-require_relative "generate"
-require_relative "run"
-require_relative "dep"
-require_relative "clean"
-require_relative "update"
-require_relative "test"
-require_relative "make"
+require_relative 'help'
+require_relative 'version'
+require_relative 'new'
+require_relative 'add'
+require_relative 'build'
+require_relative 'generate'
+require_relative 'run'
+require_relative 'dep'
+require_relative 'clean'
+require_relative 'update'
+require_relative 'test'
+require_relative 'make'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2.3
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.
@@ -33,8 +33,8 @@ files:
 - lib/config_reader.rb
 - lib/default_files.rb
 - lib/dependence.rb
-- lib/err.rb
 - lib/source_files.rb
+- lib/util.rb
 - lib/workspace/add.rb
 - lib/workspace/build.rb
 - lib/workspace/clean.rb
@@ -46,6 +46,7 @@ files:
 - lib/workspace/run.rb
 - lib/workspace/test.rb
 - lib/workspace/update.rb
+- lib/workspace/version.rb
 - lib/workspace/workspace.rb
 homepage: https://github.com/Dicridon/canoe
 licenses:
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: a C/C++ project management and building tool

data/lib/err.rb

@@ -1,21 +0,0 @@
-require_relative "coloring"
-
-module Err
-  def warn_on_err(err)
-    puts <<~ERR
-           #{"Waring: ".yellow}
-               #{err}
-           try 'canoe help' for more information
-         ERR
-  end
-
-  def abort_on_err(err)
-    abort <<~ERR
-            #{"Fatal: ".red}
-                #{err}
-            try 'canoe help' for more information
-          ERR
-  end
-
-  module_function :warn_on_err, :abort_on_err
-end