esse-redis_storage 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c05d60be8578e56e72f8eaa1ed86bd0e2ddc4155aa4e401b46f1baea2644887
+  data.tar.gz: fcf6aebf13c1dda145e8be6f1eab49a8f7fe70a4d5dd5e48be9d07c77e8ae712
+SHA512:
+  metadata.gz: 153cb2cfa231b6f4657e779923db891e164a99f6c6401afaa5cae1b9c2e8893e2675cf26dc7cfc22f3d950ba04995b443c7a729a153ea2b457ef92c45edd5dcf
+  data.tar.gz: ff228cfae97984539f88920de7888df7809517d9c4a25aa2b842b530f06bb0a6864ecaf2c4db29cd0fff54060eac494c0c169f43fd0239d9a8a10c261d5f5dd6

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  Exclude:
+    - "db/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.2 - 2024-07-18
+* The `Esse::RedisStorage::Queue.for` method now support both `repo:` and `attribute_name:` options.
+
+## 0.0.1 - 2024-07-03
+The first release of the esse-redis_storage plugin
+* Add `redis` and `redis_pool` configuration option to the `Esse::Config` class.
+* `Esse::RedisStorage::Pool` class to handle the redis connection pool.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "esse", git: "https://github.com/marcosgz/esse.git", branch: "main"
+gem "esse-rspec"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+GIT
+  remote: https://github.com/marcosgz/esse.git
+  revision: ebbe8016650c2d090873a8799e8b127a39a592bf
+  branch: main
+  specs:
+    esse (0.2.6)
+      multi_json
+      thor (>= 0.19)
+
+PATH
+  remote: .
+  specs:
+    esse-redis_storage (0.0.2)
+      esse (>= 0.2.4)
+      redis (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    esse-rspec (0.0.6)
+      esse (>= 0.2.4)
+      rspec (>= 3)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    multi_json (1.15.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    redis (5.2.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.22.2)
+      connection_pool
+    regexp_parser (2.9.2)
+    rexml (3.3.1)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.0.2)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    standard (1.37.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
+    thor (1.3.1)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  connection_pool
+  esse!
+  esse-redis_storage!
+  esse-rspec
+  pry
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  standard
+
+BUNDLED WITH
+   2.3.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Marcos G. Zimmermann
+
+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.md

@@ -0,0 +1,45 @@
+# Esse redis-storage Plugin
+
+<!-- Extends the [esse](https://github.com/marcosgz/esse) search to use [redis-storage](https://github.com/rails/redis-storage) as the default template engine. -->
+
+This gems is a add-on for the [Esse](https://github.com/marcosgz/esse) search library that allows to use [redis-rb](https://github.com/redis/redis-rb) as the default storage engine for operations like async indexing using [esse-faktory](https://github.com/marcosgz/esse-faktory) or [esse-sidekiq](https://github.com/marcosgz/esse-sidekiq).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse-redis_storage'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Configuration
+
+This gem adds the `redis` configuration option to the `Esse::Config` class.
+
+```ruby
+Esse.configure do |config|
+  config.redis = ConnectionPool.new(size: 10, timeout: 1) do
+    Redis.new(url: ENV.fetch('REDIS_URL', 'redis://0.0.0.0:6379'))
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake none` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/esse-redis_storage.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/docker-compose.yml

@@ -0,0 +1,6 @@
+services:
+  redis:
+    image: redis
+    command: redis-server
+    ports:
+      - 6379:6379

data/lib/esse/redis_storage/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Esse
+  module RedisStorage
+    module Config
+      def self.included(base)
+        base.__send__(:include, InstanceMethods)
+      end
+
+      module InstanceMethods
+        attr_accessor :redis
+
+        def redis_pool
+          @redis_pool ||= Esse::RedisStorage::Pool.new(redis)
+        end
+      end
+    end
+  end
+end

data/lib/esse/redis_storage/pool.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Esse
+  module RedisStorage
+    class Pool
+      extend Forwardable
+      def_delegator :@connection, :with
+
+      module ConnectionPoolLike
+        def with
+          yield self
+        end
+      end
+
+      def initialize(connection)
+        if connection.respond_to?(:with)
+          @connection = connection
+        else
+          @connection = connection ? ::Redis.new(connection) : ::Redis.new
+          @connection.extend(ConnectionPoolLike)
+        end
+      end
+    end
+  end
+end

data/lib/esse/redis_storage/queue.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Esse
+  module RedisStorage
+    class Queue
+      include Enumerable
+      extend Forwardable
+      def_delegator :redis_connection, :with
+
+      GROUP = "queue"
+      SEPARATOR = ":"
+
+      attr_reader :name
+
+      def self.batch_id
+        SecureRandom.uuid
+      end
+
+      def self.for(repo:, attribute_name: nil)
+        name = [repo.index.index_name, repo.repo_name, attribute_name].compact.join(SEPARATOR)
+        new(name: name)
+      end
+
+      def initialize(name:)
+        @name = [Esse::RedisStorage::NAMESPACE, GROUP, name].compact.join(SEPARATOR)
+      end
+
+      # Enqueue a batch of ids to process
+      # @param id [String] The batch id
+      # @param values [Array<String>] The values of the batch
+      def enqueue(id: nil, values: [])
+        return if values.nil? || values.empty?
+
+        batch_id = id || self.class.batch_id
+        with do |conn|
+          conn.hset(name, batch_id, values.join(","))
+        end
+        batch_id
+      end
+
+      # Fetch and remove a batch of ids to process from the queue using batch_id
+      # @param batch_id [String] The batch id to fetch
+      # @yield [Array<String>] The values of the batch
+      def fetch(batch_id)
+        with do |conn|
+          values = conn.hget(name, batch_id)
+          return unless values
+
+          yield values.split(",")
+          conn.hdel(name, batch_id)
+        end
+      end
+
+      def delete(batch_id)
+        with do |conn|
+          conn.hdel(name, batch_id)
+        end
+      end
+
+      # Clear the queue
+      def clear
+        with do |conn|
+          conn.del(name)
+        end
+      end
+
+      # Get the size of the queue
+      # @return [Integer] The size of the queue
+      def size
+        with do |conn|
+          conn.hlen(name)
+        end
+      end
+
+      def each
+        with do |conn|
+          conn.hscan_each(name, count: 1000) do |batch_id, values|
+            yield batch_id, values.split(",")
+          end
+        end
+      end
+
+      private
+
+      def redis_connection
+        Esse.config.redis_pool
+      end
+    end
+  end
+end

data/lib/esse/redis_storage/queue_stats.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Esse
+  module RedisStorage
+    module QueueStats
+      KEY = "#{Esse::RedisStorage::NAMESPACE}:queues"
+
+      class << self
+        extend Forwardable
+        def_delegator :redis_connection, :with
+
+        def all
+          with { |conn| conn.smembers(KEY) }
+        end
+
+        def push(value)
+          with { |conn| conn.sadd(KEY, value) }
+        end
+
+        def delete(value)
+          with { |conn| conn.srem(KEY, value) }
+        end
+
+        def clear
+          with { |conn| conn.del(KEY) }
+        end
+
+        private
+
+        def redis_connection
+          Esse.config.redis_pool
+        end
+      end
+    end
+  end
+end

data/lib/esse/redis_storage/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Esse
+  module RedisStorage
+    VERSION = "0.0.2"
+  end
+end

data/lib/esse/redis_storage.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "esse"
+require "redis"
+require "forwardable"
+require "securerandom"
+
+module Esse
+  module RedisStorage
+    NAMESPACE = "esse"
+  end
+end
+
+require_relative "redis_storage/version"
+require_relative "redis_storage/config"
+require_relative "redis_storage/pool"
+require_relative "redis_storage/queue_stats"
+require_relative "redis_storage/queue"
+
+Esse::Config.__send__ :include, Esse::RedisStorage::Config

data/lib/esse-redis-storage.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "esse/redis_storage"

data/lib/esse-redis_storage.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "esse/redis_storage"

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: esse-redis_storage
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: esse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: connection_pool
+  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: pry
+  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: rspec
+  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: standard
+  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: rubocop
+  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: rubocop-performance
+  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: rubocop-rspec
+  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: Add-on for the esse gem to be used with Redis as a storage backend.
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/esse-redis-storage.rb
+- lib/esse-redis_storage.rb
+- lib/esse/redis_storage.rb
+- lib/esse/redis_storage/config.rb
+- lib/esse/redis_storage/pool.rb
+- lib/esse/redis_storage/queue.rb
+- lib/esse/redis_storage/queue_stats.rb
+- lib/esse/redis_storage/version.rb
+homepage: https://github.com/marcosgz/esse-redis_storage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-redis_storage
+  source_code_uri: https://github.com/marcosgz/esse-redis_storage
+  changelog_uri: https://github.com/marcosgz/esse-redis_storage/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Add-on for the esse gem to be used with Redis as a storage backend.
+test_files: []