taskloop 0.1.0

data/lib/taskloop/command/log.rb

@@ -0,0 +1,104 @@
+module TaskLoop
+  class Log < Command
+    self.abstract_command = false
+
+    self.summary = "Check log"
+
+    self.description = <<-DESC
+    The 'taskloop log' is used to check log. It supports two options to check different kinds of log. 
+    With '--task-name=TASK_NAME' option, you can check a specific task' log. 
+    With '--cron' option, you can check the cron log of taskloop.
+    DESC
+
+    def self.options
+      [
+        ['--task-name=TASK_NAME', "To show the log of a task specified by option."],
+        ['--cron', 'To show the log of taskloop, which is based on cron.'],
+      ].concat(super)
+    end
+
+    def initialize(argv)
+      @task_name = argv.option('task-name')
+      @cron = argv.flag?('cron', false)
+      super
+    end
+
+    def validate!
+      super
+      if @task_name && @cron
+        help! "The --task-name option and the --cron option cannot be used simultaneously."
+      end
+
+      if @task_name == nil && !@cron
+        help! "Use --task-name option or --cron option for 'taskloop log' command."
+      end
+    end
+
+    def run
+      super
+      if @task_name
+        check_log_of_task(@task_name)
+        return
+      end
+
+      if @cron
+        check_log_of_cron
+        return
+      end
+    end
+
+    def check_log_of_task(name)
+      found = false
+      data_proj_dirs = Dir.entries(taskloop_data_dir)
+      data_proj_dirs.each do |dir|
+        if dir == "." or dir == ".."
+          next
+        end
+        data_proj_dir = File.join(taskloop_data_dir, dir)
+
+        print_proj = false
+        log_files = Dir.entries(data_proj_dir)
+        log_files.each do |file|
+          if "#{name.sha1}_log" == file
+            found = true
+
+            if !print_proj
+              print_proj = true
+              desc_file_path = File.join(data_proj_dir, ".description")
+              puts "=============================".ansi.blue
+              File.open(desc_file_path).each_line do |line|
+                puts "Project of <#{line.strip}>".ansi.blue
+              end
+            end
+            # print
+            task_log_path = File.join(data_proj_dir, "#{name.sha1}_log")
+            puts "Log of <Task.name: #{name}> above: ".ansi.blue
+            File.open(task_log_path).each_line do |line|
+              puts line
+            end
+
+            puts "=============================".ansi.blue
+            puts ""
+          end
+        end
+      end
+
+      unless found
+        puts "Warning: log of <Task.name: #{name}> not exist. Please check if the name of task is correct.".ansi.yellow
+        puts ""
+      end
+    end
+
+    def check_log_of_cron
+      puts "=============================".ansi.blue
+      puts "Log of cron: ".ansi.blue
+      puts ""
+      log_file = File.open(taskloop_cron_log_path, "r")
+      log_file.each_line do |line|
+        puts line
+      end
+      puts "=============================".ansi.blue
+      puts ""
+    end
+  end
+end

data/lib/taskloop/command/run.rb

