lyber-core 4.1.3 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4fb7e891b91c5c229147d0c56c5c6e4ee98e4b1
-  data.tar.gz: 2cd2447a9967a2f24a96ba8135bd50084a20cda1
+  metadata.gz: a1489790b66195312397f9325c4e61119086d903
+  data.tar.gz: e5db26df5720035e46f22360246f680dfbe87b10
 SHA512:
-  metadata.gz: b358e476ab7fa8726a87b4ea0ac945e2e18823273990c78aac31f91585a46b47004687f0362f72c430ebb1f7cdcfb860147dda8a056a6d0073eb2a25ece0efb3
-  data.tar.gz: 2189c3ca99c2e16ef0bb634cb4d6aee9d346ba2883e78c5c3da5d6cfee6c1080ea4dd1721957a3da8d0b215848d1c9a6362a046fc0221cb2f327c6136e7a7f63
+  metadata.gz: 5af41b19bb03d42890596fe374187cbc856d768fedff25b104522b2717a08adc2dff41d5c826455284cd89a7d761906ecb57633c8a0d2419ebd9616f7ab9ce2f
+  data.tar.gz: 0647f4d26c22e049c59bbc814f1dafc5463169e2e0ee687a77d9b0e4051d37ac9015280f7e2bc0fa967a6b47e2a315adaf4fd418adcdc6b712562ff7149fba09

data/lib/lyber_core.rb

@@ -1,3 +1,6 @@
+require 'dor-workflow-service'
+
+require 'lyber_core/base'
 require 'lyber_core/log'
 require 'lyber_core/robot'
 require 'lyber_core/return_state'

data/lib/lyber_core/base.rb

@@ -0,0 +1,91 @@
+require 'benchmark'
+require 'active_support'
+
+module LyberCore
+  # The skeleton of robots, a replacement for LyberCore::Robot
+  # @example To migrate from LyberCore::Robot, replace
+  #   class MyRobot
+  #     include LyberCore::Robot
+  #     def initialize
+  #       new(REPOSITORY, WORKFLOW_NAME, ROBOT_NAME)
+  #     end
+  #     def perform ...
+  #   end
+  # @example Usage: implement self.worker and override #perform, as before
+  #   class MyRobot < LyberCore::Base
+  #     def self.worker
+  #       new('sdr', 'preservationIngestWF', 'ingest-poison')
+  #     end
+  #     def perform ...
+  #   end
+  class Base
+    # Called by job-manager: instantiate the Robot and call #work with the druid
+    # @param [String] druid
+    # @note Override the instance method #perform, probably not this one
+    def self.perform(druid)
+      worker.work(druid)
+    end
+
+    # get an instance, without knowing the params for .new()
+    # @return [LyberCore::Base]
+    def self.worker
+      raise NotImplementedError, 'Implement class method self.worker on the subclass'
+    end
+
+    attr_accessor :repo, :workflow_name, :step_name, :check_queued_status, :workflow_service
+
+    def initialize(repo, workflow_name, step_name, opts = {})
+      Signal.trap('QUIT') { puts "#{Process.pid} ignoring SIGQUIT" } # SIGQUIT ignored to let the robot finish
+      @repo = repo
+      @workflow_name = workflow_name
+      @step_name = step_name
+      @check_queued_status = opts.fetch(:check_queued_status, true)
+      @workflow_service = opts.fetch(:workflow_service, Dor::WorkflowService)
+    end
+
+    # @return [Logger]
+    def logger
+      unless @log_init # one time
+        LyberCore::Log.set_logfile($stdout) # let process manager(bluepill) handle logging
+        @log_init = true
+      end
+      LyberCore::Log
+    end
+
+    # Sets up logging, timing and error handling of the job
+    # Calls the #perform method, then sets workflow to 'completed' or 'error' depending on success
+    def work(druid)
+      logger.info "#{druid} processing"
+      return if check_queued_status && !item_queued?(druid)
+      result = nil
+      elapsed = Benchmark.realtime { result = perform(druid) }
+      if result.is_a?(LyberCore::Robot::ReturnState)
+        workflow_state = result.status
+        note = result.note unless result.note.blank?
+      else
+        workflow_state = 'completed' # default
+      end
+      note ||= Socket.gethostname # default
+      workflow_service.update_workflow_status(repo, druid, workflow_name, step_name, workflow_state, elapsed: elapsed, note: note)
+      logger.info "Finished #{druid} in #{format('%0.4f', elapsed)}s"
+    rescue StandardError => e
+      Honeybadger.notify(e) if defined? Honeybadger
+      begin
+        logger.error e.message + "\n" + e.backtrace.join("\n")
+        workflow_service.update_workflow_error_status(repo, druid, workflow_name, step_name, e.message, error_text: Socket.gethostname)
+      rescue StandardError => e2
+        logger.error "Cannot set #{druid} to status='error'\n" + e2.message + "\n" + e2.backtrace.join("\n")
+        raise e2 # send exception to Resque failed queue
+      end
+    end
+
+  private
+
+    def item_queued?(druid)
+      status = workflow_service.get_workflow_status(repo, druid, workflow_name, step_name)
+      return true if status =~ /queued/i
+      logger.warn "Item is not queued, but has status of '#{status}'. Will skip processing"
+      false
+    end
+  end
+end

