gopromotional-packlist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ec908cd28c90f92b3afb8f031eb66bff55605d65aed959a00c971bd61912b08
+  data.tar.gz: 954362a4df57b747f43a824296491e6683f77fd22d4e05417b406b2cd0100f2d
+SHA512:
+  metadata.gz: 1a1e0cdac8cba2c9c1a02e5689462574f51b50d2f7489ec7550649bb5730fc4226dc54b8b73e8b456a68956ac00ee8e152098d8ff8aa88fde668e436e8da9dc9
+  data.tar.gz: 78d9460426c688ee27539c57601adba3be1c99579ca097c4dc08f6e62a53f29c262192905337a594b9a52c3dc24c17b83f84a28a6dd6a03fcbde387857b969f7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GoPromotional
+
+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,58 @@
+# gopromotional-packlist
+
+Build a packing checklist from templates (work day, travel, trade show, gym), scale clothes to the number of nights, add your own items, tick things off and see what is left. Lists are stored as plain Markdown checklists you can also edit by hand.
+
+- **4 templates**: work day (10 items), travel (19), trade show (16), gym (9). Combine them; duplicates are merged.
+- **Per-night quantities**: T-shirts, underwear and socks scale to nights + 1.
+- **Tick off** items by a unique part of their name; see **progress** and what is **still to pack**.
+- **Markdown storage**: `- [x] 3 × T-shirts` round-trips, so the list works in any editor, GitHub or Obsidian.
+
+## Install
+
+```sh
+gem install gopromotional-packlist
+# or in a Gemfile:
+gem "gopromotional-packlist"
+```
+
+## Command line
+
+```console
+$ gopromotional-packlist templates
+work-day (10 items)
+travel (19 items)
+trade-show (16 items)
+gym (9 items)
+
+$ gopromotional-packlist new --template trade-show --extra "Tote bags" --title Expo --out expo.md
+Wrote 17 items to expo.md
+
+$ gopromotional-packlist check expo.md gaffer
+1/17 packed (6%)
+
+$ gopromotional-packlist status expo.md
+Expo: 1/17 packed (6%)
+Still to pack: Pop-up banner / stand, Table cloth, Branded giveaways, Business cards, Brochures / flyers, Lead capture sheet or scanner, Extension lead, Laptop / tablet, Phone charger, Scissors, Cable ties, Pens, Water bottles, Snacks, First-aid kit, Tote bags
+```
+
+Every command accepts `--json` for machine-readable output. Run `gopromotional-packlist --help` for all options.
+
+## Library
+
+```ruby
+require "gopromotional/packlist"
+P = GoPromotional::Packlist
+
+items = P.build_list(templates: %w[travel work-day], nights: 3, extras: ["Umbrella"])
+P.mark(items, "passport", true)
+P.progress(items)                      # => {packed: 1, total: 28, percent: 4}
+title, back = P.parse_markdown(P.to_markdown(items, "Lisbon"))
+```
+
+Pure Ruby, no runtime dependencies, Ruby 3.0+. `require "gopromotional-packlist"` also works.
+
+## Links
+
+- Website: [branded tote bags](https://www.gopromotional.co.uk/branded-products/tote-bags)
+- Source code: [https://github.com/nbkdevs/GoPromotional](https://github.com/nbkdevs/GoPromotional) (`packages/tote-bags/rubygems`)
+- Licence: MIT

data/exe/gopromotional-packlist

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/gopromotional/packlist/cli"
+exit GoPromotional::Packlist::CLI.run(ARGV)

data/lib/gopromotional/packlist/cli.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "json"
+require "optparse"
+require_relative "../packlist"
+
+module GoPromotional
+  module Packlist
+    # Command line interface: templates | new | check | uncheck | add | status
+    module CLI
+      USAGE = <<~TXT
+        Usage: gopromotional-packlist <command> [options]
+
+        Commands:
+          templates                         list built-in templates
+          new [--template travel[,gym,...]] [--nights N] [--extra ITEM]... [--title T] [--out FILE]
+          check <file> <item>               mark packed (unique partial names work)
+          uncheck <file> <item>
+          add <file> <item>
+          status <file>                     progress and what is still left
+
+        Options: --json, -v/--version, -h/--help
+      TXT
+
+      module_function
+
+      def run(argv, out: $stdout, err: $stderr)
+        o = { json: false, template: "travel", nights: 0, extras: [], title: "Packing list" }
+        parser = OptionParser.new do |p|
+          p.banner = USAGE
+          p.on("--json") { o[:json] = true }
+          p.on("--template NAMES") { |v| o[:template] = v }
+          p.on("--nights N", Integer) { |v| o[:nights] = v }
+          p.on("--extra ITEM") { |v| o[:extras] << v }
+          p.on("--title TITLE") { |v| o[:title] = v }
+          p.on("--out FILE") { |v| o[:out] = v }
+          p.on("-v", "--version") { out.puts VERSION; return 0 }
+          p.on("-h", "--help") { out.puts USAGE; return 0 }
+        end
+        args = parser.parse(argv)
+        cmd = args.shift
+        case cmd
+        when nil
+          out.puts USAGE
+        when "templates"
+          out.puts(o[:json] ? JSON.pretty_generate(TEMPLATES.transform_values { |v| v.map(&:to_h) }) : TEMPLATES.map { |k, v| "#{k} (#{v.size} items)" })
+        when "new"
+          names = o[:template].split(",").map(&:strip).reject(&:empty?)
+          items = Packlist.build_list(templates: names, nights: o[:nights], extras: o[:extras])
+          md = Packlist.to_markdown(items, o[:title])
+          if o[:out]
+            File.write(o[:out], md)
+            out.puts "Wrote #{items.size} items to #{o[:out]}"
+          else
+            out.puts(o[:json] ? JSON.pretty_generate(items.map(&:to_h)) : md)
+          end
+        when "check", "uncheck", "add"
+          file = args.shift
+          name = args.join(" ")
+          raise ArgumentError, "#{cmd} needs a file and an item name" if file.nil? || name.empty?
+          title, items = Packlist.parse_markdown(File.read(file, encoding: "utf-8"))
+          if cmd == "add"
+            raise ArgumentError, %("#{name}" is already on the list) if items.any? { |i| i.name.downcase == name.downcase }
+            items << Item.new(name, "Extras")
+          else
+            Packlist.mark(items, name, cmd == "check")
+          end
+          File.write(file, Packlist.to_markdown(items, title))
+          pr = Packlist.progress(items)
+          out.puts "#{pr[:packed]}/#{pr[:total]} packed (#{pr[:percent]}%)"
+        when "status"
+          file = args.shift or raise ArgumentError, "status needs a file"
+          title, items = Packlist.parse_markdown(File.read(file, encoding: "utf-8"))
+          pr = Packlist.progress(items)
+          left = Packlist.remaining(items)
+          if o[:json]
+            out.puts JSON.pretty_generate(pr.merge(remaining: left.map(&:to_h)))
+          else
+            out.puts "#{title}: #{pr[:packed]}/#{pr[:total]} packed (#{pr[:percent]}%)"
+            out.puts(left.empty? ? "All packed." : "Still to pack: #{left.map(&:name).join(', ')}")
+          end
+        else
+          raise ArgumentError, %(Unknown command "#{cmd}". Run with --help.)
+        end
+        0
+      rescue ArgumentError, OptionParser::ParseError, SystemCallError => e
+        err.puts "Error: #{e.message}"
+        2
+      end
+    end
+  end
+end

data/lib/gopromotional/packlist/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GoPromotional
+  module Packlist
+    VERSION = "1.0.0"
+  end
+end

data/lib/gopromotional/packlist.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require_relative "packlist/version"
+
+module GoPromotional
+  # Packing checklists with templates, per-night quantities and a round-trip Markdown format.
+  module Packlist
+    TemplateItem = Struct.new(:name, :category, :per_night) do
+      def to_h = { name: name, category: category, per_night: per_night }
+    end
+
+    def self.t(rows) = rows.map { |n, c, p| TemplateItem.new(n, c, p || false).freeze }.freeze
+
+    TEMPLATES = {
+      "work-day" => t([
+        ["Laptop", "Work"], ["Laptop charger", "Work"], ["Phone charger", "Work"], ["Badge / ID", "Work"],
+        ["Notebook", "Work"], ["Pen", "Work"], ["Headphones", "Work"], ["Water bottle", "Work"],
+        ["Reusable coffee cup", "Work"], ["Lunch / snacks", "Work"]
+      ]),
+      "travel" => t([
+        ["Passport / ID", "Documents"], ["Tickets / boarding pass", "Documents"], ["Bank cards", "Documents"],
+        ["T-shirts", "Clothes", true], ["Underwear", "Clothes", true], ["Socks", "Clothes", true],
+        ["Trousers / skirt", "Clothes"], ["Jumper", "Clothes"], ["Sleepwear", "Clothes"],
+        ["Toothbrush", "Toiletries"], ["Toothpaste", "Toiletries"], ["Deodorant", "Toiletries"], ["Medications", "Toiletries"],
+        ["Phone charger", "Tech"], ["Power bank", "Tech"], ["Plug adapter", "Tech"], ["Headphones", "Tech"],
+        ["Reusable water bottle", "Other"], ["Tote bag", "Other"]
+      ]),
+      "trade-show" => t([
+        ["Pop-up banner / stand", "Stand"], ["Table cloth", "Stand"], ["Branded giveaways", "Stand"],
+        ["Business cards", "Stand"], ["Brochures / flyers", "Stand"], ["Lead capture sheet or scanner", "Stand"],
+        ["Extension lead", "Kit"], ["Laptop / tablet", "Kit"], ["Phone charger", "Kit"], ["Gaffer tape", "Kit"],
+        ["Scissors", "Kit"], ["Cable ties", "Kit"], ["Pens", "Kit"],
+        ["Water bottles", "Team"], ["Snacks", "Team"], ["First-aid kit", "Team"]
+      ]),
+      "gym" => t([
+        ["Gym clothes", "Gym"], ["Trainers", "Gym"], ["Towel", "Gym"], ["Water bottle", "Gym"], ["Padlock", "Gym"],
+        ["Headphones", "Gym"], ["Shower gel", "Gym"], ["Deodorant", "Gym"], ["Snack", "Gym"]
+      ])
+    }.freeze
+
+    Item = Struct.new(:name, :category, :qty, :packed) do
+      def initialize(name, category, qty = 1, packed = false) = super
+      def label = qty > 1 ? "#{qty} × #{name}" : name
+      def to_h = { name: name, category: category, qty: qty, packed: packed }
+    end
+
+    module_function
+
+    def key(s) = s.to_s.strip.downcase
+
+    # Build a checklist. Per-night items get nights + 1 (one spare); duplicate names are merged (first wins).
+    def build_list(templates: ["travel"], nights: 0, extras: [])
+      raise ArgumentError, "nights must be an integer from 0 to 365" unless nights.is_a?(Integer) && (0..365).cover?(nights)
+      seen = {}
+      items = []
+      push = lambda do |it|
+        k = key(it.name)
+        next if k.empty? || seen[k]
+        seen[k] = true
+        items << it
+      end
+      templates.each do |t|
+        tpl = TEMPLATES[t] or raise ArgumentError, %(Unknown template "#{t}". Choose from: #{TEMPLATES.keys.join(', ')})
+        tpl.each { |r| push.call(Item.new(r.name, r.category, r.per_night && nights.positive? ? nights + 1 : 1)) }
+      end
+      extras.each { |e| push.call(Item.new(e.to_s.strip, "Extras")) }
+      items
+    end
+
+    def find(items, name)
+      k = key(name)
+      exact = items.find { |i| key(i.name) == k }
+      return exact if exact
+      partial = items.select { |i| key(i.name).include?(k) }
+      return partial.first if partial.size == 1
+      raise ArgumentError, %("#{name}" matches #{partial.size} items: #{partial.map(&:name).join(', ')}) if partial.any?
+      raise ArgumentError, %(No item matches "#{name}")
+    end
+
+    # Mark an item packed (toggle when packed is nil). Exact name first, then a unique substring.
+    def mark(items, name, packed = nil)
+      it = find(items, name)
+      it.packed = packed.nil? ? !it.packed : packed ? true : false
+      it
+    end
+
+    def progress(items)
+      packed = items.count(&:packed)
+      { packed: packed, total: items.size, percent: items.empty? ? 0 : (packed * 100.0 / items.size + 0.5).floor }
+    end
+
+    def remaining(items) = items.reject(&:packed)
+
+    def filter_items(items, query)
+      q = key(query)
+      items.select { |i| key(i.name).include?(q) || key(i.category).include?(q) }
+    end
+
+    def categories(items) = items.map(&:category).uniq
+
+    # Markdown checkboxes grouped by category; parse_markdown reads it back.
+    def to_markdown(items, title = "Packing list")
+      lines = ["# #{title}", ""]
+      categories(items).each do |c|
+        lines << "## #{c}"
+        items.select { |i| i.category == c }.each { |i| lines << "- [#{i.packed ? 'x' : ' '}] #{i.label}" }
+        lines << ""
+      end
+      lines.join("\n")
+    end
+
+    def to_text(items)
+      categories(items).map do |c|
+        ([c] + items.select { |i| i.category == c }.map { |i| "  #{i.packed ? '[x]' : '[ ]'} #{i.label}" }).join("\n")
+      end.join("\n")
+    end
+
+    # Returns [title, items].
+    def parse_markdown(md)
+      title = "Packing list"
+      category = "Items"
+      items = []
+      md.to_s.each_line do |raw|
+        line = raw.strip
+        if (m = line.match(/\A#\s+(.+)\z/))
+          title = m[1].strip
+        elsif (m = line.match(/\A##\s+(.+)\z/))
+          category = m[1].strip
+        elsif (m = line.match(/\A[-*]\s+\[([ xX])\]\s+(.+)\z/))
+          name = m[2].strip
+          qty = 1
+          if (q = name.match(/\A(\d+)\s*[×x]\s+(.+)\z/))
+            qty = q[1].to_i
+            name = q[2].strip
+          end
+          items << Item.new(name, category, qty, m[1] != " ")
+        end
+      end
+      [title, items]
+    end
+  end
+end

data/lib/gopromotional-packlist.rb

@@ -0,0 +1 @@
+require_relative "gopromotional/packlist"

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: gopromotional-packlist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- GoPromotional
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Build a packing checklist from templates (work day, travel, trade show,
+  gym), scale clothes to the number of nights, add your own items, tick things off
+  and see what is left. Lists are stored as plain Markdown checklists you can also
+  edit by hand.
+executables:
+- gopromotional-packlist
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/gopromotional-packlist
+- lib/gopromotional-packlist.rb
+- lib/gopromotional/packlist.rb
+- lib/gopromotional/packlist/cli.rb
+- lib/gopromotional/packlist/version.rb
+homepage: https://www.gopromotional.co.uk/branded-products/tote-bags
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.gopromotional.co.uk/branded-products/tote-bags
+  source_code_uri: https://github.com/nbkdevs/GoPromotional/tree/main/packages/tote-bags/rubygems
+  bug_tracker_uri: https://github.com/nbkdevs/GoPromotional/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Packing checklists with templates, per-night quantities and a Markdown format.
+test_files: []