basket 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3e9da361b2587c986144240ada1490a812ae9a9d0f6f639c0e38c167874ac8
-  data.tar.gz: 936a8d8b31d126cd35913cc1c087ecffbca722a2d5cc06747b23f26ba90d9055
+  metadata.gz: 8ac7e6fe22a043a420bf43a2dddcf0a9eee9f9fc647624e6aeecadb0f6ffb0e6
+  data.tar.gz: 043aa8c1033f8b58cf28ca41609397eb7872846ef139e9fb10654700ef61cefc
 SHA512:
-  metadata.gz: 551534c644dbb4a269f2de9de81ae43aef66f7e41dedef2e27845d4edcd17584d74067339110611628052282f5601ca9d5c39dd7962a4a71103110b9d1b37b1a
-  data.tar.gz: 96af7b3698edec4b70b3fa13acbb007ee17a03750c2df6583ed42df0e144bc32da8074378425ac24a655e6630070d2bcadd5b9870f2e4523804003fcdbd72fb6
+  metadata.gz: 8075bdd1180e9a58b5debec7a9925b1b1a08c1fdec6935e36fba4f1442cb6372c21b5d4ea02215a78a5710d87787c4cfe826ed2f8a0cd0328f25bdab08f93b52
+  data.tar.gz: a91e1571c99a3a20432186464eaeb4f57068cda33aeddbc912b5e358c83106a11c698fa902e20b1c4dc2809558d1d650381982d61464c900750caf15380c44ab

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing to Basket
+
+This is a small project.  We welcome ideas, contributions, thoughts, issues, bug reports, questions and any other thing you might like to add.  
+
+If you do want to add something, open and issue and we will respond!  Our current list of issues is sort of short hand between to the two authors, but we'd be happy to clarify anything if you are so interested.
+
+We use `standardrb` for linting.
+We use `rspec`.
+
+If this is your first contribution to any open source project, we'd be happy to help you get something merged!  If you have an idea or question and are new to Ruby, we would love to help you!

data/Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in basket.gemspec
 gemspec
 
+gem "pry"
 gem "guard"
 gem "guard-rspec", require: false
 gem "guard-standardrb", require: false
@@ -13,4 +14,4 @@ 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"
+gem "standard", "~> 1.27"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    basket (0.0.6)
+    basket (0.0.7)
       redis
       redis-namespace
 
@@ -47,8 +47,8 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -64,7 +64,7 @@ GEM
       connection_pool
     redis-namespace (1.10.0)
       redis (>= 4)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -79,22 +79,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
-    rubocop-performance (1.15.2)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     shellany (0.0.1)
     simplecov (0.22.0)
@@ -106,10 +106,10 @@ GEM
       json
       simplecov
     simplecov_json_formatter (0.1.4)
-    standard (1.24.3)
+    standard (1.27.0)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.44.1)
-      rubocop-performance (= 1.15.2)
+      rubocop (~> 1.50.2)
+      rubocop-performance (~> 1.16.0)
     standardrb (1.0.1)
       standard
     thor (1.2.1)
@@ -128,11 +128,12 @@ DEPENDENCIES
   guard-standardrb
   mock_redis
   mocktail
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov
   simplecov-json
-  standard (~> 1.3)
+  standard (~> 1.27)
 
 BUNDLED WITH
    2.4.6

data/README.md

@@ -22,6 +22,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install basket
 
 ## Usage
+### Adding
 
 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.
 
@@ -34,6 +35,10 @@ end
 
 The item added to the basket can be any data you want!  If you are using the in memory Queue, it is fine to store Ruby objects, but if you have a different backend, must be JSON serializable via `to_json`.
 
