ruby-clock 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aecbbec2f68af72734fdb4daed9bbe35b47b3b012a2074915241eac7f8b6c40a
-  data.tar.gz: 3bef0b2f87eb30ca32e5cd142249ef7a4ef1c34deb2714dc76cb2ecab3754600
+  metadata.gz: e0fec8d8c66e1783260e73fad69f39572677871d722d1c62437c94741452340e
+  data.tar.gz: 03e5b84ef4cd5277da5623173ca70887dc3aac0296445e573459050341376b78
 SHA512:
-  metadata.gz: 9cb10c6514f7e28394632e6fbd76b19e2666ede782cf344918aeea3eaa368e318b7ee3135b7c252208c8f0090657b629cd469eaa704b0b908ce34fa213735213
-  data.tar.gz: 943997440dfb369138ad5084497dbdd76504d030d58c5508eced067930205171089518a752b42a3b7cf398dc5560a9ab8ecb70b0dc01f35188c3380853a23738
+  metadata.gz: 70134452766d69a5dbebc795cc31babb56ac14b6363aa6416379600fb6fa0546ccc9b131a17342b1376a101acc89ae746a1f9f19795274224a72e9291f9f6eba
+  data.tar.gz: 4aeb5e68d8108f40e10c11b4ea9fe4a3ad390ba4652afcc4e71cbc11c8c49b36be3f4c8b762f17eda1cffc488f1d5b803388bfb5f3e219962c289dd581549f81

data/Gemfile.lock

@@ -1,21 +1,23 @@
 PATH
   remote: .
   specs:
-    ruby-clock (0.4.0)
-      rufus-scheduler (~> 3.7)
+    ruby-clock (0.6.0)
+      method_source
+      rufus-scheduler (~> 3.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     et-orbi (1.2.4)
       tzinfo
-    fugit (1.4.1)
+    fugit (1.5.0)
       et-orbi (~> 1.1, >= 1.1.8)
       raabro (~> 1.4)
+    method_source (1.0.0)
     raabro (1.4.0)
     rake (12.3.3)
-    rufus-scheduler (3.7.0)
+    rufus-scheduler (3.8.0)
       fugit (~> 1.1, >= 1.1.6)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -102,6 +102,63 @@ You can define before, after, and around callbacks which will run for all jobs.
 Read [the rufus-scheduler documentation](https://github.com/jmettraux/rufus-scheduler/#callbacks)
 to learn how to do this. Where the documentation references `s`, you should use `schedule`.
 
+### Job Identifier
+
+ruby-clock adds the `identifier` method to `Rufus::Scheduler::Job`. This method will return the job's
+[name](https://github.com/jmettraux/rufus-scheduler/#name--string) if one was given.
+If a name is not given, the last non-comment code line in the job's block
+will be used instead. If for some reason an error is encountered while calculating this, the next
+fallback is the line number of the job in Clockfile.
+
+Some examples of jobs and their identifiers:
+
+```ruby
+schedule.every '1 second', name: 'my job' do |variable|
+  Foo.bar
+end
+# => my job
+
+schedule.every '1 day', name: 'my job' do |variable|
+  daily_things = Foo.setup_daily
+  daily_things.process
+  # TODO: figure out best time of day
+end
+# => daily_things.process
+
+# n.b. ruby-clock isn't yet smart enough to remove trailing comments
+schedule.every '1 week', name: 'my job' do |variable|
+  weekly_things = Foo.setup_weekly
+  weekly_things.process # does this work???!1~
+end
+# => weekly_things.process # does this work???!1~
+```
+
+This can be used for keeping track of job behavior in logs or a
+stats tracker. For example:
+
+```ruby
+def schedule.on_post_trigger(job, trigger_time)
+  duration = Time.now-trigger_time.to_t
+  StatsTracker.value('Clock: Job Execution Time', duration.round(2))
+  StatsTracker.value("Clock: Job #{job.identifier} Execution Time", duration.round(2))
+  StatsTracker.increment('Clock: Job Executions')
+end
+
+schedule.every '10 seconds', name: 'thread stats' do
+  thread_usage = Hash.new(0)
+  schedule.work_threads(:active).each do |t|
+    thread_usage[t[:rufus_scheduler_job].identifier] += 1
+  end
+  thread_usage.each do |job, count|
+    StatsTracker.value("Clock: Job #{job} Active Threads", count)
+  end
+
+  StatsTracker.value("Clock: Active Threads", schedule.work_threads(:active).size)
+  StatsTracker.value("Clock: Vacant Threads", schedule.work_threads(:vacant).size)
+  StatsTracker.value("Clock: DB Pool Size", ActiveRecord::Base.connection_pool.connections.size)
+end
+```
+
 ### other rufus-scheduler Options
 
 All rufus-scheduler options are set to defaults. The `schedule` variable

data/exe/clock

@@ -1,6 +1,20 @@
 #!/usr/bin/env ruby
 
 require 'ruby-clock'
+require 'method_source'
+
+class Rufus::Scheduler::Job
+  def identifier
+    @identifier ||= begin
+      name || handler.source.split("\n").reject(&:empty?).grep_v(/#.*/)[-2].strip
+    rescue
+      source_location.join('-')
+    rescue
+      'error-calculating-job-identifier'
+    end
+  end
+end
+
 include RubyClock
 
 listen_to_signals

data/lib/ruby-clock/version.rb

@@ -1,3 +1,3 @@
 module RubyClock
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/ruby-clock.gemspec

@@ -29,5 +29,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rufus-scheduler", '~> 3.7'
+  spec.add_dependency "rufus-scheduler", '~> 3.8'
+  spec.add_dependency "method_source"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-clock
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - John Bachir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  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'
 description:
 email:
 - j@jjb.cc
@@ -65,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A "clock" process for invoking ruby code within a persistent runtime