activejob_backport 0.0.1

data/lib/active_job/version.rb

@@ -0,0 +1,8 @@
+require_relative 'gem_version'
+
+module ActiveJob
+  # Returns the version of the currently loaded Active Job as a <tt>Gem::Version</tt>
+  def self.version
+    gem_version
+  end
+end

data/lib/activejob_backport.rb

@@ -0,0 +1 @@
+require 'active_job'

data/lib/global_id.rb

@@ -0,0 +1,6 @@
+require 'global_id/global_id'
+
+class GlobalID
+  autoload :Locator, 'global_id/locator'
+  autoload :Identification, 'global_id/identification'
+end

data/lib/global_id/global_id.rb

@@ -0,0 +1,93 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'  # For #model_class constantize
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/object/try'          # For #find
+require 'uri'
+
+class GlobalID
+  class << self
+    attr_reader :app
+
+    def create(model, options = {})
+      app = options.fetch :app, GlobalID.app
+      raise ArgumentError, "An app is required to create a GlobalID. Pass the :app option or set the default GlobalID.app." unless app
+      new URI("gid://#{app}/#{model.class.name}/#{model.id}"), options
+    end
+
+    def find(gid, options = {})
+      parse(gid, options).try(:find, options)
+    end
+
+    def parse(gid, options = {})
+      gid.is_a?(self) ? gid : new(gid, options)
+    rescue URI::Error
+      parse_encoded_gid(gid, options)
+    end
+
+    def app=(app)
+      @app = validate_app(app)
+    end
+
+    def validate_app(app)
+      URI.parse('gid:///').hostname = app
+    rescue URI::InvalidComponentError
+      raise ArgumentError, 'Invalid app name. ' \
+        'App names must be valid URI hostnames: alphanumeric and hyphen characters only.'
+    end
+
+    private
+      def parse_encoded_gid(gid, options)
+        new(Base64.urlsafe_decode64(repad_gid(gid)), options) rescue nil
+      end
+
+      # We removed the base64 padding character = during #to_param, now we're adding it back so decoding will work
+      def repad_gid(gid)
+        padding_chars = gid.length.modulo(4).zero? ? 0 : (4 - gid.length.modulo(4))
+        gid + ('=' * padding_chars)
+      end
+  end
+
+  attr_reader :uri, :app, :model_name, :model_id
+
+  def initialize(gid, options = {})
+    extract_uri_components gid
+  end
+
+  def find(options = {})
+    Locator.locate self, options
+  end
+
+  def model_class
+    model_name.constantize
+  end
+
+  def ==(other)
+    other.is_a?(GlobalID) && @uri == other.uri
+  end
+
+  def to_s
+    @uri.to_s
+  end
+
+  def to_param
+    # remove the = padding character for a prettier param -- it'll be added back in parse_encoded_gid
+    Base64.urlsafe_encode64(to_s).sub(/=+$/, '')
+  end
+
+  private
+    PATH_REGEXP = %r(\A/([^/]+)/([^/]+)\z)
+
+    # Pending a URI::GID to handle validation
+    def extract_uri_components(gid)
+      @uri = gid.is_a?(URI) ? gid : URI.parse(gid)
+      raise URI::BadURIError, "Not a gid:// URI scheme: #{@uri.inspect}" unless @uri.scheme == 'gid'
+
+      if @uri.path =~ PATH_REGEXP
+        @app = @uri.host
+        @model_name = $1
+        @model_id = $2
+      else
+        raise URI::InvalidURIError, "Expected a URI like gid://app/Person/1234: #{@uri.inspect}"
+      end
+    end
+end

data/lib/global_id/identification.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+class GlobalID
+  module Identification
+    extend ActiveSupport::Concern
+
+    def to_global_id
+      @global_id ||= GlobalID.create(self)
+    end
+    alias to_gid to_global_id
+
+  end
+end

data/lib/global_id/locator.rb

@@ -0,0 +1,83 @@
+class GlobalID
+  module Locator
+    class << self
+      # Takes either a GlobalID or a string that can be turned into a GlobalID
+      #
+      # Options:
+      # * <tt>:only</tt> - A class, module or Array of classes and/or modules that are
+      #   allowed to be located.  Passing one or more classes limits instances of returned
+      #   classes to those classes or their subclasses.  Passing one or more modules in limits
+      #   instances of returned classes to those including that module.  If no classes or
+      #   modules match, +nil+ is returned.
+      def locate(gid, options = {})
+        if gid = GlobalID.parse(gid)
+          locator_for(gid).locate gid if find_allowed?(gid.model_class, options[:only])
+        end
+      end
+
+      # Tie a locator to an app.
+      # Useful when different apps collaborate and reference each others' Global IDs.
+      #
+      # The locator can be either a block or a class.
+      #
+      # Using a block:
+      #
+      #   GlobalID::Locator.use :foo do |gid|
+      #     FooRemote.const_get(gid.model_name).find(gid.model_id)
+      #   end
+      #
+      # Using a class:
+      #
+      #   GlobalID::Locator.use :bar, BarLocator.new
+      #
+      #   class BarLocator
+      #     def locate(gid)
+      #       @search_client.search name: gid.model_name, id: gid.model_id
+      #     end
+      #   end
+      def use(app, locator = nil, &locator_block)
+        raise ArgumentError, 'No locator provided. Pass a block or an object that responds to #locate.' unless locator || block_given?
+
+        GlobalID.validate_app(app)
+
+        @locators[normalize_app(app)] = locator || BlockLocator.new(locator_block)
+      end
+
+      private
+        def locator_for(gid)
+          @locators.fetch(normalize_app(gid.app)) { default_locator }
+        end
+
+        def find_allowed?(model_class, only = nil)
+          only ? Array(only).any? { |c| model_class <= c } : true
+        end
+
+        def normalize_app(app)
+          app.to_s.downcase
+        end
+    end
+
+    private
+      @locators = {}
+
+      class ActiveRecordFinder
+        def locate(gid)
+          gid.model_class.find gid.model_id
+        end
+      end
+
+      def self.default_locator
+        ActiveRecordFinder.new
+      end
+
+      class BlockLocator
+        def initialize(block)
+          @locator = block
+        end
+
+        def locate(gid)
+          @locator.call(gid)
+        end
+      end
+  end
+end

data/lib/rails/generators/job/job_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/named_base'
+
+module Rails
+  module Generators # :nodoc:
+    class JobGenerator < Rails::Generators::NamedBase # :nodoc:
+      desc 'This generator creates an active job file at app/jobs'
+
+      class_option :queue, type: :string, default: 'default', desc: 'The queue name for the generated job'
+
+      check_class_collision suffix: 'Job'
+
+      hook_for :test_framework
+
+      def self.default_generator_root
+        File.dirname(__FILE__)
+      end
+
+      def create_job_file
+        template 'job.rb', File.join('app/jobs', class_path, "#{file_name}_job.rb")
+      end
+
+    end
+  end
+end

data/lib/rails/generators/job/templates/job.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+class <%= class_name %>Job < ActiveJob::Base
+  queue_as :<%= options[:queue] %>
+
+  def perform(*args)
+    # Do something later
+  end
+end
+<% end -%>

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: activejob_backport
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Declare job classes that can be run by a variety of queueing backends.
+email: david@loudthinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- lib/active_job.rb
+- lib/active_job/arguments.rb
+- lib/active_job/base.rb
+- lib/active_job/callbacks.rb
+- lib/active_job/configured_job.rb
+- lib/active_job/core.rb
+- lib/active_job/enqueuing.rb
+- lib/active_job/execution.rb
+- lib/active_job/gem_version.rb
+- lib/active_job/logging.rb
+- lib/active_job/queue_adapter.rb
+- lib/active_job/queue_adapters.rb
+- lib/active_job/queue_adapters/backburner_adapter.rb
+- lib/active_job/queue_adapters/delayed_job_adapter.rb
+- lib/active_job/queue_adapters/inline_adapter.rb
+- lib/active_job/queue_adapters/qu_adapter.rb
+- lib/active_job/queue_adapters/que_adapter.rb
+- lib/active_job/queue_adapters/queue_classic_adapter.rb
+- lib/active_job/queue_adapters/resque_adapter.rb
+- lib/active_job/queue_adapters/sidekiq_adapter.rb
+- lib/active_job/queue_adapters/sneakers_adapter.rb
+- lib/active_job/queue_adapters/sucker_punch_adapter.rb
+- lib/active_job/queue_adapters/test_adapter.rb
+- lib/active_job/queue_name.rb
+- lib/active_job/railtie.rb
+- lib/active_job/test_case.rb
+- lib/active_job/test_helper.rb
+- lib/active_job/version.rb
+- lib/activejob_backport.rb
+- lib/global_id.rb
+- lib/global_id/global_id.rb
+- lib/global_id/identification.rb
+- lib/global_id/locator.rb
+- lib/rails/generators/job/job_generator.rb
+- lib/rails/generators/job/templates/job.rb
+homepage: https://github.com/ankane/activejob_backport
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Job framework with pluggable queues.
+test_files: []
+has_rdoc: