canoe 0.2.4 → 0.3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e9bebbc3472c5f6271c4c019f23bf18779492934ed86411f4d09384e51bfeab
-  data.tar.gz: 9aa82b75a58e0992653ddc5419bf14e129846cc54cc9358f08baa1d2014d8d5a
+  metadata.gz: f86609a6f492e0a6633dab5d94a46443c24de7cad25640d9b4cfa0a8c97b2907
+  data.tar.gz: e80970d6113b6a155edbfed18e490ad297ad75d0da626394ecdc9d4f2a166d7b
 SHA512:
-  metadata.gz: fd9be9cc303239eaa9853c177501e460023279a6385094afbe79e55b912257cebe72860633b53503dff96583a61aa88ea6034ce0e741e36f4fce8acce33c2496
-  data.tar.gz: 6ee389790c8490d80ef9742e877fc0de8b13b6b74629361e68f363155c628a0dff1764d066f4608b0b7e7cef72f20b1775c2b214be487b4bdcf943ab1b985c3f
+  metadata.gz: 69ea4c7960c5240f870b9d9a851a55cf3ebfa41fed2417b2a0eae9d49dff93fe6d1bb1e0dedfcb6abf72d5c452ca38297b643848d25a1103000d0b280765f4a8
+  data.tar.gz: b9fc0c80a96a201af4f32eb6d8d787ebe7869996fbdd2c97b5f0c2f0871c52e5ae3bdeef94b2f79e5153a2fc5c43704fa6a3ee7b9286771de9aceed60339c798

data/bin/canoe

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# require_relative '../lib/canoe'
 require 'canoe'
 
 Canoe.new.parse ARGV

data/lib/canoe.rb

@@ -1,23 +1,25 @@
-require_relative "workspace"
+require_relative "workspace/workspace.rb"
 require_relative "cmd"
 require_relative "source_files"
 
 class Canoe
   def initialize
-    options = ['new', 
-               'add',
-               'build',
-               'generate',
-               'run',
-               'dep',
-               'clean',
-               'version',
-               'help',
-               'update']
+    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

@@ -1,16 +1,20 @@
-require_relative "workspace"
+require_relative "workspace/workspace"
 require_relative "err"
 require_relative "config_reader"
 
+##
+# class CmdParser
+#   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])
@@ -21,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")
@@ -31,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
@@ -41,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
@@ -52,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
@@ -64,7 +69,7 @@ class CmdParser
 
     get_current_workspace.add args
   end
-  
+
   def parse_build(args)
     get_current_workspace.build args
   end
@@ -72,31 +77,27 @@ 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
 
+  def parse_test(args)
+    get_current_workspace.test args
+  end
+
   def parse_version(args)
-    puts <<~VER
-        canoe v0.2.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
+    WorkSpace.version
   end
-  
+
   def parse_help(args)
     WorkSpace.help
   end
@@ -104,4 +105,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

