canoe 0.3.0 → 0.3.2

data/lib/workspace/run.rb

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,136 @@
+module Canoe
+  class WorkSpace
+    def test(args)
+      if args.empty?
+        test_all
+        return
+      end
+
+      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]
+
+      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
+
+    def extract_one_file_obj(file, deps)
+      extract_one_file(file, deps).map do |f|
+        file_to_obj(f)
+      end
+    end
+
+    private
+
+    def test_all
+      build_test
+      fetch_all_test_files.each do |f|
+        test_single File.basename(f, '.*')['test_'.length..]
+      end
+    end
+
+    def test_single(name)
+      bin = "#{@target_short}/test_#{name}"
+      file = "#{@tests_short}/test_#{name}.#{@source_suffix}"
+      abort_on_err "Can not find source file #{file.red} for test #{name.red}" unless File.exist?(file)
+      build_one_test(file, fetch_all_deps) unless File.exist?(bin)
+
+      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

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

@@ -0,0 +1,63 @@
+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'
+
+module Canoe
+  ##
+  # A workspace resents a C/C++ project
+  # This class is responsible for the main functionality of canoe, such as building and cleaning
+  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', 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'
+
+      @target_short = './target'
+      @src_short = './src'
+      @components_short = "#{@src_short}/components"
+      @obj_short = './obj'
+      @tests_short = './tests'
+
+      @src_prefix = './src/'
+      @components_prefix = './src/components/'
+      @obj_prefix = './obj/'
+
+      @source_suffix = src_suffix
+      @header_suffix = hdr_suffix
+    end
+  end
+end
+
+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.0
+  version: 0.3.2
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.
@@ -28,13 +28,26 @@ files:
 - bin/canoe
 - lib/canoe.rb
 - lib/cmd.rb
+- lib/coloring.rb
 - lib/compiler.rb
 - lib/config_reader.rb
 - lib/default_files.rb
 - lib/dependence.rb
-- lib/err.rb
 - lib/source_files.rb
-- lib/workspace.rb
+- lib/util.rb
+- lib/workspace/add.rb
+- lib/workspace/build.rb
+- lib/workspace/clean.rb
+- lib/workspace/dep.rb
+- lib/workspace/generate.rb
+- lib/workspace/help.rb
+- lib/workspace/make.rb
+- lib/workspace/new.rb
+- 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:
 - MIT
@@ -54,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,19 +0,0 @@
-module Err
-  def warn_on_err(err)
-    puts <<~ERR
-           Warning: 
-               #{err}
-           try 'canoe help' for more information
-         ERR
-  end
-
-  def abort_on_err(err)
-    abort <<~ERR
-            Fatal: 
-                #{err}
-            try 'canoe help' for more information
-         ERR
-  end
-
-  module_function :warn_on_err, :abort_on_err
-end

data/lib/workspace.rb