data/lib/lyber_core/log.rb

@@ -1,14 +1,13 @@
-
 module LyberCore
-
   class LyberCore::Log
     require 'logger'
 
     # Default values
-    DEFAULT_LOGFILE = "/tmp/lybercore_log.log" # TODO change to STDOUT?
+    DEFAULT_LOGFILE = '/tmp/lybercore_log.log'.freeze # TODO change to STDOUT?
     DEFAULT_LOG_LEVEL = Logger::INFO
-    DEFAULT_FORMATTER = proc{|s,t,p,m|"%5s [%s] (%s) %s :: %s\n" % [s,
-                       t.strftime("%Y-%m-%d %H:%M:%S"), $$, p, m]}
+    DEFAULT_FORMATTER = proc do |s, t, p, m|
+      "%5s [%s] (%s) %s :: %s\n" % [s, t.strftime('%Y-%m-%d %H:%M:%S'), $$, p, m]
+    end
 
     # Initial state
     @@logfile = DEFAULT_LOGFILE
@@ -27,27 +26,22 @@ module LyberCore
 
     # The current location of the logfile
     def Log.logfile
-      return @@logfile
+      @@logfile
     end
 
-
-
     # Accepts a filename as an argument, and checks to see whether that file can be
     # opened for writing. If it can be opened, it closes the existing Logger object
     # and re-opens it with the new logfile location. It raises an exception if it
     # cannot write to the specified logfile.
     def Log.set_logfile(new_logfile)
-      begin
-        current_log_level = @@log.level
-        current_formatter = @@log.formatter
-        @@log = Logger.new(new_logfile)
-        @@logfile = new_logfile
-        @@log.level = current_log_level
-        @@log.formatter = current_formatter
-      rescue Exception => e
-        raise e, "Couldn't initialize logfile #{new_logfile} because\n#{e.message}: #{e.backtrace.join(%{\n})}}"
-      end
-
+      current_log_level = @@log.level
+      current_formatter = @@log.formatter
+      @@log = Logger.new(new_logfile)
+      @@logfile = new_logfile
+      @@log.level = current_log_level
+      @@log.formatter = current_formatter
+    rescue Exception => e
+      raise e, "Couldn't initialize logfile #{new_logfile} because\n#{e.message}: #{e.backtrace.join(%(\n))}}"
     end
 
     # Set the log level.
@@ -59,18 +53,16 @@ module LyberCore
     #   Logger::INFO (1): generic (useful) information about system operation
     #   Logger::DEBUG (0):  low-level information for developers
     def Log.set_level(loglevel)
-     begin
-        if [0,1,2,3,4].include? loglevel
-          @@log.level = loglevel
-          @@log.debug "Setting LyberCore::Log.level to #{loglevel}"
-        else
-          @@log.warn "I received an invalid option for log level. I expected a number between 0 and 4 but I got #{loglevel}"
-          @@log.warn "I'm setting the loglevel to 0 (debug) because you seem to be having trouble."
-          @@log.level = 0
-        end
-      rescue Exception => e
-        raise e, "Couldn't set log level because\n#{e.message}: #{e.backtrace.join(%{\n})}"
+      if [0, 1, 2, 3, 4].include? loglevel
+        @@log.level = loglevel
+        @@log.debug "Setting LyberCore::Log.level to #{loglevel}"
+      else
+        @@log.warn "I received an invalid option for log level. I expected a number between 0 and 4 but I got #{loglevel}"
+        @@log.warn "I'm setting the loglevel to 0 (debug) because you seem to be having trouble."
+        @@log.level = 0
       end
+    rescue Exception => e
+      raise e, "Couldn't set log level because\n#{e.message}: #{e.backtrace.join(%(\n))}"
     end
 
     # Return the current log level
@@ -105,10 +97,7 @@ module LyberCore
 
     def Log.exception_message(e)
       msg = e.inspect.split($/).join('; ') + "\n"
-      msg << e.backtrace.join("\n") if(e.backtrace)
+      msg << e.backtrace.join("\n") if e.backtrace
     end
-
   end
-
-
-end
+end

data/lib/lyber_core/return_state.rb

@@ -1,38 +1,36 @@
 # this object defines the allowed states robots can optionally return upon completion
-# if the return value of the "perform" step is an object of this type and the status value is set an allowed value, 
+# if the return value of the "perform" step is an object of this type and the status value is set an allowed value,
 #  it will be used to set the final workflow state for that druid
 module LyberCore
   module Robot
     class ReturnState
-      
       attr_reader :status
       attr_accessor :note
-      ALLOWED_RETURN_STATES = %w{completed skipped waiting}
-      DEFAULT_RETURN_STATE  = 'completed'
-      
+      ALLOWED_RETURN_STATES = %w[completed skipped waiting].freeze
+      DEFAULT_RETURN_STATE  = 'completed'.freeze
+
       def self.SKIPPED
-        self.new(status: 'skipped')
+        new(status: 'skipped')
       end
 
       def self.COMPLETED
-        self.new(status: 'completed')
+        new(status: 'completed')
       end
 
       def self.WAITING
-        self.new(status: 'waiting')
+        new(status: 'waiting')
       end
 
       def initialize(params = {})
         self.status = params[:status] || DEFAULT_RETURN_STATE
-        self.note = params[:note] || ""
+        self.note = params[:note] || ''
       end
-      
+
       def status=(value)
         state = value.to_s.downcase
         raise 'invalid return state' unless ALLOWED_RETURN_STATES.include? state
         @status = state
       end
-            
     end
   end
 end

data/lib/lyber_core/robot.rb

@@ -5,25 +5,20 @@ require 'active_support/core_ext/string/inflections' # camelcase
 
 module LyberCore
   module Robot
-
     # Add the ClassMethods to the class this is being mixed into
-    def self.included base
+    def self.included(base)
       base.extend ClassMethods
     end
 
     module ClassMethods
-
       # Called by job-manager on derived-class
       # Instantiate the Robot and call #work with the passed in druid
       def perform(druid)
-        # Get the name of the derived-class that was invoked
-        klazz = self.name.split('::').inject(Object) {|o,c| o.const_get c}
-        bot = klazz.new
+        bot = new
         bot.work druid
       end
     end
 
-    
     # Converts a given step to the Robot class name
     # Examples:
     #
@@ -35,15 +30,15 @@ module LyberCore
     # @param [Hash] opts
     # @option :repo_suffix defaults to `Repo`
     # @return [String] The class name for the robot, e.g., `Robots::DorRepo::Accession:DescriptiveMetadata`
-    def self.step_to_classname step, opts = {}
+    def self.step_to_classname(step, opts = {})
       # generate the robot job class name
       opts[:repo_suffix] ||= 'Repo'
       r, w, s = step.split(/:/, 3)
