acidic_job 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9878e2b82544c04809b49366f27eafcbe28683c39ca877fb99b9649c4bd4dcdd
-  data.tar.gz: b04206a126a00f84caeb255a6a3bb6542001a6a700345edfd45fe68d39b3fcdd
+  metadata.gz: 9681eb2a123d15b96ea8666da752886f1e8365f4be846cef4a2597299378ae37
+  data.tar.gz: 83c1a7cafb42e833352f9c919d96d1d2e46e2e22830952dacb468102307f4bc0
 SHA512:
-  metadata.gz: 7d7928c276825f884387a6010cf57e1fc2b04f17e657c230c5d6909e8430445dfb903018643812255100ac8fdbf7dfe20fae0f5d194089aa003c7f6b4c996830
-  data.tar.gz: befa1e96050d612cb42fff983b751f8f04dada4f5ccd5ac81ba0190807f69e6961d1a19bdb6df06bce0e2252c60bac5dd0a37c202afa5c1f03942d46ff469828
+  metadata.gz: 1662be5778950bfd429798568aa115c294f992a9dbe530559e9f2f0093f5a767eee5667507f771148ec596a64c78be7a19d55b2965c52a1a94fdc6ae39d3562c
+  data.tar.gz: ac8b78d17d4772af7ef4661e4d7aef3b2686c73485e3809ad72dad0ab5cd3c08e630b605a294adcf49f89766ebbbc6b28dd70d0ccbae559afabf3599a744e342

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.5
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -6,6 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
+.DS_Store
+/test/database.sqlite

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/.ruby_version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -7,6 +7,16 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "rspec", "~> 3.0"
+gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.7"
+
+gem "activerecord", "~> 6.1.3.2"
+
+gem "activejob", "~> 6.1.3.2"
+
+gem "sqlite3"
+
+gem "database_cleaner"
+
+gem "simplecov"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    acidic_job (0.1.2)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    docile (1.4.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-17
+
+DEPENDENCIES
+  acidic_job!
+  activejob (~> 6.1.3.2)
+  activerecord (~> 6.1.3.2)
+  database_cleaner
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   2.2.5

data/README.md

@@ -26,7 +26,7 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
 
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[test rubocop]

data/acidic_job.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Idempotent operations for Rails apps, built on top of ActiveJob."
   spec.homepage      = "https://github.com/fractaledmind/acidic_job"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/fractaledmind/acidic_job"
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport'
+  spec.add_dependency "activesupport"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/acidic_job.rb

@@ -4,7 +4,9 @@ require_relative "acidic_job/version"
 require_relative "acidic_job/no_op"
 require_relative "acidic_job/recovery_point"
 require_relative "acidic_job/response"
+require "active_support/concern"
 
+# rubocop:disable Metrics/ModuleLength, Style/Documentation, Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 module AcidicJob
   class IdempotencyKeyRequired < StandardError; end
 
@@ -26,6 +28,13 @@ module AcidicJob
 
   included do
     attr_reader :key
+
+    # discard_on MismatchedIdempotencyKeyAndJobArguments
+    # discard_on UnknownRecoveryPoint
+    # discard_on UnknownAtomicPhaseType
+    # discard_on MissingRequiredAttribute
+    # retry_on LockedIdempotencyKey
+    # retry_on ActiveRecord::SerializationFailure
   end
 
   class_methods do
@@ -52,10 +61,11 @@ module AcidicJob
   # something like the Shannon entropy equation.
   IDEMPOTENCY_KEY_MIN_LENGTH = 20
 
-  def idempotently(key:, with:) # &block
+  # &block
+  def idempotently(key:, with:)
     # set accessors for each argument passed in to ensure they are available
     # to the step methods the job will have written
-    set_accessors_for_passed_arguments(with)
+    define_accessors_for_passed_arguments(with)
 
     validate_passed_idempotency_key(key)
     validate_passed_arguments(with)
@@ -68,7 +78,7 @@ module AcidicJob
 
     # find or create an AcidicJobKey record to store all information about this job
     # side-effect: will set the @key instance variable
-    ensure_idempotency_key_record(key, params, defined_steps.first)
+    ensure_idempotency_key_record(key, with[:params], defined_steps.first)
 
     # if the key record is already marked as finished, immediately return its result
     return @key.succeeded? if @key.finished?
@@ -109,17 +119,15 @@ module AcidicJob
       ActiveRecord::Base.transaction(isolation: :read_uncommitted) do
         phase_result = phase_callable.call
 
-        if phase_result.is_a?(NoOp) || phase_result.is_a?(RecoveryPoint) || phase_result.is_a?(Response)
-          key ||= @key
-          phase_result.call(key: key)
-        else
-          raise UnknownAtomicPhaseType
-        end
+        raise UnknownAtomicPhaseType unless phase_result.is_a?(NoOp) ||
+                                            phase_result.is_a?(RecoveryPoint) ||
+                                            phase_result.is_a?(Response)
+
+        # TODO: why is this here?
+        key ||= @key
+        phase_result.call(key: key)
       end
-    rescue MismatchedIdempotencyKeyAndJobArguments, LockedIdempotencyKey, UnknownRecoveryPoint, UnknownAtomicPhaseType, MissingRequiredAttribute, ActiveRecord::SerializationFailure => e
-      error = e
-      raise e
-    rescue => e
+    rescue StandardError => e
       error = e
       raise e
     ensure
@@ -127,8 +135,8 @@ module AcidicJob
       # key right away so that another request can try again.
       if error && !key.nil?
         begin
-          key.update(locked_at: nil, error_object: error)
-        rescue => e
+          key.update_columns(locked_at: nil, error_object: error)
+        rescue StandardError => e
           # We're already inside an error condition, so swallow any additional
           # errors from here and just send them to logs.
           puts "Failed to unlock key #{key.id} because of #{e}."
@@ -144,21 +152,15 @@ module AcidicJob
       if @key
         # Programs enqueuing multiple jobs with different parameters but the
         # same idempotency key is a bug.
-        if @key.job_args != params.as_json
-          raise MismatchedIdempotencyKeyAndJobArguments
-        end
+        raise MismatchedIdempotencyKeyAndJobArguments if @key.job_args != params.as_json
 
         # Only acquire a lock if the key is unlocked or its lock has expired
         # because the original job was long enough ago.
-        if @key.locked_at && @key.locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT
-          raise LockedIdempotencyKey
-        end
+        raise LockedIdempotencyKey if @key.locked_at && @key.locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT
 
         # Lock the key and update latest run unless the job is already
         # finished.
-        if !@key.finished?
-          @key.update!(last_run_at: Time.current, locked_at: Time.current)
-        end
+        @key.update!(last_run_at: Time.current, locked_at: Time.current) unless @key.finished?
       else
         @key = AcidicJobKey.create!(
           idempotency_key: key_val,
@@ -175,9 +177,11 @@ module AcidicJob
     end
   end
 
-  def set_accessors_for_passed_arguments(passed_arguments)
+  def define_accessors_for_passed_arguments(passed_arguments)
     passed_arguments.each do |accessor, value|
-      self.class.attr_accessor accessor
+      # the reader method may already be defined
+      self.class.attr_reader accessor unless respond_to?(accessor)
+      # but we should always update the value to match the current value
       instance_variable_set("@#{accessor}", value)
     end
 
@@ -198,7 +202,8 @@ module AcidicJob
 
     return if missing_attributes.empty?
 
-    raise MissingRequiredAttribute, "The following required job parameters are missing: #{missing_attributes.to_sentence}"
+    raise MissingRequiredAttribute,
+          "The following required job parameters are missing: #{missing_attributes.to_sentence}"
   end
 
   def define_atomic_phases(defined_steps)
@@ -219,3 +224,4 @@ module AcidicJob
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength, Style/Documentation, Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/acidic_job/no_op.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Represents an action to perform a no-op. One possible option for a return
 # from an #atomic_phase block.
 class NoOp

data/lib/acidic_job/recovery_point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Represents an action to set a new recovery point. One possible option for a
 # return from an #atomic_phase block.
 class RecoveryPoint

data/lib/acidic_job/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Represents an action to set a new API response (which will be stored onto an
 # idempotency key). One  possible option for a return from an #atomic_phase
 # block.

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,11 +31,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
+- ".ruby_version"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -62,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.circleci/config.yml

@@ -1,13 +0,0 @@
-version: 2.1
-jobs:
-  build:
-    docker:
-      - image: ruby:2.7.1
-    steps:
-      - checkout
-      - run:
-          name: Run the default task
-          command: |
-            gem install bundler -v 2.2.5
-            bundle install
-            bundle exec rake

data/.rspec

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