@@ -1,328 +0,0 @@
-require 'fileutils'
-require_relative 'source_files'
-require_relative 'compiler'
-require_relative 'config_reader'
-require_relative 'default_files'
-require_relative 'err'
-require_relative 'dependence'
-
-class WorkSpace
-  include Err
-  attr_reader :name, :cwd
-  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 generate: generate dependency relationships and store it in '.canoe.deps' file. Alias: update
-
-                canoe update: udpate dependency relationships and store it in '.canoe.deps' file. 
-                
-                canoe run: compile and execute current project (execute this command in project directory)
-                
-                canoe clean: remove all generated object files and binary files
-                
-                canoe help: show this help message
-
-                canoe add tada: add a folder named tada under workspace/components,
-                
-                canoe dep: show current dependency relationships of current project
-                
-                canoe verion: version information
-
-            new project_name [mode] [suffixes]:
-                create a new project with project_name.
-                In this project, four directories obj, src, target and third-party will be generated in project directory.
-                in src, directory 'components' will be generated if [mode] is '--lib', an extra main.cpp will be generated if [mode] is '--bin'
-
-                [mode]: --lib for a library and --bin for executable binaries
-                [suffixes]: should be in 'source_suffix:header_suffix" format, notice the ':' between two suffixes
-            add component_name:
-                add a folder named tada under workspace/components.
-                two files tada.hpp and tada.cpp would be craeted and intialized. File suffix may differ according users' specifications.
-                if component_name is a path separated by '/', then canoe would create folders and corresponding files recursively.
-
-            generate: 
-                generate dependence relationship for each file, this may accelarate
-                `canoe buid` command. It's recommanded to execute this command everytime
-                headers are added or removed from any file.
-            
-            update:
-                this command is needed because '.canoe.deps' is actually a cache of dependency relationships so that
-                canoe doesn't have to analyze all the files when building a project.
-                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
-            
-            run [options]:
-                build current project with no specific compilation flags, and run this project, passing [options] as command line arguments to the binary
-
-            clean:
-                remove all generated object files and binary files
-
-            help:
-                show this help message
-
-            verion: 
-                display version information
-
-            dep:
-                display file dependencies in a better readable way
-
-            @author: written by XIONG Ziwei, ICT, CAS
-            @contact: noahxiong@outlook.com
-        INFO
-    puts info
-  end
-
-
-  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'
-
-    @src_prefix = './src/'
-    @components_prefix = './src/components/'
-    @obj_prefix = './obj/'
-
-    @source_suffix = src_suffix
-    @header_suffix = hdr_suffix
-  end
-
-  def new
-    Dir.mkdir(@name)
-    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
-
-    Dir.mkdir(@third)
-    Dir.mkdir(@target)
-    Dir.chdir(@workspace) do
-      system "git init"
-    end
-    puts "workspace #{@workspace} is created"
-  end
-
-  # args are commandline parameters passed to `canoe build`    
-  def build(args)
-    deps = File.exist?(@deps) ? 
-             DepAnalyzer.read_from(@deps) :
-             DepAnalyzer.new('./src').build_to_file(['./src', './src/components'], @deps)
-    target = "./target/#{@name}"
-    build_time = File.exist?(target) ? File.mtime(target) : Time.new(0)
-    files = DepAnalyzer.compiling_filter(deps, build_time, @source_suffix, @header_suffix)
-
-    if files.empty?
-      puts "nothing to do, all up to date"
-      return
-    end
-    
-    self.send "build_#{@mode.to_s}", files, args 
-  end
-
-  def generate
-    DepAnalyzer.new('./src', @source_suffix, @header_suffix)
-               .build_to_file ['./src', './src/components'], @deps
-  end
-
-  def update
-    generate
-  end
-
-  def clean
-    self.send "clean_#{@mode.to_s}"
-  end
-
-  def run(args)
-    return if @mode == :lib
-    build []
-    args = args.join " "
-    puts "./target/#{@name} #{args}"
-    exec "./target/#{@name} #{args}"
-  end
-
-  def add(args)
-    args.each do |i|
-      dir = @components
-      filenames = i.split("/")
-      prefix = []
-      filenames.each do |filename|
-        dir += "/#{filename}"
-        prefix << filename
-        unless Dir.exist? dir
-          FileUtils.mkdir dir 
-          Dir.chdir(dir) do
-            puts "created " + Dir.pwd
-            create_working_files prefix.join('__'), filename
-          end
-        end
-      end
-    end
-  end
-
-  def dep
-    deps = DepAnalyzer.read_from(@deps) if File.exist?(@deps)
-    deps.each do |k, v|
-      unless v.empty?
-        puts "#{k} depends on: "
-        v.each {|f| puts "    #{f}"}
-        puts ""
-      end
-    end
-  end
-
-  def test(args)
-    args.each do |arg|
-      case arg
-      when "all"
-        test_all
-      else
-        test_single arg        
-      end
-    end
-  end
-  
-  private
-  def create_working_files(prefix, filename)
-    DefaultFiles.create_cpp filename, @source_suffix, @header_suffix
-    DefaultFiles.create_hpp @name, prefix, filename, @header_suffix
-  end
-
-  def build_compiler_from_config(args)
-    Dir.chdir(@workspace) do
-      flags = ConfigReader.extract_flags "config.json"
-      compiler_name = flags['compiler'] ? flags['compiler'] : "clang++"
-      abort_on_err "compiler #{compiler_name} not found" unless File.exists?("/usr/bin/#{compiler_name}")
-      compiler_flags = ['-Isrc/components'] + args
-      
-      if opts = flags['flags'] 
-        opts.each do |k, v|
-          case v
-          when String
-            compiler_flags << v
-          when Array
-            v.each do |o|
-              compiler_flags << o
-            end
-          else
-            abort_on_err "unknown options in config.json, #{v}"
-          end
-        end
-      end
-
-      @compiler = Compiler.new compiler_name, compiler_flags
-    end
-  end
-
-  def compile(f, o)
-    @compiler.compile f, o
-  end
-
-  def link_exectutable(odir, objs)
-    puts "[100%] linking"
-    @compiler.link_executable "#{odir}/#{@name}", objs
-  end
-
-  def link_shared(odir, objs)
-    puts "[100%] linking"
-    @compiler.link_shared "#{odir}/lib#{@name}", objs
-  end
-
-  def build_bin(files, args)
-    return if files.empty?
-    build_compiler_from_config args
-    if build_common(files, args)
-      link_exectutable('./target', Dir.glob("obj/*.o"))
-      puts "canoe: building succeeded"
-    else 
-      puts "canoe: building failed"
-    end
-  end
-
-  def build_lib(files, args)
-    return if files.empty?
-    build_compiler_from_config args
-    @compiler.append_compiling_flag '-fPIC'
-    if (build_common files, args)
-      link_shared('./target', Dir.glob("obj/*.o"))
-      puts "canoe: building succeeded"
-    else 
-      puts "canoe: building failed"
-    end
-  end
-
-  def build_common(files, args)
-    all = SourceFiles.get_all('./src') {|f| f.end_with? @source_suffix}
-    total = all.size.to_f
-    compiled = total - files.size
-    comps = files.select {|f| f.start_with? @components_prefix}
-    srcs = files - comps
-    flag = true;
-    srcs.each do |f|
-      progress = (compiled / total).round(2) * 100
-      printf "[#{progress.to_i}%%] compiling #{f}: "
-      fname = f.split("/")[-1]
-      o = @obj_prefix + fname.delete_suffix(File.extname(fname)) + '.o'
-      flag = false unless compile f, o 
-      compiled += 1
-    end
-    
-    comps.each do |f|
-      progress = (compiled / total).round(2) * 100
-      printf "[#{progress.to_i}%%] compiling #{f}: "
-      o = @obj_prefix + f.delete_suffix(File.extname(f))[@components_prefix.length..]
-                         .gsub('/', '_') + '.o'
-      flag = false unless compile f, o
-      compiled += 1
-    end
-    flag
-  end
-
-  def clean_obj
-    puts "rm -f ./obj/*.o"
-    system "rm -f ./obj/*.o"
-  end
-
-  def clean_target
-    puts "rm -f ./target/*"
-    system "rm -f ./target/*"
-  end
-
-  def clean_bin
-    clean_obj
-    clean_target
-  end
-
-  def clean_lib
-    clean_obj
-    clean_target
-  end
-
-  public
-  def inspect 
-    puts "name is #{@name}"
-    puts "name is #{@workspace}"
-  end
-end