sidekiq-unique-jobs 4.0.17 → 4.0.18

data/rails_example/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/rails_example/app/models/guest.rb

@@ -0,0 +1,21 @@
+class Guest
+  def name
+    'Guest Visitor'.freeze
+  end
+
+  def email
+    'unknown@domain.com'.freeze
+  end
+
+  def appear
+  end
+
+  def disappear
+  end
+
+  def appear
+  end
+
+  def away
+  end
+end

data/rails_example/app/models/post.rb

@@ -1,2 +1,2 @@
-class Post < ActiveRecord::Base
+class Post < ApplicationRecord
 end

data/rails_example/app/workers/simple_worker.rb

@@ -1,11 +1,12 @@
 class SimpleWorker
   include Sidekiq::Worker
   sidekiq_options unique: :until_executed,
-                  unique_args: -> (args) { [args.first] },
                   queue: :default,
-                  default_queue_lock_expiration: 3 * 60 * 60
+                  unique_args: (lambda do |args|
+                    [args.first]
+                  end)
 
-  def perform(_some_arg)
-    sleep 60
+  def perform(_some_args)
+    sleep 1
   end
 end

data/rails_example/bin/check_or_setup_db

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+# This script is used in the development environment with Docker to check if the
+# app database exists, and runs the database setup if it doesn't, as it is the
+# case when the project runs for the first time on the development machine.
+#
+# We are using this custom script instead of running the
+# `rake db:version  || rake db:setup` commands, as that currently leaves a
+# couple of small ruby zombie processes running in the app container:
+require 'rubygems'
+require 'rake'
+require 'bundler'
+
+Bundler.setup(:default)
+
+require 'active_record'
+require 'pg'
+
+exit begin
+  connection_tries ||= 3
+  ActiveRecord::Base.establish_connection && ActiveRecord::Migrator.current_version
+  0
+rescue PG::ConnectionBad
+  unless (connection_tries -= 1).zero?
+    puts "Retrying DB connection #{connection_tries} more times..."
+    sleep ENV.fetch('APP_SETUP_WAIT', '5').to_i
+    retry
+  end
+  1
+rescue ActiveRecord::NoDatabaseError, ActiveRecord::AdapterNotSpecified
+
+  include ActiveRecord::Tasks
+
+  DatabaseTasks.root = File.expand_path '../..', __FILE__
+  DatabaseTasks.db_dir = File.join DatabaseTasks.root, 'db'
+  DatabaseTasks.env = ENV.fetch 'ENV', ENV.fetch('RAILS_ENV', 'development')
+
+  # The App database seeder:
+  DatabaseTasks.seed_loader = (Class.new do
+    def load_seed
+      seed_file_path = File.join DatabaseTasks.db_dir, 'seeds.rb'
+      raise "Seed file '#{seed_file_path}' does not exist" unless File.file?(seed_file_path)
+      load seed_file_path
+    end
+  end).new
+
+  # Add model dirs to the autoload_paths for the seeder to run smoothly:
+  ActiveSupport::Dependencies.autoload_paths << File.join(DatabaseTasks.root, 'app', 'models', 'concerns')
+  ActiveSupport::Dependencies.autoload_paths << File.join(DatabaseTasks.root, 'app', 'models')
+
+  return 2 unless DatabaseTasks.create_current
+  return 3 unless DatabaseTasks.load_schema_current
+  return 4 unless DatabaseTasks.load_seed
+  0
+ensure
+  ActiveRecord::Base.clear_all_connections!
+end

data/rails_example/bin/docker-setup

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -e
+
+# ln -s ../ gems/sidekiq-unique-jobs
+cp -f config/database.docker.yml config/database.yml
+# cp -f config/application.docker.yml config/application.yml
+
+# build app image
+docker-compose build
+
+# start mysql and redis in background
+docker-compose start postgres
+docker-compose start redis
+
+# setup database
+docker-compose run web rake db:create db:migrate
+
+# ensure all containers are up and running
+docker-compose up

