tab_keeper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29235a8d42173d34b28beb02ec01bb82285aa12c
-  data.tar.gz: c3978f99e2fcc255ff2d7f68590e46e162a6c498
+  metadata.gz: a8ba88f83d4c927a0292c8b47f8f2d2141de23b0
+  data.tar.gz: 837513550403d5cd3be0f680bad666396394323b
 SHA512:
-  metadata.gz: 59272e872de28887507c2ec2a7712695d2a442e0d788c96a05327eadb5d8f1aff727e41c4c4ed9179780cea7fcf2507aa41fdf303a7276e3327a0c0c3d7ad415
-  data.tar.gz: f92e98d7503c162a0679a145c38e1d39e566137d4b7beb43bf7b164d6522f97053002c6ee6dbffc98a12f267690626b11930bf8ba656f476c4dbadf04ef46338
+  metadata.gz: 2cb9a5365b000ab3a1f74fe75365f441ac494b0fa15478c297007370c59a2d4eac0a0981d5a19578a498e6cf047199e80523f34f4b7b550e08d229e1c2328001
+  data.tar.gz: bb7ce75b083aab8e8ee56e09ff1a48cca4a1156ab3a9a943a8493dc2c928c087fe1c06f14ec7a2d48cbd471200d6686d97355a940547aef75e9a18fbb25d2174

data/lib/tab_keeper/generator.rb

@@ -5,11 +5,34 @@ module TabKeeper
     end
 
     def generate(job_list, **options)
+      rows = rows(job_list, **options)
+      validate_rows!(rows)
+      rows.join("\n\n") + "\n"
+    end
+
+    private
+
+    def validate_rows!(rows)
+      too_long_rows = rows.reject { |row| row.length < 900 }
+      return unless too_long_rows.any?
+      raise "The following rows are too long for a cron file, and may be truncated:\n" \
+            "#{too_long_rows.join("\n\n")}"
+    end
+
+    def rows(job_list, **options)
       job_list.map do |job, timing|
-        timing + " " + @pipeline.reduce(nil) do |previous, pipe|
-          pipe.new(previous, job: job, timing: timing, **options).to_s
-        end
-      end.join("\n\n") + "\n"
+        timing + " " + cron_escape(apply_pipeline(job, timing, **options))
+      end
+    end
+
+    def apply_pipeline(job, timing, **options)
+      @pipeline.reduce(nil) do |previous, pipe|
+        pipe.new(previous, job: job, timing: timing, **options).to_s
+      end
+    end
+
+    def cron_escape(input)
+      input.chars.map { |char| char == '%' ? "\\%" : char }.join
     end
   end
 end

data/lib/tab_keeper/log_redirection.rb

@@ -20,7 +20,7 @@ module TabKeeper
       # Normalise the job name: if it's an array take the first thing, then get the last
       # thing after a "::" (if it's a class name), or a "/" (if it's a script, and removes
       # the need to escape yay)
-      job_name = Array(@job).first.to_s.split(/((::)|\/)/).last
+      job_name = Array(@job).first.to_s.split(/((::)|\/)/).last.split(/[^\w\d]/).first
       @job_name = job_name_proc.call(job_name)
       @timing = timing
       @log_directory = log_directory
@@ -60,7 +60,7 @@ module TabKeeper
         hour_component,
         min_component,
         second_component
-      ].compact.join('-').chars.map { |char| char == '%' ? '\%' : char }.join
+      ].compact.join('-')
     end
 
     def day_component
@@ -72,7 +72,7 @@ module TabKeeper
     end
 
     def min_component
-      '%m' if more_than_once_a_day?
+      '%M' if more_than_once_a_day?
     end
 
     def second_component

data/lib/tab_keeper/version.rb

@@ -1,3 +1,3 @@
 module TabKeeper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/tab_keeper/generator_spec.rb

@@ -10,25 +10,39 @@ RSpec.describe TabKeeper::Generator do
     end.to_a
   end
 
-  let(:pipeline) { [TabKeeper::RailsRunner, TabKeeper::LoginShell] }
+  let(:pipeline) do
+    [TabKeeper::RailsRunner, TabKeeper::LogRedirection, TabKeeper::LoginShell]
+  end
   let(:options) do
     {
       code_directory: '/path/to/code',
-      rails_env: :production
+      rails_env: :production,
+      log_directory: '/path/to/logs',
+      include_date_in_log_name: true
     }
   end
 
   it do
     is_expected.to eq <<-CRONTAB