@@ -0,0 +1,106 @@
+module TaskLoop
+  class Run < Command
+    require_relative '../task/task'
+    require_relative '../rules/rule'
+    require_relative '../rules/interval_rule'
+    require_relative '../rules/scope_rule'
+    require_relative '../rules/default_rule'
+    require_relative '../rules/specific_rule'
+    require_relative '../rules/after_scope_rule'
+    require_relative '../rules/before_scope_rule'
+    require_relative '../rules/between_scope_rule'
+    require_relative '../rules/loop_rule'
+    require_relative '../rules/date_list_rule'
+    require_relative '../rules/time_list_rule'
+    require_relative '../extension/string_extension'
+    require_relative '../extension/integer_extension'
+    require_relative '../utils/proj_tasklist'
+    require_relative '../dsl/dsl'
+    require 'open3'
+
+    include TaskLoop::DSL
+    include TaskLoop::ProjTaskList
+
+    self.abstract_command = false
+
+    self.summary = "Execute all the registered tasks that meet their requirements."
+
+    self.description = <<-DESC
+    The `taskloop run` command will execute all the registered tasks that meet their requiremets.
+    Taskloop will read all the registered Taskfiles from `~/.taskloop/tasklist.json`, then execute
+    each Tasfile to figure out if there is any task need to be executed. If needed, they will be
+    executed.
+    DESC
+
+    #################################
+    # Utils Methods
+    #################################
+
+    def run
+      super
+      create_data_proj_dir_if_needed
+      create_data_proj_description_if_needed
+
+      construct_proj_tasklist_map
+      setup_task_property
+
+      create_data_proj_task_log_if_needed
+      create_data_proj_task_time_if_needed
+      create_data_proj_task_loop_if_needed
+
+      execute_tasks_if_needed
+      clean_cache_file_if_needed
+    end
+
+    private def execute_tasks_if_needed
+      unless @proj_tasklist_map != nil
+        return
+      end
+
+      puts "Trigger Time: <#{Time.now}>"
+      @proj_tasklist_map.each do |proj, list|
+        list.each do |task|
+          unless task.check_rule_conflict?
+            puts "Warning: There is a rule conflict in #{task.desc}, taskloop will skip its execution.".ansi.yellow
+            next
+          end
+          unless task.check_all_rules?
+            puts "Checking: #{task.desc} does not meet the execution rules, taskloop will skip its execution.".ansi.blue
+            next
+          end
+          puts "Checking: #{task.desc} does meet the execution rules, taskloop start to execute.".ansi.blue
+          execute_task(proj, task)
+        end
+      end
+    end
+
+    private def execute_task(proj, task)
+      path = task.path
+      unless path[0] == '/'
+        path = File.join(proj, path)
+      end
+
+      unless File.exists?(path)
+        errmsg = "No such file or directory - #{path}"
+        task.write_to_logfile(errmsg)
+        return
+      end
+
+      # record execute timestamp into task's timefile
+      timestamp = Time.now.to_i
+      task.write_to_timefile(timestamp)
+      count = task.loop_count + 1
+      task.write_to_loopfile(count)
+
+      cmd = path
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+        # record execute information into task's logfile
+        out = stdout.read
+        err = stderr.read
+        content = out + "\n" + err
+        content = "<Trigger Time: #{Time.now}>\n" + content
+        task.write_to_logfile(content)
+      end
+    end
+  end
+end

data/lib/taskloop/command/shutdown.rb

@@ -0,0 +1,49 @@
+module TaskLoop
+  class Shutdown < Command
+    self.abstract_command = false
+
+    self.summary = "Shutdown taskloop. "
+
+    self.description = <<-DESC
+    The `taskloop shutdown` command will shutdown taskloop. Therefore, every Taskfile registered in taskloop will stop. 
+    It is a global switch that controls taskloop. If you execute `taskloop launch` command again after executing 'taskloop shutdown',
+    every Taskfile you deployed before will resume automatically.
+    DESC
+    def run
+      super
+      unregister_taskloop_from_crontab_if_needed
+    end
+
+    def unregister_taskloop_from_crontab_if_needed
+      system("crontab -l > #{taskloop_cron_tab_path}")
+      registered = false
+      pattern = /\A\* \* \* \* \* sh ~\/\.tasklooprc/
+      remain = []
+      File.open(taskloop_cron_tab_path, "r").each_line do |line|
+        if line.match?(pattern)
+          registered = true
+        else
+          remain << line
+        end
+      end
+
+      unless registered
+        puts "Warning: taskloop has already shutdown. Please do not shutdown again.".ansi.yellow
+        puts "    If your want to launch taskloop, please execute the `taskloop launch` command.".ansi.yellow
+        return
+      end
+
+      File.open(taskloop_cron_tab_path, "w") do |file|
+        file.write(remain.join)
+      end
+
+      system("crontab #{taskloop_cron_tab_path}")
+
+      puts LOGO.ansi.blue
+      puts "    taskloop has shutdown successfully. ".ansi.blue
+      puts ""
+      puts "    byeeeeeeeeeeeeeeeee !".ansi.blue
+      puts ""
+    end
+  end
+end

data/lib/taskloop/command/undeploy.rb