@@ -0,0 +1,23 @@
+##
+# gem Colorize is a great tool, but I don't want add dependencies to Canoe
+class String
+  def self.define_coloring_methods
+    colors = {
+      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
+        "\033[#{k}m#{self}\033[0m"
+      end
+    end
+  end
+
+  define_coloring_methods
+end

data/lib/compiler.rb

@@ -1,35 +1,48 @@
+##
+# class Compiler
+#   Storing compiler name in String and flags as an array
 class Compiler
   attr_reader :name, :flags
-  def initialize(name, flgs)
+  ##
+  # @name: String
+  # @flgs: Array of String
+  def initialize(name, compiling_flags, linking_flags)
     @name = name
-    @flags = flgs
+    @linking_flags = linking_flags
+    @compiling_flags = compiling_flags
   end
 
-  def flags_as_str
-    flags.join " "
+  def compiling_flags_as_str
+    @compiling_flags.join " "
   end
 
-  def append_flag(flag)
-    @flags << flag
+  def linking_flags_as_str
+    @linking_flags.join " "
+  end
+
+  def append_compiling_flag(flag)
+    @compiling_flags << flag
+  end
+
+  def append_linking_flag(flag)
+    @linking_flags << flag
   end
 
   def compile(src, out)
-    puts "#{name} -o #{out} #{flags_as_str} -c #{src}"
-    system "#{name} -o #{out} #{flags_as_str} -c #{src}"
+    puts "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
+    system "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
   end
 
   def link_executable(out, objs)
-    libs = flags.select {|f| f.start_with?('-l')}
-    puts "#{name} -o #{out} #{objs.join(" ")} #{libs.join(" ")}"
-    system "#{name} -o #{out} #{objs.join(" ")} #{libs.join(" ")}"
+    puts "#{name} -o #{out} #{objs.join(" ")} #{linking_flags_as_str}"
+    system "#{name} -o #{out} #{objs.join(" ")} #{linking_flags_as_str}"
   end
 
   def link_shared(out, objs)
-    libs = flags.select {|f| f.start_with?('-l')}
-    puts "#{name} -shared -o #{out}.so #{objs.join(" ")} #{libs.join(" ")}"
-    system "#{name} -shared -o #{out}.so #{objs.join(" ")} #{libs.join(" ")}"
+    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,5 +1,8 @@
-require 'json'
+require "json"
 
+##
+# 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.exists? file

data/lib/default_files.rb

@@ -1,82 +1,98 @@
+##
+# class DefaultFiles
+#   A singleton class to generate header and souce files.
+#   TODO: consider using class source_file.rb in Pareater
 class DefaultFiles
-  def self.open_file_and_write(filename, content)
-    File.open(filename, "w") {|f|
-      f.write(content)
-    }
-  end
-
-  def self.create_config(path, src_sfx='cpp', hdr_sfx='hpp')
-    open_file_and_write(
-      "#{path}/config.json", 
-      <<~CONFIG
-        {
-            "compiler": "clang++",
-            "header-suffix": "#{hdr_sfx}",
-            "source-suffix": "#{src_sfx}",
-            "flags": {
-                "opt": "-O2",
-                "debug": "-g",
-                "std": "-std=c++17"
-            }
-        }
-      CONFIG
-    )
-  end
-
-  def self.create_main(path, suffix='cpp')
-    open_file_and_write(
-      "#{path}/main.#{suffix}",
-      <<~DOC
-        #include <iostream>
-        int main(int argc, char *argv[]) {
-            std::cout << "hello world!" << std::endl;
-        }
-      DOC
-    )
-  end
+  class << self
+    def open_file_and_write(filename, content)
+      File.open(filename, "w") do |f|
+        f.write(content)
+      end
+    end
 
-  def self.create_lib_header(path, lib_name, suffix='hpp')
-    open_file_and_write(
-      "#{path}/#{lib_name}.#{suffix}",
-      <<~DOC
-        #ifndef __#{lib_name.upcase}__
-        #define __#{lib_name.upcase}__
+    def create_config(path, src_sfx = "cpp", hdr_sfx = "hpp")
+      open_file_and_write(
+        "#{path}/config.json",
+        <<~CONFIG
+          {
+              "compiler": "clang++",
+              "header-suffix": "#{hdr_sfx}",
+              "source-suffix": "#{src_sfx}",
+              "flags": {
+                  "compile": {
+                      "opt": "-O2",
+                      "debug": "-g",
+                      "std": "-std=c++17"
+                  },
+                  "link": {
+                    
+                  }
+              }
+          }
+        CONFIG
+      
+)
+    end
 
-        #endif
-      DOC
-    )
-  end
+    def create_main(path, suffix = "cpp")
+      open_file_and_write(
+        "#{path}/main.#{suffix}",
+        <<~DOC
+          #include <iostream>
+          int main(int argc, char *argv[]) {
+              std::cout << "hello world!" << std::endl;
+          }
+        DOC
+      
+)
+    end
 
-  def self.create_emacs_dir_local(path)
-    open_file_and_write(
-      "#{path}/.dir-locals.el",
-      <<~DOC
-        ((nil . ((company-clang-arguments . ("-I./src/components/"
-                                             "-I./components/"))))
-         (nil . ((company-c-headers-path-user . ("./src/components/"
-                                 "./components/")))))
-      DOC
-    )
-  end
+    def create_lib_header(path, lib_name, suffix = "hpp")
+      open_file_and_write(
+        "#{path}/#{lib_name}.#{suffix}",
+        <<~DOC
+          #ifndef __#{lib_name.upcase}__
+          #define __#{lib_name.upcase}__
+         
+          #endif
+        DOC
+      
+)
+    end
 
-  def self.create_cpp(filename, src_sfx='cpp', hdr_sfx='hpp')
-    open_file_and_write(
-      "#{filename}.#{src_sfx}", 
-      <<~DOC
-                #include "#{filename}.#{hdr_sfx}"
-      DOC
-    )
-  end
+    # def create_emacs_dir_local(path)
+    #   open_file_and_write(
+    #     "#{path}/.dir-locals.el",
+    #     <<~DOC
+    #       ((nil . ((company-clang-arguments . ("-I./src/components/"
+    #                                            "-I./components/"))))
+    #        (nil . ((company-c-headers-path-user . ("./src/components/"
+    #                                "./components/")))))
+    #     DOC
+    #   )
+    # end
 
-  def self.create_hpp(workspace, prefix, filename, hdr_sfx='hpp')
-    open_file_and_write(
-      "#{filename}.#{hdr_sfx}",
-      <<~DOC
-        #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
-        #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+    def create_cpp(filename, src_sfx = "cpp", hdr_sfx = "hpp")
+      open_file_and_write(
+        "#{filename}.#{src_sfx}",
+        <<~DOC
+          #include "#{filename}.#{hdr_sfx}"
+        DOC
+      
+)
+    end
 
-        #endif
-      DOC
-    )
+    def create_hpp(workspace, prefix, filename, hdr_sfx = "hpp")
+      open_file_and_write(
+        "#{filename}.#{hdr_sfx}",
+        <<~DOC
+          #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+          #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
+          
+          #endif
+        DOC
+      
+)
+    end
   end
 end