queue_classic 3.2.0.RC1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 173f9534b0c2b7318cccdf7de96b762ee63306d3
-  data.tar.gz: c808e6bc17371a57e997c13800ba803666be969e
+SHA256:
+  metadata.gz: 85cbe23c9e438cd6a641325666d15b2b9195e804807301551c2daf557edf5f1a
+  data.tar.gz: 5a83731ab2ee80532dc4e4e5af535e58301003a8064f92851793120520b88cff
 SHA512:
-  metadata.gz: 7065d297515c3cd9bc40ac5f93a36f164d124f812dc2c53a649b163aceecf9995ebc07bee273660a4540defd08b95afc5b0b69f7b6af1491fd25f8c61cdbb927
-  data.tar.gz: 9f4abe2f2f6c58a5bc4f049b0851d63e730c2922dcf8141a14222e01e2900c7993db939033925ebb684c88b6452e689269c3bbccb2e7386a60a4eacf24308aed
+  metadata.gz: 9862ac7ed5c2d45d30524636cba00ac60b0939c240fc631a9e60561353ac115d49ce147d783cc454ddcb025676eaac7958368d286877e57d38bf1889924b3574
+  data.tar.gz: 83010a3b0450dd5128c72fdc41ac834baa7af97e3166a2a3e7bc8592213a7682f434b23c34c89635f2246112cbe240faa97d7bcb6bda4579703ed0d2e613cc71

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '30 21 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/main.yaml

@@ -0,0 +1,71 @@
+name: Test
+on: push
+jobs:
+  # test_rails:
+  #   runs-on: ubuntu-latest
+  #   services:
+  #     postgres:
+  #       image: postgres
+  #       env:
+  #         POSTGRES_PASSWORD: postgres
+  #       options: >-
+  #         --health-cmd pg_isready
+  #         --health-interval 10s
+  #         --health-timeout 5s
+  #         --health-retries 5
+  #       ports:
+  #         - 5432:5432
+  #   steps:
+  #   - uses: actions/checkout@v3
+  #   - name: Install postgresql-client
+  #     run: |
+  #       sudo apt-get update
+  #       sudo apt-get install -y libpq-dev
+  #   - uses: ruby/setup-ruby@v1
+  #     with:
+  #       ruby-version: "2.6"
+  #       bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+  #   - name: Test clean install in Rails
+  #     env:
+  #       DATABASE_URL: postgres://postgres:postgres@localhost/qctest523
+  #     run: |
+  #       cd test/rails-tests/
+  #       sh rails523.sh
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ['2.6', '2.7', '3.0', '3.1']
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install postgresql-client
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libpq-dev
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        RAILS_ENV: test
+        RACK_ENV: test
+        QC_DATABASE_URL: postgres://postgres:postgres@localhost/postgres
+        DATABASE_URL: postgres://postgres:postgres@localhost/postgres
+        QC_BENCHMARK: true
+        QC_BENCHMARK_MAX_TIME_DEQUEUE: 60
+        QC_BENCHMARK_MAX_TIME_ENQUEUE: 10

data/.gitignore

@@ -7,3 +7,5 @@ etc/
 .env
 Gemfile.lock
 tips-and-tricks.md
+test/reports/
+vendor/

data/{changelog → CHANGELOG.md}

