rocketjob 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0791ec0844d63115ea5d7b5a1205fe21e72a635c
-  data.tar.gz: 1898e2c267dce737cfa546796d700c72a06bcad7
+  metadata.gz: c742a1c093d122fbb2d6d9b194607d1ebd6743f3
+  data.tar.gz: 2998a334bf98a4624ac3c42b69c70c1a4a4dcaf8
 SHA512:
-  metadata.gz: 14da955ecac4f0b1316c343de006c53d1df296c24c9982c72c48e4ca12631d1283e89e64b999d488a26907503e7b46801c5ace72096dd4b0d3f02c6631f4e001
-  data.tar.gz: f97236b79cfab5ade58b30afebbd8ef05e462ef3f264c70860ab9cc8c2061257f6789bbc3b8d339f80a7d9ca1b17c7e6834678ca1b44958296683543e8adb32f
+  metadata.gz: b032a72a38db2aeb1f121cd65e5835fce438d77c1f6248560c40086fe4fb47f69815c83b8ac491188819ad0b4fea2a93e661015d7e38e0ccb1474e9b3e6c9505
+  data.tar.gz: f152e0cbd1af97f02674a5b47e8f9854f7cfac1c5fc509489b5ab30cd3c464ba11fc6ba41809687720a2caa18fd8dc2b7eaebc5a33fac2c6df7f411777089960

data/lib/rocket_job/cli.rb

@@ -1,23 +1,27 @@
 require 'optparse'
+require 'yaml'
 module RocketJob
   # Command Line Interface parser for RocketJob
   class CLI
-    attr_reader :name, :threads, :environment, :pidfile, :directory, :quiet
+    include SemanticLogger::Loggable
+    attr_accessor :name, :threads, :environment, :pidfile, :directory, :quiet, :log_level
 
     def initialize(argv)
       @name        = nil
       @threads     = nil
       @quiet       = false
-      @environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      @environment = nil
       @pidfile     = nil
       @directory   = '.'
+      @log_level   = nil
       parse(argv)
     end
 
     # Run a RocketJob::Worker from the command line
     def run
-      SemanticLogger.add_appender(STDOUT, &SemanticLogger::Appender::Base.colorized_formatter) unless quiet
-      boot_rails if defined?(:Rails)
+      setup_environment
+      setup_logger
+      boot_standalone unless boot_rails
       write_pidfile
 
       opts               = {}
@@ -27,14 +31,28 @@ module RocketJob
     end
 
     # Initialize the Rails environment
+    # Returns [true|false] whether Rails is present
     def boot_rails
-      require File.expand_path("#{directory}/config/environment.rb")
+      boot_file = Pathname.new(directory).join('config/environment.rb').expand_path
+      return false unless boot_file.file?
+
+      logger.info 'Booting Rails'
+      require boot_file.to_s
       if Rails.configuration.eager_load
         RocketJob::Worker.logger.benchmark_info('Eager loaded Rails and all Engines') do
           Rails.application.eager_load!
           Rails::Engine.subclasses.each(&:eager_load!)
         end
       end
+
+      self.class.load_config(Rails.env)
+      true
+    end
+
+    def boot_standalone
+      logger.info 'Rails not detected. Running standalone.'
+      self.class.load_config(environment)
+      self.class.eager_load_jobs
     end
 
     # Create a PID file if requested
@@ -49,6 +67,44 @@ module RocketJob
       end
     end
 
