box-office 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc1e432c18b1eadb7ef991820265cfb8932291ad1c876df5099e47accb796a29
+  data.tar.gz: 4f9f0bd0024ca3ba404853443dc320f65820bdbe0e19d60ac6045002e155ed66
+SHA512:
+  metadata.gz: ac5ce90044ec865ab6e272a64f07e2f1bd21a18ff3b7194647a2ef0aaf2c3230ea8f3b9e9470226b8ad84fe0d55b228adb0660398c368237d8bcde75241d1e78
+  data.tar.gz: eefb458087ce0aeabd5c0702dc433765fdf1fe727ca06a4df8571b7d0ceb8b8475546f90160cb88fb13ee6b60a2fe92d74ab99d6d7c3e56fb94f921d3d4ebeda

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+  - 2.6.0
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dvmonroe6@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in box-office.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Drew Monroe
+
+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,52 @@
+# Box::Office
+
+A queue worth lining up for.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'box-office'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install box-office
+
+## Usage
+
+```
+# showing = Box::Office.showing(name: "Jurassic Park", showings: 5)
+
+# showing.standby.push %w(1 2 3)
+# showing << %w(1 2 3)
+# showing.reserve do |queue, members|
+#   p queue
+#   p members
+# end 
+
+# showing.reserved(1)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/box-office. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Box::Office project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/box-office/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "box/office"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/box-office.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "box/office/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "box-office"
+  spec.version       = Box::Office::VERSION
+  spec.authors       = ["Drew Monroe"]
+  spec.email         = ["dvmonroe6@gmail.com"]
+
+  spec.summary       = "Reliable redis queueing"
+  spec.homepage      = "http://github.com/dvmonroe/box-office"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5.2"
+  spec.add_dependency "redis", "~> 4.1"
+  spec.add_dependency "redlock", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", ">= 1.3"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.61.0"
+end

data/lib/box/office.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "active_support/inflector"
+require "redis"
+require "redlock"
+
+require "box/office/version"
+require "box/office/configuration"
+
+require "box/office/connection"
+
+require "box/office/janitor"
+require "box/office/booth"
+require "box/office/queue"
+require "box/office/showing"
+
+module Box
+  module Office
+    class NoOpenings < StandardError; end
+    class QueueInUse < StandardError; end
+    class NotBoolean < StandardError; end
+    class OutOfRange < StandardError; end
+
+    class << self
+      def showing(name: config.default_name, track_fulfilled: config.track_fulfilled,
+                  showings: config.showings, capacity: config.capacity)
+        Showing.new(name: name, track_fulfilled: track_fulfilled, showings: showings, capacity: capacity)
+      end
+    end
+  end
+end

data/lib/box/office/booth.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Box
+  module Office
+    class Booth
+      include Box::Office::Connection
+      attr_reader :showing
+
+      delegate :config, to: Box::Office
+
+      def initialize(showing:)
+        @showing = showing
+      end
+
+      def first_available_opening(conn)
+        1.upto(showing.showings) do |idx|
+          queue = find_queue(idx)
+
+          Redlock::Client.new([conn]).lock("#{queue.name}-locked", 3000) do |locked|
+            if locked && !Janitor.locked?(queue.name) && queue.length < showing.capacity
+              yield queue
+              return
+            end
+          end
+
+          next if idx < showing.showings
+
+          raise NoOpenings, "No available openings for #{showing.name}"
+        end
+      end
+
+      private
+
+      def find_queue(idx)
+        showing.send(config.reserved, idx)
+      end
+    end
+  end
+end

data/lib/box/office/configuration.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Box
+  module Office
+    class Configuration
+      # Redis instance
+      # @return [Object]
+      attr_accessor :instance
+
+      attr_accessor :pool_size
+
+      attr_accessor :standby
+
+      attr_accessor :reserved
+
+      attr_accessor :fulfilled
+
+      attr_accessor :showings
+
+      attr_accessor :default_name
+
+      attr_accessor :track_fulfilled
+
+      attr_accessor :capacity
+
+      attr_accessor :lock_reserved
+
+      def initialize
+        @instance         = Redis.current
+        @pool_size        = 5
+
+        @standby          = :standby
+        @reserved         = :reserved
+        @fulfilled        = :fulfilled
+        @showings         = 1
+        @track_fulfilled  = true
+        @capacity         = 100
+        @default_name     = "Box Office Hit"
+        @lock_reserved    = true
+      end
+
+      instance_methods.each do |meth|
+        define_method("#{meth}?") do
+          return send(meth) == true if !!send(meth) == send(meth) # rubocop:disable Style/DoubleNegation
+
+          raise NotBoolean, "Configuration##{meth} does not return a Boolean and therefore, has no predicate method."
+        end
+      end
+
+      def single_queues
+        queues - [reserved]
+      end
+
+      def queues
+        [standby, reserved, fulfilled]
+      end
+    end
+
+    # @return [Box::Office::Configuration] Box::Office's current configuration
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    class << self
+      alias config configuration
+    end
+
+    # Set Box::Office's configuration
+    # @param config [Box::Office::Configuration]
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    # Modify Box::Office's current configuration
+    # @yieldparam [Box::Office] config current Box::Office config
+    # ```
+    # Box::Office.configure do |config|
+    #   config.routes = false
+    # end
+    # ```
+    def self.configure
+      yield configuration
+    end
+  end
+end

