canoe 0.3.2.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f216d0dc37bc62674772eb685e40bae7859af341e75f3b67e4f9327030ad3483
-  data.tar.gz: 28c69b2037f47926b86a5f927ff0398f6122a30adb725ce0e5830dea81acf549
+  metadata.gz: 6c8e08b29045ffc655f4dedf9cb358b70e643702dac79a88d81436e39ba9ace1
+  data.tar.gz: 2d5a877f870fa531b236f570c52f3b97ec9fc7efd35c0b05447f1e7e850f47e1
 SHA512:
-  metadata.gz: 110c69c11e3be4d7d38e23cb2d83680fd4677f5537f5448fba4a5d68999e5e1727794d9c857ccb290a628e6c4586c22a68c8ee73799f7ecf1e58ffa9dd1ea351
-  data.tar.gz: 05a9808ee35431a874a932c36af3b6ab3d5f0734a04fd2ed70aa9d18ac2a4d3c211340142f722acee9dea997030b80c5e34e77491c6a387ab1bad74936529e7e
+  metadata.gz: a40625eaafec1023609c210a5d84710433b3d34557fc1079b9a0ca441da60ecfc6316ab4d9e1c40991530c6fb8c49155109561f3663699dfffe3bd23cf6e1c44
+  data.tar.gz: 47fde1b6a149e118d6b835e2d82e55654627a08c98faa2a8535a9e142f29a2eda5b0572da9f43c13084932e70777502df48cd608ac2db27f8586c0538acab5a2

data/lib/cmd.rb

@@ -53,31 +53,38 @@ module Canoe
         abort_on_err "it's not reasonable to add a component with no name given"
       end
 
-      get_current_workspace.add args
+      current_workspace.add args
     end
 
     def parse_build(args)
-      get_current_workspace.build args
+      options = {[] => 'target', ['all'] => 'all', ['test'] => 'test', ['base'] => 'base'}
+      abort_on_err "Unkown subcommand #{args.join(" ").red}" unless options.include?(args)
+      current_workspace.build options[args]
     end
 
     def parse_generate(args)
-      get_current_workspace.generate
+      current_workspace.generate
     end
 
     def parse_run(args)
-      get_current_workspace.run args
+      current_workspace.run args
     end
 
     def parse_dep(args)
-      get_current_workspace.dep
+      current_workspace.dep
     end
 
     def parse_clean(args)
-      get_current_workspace.clean args
+      options = {
+        [] => 'all', ['all'] => 'all',
+        ['target'] => 'target', ['tests'] => 'tests', ['obj'] => 'obj'
+      }
+      abort_on_err "Unkown subcommand #{args.join(" ").red}" unless options.include?(args)
+      current_workspace.clean options[args]
     end
 
     def parse_test(args)
-      get_current_workspace.test args
+      current_workspace.test args
     end
 
     def parse_version(args)
@@ -89,11 +96,11 @@ module Canoe
     end
 
     def parse_update(args)
-      get_current_workspace.update
+      current_workspace.update
     end
 
     def parse_make(args)
-      get_current_workspace.make
+      current_workspace.make
     end
   end
 end

data/lib/config_reader.rb

@@ -1,11 +1,17 @@
 require 'json'
+require_relative 'util'
 
 ##
 # class ConfigReader
 #   Just read a json file
 class ConfigReader
-  def self.extract_flags(file)
-    abort_on_err("config file #{file} does not exsit") unless File.exist? file
-    JSON.parse(File.read(file))
+  include Canoe::Err
+  def initialize(file)
+    @config_file = file
+  end
+
+  def extract_flags
+    abort_on_err("config file #{@config_file} does not exsit") unless File.exist? @config_file
+    JSON.parse(File.read(@config_file))
   end
 end

data/lib/default_files.rb

@@ -10,19 +10,18 @@ class DefaultFiles
       end
     end
 