-*/5 * * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''FrequentJob.run'\\'''
+*/5 * * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''FrequentJob.run'\\'' >> /path/to/logs/FrequentJob_`date +\\%Y-\\%m-\\%d-\\%H-\\%M-\\%s`.log 2>&1'
 
-0 0 * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''MidnightJob.run'\\'''
+0 0 * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''MidnightJob.run'\\'' >> /path/to/logs/MidnightJob_`date +\\%Y-\\%m-\\%d`.log 2>&1'
 
-30 12 * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''LunchtimeJob.run'\\'''
+30 12 * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''LunchtimeJob.run'\\'' >> /path/to/logs/LunchtimeJob_`date +\\%Y-\\%m-\\%d`.log 2>&1'
 
-30 7 * * 1 /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''HappyMondayJob.run'\\'''
+30 7 * * 1 /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''HappyMondayJob.run'\\'' >> /path/to/logs/HappyMondayJob_`date +\\%Y-\\%m-\\%d`.log 2>&1'
 
-15 16 25 * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''PaydayJob.run'\\'''
+15 16 25 * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''PaydayJob.run'\\'' >> /path/to/logs/PaydayJob_`date +\\%Y-\\%m`.log 2>&1'
     CRONTAB
   end
+
+  context "when the line gets over 900 characters long" do
+    let(:job_list) do
+      TabKeeper::JobList.new { |tab| tab.daily("A" * 901, hour: 12) }.to_a
+    end
+
+    it "raises" do
+      expect { subject }.to raise_error(/too long/)
+    end
+  end
 end

data/spec/tab_keeper/log_redirection_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe TabKeeper::LogRedirection do
   let(:instance) do
     described_class.new("scripts/thing",
-                        job: "scripts/thing",
+                        job: "scripts/thing.sh",
                         job_name_proc: job_name_proc,
                         timing: timing,
                         log_directory: "/path/to/logs",
@@ -34,7 +34,7 @@ RSpec.describe TabKeeper::LogRedirection do
     it do
       is_expected.to eq(
         "scripts/thing >> /path/to/logs/thing_" \
-        "`date +\\%Y-\\%m-\\%d-\\%H-\\%m-\\%s`.log 2>&1")
+        "`date +%Y-%m-%d-%H-%M-%s`.log 2>&1")
     end
   end
 
@@ -43,7 +43,7 @@ RSpec.describe TabKeeper::LogRedirection do
     it do
       is_expected.to eq(
         "scripts/thing >> /path/to/logs/thing_" \
-        "`date +\\%Y-\\%m-\\%d-\\%H-\\%m`.log 2>&1")
+        "`date +%Y-%m-%d-%H-%M`.log 2>&1")
     end
   end
 
@@ -52,7 +52,7 @@ RSpec.describe TabKeeper::LogRedirection do
     it do
       is_expected.to eq(
         "scripts/thing >> /path/to/logs/thing_" \
-        "`date +\\%Y-\\%m-\\%d`.log 2>&1")
+        "`date +%Y-%m-%d`.log 2>&1")
     end
 
     context "with a separate error file" do
@@ -60,8 +60,8 @@ RSpec.describe TabKeeper::LogRedirection do
       it do
         is_expected.to eq(
           "scripts/thing " \
-          ">> /path/to/logs/thing_`date +\\%Y-\\%m-\\%d`.log " \
-          "2>> /path/to/logs/thing_`date +\\%Y-\\%m-\\%d`.error.log")
+          ">> /path/to/logs/thing_`date +%Y-%m-%d`.log " \
+          "2>> /path/to/logs/thing_`date +%Y-%m-%d`.error.log")
       end
     end
 
@@ -70,7 +70,7 @@ RSpec.describe TabKeeper::LogRedirection do
       it do
         is_expected.to eq(
           "scripts/thing >> /path/to/logs/thing_sadness_" \
-          "`date +\\%Y-\\%m-\\%d`.log 2>&1")
+          "`date +%Y-%m-%d`.log 2>&1")
       end
     end
   end
@@ -80,7 +80,7 @@ RSpec.describe TabKeeper::LogRedirection do
     it do
       is_expected.to eq(
         "scripts/thing >> /path/to/logs/thing_" \
-        "`date +\\%Y-\\%m-\\%d`.log 2>&1")
+        "`date +%Y-%m-%d`.log 2>&1")
     end
   end
 
@@ -89,7 +89,7 @@ RSpec.describe TabKeeper::LogRedirection do
     it do
       is_expected.to eq(
         "scripts/thing >> /path/to/logs/thing_" \
-        "`date +\\%Y-\\%m`.log 2>&1")
+        "`date +%Y-%m`.log 2>&1")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tab_keeper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler