canoe 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6650afffc9e3aa13bb3489b419cd7e4f2b44f1f104be6fdffa77d0b2a66d072
-  data.tar.gz: fef3df6c97065e9274c2f95e2b2993a740d46a563e9e04b7359fbb4b69d4f95d
+  metadata.gz: 7b97a389b6d90008ad3e69fc0937e7382f904574ae28180f2fe98c9920f41aca
+  data.tar.gz: 8e1fe69ac5b71343a68389d2053a691caa4df6b7ca51c03c2bc50ec5e3527d51
 SHA512:
-  metadata.gz: 1c093606ffcc64c3679afc3b8998841e7e1b8e83a2315d5bc8f1ad91e2c3b36d3eac5d649dda55d27287600ba52c9880c2f65b612b65f5fb57dbeac06ddc865b
-  data.tar.gz: 7483c43fa9d8f91c27be1b042f2b151187a867e85fd4cffc57f84b0a01c892583ef3f7d57ad6c816ad50668cabdfcb4e6c955db9c95aba8037ccf30c02eb0054
+  metadata.gz: 7d8698fea60f94b97246aecd1af2b51a2996871fdabc2aa0fab47c84dd764ac20c7b460cd3183d653777f11b8c403c36b2f6054f8d60baff65ca7e47f11fac9c
+  data.tar.gz: c740ad122d12eb555aae933c931cfab5dd2225057c4367cfae7f8abd1811601cafbf1e9a3987fdf0992a71d849c4d1f2d30d85bb6b078e6cb2a574e9a0ea336a

data/bin/canoe

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

data/lib/canoe.rb

@@ -1,23 +1,27 @@
-require_relative "workspace"
-require_relative "cmd"
-require_relative "source_files"
+require_relative 'workspace/workspace'
+require_relative 'cmd'
+require_relative 'source_files'
 
-class Canoe
-  def initialize
-    options = ['new', 
-               'add',
-               'build',
-               'generate',
-               'run',
-               'dep',
-               'clean',
-               'version',
-               'help',
-               'update']
-    @cmd = CmdParser.new options
-  end
+module Canoe
+  class Builder
+    def initialize
+      options = ['new',
+                 'add',
+                 'build',
+                 'generate',
+                 'make',
+                 'run',
+                 'dep',
+                 'clean',
+                 'version',
+                 'help',
+                 'update',
+                 'test']
+      @cmd = CmdParser.new options
+    end
 
-  def parse(args)
+    def parse(args)
       @cmd.parse args
+    end
   end
 end

data/lib/cmd.rb

@@ -1,114 +1,99 @@
-require_relative "workspace"
-require_relative "err"
-require_relative "config_reader"
+require_relative 'workspace/workspace'
+require_relative 'util'
+require_relative 'config_reader'
 
 ##
 # class CmdParser
 #   Parsing command arguments passed to canoe
-class CmdParser
-  include Err
-  def initialize(options)
-    @options = options 
-  end
+module Canoe
+  class CmdParser
+    include Err
+    include WorkSpaceUtil
 
-  def parse(args)
-    if args.size < 1 
-      abort_on_err "please give one command among #{@options.join(', ')}"
+    def initialize(options)
+      @options = options
     end
 
-    unless @options.include?(args[0])
-      abort_on_err "unknown command #{args[0]}"
+    def parse(args)
+      if args.size < 1
+        abort_on_err "please give one command among #{@options.join(", ")}"
+      end
+
+      unless @options.include?(args[0])
+        abort_on_err "unknown command #{args[0]}"
+      end
+
+      self.send "parse_#{args[0]}", args[1..]
     end
 
-    self.send "parse_#{args[0]}", args[1..]
-  end
+    private
+    def parse_new(args)
+      abort_on_err "not enough arguments to canoe new" if args.size < 1
+
+      name, mode = nil, "bin"
+      suffixes = ["cpp", "hpp"]
+
+      args.each do |arg|
+        case arg
+        when "--bin", "--lib"
+          mode = arg[2..]
+        when /--suffix=(\w+)\:(\w+)/
+          suffixes[0], suffixes[1] = $1, $2
+        else
+          name = arg unless name
+        end
+      end
 
-  private
-  def get_current_workspace
-    abort_on_err "not in a canoe workspace" unless File.exists? ".canoe"
-    config = ConfigReader.extract_flags("config.json")
+      abort_on_err('please give a name to this project') unless name
+      WorkSpace.new(name, mode.to_sym, suffixes[0], suffixes[1], true).new
+    end
 
-    src_sfx = config["source-suffix"] ? config["source-suffix"] : "cpp"
-    hdr_sfx = config["header-suffix"] ? config["header-suffix"] : "hpp"
+    def parse_add(args)
+      if args.size < 1
+        abort_on_err "it's not reasonable to add a component with no name given"
+      end
 
-    name = Dir.pwd.split("/")[-1]
-    mode = File.exists?("src/main.#{src_sfx}") ? :bin : :lib
+      get_current_workspace.add args
+    end
 
