litequeue 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e33bb82bf866416420a67cdbc4d5106a85d378ff9d0739ea8dbdbb7022f7902d
-  data.tar.gz: d8d721f96fb1a533fcc1446b6d193de6eba46a575b8114b7fdf537958b8e079f
+  metadata.gz: 975ed284b758c73f3ac99d5874c05fea38eb8c25bb36221b56f3e778b3f8fc08
+  data.tar.gz: fcb2a7662243851c7dcc62ea6346b0a1cbd591330c2d0883737609ff7996c260
 SHA512:
-  metadata.gz: 5b421f5e2375f74806ccf2564ff642698c25b9a59f26d92190fa138808d1a08e9ccbca295c8925604a0bb1b7a4383db8f46e0a97b1ae0f4c925633b356791280
-  data.tar.gz: c57def82958f2878d7a42ea65a45af8a5a4599cd3b83a2d0481db6a8d02f8663bffed4362adbb1af732f86e948a70ed7e7e2341269b96ea8f436c8c5df06f67e
+  metadata.gz: 17cb8fc124f2b14ff43f10e2281af2d33e60b684a2dcea9c735e15798efa3790976cda508d8e9d5a1ef2816b4322bf9c906b53156a65c68987cb8d1d29d82fcd
+  data.tar.gz: 10cea9107216cbbb56a2fe2e7647c2a5830acd74ae8840817dd6dd9aa717124588dd61cbb2d2ba51b4adcb39661c353c36ff7c10a1e6d4551feb76c560b4fbab

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2023-08-11
+
+- Update statements to work with SQLite versions that don't support `UNIXEPOCH('subsec')``
+
+## [0.2.0] - 2023-08-11
+
+- Initial release of usable code
+
 ## [0.1.0] - 2023-08-09
 
-- Initial release
+- Initial release to reserve gem name

data/Gemfile.lock

@@ -1,15 +1,21 @@
 PATH
   remote: .
   specs:
