kredis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6a806a43280483f33a61cb2133b869d7742251eb7df3ccfcfe18c4bc5274873
+  data.tar.gz: 1c255fa02c7172090724ee01b5f72ec5540b4e38c43505135bd123c2ab6a1c79
+SHA512:
+  metadata.gz: 270f4fda9ed70fb489e9b54431ae01118f2f25fcb6632a8eb83abb50e4ff0871729a4282989c75801bd6f0c7520f72d51923b6980c46089f0f27a3d8145a2a6e
+  data.tar.gz: d1d5cc05fbe9091db57a20ad138e08cf1ee60d00765ebf69222cf53f9c153ce0a260496d0dd406c807ef1b6b51164ab365487c72e9299ca703d776add411c564

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Basecamp
+
+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,12 @@
+# Kredis
+
+Keyed Redis encapsulates higher-level data structures around a single key, so you can interact with them as coherent objects rather than isolated procedural commands.
+
+
+## Development
+
+...
+
+## License
+
+Kredis is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/kredis.rb

@@ -0,0 +1,14 @@
+require "kredis/railtie"
+
+require "kredis/connections"
+require "kredis/types"
+require "kredis/attributes"
+require "kredis/namespace"
+
+module Kredis
+  include Connections
+  include Namespace
+  include Types
+
+  extend self
+end

data/lib/kredis/attributes.rb

@@ -0,0 +1,34 @@
+module Kredis::Attributes
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def kredis_list(name, config: :shared)
+      ivar_symbol = :"@#{name}_kredis_list"
+
+      define_method(name) do
+        if instance_variable_defined?(ivar_symbol)
+          instance_variable_get(ivar_symbol)
+        else
+          instance_variable_set(ivar_symbol, Kredis.list(kredis_key_for_attribute(name), config: config))
+        end
+      end
+    end
+
+    def kredis_unique_list(name, limit: nil, config: :shared)
+      ivar_symbol = :"@#{name}_kredis_unique_list"
+
+      define_method(name) do
+        if instance_variable_defined?(ivar_symbol)
+          instance_variable_get(ivar_symbol)
+        else
+          instance_variable_set(ivar_symbol, Kredis.unique_list(kredis_key_for_attribute(name), limit: limit, config: config))
+        end
+      end
+    end
+  end
+
+  private
+    def kredis_key_for_attribute(name)
+      "#{self.class.name.tableize.gsub("/", ":")}:#{id}:#{name}"
+    end
+end

data/lib/kredis/connections.rb

@@ -0,0 +1,14 @@
+require "redis"
+
+module Kredis::Connections
+  mattr_accessor :connections, default: Hash.new
+  mattr_accessor :configurator
+
+  def configured_for(name)
+    connections[name] ||= Redis.new configurator.config_for("redis/#{name}")
+  end
+
+  def clear_all
+    connections.each_value(&:flushdb)
+  end
+end

data/lib/kredis/namespace.rb

@@ -0,0 +1,13 @@
+module Kredis::Namespace
+  def namespace=(namespace)
+    Thread.current[:kredis_namespace] = namespace
+  end
+
+  def namespace
+    Thread.current[:kredis_namespace]
+  end
+
+  def namespaced_key(key)
+    namespace ? "#{namespace}:#{key}" : key
+  end
+end

data/lib/kredis/proxy.rb

@@ -0,0 +1,13 @@
+class Kredis::Proxy
+  def initialize(redis, key)
+    @redis, @key = redis, key
+  end
+
+  def multi(...)
+    @redis.multi(...)
+  end
+
+  def method_missing(method, *args, **kwargs)
+    @redis.public_send method, @key, *args, **kwargs
+  end
+end

data/lib/kredis/railtie.rb

@@ -0,0 +1,29 @@
+require "rails/railtie"
+
+module Kredis
+  class Railtie < ::Rails::Railtie
+    config.kredis = ActiveSupport::OrderedOptions.new
+    config.eager_load_namespaces << Kredis
+
+    initializer "kredis.testing" do
+      ActiveSupport.on_load(:active_support_test_case) do
+        parallelize_setup    { |worker| Kredis.namespace = "test-#{worker}" }
+        parallelize_teardown { Kredis.clear_all }
+      end
+    end
+
+    initializer "kredis.configurator" do
+      Kredis.configurator = Rails.application
+    end
+
+    initializer "kredis.attributes" do
+      ActiveSupport.on_load(:active_model) do
+        ActiveModel::Base.send :include, Kredis::Attributes
+      end
+
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, Kredis::Attributes
+      end
+    end
+  end
+end

data/lib/kredis/types.rb

@@ -0,0 +1,27 @@
+module Kredis::Types
+  def keyed(key, config: :shared)
+    Kredis::Proxy.new configured_for(config), namespaced_key(key)
+  end
+
+  def list(key, config: :shared)
+    List.new configured_for(config), namespaced_key(key)
+  end
+
+  def unique_list(key, limit: nil, config: :shared)
+    UniqueList.new configured_for(config), namespaced_key(key), limit: limit
+  end
+
+  def counter(key, expires_in: nil, config: :shared)
+    Counter.new configured_for(config), namespaced_key(key), expires_in: expires_in
+  end
+
+  def mutex(key, expires_in: nil, config: :shared)
+    Mutex.new configured_for(config), namespaced_key(key), expires_in: expires_in
+  end
+end
+
+require "kredis/proxy"
+require "kredis/types/list"
+require "kredis/types/unique_list"
+require "kredis/types/counter"
+require "kredis/types/mutex"

data/lib/kredis/types/counter.rb

@@ -0,0 +1,17 @@
+class Kredis::Types::Counter < Kredis::Proxy
+  def initialize(redis, key, expires_in: nil)
+    @expires_in = expires_in
+    super redis, key
+  end
+
+  def increment(by: 1)
+    multi do
+      set 0, ex: @expires_in, nx: true
+      incrby by
+    end
+  end
+
+  def value
+    get.to_i
+  end
+end

data/lib/kredis/types/list.rb

@@ -0,0 +1,17 @@
+class Kredis::Types::List < Kredis::Proxy
+  def elements
+    lrange(0, -1) || []
+  end
+
+  def remove(elements)
+    Array(elements).each { |element| lrem 0, element }
+  end
+
+  def prepend(elements)
+    lpush elements
+  end
+
+  def append(elements)
+    rpush elements
+  end
+end

data/lib/kredis/types/mutex.rb

@@ -0,0 +1,25 @@
+class Kredis::Types::Mutex < Kredis::Proxy
+  def initialize(redis, key, expires_in: nil)
+    @expires_in = expires_in
+    super redis, key
+  end
+
+  def lock
+    set 1, ex: @expires_in
+  end
+
+  def unlock
+    del
+  end
+
+  def locked?
+    get
+  end
+
+  def synchronize
+    lock
+    yield
+  ensure
+    unlock
+  end
+end

data/lib/kredis/types/unique_list.rb

@@ -0,0 +1,23 @@
+# You'd normally call this a set, but Redis already has another data type for that
+class Kredis::Types::UniqueList < Kredis::Types::List
+  def initialize(redis, key, limit: nil)
+    @limit = limit
+    super redis, key
+  end
+
+  def prepend(elements)
+    multi do
+      remove elements
+      super
+      ltrim 0, (@limit - 1) if @limit
+    end
+  end
+
+  def append(elements)
+    multi do
+      remove elements
+      super
+      ltrim (@limit - 1), -1 if @limit
+    end
+  end
+end

data/lib/kredis/version.rb

@@ -0,0 +1,3 @@
+module Kredis
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: kredis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-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: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email: david@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/kredis.rb
+- lib/kredis/attributes.rb
+- lib/kredis/connections.rb
+- lib/kredis/namespace.rb
+- lib/kredis/proxy.rb
+- lib/kredis/railtie.rb
+- lib/kredis/types.rb
+- lib/kredis/types/counter.rb
+- lib/kredis/types/list.rb
+- lib/kredis/types/mutex.rb
+- lib/kredis/types/unique_list.rb
+- lib/kredis/version.rb
+homepage: https://github.com/rails/kredis
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Higher-level data structures built on Redis.
+test_files: []