tab_keeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29235a8d42173d34b28beb02ec01bb82285aa12c
+  data.tar.gz: c3978f99e2fcc255ff2d7f68590e46e162a6c498
+SHA512:
+  metadata.gz: 59272e872de28887507c2ec2a7712695d2a442e0d788c96a05327eadb5d8f1aff727e41c4c4ed9179780cea7fcf2507aa41fdf303a7276e3327a0c0c3d7ad415
+  data.tar.gz: f92e98d7503c162a0679a145c38e1d39e566137d4b7beb43bf7b164d6522f97053002c6ee6dbffc98a12f267690626b11930bf8ba656f476c4dbadf04ef46338

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+.rspec_log

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tab_keeper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Isaac Seymour
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# TabKeeper
+
+Keep tabs on your crontab.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tab_keeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tab_keeper
+
+## Usage
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test`
+to run the tests. You can also run `bin/console` for an interactive prompt that will allow
+you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/isaacseymour/tab_keeper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tab_keeper"
+require "pry"
+Pry.start

data/lib/tab_keeper/daily.rb

@@ -0,0 +1,30 @@
+module TabKeeper
+  class Daily
+    HOUR_VALUES = (0..23)
+    MINUTE_VALUES = (0..59)
+
+    def initialize(hour: nil, min: 0)
+      @hour = hour
+      @min = min
+      validate!
+    end
+
+    def to_s
+      "#{min} #{hour} * * *"
+    end
+
+    private
+
+    attr_reader :hour, :min
+
+    def validate!
+      unless HOUR_VALUES.include?(hour)
+        raise ArgumentError, "hour must be between 0 and 23"
+      end
+
+      unless MINUTE_VALUES.include?(min)
+        raise ArgumentError, "min must be between 0 and 59"
+      end
+    end
+  end
+end

data/lib/tab_keeper/generator.rb

@@ -0,0 +1,15 @@
+module TabKeeper
+  class Generator
+    def initialize(*pipeline)
+      @pipeline = pipeline.flatten
+    end
+
+    def generate(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"
+    end
+  end
+end

data/lib/tab_keeper/hourly.rb

@@ -0,0 +1,45 @@
+module TabKeeper
+  class Hourly
+    MINUTE_VALUES = (0..59)
+    # Other values don't divide 24, so result in weird behaviour
+    EVERY_VALUES = [nil, 2, 3, 4, 6, 8, 12]
+    HOUR_VALUES = (0..23)
+
+    def initialize(min: 0, every: nil, only: nil)
+      @min = min
+      @every = every
+      @only = only
+      verify!
+    end
+
+    def to_s
+      return "#{min} */#{every} * * *" if every
+      return "#{min} #{only.join(',')} * * *" if only
+      "#{min} * * * *"
+    end
+
+    private
+
+    attr_reader :min, :every, :only
+
+    def verify!
+      unless MINUTE_VALUES.include?(min)
+        raise ArgumentError, "min must be between 0 and 59"
+      end
+
+      unless EVERY_VALUES.include?(every)
+        raise ArgumentError, "every must be one of #{EVERY_VALUES.join(', ')}"
+      end
+
+      return if only.nil?
+      raise ArgumentError, "every and only don't make sense together!" if every
+
+      raise ArgumentError, "only must be an array" unless only.is_a?(Array)
+
+      raise ArgumentError, "use Daily instead of a single `only` list" if only.one?
+
+      return if only.all? { |hour| HOUR_VALUES.include?(hour) }
+      raise ArgumentError, "only must be nil, or a list of hours"
+    end
+  end
+end

data/lib/tab_keeper/job_list.rb

@@ -0,0 +1,41 @@
+module TabKeeper
+  class JobList
+    def initialize
+      @jobs = []
+      yield self if block_given?
+    end
+
+    def generate(generator, **options)
+      generator.generate(@jobs, **options)
+    end
+
+    def to_a
+      @jobs
+    end
+
+    def add(job, timer)
+      # TODO: validate `timer.to_s`
+      @jobs << [job, timer.to_s]
+    end
+
+    def daily(job, **options)
+      add(job, Daily.new(**options))
+    end
+
+    def hourly(job, **options)
+      add(job, Hourly.new(**options))
+    end
+
+    def minutely(job, **options)
+      add(job, Minutely.new(**options))
+    end
+
+    def monthly(job, **options)
+      add(job, Monthly.new(**options))
+    end
+
+    def weekly(job, **options)
+      add(job, Weekly.new(**options))
+    end
+  end
+end

data/lib/tab_keeper/log_redirection.rb

@@ -0,0 +1,96 @@
+module TabKeeper
+  class LogRedirection
+    def initialize(previous, job: nil,
+                             job_name_proc: ->(x) { x },
+                             timing: nil,
+                             log_directory: nil,
+                             error_suffix: nil,
+                             include_date_in_log_name: false,
+                             **_options)
+      if previous.nil?
+        raise ArgumentError, "#{self.class.name} must not be first in the cron pipeline!"
+      end
+
+      if log_directory.nil?
+        raise ArgumentError, "log_directory must be set for #{self.class.name}"
+      end
+
+      @previous = previous
+      @job = job
+      # 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 = job_name_proc.call(job_name)
+      @timing = timing
+      @log_directory = log_directory
+      @error_suffix = error_suffix
+      @include_date_in_log_name = include_date_in_log_name
+    end
+
+    def to_s
+      "#{@previous} " \
+        ">> #{@log_directory}/#{job_name}#{date_part}.log " \
+        "2>#{error_part}"
+    end
+
+    private
+
+    attr_reader :job_name
+
+    def error_part
+      return "&1" unless @error_suffix
+      "> #{@log_directory}/#{job_name}#{date_part}.#{@error_suffix}.log"
+    end
+
+    def date_part
+      return unless include_date?
+      "_`date +#{date_format}`"
+    end
+
+    def include_date?
+      @include_date_in_log_name
+    end
+
+    def date_format
+      [
+        '%Y',
+        '%m',
+        day_component,
+        hour_component,
+        min_component,
+        second_component
+      ].compact.join('-').chars.map { |char| char == '%' ? '\%' : char }.join
+    end
+
+    def day_component
+      '%d' if more_than_once_a_month?
+    end
+
+    def hour_component
+      '%H' if more_than_once_a_day?
+    end
+
+    def min_component
+      '%m' if more_than_once_a_day?
+    end
+
+    def second_component
+      '%s' if more_than_once_an_hour?
+    end
+
+    MULTIPLE_CHARACTERS = "*-/,".chars.map(&:freeze).freeze
+
+    def more_than_once_a_month?
+      MULTIPLE_CHARACTERS.any? { |char| @timing.split(' ')[2].include?(char) }
+    end
+
+    def more_than_once_a_day?
+      MULTIPLE_CHARACTERS.any? { |char| @timing.split(' ').first(2).join.include?(char) }
+    end
+
+    def more_than_once_an_hour?
+      MULTIPLE_CHARACTERS.any? { |char| @timing.split(' ').first.include?(char) }
+    end
+  end
+end

data/lib/tab_keeper/login_shell.rb

@@ -0,0 +1,24 @@
+module TabKeeper
+  class LoginShell
+    def initialize(previous, job: nil, code_directory: nil, **_options)
+      @command = previous || job
+      @code_directory = code_directory
+      return if code_directory
+      raise ArgumentError, "code `directory` must be configured for LoginShell"
+    end
+
+    def to_s
+      "/bin/bash -l -c 'cd #{escaped_path} && #{escaped_command}'"
+    end
+
+    private
+
+    def escaped_path
+      @code_directory.chars.map { |char| char == "'" ? "'\\''" : char }.join
+    end
+
+    def escaped_command
+      @command.chars.map { |char| char == "'" ? "'\\''" : char }.join
+    end
+  end
+end

data/lib/tab_keeper/minutely.rb

@@ -0,0 +1,25 @@
+module TabKeeper
+  class Minutely
+    # Other values would lead to the non-evenly spaced runs, which is non-obvious
+    EVERY_VALUES = [2, 3, 4, 5, 6, 10, 12, 15, 20, 30]
+
+    def initialize(every: nil)
+      @every = every
+      verify!
+    end
+
+    def to_s
+      return "* * * * *" unless every
+      "*/#{every} * * * *"
+    end
+
+    private
+
+    attr_reader :every
+
+    def verify!
+      return if every.nil? || EVERY_VALUES.include?(every)
+      raise ArgumentError, "every must be nil, or one of #{EVERY_VALUES.join(', ')}"
+    end
+  end
+end

