cronv-rb 0.2.0

data/lib/cronv_rb/schedule.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CronvRb
+  class Schedule
+    attr_reader :minutes, :hour, :day_of_month, :month, :day_of_week, :year, :schedule_alias
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(minutes:, hour:, day_of_month:, month:, day_of_week:, year:, schedule_alias:)
+      @minutes = minutes
+      @hour = hour
+      @day_of_month = day_of_month
+      @month = month
+      @day_of_week = day_of_week
+      @year = year
+      @schedule_alias = schedule_alias
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def to_crontab
+      return @schedule_alias if @schedule_alias
+
+      "#{@minutes} #{@hour} #{@day_of_month} #{@month} #{@day_of_week} #{@year}"
+    end
+  end
+end

data/lib/cronv_rb/template.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'time'
+
+module CronvRb
+  # rubocop:disable Metrics/ClassLength
+  class Template
+    TEMPLATE = <<~ERB
+      <html>
+      <head>
+      <title><%= @v.option.title %> | <%= date_format(value: @v.time_from, format: "%Y/%-m/%-d %H:%M") %>, +<%= @v.option.duration %></title>
+      <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
+      </head>
+      <body>
+        <div class="container-fluid">
+          <h1>
+            <%= @v.option.title %>&nbsp;<small class="text-muted">From <%= date_format(value: @v.time_from, format: "%Y/%-m/%-d %H:%M") %>, +<%= @v.option.duration %></small>
+          </h1>
+
+          <br>
+
+          <% if @v.extras.any? %>
+            <h3>Extra</h3>
+            <div id="cronv-extra" style="width:<%= @v.option.width %>%;">
+              <dl class="row">
+                <% @v.extras.each do |extra| %>
+                  <dt class="col-sm-1"><%= extra.label %></dt>
+                  <dd class="col-sm-11"><%= extra.job %></dd>
+                <% end %>
+              </dl>
+            </div>
+            <hr>
+          <% end %>
+
+          <h3>Timeline</h3>
+          <div id="cronv-timeline" style="height:100%; width:<%= @v.option.width %>%;">
+            <b>Loading...</b>
+          </div>
+        </div>
+        <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
+        <script type="text/javascript">
+           google.charts.load("current", {packages:["timeline"]});
+           google.charts.setOnLoadCallback(function() {
+             var container = document.getElementById('cronv-timeline');
+             var chart = new google.visualization.Timeline(container);
+             var dataTable = new google.visualization.DataTable();
+              dataTable.addColumn({ type: 'string', id: 'job' });
+              dataTable.addColumn({ type: 'string', id: 'dummy bar label' });
+              dataTable.addColumn({ type: 'string', role: 'tooltip' });
+              dataTable.addColumn({ type: 'date', id: 'Start' });
+              dataTable.addColumn({ type: 'date', id: 'End' });
+
+              var tasks = {};
+              <%# time_from = @v.time_from %>
+              <%# time_to = @v.time_to %>
+              <% @v.records.each do |cronv| %>
+                <% job = js_escape_string(str: cronv.crontab.job) %>
+                tasks['<%= job %>'] = tasks['<%= job %>'] || [];
+                <% if running_every_minutes?(crontab: cronv.crontab) %>
+                  tasks['<%= job %>'].push(['<%= job %>', '', 'Every minutes <%= job %>', <%= new_js_date(value: @v.time_from) %>, <%= new_js_date(value: @v.time_to) %>]);
+                <% else %>
+                  <% cronv_iter(cronv:).each do |exec| %>tasks['<%= job %>'].push(['<%= job %>', '', '<%= date_format(value: exec[:start], format: "%H:%M") %> <%= job %>', <%= new_js_date(value: exec[:start]) %>, <%= new_js_date(value: exec[:end]) %>]);<% end %>
+                <% end %>
+              <% end %>
+
+              var taskByJobCount = [];
+              for (var k in tasks) taskByJobCount.push({name: k, size: tasks[k].length});
+              taskByJobCount.sort(function(a, b) {
+                if (a.size == b.size) return 0;
+                return a.size > b.size ? -1 : 1;
+              });
+
+              var rows = [];
+              for (var i = 0; i < taskByJobCount.length; i++) {
+                jobs = tasks[taskByJobCount[i].name];
+                var jl = jobs.length;
+                for (var j = 0; j < jl; j++) rows.push(jobs[j]);
+              }
+
+              if (rows.length > 0) {
+                dataTable.addRows(rows);
+                chart.draw(dataTable, {
+                  timeline: {
+                    colorByRowLabel: true
+                  },
+                  avoidOverlappingGridLines: false
+                });
+              } else {
+                container.innerHTML = '<div class="alert alert-success"><strong>Woops!</strong> There is no data!</div>';
+              }
+
+              var mousePosX = undefined,
+                  mousePosY = undefined;
+
+              google.visualization.events.addListener(chart, 'onmouseover', function(e) {
+                var t = document.getElementsByClassName("google-visualization-tooltip")[0];
+                if (mousePosX) t.style.left = mousePosX + 'px';
+                if (mousePosY) t.style.top = mousePosY - 120 + 'px';
+              });
+
+              document.addEventListener('mousemove', function(e) {
+                mousePosX = e.pageX;
+                mousePosY = e.pageY;
+              });
+           });
+
+        </script>
+      </body>
+      </html>
+    ERB
+
+    def self.render(visualizer:)
+      new(visualizer:).render
+    end
+
+    def render
+      ERB.new(TEMPLATE).result(binding)
+    end
+
+    private_class_method :new
+
+    private
+
+    def initialize(visualizer:)
+      @v = visualizer
+    end
+
+    def cronv_iter(cronv:)
+      cronv.iter
+    end
+
+    def js_escape_string(str:)
+      str.gsub(/['"\\]/) { |char| "\\#{char}" }.gsub("\n", '\\n').gsub("\r", '\\r')
+    end
+
+    def new_js_date(value:)
+      time = value.is_a?(String) ? Time.parse(value) : value
+      format('new Date(%<year>d, %<month>d, %<day>d, %<hour>d, %<min>d)', year: time.year, month: time.month - 1, day: time.day, hour: time.hour, min: time.min)
+    end
+
+    def date_format(value:, format:)
+      time = value.is_a?(String) ? Time.parse(value) : value
+      time.strftime(format)
+    end
+
+    def running_every_minutes?(crontab:)
+      crontab.running_every_minutes?(crontab.schedule)
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/cronv_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CronvRb
+  VERSION = '0.2.0'
+end

data/lib/cronv_rb/visualizer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'time'
+
+module CronvRb
+  class Visualizer
+    attr_reader :option, :time_from, :time_to, :duration_minutes, :records, :extras
+
+    class << self
+      def new_visualizer(option)
+        time_from = option.to_from_time
+        duration_minutes = option.to_duration_minutes
+        time_to = time_from + duration_minutes * 60
+
+        new(option, time_from, time_to, duration_minutes)
+      end
+    end
+
+    def add(line)
+      trimmed = line.strip
+
+      return [false, nil] if trimmed.empty? || trimmed.start_with?('#')
+
+      begin
+        record, extra = Record.new_record(line: trimmed, start_time: @time_from, duration_minutes: @duration_minutes)
+      rescue ArgumentError => e
+        warn "[WARN] Skipping invalid crontab line: '#{trimmed}' (#{e.message})"
+        return [false, nil]
+      end
+
+      @records.push(record) unless record.nil?
+      @extras.push(extra) unless extra.nil?
+
+      [true, nil]
+    end
+
+    def dump
+      File.write(@option.output_file_path, Template.render(visualizer: self))
+      @option.output_file_path
+    end
+
+    private
+
+    def initialize(option, time_from, time_to, duration_minutes)
+      @option = option
+      @time_from = time_from
+      @time_to = time_to
+      @duration_minutes = duration_minutes
+      @records = []
+      @extras = []
+    end
+  end
+end

data/lib/cronv_rb.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'cronv_rb', '*.rb')].each do |file|
+  require "cronv_rb/#{File.basename(file, '.rb')}"
+end
+
+ENV['TZ'] = 'UTC'
+
+module CronvRb
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/release-please-config.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "version-file": "lib/cronv_rb/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": false,
+      "include-component-in-tag": false,
+      "changelog-sections": [
+        { "type": "feat", "section": "Features" },
+        { "type": "fix", "section": "Bug Fixes" },
+        { "type": "perf", "section": "Performance Improvements" },
+        { "type": "docs", "section": "Documentation", "hidden": true },
+        { "type": "refactor", "section": "Code Refactoring", "hidden": true },
+        { "type": "chore", "section": "Miscellaneous", "hidden": true }
+      ]
+    }
+  }
+}

data/renovate.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended"],
+  "semanticCommits": "enabled",
+  "semanticCommitType": "fix",
+  "semanticCommitScope": "deps",
+  "labels": ["dependencies"],
+  "addLabels": ["renovate"],
+  "schedule": ["every weekend"],
+  "prConcurrentLimit": 5,
+  "platformAutomerge": false,
+  "osvVulnerabilityAlerts": true,
+  "vulnerabilityAlerts": {
+    "enabled": true,
+    "labels": ["dependencies", "security"],
+    "automerge": true,
+    "schedule": ["at any time"]
+  },
+  "packageRules": [
+    {
+      "description": "Terraform (github-repo-management) owns these distributed workflow files; Renovate must not edit them or it fights Terraform over the same content.",
+      "matchFileNames": [
+        ".github/workflows/ai-triage.yml",
+        ".github/workflows/ai-fix.yml",
+        ".github/workflows/ai-review.yml",
+        ".github/workflows/auto-merge.yml",
+        ".github/workflows/codeql.yml",
+        ".github/workflows/digest.yml",
+        ".github/workflows/drift.yml"
+      ],
+      "enabled": false
+    },
+    {
+      "matchUpdateTypes": ["patch", "minor"],
+      "automerge": true
+    },
+    {
+      "matchUpdateTypes": ["major"],
+      "automerge": false,
+      "labels": ["dependencies", "major-update"]
+    }
+  ]
+}

data/scripts/compare_cronv_outputs.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Compares the HTML outputs of OSS cronv (Go) and cronv-rb (Ruby) to verify
+# that job names and color/time ranges match.
+#
+# Usage:
+#   ruby scripts/compare_cronv_outputs.rb <oss_cronv.html> <cronvrb.html>
+
+def usage
+  "Usage: #{$PROGRAM_NAME} <oss_cronv.html> <cronvrb.html>"
+end
+
+abort usage if ARGV.length != 2
+
+oss_path, rb_path = ARGV
+
+abort "File not found: #{oss_path}" unless File.exist?(oss_path)
+abort "File not found: #{rb_path}" unless File.exist?(rb_path)
+
+# Parse the "Extra" section (e.g. @reboot entries) from the HTML.
+# Returns an array of { label:, job: } hashes.
+def parse_extras(html)
+  extras = []
+  html.scan(%r{<dt[^>]*>(.*?)</dt>\s*<dd[^>]*>(.*?)</dd>}m) do |label, command|
+    extras << { label: label.strip, job: command.strip }
+  end
+  extras
+end
+
+# Normalize a new Date(...) string by removing all spaces after commas/parens
+# so that "new Date(2025, 0, 1, 0, 5)" == "new Date(2025,0,1,0,5)".
+def normalize_date(str)
+  str.gsub(/\s+/, '')
+end
+
+# Parse all job names that are initialized in the JS block (tasks['job'] = ...).
+# Returns a Set of job name strings.
+def parse_all_job_names(html)
+  jobs = Set.new
+  html.scan(/tasks\['(.+?)'\]\s*=\s*tasks\[/) { |m| jobs << m[0] }
+  jobs
+end
+
+# Parse timeline task entries from the JS block in the HTML.
+# Returns a hash: { job_name => [{start:, end:}, ...] }
+def parse_timeline(html)
+  timeline = Hash.new { |h, k| h[k] = [] }
+
+  html.scan(/tasks\['(.+?)'\]\.push\(\['(?:.+?)', '', '(?:.+?)', (new Date\(.+?\)), (new Date\(.+?\))\]\);/) do |job, start_date, end_date|
+    timeline[job] << { start: normalize_date(start_date), end: normalize_date(end_date) }
+  end
+
+  timeline
+end
+
+puts 'Comparing:'
+puts "  OSS cronv : #{oss_path}"
+puts "  cronv-rb  : #{rb_path}"
+puts
+
+oss_html = File.read(oss_path)
+rb_html  = File.read(rb_path)
+
+errors = []
+
+# ── 1. Compare Extras (e.g. @reboot) ─────────────────────────────────────────
+oss_extras = parse_extras(oss_html)
+rb_extras  = parse_extras(rb_html)
+
+if oss_extras != rb_extras
+  errors << 'Extra section mismatch:'
+  errors << "  OSS cronv : #{oss_extras.inspect}"
+  errors << "  cronv-rb  : #{rb_extras.inspect}"
+else
+  puts "[OK] Extras match (#{oss_extras.size} entries)"
+end
+
+# ── 2. Compare full job name set (including jobs with no executions) ───────────
+oss_all_jobs = parse_all_job_names(oss_html)
+rb_all_jobs  = parse_all_job_names(rb_html)
+
+only_in_oss_all = oss_all_jobs - rb_all_jobs
+only_in_rb_all  = rb_all_jobs  - oss_all_jobs
+
+if only_in_oss_all.any?
+  errors << 'Jobs present in OSS cronv but missing from cronv-rb:'
+  only_in_oss_all.sort.each { |j| errors << "  - #{j}" }
+end
+
+if only_in_rb_all.any?
+  errors << 'Jobs present in cronv-rb but missing from OSS cronv:'
+  only_in_rb_all.sort.each { |j| errors << "  - #{j}" }
+end
+
+puts "[OK] Job names match (#{oss_all_jobs.size} jobs)" if only_in_oss_all.empty? && only_in_rb_all.empty?
+
+# ── 3. Compare time ranges for jobs that have executions ─────────────────────
+oss_timeline = parse_timeline(oss_html)
+rb_timeline  = parse_timeline(rb_html)
+
+common_jobs = oss_all_jobs & rb_all_jobs
+range_errors = []
+
+common_jobs.sort.each do |job|
+  oss_entries = oss_timeline[job].sort_by { |e| e[:start] }
+  rb_entries  = rb_timeline[job].sort_by  { |e| e[:start] }
+
+  next if oss_entries == rb_entries
+
+  range_errors << "  Job: #{job}"
+  range_errors << "    OSS cronv count : #{oss_entries.size}"
+  range_errors << "    cronv-rb  count : #{rb_entries.size}"
+
+  # Show up to 3 differing entries
+  diffs = oss_entries.zip(rb_entries).reject { |a, b| a == b }.first(3)
+  diffs.each_with_index do |(oss_e, rb_e), i|
+    range_errors << "    Diff ##{i + 1}:"
+    range_errors << "      OSS: #{oss_e.inspect}"
+    range_errors << "      RB : #{rb_e.inspect}"
+  end
+end
+
+if range_errors.empty?
+  puts "[OK] Time ranges match for all #{common_jobs.size} jobs"
+else
+  errors << 'Time range mismatches:'
+  errors.concat(range_errors)
+end
+
+# ── Result ────────────────────────────────────────────────────────────────────
+puts
+if errors.empty?
+  puts 'All checks passed. cronv-rb output matches OSS cronv.'
+  exit 0
+else
+  puts 'FAILED: Differences found between OSS cronv and cronv-rb:'
+  errors.each { |e| puts e }
+  exit 1
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: cronv-rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Masato Yamashita
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem that rewrites cronv, originally written in Go, in Ruby to visualize
+  your cron schedules in crontab.
+email:
+- 4653960+M-Yamashita01@users.noreply.github.com
+executables:
+- cronv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ai-fix.yml"
+- ".github/workflows/ai-review.yml"
+- ".github/workflows/ai-triage.yml"
+- ".github/workflows/auto-merge.yml"
+- ".github/workflows/codeql.yml"
+- ".github/workflows/compare_cronv_outputs.yml"
+- ".github/workflows/release-please.yml"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
+- ".gitignore"
+- ".release-please-manifest.json"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cronv-rb.gemspec
+- docs/release.md
+- exe/cronv
+- fixtures/sample.crontab
+- lib/cronv_rb.rb
+- lib/cronv_rb/crontab.rb
+- lib/cronv_rb/logger.rb
+- lib/cronv_rb/main.rb
+- lib/cronv_rb/option.rb
+- lib/cronv_rb/record.rb
+- lib/cronv_rb/schedule.rb
+- lib/cronv_rb/template.rb
+- lib/cronv_rb/version.rb
+- lib/cronv_rb/visualizer.rb
+- release-please-config.json
+- renovate.json
+- scripts/compare_cronv_outputs.rb
+homepage: https://github.com/M-Yamashita01/cronv-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/M-Yamashita01/cronv-rb
+  source_code_uri: https://github.com/M-Yamashita01/cronv-rb
+  changelog_uri: https://github.com/M-Yamashita01/cronv-rb
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Visualize your cron schedules in crontab by Ruby
+test_files: []