@@ -0,0 +1,46 @@
+require 'fileutils'
+
+module TaskLoop
+  class Undeploy < Command
+    self.abstract_command = false
+
+    self.summary = "Undeploy a Taskfile from taskloop."
+
+    self.description = <<-DESC
+    The "taskloop undeploy" command will undeploy a Taskfile from taskloop. It should be executed in the directory where 
+    Taskfile exists.
+    DESC
+
+    def run
+      super
+      unless File.exists?(:Taskfile.to_s)
+        puts "Error: 'taskloop undeploy' command should be executed in the directory where Taskfile exists.".ansi.red
+        return
+      end
+
+      remove_proj_path_from_projlist
+    end
+
+    def remove_proj_path_from_projlist
+      current_dir = Dir.pwd
+      proj_list_dirs = taskloop_proj_list_dirs
+      unless proj_list_dirs.include?(current_dir)
+        puts "Warning: current Taskfile is not deployed before. Do not need to undeploy it again.".ansi.yellow
+        return
+      end
+      proj_list_dirs.delete(current_dir)
+      File.open(taskloop_proj_list_path, "w") do |file|
+        file.write(JSON.pretty_generate(proj_list_dirs))
+      end
+
+      data_proj_dir = File.join(taskloop_data_dir, current_dir.sha1_8bit)
+      unless File.directory?(data_proj_dir)
+        puts "Warning: #{data_proj_dir} not exist. ".ansi.yellow
+        return
+      end
+
+      FileUtils.rm_rf(data_proj_dir)
+      puts "Taskfile in <#{current_dir}> has been undeployed successfully.".ansi.blue
+    end
+  end
+end

data/lib/taskloop/command.rb

@@ -0,0 +1,168 @@
+module TaskLoop
+  require 'claide'
+
+  class Command < CLAide::Command
+    require 'digest'
+    require 'taskloop/extension/string_extension'
+    require 'taskloop/command/init'
+    require 'taskloop/command/list'
+    require 'taskloop/command/log'
+    require 'taskloop/command/deploy'
+    require 'taskloop/command/run'
+    require 'taskloop/command/launch'
+    require 'taskloop/command/shutdown'
+    require 'taskloop/command/env'
+    require 'taskloop/command/undeploy'
+
+    self.abstract_command = true
+
+    self.description = <<-DESC
+      Taskloop is a scheduled task manager based on cron. It offers a more clear syntax, more convenient log management. 
+      It also solves environment variable import issues, and provides a more user-friendly experience.'
+    DESC
+
+    self.command = 'taskloop'
+
+    def initialize(argv)
+      # @verbose = argv.flag?('verbose', true)
+      super
+    end
+
+    def run
+      create_taskloop_file_structure_if_needed
+    end
+
+    #################################
+    # Path and Directory and Files
+    #################################
+    def create_taskloop_file_structure_if_needed
+      # create ~/.taskloop/ dir
+      create_dir_if_needed(taskloop_dir)
+      # create ~/.taskloop/projlist file
+      unless File.exists?(taskloop_proj_list_path)
+        projlist = File.new(taskloop_proj_list_path, "w+")
+        projlist.puts "[]"
+        projlist.close
+      end
+
+      # create ~/.taskloop/crontab file
+      create_file_if_needed(taskloop_cron_tab_path)
+      # create ~/.taskloop/cronlog file
+      create_file_if_needed(taskloop_cron_log_path)
+
+      # create ~/.taskloop/data/ dir
+      create_dir_if_needed(taskloop_data_dir)
+    end
+
+    def create_file_if_needed(path)
+      unless File.file?(path)
+        File.new(path, "w")
+      end
+    end
+    def create_dir_if_needed(dir)
+      unless File.directory?(dir)
+        FileUtils.mkdir(dir)
+      end
+    end
+
+    def tasklooprc_path
+      File.join(Dir.home, ".tasklooprc")
+    end
+
+    def taskloop_dir
+      File.join(Dir.home, ".taskloop")
+    end
+
+    def taskloop_cron_log_path
+      File.join(taskloop_dir, "cronlog")
+    end
+
+    def taskloop_cron_tab_path
+      File.join(taskloop_dir, "crontab")
+    end
+
+    def taskloop_environments_path
+      File.join(taskloop_dir, "environments")
+    end
+
+    def taskloop_proj_list_path
+      File.join(taskloop_dir, "projlist")
+    end
+
+    def taskloop_data_dir
+      File.join(taskloop_dir, "data")
+    end
+
+    def taskloop_proj_list_dirs
+      json_string = File.read(taskloop_proj_list_path)
+      parsed_json = JSON.parse(json_string)
+      return parsed_json
+    end
+
+    def taskloop_data_proj_dirs
+      dirs = Dir.entries(taskloop_data_dir)
+      result = []
+      dirs.each do |dir|
+        if dir != '.' && dir != '..'
+          result.push(dir)
+        end
+      end
+      return result
+    end
+
+    def taskloop_taskfile_paths
+      paths = taskloop_data_proj_dirs
+      result = []
+      paths.each do |path|
+        result.push(File.join(path, ".Taskfile.deploy"))
+      end
+      return result
+    end
+
+    LOGO = <<-DESC
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@   @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@@@@@@@@          @@@@@@@@@@@@@@@@@@@@@@   @@@@@@@    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@@@@@@@@@@@    @@@@@@    @@@@@       @@@   @@   @@    @@@@@      @@@@      @@@       @@@@@@@@@
+@@@@@@@@@@@    @@@@   @@   @@   @@@   @@   @   @@@    @@@@   @@   @@   @@   @@   @@   @@@@@@@@
+@@@@@@@@@@@    @@@@@@@@@   @@@    @@@@@@      @@@@    @@@@   @@   @@   @@   @@   @@   @@@@@@@@
+@@@@@@@@@@@    @@@@        @@@@@@    @@@      @@@@    @@@@   @@   @@   @@   @@   @@   @@@@@@@@
+@@@@@@@@@@@    @@@   @@@   @@   @@@   @@   @   @@@    @@@@   @@   @@   @@   @@   @@   @@@@@@@@
+@@@@@@@@@@@    @@@@        @@@       @@@   @@   @@      @@@      @@@@      @@@       @@@@@@@@@
+@@@@@@@@@@@    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@   @@@@@@@@@@@@@
+@@@@@@@@@@@   @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+    DESC
+
+    DOLPHIN = <<-DESC
+
+                       (@&/////%@@@@@@@@@@@@@#                                  
+                          @@&@&////////////////(@@#                             
+                         /@(///////////////////////%@/                          
+                       *@////////////////////////////#@,                        
+                      @&///////////////////////////////@%                       
+                     @&//////////////(@////@&#/////////(@                       
+                     @////////////@@  @////@    ,.@////@@                       
+                    /@//////////&@  ,@@////@@@&.  *///@@                        
+                    ,@/////////(@@@   @///&@     /@@///@@                       
+                     @%////////@@     @@@&           @@/@#                      
+                      @#///////@           ,                                    
+                       @@//////@&      @(//@                                    
+                         @@/////%@    @////@                                    
+                            @@/////#@@@////@                                    
+                                &@@@&#((&@@                                     
+                          /&#         @///@@                                    
+                       ,///,*.        @////@                                    
+                   &#  %/,@           @@///@                                    
+                 (, .*/&*%/*%///&       (@@@         ,*/////*.                  
+           %/#@, ////&  @  % .&  /@%/(/    /#/#@(                 #@#/&         
+        (/&               .           .////,                           &//      
+       &(//@                         &//////&                         @///@     
+         (@%//////#&@@@@@@@@@@%///////@@  @@///////%@@@@@@@@@@&#//////#@#       
+                %@@@@&@@@@@&&@@@@/              /@@@@&&@@@@@&@@@@&
+    DESC
+  end
+
+end

data/lib/taskloop/dsl/dsl.rb

@@ -0,0 +1,63 @@
+module TaskLoop
+  module DSL
+
+    #################################
+    # Loop Syntax
+    #################################
+    def interval(interval)
+      IntervalRule.new(:unknown, interval)
+    end
+
+    #################################
+    # Specific Syntax
+    #################################
+    def at(value)
+      SpecificRule.new(:unknown, value)
+    end
+
+    #################################
+    # Scope Syntax
+    #################################
+    def before(right)
+      BeforeScopeRule.new(:unknown, :before, right)
+    end
+
+    def between(left, right)
+      BetweenScopeRule.new(:unknown, :between, left, right)
+    end
+
+    def after(left)
+      AfterScopeRule.new(:unknown, :after, left)
+    end
+
+    #################################
+    # Loop Syntax
+    #################################
+    def loop(count)
+      LoopRule.new(:unknown, count)
+    end
+
+    #################################
+    # Time List Syntax
+    #################################
+    def time(*args)
+      TimeListRule.new(:unknown, args)
+    end
+
+    #################################
+    # Date List Syntax
+    #################################
+    def date(*args)
+      DateListRule.new(:unknown, args)
+    end
+
+    #################################
+    # Env
+    #################################
+    def env(name, value)
+      ENV[name] = value
+    end
+
+
+  end
+end

data/lib/taskloop/extension/integer_extension.rb

@@ -0,0 +1,25 @@
+class Integer
+  def minute
+    self
+  end
+
+  def hour
+    self
+  end
+
+  def day
+    self
+  end
+
+  def month
+    self
+  end
+
+  def year
+    self
+  end
+
+  def times
+    self
+  end
+end

data/lib/taskloop/extension/string_extension.rb

@@ -0,0 +1,18 @@
+class String
+  require 'digest'
+
+  def sha1
+    sha1_digest = Digest::SHA1.new
+    sha1_digest.update(self)
+    return sha1_digest.hexdigest
+  end
+
+  def sha1_32bit
+    sha1[0..31]
+  end
+
+  def sha1_8bit
+    sha1[0..8]
+  end
+
+end

data/lib/taskloop/rules/after_scope_rule.rb

@@ -0,0 +1,91 @@
+module TaskLoop
+  class AfterScopeRule < ScopeRule
+
+    attr_accessor :left
+
+    def initialize(unit, scope, left)
+      super unit, scope
+      @left = left
+    end
+
+    def invalidate!
+      super
+      if @unit == :day
+        unless Task::WEEK.has_key?(@left) || Task::DAY.has_key?(@left)
+          raise ArgumentError, "#{left} must be a Symbol defined in Task::WEEK or Task::DAY"
+        end
+        return
+      end
+
+      if @unit == :month
+        unless Task::MONTH.has_key?(@left)
+          raise ArgumentError, "#{left} must be a Symbol defined in Task::MONTH"
+        end
+        return
+      end
+
+      unless @left.is_a?(Integer)
+        raise TypeError, "'left' need to be Symbol or Integer"
+      end
+
+      if @unit == :minute && (@left < 0 || @left > 59)
+        raise ArgumentError, "'right' for 'minute' must >= 0 and <= 59"
+      end
+
+      if @unit == :hour && (@left < 0 || @left > 23)
+        raise ArgumentError, "'right' for 'hour' must >= 0 and <= 23"
+      end
+    end
+
+
+    def left_value
+      if (Task::DAY.has_key?(@left))
+        return Task::DAY[@left]
+      end
+      if (Task::WEEK.has_key?(@left))
+        return Task::WEEK[@left]
+      end
+      if (Task::MONTH.has_key?(@left))
+        return Task::MONTH[@left]
+      end
+
+      unless @left != nil && @left.is_a?(Integer)
+        return -1
+      end
+
+      return @left
+    end
+
+    def is_week_value?
+      if @unit == :day && Task::WEEK.has_key?(@left)
+        return true
+      end
+      return false
+    end
+
+    def is_conform_rule?(last_exec_time)
+      current = Time.now
+      value = left_value
+      result = false
+      case @unit
+      when :year then
+        result = current.year > value
+      when :month then
+        result = current.month > value
+      when :day then
+        if is_week_value?
+          result = current.wday > (value % TaskLoop::WEEK_BASE)
+        else
+          result = current.day > value
+        end
+      when :hour then
+        result = current.hour > value
+      end
+      return result
+    end
+
+    def desc
+      super + " #{left}"
+    end
+  end
+end