-    Dir.chdir('..') do
-      return WorkSpace.new(name, mode, src_sfx, hdr_sfx)
+    def parse_build(args)
+      get_current_workspace.build args
     end
-  end
 
-  def parse_new(args)
-    abort_on_err "not enough arguments to canoe new" if args.size < 1
-
-    name, mode = nil, "bin"
-    suffixes = ["cpp", "hpp"]
-    
-    args.each do |arg|
-      case arg
-      when '--bin', '--lib'
-        mode = arg[2..]
-      when /--suffix=(\w+)\:(\w+)/
-        suffixes[0], suffixes[1] = $1, $2
-      else
-        name = arg unless name
-      end
+    def parse_generate(args)
+      get_current_workspace.generate
     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
 
-  def parse_add(args)
-    if args.size < 1
-      abort_on_err "it's not reasonable to add a component with no name given"
+    def parse_run(args)
+      get_current_workspace.run args
     end
 
-    get_current_workspace.add args
-  end
-  
-  def parse_build(args)
-    get_current_workspace.build args
-  end
+    def parse_dep(args)
+      get_current_workspace.dep
+    end
 
-  def parse_generate(args)
-    get_current_workspace.generate
-  end
-  
-  def parse_run(args)
-    get_current_workspace.run args
-  end
+    def parse_clean(args)
+      get_current_workspace.clean args
+    end
 
-  def parse_dep(args)
-    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_test(args)
-    get_current_workspace.test args
-  end
+    def parse_version(args)
+      WorkSpace.version
+    end
 
-  def parse_version(args)
-    puts <<~VER
-        canoe v0.3.0
-        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
+    def parse_help(args)
+      WorkSpace.help
+    end
 
-  def parse_update(args)
-    get_current_workspace.update
+    def parse_update(args)
+      get_current_workspace.update
+    end
+
+    def parse_make(args)
+      get_current_workspace.make
+    end
   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,51 +1,49 @@
+require_relative 'util'
+
 ##
 # class Compiler
 #   Storing compiler name in String and flags as an array
-class Compiler
-  attr_reader :name, :flags
-  ##
-  # @name: String
-  # @flgs: Array of String
-  def initialize(name, flgs)
-    @name = name
-    @linking_flags = flgs.filter {|f| f.start_with? "-l"}
-    @compiling_flags = flgs - @linking_flags
-  end
-
-  def compiling_flags_as_str
-    @compiling_flags.join " "
-  end
-
-  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} #{compiling_flags_as_str} -c #{src}"
-    system "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
-  end
-
-  def link_executable(out, objs)
-    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)
-    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}"
+module Canoe
+  class Compiler
+    include SystemCommand
+
+    attr_reader :name, :flags
+
+    ##
+    # @name: String
+    # @flgs: Array of String
+    def initialize(name, compiling_flags, linking_flags)
+      @name = name
+      @linking_flags = linking_flags
+      @compiling_flags = compiling_flags
+    end
+
+    def compiling_flags_as_str
+      @compiling_flags.join ' '
+    end
+
+    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)
+      issue_command "#{name} -o #{out} #{compiling_flags_as_str} -c #{src}"
+    end
+
+    def link_executable(out, objs)
+      issue_command "#{name} -o #{out} #{objs.join(' ')} #{linking_flags_as_str}"
+    end
+
+    def link_shared(out, objs)
+      issue_command "#{name} -shared -o #{out}.so #{objs.join(' ')} #{linking_flags_as_str}"
+    end
   end
 end

data/lib/config_reader.rb

@@ -5,7 +5,7 @@ require 'json'
 #   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
+    abort_on_err("config file #{file} does not exsit") unless File.exist? file
     JSON.parse(File.read(file))
   end
 end

data/lib/default_files.rb

@@ -5,30 +5,35 @@
 class DefaultFiles
   class << self
     def open_file_and_write(filename, content)
-      File.open(filename, "w") {|f|
+      File.open(filename, 'w') do |f|
         f.write(content)
-      }
+      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++",
               "header-suffix": "#{hdr_sfx}",
               "source-suffix": "#{src_sfx}",
               "flags": {
-                  "opt": "-O2",
-                  "debug": "-g",
-                  "std": "-std=c++17"
+                  "compile": {
+                      "opt": "-O2",
+                      "debug": "-g",
+                      "std": "-std=c++17"
+                  },
+                  "link": {
+
+                  }
               }
           }
         CONFIG
       )
     end
 
-    def create_main(path, suffix='cpp')
+    def create_main(path, suffix = 'cpp')
       open_file_and_write(
         "#{path}/main.#{suffix}",
         <<~DOC
@@ -40,46 +45,34 @@ class DefaultFiles
       )
     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
           #ifndef __#{lib_name.upcase}__
           #define __#{lib_name.upcase}__
-         
+
           #endif
         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 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
           #ifndef __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
           #define __#{workspace.upcase}__#{prefix.upcase}__#{filename.upcase}__
-          
+
           #endif
         DOC
       )