data/lib/box/office/connection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Box
+  module Office
+    module Connection
+      extend ActiveSupport::Concern
+
+      def with_connection
+        if defined?(ConnectionPool)
+          if configured_instance.is_a?(ConnectionPool)
+            configured_instance.with { |conn| yield conn }
+          else
+            connection_pool.with { |conn| yield conn }
+          end
+        else
+          yield configured_instance
+        end
+      end
+
+      private
+
+      def configured_instance
+        Box::Office.config.instance
+      end
+
+      def configured_pool_size
+        Box::Office.config.pool_size
+      end
+
+      def connection_pool
+        ConnectionPool.new(size: configured_pool_size) { configured_instance }
+      end
+    end
+  end
+end

data/lib/box/office/janitor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Box
+  module Office
+    class Janitor
+      class << self
+        include Box::Office::Connection
+        LOCKED_QUEUE_KEY = "box-office:locked:queues"
+
+        def lock(queue_name)
+          with_connection { |conn| conn.sadd(LOCKED_QUEUE_KEY, queue_name) }
+        end
+
+        def locked?(queue_name)
+          with_connection { |conn| conn.sismember(LOCKED_QUEUE_KEY, queue_name) }
+        end
+
+        def locked_queues
+          with_connection { |conn| conn.smembers LOCKED_QUEUE_KEY }
+        end
+
+        def unlock(queue_name)
+          with_connection { |conn| conn.srem(LOCKED_QUEUE_KEY, queue_name) }
+        end
+      end
+    end
+  end
+end

data/lib/box/office/queue.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Box
+  module Office
+    class Queue
+      include Box::Office::Connection
+      LIMIT = 100
+
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def clear
+        with_connection { |conn| conn.del(name) }
+      end
+
+      def members(limit: LIMIT)
+        with_connection { |conn| conn.lrange(name, 0, limit - 1) }
+      end
+
+      def empty?
+        length.zero?
+      end
+
+      def length
+        with_connection { |conn| conn.llen(name) }
+      end
+      alias size length
+
+      def push(*msg)
+        with_connection { |conn| conn.lpush(name, *msg) }
+      end
+      alias << push
+
+      def remove(msg)
+        with_connection { |conn| conn.lrem(name, 0, msg) }
+      end
+      alias >> remove
+    end
+  end
+end

data/lib/box/office/showing.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Box
+  module Office
+    class Showing
+      include Connection
+
+      attr_accessor :track_fulfilled, :showings, :capacity
+      attr_reader :name, :booth
+
+      delegate :config, to: Box::Office
+
+      def initialize(name: config.default_name, track_fulfilled: config.track_fulfilled,
+                     showings: config.showings, capacity: config.capacity)
+        @name              = name
+        @track_fulfilled   = track_fulfilled
+        @showings          = showings
+        @capacity          = capacity
+
+        @booth             = Booth.new(showing: self)
+
+        setup_reserved_queues
+      end
+
+      Box::Office.config.single_queues.each do |que|
+        define_method que do
+          Queue.new send("#{que}_key")
+        end
+      end
+
+      def fulfill(queue, msg)
+        send(config.fulfilled) << msg if track_fulfilled?
+        queue >> msg
+      end
+
+      def push(*msg)
+        with_connection { |conn| conn.lpush(send("#{config.standby}_key"), *msg) }
+      end
+      alias << push
+
+      def reserve(capacity: self.capacity, block_unlock: true)
+        with_connection do |conn|
+          booth.first_available_opening(conn) do |opening|
+            Janitor.lock(opening.name) if config.lock_reserved?
+            conn.rpoplpush(send("#{config.standby}_key"), opening.name) while openings?(opening, capacity)
+
+            if block_given?
+              yield opening, opening.members(limit: capacity)
+              Janitor.unlock(opening.name) if config.lock_reserved? && block_unlock
+            end
+          rescue
+            Janitor.unlock(opening.name)
+            raise
+          end
+        end
+      end
+      alias pop reserve
+
+      private
+
+      Box::Office.config.single_queues.each do |que|
+        define_method "#{que}_key" do
+          "box-office:#{name.parameterize}:#{que}"
+        end
+      end
+
+      Box::Office.config.reserved.tap do |que|
+        define_method "#{que}_key" do |idx|
+          "box-office:#{name.parameterize}:#{que}-#{idx}"
+        end
+      end
+
+      def openings?(queue, capacity)
+        queue.length < capacity && !send(config.standby).empty?
+      end
+
+      def setup_reserved_queues
+        Box::Office.config.reserved.tap do |que|
+          define_singleton_method que do |idx = 1|
+            raise OutOfRange, "#{idx} is out of range of available showings" unless (1..showings).to_a.include? idx
+
+            Queue.new send("#{que}_key", idx)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/box/office/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Box
+  module Office
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: box-office
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Monroe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+description: 
+email:
+- dvmonroe6@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- box-office.gemspec
+- lib/box/office.rb
+- lib/box/office/booth.rb
+- lib/box/office/configuration.rb
+- lib/box/office/connection.rb
+- lib/box/office/janitor.rb
+- lib/box/office/queue.rb
+- lib/box/office/showing.rb
+- lib/box/office/version.rb
+homepage: http://github.com/dvmonroe/box-office
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Reliable redis queueing
+test_files: []