active_model-jobs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b425410108badbd825b1d7abf39fa6c95e0af10
-  data.tar.gz: 23282f539b1055e3009985dc473f15463527ae9d
+  metadata.gz: 3498758a1e49f162cf4ac307c59fcc514f84cf4b
+  data.tar.gz: d6cfb41f2ea4efa81fd306bafd2f7e0bf48feac1
 SHA512:
-  metadata.gz: 49d7d44acac33e64ea7d3ea22b5e9915cb58e20522659870b2efff77dabf883f73c9607285a052a2c5ee3d4a9396805cd5662a77ff9fca365782fbd6e6e2a654
-  data.tar.gz: 791e870af887280896309501e6c16dbb9cef9318ff8f4297879c21d3bb6c218b71f5544aac6a745653ada7d22b45fdde40954cf183fb25aaf231a6004a81da47
+  metadata.gz: 56cf8488a7d852d7f226bf97a9213e7fa783611bb5b6b1473f11e5da8fe609dff8bbb6016c88146477b639f5ded2a65e2a060eb6363e7ca764acaf2c53da4dea
+  data.tar.gz: 6c7d2fc095551477b5f815b1569b43e20d9faf8370e948d8501b4efe17f92b3b2082d5cba94ac4bc5a3017e42a46e0ba01bbdace7231ace9d3cae21264ef1289

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
 # Don't require documentation for mocks
 Style/Documentation:
   Exclude:
-    - spec/support/mocks.rb
+    - spec/**/*
 
 # Allow any kind of string literal
 Style/StringLiterals:

data/README.md

@@ -12,25 +12,14 @@ gem 'active_model-jobs'
 
 And then execute:
 
-    $ bundle
-
-## Usage
-
-In an initializer:
-
-```ruby
-ActiveRecord::Base.send :include, ActiveModel::Jobs
+```bash
+$ bundle
 ```
 
-In your model:
-
-```ruby
-class Track < ActiveRecord::Base
-  after_commit :upload!
-end
-```
+## Usage
 
-Now, generate a job called `UploadTrackJob`:
+Given we already have a model called **Track**, generate a job
+called `UploadTrackJob`:
 
 ```ruby
 require 'aws/s3'
@@ -50,24 +39,48 @@ class UploadTrackJob < ActiveRecord::Base
 end
 ```
 
-You can also call `track.upload!` to kick off the job on demand.
+Now, you can kick off that job by calling its "action method" on your
+model:
+
+```ruby
+class Track < ActiveRecord::Base
+  include ActiveModel::Jobs
+
+  after_commit :upload!, on: :create
+end
+```
+
+Since this is just an instance method, you can call `track.upload!` to
+kick off the job at any time outside of the callback lifecycle.
 
+### Global Inclusion
 
-## Development
+You can include this module in every ActiveRecord model by inserting the
+following code into an initializer at
+**config/initializers/active_model_jobs.rb**:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+ActiveRecord::Base.send :include, ActiveModel::Jobs
+```
 
-### Contribution Guidelines
+## Development
 
-All contributions must be made in a pull request and include
-accompanying tests. Pull requests will not be merged until they pass the
-CI build for all supported Ruby and Rails versions.
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/active_model-jobs/fork )
+1. Fork it ( https://github.com/tubbo/active_model-jobs/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+All contributions must be made in a pull request and include accompanying tests.
+Pull requests will not be merged until they pass the CI build for all supported
+Ruby and Rails versions. 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` to create a git
+tag for the version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+Also see our [Code of Conduct](https://github.com/tubbo/active_model-jobs/blob/master/CODE_OF_CONDUCT.md).

data/lib/active_model/jobs.rb

@@ -1,5 +1,7 @@
+require "active_support/all"
 require "active_model"
 require "active_model/jobs/version"
+require "active_model/jobs/performer"
 
 module ActiveModel
   # Include this module into your model to take advantage of
@@ -8,51 +10,27 @@ module ActiveModel
   #
   # @api public
   module Jobs
-    # @type [RegExp]
-    BANG = /!\Z/
-
     # Call +perform_later+ on an ActiveJob class corresponding to an
-    # undefined action method name.
+    # undefined action method name. Most of the work here is done in the
+    # +Performer+ class, which takes care of discoevering whether the
+    # method passed in corresponds to a given job or whether we should
+    # just delegate back to +ActiveRecord::Base+. This method will
+    # prevent a new +Perfomer+ class from being instantiated for every
+    # method call by using a guard clause to check whether the method is
+    # an action method before proceeding on further checks.
     #
     # @throws NoMethodError if no job matches the action method
     def method_missing(method, *arguments)
-      return super unless respond_to? method
-      job_for(method).perform_later(self)
-    end
-
-    # Test whether the action method exists on this class.
-    #
-    # @returns [FalseClass] if the method does not end in a '!'
-    # @returns [FalseClass] if the method does not correspond to a job
-    # @returns [TrueClass] if a job with a corresponding name is found
-    def respond_to?(method)
-      method_for_job?(method) || super
+      performer = job_performer(method)
+      return super unless performer.present?
+      performer.call self
     end
 
     private
 
-    def method_for_job?(method)
-      return false unless method.to_s =~ BANG
-      job_for(method).present?
-    end
-
-    def job_for(method)
-      job_name(method).classify.constantize
-    rescue LoadError
-      logger.debug "#{job_name(method)} is not defined"
-      nil
-    end
-
-    def job_name(method)
-      [
-        job_action_name(method.to_s),
-        model_name,
-        'job'
-      ].join '_'
-    end
-
-    def job_action_name(method)
-      method.gsub(BANG, '')
+    def job_performer(method)
+      return unless method =~ Performer::BANG
+      Performer.new method, model_name
     end
   end
 end

data/lib/active_model/jobs/performer.rb

@@ -0,0 +1,74 @@
+module ActiveModel
+  #
+  module Jobs
+    # A support class for finding the +ActiveJob::Base+ that corresponds
+    # to a given action method on a given model. When the job class is
+    # found, the action method fires off a new instance of the job.
+    #
+    # @api private
+    # @private
+    class Performer
+      # @type [RegExp]
+      BANG = /!\Z/
+
+      # @attr_reader
+      # @type [String]
+      attr_reader :method_name
+
+      # @attr_reader
+      # @type [String]
+      attr_reader :model_name
+
+      # @param [String] method_name - A method corresponding to a job.
+      # @param [String] model_name - The model we are calling this from.
+      def initialize(method_name, model_name)
+        @method_name = method_name.to_s
+        @model_name = model_name.to_s
+      end
+
+      # Tests whether this method name corresponds to a job class in the
+      # application.
+      #
+      # @returns [Boolean] whether this job exists or not
+      def job?
+        method_name =~ BANG && job_class.present?
+      end
+
+      # Attempts to find the job class for this method and return it,
+      # otherwise it returns +nil+ when encountering a +NameError+.
+      #
+      # @returns [ActiveJob::Base] a job class or nil
+      def job_class
+        job_name.classify.constantize
+      rescue NameError
+        nil
+      end
+
+      # Build the conventional job name from the given method and model.
+      # Suffix with +job+ and separate with underscores.
+      #
+      # @returns [String] the underscored job class name
+      def job_name
+        [
+          action_name, model_name, 'job'
+        ].join '_'
+      end
+
+      # Strip the '!' off of the end of the method.
+      #
+      # @returns [String]
+      def action_name
+        method_name.gsub BANG, ''
+      end
+
+      # Perform this action on the given model.
+      #
+      # @param [ActiveModel::Model]
+      # @returns [TrueClass]
+      def call(model)
+        return false unless job?
+        job_class.perform_later model
+      end
+    end
+  end
+end

data/lib/active_model/jobs/version.rb

@@ -2,6 +2,6 @@
 module ActiveModel
   module Jobs
     # @type [String]
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model-jobs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom Scott
@@ -126,6 +126,7 @@ files:
 - bin/yardoc
 - bin/yri
 - lib/active_model/jobs.rb
+- lib/active_model/jobs/performer.rb
 - lib/active_model/jobs/version.rb
 homepage: http://github.com/tubbo/active_model-jobs
 licenses: