chicago_charter_bus_rental 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e0a07ce1b40771854f1854487248d57f90ef29eb960f2f04d07206a70656edb
+  data.tar.gz: cd9e21fc56df3f49e4bb461546cdbe4c88e9866450b33381782cf9606202ece3
+SHA512:
+  metadata.gz: 849e94120dbb847b5379745ee4ac0a43b242422546b5dda6c0cb80718f1533e4eafa187a151a61c4e65f95de61b82174306e9360d642cfec264a67284885fc5b
+  data.tar.gz: b3c0c1bba1ee7b1c5d4a34ccadb953f54725bf1d35ddeacd1b34321c52e1aebc093aadfdf1a8b6f5da2d8f377b69ceefc96e638350318936af8e4c78a203d7d6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Chicago Super Coach
+
+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,34 @@
+# chicago_charter_bus_rental
+
+Group charter planning helpers for the [Chicago Charter Bus Rental](https://chicagosupercoachbus.com/) fleet: work out how many vehicles a headcount needs and how many seats are left over.
+
+Seat counts are the top of the ranges published for each vehicle class: SuperCoach 57 (50-57), Coach Bus 44 (39-44), Small Coach Bus 28 (22-28), Executive Sprinter Van 15 (13-15), Party Bus 45 and Trolley 30.
+
+```ruby
+require "chicago_charter_bus_rental"
+
+headcount = ChicagoCharterBusRental.headcount_with_buffer(80) # 84, +5% for late additions
+plan = ChicagoCharterBusRental.recommend_fleet(headcount)
+puts plan.summary
+# 1 x SuperCoach (50-57 seats) + 1 x Small Coach Bus (22-28 seats)
+# = 85 seats for 84 passengers, 1 spare
+
+ChicagoCharterBusRental.vehicles_needed(headcount, ChicagoCharterBusRental::SUPER_COACH) # 2
+```
+
+- `recommend_fleet(passengers, vehicles: STANDARD)` returns the fewest vehicles that seat everyone and, among those, the fewest spare seats. Pass `vehicles: ChicagoCharterBusRental::ALL` to include the party bus and trolley.
+- `vehicles_needed(passengers, vehicle)` is the simple round-up for one class.
+- `headcount_with_buffer(confirmed, percent: 5)` adds a rounded-up safety margin.
+
+A headcount below 1 raises `ArgumentError`.
+
+## Scope
+
+A planning aid, not a quote, booking or availability statement. Confirm vehicles, prices and dates with the provider.
+
+## Development
+
+```
+ruby test/chicago_charter_bus_rental_test.rb
+gem build chicago_charter_bus_rental.gemspec
+```

data/lib/chicago_charter_bus_rental.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Group charter planning helpers for Chicago Charter Bus Rental: how many
+# vehicles does a headcount need, and how many seats are left over?
+#
+# Seat counts are the top of the ranges on the published fleet page. They are
+# a planning aid only, not a quote, a booking or a statement of availability.
+module ChicagoCharterBusRental
+  VERSION = "1.0.0"
+  TITLE = "Chicago Charter Bus Rental"
+  HOMEPAGE = "https://chicagosupercoachbus.com/"
+  MAX_PLAN_PASSENGERS = 5000
+
+  # A vehicle class in the Chicago charter fleet.
+  Vehicle = Struct.new(:key, :label, :min_seats, :max_seats) do
+    # Seat range as text, e.g. "39-44", or "45" for a single number.
+    def seat_range
+      min_seats == max_seats ? max_seats.to_s : "#{min_seats}-#{max_seats}"
+    end
+  end
+
+  SUPER_COACH = Vehicle.new(:super_coach, "SuperCoach", 50, 57).freeze
+  COACH = Vehicle.new(:coach, "Coach Bus", 39, 44).freeze
+  SMALL_COACH = Vehicle.new(:small_coach, "Small Coach Bus", 22, 28).freeze
+  SPRINTER_VAN = Vehicle.new(:sprinter_van, "Executive Sprinter Van", 13, 15).freeze
+  PARTY_BUS = Vehicle.new(:party_bus, "Party Bus", 45, 45).freeze
+  TROLLEY = Vehicle.new(:trolley, "Trolley", 30, 30).freeze
+
+  # Standard coaches used by default, largest first.
+  STANDARD = [SUPER_COACH, COACH, SMALL_COACH, SPRINTER_VAN].freeze
+  # Every class, including the party bus and trolley.
+  ALL = [SUPER_COACH, PARTY_BUS, COACH, TROLLEY, SMALL_COACH, SPRINTER_VAN].freeze
+
+  # One line of a plan: +count+ vehicles of one class.
+  FleetLine = Struct.new(:vehicle, :count) do
+    def seats
+      vehicle.max_seats * count
+    end
+
+    def to_s
+      "#{count} x #{vehicle.label} (#{vehicle.seat_range} seats)"
+    end
+  end
+
+  # The vehicles recommended for a headcount.
+  FleetPlan = Struct.new(:passengers, :lines) do
+    def vehicle_count
+      lines.sum(&:count)
+    end
+
+    def total_seats
+      lines.sum(&:seats)
+    end
+
+    def spare_seats
+      total_seats - passengers
+    end
+
+    def summary
+      "#{lines.join(' + ')} = #{total_seats} seats for #{passengers} passengers, #{spare_seats} spare"
+    end
+
+    alias_method :to_s, :summary
+  end
+
+  module_function
+
+  def homepage
+    HOMEPAGE
+  end
+
+  # Vehicles of one class needed for +passengers+.
+  def vehicles_needed(passengers, vehicle)
+    check_passengers(passengers)
+    (passengers + vehicle.max_seats - 1) / vehicle.max_seats
+  end
+
+  # Headcount to plan for after adding +percent+ (default 5) for late
+  # additions, rounded up.
+  def headcount_with_buffer(confirmed, percent: 5)
+    check_passengers(confirmed)
+    raise ArgumentError, "percent must not be negative" if percent.negative?
+
+    (confirmed * (100 + percent) + 99) / 100
+  end
+
+  # Fewest vehicles that seat +passengers+, and among those the fewest spare
+  # seats. Uses the standard coaches unless +vehicles+ is given.
+  def recommend_fleet(passengers, vehicles: STANDARD)
+    check_passengers(passengers)
+    if passengers > MAX_PLAN_PASSENGERS
+      raise ArgumentError, "passengers must be at most #{MAX_PLAN_PASSENGERS}"
+    end
+    raise ArgumentError, "vehicles must not be empty" if vehicles.empty?
+
+    options = vehicles.sort_by { |v| -v.max_seats }
+    limit = passengers + options.first.max_seats - 1
+    unreachable = 1 << 30
+    fewest = Array.new(limit + 1, unreachable)
+    pick = Array.new(limit + 1)
+    fewest[0] = 0
+    (1..limit).each do |s|
+      options.each do |v|
+        from = s - v.max_seats
+        next unless from >= 0 && fewest[from] + 1 < fewest[s]
+
+        fewest[s] = fewest[from] + 1
+        pick[s] = v
+      end
+    end
+
+    best = nil
+    (passengers..limit).each do |s|
+      next if fewest[s] == unreachable
+
+      best = s if best.nil? || fewest[s] < fewest[best]
+    end
+
+    counts = Hash.new(0)
+    s = best
+    while s.positive?
+      counts[pick[s]] += 1
+      s -= pick[s].max_seats
+    end
+    lines = options.select { |v| counts.key?(v) }.map { |v| FleetLine.new(v, counts[v]) }
+    FleetPlan.new(passengers, lines)
+  end
+
+  def check_passengers(passengers)
+    raise ArgumentError, "passengers must be at least 1" if passengers < 1
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: chicago_charter_bus_rental
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- nbkdevs
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Recommends the fewest vehicles for a Chicago group charter headcount
+  using the Chicago Charter Bus Rental fleet seat sizes, with spare-seat counts and
+  a late-additions headcount buffer. Library only, no dependencies.
+email: info@chicagosupercoach.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/chicago_charter_bus_rental.rb
+homepage: https://chicagosupercoachbus.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://chicagosupercoachbus.com/
+  source_code_uri: https://github.com/nbkdevs/chicago-super/tree/main/publish/chicago-charter-bus-rental/rubygems
+  bug_tracker_uri: https://github.com/nbkdevs/chicago-super/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: 'Chicago group charter planner: how many vehicles does a headcount need?'
+test_files: []