basket 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '092352c400ad4483af38e9afe1060a39c6162c7318e4c69fb1ecd7649af56344'
-  data.tar.gz: 9a6cb3e5937d7367b6e83bae58e796c71c7a2a7b77cec5bbbbd5178bf4e0107b
+  metadata.gz: fe1bb079417239ff859572188cdc08c280e471752d2e5bca308e26b57d375640
+  data.tar.gz: f8f4cb0b630b7f07b492a4281e04302322c4661266f0da966e4b5b4dc5f1b37c
 SHA512:
-  metadata.gz: a0f510f3e3f9c7b7accff0b76580d426e939d82212d6a4d83979f3043e4d679c8fafe994e58f788cf920110f3094e45cac1e290b50c802a22a5937358cdabd86
-  data.tar.gz: 33798eb722f92da71a396bac9529676f34cde316cdf3824fe5c42e66cfca26444caedb615fdcbad4ff67374a0a60dd646daf93eb349e0ee4d880f22b2186b2be
+  metadata.gz: 5cfa5e413c339a9f354457c7f2cf2a05edb21fecabaa63da9a6d8e51987d1e4ddef90b01235835ff330357834881836aa48dcf52edb8cc43e7d466e5f5528a6c
+  data.tar.gz: d880195c4f2d3ef24ed92e3ac288de53cfaca6990b1e8a8c596b0ad5fef126907b62336478edbf38c317c9f6a721bbcc5578c2a84af26047031acc25b0e5a11e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    basket (0.0.2)
+    basket (0.0.3)
       redis
       redis-namespace
 

data/README.md

@@ -26,7 +26,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 Add items to your basket as they come along.  They might come along quickly, or there might be a delay between them.  Regardless, you want to collect items into your basket before going and doing something with them.
 
 ```ruby
-while chicken.laying do 
+while chicken.laying? do 
   egg = { egg: {color: brown, size: medium}}
   Basket.add('QuicheBasket', egg)
 end
@@ -89,7 +89,7 @@ Defining `on_add`, `on_failure`, and `on_success` is optional.
 In an initializer, or somewhere equally appropriate, you might put something like this:
 
 ```ruby
-Basket.config do |config|
+Basket.configure do |config|
   config.redis_host = "127.0.0.2"
   config.redis_port = 6390
   config.redis_db = 10
@@ -98,10 +98,18 @@ Basket.config do |config|
 end
 ```
 
-The defaults for a redis backend are the standard "127.0.0.1", 6379, 15 with a namespace of :basket.
+The defaults for a redis backend are the standard `"127.0.0.1"`, `6379`, `15` with a namespace of `:basket`.
 
 The default for the backend is the HashBackend, which can be set by passing `:hash` to `config.backend`, but you don't have to do that.  Because it's the default!
 
+For the redis configuration, you can alternatively pass a url, thusly:
+
+```ruby
+Basket.configure do |config|
+  config.backend = :redis
+  config.redis_url = "redis://:p4ssw0rd@10.0.1.1:6380/15"
+end
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -110,6 +118,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 This project uses Guard to facilitate local development.  You can run it with `bundle exec guard`.  It will run specs on change to files and will run `standard --fix` after passing tests.
 
+Looking through the code base, the majority of the work happens in [lib/basket/handle_add.rb](https://github.com/nicholalexander/basket/blob/main/lib/basket/handle_add.rb).  Alternatively, you might be interested in the [backend adapters](https://github.com/nicholalexander/basket/tree/main/lib/basket/backend_adapter) for how the gem works with in memory hashes and/or a redis backend.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nicholalexander/basket. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nicholalexander/basket/blob/main/CODE_OF_CONDUCT.md).

data/basket.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "A simple way of accumulating things and then acting on them."
   spec.homepage = "https://github.com/nicholalexander/basket"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.0.6"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/nicholalexander/basket"

data/lib/basket/backend_adapter/redis_backend.rb

@@ -6,11 +6,7 @@ module Basket
       attr_reader :client
 
       def initialize
-        redis_connection = Redis.new(
-          host: Basket.config.redis_host,
-          port: Basket.config.redis_port,
-          db: Basket.config.redis_db
-        )
+        redis_connection = select_redis_connection
 
         @client = Redis::Namespace.new(
           Basket.config.namespace,
@@ -51,6 +47,28 @@ module Basket
       def deserialized_queue_data(queue)
         @client.lrange(queue, 0, -1).reverse.map { |marshalled_data| Marshal.load(marshalled_data) }
       end
+
+      def select_redis_connection
+        if Basket.config.redis_url
+          redis_connection_from_url
+        else
+          redis_connection_from_host
+        end
+      end
+
+      def redis_connection_from_host
+        Redis.new(
+          host: Basket.config.redis_host,
+          port: Basket.config.redis_port,
+          db: Basket.config.redis_db
+        )
+      end
+
+      def redis_connection_from_url
+        Redis.new(
+          url: Basket.config.redis_url
+        )
+      end
     end
   end
 end

data/lib/basket/configuration.rb

@@ -1,6 +1,6 @@
 module Basket
   class Configuration
-    attr_accessor :redis_host, :redis_port, :redis_db, :namespace
+    attr_accessor :redis_host, :redis_port, :redis_db, :namespace, :redis_url
     attr_reader :backend
 
     def initialize
@@ -9,6 +9,7 @@ module Basket
       @redis_db = 15
       @backend = BackendAdapter::HashBackend
       @namespace = :basket
+      @redis_url = nil
     end
 
     def backend=(backend)

data/lib/basket/handle_add.rb

@@ -7,43 +7,58 @@ module Basket
     def initialize(queue, data)
       @queue = queue
       @data = data
-      @queue_collection = Basket.queue_collection
     end
 
-    def call(data = @data)
-      queue_length = @queue_collection.push(@queue, data)
-      queue_class = class_for_queue
-      queue_instance = queue_class.new
+    def call
+      setup_batchers
+      add_to_basket
+      perform if basket_full?(@queue_length, @queue_class)
+    rescue => error
+      maybe_raise_basket_error(error)
+      failure(error)
+    end
 
-      queue_instance.define_singleton_method(:element) { data }
-      queue_instance.on_add
+    private
 
-      return unless basket_full?(queue_length, queue_class)
+    def setup_batchers
+      @queue_collection = Basket.queue_collection
+      @queue_class = class_for_queue
+      @queue_instance = @queue_class.new
+    end
 
-      queue_instance.perform
-      queue_instance.on_success
-      @queue_collection.clear(@queue)
-    rescue => e
-      raise e if basket_error?(e)
+    def add_to_basket(data = @data)
+      @queue_length = @queue_collection.push(@queue, data)
+      @queue_instance.define_singleton_method(:element) { data }
+      @queue_instance.on_add
+    end
 
-      queue_instance.define_singleton_method(:error) { e }
-      queue_instance.on_failure
+    def perform
+      @queue_instance.perform
+      @queue_instance.on_success
+      @queue_collection.clear(@queue)
     end
 
-    private
+    def failure(error)
+      @queue_instance.define_singleton_method(:error) { error }
+      @queue_instance.on_failure
+    end
 
     def class_for_queue
+      raise_basket_not_found unless Object.const_defined?(@queue)
       Object.const_get(@queue)
-    rescue NameError => e
-      raise Basket::BasketNotFoundError, "We couldn't find that basket anywhere, please make sure it is defined. | #{e.message}"
+    end
+
+    def raise_basket_not_found
+      raise Basket::BasketNotFoundError, "We couldn't find that basket anywhere, please make sure it is defined."
     end
 
     def basket_full?(queue_length, queue_class)
       queue_length == queue_class.basket_options_hash[:size]
     end
 
-    def basket_error?(e)
-      e.instance_of?(Basket::Error) || e.instance_of?(Basket::BasketNotFoundError)
+    def maybe_raise_basket_error(e)
+      raise e if e.instance_of?(Basket::Error)
+      raise e if e.instance_of?(Basket::BasketNotFoundError)
     end
   end
 end

data/lib/basket/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Basket
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basket
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - nichol alexander
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -98,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="