basket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ae2ec64c54d8a1ae452a284e20f8bc2393318f7333bcbc7152bf24236e4b26
-  data.tar.gz: 8cb26c727cbc2c49ea906a6f949c6b1a8631a9bea3200b446f7ee2b4a8c15a59
+  metadata.gz: d11f37f0087fb606bf92362eb1c913e9f089b262d130a13edfb22d639055c374
+  data.tar.gz: b66835a0ad01af6b29b528a2e7bd481331e64b0b437586a42a504ecc27d3c1b7
 SHA512:
-  metadata.gz: 7f0b0410eb3ad97c9ca857e875c031d5d0bbee7183f62dc22d087424d503c16b2f5c7080aa1f458b89a07719eace55fae46b87f6df079cc8a4cc341b8a00f17a
-  data.tar.gz: a6924dd3d2e1b3d3b731cbcbe2fa473718785244e432fd87a9de11e29a3f0275380581dbf5844a5e0d7bbbb6377a262e6592a657f0f1df5d5f0517f0697869ed
+  metadata.gz: f015621c801d42ef33fc3090d244b8a53f8a8830d7230ce73177287ba9b7ab3a7fe41129a6427c66a1119e17e0fb75e1be82bfbca0424026bdbefb0d33e94a79
+  data.tar.gz: 4ae3e63475e3fb68e2177356d44f5a92b332b31efe43081c76f3df5824751f4ed3d203b39f3d01e227edea063466220e9ec4bd63a6cb272f8f560fbb70c31ce9

data/Gemfile

@@ -8,5 +8,10 @@ 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

data/Gemfile.lock

@@ -1,20 +1,57 @@
 PATH
   remote: .
   specs:
-    basket (0.1.0)
+    basket (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-standardrb (0.2.2)
+      guard (>= 2.0.0)
+      guard-compat (~> 1.0)
+      standardrb
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mocktail (1.2.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -46,19 +83,28 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    shellany (0.0.1)
     standard (1.24.3)
       language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.44.1)
       rubocop-performance (= 1.15.2)
+    standardrb (1.0.1)
+      standard
+    thor (1.2.1)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   arm64-darwin-22
   x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
   basket!
+  guard
+  guard-rspec
+  guard-standardrb
+  mocktail
   rake (~> 13.0)
   rspec (~> 3.0)
   standard (~> 1.3)

data/Guardfile

@@ -0,0 +1,37 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# 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
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+group "specs", halt_on_fail: true do
+  guard :rspec, all_on_start: false, 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" }
+  end
+
+  guard :standardrb, fix: true, all_on_start: true, progress: true do
+    watch(/.+\.rb$/)
+  end
+end

data/README.md

@@ -1,21 +1,21 @@
-# It would be silly to use this gem because it doesn't work yet.
+[![Gem Version](https://badge.fury.io/rb/basket.svg)](https://badge.fury.io/rb/basket)
 # 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, etc, etc.  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.
+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.
 
 `Basket` lets you do just that.  Collect items until your basket is full and then, when it is, go do something with them!
 
-## Installation
+Basket is very new and under development.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add basket
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install basket
 
 ## Usage
 
@@ -32,21 +32,19 @@ The item added to the basket can be any data you want!  If you are using the in
 
 ```ruby
 class QuicheBasket
+  # Include the Basket::Batcher
   include Basket::Batcher
-  
-  basket_options length: 15
+
+  # Define the size of your basket
+  basket_options size: 15
 
   def perform
-    eggs = []
     batch.each do | egg |
-      # do some processing on each element of the batch.  In this case there will be 15 eggs.
-      egg = Egg.new(egg)
-      egg.wash!
-      eggs << egg
+      # Do some processing on each element of the batch.  In this case there will be 15 eggs.
     end
 
     # If you want to do something directly inline:
-    Quiche.make(eggs)
+    Quiche.make(batch)
 
     # If you want to do something out of a request response cycle,
     # call out to your favorite background processing framework:
@@ -54,18 +52,33 @@ class QuicheBasket
   end
  
   # There are four callbacks to the lifecycle of a basket.
-  # :on_success, :on_failure, :on_add, :check_length
+  # :on_add, :on_success, and :on_failure.
   # They can be used like this:
-  on_success: :let_chickens_rest
+  def on_success
+    Farm.rest_chickens
+    batch.each do |egg|
+      egg.inspect
+    end
+  end
 
-  def let_chickens_rest
-    ... 
+  def on_add
+    element.wash
   end
 
+  def on_failure
+    Farm.notify_egg_monitor(error)
+    raise Error
+  end
 end
 ```
 
-The perform method will be called after there have been 15 elements added to the batch.  The callbacks are lifecycle callbacks on the existing batch.  `on_add` takes an argument of the element that is being added.  The elements are just a hash.  `on_success` and `on_failure` give access to the whole batch.
+The perform method will be called after there have been the defined number of elements added to the batch, specified in the `basket_options` size parameter.  The elements can be any kind of data, depending on the backend that you are using.  The default is just an in-memory hash.
+
+The callbacks are lifecycle callbacks on the existing batch.  `on_add` gives access to a variable called `element` which is equal to the item just added to the batch. `on_add`, `on_success` and `on_failure` also give access to the whole batch through the `batch` variable.  `on_success` is called after `perform`.  
+
+The `on_failure` use of `batch` of course may not have a full batch as the error could have been generated during `add` or `on_add`.  The `on_failure` callback also has access to an `error` variable which holds the error that was generated.  
+
+Defining `on_add`, `on_failure`, and `on_success` is optional. 
 
 ## Development
 
@@ -73,6 +86,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+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.
+
 ## 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).
@@ -87,22 +102,3 @@ Everyone interacting in the Basket project's codebases, issue trackers, chat roo
 
 
 
-## Ideas
-
-1. Can the callbacks support ActiveSupport Notifications?
-   - ActiveSupport::Callbacks extraction of callbacks
-2. Batch can be postgres json blob or Redis! - Backend system
-~~3. Does not execute in line~~For now.
-~~4. Use ActiveJob for background execution.~~ It's up to you to handle a full basket how you want.
-~~5. "Buffer", "collection", "queue"~~ Basket.
-6. Default trigger is just queue length.
-7. Expose basket_options trigger: :check_some_thing_lambda
-8. Redis push pop.
-9. Make queue ephemeral?
-10. Define gotchas but don't solve them.
-11. Redis fetch / Super Fetch?
-12. Configuration.
-
-https://api.rubyonrails.org/classes/ActiveSupport/Callbacks.html
-
-

data/lib/basket/batcher.rb

@@ -1,4 +1,38 @@
+require_relative "./error"
 module Basket
   module Batcher
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def basket_options(args)
+        @basket_options = args
+      end
+
+      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)
+    end
+
+    def perform
+      raise Basket::Error, "You must implement perform in your Basket class."
+    end
+
+    def on_success
+    end
+
+    def on_add
+    end
+
+    def on_failure
+      raise error
+    end
   end
 end

data/lib/basket/configuration.rb

@@ -0,0 +1,7 @@
+module Basket
+  class Configuration
+    def queue_collection
+      @queue_collection ||= Basket::QueueCollection.new
+    end
+  end
+end

data/lib/basket/error.rb

@@ -0,0 +1,4 @@
+module Basket
+  class Error < StandardError
+  end
+end

data/lib/basket/{queue.rb → queue_collection.rb}

@@ -1,5 +1,5 @@
 module Basket
-  class Queue
+  class QueueCollection
     def initialize(backend = HashBackend.new)
       @backend = backend
     end
@@ -20,5 +20,9 @@ module Basket
     def data
       @backend.data
     end
+
+    def reset_backend
+      @backend = HashBackend.new
+    end
   end
 end

data/lib/basket/version.rb

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

data/lib/basket.rb

@@ -1,18 +1,43 @@
 # frozen_string_literal: true
 
 require_relative "basket/batcher"
+require_relative "basket/configuration"
+require_relative "basket/error"
 require_relative "basket/hash_backend"
-require_relative "basket/queue"
+require_relative "basket/queue_collection"
 require_relative "basket/version"
 
 module Basket
   class Error < StandardError; end
 
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.contents
+    @queue_collection.data
+  end
+
   def self.add(queue, data)
-    queue_length = Basket::Queue.push(queue, data)
-    queue_class = queue.constantize.new
-    return unless queue_length == queue_class.batcher.options.queue_length
+    @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
+  end
 
-    queue_class.perform
+  def self.clear_all
+    config.queue_collection.reset_backend
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basket
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - nichol alexander
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-03-05 00:00:00.000000000 Z
 dependencies: []
 description: This is a longer description.
 email:
@@ -23,14 +23,16 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- basket.gemspec
 - lib/basket.rb
 - lib/basket/batcher.rb
+- lib/basket/configuration.rb
+- lib/basket/error.rb
 - lib/basket/hash_backend.rb
-- lib/basket/queue.rb
+- lib/basket/queue_collection.rb
 - lib/basket/version.rb
 - sig/basket.rbs
 homepage: https://github.com/nicholalexander/basket
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.3.24
 signing_key:
 specification_version: 4
 summary: Wait until you have a bunch of things, then do something.

data/basket.gemspec

@@ -1,37 +0,0 @@
-# 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"]
-  spec.email = ["nichol.alexander@gmail.com "]
-
-  spec.summary = "Wait until you have a bunch of things, then do something."
-  spec.description = "This is a longer description."
-  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"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  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"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end