-    def create_config(path, src_sfx = 'cpp', hdr_sfx = 'hpp')
+    def create_config(path, compiler = 'clang++', src_sfx = 'cpp', hdr_sfx = 'hpp')
       open_file_and_write(
         "#{path}/config.json",
         <<~CONFIG
           {
-              "compiler": "clang++",
+              "compiler": "#{compiler}",
               "header-suffix": "#{hdr_sfx}",
               "source-suffix": "#{src_sfx}",
               "flags": {
                   "compile": {
                       "opt": "-O2",
-                      "debug": "-g",
-                      "std": "-std=c++17"
+                      "debug": "-g"
                   },
                   "link": {
 
@@ -34,12 +33,13 @@ class DefaultFiles
     end
 
     def create_main(path, suffix = 'cpp')
+      header = suffix == 'c' ? 'stdio.h' : 'iostream'
       open_file_and_write(
         "#{path}/main.#{suffix}",
         <<~DOC
-          #include <iostream>
+          #include <#{header}>
           int main(int argc, char *argv[]) {
-              std::cout << "hello world!" << std::endl;
+
           }
         DOC
       )

data/lib/source_files.rb

@@ -30,13 +30,14 @@ 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
+        elsif File.directory? file
           get_all_helper("#{file}", &block)
         end
       end

data/lib/util.rb

@@ -1,6 +1,11 @@
 require_relative 'coloring'
 
+require 'English'
+
 module Canoe
+  ##
+  # Stepper record the progress of a task
+  # progress is obtained via #'progress_as_str
   class Stepper
     def initialize(total, togo)
       @total = total.to_f
@@ -16,13 +21,13 @@ module Canoe
       @togo -= 1 if @togo.positive?
     end
   end
-  
+
   ##
   # wrapping workspace related functionality to expose to other modules
   module WorkSpaceUtil
-    def get_current_workspace
+    def current_workspace
       abort_on_err 'not in a canoe workspace' unless File.exist? '.canoe'
-      config = ConfigReader.extract_flags('config.json')
+      config = ConfigReader.new('config.json').extract_flags
 
       src_sfx = config['source-suffix'] || 'cpp'
       hdr_sfx = config['header-suffix'] || 'hpp'
@@ -34,30 +39,37 @@ module Canoe
     end
 
     def src_to_obj(src)
-      get_current_workspace.src_to_obj(src)
+      current_workspace.src_to_obj(src)
     end
 
     def comp_to_obj(comp)
-      get_current_workspace.comp_to_obj(comp)
+      current_workspace.comp_to_obj(comp)
     end
 
     def file_to_obj(file)
-      get_current_workspace.file_to_obj(file)
+      current_workspace.file_to_obj(file)
     end
 
     def extract_one_file(file, deps)
-      get_current_workspace.extract_one_file(file, deps)
+      current_workspace.extract_one_file(file, deps)
     end
 
     def extract_one_file_obj(file, deps)
-      get_current_workspace.extract_one_file_obj(file, deps)
+      current_workspace.extract_one_file_obj(file, deps)
     end
   end
 
   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
   

data/lib/workspace/build.rb

@@ -1,3 +1,4 @@
+require 'json'
 module Canoe
   class WorkSpace
     def src_to_obj(src)
@@ -17,15 +18,15 @@ module Canoe
       end
     end
 
+    def hdr_of_src(file)
+      file.gsub(".#{@source_suffix}", ".#{@header_suffix}")
+    end
+
     # args are commandline parameters passed to `canoe build`,
-    # could be 'all', 'test', 'target' or empty
-    def build(args)
-      options = {[] => 'target', ['all'] => 'all', ['test'] => 'test'}
-      if options.include?(args)
-        send "build_#{options[args]}"
-      else
-        abort_on_err "Unkown subcommand #{args.join(" ").red}"
-      end
+    # could be 'all', 'test', 'target', 'base' or empty
+    def build(arg = 'target')
+      build_compiler_from_config
+      send "build_#{arg}"
     end
 
     private
@@ -46,14 +47,14 @@ module Canoe
     end
 
     def build_compiler_from_config
-      flags = ConfigReader.extract_flags "config.json"
-      compiler_name = flags["compiler"] ? flags["compiler"] : "clang++"
+      flags = ConfigReader.new('config.json').extract_flags
+      compiler_name = flags['compiler'] ? flags['compiler'] : 'clang++'
 
       abort_on_err "compiler #{compiler_name} not found" unless system "which #{compiler_name} > /dev/null"
-      compiler_flags = ["-Isrc/components"]
+      compiler_flags = ['-Isrc/components']
       linker_flags = []
 
-      c_flags, l_flags = flags["flags"]["compile"], flags["flags"]["link"]
+      c_flags, l_flags = flags['flags']['compile'], flags['flags']['link']
       build_flags(compiler_flags, c_flags)
       build_flags(linker_flags, l_flags)
 
@@ -132,12 +133,9 @@ module Canoe
 
     def build_target
       puts "#{'[BUILDING TARGET]'.magenta}..."
-      deps = get_deps @deps, @src, [@src_short, @components_short]
       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 
-
-      build_compiler_from_config
+      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"
@@ -146,5 +144,49 @@ module Canoe
 
       self.send "build_#{@mode.to_s}", files
     end
+
+    # generate a compile_commands.json file
+    def build_base
+      deps = target_deps.merge tests_deps
+      database = CompilationDatabase.new
+      deps.each_key do |k|
+        next if k.end_with? @header_suffix
+        c = @compiler.name.end_with?('++') ? 'c++' : 'c'
+
+        arg =  [c] + @compiler.compiling_flags_as_str.split + [k] + [file_to_obj(k)] + ['-c', '-o']
+        database.add_command_object(@workspace, arg, k)
+      end
+      File.open('compile_commands.json', 'w') do |f|
+        f.puts database.pretty_to_s
+      end
+    end
+  end
+
+  class CompilationDatabase
+    attr_reader :database
+    def initialize
+      @database = []
+    end
+
+    def add_command_object(dir, arguments, file)
+      temp = {             
+        "arguments" => arguments,
+        "directory" => dir,
+        "file" => file
+      }
+      @database << temp
+    end
+
+    def to_s
+      @database.to_s
+    end
+
+    def pretty_to_s
+      JSON.pretty_generate(@database)
+    end
+
+    def to_json
+      @database.to_json
+    end
   end
 end

data/lib/workspace/clean.rb

@@ -1,16 +1,8 @@
 module Canoe
   class WorkSpace
     # valid options: none, 'all', 'target', 'tests'
-    def clean(args)
-      options = {
-        [] => 'all', ['all'] => 'all',
-        ['target'] => 'target', ['tests'] => 'tests', ['obj'] => 'obj'
-      }
-      if options.include?(args)
-        send "clean_#{options[args]}"
-      else
-        abort_on_err "Unkown subcommand #{args.join(' ').red}"
-      end
+    def clean(arg = 'all')
+      send "clean_#{arg}"
     end
 
     private

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/make.rb

@@ -1,6 +1,8 @@
 # If the project has circular dependency, this command would fail
 module Canoe
-  class Makefile
+  ##
+  # CanoeMakefile is used to offer makefile generation utilities
+  class CanoeMakefile
     include WorkSpaceUtil
     def initialize(workspace)
       @workspace = workspace
@@ -208,25 +210,23 @@ module Canoe
 
     def make_obj_rules(makefile, deps)
       cmplr = cxx?(get_compiler) ? 'CXX' : 'CC'
-      makefile.puts("all: OUT\n")
-      makefile.puts ''
 
       @all_names.each do |n|
-        makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ -c $(SRC_#{n})")
-        makefile.puts ''
+        makefile.puts("$(OBJ_#{n}): $(#{n}_DEP)\n\t$(#{cmplr}) $(#{cmplr}FLAGS) -o $@ -c $(SRC_#{n})\n\n")
       end
-
     end
 
     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)")
+        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)")
+        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)
@@ -256,10 +256,9 @@ module Canoe
     def make_rules(makefile, deps)
       make_dependencies makefile, deps
       makefile.puts ''
-      make_obj_rules 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
@@ -268,11 +267,11 @@ module Canoe
 
   class WorkSpace
     def make
-      config = ConfigReader.extract_flags "config.json"
+      config = ConfigReader.new('config.json').extract_flags
 
       deps = target_deps.merge tests_deps
 
-      makefile = Makefile.new self
+      makefile = CanoeMakefile.new self
       makefile.configure config
       makefile.make! deps
     end

data/lib/workspace/new.rb

@@ -8,24 +8,36 @@ 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
         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
+      compiler = @source_suffix == 'c' ? 'clang' : 'clang++'
+      DefaultFiles.create_config @workspace, compiler, @source_suffix, @header_suffix
 
       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

@@ -3,10 +3,10 @@ module Canoe
     def run(args)
       return if @mode == :lib
 
-      return unless build []
+      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,15 +5,8 @@ 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
@@ -44,13 +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 "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)
+      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
 
-      issue_command bin
+      cmd = "#{bin} #{args}"
+      if rebuild
+        build_compiler_from_config
+        run_command cmd if build_one_test(file, deps)
+      else
+        run_command cmd
+      end
     end
 
     def fetch_all_test_files
@@ -76,7 +83,7 @@ module Canoe
     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)
+        next if File.exist?(o) && File.mtime(o) > File.mtime(f) && File.mtime(o) > File.mtime(hdr_of_src(f))
 
         compile(f, o)
       end

data/lib/workspace/version.rb

@@ -2,7 +2,7 @@ module Canoe
   class WorkSpace
     def self.version
       puts <<~VER
-           canoe v0.3.2.1
+           canoe v0.3.3
            For features in this version, please visit https://github.com/Dicridon/canoe
            Currently, canoe can do below:
                - project creation

data/lib/workspace/workspace.rb

@@ -11,6 +11,8 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.3.2.1
+  version: 0.3.3
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.