+### Your basket
+
+When a basket has become full after you have added a bunch of things to it, it performs actions!  See below for the full definition of a basket.
+
 ```ruby
 class QuicheBasket
   # Include the Basket::Batcher
@@ -84,6 +89,51 @@ 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. 
 
+### Search
+
+You may search through your basket, if for example, you need to see if you've accidentally collected a robin egg and not a chicken egg!
+
+```ruby
+search_results = Basket.search("QuicheBasket") do |egg|
+  egg.color == "blue"
+end
+```
+
+The block you pass will match against the objects in your basket.  If you have ruby objects in your basket, you can match against their properties just as if you were accessing them one at a time.  If you have json objects in your basket, you will be searching through a hash thusly:
+
+```ruby
+search_results = Basket.search("PlaylistBasket") do |song|
+  song[:artist] == "Vansire"
+end
+```
+
+The search results will be a fully qualified basket element which will contain an id attribute and a data attribute.  In the case of using the MemoryBackend, you might see something like this:
+
+```ruby
+# ...continued from above
+search_results.first  #=> #<Basket::Element:0x00000001075d9c80
+                      #   @data=#<Egg color="blue", size="smol">
+                      #   @id="5fe3df9e-4063-4b67-a08f-e36b847087c7">
+```
+
+You'll note that the result of a search is an array of basket elements.  An element consists of the data that you put in and ID.  What is the id for?  Glad you asked.
+
+### Remove
+
+You can also remove something from your basket.  Perhaps it is deleted in the database and no longer contains a valid reference to data?  Perhaps you found that robin egg and don't actually want to use it to make a quiche, because who would?  Either way, removing the element is easy!
+
+```ruby
+# ...continued from above
+element_id_to_remove = search_results.first
+removed_egg = Basket.remove('Quiche', element_id_to_remove)
+removed_egg #=> #<Egg color="blue", size="smol">
+```
+
+Voila!
+
+### A Note of Warning
+
+Searching for and removing elements from your basket is an inherently tricky process as your basket may fill up and execute the `perform` action while searching and removing.
 ## Configuration
 
 In an initializer, or somewhere equally appropriate, you might put something like this:
@@ -132,5 +182,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 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).
 
+## Thanks
+
+This project has been a fun and educational use of Growth Time at [Test Double](https://testdouble.com/) where consultants are given 4hrs per week to grow their skills and work on projects that further the mission of building software, better.
 
+## Authors
 
+* [Nichol Alexander](https://github.com/nicholalexander/)
+* [Alec Clarke](https://github.com/alecclarke)

data/SECURITY.md

@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+We support Ruby versions as below:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 3.2.2   | :white_check_mark: |
+| 3.1.4   | :white_check_mark: |
+| 3.0.6   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security related bug, please don't file an issue for it and instead let us know directly!

data/lib/basket/backend_adapter/memory_backend.rb

@@ -22,6 +22,17 @@ module Basket
         @data[queue]
       end
 
+      def search(queue, &block)
+        @data[queue].select { |element| block.call(element.data) }
+      end
+
+      def remove(queue, id)
+        index_of_element_to_delete = @data[queue].index { |element| element.id == id }
+        @data[queue].delete_at(index_of_element_to_delete)
+      rescue
+        nil
+      end
+
       def clear(queue)
         @data[queue] = []
       end

data/lib/basket/backend_adapter/redis_backend.rb

@@ -1,5 +1,4 @@
 require "redis-namespace"
-require "json"
 
 module Basket
   class BackendAdapter
@@ -25,6 +24,18 @@ module Basket
         response
       end
 
+      def search(queue, &block)
+        deserialized_queue_data(queue).select { |raw_element| block.call(raw_element["data"]) }
+      end
+
+      def remove(queue, element_id)
+        element = deserialized_queue_data(queue).find { |raw_element| raw_element["id"] == element_id }
+
+        @client.lrem(queue, 1, element.to_json)
+
+        element
+      end
+
       def push(queue, data)
         @client.lpush(queue, serialize_data(data))
       end

data/lib/basket/element.rb

@@ -0,0 +1,38 @@
+require "securerandom"
+
+module Basket
+  class Element
+    class InvalidElement < StandardError; end
+
+    attr_reader :data, :id
+
+    def self.from_queue(element)
+      if element.is_a?(Element)
+        element
+      elsif element.is_a?(Hash)
+        new(element["data"], element["id"])
+      else
+        raise InvalidElement, "element must be a hash or a Basket::Element"
+      end
+    end
+
+    def initialize(data, id = SecureRandom.uuid)
+      raise InvalidElement, "both data and id must be present" unless data && id
+
+      @data = data
+      @id = id
+    end
+
+    def to_h
+      {data: data, id: id}
+    end
+
+    def to_json(*)
+      to_h.to_json
+    end
+
+    def ==(other)
+      to_h == other.to_h
+    end
+  end
+end

data/lib/basket/error.rb

@@ -2,4 +2,8 @@ module Basket
   class Error < StandardError; end
 
   class BasketNotFoundError < Error; end
+
+  class EmptyBasketError < Error; end
+
+  class ElementNotFoundError < Error; end
 end

data/lib/basket/queue_collection.rb

@@ -5,7 +5,7 @@ module Basket
     end
 
     def push(queue, data)
-      @backend.push(queue, data)
+      @backend.push(queue, Element.new(data))
       length(queue)
     end
 
@@ -14,7 +14,22 @@ module Basket
     end
 
     def read(queue)
-      @backend.read(queue)
+      check_for_basket(queue)
+      raw_queue = @backend.read(queue)
+      raw_queue.map { |element| Element.from_queue(element).data }
+    end
+
+    def search(queue, query)
+      check_for_basket(queue)
+      check_for_zero_length(queue)
+      raw_search_results = @backend.search(queue, &query)
+      raw_search_results.map { |raw_search_result| Element.from_queue(raw_search_result) }
+    end
+
+    def remove(queue, id)
+      raw_removed_element = @backend.remove(queue, id)
+      check_for_raw_removed_element(raw_removed_element)
+      Element.from_queue(raw_removed_element).data
     end
 
     def clear(queue)
@@ -28,5 +43,19 @@ module Basket
     def reset_backend
       @backend = Basket.config.backend.new
     end
+
+    private
+
+    def check_for_basket(queue)
+      raise Basket::BasketNotFoundError unless Object.const_defined?(queue)
+    end
+
+    def check_for_zero_length(queue)
+      raise Basket::EmptyBasketError, "The basket #{queue} is empty." if length(queue).zero?
+    end
+
+    def check_for_raw_removed_element(raw_removed_element)
+      raise Basket::ElementNotFoundError if raw_removed_element.nil?
+    end
   end
 end

data/lib/basket/version.rb

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

data/lib/basket.rb

@@ -5,11 +5,14 @@ require_relative "basket/backend_adapter/memory_backend"
 require_relative "basket/backend_adapter/redis_backend"
 require_relative "basket/batcher"
 require_relative "basket/configuration"
+require_relative "basket/element"
 require_relative "basket/error"
 require_relative "basket/handle_add"
 require_relative "basket/queue_collection"
 require_relative "basket/version"
 
+require "json"
+
 module Basket
   class Error < StandardError; end
 
@@ -25,6 +28,10 @@ module Basket
     @queue_collection.data
   end
 
+  def self.peek(queue)
+    queue_collection.read(queue)
+  end
+
   def self.queue_collection
     @queue_collection ||= Basket::QueueCollection.new
   end
@@ -33,6 +40,14 @@ module Basket
     HandleAdd.call(queue, data)
   end
 
+  def self.search(queue, &query)
+    queue_collection.search(queue, query)
+  end
+
+  def self.remove(queue, id)
+    queue_collection.remove(queue, id)
+  end
+
   def self.clear_all
     queue_collection.reset_backend
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basket
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - nichol alexander
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,12 +66,14 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - basket.gemspec
 - lib/basket.rb
 - lib/basket/backend_adapter.rb
@@ -79,6 +81,7 @@ files:
 - lib/basket/backend_adapter/redis_backend.rb
 - lib/basket/batcher.rb
 - lib/basket/configuration.rb
+- lib/basket/element.rb
 - lib/basket/error.rb
 - lib/basket/handle_add.rb
 - lib/basket/queue_collection.rb