-      return [
+      [
         'Robots',
         r.camelcase + opts[:repo_suffix], # 'Dor' conflicts with dor-services
         w.sub('WF', '').camelcase,
-        s.gsub('-', '_').camelcase
+        s.tr('-', '_').camelcase
       ].join('::')
     end
 
@@ -51,7 +46,7 @@ module LyberCore
     attr_reader :workflow_service
 
     def initialize(repo, workflow_name, step_name, opts = {})
-      Signal.trap("QUIT") { puts "#{Process.pid} ignoring SIGQUIT" } # SIGQUIT ignored to let the robot finish
+      Signal.trap('QUIT') { puts "#{Process.pid} ignoring SIGQUIT" } # SIGQUIT ignored to let the robot finish
       @repo = repo
       @workflow_name = workflow_name
       @step_name = step_name
@@ -62,54 +57,49 @@ module LyberCore
     # Sets up logging, timing and error handling of the job
     # Calls the #perform method, then sets workflow to 'completed' or 'error' depending on success
     def work(druid)
-      LyberCore::Log.set_logfile($stdout)                     # let process manager(bluepill) handle logging
+      LyberCore::Log.set_logfile($stdout) # let process manager(bluepill) handle logging
       LyberCore::Log.info "#{druid} processing"
       return if @check_queued_status && !item_queued?(druid)
 
       result = nil
       elapsed = Benchmark.realtime do
-        result = self.perform druid                                    # implemented in the mixed-in robot class
+        result = perform druid # implemented in the mixed-in robot class
       end
 
       # this is the default note to pass back to workflow service, but it can be overriden by a robot that uses the Lybercore::Robot::ReturnState object to return a status
       note = Socket.gethostname
-      
-      # the final workflow state is determined by the return value of the perform step, if it is a ReturnState object, 
+
+      # the final workflow state is determined by the return value of the perform step, if it is a ReturnState object,
       # we will use the defined status, otherwise default to completed
       # if a note is passed back, we will also use that instead of the default
       if result.class == LyberCore::Robot::ReturnState
         workflow_state = result.status
         note = result.note unless result.note.blank?
       else
-        workflow_state = 'completed'  
+        workflow_state = 'completed'
       end
-      
-      # update the workflow status from its current state to the state returned by perform (or 'completed' as the default) 
-      workflow_service.update_workflow_status @repo, druid, @workflow_name, @step_name, workflow_state, :elapsed => elapsed, :note => note
-      LyberCore::Log.info "Finished #{druid} in #{sprintf("%0.4f",elapsed)}s"
 
-    rescue => e
+      # update the workflow status from its current state to the state returned by perform (or 'completed' as the default)
+      workflow_service.update_workflow_status(@repo, druid, @workflow_name, @step_name, workflow_state, elapsed: elapsed, note: note)
+      LyberCore::Log.info "Finished #{druid} in #{sprintf('%0.4f', elapsed)}s"
+    rescue StandardError => e
       Honeybadger.notify(e) if defined? Honeybadger
       begin
         LyberCore::Log.error e.message + "\n" + e.backtrace.join("\n")
-        workflow_service.update_workflow_error_status @repo, druid , @workflow_name, @step_name, e.message, :error_text => Socket.gethostname
-      rescue => e2
+        workflow_service.update_workflow_error_status(@repo, druid, @workflow_name, @step_name, e.message, error_text: Socket.gethostname)
+      rescue StandardError => e2
         LyberCore::Log.error "Cannot set #{druid} to status='error'\n" + e2.message + "\n" + e2.backtrace.join("\n")
         raise e2 # send exception to Resque failed queue
       end
     end
 
-    private
+  private
 
     def item_queued?(druid)
       status = workflow_service.get_workflow_status(@repo, druid, @workflow_name, @step_name)
-      if(status =~ /queued/i)
-        return true
-      else
-        LyberCore::Log.warn "Item is not queued, but has status of '#{status}'. Will skip processing"
-        return false
-      end
+      return true if status =~ /queued/i
+      LyberCore::Log.warn "Item is not queued, but has status of '#{status}'. Will skip processing"
+      false
     end
-
   end
 end

data/lib/tasks/rdoc.rake

@@ -1,5 +1,5 @@
-desc "Generate RDoc"
-task :doc => ['doc:generate']
+desc 'Generate RDoc'
+task doc: ['doc:generate']
 
 namespace :doc do
   project_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
@@ -10,23 +10,22 @@ namespace :doc do
     require 'yard/rake/yardoc_task'
 
     YARD::Rake::YardocTask.new(:generate) do |yt|
-      yt.files   =  Dir.glob(File.join(project_root, 'lib', '*.rb')) + 
+      yt.files   =  Dir.glob(File.join(project_root, 'lib', '*.rb')) +
                     Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
-                   [ File.join(project_root, 'README.rdoc') ] +
-                   [ File.join(project_root, 'LICENSE') ]
-                   
+                    [File.join(project_root, 'README.rdoc')] +
+                    [File.join(project_root, 'LICENSE')]
+
       yt.options = ['--output-dir', doc_destination, '--readme', 'README.rdoc']
     end
   rescue LoadError
-    desc "Generate YARD Documentation"
+    desc 'Generate YARD Documentation'
     task :generate do
-      abort "Please install the YARD gem to generate rdoc."
+      abort 'Please install the YARD gem to generate rdoc.'
     end
   end
 
-  desc "Remove generated documenation"
+  desc 'Remove generated documenation'
   task :clean do
-    rm_r doc_destination if File.exists?(doc_destination)
+    rm_r doc_destination if File.exist?(doc_destination)
   end
-
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyber-core
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.4
 platform: ruby
 authors:
 - Alpana Pande
@@ -16,8 +16,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dor-workflow-service
   requirement: !ruby/object:Gem::Requirement
@@ -39,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -134,6 +162,7 @@ files:
 - LICENSE
 - README.md
 - lib/lyber_core.rb
+- lib/lyber_core/base.rb
 - lib/lyber_core/log.rb
 - lib/lyber_core/return_state.rb
 - lib/lyber_core/robot.rb
@@ -158,8 +187,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Core services used by the SUL Digital Library
 test_files: []
+has_rdoc: