triggered_job 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06090aceac8ddf14aa47eedc5ce765784bfb1a05
-  data.tar.gz: 6edc2977e3a093fba700a4c8389e1525a7a6629f
+  metadata.gz: cc9e1201d81e4cdc7758f504eb7ffcb95e880a7e
+  data.tar.gz: 18962f87a51fceeaf4a935a0b8ca60217f31b903
 SHA512:
-  metadata.gz: aba73525fbfba8cee97cf9feab3557ba063ceaf898585616fc5757441bf15d28096f29346fc34bf47756cfb60a5bf46808cca9f94f185f4615a0f4b548320168
-  data.tar.gz: a78e546fcf8327dc9d361e0a182864e549856f00d20cd853c85a9e9be75a69eee33198c3cb5f214a5fd63bbe469110cb34700a90fcca402ec1119a6d7fed59fa
+  metadata.gz: 638ac7bf06ecf8f036b3987bdd75037f9a654375a210a21ef85ec92959914d54b77ed5244a6d1531aa48a59795ff0ce6a796ec8316f774d950972fc5322c94cf
+  data.tar.gz: b9efde17de7bcbb37b82890335ec3cb1fc74367616a469ccc8ef1f71b8e67ef28bfa3936966b6bbdc8562c3955f83b427cb299803f0539a395d8f29d04bef8dd

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    triggered_job (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.2)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 11.0)
+  rspec (~> 3.5)
+  simplecov (~> 0.12)
+  triggered_job!
+
+BUNDLED WITH
+   1.13.5

data/README.md

@@ -20,7 +20,7 @@ end
 class MyTriggeredJob < BaseJob
   triggered_by "my_trigger"
 
-  def perform(id, args*)
+  def perform(id, *args)
     # ...
   end
 end

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec
+

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/triggered_job/base.rb

@@ -0,0 +1,10 @@
+module TriggeredJob
+  class Base
+    def self.triggered_by(table: nil, field: nil)
+      raise ArgumentError, ":table argument is required" if table.nil?
+      raise ArgumentError, ":field argument is required" if field.nil?
+
+      TriggeredJob.set_trigger([table, field].join("__"), self)
+    end
+  end
+end

data/lib/triggered_job/version.rb

@@ -0,0 +1,3 @@
+module TriggeredJob
+  VERSION = "0.0.2".freeze unless defined?(TriggeredJob::VERSION)
+end

data/lib/triggered_job.rb

@@ -0,0 +1,25 @@
+require "triggered_job/base"
+
+module TriggeredJob
+  @triggered_jobs = {}
+
+  def self.set_trigger(trigger, klass)
+    raise ArgumentError, "trigger cannot be null" if trigger.nil?
+    raise ArgumentError, "klass cannot be null" if klass.nil?
+    raise ArgumentError, "klass must be a Class" unless klass.is_a?(Class)
+
+    if @triggered_jobs.key?(trigger) && !@triggered_jobs[trigger].empty?
+      @triggered_jobs[trigger] << klass.to_s
+    else
+      @triggered_jobs[trigger] = [klass.to_s]
+    end
+  end
+
+  def self.clear
+    @triggered_jobs = {}
+  end
+
+  def self.triggered_by(trigger)
+    @triggered_jobs[trigger]
+  end
+end

data/spec/lib/triggered_job/base_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require "support/constant_helpers"
+
+RSpec.describe TriggeredJob::Base do
+  describe ".triggered_by" do
+    context "missing required attributes" do
+      it "raises exception when missing :table" do
+        begin
+          expect {
+            class A < TriggeredJob::Base
+              triggered_by field: "my_field"
+            end
+          }.to raise_error(ArgumentError, /table/)
+        ensure
+          remove_constants :A
+        end
+      end
+
+      it "raises exception when missing :field" do
+        begin
+          expect {
+            class A < TriggeredJob::Base
+              triggered_by table: "my_table"
+            end
+          }.to raise_error(ArgumentError, /field/)
+        ensure
+          remove_constants :A
+        end
+      end
+    end
+
+    it "registers table+field trigger with itself" do
+      begin
+        class A < TriggeredJob::Base
+          triggered_by table: "table", field: "field"
+        end
+
+        expect(TriggeredJob.triggered_by("table__field")).to contain_exactly("A")
+      ensure
+        TriggeredJob.clear
+        remove_constants :A
+      end 
+    end
+  end
+end

data/spec/lib/triggered_job_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+require "support/constant_helpers"
+
+RSpec.describe TriggeredJob do
+  describe ".clear" do
+    it "clears the stored triggered jobs" do
+      TriggeredJob.set_trigger("alpha", Struct)
+
+      expect(TriggeredJob.triggered_by("alpha")).to contain_exactly("Struct")
+      TriggeredJob.clear
+
+      expect(TriggeredJob.triggered_by("alpha")).to be nil
+    end
+  end
+
+  describe ".triggered_by" do
+    it "returns groups of class names by trigger" do
+      begin
+        class A; end
+        class B; end
+        class C; end
+        TriggeredJob.set_trigger("alpha", A)
+        TriggeredJob.set_trigger("alpha", B)
+        TriggeredJob.set_trigger("beta", C)
+
+        expect(TriggeredJob.triggered_by("alpha")).to contain_exactly("A", "B")
+        expect(TriggeredJob.triggered_by("beta")).to contain_exactly("C") 
+      ensure
+        TriggeredJob.clear
+        remove_constants :A, :B, :C
+      end
+    end
+  end
+
+  describe ".set_trigger" do
+    context "with both parameters" do
+      it "does not throw an exception" do
+        begin
+          class A; end
+
+          expect { TriggeredJob.set_trigger("alpha", A) }.not_to raise_error
+        ensure
+          TriggeredJob.clear
+          remove_constants :A
+        end
+      end
+    end
+
+    context "invalid parameters" do
+      it "throws exception when trigger is nil" do
+        begin
+          class A; end
+
+          expect { TriggeredJob.set_trigger(nil, A ) }.to raise_error(ArgumentError, /[t|T]rigger.*null/)
+        ensure
+          TriggeredJob.clear
+          remove_constants :A
+        end
+      end
+
+      it "throws exception when klass is nil" do
+        begin
+          expect { TriggeredJob.set_trigger("error", nil) }.to raise_error(ArgumentError, /[k|K]lass.*null/)
+        ensure
+          TriggeredJob.clear
+        end
+      end
+
+      it "throws exception when klass is not a class" do
+        begin
+          expect { TriggeredJob.set_trigger("error", "class") }.to raise_error(ArgumentError, /[c|C]lass/)
+        ensure
+          TriggeredJob.clear
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec"
+end
+
+require "triggered_job"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # 
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/constant_helpers.rb

@@ -0,0 +1,11 @@
+module ConstantHelpers
+  def remove_constants(*constants)
+    constants.each { |const| Object.send(:remove_const, const) }
+  rescue NameError => e
+    $stderr.puts "Warning from ConstantHelpers::remove_constants:\n\t#{e}"
+  end
+end
+
+RSpec.configure do |config|
+  config.include ConstantHelpers
+end

data/triggered_job.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "triggered_job/version"
+
+Gem::Specification.new do |s|
+  s.name = "triggered_job"
+  s.version = TriggeredJob::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.date = "2016-10-18"
+  s.author = "Daniel Hanson"
+  s.email = "hansondr@gmail.com"
+  s.homepage = "https://github.com/hansondr/triggered_job"
+  s.license = "MIT"
+  s.summary = "Simple framework for trigger-based jobs"
+  s.description = "Simple framework for trigger-based jobs"
+
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "simplecov", "~> 0.12"
+  s.add_development_dependency "rake", "~> 11.0"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: triggered_job
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Hanson
@@ -58,8 +58,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
+- bin/rspec
+- lib/triggered_job.rb
+- lib/triggered_job/base.rb
+- lib/triggered_job/version.rb
+- spec/lib/triggered_job/base_spec.rb
+- spec/lib/triggered_job_spec.rb
+- spec/spec_helper.rb
+- spec/support/constant_helpers.rb
+- triggered_job.gemspec
 homepage: https://github.com/hansondr/triggered_job
 licenses:
 - MIT
@@ -84,4 +98,8 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple framework for trigger-based jobs
-test_files: []
+test_files:
+- spec/lib/triggered_job/base_spec.rb
+- spec/lib/triggered_job_spec.rb
+- spec/spec_helper.rb
+- spec/support/constant_helpers.rb