-    litequeue (0.1.0)
+    litequeue (0.2.1)
+      litedb (>= 0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    docile (1.4.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    litedb (0.2.1)
+      litescheduler (>= 0.2.0)
+      sqlite3 (>= 1.5.0)
+    litescheduler (0.2.1)
     minitest (5.19.0)
     parallel (1.23.0)
     parser (3.2.2.3)
@@ -36,6 +42,14 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (1.6.3-arm64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
     standard (1.30.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -52,11 +66,13 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   litequeue!
   minitest (~> 5.0)
   rake (~> 13.0)
+  simplecov
   standard (~> 1.3)
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,10 @@
 # Litequeue
 
+[![Gem Version](https://badge.fury.io/rb/litequeue.svg)](https://rubygems.org/gems/litequeue)
+[![Gem Downloads](https://img.shields.io/gem/dt/litequeue)](https://rubygems.org/gems/litequeue)
+![Tests](https://github.com/litestack-ruby/litequeue/actions/workflows/main.yml/badge.svg)
+![Coverage](https://img.shields.io/badge/code_coverage-100%25-brightgreen)
+
 TODO: Delete this and the text below, and describe your gem
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/litequeue`. To experiment with that code, run `bin/console` for an interactive prompt.

data/Rakefile

@@ -9,6 +9,34 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
+desc "Update the README code coverage badge"
+task :update_readme_coverage_badge do
+  require "json"
+
+  next unless File.exist?("coverage/.last_run.json")
+
+  last_run_coverage = JSON.load_file("coverage/.last_run.json")
+  line_coverage = last_run_coverage.dig("result", "line")
+  branch_coverage = last_run_coverage.dig("result", "branch")
+  average_coverage = [(branch_coverage * 1), (line_coverage * 1.5)].sum.fdiv(2.5).round
+  badge_color = if average_coverage >= 75
+    :brightgreen
+  else
+    :red
+  end
+
+  coverage_badge_re = /!\[Coverage\]\(https:\/\/img.shields.io\/badge\/code_coverage-(.*?)\)/
+  last_run_coverage_badge = "![Coverage](https://img.shields.io/badge/code_coverage-#{average_coverage}%25-#{badge_color})"
+
+  new_readme = File.read("README.md").gsub(coverage_badge_re, last_run_coverage_badge)
+
+  File.write("README.md", new_readme)
+
+  puts "Updated README code coverage badge to show #{average_coverage}% coverage."
+end
+
+task cov: %i[test update_readme_coverage_badge]
+
 require "standard/rake"
 
 task default: %i[test standard]

data/lib/litequeue/migrations.sql.yml

@@ -0,0 +1,11 @@
+create_table_queue: >
+  CREATE TABLE IF NOT EXISTS queue(
+    id TEXT PRIMARY KEY NOT NULL ON CONFLICT REPLACE,
+    name TEXT NOT NULL ON CONFLICT REPLACE,
+    fire_at INTEGER NOT NULL ON CONFLICT REPLACE,
+    value TEXT,
+    created_at INTEGER DEFAULT(UNIXEPOCH()) NOT NULL ON CONFLICT REPLACE
+  ) WITHOUT ROWID;
+
+create_index_queue_by_name: >
+  CREATE INDEX IF NOT EXISTS idx_queue_by_name ON queue(name, fire_at ASC);

data/lib/litequeue/statements.sql.yml

@@ -0,0 +1,48 @@
+push: >
+  INSERT INTO queue(id, name, fire_at, value)
+  VALUES (HEX(RANDOMBLOB(32)), $1, (IFNULL(UNIXEPOCH('subsec'), UNIXEPOCH()) + $2), $3)
+  RETURNING id, name;
+
+pop: >
+  DELETE FROM queue
+  WHERE name != '_dead'
+  AND (name, fire_at, id)
+  IN (
+      SELECT name, fire_at, id FROM queue
+      WHERE name = IFNULL($1, 'default')
+      AND fire_at <= IFNULL(UNIXEPOCH('subsec'), UNIXEPOCH())
+      ORDER BY fire_at ASC
+      LIMIT IFNULL($2, 1)
+  )
+  RETURNING id, value;
+
+repush: >
+  INSERT INTO queue(id, name, fire_at, value)
+  VALUES ($1, $2, (IFNULL(UNIXEPOCH('subsec'), UNIXEPOCH()) + $3), $4)
+  RETURNING name;
+
+delete: >
+  DELETE FROM queue
+  WHERE id = $1
+  RETURNING value;
+
+count: >
+  SELECT COUNT(*)
+  FROM queue
+  WHERE IIF($1 IS NULL, 1, name = $1);
+
+clear: >
+  DELETE FROM queue
+  WHERE IIF($1 IS NULL, 1, name = $1)
+  RETURNING id;
+
+info: >
+  SELECT 
+    name, 
+    COUNT(*) AS count, 
+    AVG(IFNULL(UNIXEPOCH('subsec'), UNIXEPOCH()) - created_at) AS avg, 
+    MIN(IFNULL(UNIXEPOCH('subsec'), UNIXEPOCH()) - created_at) AS min, 
+    MAX(IFNULL(UNIXEPOCH('subsec'), UNIXEPOCH()) - created_at) AS max
+  FROM queue 
+  GROUP BY name 
+  ORDER BY count DESC;

data/lib/litequeue/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Litequeue
-  VERSION = "0.1.0"
+class Litequeue
+  VERSION = "0.2.1"
 end

data/lib/litequeue.rb

@@ -2,7 +2,102 @@
 
 require_relative "litequeue/version"
 
-module Litequeue
-  class Error < StandardError; end
-  # Your code goes here...
+require "singleton"
+require "yaml"
+require "litedb"
+
+class Litequeue
+  include Singleton
+
+  DEFAULT_QUEUE = "default"
+
+  Configuration = Struct.new(:path, :synchronous, :mmap_size, :journal_size_limit)
+
+  def self.configuration
+    @configuration ||= Configuration.new(
+      _path = "queue.sqlite3",
+      _synchronous = :OFF,
+      _mmap_size = 32 * 1024
+    )
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.migrations
+    YAML.load_file("#{__dir__}/litequeue/migrations.sql.yml")
+  end
+
+  def self.statements
+    YAML.load_file("#{__dir__}/litequeue/statements.sql.yml")
+  end
+
+  def initialize
+    configuration = self.class.configuration
+    file = configuration.path
+    options = configuration.to_h
+      .slice(:synchronous, :mmap_size, :journal_size_limit)
+      .merge(migrations: self.class.migrations,
+        statements: self.class.statements)
+
+    @db = Litedb::Connection.new(file, options)
+    # Once the instance has been initialized, don't allow the configuration to be changed
+    # as it won't have any effect.
+    configuration.freeze
+  end
+
+  def push(value, queue: DEFAULT_QUEUE, delay: 0)
+    results = @db.run_statement(:push, queue, delay, value) # [["{id}", "{name}"]]
+    extract_row(results)
+  end
+
+  def pop(queue: DEFAULT_QUEUE, limit: 1)
+    results = @db.run_statement(:pop, queue, limit)
+
+    return extract_row(results) if limit == 1
+
+    results
+  end
+
+  def repush(id, value, queue: DEFAULT_QUEUE, delay: 0)
+    results = @db.run_statement(:repush, id, queue, delay, value)
+    extract_value(results)
+  end
+
+  def delete(id)
+    results = @db.run_statement(:delete, id)
+    extract_value(results)
+  end
+
+  def count(queue: nil)
+    results = @db.run_statement(:count, queue)
+    extract_value(results)
+  end
+
+  def clear(queue: nil)
+    results = @db.run_statement(:clear, queue)
+    results.count
+  end
+
+  def empty?
+    count.zero?
+  end
+
+  private
+
+  def extract_value(results) # [["{value}"]] || []
+    return if results.empty?
+
+    results
+      .first # [[value]] -> [value]
+      .first # [value] -> value
+  end
+
+  def extract_row(results) # [[{value}, {value}]] || []
+    return if results.empty?
+
+    results
+      .first # [[value, value]] -> [value, value]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: litequeue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mohamed Hassan
@@ -9,8 +9,36 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-09 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: litedb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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:
 email:
 - oldmoe@gmail.com
@@ -28,6 +56,8 @@ files:
 - README.md
 - Rakefile
 - lib/litequeue.rb
+- lib/litequeue/migrations.sql.yml
+- lib/litequeue/statements.sql.yml
 - lib/litequeue/version.rb
 - sig/litequeue.rbs
 homepage: https://github.com/litestack-ruby/litequeue