@@ -1,31 +1,60 @@
-Unreleased
-- Fixed a bug in the offset calculation of `.enqueue_at`.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [4.0.0] - 2022-05-17
+
+Updates:
+- [Allow overriding of job successes](https://github.com/QueueClassic/queue_classic/pull/338)
+- [Move to @github actions - @circleci ended up being slower. Test for Ruby 2.6, 2.7, 3.0 and 3.1. Require a more modern, but still old PG gem.](https://github.com/QueueClassic/queue_classic/pull/335)
+- [Setup some code analysis](https://github.com/QueueClassic/queue_classic/pull/337)
+
+## [4.0.0-alpha1] - 2019-07-18
+
+Updates:
+- [Change to only support >= Postgres 9.6. We will be bringing in newer changes and testing on only 9.6+ going forward.](https://github.com/QueueClassic/queue_classic/pull/307)
+- [Change to only support currently supported Ruby versions: 2.4, 2.5 and 2.6.](https://github.com/QueueClassic/queue_classic/pull/305)
+- [Use skip-locked](https://github.com/QueueClassic/queue_classic/pull/303)
+- [Add abilty to count ready and scheduled jobs](https://github.com/QueueClassic/queue_classic/pull/255)
+
+Bug fixes:
+- [Switched project to use CircleCI, as it's way more consistent speed wise](https://github.com/QueueClassic/queue_classic/pull/304)
+- [Automatically retry after a connection reset #294](https://github.com/QueueClassic/queue_classic/pull/294)
+- [Add tests for installing fresh on rails 5.2.3 + running migrations](https://github.com/QueueClassic/queue_classic/pull/308)
+- [Don't recuse Time.now errors](https://github.com/QueueClassic/queue_classic/pull/310)
 - Use the jsonb type for the args column from now on. If not available, fall back to json or text.
 - `enqueue`, `enqueue_at`, `enqueue_in` return job hash with id.
-- Fixed unlock query for versions below Postgres 9.2
+- Fixed a bug in the offset calculation of `.enqueue_at`.
+
+## [3.0.0rc] - 2014-01-07
 
-Version 3.0.0rc
 - Improved signal handling
 
-Version 3.0.0beta
+## [3.0.0beta] - 2014-01-06
+
 - Workers can process many queues.
 
-Version 2.2.3
+## [2.2.3] - 2013-10-24
+
 - Update pg dependency to 0.17.0
 
-Version 2.3.0beta [YANKED]
+## [2.3.0beta] - 2013-09-05 YANKED
+
 - Concurrent job processing.
 
-Version 2.2.2
+## [2.2.2] - 2013-08-04
+
 - Update pg dependency to 0.16.0
 
-Version 2.2.1
+## [2.2.1] - 2013-07-12
+
 - Force listen/notify on worker
 - Notifications happen inside PostgreSQL trigger
 - Add rake task for generating rails migrations
 - Fix bug related to listening worker
 
-Version 2.2.0
+## [2.2.0] - 2013-07-02
+
 - Use json from the stdlib in place of MultiJson.
 - Use postgresql's json type for the args column if json type is available
 - QC::Worker#handle_failure logs the job and the error
@@ -33,53 +62,65 @@ Version 2.2.0
   in testing to configure a mock queue)
 - QC.log now reports time elapsed in milliseconds.
 
-Version 2.1.4
+## [2.1.4]
+
 - Update pg dependency to 0.15.1
 - Document logging behaviour
 
-Version 2.1.3
+## [2.1.3]
+
 - Use MultiJson (Ezekiel Templin: #106)
 
-Version 2.1.2
+## [2.1.2]
+
 - Use 64bit ints as default data types in PostgreSQL
 - Add process method in worker
 - Allow percent-encoded socket paths in DATABASE_URL
 
-Version 2.1.1
+## [2.1.1]
+
 - Update pg gem version
 
-Version 2.1.0
+## [2.1.0]
+
 - Wrap connection execution in mutex making it thread safe
 - Cleanup logging
 - Refactor worker class making it more extensible
 - Added rdoc style docs for worker class
 
-Version 2.0.5
+## [2.0.5]
+
 - Allow term signal to halt the lock_job function
 
-Version 2.0.4
+## [2.0.4]
+
 - Provider a connection setter.
 
-Version 2.0.3
+## [2.0.3]
+
 - Fix typo :(
 
-Version 2.0.2
+## [2.0.2]
+
 - Remove scrolls dependency
 - Fix issue with notify not working on non-default queues
 
-Version 2.0.1
+## [2.0.1]
+
+## [2.0.0]
 
-Version 2.0.0
 - Simpler setup via QC::Setup.create (rake qc:create) & QC::Setup.drop (rake
 qc:drop)
 - Simpler abstractions in implementation
 - Better support for instrumentation via log_yield hook in QC module
 - Multiple queues use one table with a queue_name column
 
-Version 1.0.2
+## [1.0.2]
+
 - Update to latest okjson as the current has bugs
 
-Version 1.0.1
+## [1.0.1]
+
 - Using OkJson instead of any sort of rubygem
 - Remove html from docs
 - Use parameterised queries
@@ -87,35 +128,42 @@ Version 1.0.1
 - Injection attack bug fixed in lock_head()
 - Notificaiton get sent on seperate chans for disjoint queues
 
-Version 1.0.0rc1
+## [1.0.0rc1] - 2011-08-29
+
 - Removed json gem and relying on ruby 1.9.2's stdlib
 - Added better documentation
 
-Version 0.3.6pre
+## [0.3.6pre]
+
 - Added listen/notify support configured by $QC_LISTENING_WORKER otherwise uses Kernel.sleep()
 
-Version 0.3.5pre
+## [0.3.5pre] - 2011-08-27
+
 - Removed debug statement. Mistake!
 
-Version 0.3.4pre
+## [0.3.4pre]
+
 - Added logging configured by $VERBOSE or $QC_VERBOSE.
 - Added a method setup_child that gets called right after a worker forks.
 - Removed database helper methods: create_table, drop_table, silence_warnings.
 - Removed queue connection helper methods. Status should be discoverd by psql or the likes.
 
-Version 0.3.3pre
+## [0.3.3pre]
+
 - Removed PUB/SUB
 - Added GC after working a job
 - Added support for a database_url other than $DATABASE_URL. $QC_DATABASE_URL
 - Added exp backoff configured by $QC_MAX_LOCK_ATTEMPTS (default = 5)
 - Added option for forking worker configured by $QC_FORK_WORKER (default = false)
 
-Version 0.3.2
+## [0.3.2] - 2011-08-03
+
 - Fixed bug which caused workers to consume 2 connections. Now they only consume 1
 - Added a rake file for tests
 - Added support for postgres:///db_name DATABASE_URLs
 
-Version 0.3.1
+## [0.3.1] - 2011-04-27
+
 - Added query interface for introspection success
 - Moved the locking of jobs into the DB as a PG function. SELECT lock_head()
 - Added requirement for DB connection. MUST BE URI i.e. DATABASE_URL=postgres://user:pass@localhost/db_name
@@ -126,21 +174,26 @@ Version 0.3.1
 - Renamed the jobs channel to queue_classic_jobs
 - Added support for multiple queues
 
-Version 0.2.2
+## [0.2.2] - 2011-02-26
+
 - Fixed problems with enqueueing a list of parameters.
 
-Version 0.2.1
+## [0.2.1] - 2011-02-22
+
 - Added method for handling errors.
 - Added ability to enqueue a Job instance. Makes retrying jobs easier.
 - Added delete_all.
 - Fixed connection algorithm. 1 connection per process.
 - Fixed API for enqueue. Now accepting 1 arg or many args.
 
-Version 0.2.0
+## [0.2.0] - 2011-02-17
+
 - Beta Release
 - Added method for handling failed jobs
 - Added Benchmarks
 - Removed logging
 - Moved the Job class into it's own file
 
-0.1.6
+## [0.1.6] - 2011-02-03
+
+- Early release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at isitaboat+qc@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,9 +1,13 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+source 'https://rubygems.org'
 
-gem "rake"
+source 'https://rubygems.org' do
+  gem 'rake'
 
-gemspec
+  gemspec
 
-group :test do
-  gem 'minitest', '~> 5.5.1'
+  group :test do
+    gem 'minitest', '~> 5.8'
+    gem 'minitest-reporters'
+  end
 end