workers_loader 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTVlM2IzMzNhYjRjZmFlYzBiYTBhNWY3NDZmMTAyNjg0ZTJmY2Q4YQ==
+  data.tar.gz: !binary |-
+    MmYzOGJmOGY3MWUxZTEzMDg1OTNiYmE0ODNiODViNWEzOTNhMTQyMQ==
+SHA512:
+  metadata.gz: !binary |-
+    MzExODcxMWIwYTEyYzI5MWYyZWI1ZDNmOGQ4YmUxNDg5MGEyMmQ3NDQ2MGJj
+    NjM2Y2I4YjkwMDVkMzhjMDc1ODMwMGJkYTFlZDUyYWY1NjU3NTI0ZDkzMmEy
+    YWRmYmJmMmM0NTJkMDRjZTc2MjJiNzhhY2U2ZjY2MTcwZTI4ZTk=
+  data.tar.gz: !binary |-
+    NzAxNzA5ZDE1ZjEyMDcxZTgwZTgyNjJhM2VhMWVjNDlhZjRmODM3NzY3ZTgw
+    YzRkNGEwYzBmZmI1YWVkMzQ2OTY2MTMzNmVhNWJkMzQ1Y2U5NDAyYTM3YTc0
+    OTRlNTJlMjBjYjgyNzgzYTUxMmZmZjI5MjY2NTNjZWJlZGNkY2E=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Ricard Forniol
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,26 @@
+This library is intended to let workers modularization.
+
+
+It lets you load workers queue names from a given directory.
+
+Let's say you have some engines with workers in folder /my_engine/app/workers
+
+You can place an initializer like follow in your engine so then the container app can collect all queues from engines:
+
+## Engine
+
+module MyApp
+  class Engine < ::Rails::Engine
+    initializer 'my_app.wokers_path' do |app|
+      WorkersLoader.add_path(MyApp::Engine.root.join('app', workers))
+    end
+  end
+end
+
+## Container App initializer
+
+You can get the complete list of queues by doing the following:
+
+WorkersLoader.load_workers!
+WorkersLoader.workers
+

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/lib/workers_loader/path.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'resque'
+
+module WorkersLoader
+  class Path
+    attr_reader :base, :parent
+
+    def initialize(base, parent = true)
+      base = match[1] if match = /(.*)\/$/.match(base)
+      @base = base
+
+      @parent = base.split('/').last if parent
+    end
+
+    def files
+      path = File.join(base, '{**/*.rb}')
+      Dir[path]
+        .map { |file| /#{base}\/(.*).rb/.match(file)[1] }
+        .map { |relative_path| relative_path_for(relative_path) }
+    end
+
+    def class_for(relative_path)
+      relative_path.split('/').map(&:camelize).join('::').constantize
+    rescue NameError
+      file = File.join(base, "#{relative_path}.rb")
+      raise "File not found: #{file}" unless File.exist?(file)
+      load file
+      class_for(relative_path)
+    end
+
+    def queue_for(relative_path)
+      Resque.queue_from_class(class_for(relative_path))
+    end
+
+    def relative_path_for(path)
+      parent.nil? ? path : File.join(parent, path)
+    end
+    private :relative_path_for
+  end
+end

data/lib/workers_loader/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module WorkersLoader
+  VERSION = '0.0.1'
+end

data/lib/workers_loader.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'active_support/core_ext/module/attribute_accessors'
+
+# Resque workers strategy
+# loading system
+module WorkersLoader
+  mattr_accessor :workers_paths
+  @@workers_paths = []
+
+  mattr_accessor :workers
+  @@workers = []
+
+  class << self
+    def add_path(path)
+      fail "Directory not found: `#{path}`" unless Dir.exist?(path)
+      @@workers_paths << path
+    end
+
+    def find(path)
+      path = Path.new(path)
+      path.files.map { |file| path.queue_for(file) }
+        .reject(&:blank?)
+    end
+
+    def load_workers!
+      workers_paths.each do |path|
+        workers_in_path = find(path)
+        next if workers_in_path.empty?
+
+        duplacates = workers_in_path
+          .select { |worker| workers.include?(worker) }
+        if duplacates.any?
+          fail("Workers already present! #{duplacates.join(', ')}")
+        end
+
+        self.workers += workers_in_path
+      end
+    end
+  end
+
+  autoload :Path, 'workers_loader/path'
+end

data/spec/lib/workers_loader/path_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe WorkersLoader::Path do
+  let(:base) do
+    File.join(File.dirname(__FILE__), '..', '..', 'support', 'dummy')
+  end
+  subject { described_class.new(base) }
+
+  describe '#files' do
+    let(:files) { %w(dummy/bar/base dummy/foo dummy/bar/baz).sort }
+    it { expect(subject.files.sort).to eq(files) }
+  end
+
+  describe '#class_for' do
+    it { expect(subject.class_for('dummy/foo')).to eq(Dummy::Foo) }
+    it { expect(subject.class_for('dummy/bar/baz')).to eq(Dummy::Bar::Baz) }
+  end
+
+  describe '#queue_for' do
+    it { expect(subject.queue_for('dummy/foo')).to eq(:dummy_foo) }
+    it { expect(subject.queue_for('dummy/bar/baz')).to eq(:baz_queue) }
+  end
+end

data/spec/lib/workers_loader_spec.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe WorkersLoader do
+  before do
+    described_class.workers_paths = []
+    described_class.workers = []
+  end
+  let(:workers_path) do
+    File.join(File.dirname(__FILE__), '..', 'support', 'dummy')
+  end
+  subject { described_class.workers_paths }
+
+  it { expect(subject).to eq([]) }
+
+  describe '::add_path' do
+    before { described_class.add_path(workers_path) }
+
+    it { expect(described_class.workers_paths).to eq([workers_path]) }
+
+    context 'dubplicate worker' do
+      let(:message) { 'Directory not found: `foo`' }
+      it { expect { described_class.add_path('foo') }.to raise_error(message) }
+    end
+  end
+
+  describe '::find' do
+    subject { described_class.find(workers_path) }
+
+    it { expect(subject.sort).to eq([:dummy_foo, :baz_queue].sort) }
+  end
+
+  describe '::load_workers!' do
+    before do
+      described_class.add_path(workers_path)
+      described_class.load_workers!
+    end
+
+    it { expect(described_class.workers).to eq([:baz_queue, :dummy_foo]) }
+
+    context 'prevent duplicates' do
+      let(:message) { 'Workers already present! baz_queue, dummy_foo' }
+      it { expect { described_class.load_workers! }.to raise_error(message) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'rspec'
+require 'factory_girl_rails'
+require 'workers_loader'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.order = 'random'
+end

data/spec/support/dummy/bar/base.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Dummy
+  module Bar
+    class Base
+      # not a worker
+    end
+  end
+end

data/spec/support/dummy/bar/baz.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Dummy
+  module Bar
+    class Baz
+      @queue = :baz_queue
+    end
+  end
+end

data/spec/support/dummy/foo.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Dummy
+  class Foo
+    @queue = :dummy_foo
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: workers_loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricard Forniol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.21
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: factory_girl_rails
+  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: Resque workers loading strategy system
+email:
+- ricard.forniol@pushtech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README
+- Rakefile
+- lib/workers_loader.rb
+- lib/workers_loader/path.rb
+- lib/workers_loader/version.rb
+- spec/lib/workers_loader/path_spec.rb
+- spec/lib/workers_loader_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy/bar/base.rb
+- spec/support/dummy/bar/baz.rb
+- spec/support/dummy/foo.rb
+homepage: http://www.pushtech.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Resque loading system
+test_files:
+- spec/lib/workers_loader/path_spec.rb
+- spec/lib/workers_loader_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy/bar/base.rb
+- spec/support/dummy/bar/baz.rb
+- spec/support/dummy/foo.rb
+has_rdoc: