basket 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d11f37f0087fb606bf92362eb1c913e9f089b262d130a13edfb22d639055c374
-  data.tar.gz: b66835a0ad01af6b29b528a2e7bd481331e64b0b437586a42a504ecc27d3c1b7
+  metadata.gz: '092352c400ad4483af38e9afe1060a39c6162c7318e4c69fb1ecd7649af56344'
+  data.tar.gz: 9a6cb3e5937d7367b6e83bae58e796c71c7a2a7b77cec5bbbbd5178bf4e0107b
 SHA512:
-  metadata.gz: f015621c801d42ef33fc3090d244b8a53f8a8830d7230ce73177287ba9b7ab3a7fe41129a6427c66a1119e17e0fb75e1be82bfbca0424026bdbefb0d33e94a79
-  data.tar.gz: 4ae3e63475e3fb68e2177356d44f5a92b332b31efe43081c76f3df5824751f4ed3d203b39f3d01e227edea063466220e9ec4bd63a6cb272f8f560fbb70c31ce9
+  metadata.gz: a0f510f3e3f9c7b7accff0b76580d426e939d82212d6a4d83979f3043e4d679c8fafe994e58f788cf920110f3094e45cac1e290b50c802a22a5937358cdabd86
+  data.tar.gz: 33798eb722f92da71a396bac9529676f34cde316cdf3824fe5c42e66cfca26444caedb615fdcbad4ff67374a0a60dd646daf93eb349e0ee4d880f22b2186b2be

data/Gemfile

@@ -5,13 +5,12 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in basket.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-gem "mocktail"
-
-gem "standard", "~> 1.3"
-
 gem "guard"
 gem "guard-rspec", require: false
 gem "guard-standardrb", require: false
+gem "mocktail"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "simplecov", require: false, group: :test
+gem "simplecov-json", require: false, group: :test
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -2,13 +2,17 @@ PATH
   remote: .
   specs:
     basket (0.0.2)
+      redis
+      redis-namespace
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     coderay (1.1.3)
+    connection_pool (2.3.0)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     ffi (1.15.5)
     formatador (1.1.0)
     guard (2.18.0)
@@ -36,6 +40,8 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
+    mock_redis (0.36.0)
+      ruby2_keywords
     mocktail (1.2.2)
     nenv (0.3.0)
     notiffany (0.1.3)
@@ -52,6 +58,12 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    redis (5.0.6)
+      redis-client (>= 0.9.0)
+    redis-client (0.14.0)
+      connection_pool
+    redis-namespace (1.10.0)
+      redis (>= 4)
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -83,7 +95,17 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
+    simplecov_json_formatter (0.1.4)
     standard (1.24.3)
       language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.44.1)
@@ -104,9 +126,12 @@ DEPENDENCIES
   guard
   guard-rspec
   guard-standardrb
+  mock_redis
   mocktail
   rake (~> 13.0)
   rspec (~> 3.0)
+  simplecov
+  simplecov-json
   standard (~> 1.3)
 
 BUNDLED WITH

data/Guardfile

@@ -15,7 +15,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'
@@ -25,10 +25,10 @@
 #  * 'just' rspec: 'rspec'
 
 group "specs", halt_on_fail: true do
-  guard :rspec, all_on_start: false, cmd: "rspec" do
+  guard :rspec, all_on_start: true, all_after_pass: true, cmd: "rspec" do
     watch(%r{^spec/.+_spec\.rb$})
-    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
-    watch("spec/spec_helper.rb") { "spec/lib" }
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch("spec/spec_helper.rb") { "spec/" }
   end
 
   guard :standardrb, fix: true, all_on_start: true, progress: true do

data/README.md

@@ -1,4 +1,8 @@
 [![Gem Version](https://badge.fury.io/rb/basket.svg)](https://badge.fury.io/rb/basket)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Tests](https://github.com/nicholalexander/basket/actions/workflows/main.yml/badge.svg)](https://github.com/nicholalexander/basket/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dab6a6e193cbd9df2b3e/maintainability)](https://codeclimate.com/github/nicholalexander/basket/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/dab6a6e193cbd9df2b3e/test_coverage)](https://codeclimate.com/github/nicholalexander/basket/test_coverage)
 # Basket
 
 A farmer doesn't walk down to the chicken coop, grab an egg, go back to the kitchen, go back to the coop, go back to the kitchen ad infinitum.  They take a basket with them, and as the chickens lay their eggs, they fill up the basket and when the basket is full they go make something with them!  I would make a quiche, but that's besides the case.
@@ -51,7 +55,7 @@ class QuicheBasket
     BrunchInviteJob.perform_async
   end
  
-  # There are four callbacks to the lifecycle of a basket.
+  # There are three callbacks to the lifecycle of a basket.
   # :on_add, :on_success, and :on_failure.
   # They can be used like this:
   def on_success
@@ -80,6 +84,24 @@ The `on_failure` use of `batch` of course may not have a full batch as the error
 
 Defining `on_add`, `on_failure`, and `on_success` is optional. 
 
+## Configuration
+
+In an initializer, or somewhere equally appropriate, you might put something like this:
+
+```ruby
+Basket.config do |config|
+  config.redis_host = "127.0.0.2"
+  config.redis_port = 6390
+  config.redis_db = 10
+  config.backend = :redis
+  config.namespace = :basket
+end
+```
+
+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!
+
 ## 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.
@@ -90,7 +112,7 @@ This project uses Guard to facilitate local development.  You can run it with `b
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/basket/blob/main/CODE_OF_CONDUCT.md).
+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).
 
 ## License
 
@@ -98,7 +120,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Basket project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/basket/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Basket project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nicholalexander/basket/blob/main/CODE_OF_CONDUCT.md).
 
 
 

data/basket.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/basket/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "basket"
+  spec.version = Basket::VERSION
+  spec.authors = ["nichol alexander", "alec clarke"]
+  spec.email = ["nichol.alexander@gmail.com", "alec.clarke.dev@gmail.com"]
+
+  spec.summary = "Wait until you have a bunch of things, then do something."
+  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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nicholalexander/basket"
+  spec.metadata["changelog_uri"] = "https://github.com/nicholalexander/basket/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+  spec.add_dependency "redis-namespace"
+
+  spec.add_development_dependency "mock_redis"
+end

data/lib/basket/backend_adapter/hash_backend.rb

@@ -0,0 +1,30 @@
+module Basket
+  class BackendAdapter
+    class HashBackend < Basket::BackendAdapter
+      def initialize
+        @data = {}
+      end
+
+      attr_reader :data
+
+      def push(queue, data)
+        @data[queue] = [] if @data[queue].nil?
+        @data[queue] <<= data
+      end
+
+      def length(queue)
+        return 0 if @data[queue].nil?
+
+        @data[queue].length
+      end
+
+      def read(queue)
+        @data[queue]
+      end
+
+      def clear(queue)
+        @data[queue] = []
+      end
+    end
+  end
+end

data/lib/basket/backend_adapter/redis_backend.rb

@@ -0,0 +1,56 @@
+require "redis-namespace"
+
+module Basket
+  class BackendAdapter
+    class RedisBackend < Basket::BackendAdapter
+      attr_reader :client
+
+      def initialize
+        redis_connection = Redis.new(
+          host: Basket.config.redis_host,
+          port: Basket.config.redis_port,
+          db: Basket.config.redis_db
+        )
+
+        @client = Redis::Namespace.new(
+          Basket.config.namespace,
+          redis: redis_connection
+        )
+      end
+
+      def data
+        response = {}
+
+        @client.scan_each do |queue|
+          response[queue] = deserialized_queue_data(queue)
+        end
+
+        response
+      end
+
+      def push(queue, data)
+        # TODO: should we use JSON vs Marshal?
+        marshalled_data = Marshal.dump(data)
+        @client.lpush(queue, marshalled_data)
+      end
+
+      def length(queue)
+        @client.llen(queue)
+      end
+
+      def clear(queue)
+        @client.del(queue)
+      end
+
+      def read(queue)
+        deserialized_queue_data(queue)
+      end
+
+      private
+
+      def deserialized_queue_data(queue)
+        @client.lrange(queue, 0, -1).reverse.map { |marshalled_data| Marshal.load(marshalled_data) }
+      end
+    end
+  end
+end

data/lib/basket/backend_adapter.rb

@@ -0,0 +1,23 @@
+module Basket
+  class BackendAdapter
+    def data
+      raise "must implement data"
+    end
+
+    def push(queue, data)
+      raise "must implement push with queue and data params"
+    end
+
+    def length(queue)
+      raise "must implement length with queue param"
+    end
+
+    def read(queue)
+      raise "must implement read with queue param"
+    end
+
+    def clear(queue)
+      raise "must implement clear with queue param"
+    end
+  end
+end

data/lib/basket/batcher.rb

@@ -1,4 +1,3 @@
-require_relative "./error"
 module Basket
   module Batcher
     def self.included(base)
@@ -13,12 +12,13 @@ module Basket
       def basket_options_hash
         raise Basket::Error, "You must specify the size of your basket!" if @basket_options.nil?
         raise Basket::Error, "You must specify a size greater than 0" if @basket_options[:size] <= 0
+
         @basket_options
       end
     end
 
     def batch
-      @batch ||= Basket.config.queue_collection.pop_all(self.class.name)
+      @batch ||= Basket.queue_collection.read(self.class.name)
     end
 
     def perform

data/lib/basket/configuration.rb

@@ -1,7 +1,25 @@
 module Basket
   class Configuration
-    def queue_collection
-      @queue_collection ||= Basket::QueueCollection.new
+    attr_accessor :redis_host, :redis_port, :redis_db, :namespace
+    attr_reader :backend
+
+    def initialize
+      @redis_host = "127.0.0.1"
+      @redis_port = 6379
+      @redis_db = 15
+      @backend = BackendAdapter::HashBackend
+      @namespace = :basket
+    end
+
+    def backend=(backend)
+      case backend
+      when :hash
+        @backend = BackendAdapter::HashBackend
+      when :redis
+        @backend = BackendAdapter::RedisBackend
+      else
+        raise Basket::Error, "Unknown Backend"
+      end
     end
   end
 end

data/lib/basket/error.rb

@@ -1,4 +1,5 @@
 module Basket
-  class Error < StandardError
-  end
+  class Error < StandardError; end
+
+  class BasketNotFoundError < Error; end
 end

data/lib/basket/handle_add.rb

@@ -0,0 +1,49 @@
+module Basket
+  class HandleAdd
+    def self.call(queue, data)
+      new(queue, data).call
+    end
+
+    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
+
+      queue_instance.define_singleton_method(:element) { data }
+      queue_instance.on_add
+
+      return unless basket_full?(queue_length, queue_class)
+
+      queue_instance.perform
+      queue_instance.on_success
+      @queue_collection.clear(@queue)
+    rescue => e
+      raise e if basket_error?(e)
+
+      queue_instance.define_singleton_method(:error) { e }
+      queue_instance.on_failure
+    end
+
+    private
+
+    def class_for_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 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)
+    end
+  end
+end

data/lib/basket/queue_collection.rb

@@ -1,7 +1,7 @@
 module Basket
   class QueueCollection
-    def initialize(backend = HashBackend.new)
-      @backend = backend
+    def initialize(backend = Basket.config.backend)
+      @backend = backend.new
     end
 
     def push(queue, data)
@@ -13,8 +13,12 @@ module Basket
       @backend.length(queue)
     end
 
-    def pop_all(queue)
-      @backend.pop_all(queue)
+    def read(queue)
+      @backend.read(queue)
+    end
+
+    def clear(queue)
+      @backend.clear(queue)
     end
 
     def data
@@ -22,7 +26,7 @@ module Basket
     end
 
     def reset_backend
-      @backend = HashBackend.new
+      @backend = Basket.config.backend.new
     end
   end
 end

data/lib/basket/version.rb

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

data/lib/basket.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "basket/backend_adapter"
+require_relative "basket/backend_adapter/hash_backend"
+require_relative "basket/backend_adapter/redis_backend"
 require_relative "basket/batcher"
 require_relative "basket/configuration"
 require_relative "basket/error"
-require_relative "basket/hash_backend"
+require_relative "basket/handle_add"
 require_relative "basket/queue_collection"
 require_relative "basket/version"
 
@@ -14,30 +17,23 @@ module Basket
     @config ||= Configuration.new
   end
 
+  def self.configure
+    yield(config)
+  end
+
   def self.contents
     @queue_collection.data
   end
 
+  def self.queue_collection
+    @queue_collection ||= Basket::QueueCollection.new
+  end
+
   def self.add(queue, data)
-    @queue_collection = config.queue_collection
-    queue_length = @queue_collection.push(queue, data)
-    queue_class = Object.const_get(queue)
-    queue_instance = queue_class.new
-
-    queue_instance.define_singleton_method(:element) { data }
-    queue_instance.on_add
-
-    return unless queue_length == queue_class.basket_options_hash[:size]
-
-    queue_instance.perform
-    queue_instance.on_success
-  rescue => e
-    raise e if e.instance_of?(Basket::Error)
-    queue_instance.define_singleton_method(:error) { e }
-    queue_instance.on_failure
+    HandleAdd.call(queue, data)
   end
 
   def self.clear_all
-    config.queue_collection.reset_backend
+    queue_collection.reset_backend
   end
 end

metadata

@@ -1,18 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: basket
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - nichol alexander
+- alec clarke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-05 00:00:00.000000000 Z
-dependencies: []
-description: This is a longer description.
+date: 2023-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  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: A simple way of accumulating things and then acting on them.
 email:
-- 'nichol.alexander@gmail.com '
+- nichol.alexander@gmail.com
+- alec.clarke.dev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -27,11 +71,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- basket.gemspec
 - lib/basket.rb
+- lib/basket/backend_adapter.rb
+- lib/basket/backend_adapter/hash_backend.rb
+- lib/basket/backend_adapter/redis_backend.rb
 - lib/basket/batcher.rb
 - lib/basket/configuration.rb
 - lib/basket/error.rb
-- lib/basket/hash_backend.rb
+- lib/basket/handle_add.rb
 - lib/basket/queue_collection.rb
 - lib/basket/version.rb
 - sig/basket.rbs
@@ -57,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Wait until you have a bunch of things, then do something.

data/lib/basket/hash_backend.rb

@@ -1,24 +0,0 @@
-module Basket
-  class HashBackend
-    attr_reader :data
-
-    def initialize
-      @data = {}
-    end
-
-    def push(queue, data)
-      @data[queue] = [] if @data[queue].nil?
-      @data[queue] <<= data
-    end
-
-    def length(queue)
-      return 0 if @data[queue].nil?
-
-      @data[queue].length
-    end
-
-    def pop_all(queue)
-      @data.delete(queue)
-    end
-  end
-end