data/rails_example/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/rails_example/bin/setup

@@ -1,29 +1,34 @@
 #!/usr/bin/env ruby
 require 'pathname'
+require 'fileutils'
+include FileUtils
 
 # path to your application root.
 APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
 
-Dir.chdir APP_ROOT do
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
   # This script is a starting point to setup your application.
-  # Add necessary setup steps to this file:
+  # Add necessary setup steps to this file.
 
   puts '== Installing dependencies =='
-  system 'gem install bundler --conservative'
-  system 'bundle check || bundle install'
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
 
   # puts "\n== Copying sample files =="
-  # unless File.exist?("config/database.yml")
-  #   system "cp config/database.yml.sample config/database.yml"
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
   # end
 
   puts "\n== Preparing database =="
-  system 'bin/rake db:setup'
+  system! 'bin/rails db:setup'
 
   puts "\n== Removing old logs and tempfiles =="
-  system 'rm -f log/*'
-  system 'rm -rf tmp/cache'
+  system! 'bin/rails log:clear tmp:clear'
 
   puts "\n== Restarting application server =="
-  system 'touch tmp/restart.txt'
+  system! 'bin/rails restart'
 end

data/rails_example/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/rails_example/cable.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+Rails.application.eager_load!
+
+run ActionCable.server

data/rails_example/common-services.yml

@@ -0,0 +1,50 @@
+version: '2'
+services:
+  rails:
+    image: ruby:2.3
+    # build:
+    #   context: .
+    #   dockerfile: docker/rails.Dockerfile
+    # We'll specify a dotenv file for docker-compose to load more environment
+    # variables into our app containers. This dotenv file would normally contain
+    # sensitive data (API keys & secrets, etc) which SHOULD NOT be committed into
+    # Git.
+    # Keep in mind that any changes in this file will require a container restart
+    # in order to be available on the app containers:
+    env_file:
+      - dev.env
+    # Specify environment variables available for our app containers. We'll leave
+    # a YML anchor in case we need to override or add more variables if needed on
+    # each app container:
+    environment: &app_environment
+      # We'll overwrite the PATH environment variable to include the 'bin/'
+      # directory, for the entrypoint script to find the app's executables:
+      PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+      # We'll set the REDIS_URL environment variable for the app to connect
+      # to our redis container:
+      REDIS_URL: redis://redis:6379
+
+      # We'll set the RAILS_ENV and RACK_ENV environment variables to
+      # 'development', so our app containers will start in 'development' mode
+      # on this compose project:
+      RAILS_ENV: development
+      RACK_ENV: development
+    cpu_shares: 4
+    # Specify the directory from where all commands sent to the container will be
+    # issued to where the code is mounted:
+    working_dir: /usr/src/app
+
+    # Keep the stdin open, so we can attach to our app container's process
+    # and do things such as byebug, etc:
+    stdin_open: true
+
+    # Enable sending signals (CTRL+C, CTRL+P + CTRL+Q) into the container:
+    tty: true
+    volumes:
+      # Mount our app code directory (".") into our app containers at the
+      # "/usr/src/app" folder:
+      - .:/usr/src/app
+
+      # Mount the 'gems' volume on the folder that stores bundled gems:
+      - gems:/usr/local/bundle

data/rails_example/config/application.rb

@@ -1,5 +1,7 @@
-require File.expand_path('../boot', __FILE__)
+require_relative 'boot'
 
+require 'bigdecimal'
+require 'bigdecimal/util'
 require 'rails/all'
 
 # Require the gems listed in Gemfile, including any gems
@@ -14,13 +16,12 @@ module RailsExample
 
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
+    config.time_zone = 'CET'
 
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
 
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    # config.active_record.schema_format = :sql
   end
 end

data/rails_example/config/boot.rb

@@ -1,3 +1,3 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
 require 'bundler/setup' # Set up gems listed in the Gemfile.

data/rails_example/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/rails_example/config/database.docker.yml

@@ -0,0 +1,12 @@
+development:
+  adapter: postgresql
+  database: rails_example_dev
+  pool: 5
+  timeout: 5000
+
+test:
+  adapter: postgresql
+  database: rails_example_test
+  pool: 5
+  timeout: 5000
+

data/rails_example/config/database.yml

@@ -1,26 +1,19 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
+defaults: &defaults
+  encoding: unicode
+  adapter: postgresql
+  host: <%= ENV.fetch('DB_HOST') { 'localhost' } %>
+  port: <%= ENV.fetch('DB_PORT') { 5432 } %>
+  username: <%= ENV.fetch('DB_USERNAME') { 'postgres' } %>
+  password: <%= ENV.fetch('DB_PASSWORD') { '' } %>
+  pool: <%= ENV.fetch('DB_POOL') { 25 } %>
+  timeout: <%= ENV.fetch('DB_TIMEOUT') { 5000 } %>
+  reaping_frequency: <%= ENV.fetch('DB_REAPING_FREQUENCY') { 5000 } %>
+
 development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 5
-  timeout: 5000
+  <<: *defaults
+  database: rails_example_dev
 
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
 test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
-
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000
+  <<: *defaults
+  database: rails_example_test
 

data/rails_example/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the Rails application.
-require File.expand_path('../application', __FILE__)
+require_relative 'application'
 
 # Initialize the Rails application.
 Rails.application.initialize!

data/rails_example/config/environments/development.rb

@@ -9,13 +9,28 @@ Rails.application.configure do
   # Do not eager load code on boot.
   config.eager_load = false
 
-  # Show full error reports and disable caching.
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
 
   # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false
 
+  config.action_mailer.perform_caching = false
+
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
@@ -27,15 +42,13 @@ Rails.application.configure do
   # number of complex assets.
   config.assets.debug = true
 
-  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
-  # yet still be able to expire them through the digest params.
-  config.assets.digest = true
-
-  # Adds additional error checking when serving assets at runtime.
-  # Checks for improperly declared sprockets dependencies.
-  # Raises helpful error messages.
-  config.assets.raise_runtime_errors = true
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
 end

data/rails_example/config/environments/production.rb

@@ -14,15 +14,9 @@ Rails.application.configure do
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
 
-  # Enable Rack::Cache to put a simple HTTP cache in front of your application
-  # Add `rack-cache` to your Gemfile before enabling this.
-  # For large-scale production use, consider using a caching reverse proxy like
-  # NGINX, varnish or squid.
-  # config.action_dispatch.rack_cache = true
-
   # Disable serving static files from the `/public` folder by default since
   # Apache or NGINX already handles this.
-  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier
@@ -31,16 +25,20 @@ Rails.application.configure do
   # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
 
-  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
-  # yet still be able to expire them through the digest params.
-  config.assets.digest = true
-
   # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
 
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
   # Specifies the header that your server uses for sending files.
   # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
@@ -49,16 +47,15 @@ Rails.application.configure do
   config.log_level = :debug
 
   # Prepend all log lines with the following tags.
-  # config.log_tags = [ :subdomain, :uuid ]
-
-  # Use a different logger for distributed setups.
-  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+  config.log_tags = [:request_id]
 
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
-  # config.action_controller.asset_host = 'http://assets.example.com'
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "rails_example_#{Rails.env}"
+  config.action_mailer.perform_caching = false
 
   # Ignore bad email addresses and do not raise email delivery errors.
   # Set this to true and configure the email server for immediate delivery to raise delivery errors.
@@ -74,6 +71,16 @@ Rails.application.configure do
   # Use default logging formatter so that PID and timestamp are not suppressed.
   config.log_formatter = ::Logger::Formatter.new
 
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+
   # Do not dump schema after migrations.
   config.active_record.dump_schema_after_migration = false
 end