+    def setup_environment
+      # Override Env vars when environment is supplied
+      if environment
+        ENV['RACK_ENV'] = ENV['RAILS_ENV'] = environment
+      else
+        self.environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      end
+    end
+
+    def setup_logger
+      SemanticLogger.add_appender(STDOUT, &SemanticLogger::Appender::Base.colorized_formatter) unless quiet
+      SemanticLogger.default_level = log_level.to_sym if log_level
+    end
+
+    # Configure MongoMapper if it has not already been configured
+    def self.load_config(environment='development', file_name=nil)
+      return false if MongoMapper.config
+
+      config_file = file_name ? Pathname.new(file_name) : Pathname.pwd.join('config/mongo.yml')
+      if config_file.file?
+        config = YAML.load(ERB.new(config_file.read).result)
+        log    = SemanticLogger::DebugAsTraceLogger.new('Mongo')
+        MongoMapper.setup(config, environment, logger: log)
+        true
+      else
+        raise(ArgumentError, "Mongo Configuration file: #{config_file.to_s} not found")
+      end
+    end
+
+    # Eager load files in jobs folder
+    def self.eager_load_jobs(path = 'jobs')
+      Pathname.glob("#{path}/**/*.rb").each do |path|
+        next if path.directory?
+        logger.debug "Loading #{path.to_s}"
+        load path.expand_path.to_s
+      end
+    end
+
     # Parse command line options placing results in the corresponding instance variables
     def parse(argv)
       parser        = OptionParser.new do |o|
@@ -57,6 +113,7 @@ module RocketJob
         o.on('-q', '--quiet', 'Do not write to stdout, only to logfile. Necessary when running as a daemon') { @quiet = true }
         o.on('-d', '--dir DIR', 'Directory containing Rails app, if not current directory') { |arg| @directory = arg }
         o.on('-e', '--environment ENVIRONMENT', 'The environment to run the app on (Default: RAILS_ENV || RACK_ENV || development)') { |arg| @environment = arg }
+        o.on('-l', '--log_level trace|debug|info|warn|error|fatal', 'The log level to use') { |arg| @log_level = arg }
         o.on('--pidfile PATH', 'Use PATH as a pidfile') { |arg| @pidfile = arg }
         o.on('-v', '--version', 'Print the version information') do
           puts "Rocket Job v#{RocketJob::VERSION}"

data/lib/rocket_job/concerns/worker.rb

@@ -6,9 +6,6 @@ module RocketJob
     module Worker
       def self.included(base)
         base.extend ClassMethods
-        base.class_eval do
-          @rocket_job_defaults = nil
-        end
       end
 
       module ClassMethods
@@ -25,7 +22,13 @@ module RocketJob
 
         # Create a job and process it immediately in-line by this thread
         def now(method, *args, &block)
-          job    = build(method, *args, &block)
+          job = build(method, *args, &block)
+          # Call validations
+          if job.respond_to?(:validate!)
+            job.validate!
+          elsif job.invalid?
+            raise(MongoMapper::DocumentNotValid, "Validation failed: #{job.errors.messages.join(', ')}")
+          end
           worker = RocketJob::Worker.new(name: 'inline')
           worker.started
           job.start
@@ -43,7 +46,6 @@ module RocketJob
         #    discarded, call #cleanup! to clear out any partially uploaded data
         def build(method, *args, &block)
           job = new(arguments: args, perform_method: method.to_sym)
-          @rocket_job_defaults.call(job) if @rocket_job_defaults
           block.call(job) if block
           job
         end
@@ -63,12 +65,6 @@ module RocketJob
           now(:perform, *args, &block)
         end
 
-        # Define job defaults
-        def rocket_job(&block)
-          @rocket_job_defaults = block
-          self
-        end
-
         # Returns the next job to work on in priority based order
         # Returns nil if there are currently no queued jobs, or processing batch jobs
         #   with records that require processing

data/lib/rocket_job/job.rb

@@ -223,6 +223,12 @@ module RocketJob
       instance_method(method).arity
     end
 
+    # Override parent defaults
+    def self.rocket_job(&block)
+      @rocket_job_defaults = block
+      self
+    end
+
     # Returns [true|false] whether to collect the results from running this batch
     def collect_output?
       collect_output == true
@@ -313,14 +319,6 @@ module RocketJob
       end
     end
 
-    # After this model is read, convert any hashes in the arguments list to HashWithIndifferentAccess
-    def load_from_database(*args)
-      super
-      if arguments.present?
-        self.arguments = arguments.collect { |i| i.is_a?(BSON::OrderedHash) ? i.with_indifferent_access : i }
-      end
-    end
-
     # Set exception information for this job and fail it
     def fail(worker_name='user', exc_or_message='Job failed through user action')
       if exc_or_message.is_a?(Exception)
@@ -360,7 +358,6 @@ module RocketJob
       aasm_fire_event(:requeue, persist: false)
     end
 
-    ############################################################################
     protected
 
     # Before events that can be overridden by child classes
@@ -382,7 +379,7 @@ module RocketJob
 
     def before_retry
       self.completed_at = nil
-      self.exception = nil
+      self.exception    = nil
     end
 
     def before_pause
@@ -404,5 +401,26 @@ module RocketJob
       self.worker_name = nil
     end
 
+    private
+
+    # After this model is loaded, convert any hashes in the arguments list to HashWithIndifferentAccess
+    def load_from_database(*args)
+      super
+      if arguments.present?
+        self.arguments = arguments.collect { |i| i.is_a?(BSON::OrderedHash) ? i.with_indifferent_access : i }
+      end
+    end
+
+    def self.apply_defaults(job)
+      @rocket_job_defaults.call(job) if @rocket_job_defaults
+    end
+
+    # Apply RocketJob defaults after initializing default values
+    # but before setting attributes
+    def initialize_default_values(except = {})
+      super
+      self.class.apply_defaults(self)
+    end
+
   end
 end

data/lib/rocket_job/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module RocketJob #:nodoc
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/lib/rocket_job/worker.rb

@@ -102,7 +102,9 @@ module RocketJob
       worker.save!
       create_indexes
       register_signal_handlers
-      raise 'The RocketJob configuration is being applied after the system has been initialized' unless RocketJob::Job.database.name == RocketJob::SlicedJob.database.name
+      if defined?(RocketJobPro) && (RocketJob::Job.database.name != RocketJob::SlicedJob.database.name)
+        raise 'The RocketJob configuration is being applied after the system has been initialized'
+      end
       logger.info "Using MongoDB Database: #{RocketJob::Job.database.name}"
       worker.run
     end

data/test/dirmon_entry_test.rb

@@ -245,9 +245,9 @@ class DirmonEntryTest < Minitest::Test
 
       describe '#later' do
         it 'enqueue job' do
-          @entry.arguments = [{}]
+          @entry.arguments      = [{}]
           @entry.perform_method = :event
-          job = @entry.later(@pathname)
+          job                   = @entry.later(@pathname)
           assert_equal File.join(@archive_directory, "#{job.id}_#{File.basename(@file_name)}"), job.arguments.first[:full_file_name]
           assert job.queued?
         end

data/test/dirmon_job_test.rb

@@ -117,7 +117,7 @@ class DirmonJobTest < Minitest::Test
 
       it 'skip files in archive directory' do
         @entry.archive_directory = nil
-        @entry.pattern = "#{@directory}/abc/**/*"
+        @entry.pattern           = "#{@directory}/abc/**/*"
 
         create_file("#{@directory}/abc/file1", 5)
         create_file("#{@directory}/abc/file2", 10)
@@ -139,7 +139,7 @@ class DirmonJobTest < Minitest::Test
           "#{@directory}/abc/file1" => 5,
           "#{@directory}/abc/file2" => 10,
         }
-        new_file_names = {
+        new_file_names      = {
           "#{@directory}/abc/file1" => 10,
           "#{@directory}/abc/file2" => 10,
         }
@@ -165,28 +165,28 @@ class DirmonJobTest < Minitest::Test
         new_dirmon_job.destroy
       end
 
-        it 'check directories and reschedule even on exception' do
-          dirmon_job = nil
-          RocketJob::Jobs::DirmonJob.destroy_all
-          RocketJob::Jobs::DirmonJob.stub_any_instance(:check_directories, -> previous { raise RuntimeError.new("Oh no") }) do
-            # perform_now does not save the job, just runs it
-            dirmon_job = RocketJob::Jobs::DirmonJob.perform_now do |job|
-              job.priority      = 11
-              job.check_seconds = 30
-            end
+      it 'check directories and reschedule even on exception' do
+        dirmon_job = nil
+        RocketJob::Jobs::DirmonJob.destroy_all
+        RocketJob::Jobs::DirmonJob.stub_any_instance(:check_directories, -> previous { raise RuntimeError.new("Oh no") }) do
+          # perform_now does not save the job, just runs it
+          dirmon_job = RocketJob::Jobs::DirmonJob.perform_now do |job|
+            job.priority      = 11
+            job.check_seconds = 30
           end
-          assert dirmon_job.failed?, dirmon_job.status.inspect
+        end
+        assert dirmon_job.failed?, dirmon_job.status.inspect
 
-          # It it have enqueued another instance to run in the future
-          assert_equal 2, RocketJob::Jobs::DirmonJob.count
-          assert new_dirmon_job = RocketJob::Jobs::DirmonJob.last
-          assert new_dirmon_job.run_at
-          assert_equal 11, new_dirmon_job.priority
-          assert_equal 30, new_dirmon_job.check_seconds
-          assert new_dirmon_job.queued?
+        # It it have enqueued another instance to run in the future
+        assert_equal 2, RocketJob::Jobs::DirmonJob.count
+        assert new_dirmon_job = RocketJob::Jobs::DirmonJob.last
+        assert new_dirmon_job.run_at
+        assert_equal 11, new_dirmon_job.priority
+        assert_equal 30, new_dirmon_job.check_seconds
+        assert new_dirmon_job.queued?
 
-          new_dirmon_job.destroy
-        end
+        new_dirmon_job.destroy
+      end
     end
 
     def create_file(file_name, size)

data/test/job_test.rb

@@ -17,7 +17,8 @@ class JobTest < Minitest::Test
       @job2        = Jobs::TestJob.new(
         description:         "#{@description} 2",
         arguments:           @arguments,
-        destroy_on_complete: false
+        destroy_on_complete: false,
+        priority:            52
       )
     end
 
@@ -64,7 +65,7 @@ class JobTest < Minitest::Test
         assert_nil @job.expires_at
         assert_equal @arguments, @job.arguments
         assert_equal 0, @job.percent_complete
-        assert_equal 50, @job.priority
+        assert_equal 51, @job.priority
         assert_equal 0, @job.failure_count
         assert_nil @job.run_at
         assert_nil @job.started_at
@@ -268,6 +269,7 @@ class JobTest < Minitest::Test
 
     describe '.requeue_dead_worker' do
       it 'requeue jobs from dead workers' do
+        assert_equal 52, @job2.priority
         worker_name      = 'server:12345'
         @job.worker_name = worker_name
         @job.start!

data/test/job_worker_test.rb

@@ -29,7 +29,7 @@ class WorkerTest < Minitest::Test
           assert_equal false, @job.destroy_on_complete
           assert_nil @job.expires_at
           assert_equal 0, @job.percent_complete
-          assert_equal 50, @job.priority
+          assert_equal 51, @job.priority
           assert_equal 0, @job.failure_count
           assert_nil @job.run_at
           assert_nil @job.started_at
@@ -48,7 +48,7 @@ class WorkerTest < Minitest::Test
           assert_equal false, @job.destroy_on_complete
           assert_nil @job.expires_at
           assert_equal 100, @job.percent_complete
-          assert_equal 50, @job.priority
+          assert_equal 51, @job.priority
           assert_equal 0, @job.failure_count
           assert_nil @job.run_at
           assert @job.started_at

data/test/jobs/test_job.rb

@@ -1,6 +1,10 @@
 require 'rocketjob'
 module Jobs
   class TestJob < RocketJob::Job
+    rocket_job do |job|
+      job.priority = 51
+    end
+
     @@result = nil
 
     # For holding test results
@@ -39,4 +43,4 @@ module Jobs
     end
 
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketjob
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm