active_model-jobs 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 3498758a1e49f162cf4ac307c59fcc514f84cf4b
-  data.tar.gz: d6cfb41f2ea4efa81fd306bafd2f7e0bf48feac1
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTUzOTg4NGI1ZGRmNTU4OTk4ZmM5YmU0NmQ2YjM2ZDY3NjUzOGQyNg==
+  data.tar.gz: !binary |-
+    MmQ4ZWRiYTg3OTlhZWZlZGY4YzlmMTU2Mzc4Y2YxMTdlZDQyMWZkMA==
 SHA512:
-  metadata.gz: 56cf8488a7d852d7f226bf97a9213e7fa783611bb5b6b1473f11e5da8fe609dff8bbb6016c88146477b639f5ded2a65e2a060eb6363e7ca764acaf2c53da4dea
-  data.tar.gz: 6c7d2fc095551477b5f815b1569b43e20d9faf8370e948d8501b4efe17f92b3b2082d5cba94ac4bc5a3017e42a46e0ba01bbdace7231ace9d3cae21264ef1289
+  metadata.gz: !binary |-
+    MmEzOTJmNjg1YWMwMjBkYjAxNjAzYTBkYmJmMzJmZTI4NGQ4YWU0Y2U2NGMx
+    M2NkMjI1NTg3ZGI5ODFjN2JiMjk1MDc1ZjViMTFlNjU5YjYwMTdkYTZiMTY2
+    NmE1OGJkNDBlYWFjZmU0NDBmNDgzMDNjNmQ2OTAxMzI1MzI5YWM=
+  data.tar.gz: !binary |-
+    YmNiZGIyOWM3MzI3OTYzNWJmYjIyY2E2NzM3NTU5NzE5Njk0NjM5ZTdjYmU0
+    NzljNTIyNGNiMGE1NWNkMGFmYjI3ZGYxMmUyNDkzYjE2NmEzNjNkN2ZkNTY0
+    MDRmMjdkMDFmOWViMjczZWIyZjFhODA3ZDVlMjkzMDEyZGRmMzM=

data/.bundle/config

@@ -0,0 +1,4 @@
+---
+BUNDLE_BIN: "./bin"
+BUNDLE_RETRY: 3
+BUNDLE_JOBS: 3

data/.travis.yml

@@ -1,5 +1,11 @@
 language: ruby
 rvm:
-  - 2.2.2
+- 2.2.2
 deploy:
-  # TODO: to rubygems
+  provider: rubygems
+  api_key:
+    secure: JQWmjd5/4zPBjt33e+ZF5+lmz7nsek6X6Q5Er06q/Qbaeak/uxCd/7hW8mP6mesh6p/OOBIYlRBOxN/GHf7/TWd+n5LrmCye18iyqGQlgwrB3ULoDqSh/GBBLp4u4zI6oBZJA3GoC5mDyDg5Mdf5ye0yVBhbfT3D9+VUyq53xrKI3B3pKztTgvZ/KzF4Gsb3UrN5R0E9Q4NZLrkIlApM517BXKnDTpk1DYZGe12FYZtgZMCkSPtiohZ5qizHDq6HK8ZgPPZ970QEu1jIFUs4luF0qKOCYhO9Yq9UWL1m+eRwa/s/j8Vyww9dPg2x9yReDWcIf0gZMKPBMgVQrnfT/YER5L0cee2XbxI6LdPwkvrx7EQwb5e2z/bzVr7IuiZrewWUTNaO7v9NnKSnS3smfbtu9gK5AYzf0X1z42vWCnCwJNYGAJd2sD1dw80zBtWf0YlonrRnXTUTdapSV3FAZBLFNHL9YNldZ9bjT3cPLhZv/ajk9eL7wOWGVRzghfUTYkTdIGQtH1nasVj99b9cuENj8HEJbnh7r8CgkpyuyZ5YjyZt+VCwCxeImPYv7uJbUlChFipdhC5NTvfIkcsDuXWWP+Va67MTchCnf+chCFD4oRLKuc9atkpSdawpvQ4T5tYiqa5nhscLm79bE2Md/VYqdgWo+JzbPOHq4MqAg4Q=
+  gem: active_model-jobs
+  on:
+    tags: true
+    repo: tubbo/active_model-jobs

data/README.md

@@ -1,6 +1,16 @@
 # ActiveModel::Jobs
 
+[![Build Status](https://travis-ci.org/tubbo/active_model-jobs.svg)](https://travis-ci.org/tubbo/active_model-jobs)
+[![Code Climate](https://codeclimate.com/github/tubbo/active_model-jobs/badges/gpa.svg)](https://codeclimate.com/github/tubbo/active_model-jobs)
+[![Test Coverage](https://codeclimate.com/github/tubbo/active_model-jobs/badges/coverage.svg)](https://codeclimate.com/github/tubbo/active_model-jobs/coverage)
+[![Inline docs](http://inch-ci.org/github/tubbo/active_model-jobs.svg?branch=master)](http://inch-ci.org/github/tubbo/active_model-jobs)
+
 A model-level interface for kicking off background jobs using ActiveJob.
+Most useful inside a Rails application, it enables you to enqueue
+ActiveJob jobs with a dynamically-generated instance method inside your
+ActiveRecord (or ActiveModel-compatible) model class.
+
+[Documentation](http://www.rubydoc.info/github/tubbo/active_model-jobs/master)
 
 ## Installation
 
@@ -44,28 +54,24 @@ model:
 
 ```ruby
 class Track < ActiveRecord::Base
-  include ActiveModel::Jobs
+  attachment :file
 
-  after_commit :upload!, on: :create
+  after_create :upload!
 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
-
-You can include this module in every ActiveRecord model by inserting the
-following code into an initializer at
-**config/initializers/active_model_jobs.rb**:
-
-```ruby
-ActiveRecord::Base.send :include, ActiveModel::Jobs
-```
-
 ## Development
 
-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.
+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.
+
+We follow a [semantic versioning](http://semver.org) guideline when
+releasing new versions. Documentation updates do not get a new version,
+it is just merged into 'master' and updated on http://rubydoc.info.
 
 ## Contributing
 

data/Rakefile

@@ -8,9 +8,10 @@ RSpec::Core::RakeTask.new :spec
 
 RuboCop::RakeTask.new :lint
 
-YARD::Rake::YardocTask.new :docs
+YARD::Rake::YardocTask.new :doc
 
 desc "Run all RuboCop lint checks and RSpec code examples"
 task test: %w(lint spec)
 
-task default: %i(test build docs release)
+# CI task.
+task default: :test

data/active_model-jobs.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
 
   spec.add_dependency "activemodel"
+  spec.add_dependency "activejob"
 end

data/bin/setup

@@ -1,7 +1,7 @@
 #!/bin/bash
+
 set -euo pipefail
 IFS=$'\n\t'
 
-bundle install
-
-# Do any other automated setup that you need to do here
+bundle check || bundle install
+./bin/rake doc

data/lib/active_model/jobs/engine.rb

@@ -0,0 +1,16 @@
+if defined? Rails
+  module ActiveModel
+    module Jobs
+      # Hooks into the host Rails application that include
+      # +ActiveModel::Jobs+ into every model that includes
+      # +ActiveModel::Model+.
+      class Engine < Rails::Engine
+        initializer 'active_model_jobs.setup' do
+          ActiveSupport.on_load :active_model do
+            ActiveModel::Model.send :include, ActiveModel::Jobs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_model/jobs/performer.rb

@@ -5,31 +5,40 @@ module ActiveModel
     # 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]
+      # Regular expression for finding a '!' at the end of a String.
       BANG = /!\Z/
 
-      # @attr_reader
-      # @type [String]
+      # The method name given to the class as a String.
+      #
+      # @attr_reader [String]
       attr_reader :method_name
 
-      # @attr_reader
-      # @type [String]
+      # The model name given to the class by +ActiveModel::Naming+.
+      #
+      # @attr_reader [String]
+      # @see http://api.rubyonrails.org/classes/ActiveModel/Naming.html
       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.
+      # @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 the given method name ends with a '!'.
+      #
+      # @return [Boolean]
+      def self.action?(method)
+        method =~ BANG
+      end
+
       # Tests whether this method name corresponds to a job class in the
       # application.
       #
-      # @returns [Boolean] whether this job exists or not
+      # @return [Boolean] whether this job exists or not
       def job?
         method_name =~ BANG && job_class.present?
       end
@@ -37,7 +46,7 @@ module ActiveModel
       # 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
+      # @return [ActiveJob::Base] a job class or nil
       def job_class
         job_name.classify.constantize
       rescue NameError
@@ -47,24 +56,24 @@ module ActiveModel
       # 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
+      # @return [String] the underscored job class name
       def job_name
-        [
-          action_name, model_name, 'job'
-        ].join '_'
+        "#{action_name}_#{model_name}_job"
       end
 
       # Strip the '!' off of the end of the method.
       #
-      # @returns [String]
+      # @return [String] '!'-stripped version of the method name.
       def action_name
         method_name.gsub BANG, ''
       end
 
       # Perform this action on the given model.
       #
-      # @param [ActiveModel::Model]
-      # @returns [TrueClass]
+      # @param [ActiveModel::Model] model The model object we are
+      # performing the job on
+      # @return [TrueClass, FalseClass] whether the job succeeded to
+      # enqueue.
       def call(model)
         return false unless job?
         job_class.perform_later model

data/lib/active_model/jobs/version.rb

@@ -1,7 +1,7 @@
-# :nodoc:
+# @see http://api.rubyonrails.org/classes/ActiveModel/Model.html
 module ActiveModel
   module Jobs
     # @type [String]
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/active_model/jobs.rb

@@ -2,13 +2,20 @@ require "active_support/all"
 require "active_model"
 require "active_model/jobs/version"
 require "active_model/jobs/performer"
+require "active_model/jobs/engine"
 
+# :nodoc:
 module ActiveModel
   # Include this module into your model to take advantage of
-  # automatically-generated :#{job_name}! action methods for any
+  # automatically-generated +:job_name!+ action methods for any
   # matching ActiveJob classes.
   #
-  # @api public
+  # @example
+  #   class MyModel < ActiveRecord::Base
+  #     include ActiveModel::Jobs
+  #
+  #     after_commit :deploy!
+  #   end
   module Jobs
     # Call +perform_later+ on an ActiveJob class corresponding to an
     # undefined action method name. Most of the work here is done in the
@@ -22,14 +29,14 @@ module ActiveModel
     # @throws NoMethodError if no job matches the action method
     def method_missing(method, *arguments)
       performer = job_performer(method)
-      return super unless performer.present?
+      return super unless performer.present? && performer.job?
       performer.call self
     end
 
     private
 
     def job_performer(method)
-      return unless method =~ Performer::BANG
+      return unless Performer.action? method
       Performer.new method, model_name
     end
   end

metadata

@@ -1,97 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: active_model-jobs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Scott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   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: activejob
+  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: Helper module for initiating ActiveJobs through an ActiveRecord model.
@@ -101,12 +115,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
+- .bundle/config
+- .env
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-version
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -126,6 +141,7 @@ files:
 - bin/yardoc
 - bin/yri
 - lib/active_model/jobs.rb
+- lib/active_model/jobs/engine.rb
 - lib/active_model/jobs/performer.rb
 - lib/active_model/jobs/version.rb
 homepage: http://github.com/tubbo/active_model-jobs
@@ -138,12 +154,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -153,4 +169,3 @@ signing_key:
 specification_version: 4
 summary: Helper module for initiating ActiveJobs through an ActiveRecord model.
 test_files: []
-has_rdoc: