canoe 0.3.0.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acf64e52f86562fbb4103263adf6ac25d3583fdd8cc935df460d6df89ffa4367
-  data.tar.gz: 8f3e6ba476da88e1cd34abffb4bfa70e0ac910fb5bc93977601df49e44a75735
+  metadata.gz: af31768c0b36d635c13ff31e41dc772dd9834ccd2d52e791f399053ebb3b9782
+  data.tar.gz: 135f95f9631bcc43c4817833ee9a6075b1d336239b9131c8f5f26d3f0006cd3b
 SHA512:
-  metadata.gz: e39ce423d813c64ef43c4440990439463a99dcb724771adc2d4d5db130c8206d7a3801c9fd036ee1477cd5c162f19b3da3dbc123e6114cba5bc7d8c0bf7d03a0
-  data.tar.gz: fe49d0b455bb21deb30b149f08736e2cff7091d8a3d38f87ac395fa1800c8b9abdb7c17594007412f5aacce448da5ebb60fd9a986fbf2ab645737aa59cd9100f
+  metadata.gz: 9c82734822d59c1cd1a119dcc55f954f3d6b971457f44df22c8e9f6eceaa638c503816a1f05dc54019ea8ded2c70f1431e26cab0c057db3cd4ee2775dc12583c
+  data.tar.gz: 9b23406264a260e2b715018f5ad275c6a8b9293d712fd4d7623b03709fa5d93ee03cbc916472d9b24e9e6e1d4e2dd83e6781903ca7987febc4ec28a3e92e0ce5

data/lib/canoe.rb

@@ -4,21 +4,22 @@ require_relative "source_files"
 
 class Canoe
   def initialize
-    options = ['new', 
-               'add',
-               'build',
-               'generate',
-               'run',
-               'dep',
-               'clean',
-               'version',
-               'help',
-               'update',
-               'test']
+    options = ["new",
+               "add",
+               "build",
+               "generate",
+               "make",
+               "run",
+               "dep",
+               "clean",
+               "version",
+               "help",
+               "update",
+               "test"]
     @cmd = CmdParser.new options
   end
 
   def parse(args)
-      @cmd.parse args
+    @cmd.parse args
   end
 end

data/lib/cmd.rb

@@ -7,13 +7,14 @@ require_relative "config_reader"
 #   Parsing command arguments passed to canoe
 class CmdParser
   include Err
+
   def initialize(options)
-    @options = options 
+    @options = options
   end
 
   def parse(args)
-    if args.size < 1 
-      abort_on_err "please give one command among #{@options.join(', ')}"
+    if args.size < 1
+      abort_on_err "please give one command among #{@options.join(", ")}"
     end
 
     unless @options.include?(args[0])
@@ -24,6 +25,7 @@ class CmdParser
   end
 
   private
+
   def get_current_workspace
     abort_on_err "not in a canoe workspace" unless File.exists? ".canoe"
     config = ConfigReader.extract_flags("config.json")
@@ -34,7 +36,7 @@ class CmdParser
     name = Dir.pwd.split("/")[-1]
     mode = File.exists?("src/main.#{src_sfx}") ? :bin : :lib
 
-    Dir.chdir('..') do
+    Dir.chdir("..") do
       return WorkSpace.new(name, mode, src_sfx, hdr_sfx)
     end
   end
@@ -44,10 +46,10 @@ class CmdParser
 
     name, mode = nil, "bin"
     suffixes = ["cpp", "hpp"]
-    
+
     args.each do |arg|
       case arg
-      when '--bin', '--lib'
+      when "--bin", "--lib"
         mode = arg[2..]
       when /--suffix=(\w+)\:(\w+)/
         suffixes[0], suffixes[1] = $1, $2
@@ -55,7 +57,7 @@ class CmdParser
         name = arg unless name
       end
     end
-    
+
     abort_on_err("please give a name to this project") unless name
     WorkSpace.new(name, mode.to_sym, suffixes[0], suffixes[1]).new
   end
@@ -67,7 +69,7 @@ class CmdParser
 
     get_current_workspace.add args
   end
-  
+
   def parse_build(args)
     get_current_workspace.build args
   end
@@ -75,15 +77,15 @@ class CmdParser
   def parse_generate(args)
     get_current_workspace.generate
   end
-  
+
   def parse_run(args)
     get_current_workspace.run args
   end
 
   def parse_dep(args)
-    get_current_workspace.dep 
+    get_current_workspace.dep
   end
-  
+
   def parse_clean(args)
     get_current_workspace.clean
   end
@@ -94,16 +96,16 @@ class CmdParser
 
   def parse_version(args)
     puts <<~VER
-        canoe v0.3.0.2
-        For features in this version, please visit https://github.com/Dicridon/canoe
-        Currently, canoe can do below:
-            - project creation
-            - project auto build and run (works like Cargo for Rust)
-            - project structure management
-        by XIONG Ziwei
-        VER
+           canoe v0.3.1
+           For features in this version, please visit https://github.com/Dicridon/canoe
+           Currently, canoe can do below:
+               - project creation
+               - project auto build and run (works like Cargo for Rust)
+              - project structure management
+           by XIONG Ziwei
+         VER
   end
-  
+
   def parse_help(args)
     WorkSpace.help
   end
@@ -111,4 +113,8 @@ class CmdParser
   def parse_update(args)
     get_current_workspace.update
   end
+
+  def parse_make(args)
+    get_current_workspace.make
+  end
 end

data/lib/coloring.rb

@@ -3,14 +3,14 @@
 class String
   def self.define_coloring_methods
     colors = {
-        30 => :black,
-        31 => :red,
-        32 => :green,
-        33 => :yellow,
-        34 => :blue,
-        35 => :magenta,
-        36 => :cyan,
-        37 => :white
+      30 => :black,
+      31 => :red,
+      32 => :green,
+      33 => :yellow,
+      34 => :blue,
+      35 => :magenta,
+      36 => :cyan,
+      37 => :white,
     }
     colors.each do |k, v|
       define_method v do
@@ -20,4 +20,4 @@ class String
   end
 
   define_coloring_methods
-end
+end

data/lib/compiler.rb

@@ -20,7 +20,6 @@ class Compiler
     @linking_flags.join " "
   end
 
-
   def append_compiling_flag(flag)
     @compiling_flags << flag
   end
@@ -43,7 +42,7 @@ class Compiler
     puts "#{name} -shared -o #{out}.so #{objs.join(" ")} #{linking_flags_as_str}"
     system "#{name} -shared -o #{out}.so #{objs.join(" ")} #{linking_flags_as_str}"
   end
-  
+
   def inspect
     puts "compiler name: #{name.inspect}"
     puts "compiler flags: #{flags.inspect}"

data/lib/config_reader.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 ##
 # class ConfigReader

data/lib/default_files.rb

@@ -10,9 +10,9 @@ class DefaultFiles
       end
     end
 
-    def create_config(path, src_sfx='cpp', hdr_sfx='hpp')
+    def create_config(path, src_sfx = "cpp", hdr_sfx = "hpp")
       open_file_and_write(
-        "#{path}/config.json", 
+        "#{path}/config.json",
         <<~CONFIG
           {
               "compiler": "clang++",
@@ -30,10 +30,11 @@ class DefaultFiles
               }
           }
         CONFIG
-      )
+      
+)
     end
 
-    def create_main(path, suffix='cpp')
+    def create_main(path, suffix = "cpp")
       open_file_and_write(
         "#{path}/main.#{suffix}",
         <<~DOC
@@ -42,10 +43,11 @@ class DefaultFiles
               std::cout << "hello world!" << std::endl;
           }
         DOC
-      )
+      
+)
     end
 
-    def create_lib_header(path, lib_name, suffix='hpp')
+    def create_lib_header(path, lib_name, suffix = "hpp")
       open_file_and_write(
         "#{path}/#{lib_name}.#{suffix}",
         <<~DOC
@@ -54,7 +56,8 @@ class DefaultFiles
          
           #endif
         DOC
-      )
+      
+)
     end
 
     # def create_emacs_dir_local(path)
@@ -69,16 +72,17 @@ class DefaultFiles
     #   )
     # end
 
-    def create_cpp(filename, src_sfx='cpp', hdr_sfx='hpp')
+    def create_cpp(filename, src_sfx = "cpp", hdr_sfx = "hpp")
       open_file_and_write(
-        "#{filename}.#{src_sfx}", 
+        "#{filename}.#{src_sfx}",
         <<~DOC
           #include "#{filename}.#{hdr_sfx}"
         DOC
-      )
+      
+)
     end
 
-    def create_hpp(workspace, prefix, filename, hdr_sfx='hpp')
+    def create_hpp(workspace, prefix, filename, hdr_sfx = "hpp")
       open_file_and_write(
         "#{filename}.#{hdr_sfx}",
         <<~DOC
@@ -87,7 +91,8 @@ class DefaultFiles
           
           #endif
         DOC
-      )
+      
+)
     end
   end
 end

data/lib/dependence.rb

@@ -1,11 +1,11 @@
-require_relative 'source_files'
-require_relative 'err'
+require_relative "source_files"
+require_relative "err"
 
 ##
 # class DepAnalyzer
-#   This class is the key component of canoe, which offers file dependency analysis functionality. 
+#   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, i.e. test.cpp and test.hpp.
+#     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
@@ -20,15 +20,15 @@ class DepAnalyzer
     File.open(filename, "r") do |f|
       ret = Hash.new []
       f.each_with_index do |line, i|
-        entry = line.split(': ')
-        Err.abort_on_err("Bad .canoe.deps format, line #{i+1}") unless entry.length == 2
+        entry = line.split(": ")
+        Err.abort_on_err("Bad .canoe.deps format, line #{i + 1}") unless entry.length == 2
         ret[entry[0]] = entry[1].split
-      end            
+      end
       ret
     end
   end
 
-  def self.compiling_filter(deps, build_time, src_sfx='cpp', hdr_sfx='hpp')
+  def self.compiling_filter(deps, build_time, src_sfx = "cpp", hdr_sfx = "hpp")
     files = []
     @processed = {}
     @recompiles = {}
@@ -57,6 +57,7 @@ class DepAnalyzer
   end
 
   private
+
   def self.mark(file, build_time, deps)
     ret = false
     return false unless File.exists? file
@@ -71,21 +72,21 @@ class DepAnalyzer
         @processed[f] = true
         if mark(f, build_time, deps)
           @recompiles[f] = true
-          return true 
+          return true
         end
       end
     end
     ret
   end
 
-  def self.should_recompile?(file, build_time) 
+  def self.should_recompile?(file, build_time)
     judge = build_time
     if build_time == Time.new(0)
       objfile = if file.start_with?("./src/components")
-                  './obj/' + file.delete_suffix(File.extname(file))['./src/components/'.length..].gsub('/', '_') + '.o'
-                else
-                  "./obj/#{File.basename(file, ".*")}.o"
-                end
+          "./obj/" + file.delete_suffix(File.extname(file))["./src/components/".length..].gsub("/", "_") + ".o"
+        else
+          "./obj/#{File.basename(file, ".*")}.o"
+        end
       return true unless File.exists? objfile
       judge = File.mtime(objfile)
     end
@@ -93,7 +94,8 @@ class DepAnalyzer
   end
 
   public
-  def initialize(dir, src_sfx='cpp', hdr_sfx='hpp')
+
+  def initialize(dir, src_sfx = "cpp", hdr_sfx = "hpp")
     @dir = dir
     @deps = Hash.new []
     @source_suffix = src_sfx
@@ -115,25 +117,26 @@ class DepAnalyzer
 
   def build_to_file(include_path, filename)
     build_dependence include_path
-    
+
     File.open(filename, "w") do |f|
       @deps.each do |k, v|
         f.write "#{k}: #{v.join(" ")}\n"
       end
     end
-    
+
     @deps
   end
 
   private
-  def get_all_headers(include_path, file, suffix='hpp')
+
+  def get_all_headers(include_path, file, suffix = "hpp")
     File.open(file, "r") do |f|
       ret = []
       if file.end_with?(".#{@source_suffix}")
         header = file.sub(".#{@source_suffix}", ".#{@header_suffix}")
         ret += [header] if File.exists?(header)
       end
-      
+
       f.each_line do |line|
         if mat = line.match(/include "(.+\.#{suffix})"/)
           include_path.each do |path|
@@ -142,7 +145,7 @@ class DepAnalyzer
           end
         end
       end
-      
+
       ret.uniq
     end
   end

data/lib/err.rb

@@ -1,4 +1,5 @@
-require_relative 'coloring'
+require_relative "coloring"
+
 module Err
   def warn_on_err(err)
     puts <<~ERR
@@ -13,8 +14,8 @@ module Err
             #{"Fatal: ".red}
                 #{err}
             try 'canoe help' for more information
-         ERR
+          ERR
   end
 
   module_function :warn_on_err, :abort_on_err
-end
+end

data/lib/source_files.rb

@@ -5,7 +5,7 @@ class SourceFiles
   class << self
     def get_all(dir, &block)
       @files = []
-      get_all_helper(dir, &block) 
+      get_all_helper(dir, &block)
       @files
     end
 
@@ -19,13 +19,14 @@ class SourceFiles
           else
             @files << "#{file}"
           end
-        end 
+        end
       end
-      
+
       @files
     end
 
     private
+
     def get_all_helper(dir, &block)
       Dir.each_child(dir) do |f|
         file = "#{dir}/#{f}"
@@ -42,4 +43,3 @@ class SourceFiles
     end
   end
 end
-

data/lib/workspace/add.rb

@@ -8,19 +8,20 @@ class WorkSpace
         dir += "/#{filename}"
         prefix << filename
         unless Dir.exist? dir
-          FileUtils.mkdir dir 
+          FileUtils.mkdir dir
           Dir.chdir(dir) do
             puts "created " + Dir.pwd.blue
-            create_working_files prefix.join('__'), filename
+            create_working_files prefix.join("__"), filename
           end
         end
       end
     end
   end
 
-private
+  private
+
   def create_working_files(prefix, filename)
     DefaultFiles.create_cpp filename, @source_suffix, @header_suffix
     DefaultFiles.create_hpp @name, prefix, filename, @header_suffix
   end
-end
+end

data/lib/workspace/build.rb

@@ -1,5 +1,5 @@
 class WorkSpace
-  # args are commandline parameters passed to `canoe build`, 
+  # args are commandline parameters passed to `canoe build`,
   # could be 'all', 'test', 'target' or empty
   def build(args)
     case args[0]
@@ -12,8 +12,9 @@ class WorkSpace
     end
   end
 
-private
-  def build_flags(flags, config) 
+  private
+
+  def build_flags(flags, config)
     config.values.each do |v|
       case v
       when String
@@ -31,12 +32,12 @@ private
   def build_compiler_from_config
     Dir.chdir(@workspace) do
       flags = ConfigReader.extract_flags "config.json"
-      compiler_name = flags['compiler'] ? flags['compiler'] : "clang++"
+      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']
+      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)
 
@@ -61,9 +62,9 @@ private
   def build_bin(files)
     # return if files.empty?
     build_compiler_from_config
-    if build_common(files) && link_exectutable('./target', Dir.glob("obj/*.o"))
-        puts "BUILDING SUCCEEDED".green
-    else 
+    if build_common(files) && link_exectutable("./target", Dir.glob("obj/*.o"))
+      puts "BUILDING SUCCEEDED".green
+    else
       puts "building FAILED".red
     end
   end
@@ -71,28 +72,28 @@ private
   def build_lib(files)
     # return if files.empty?
     build_compiler_from_config
-    @compiler.append_compiling_flag '-fPIC'
-    if build_common(files) && link_shared('./target', Dir.glob("obj/*.o"))
+    @compiler.append_compiling_flag "-fPIC"
+    if build_common(files) && link_shared("./target", Dir.glob("obj/*.o"))
       puts "BUILDING SUCCEEDED".green
-    else 
+    else
       puts "building FAILED".red
     end
   end
 
   def build_common(files)
-    all = SourceFiles.get_all('./src') {|f| f.end_with? @source_suffix}
+    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}
+    comps = files.select { |f| f.start_with? @components_prefix }
     srcs = files - comps
-    flag = true;
-    
+    flag = true
+
     srcs.each do |f|
       progress = (compiled / total).round(2) * 100
       printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
       fname = f.split("/")[-1]
-      o = @obj_prefix + File.basename(fname, ".*") + '.o'
-      flag = false unless compile f, o 
+      o = @obj_prefix + File.basename(fname, ".*") + ".o"
+      flag = false unless compile f, o
       compiled += 1
     end
 
@@ -100,7 +101,7 @@ private
       progress = (compiled / total).round(2) * 100
       printf "[#{progress.to_i}%%]".green + " compiling #{f}: "
       o = @obj_prefix + f.delete_suffix(File.extname(f))[@components_prefix.length..]
-                         .gsub('/', '_') + '.o'
+        .gsub("/", "_") + ".o"
       flag = false unless compile f, o
       compiled += 1
     end
@@ -113,9 +114,9 @@ private
   end
 
   def build_target
-    deps = File.exist?(@deps) ? 
-           DepAnalyzer.read_from(@deps) :
-           DepAnalyzer.new('./src').build_to_file(['./src', './src/components'], @deps)
+    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)
@@ -127,4 +128,4 @@ private
 
     self.send "build_#{@mode.to_s}", files
   end
-end
+end

data/lib/workspace/clean.rb

@@ -2,8 +2,9 @@ class WorkSpace
   def clean
     self.send "clean_#{@mode.to_s}"
   end
-  
-private    
+
+  private
+
   def clean_obj
     puts "rm -f ./obj/*.o"
     system "rm -f ./obj/*.o"
@@ -23,4 +24,4 @@ private
     clean_obj
     clean_target
   end
-end
+end

data/lib/workspace/dep.rb

@@ -4,9 +4,9 @@ class WorkSpace
     deps.each do |k, v|
       unless v.empty?
         puts "#{k.blue} depends on: "
-        v.each {|f| puts "    #{f.blue}"}
+        v.each { |f| puts "    #{f.blue}" }
         puts ""
       end
     end
   end
-end
+end

data/lib/workspace/generate.rb

@@ -1,6 +1,5 @@
 class WorkSpace
   def generate
-    DepAnalyzer.new('./src', @source_suffix, @header_suffix)
-               .build_to_file ['./src', './src/components'], @deps
+    DepAnalyzer.new("./src", @source_suffix, @header_suffix).build_to_file ["./src", "./src/components"], @deps
   end
 end

data/lib/workspace/help.rb

@@ -1,71 +1,76 @@
 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 generate: generate dependency relationships and store it in '.canoe.deps' file. Alias: update
+      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
+          canoe update: udpate dependency relationships and store it in '.canoe.deps' file. 
               
-            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
+          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
+
+          canoe make: generate a makefile for this project
+      
+      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
+
+      make: 
+          generate a Makefile for this project
+      
+      @author: written by XIONG Ziwei, ICT, CAS
+      @contact: noahxiong@outlook.com
+    INFO
     puts info
   end
-end
+end

data/lib/workspace/make.rb

@@ -0,0 +1,232 @@
+class Makefile
+  def initialize(workspace)
+    @workspace = workspace
+    @all_names = []
+    @common_variables = {}
+    @src_variables = {}
+    @hdr_variables = {}
+    @obj_variables = {}
+    @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)
+      end
+    end
+  end
+
+  private
+
+  def get_compiler
+    @config["compiler"]
+  end
+
+  def get_header_suffix
+    @workspace.header_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_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 cxx?(name)
+    return get_compiler.end_with? "++"
+  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_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 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 extract_name(name, prefix)
+    if name.start_with?(prefix)
+      name.delete_suffix(File.extname(name))[prefix.length..].gsub("/", "_")
+    else
+      File.basename(name.split("/")[-1], ".*")
+    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"
+    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_srcs(makefile, files)
+    @src_variables.each do |k, v|
+      makefile.puts("SRC_#{k}=#{v}")
+    end
+  end
+
+  def define_hdrs(makefile, files)
+    @hdr_variables.each do |k, v|
+      next if k == "MAIN"
+      makefile.puts("HDR_#{k}=#{v}")
+    end
+  end
+
+  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})" }.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)
+      end
+      tmp
+    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)
+      else
+        "$(#{n}_DEP)"
+      end
+    end.flatten.join " "
+    makefile.puts("#{name}_DEP=#{as_str}")
+  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
+    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
+  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 ""
+    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)")
+    end
+    makefile.puts ""
+
+    clean = <<~DOC
+      .PHONY: clean
+      clean: 
+      \trm $(TARGET)
+      \trm ./obj/*.o
+    DOC
+    makefile.puts(clean)
+  end
+end
+
+class WorkSpace
+  def make
+    config = ConfigReader.extract_flags "config.json"
+
+    deps = File.exist?(@deps) ?
+      DepAnalyzer.read_from(@deps) :
+      DepAnalyzer.new("./src").build_to_fil
+
+    makefile = Makefile.new(self)
+    makefile.configure(config)
+    makefile.make!(deps)
+  end
+end

data/lib/workspace/new.rb

@@ -9,14 +9,14 @@ class WorkSpace
     Dir.mkdir(@components)
     Dir.mkdir("#{@workspace}/obj")
     if @mode == :bin
-      DefaultFiles.create_main(@src, @source_suffix) 
+      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.mkdir(@tests)
@@ -25,4 +25,4 @@ class WorkSpace
     end
     puts "workspace #{@workspace.blue} is created"
   end
-end
+end

data/lib/workspace/run.rb

@@ -6,4 +6,4 @@ class WorkSpace
     puts "./target/#{@name} #{args}"
     exec "./target/#{@name} #{args}"
   end
-end
+end

data/lib/workspace/test.rb

@@ -1,5 +1,6 @@
 class WorkSpace
-public
+  public
+
   def test(args)
     if args.empty?
       test_all
@@ -11,12 +12,13 @@ public
       when "all"
         test_all
       else
-        test_single arg        
+        test_single arg
       end
     end
   end
 
-private
+  private
+
   def test_all
     puts "tests all"
   end
@@ -25,7 +27,7 @@ private
     puts "#{@tests}/bin/test_#{name}"
     # system "./#{@tests}/bin/test_#{name}"
   end
-  
+
   ##
   # how to build:
   # each test file tests one or more components, indicated by included headers
@@ -33,7 +35,7 @@ private
   # TODO
   def build_test
     build
-    deps = DepAnalyzer.new('./tests').build_to_file(['./src', './src/components', './tests', './tests/common'], './tests/.canoe.deps')
+    deps = DepAnalyzer.new("./tests").build_to_file(["./src", "./src/components", "./tests", "./tests/common"], "./tests/.canoe.deps")
     puts deps
   end
-end
+end

data/lib/workspace/update.rb

@@ -2,4 +2,4 @@ class WorkSpace
   def update
     generate
   end
-end
+end

data/lib/workspace/workspace.rb

@@ -1,20 +1,19 @@
-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 "../err"
+require_relative "../dependence"
+require_relative "../coloring"
 
 class WorkSpace
   include Err
-  attr_reader :name, :cwd
+  attr_reader :name, :cwd, :src_prefix, :components_prefix, :obj_prefix, :source_suffix, :header_suffix, :mode
 
-  def initialize(name, mode, src_suffix='cpp', hdr_suffix='hpp')
+  def initialize(name, mode, src_suffix = "cpp", hdr_suffix = "hpp")
     @name = name
-    @compiler = Compiler.new 'clang++', ['-Isrc/components'], []
+    @compiler = Compiler.new "clang++", ["-Isrc/components"], []
     @cwd = Dir.new(Dir.pwd)
     @workspace = "#{Dir.pwd}/#{@name}"
     @src = "#{@workspace}/src"
@@ -24,30 +23,30 @@ class WorkSpace
     @target = "#{@workspace}/target"
     @tests = "#{@workspace}/tests"
     @mode = mode
-    @deps = '.canoe.deps'
+    @deps = ".canoe.deps"
 
-    @src_prefix = './src/'
-    @components_prefix = './src/components/'
-    @obj_prefix = './obj/'
+    @src_prefix = "./src/"
+    @components_prefix = "./src/components/"
+    @obj_prefix = "./obj/"
 
     @source_suffix = src_suffix
     @header_suffix = hdr_suffix
   end
 
-  def inspect 
+  def inspect
     puts "name is #{@name}"
     puts "name is #{@workspace}"
   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 'version'
-require_relative 'update'
-require_relative 'test'
+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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canoe
 version: !ruby/object:Gem::Version
-  version: 0.3.0.2
+  version: 0.3.1
 platform: ruby
 authors:
 - XIONG Ziwei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies: []
 description: |+
   Canoe offers project management and building facilities to C/C++ projects.
@@ -41,11 +41,11 @@ files:
 - 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:

data/lib/workspace/version.rb

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