taskloop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6395f4580c66f3deef3ec7a0a6103083b7d1b3a608c68cc0b878ad0a496c0116
+  data.tar.gz: 8775908ba3ac44c34dd23435e5159e52fab16d7901ff970d0a3d2af7ccc3e8d4
+SHA512:
+  metadata.gz: d2e8aa350458c9d9538cc339fbfd93f820fc3abdfcc4d905178d757805d9cafda6042c5049b12033ca84814fcd1f8d2111bc890c23de5b8785fb180553980dd2
+  data.tar.gz: fc4513b7568acc4789af5b39d73b31b28039bae7885b9ff70c838fc00f810fc9d501eba9041c540026da02224c8ba3763988d9fa7f39d8dc9157eb0ec0dc771e

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.6.5 [yp]" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/taskloop.iml" filepath="$PROJECT_DIR$/.idea/taskloop.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/taskloop.iml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.17.3, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="claide (v1.0.3, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.12.0, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.12.2, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.12.3, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.12.5, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.12.1, RVM: ruby-2.6.5 [yp]) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build taskloop-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install taskloop-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install taskloop-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push taskloop-0.1.0.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in taskloop.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    taskloop (0.1.0)
+      claide (~> 1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    claide (1.0.3)
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  taskloop!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,31 @@
+![](https://chuquan-public-r-001.oss-cn-shanghai.aliyuncs.com/sketch-images/taskloop-logo-white.png)
+
+# Taskloop
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/taskloop`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add taskloop
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install taskloop
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/taskloop.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/taskloop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/taskloop"
+
+TaskLoop::Command.run(ARGV)
+# TaskLoop::Command.run(["init"])
+# TaskLoop::Command.run(["list"])
+# TaskLoop::Command.run(["log", "--task-name=chuquan"])
+# TaskLoop::Command.run(["log", "--cron"])
+# TaskLoop::Command.run(["launch"])
+# TaskLoop::Command.run(["env", "--remove=NOX_TEMPALTES,NOX_HOME"])
+# TaskLoop::Command.run(["env", "--global-list"])
+# TaskLoop::Command.run(["env", "--import=PATH,RUBY_VERSION,GEM_PATH,GEM_HOME,IRBRC,NOX_ROOT,NOX_HOME,NOX_COMMON,NOX_SCRIPTS,NOX_CONFIG,NOX_TEMPALTES"])
+# TaskLoop::Command.run(["shutdown"])
+# TaskLoop::Command.run(["run"])
+# TaskLoop::Command.run(["deploy"])

data/lib/taskloop/command/deploy.rb

@@ -0,0 +1,136 @@
+
+module TaskLoop
+  class Deploy < 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 '../dsl/dsl'
+    require 'json'
+
+    include TaskLoop::DSL
+
+    self.abstract_command = false
+
+    self.summary = "Deploy a Taskfile into taskloop."
+
+    self.description = <<-DESC
+      The `taskloop deploy` command will deploy a Taskfile into taskloop.
+      Taskloop will record the path of a Taskfile into ~/.taskloop/tasklist.json.
+    DESC
+
+    attr_writer :tasklist
+
+    def tasklist
+      @tasklist ||= []
+    end
+
+    def run
+      super
+      # check if Taskfile exist
+      unless  File.file?(:Taskfile.to_s)
+        puts "Error:".ansi.red
+        puts "    Taskfile is not exist. Please goto the project's root directory and execute again, or run `taskloop init` command first if current directory is the root directory of a project.".ansi.red
+        exit 1
+      end
+
+      register_taskfile_dir_if_needed
+      unless deploy_lint?
+        puts "Taskfile deploy failed. Please check Taskfile again.".ansi.red
+        exit 1
+      end
+
+      generate_taskfile_deploy
+
+      clean_loopfile_if_needed
+    end
+
+    #################################
+    # Register taskfile dir if needed
+    #################################
+    private def register_taskfile_dir_if_needed
+      json_string = File.read(taskloop_proj_list_path)
+      parsed_json = JSON.parse(json_string)
+      # check if all the registered path
+      push_taskfile_dir_if_needed(parsed_json)
+    end
+
+    private def push_taskfile_dir_if_needed(parsed_json)
+      proj_dir = Dir.pwd
+      duplicate = parsed_json.select { |path| path == proj_dir }
+      if duplicate.empty?
+        puts "First time to deploy current Taskfile.".ansi.blue
+        puts "Register Taskfile into taskloop.".ansi.blue
+        parsed_json.push(proj_dir)
+
+        File.open(taskloop_proj_list_path, 'w') do |file|
+          file.write(JSON.pretty_generate(parsed_json))
+        end
+      end
+    end
+
+    #################################
+    # Deploy lint
+    #################################
+    private def deploy_lint?
+      taskfile_path = Dir.pwd + "/Taskfile"
+
+      eval_taskfile(taskfile_path)
+
+      results = []
+      lint_msgs = []
+      for task in TaskLoop::Task::tasklist
+        results.push(task.deploy_lint?)
+      end
+      return !results.include?(false)
+    end
+
+    private def eval_taskfile(path)
+      string = File.open(path, 'r:utf-8', &:read)
+      if string.respond_to?(:encoding) && string.encoding.name != 'UTF-8'
+        string.encode!('UTF-8')
+      end
+      eval(string)
+    rescue Exception => e
+      raise TaskfileDeployError, "Error: Taskfile eval failed. Please check Taskfile again. #{e.message}"
+    end
+
+    #################################
+    # Generate Taskfile.lock
+    #################################
+
+    private def generate_taskfile_deploy
+      data_proj_dir = File.join(taskloop_data_dir, Dir.pwd.sha1_8bit)
+      create_dir_if_needed(data_proj_dir)
+      deploy_path = File.join(data_proj_dir, ".Taskfile.deploy")
+
+      FileUtils.copy_file("Taskfile", deploy_path)
+      puts DOLPHIN.ansi.blue
+      puts "                              Taskfile deploy success!".ansi.blue
+    end
+
+    #################################
+    # Clean loopfile
+    #################################
+    private def clean_loopfile_if_needed
+      data_proj_dir = File.join(taskloop_data_dir, Dir.pwd.sha1_8bit)
+      TaskLoop::Task::tasklist.each do |task|
+        loopfile_path = File.join(data_proj_dir, task.loopfile_name)
+        if File.exists?(loopfile_path)
+          File.delete(loopfile_path)
+        end
+      end
+    end
+
+  end
+end

data/lib/taskloop/command/env.rb

@@ -0,0 +1,134 @@
+module TaskLoop
+  class Env < Command
+    self.abstract_command = false
+
+    self.summary = "To import one or more global environment variables into taskloop."
+
+    self.description = <<-DESC
+      The `taskloop env` command can be used to deal with global environment variable related operations. 
+      For example, you can export environment variables into taskloop with `--global-export=VAR1,VAR2...` options.
+      Beside, you can list all the global environment variables exported in taskloop.
+      All above operations are based on ~/.taskloop/environments file. If you want more details about global environment
+      variables, check and edit ~/.taskloop/environments by yourself.
+    DESC
+
+    def self.options
+      [
+        ['--global-import=VAR1,VAR2...', 'Import one or more global environment variables into taskloop.'],
+        ["--global-remove=VAR1,VAR2...", 'Remove one or more global environment variables from taskloop.']
+      ].concat(super)
+    end
+
+    def initialize(argv)
+      @import = argv.option('global-import')
+      @remove = argv.option('global-remove')
+      super
+    end
+
+    def run
+      super
+      if @import == nil && @remove == nil
+        list_environment_variables
+        return
+      end
+
+      if @import
+        import_environment_variables
+      end
+
+      if @remove
+        remove_environment_variables
+      end
+    end
+
+    def validate!
+      super
+      if @export && @list
+        help! "The --global-export option and the --global-list option cannot be used simultaneously."
+      end
+      if @remove && @list
+        help! "The --global-remove option and the --global-list option cannot be used simultaneously."
+      end
+    end
+
+    def import_environment_variables
+      env_list = @import.split(',')
+      unless env_list.length > 0
+        puts "Warning: the global environment variables you import is empty. Please check the option arguments again.".ansi.yellow
+        return
+      end
+      env_file = File.open(taskloop_environments_path, "a")
+      env_list.each do |var|
+        puts "importing #{var} ...".ansi.blue
+        puts "    #{var}=#{ENV[var]}".ansi.blue
+        env_file.puts "export #{var}=#{ENV[var]}"
+      end
+      puts ""
+      puts "import global environment variables complete.".ansi.blue
+      env_file.close
+    end
+
+    def remove_environment_variables
+      env_list = @remove.split(',')
+      unless env_list.length > 0
+        puts "Warning: the global environment variables you import is empty. Please check the option arguments again.".ansi.yellow
+        return
+      end
+
+      file_content = []
+      File.open(taskloop_environments_path, "r") do |file|
+        file.each_line do |line|
+          name = get_environment_variable_from_line(line)
+          unless env_list.include?(name)
+            file_content.push(line)
+          end
+        end
+      end
+
+      File.open(taskloop_environments_path, "w") do |file|
+        file_content.each do |line|
+          file.puts line
+        end
+      end
+      puts "remove global environment variables complete.".ansi.blue
+    end
+
+    def list_environment_variables
+      env_list = {}
+      env_file = File.open(taskloop_environments_path, "r")
+      pattern = /\Aexport /
+      env_file.each_line do |line|
+        if line.match(pattern)
+          left = line.index(" ")
+          right = line.index("=")
+          if left && right
+            name = line[left+1..right-1]
+            value = line[left+1..-1]
+            env_list[name] = value
+          end
+        end
+      end
+      if env_list.empty?
+        puts "Warning: no global environment variable imported in taskloop.".ansi.blue
+        return
+      end
+      puts "There are the global environments variables imported in taskloop:".ansi.blue
+      env_list.each do |k, v|
+        puts v
+      end
+    end
+
+    private def get_environment_variable_from_line(line)
+      pattern = /\Aexport /
+      result = nil
+      if line.match(pattern)
+        left = line.index(" ")
+        right = line.index("=")
+        if left && right
+          result = line[left+1..right-1]
+        end
+      end
+      return result
+    end
+  end
+end

data/lib/taskloop/command/init.rb

@@ -0,0 +1,42 @@
+module TaskLoop
+  class Init < Command
+    self.abstract_command = false
+
+    self.summary = "Setup a project to support taskloop."
+
+    self.description = <<-DESC
+      The `taskloop init` command will create a file named Taskfile in the current directory.
+      You can modify Taskfile to customize the execution rules for each scheduled task.
+      Attention! You should execute this command in the root directory of your project.
+    DESC
+
+    def run
+      super
+      # check if Taskfile exist in current directory
+      if File.exists?(:Taskfile.to_s)
+        puts "Warning: Taskfile exists! There is no need to execute `taskloop init` command in current directory!".ansi.yellow
+        puts ""
+        return
+      end
+
+      file = File.new(:Taskfile.to_s, "w+")
+      content = <<-DESC
+# env to set environment variables which are shared by all tasks defined in the Taskfile. <Optional>
+# env "ENV_NAME", "ENV_VALUE" 
+
+TaskLoop::Task.new do |t|
+  t.name = 'TODO: task name. <Required>'
+  t.path = 'TODO: task job path. For exmaple, t.path = "./Job.sh". <Required>'
+  t.year = "TODO: year rule. <Optional>"
+  t.month = "TODO: month rule. <Optional>"
+  t.day = "TODO: day rule. <Optional>"
+  t.hour = "TODO: hour rule. <Optional>"
+  t.minute = "TODO: minute rule. <Optional>"
+  t.loop = "TODO: loop count. <Optional>"
+end
+      DESC
+      file.puts content
+      file.close
+    end
+  end
+end

data/lib/taskloop/command/launch.rb

@@ -0,0 +1,67 @@
+module TaskLoop
+  class Launch < Command
+    self.abstract_command = false
+
+    self.summary = "Launch taskloop in order to run all the tasks which conform their rules."
+
+    self.description = <<-DESC
+    The `taskloop launch` command will register a schedule job into to crontab which is * * * * * sh ~/.tasklooprc.
+    Taskloop which check all the tasks every minute. If a task met its rule, execute it.
+    DESC
+    def run
+      super
+      create_environments_file_if_needed
+      create_tasklooprc_file_if_needed
+      register_taskloop_into_crontab_if_needed
+    end
+
+    def create_environments_file_if_needed
+      unless File.exists?(taskloop_environments_path)
+        env_file = File.new(taskloop_environments_path, "w+")
+        variables = ["PATH", "RUBY_VERSION", "GEM_PATH", "GEM_HOME", "IRBRC"]
+        variables.each do |var|
+          env_file.puts "export " + var + "=#{ENV[var]}"
+        end
+        env_file.close
+      end
+    end
+
+    def create_tasklooprc_file_if_needed
+      unless File.exists?(tasklooprc_path)
+        rc = File.new(tasklooprc_path, "w+")
+        rc.puts "source ~/.taskloop/environments"
+        rc.puts "taskloop run > ~/.taskloop/cronlog 2>&1"
+        rc.close
+      end
+    end
+
+    def register_taskloop_into_crontab_if_needed
+      # TODO: @baocq 考虑 crontab 为空的情况
+      system("crontab -l > #{taskloop_cron_tab_path}")
+      registered = false
+      pattern = /\A\* \* \* \* \* sh ~\/\.tasklooprc/
+      File.open(taskloop_cron_tab_path, "r").each_line do |line|
+        if line.match?(pattern)
+          registered = true
+          break
+        end
+      end
+
+      if registered
+        puts "Warning: taskloop has already launched. Please do not launch again.".ansi.yellow
+        puts "    If your want to shutdown taskloop, please execute the `taskloop shutdown` command.".ansi.yellow
+        return
+      end
+
+      File.open(taskloop_cron_tab_path, "a") do |file|
+        file.puts "* * * * * sh ~/.tasklooprc"
+      end
+
+      system("crontab #{taskloop_cron_tab_path}")
+
+      puts LOGO.ansi.blue
+      puts "    taskloop has launched successfully. ".ansi.blue
+      puts ""
+    end
+  end
+end

data/lib/taskloop/command/list.rb

@@ -0,0 +1,59 @@
+require_relative '../utils/proj_tasklist'
+require_relative '../dsl/dsl'
+
+module TaskLoop
+  class List < Command
+    include TaskLoop::DSL
+    include TaskLoop::ProjTaskList
+
+    self.abstract_command = false
+
+    self.summary = "List current running tasks in taskloop."
+
+    self.description = <<-DESC
+      The 'taskloop list' command will list all the running tasks in taskloop.
+    DESC
+
+    attr_reader :proj_tasklist_map
+
+    def proj_tasklist_map
+      @proj_tasklist_map ||= {}
+    end
+
+    def run
+      super
+      create_data_proj_dir_if_needed
+      create_data_proj_description_if_needed
+
+      construct_proj_tasklist_map
+      setup_task_property
+
+      show_proj_tasklist_info
+    end
+
+    def show_proj_tasklist_info
+      unless @proj_tasklist_map != nil && !@proj_tasklist_map.empty?
+        puts "Warning: there is no task in taskloop.".ansi.yellow
+        return
+      end
+      @proj_tasklist_map.each do |proj, list|
+        unless list.length > 0
+          next
+        end
+        puts "=============================".ansi.blue
+        puts "Tasks above are defined in Taskfile of <#{proj}>".ansi.blue
+        list.each do |task|
+          puts "  #{task.desc}".ansi.blue
+          puts "    t.name   = #{task.name}".ansi.blue
+          puts "    t.path   = #{task.path}".ansi.blue
+          puts "    t.year   = #{task.year.desc}".ansi.blue
+          puts "    t.month  = #{task.month.desc}".ansi.blue
+          puts "    t.day    = #{task.day.desc}".ansi.blue
+          puts "    t.hour   = #{task.hour.desc}".ansi.blue
+          puts "    t.minute = #{task.minute.desc}".ansi.blue
+          puts "    t.loop   = #{task.loop.desc}".ansi.blue
+        end
+      end
+    end
+  end
+end