data/lib/tab_keeper/monthly.rb

@@ -0,0 +1,36 @@
+module TabKeeper
+  class Monthly
+    MINUTE_VALUES = (0..59)
+    HOUR_VALUES = (0..23)
+    # Cron supports 29-31 too, but that's a recipe for sadness
+    DAY_VALUES = (0..28)
+
+    def initialize(day: nil, hour: nil, min: 0)
+      @day = day
+      @hour = hour
+      @min = min
+      verify!
+    end
+
+    def to_s
+      "#{min} #{hour} #{day} * *"
+    end
+
+    private
+
+    attr_reader :day, :hour, :min
+
+    def verify!
+      unless MINUTE_VALUES.include?(min)
+        raise ArgumentError, "min must be between 0 and 59"
+      end
+
+      unless HOUR_VALUES.include?(hour)
+        raise ArgumentError, "hour must be between 0 and 23"
+      end
+
+      return if DAY_VALUES.include?(day)
+      raise ArgumentError, "day must be between 0 and 28"
+    end
+  end
+end

data/lib/tab_keeper/rails_runner.rb

@@ -0,0 +1,25 @@
+module TabKeeper
+  class RailsRunner
+    def initialize(previous, job: nil, rails_env: nil, **_options)
+      @to_run = previous || job
+      @rails_env = rails_env
+    end
+
+    def to_s
+      ["bin/rails runner", env_part, "'#{escaped_previous}'"].compact.join(" ")
+    end
+
+    private
+
+    attr_reader :rails_env, :to_run
+
+    def env_part
+      return unless @rails_env
+      "-e #{rails_env}"
+    end
+
+    def escaped_previous
+      to_run.chars.map { |char| char == "'" ? "'\\''" : char }.join
+    end
+  end
+end

data/lib/tab_keeper/version.rb

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

data/lib/tab_keeper/weekly.rb

@@ -0,0 +1,41 @@
+module TabKeeper
+  class Weekly
+    MINUTE_VALUES = (0..59)
+    HOUR_VALUES = (0..23)
+    # Order matters here - it must match the ordering used by cron (i.e. 0 = Sunday)
+    DAY_VALUES = %i(sunday monday tuesday wednesday thursday friday saturday)
+
+    def initialize(day: nil, hour: nil, min: 0)
+      @day = day
+      @hour = hour
+      @min = min
+      verify!
+    end
+
+    def to_s
+      "#{min} #{hour} * * #{day_index}"
+    end
+
+    private
+
+    attr_reader :day, :hour, :min
+
+    def day_index
+      return day if day.is_a?(Fixnum)
+      DAY_VALUES.index(day)
+    end
+
+    def verify!
+      unless MINUTE_VALUES.include?(min)
+        raise ArgumentError, "min must be between 0 and 59"
+      end
+
+      unless HOUR_VALUES.include?(hour)
+        raise ArgumentError, "hour must be between 0 and 23"
+      end
+
+      return if DAY_VALUES.include?(day) || (day.is_a?(Fixnum) && DAY_VALUES[day])
+      raise ArgumentError, "day must be between 0 and 6, or a symbol day name"
+    end
+  end
+end

data/lib/tab_keeper.rb

@@ -0,0 +1,18 @@
+require "tab_keeper/version"
+
+module TabKeeper
+end
+
+require "tab_keeper/daily"
+require "tab_keeper/hourly"
+require "tab_keeper/minutely"
+require "tab_keeper/monthly"
+require "tab_keeper/weekly"
+
+require "tab_keeper/job_list"
+
+require "tab_keeper/log_redirection"
+require "tab_keeper/login_shell"
+require "tab_keeper/rails_runner"
+
+require "tab_keeper/generator"

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+lib_path = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require "tab_keeper"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.example_status_persistence_file_path = ".rspec_log"
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/tab_keeper/daily_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe TabKeeper::Daily do
+  subject { described_class.new(hour: hour, min: min).to_s }
+
+  context "midnight" do
+    let(:hour) { 0 }
+    let(:min) { 0 }
+    it { is_expected.to eq("0 0 * * *") }
+  end
+
+  context "7:30am" do
+    let(:hour) { 7 }
+    let(:min) { 30 }
+    it { is_expected.to eq("30 7 * * *") }
+  end
+
+  context "without min supplied" do
+    let(:hour) { 12 }
+    let(:min) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "without hour supplied" do
+    let(:hour) { nil }
+    let(:min) { 2 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird hour" do
+    let(:hour) { 24 }
+    let(:min) { 0 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird minute" do
+    let(:hour) { 12 }
+    let(:min) { -1 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+end

data/spec/tab_keeper/generator_spec.rb

@@ -0,0 +1,34 @@
+RSpec.describe TabKeeper::Generator do
+  subject { described_class.new(*pipeline).generate(job_list, **options) }
+  let(:job_list) do
+    TabKeeper::JobList.new do |tab|
+      tab.minutely("FrequentJob.run", every: 5)
+      tab.daily("MidnightJob.run", hour: 0)
+      tab.daily("LunchtimeJob.run", hour: 12, min: 30)
+      tab.weekly("HappyMondayJob.run", day: :monday, hour: 7, min: 30)
+      tab.monthly("PaydayJob.run", day: 25, hour: 16, min: 15)
+    end.to_a
+  end
+
+  let(:pipeline) { [TabKeeper::RailsRunner, TabKeeper::LoginShell] }
+  let(:options) do
+    {
+      code_directory: '/path/to/code',
+      rails_env: :production
+    }
+  end
+
+  it do
+    is_expected.to eq <<-CRONTAB
+*/5 * * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''FrequentJob.run'\\'''
+
+0 0 * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''MidnightJob.run'\\'''
+
+30 12 * * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''LunchtimeJob.run'\\'''
+
+30 7 * * 1 /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''HappyMondayJob.run'\\'''
+
+15 16 25 * * /bin/bash -l -c 'cd /path/to/code && bin/rails runner -e production '\\''PaydayJob.run'\\'''
+    CRONTAB
+  end
+end

data/spec/tab_keeper/hourly_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe TabKeeper::Hourly do
+  subject { described_class.new(every: every, only: only, min: min).to_s }
+  let(:every) { nil }
+  let(:only) { nil }
+
+  context "every hour" do
+    let(:min) { 0 }
+    it { is_expected.to eq("0 * * * *") }
+  end
+
+  context "every half-past" do
+    let(:min) { 30 }
+    it { is_expected.to eq("30 * * * *") }
+  end
+
+  context "every 3rd hour" do
+    let(:min) { 0 }
+    let(:every) { 3 }
+    it { is_expected.to eq("0 */3 * * *") }
+  end
+
+  context "on specified hours" do
+    let(:min) { 15 }
+    let(:only) { [3, 9, 17] }
+    it { is_expected.to eq("15 3,9,17 * * *") }
+  end
+
+  context "without the minute" do
+    let(:min) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with every and only specified" do
+    let(:min) { 0 }
+    let(:every) { 3 }
+    let(:only) { [1, 2, 3] }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with only as a single hour" do
+    let(:only) { 12 }
+    let(:min) { 0 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+end

data/spec/tab_keeper/job_list_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe TabKeeper::JobList do
+  subject(:instance) { described_class.new }
+
+  it "yields itself" do
+    yielded = nil
+    returned = described_class.new { |tab| yielded = tab }
+    expect(yielded).to be(returned)
+  end
+
+  describe "#add" do
+    pending "rejects invalid timers" do
+      expect { instance.add("thing", "* *-2 50 * -1") }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#daily" do
+    it "passes options through to Daily.new" do
+      expect(TabKeeper::Daily).to receive(:new).with(hour: 5).and_call_original
+      instance.daily("thing", hour: 5)
+    end
+  end
+
+  describe "#hourly" do
+    it "passes options through to Hourly.new" do
+      expect(TabKeeper::Hourly).to receive(:new).with(min: 5).and_call_original
+      instance.hourly("thing", min: 5)
+    end
+  end
+
+  describe "#minutely" do
+    it "passes options through to Minutely.new" do
+      expect(TabKeeper::Minutely).to receive(:new).and_call_original
+      instance.minutely("thing")
+    end
+  end
+
+  describe "#monthly" do
+    it "passes options through to Monthly.new" do
+      expect(TabKeeper::Monthly).to receive(:new).with(day: 14, hour: 5).and_call_original
+      instance.monthly("thing", day: 14, hour: 5)
+    end
+  end
+
+  describe "#weekly" do
+    it "passes options through to Weekly.new" do
+      expect(TabKeeper::Weekly).to receive(:new).with(day: :monday, hour: 5).
+        and_call_original
+      instance.weekly("thing", day: :monday, hour: 5)
+    end
+  end
+end

data/spec/tab_keeper/log_redirection_spec.rb

@@ -0,0 +1,95 @@
+RSpec.describe TabKeeper::LogRedirection do
+  let(:instance) do
+    described_class.new("scripts/thing",
+                        job: "scripts/thing",
+                        job_name_proc: job_name_proc,
+                        timing: timing,
+                        log_directory: "/path/to/logs",
+                        include_date_in_log_name: include_date_in_log_name,
+                        error_suffix: error_suffix)
+  end
+  subject { instance.to_s }
+  let(:job_name_proc) { ->(job) { job } }
+  let(:error_suffix) { nil }
+  let(:include_date_in_log_name) { true }
+
+  context "without date in the log file name" do
+    let(:include_date_in_log_name) { false }
+    let(:timing) { "* * * * *" }
+    it { is_expected.to eq("scripts/thing >> /path/to/logs/thing.log 2>&1") }
+  end
+
+  context "with a separate error log" do
+    let(:include_date_in_log_name) { false }
+    let(:error_suffix) { "wah" }
+    let(:timing) { "* * * * *" }
+    it do
+      is_expected.to eq("scripts/thing >> /path/to/logs/thing.log " \
+                        "2>> /path/to/logs/thing.wah.log")
+    end
+  end
+
+  context "with minutely timing" do
+    let(:timing) { TabKeeper::Minutely.new(every: 5).to_s }
+    it do
+      is_expected.to eq(
+        "scripts/thing >> /path/to/logs/thing_" \
+        "`date +\\%Y-\\%m-\\%d-\\%H-\\%m-\\%s`.log 2>&1")
+    end
+  end
+
+  context "with hourly timing" do
+    let(:timing) { TabKeeper::Hourly.new(every: 2).to_s }
+    it do
+      is_expected.to eq(
+        "scripts/thing >> /path/to/logs/thing_" \
+        "`date +\\%Y-\\%m-\\%d-\\%H-\\%m`.log 2>&1")
+    end
+  end
+
+  context "with daily timing" do
+    let(:timing) { TabKeeper::Daily.new(hour: 14).to_s }
+    it do
+      is_expected.to eq(
+        "scripts/thing >> /path/to/logs/thing_" \
+        "`date +\\%Y-\\%m-\\%d`.log 2>&1")
+    end
+
+    context "with a separate error file" do
+      let(:error_suffix) { "error" }
+      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")
+      end
+    end
+
+    context "with a fun job name proc" do
+      let(:job_name_proc) { -> (job) { "#{job}_sadness" } }
+      it do
+        is_expected.to eq(
+          "scripts/thing >> /path/to/logs/thing_sadness_" \
+          "`date +\\%Y-\\%m-\\%d`.log 2>&1")
+      end
+    end
+  end
+
+  context "with weekly timing" do
+    let(:timing) { TabKeeper::Weekly.new(hour: 14, day: :tuesday).to_s }
+    it do
+      is_expected.to eq(
+        "scripts/thing >> /path/to/logs/thing_" \
+        "`date +\\%Y-\\%m-\\%d`.log 2>&1")
+    end
+  end
+
+  context "with monthly timing" do
+    let(:timing) { TabKeeper::Monthly.new(day: 5, hour: 12).to_s }
+    it do
+      is_expected.to eq(
+        "scripts/thing >> /path/to/logs/thing_" \
+        "`date +\\%Y-\\%m`.log 2>&1")
+    end
+  end
+end

data/spec/tab_keeper/login_shell_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe TabKeeper::LoginShell do
+  subject { described_class.new(previous, job: job, code_directory: code_directory).to_s }
+  let(:job) { "bin/some_script" }
+  let(:code_directory) { "/path/to/code" }
+  let(:previous) { nil }
+
+  it { is_expected.to eq("/bin/bash -l -c 'cd /path/to/code && bin/some_script'") }
+
+  context "with a previous command" do
+    let(:previous) { "SOMEVAR=value bin/some_script" }
+    it do
+      is_expected.
+        to eq("/bin/bash -l -c 'cd /path/to/code && SOMEVAR=value bin/some_script'")
+    end
+  end
+
+  context "when the job needs escaping" do
+    let(:job) { "bin/run 'MyJob.run('\\''arg'\\'')'" }
+    it do
+      is_expected.to eq(
+        "/bin/bash -l -c 'cd /path/to/code && " \
+        "bin/run '\\''MyJob.run('\\''\\'\\'''\\''arg'\\''\\'\\'''\\'')'\\'''")
+    end
+  end
+end

data/spec/tab_keeper/minutely_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe TabKeeper::Minutely do
+  subject { described_class.new(every: every).to_s }
+
+  context "5 minutes" do
+    let(:every) { 5 }
+    it { is_expected.to eq("*/5 * * * *") }
+  end
+
+  context "every minute" do
+    let(:every) { nil }
+    it { is_expected.to eq("* * * * *") }
+  end
+
+  context "every 30 seconds" do
+    let(:every) { 0.5 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+end

data/spec/tab_keeper/monthly_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe TabKeeper::Monthly do
+  subject { described_class.new(day: day, hour: hour, min: min).to_s }
+  let(:day) { 1 }
+  let(:hour) { 13 }
+  let(:min) { 0 }
+
+  context "on the first of the month" do
+    let(:day) { 1 }
+    it { is_expected.to eq("0 13 1 * *") }
+  end
+
+  context "on the 15th of the month" do
+    let(:day) { 15 }
+    it { is_expected.to eq("0 13 15 * *") }
+  end
+
+  context "without the minute" do
+    let(:min) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "without the hour" do
+    let(:hour) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "without the day" do
+    let(:day) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird minute" do
+    let(:min) { 60 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird hour" do
+    let(:hour) { -1 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird day" do
+    let(:day) { 29 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a symbol day" do
+    let(:day) { :thursday }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+end

data/spec/tab_keeper/rails_runner_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe TabKeeper::RailsRunner do
+  subject { described_class.new(previous, job: "MyJob.run", rails_env: rails_env).to_s }
+
+  let(:previous) { "MyJob.run" }
+  let(:rails_env) { :staging }
+
+  it { is_expected.to eq("bin/rails runner -e staging 'MyJob.run'") }
+
+  context "when there are 's to escape" do
+    let(:previous) { "MyJob.run('arg')" }
+    it { is_expected.to eq("bin/rails runner -e staging 'MyJob.run('\\''arg'\\'')'") }
+  end
+
+  context "when this is the first transformer in the pipeline" do
+    let(:previous) { nil }
+    it { is_expected.to eq("bin/rails runner -e staging 'MyJob.run'") }
+  end
+
+  context "without a rails_env set" do
+    let(:rails_env) { nil }
+    it { is_expected.to eq("bin/rails runner 'MyJob.run'") }
+  end
+end

data/spec/tab_keeper/weekly_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe TabKeeper::Weekly do
+  subject { described_class.new(day: day, hour: hour, min: min).to_s }
+  let(:day) { :wednesday }
+  let(:hour) { 13 }
+  let(:min) { 0 }
+
+  context "every Thursday" do
+    let(:day) { :thursday }
+    it { is_expected.to eq("0 13 * * 4") }
+  end
+
+  context "every 3rd day of the week" do
+    let(:day) { 3 }
+    it { is_expected.to eq("0 13 * * 3") }
+  end
+
+  context "without the minute" do
+    let(:min) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "without the hour" do
+    let(:hour) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "without the day" do
+    let(:day) { nil }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird minute" do
+    let(:min) { 60 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird hour" do
+    let(:hour) { -1 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a weird day" do
+    let(:day) { 8 }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+
+  context "with a string day" do
+    let(:day) { "thursday" }
+    specify { expect { subject }.to raise_error(ArgumentError) }
+  end
+end

data/tab_keeper.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tab_keeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tab_keeper"
+  spec.version       = TabKeeper::VERSION
+  spec.authors       = ["Isaac Seymour"]
+  spec.email         = ["i.seymour@oxon.org"]
+
+  spec.summary       = %q{Manage crons}
+  spec.homepage      = "https://github.com/isaacseymour/tab_keeper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rspec",   "~> 3"
+  spec.add_development_dependency "pry",     "~> 0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: tab_keeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isaac Seymour
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- i.seymour@oxon.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/console
+- lib/tab_keeper.rb
+- lib/tab_keeper/daily.rb
+- lib/tab_keeper/generator.rb
+- lib/tab_keeper/hourly.rb
+- lib/tab_keeper/job_list.rb
+- lib/tab_keeper/log_redirection.rb
+- lib/tab_keeper/login_shell.rb
+- lib/tab_keeper/minutely.rb
+- lib/tab_keeper/monthly.rb
+- lib/tab_keeper/rails_runner.rb
+- lib/tab_keeper/version.rb
+- lib/tab_keeper/weekly.rb
+- spec/spec_helper.rb
+- spec/tab_keeper/daily_spec.rb
+- spec/tab_keeper/generator_spec.rb
+- spec/tab_keeper/hourly_spec.rb
+- spec/tab_keeper/job_list_spec.rb
+- spec/tab_keeper/log_redirection_spec.rb
+- spec/tab_keeper/login_shell_spec.rb
+- spec/tab_keeper/minutely_spec.rb
+- spec/tab_keeper/monthly_spec.rb
+- spec/tab_keeper/rails_runner_spec.rb
+- spec/tab_keeper/weekly_spec.rb
+- tab_keeper.gemspec
+homepage: https://github.com/isaacseymour/tab_keeper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Manage crons
+test_files:
+- spec/spec_helper.rb
+- spec/tab_keeper/daily_spec.rb
+- spec/tab_keeper/generator_spec.rb
+- spec/tab_keeper/hourly_spec.rb
+- spec/tab_keeper/job_list_spec.rb
+- spec/tab_keeper/log_redirection_spec.rb
+- spec/tab_keeper/login_shell_spec.rb
+- spec/tab_keeper/minutely_spec.rb
+- spec/tab_keeper/monthly_spec.rb
+- spec/tab_keeper/rails_runner_spec.rb
+- spec/tab_keeper/weekly_spec.rb