lighterpack-parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fed15af6ad0ccfbba49c9960cf80e47fee71cbdce5166746e5788df489127d
-  data.tar.gz: dbf4da779516e9ba651846a1457fcdfa52142313643235f5cbc7500778d9baec
+  metadata.gz: b692835b5b950b2892cc8ea192966625ff52d5237ff94715b9c63689ccb9cec4
+  data.tar.gz: dbff07f7be838fcc24a04d116d359bc880cb59aa5992434abf904262247d206d
 SHA512:
-  metadata.gz: 1e35ae9d5211815cef892b469d26e4e79163698465e2b213e8f394a0d2f9546ddc007e7a182684513aff24579281fe719581d3156c3fc6323134f48af2d6067f
-  data.tar.gz: c90687504af99ace152a1bf2749362d70d004e37e3cd9baf50aee6adbe0fbce4869ba57ea7b6b7b74b617a6bac7ece5954dc4fe1c2e365377ffc110711efb8bb
+  metadata.gz: 3defc27122c9cf2c813e3869f7c5a3ab4172ffe3da706da64de7e6e92d4c771849efadcdabce1af8e2b989dcedd9c91acf14ef6da1c126f873674bc068e4e144
+  data.tar.gz: f198b1e0d4c4776f48b178bfdf76fc3281d48e383adf709011eca040d43473b75b74f0a5b76aa748eef2bc0293430e7d4f4cb1d14bb22844e7ac74725e363584

data/README.md

@@ -2,41 +2,81 @@
 
 A Ruby gem for parsing Lighterpack lists from HTML or URLs.
 
+Used by [Goulight](https://goulight.com). Source: [github.com/goulight/lighterpack-parser](https://github.com/goulight/lighterpack-parser).
+
 ## Installation
 
-This gem is used as a local dependency in the Packlista project. It's referenced in the backend `Gemfile`:
+Add to your `Gemfile`:
 
 ```ruby
-gem 'lighterpack_parser', path: '../lighterpack-parser'
+gem 'lighterpack-parser', '~> 1.0'
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install lighterpack-parser
 ```
 
 ## Usage
 
+`LighterpackParser::Parser#parse` (and `LighterpackParser.parse_url`) return a **`LighterpackParser::List`** object with readers `name`, `description`, and `categories`. Each category is a **`LighterpackParser::Category`**; each item is a **`LighterpackParser::Item`**.
+
+Call **`#to_h`** on the list (or on categories/items) if you need nested hashes (for example JSON APIs).
+
 ### Parse from HTML string
 
 ```ruby
 require 'lighterpack_parser'
 
 html = File.read('path/to/lighterpack.html')
-result = LighterpackParser::Parser.new(html: html).parse
-
-# Result structure:
-# {
+list = LighterpackParser::Parser.new(html: html).parse
+
+list.name                    # => "List Name"
+list.description             # => "List description" or nil
+list.categories.first.name   # => "Category Name"
+
+item = list.categories.first.items.first
+item.name                    # => "Item Name"
+item.description             # => "Item description" or nil
+item.weight                  # => 476.0   # grams per unit
+item.total_weight            # => 476.0   # weight * quantity (grams)
+item.quantity                # => 1
+item.image_url               # => "https://..." or nil
+item.consumable              # => false
+item.total_consumable_weight # => nil (or total grams if consumable)
+item.worn                    # => false
+item.worn_quantity           # => nil (or 1 if worn)
+item.total_worn_weight       # => nil (or grams worn, weight × 1)
+
+# Hash shape (matches nested #to_h):
+list.to_h
+# => {
 #   name: "List Name",
-#   description: "List description (optional)",
+#   description: nil,
 #   categories: [
 #     {
 #       name: "Category Name",
-#       description: "Category description (optional)",
+#       description: nil,
 #       items: [
 #         {
 #           name: "Item Name",
 #           description: "Item description",
-#           weight: 476.0,  # in grams
+#           weight: 476.0,
+#           total_weight: 476.0,
 #           quantity: 1,
 #           image_url: "https://...",
 #           consumable: false,
-#           worn: false
+#           total_consumable_weight: nil,
+#           worn: false,
+#           worn_quantity: nil,
+#           total_worn_weight: nil
 #         }
 #       ]
 #     }
@@ -49,11 +89,10 @@ result = LighterpackParser::Parser.new(html: html).parse
 ```ruby
 require 'lighterpack_parser'
 
-# Using the parser directly
-result = LighterpackParser::Parser.new(url: 'https://lighterpack.com/r/b6q1kr').parse
+list = LighterpackParser::Parser.new(url: 'https://lighterpack.com/r/b6q1kr').parse
 
 # Or using the convenience method
-result = LighterpackParser.parse_url('https://lighterpack.com/r/b6q1kr')
+list = LighterpackParser.parse_url('https://lighterpack.com/r/b6q1kr')
 ```
 
 ## Running Tests
@@ -66,7 +105,8 @@ rspec
 
 ## Test Fixtures
 
-Test fixtures are stored in `test/fixtures/` and contain HTML from example Lighterpack lists:
+Test fixtures are stored in `spec/fixtures/` and contain HTML from example Lighterpack lists:
+
 - `b6q1kr.html` - Ultimate Hike 2025
 - `adbf7c.html` - Example list 2
 - `h23rxt.html` - Example list 3
@@ -74,7 +114,7 @@ Test fixtures are stored in `test/fixtures/` and contain HTML from example Light
 To update fixtures, download fresh HTML:
 
 ```bash
-curl -s "https://lighterpack.com/r/b6q1kr" > test/fixtures/b6q1kr.html
+curl -s "https://lighterpack.com/r/b6q1kr" > spec/fixtures/b6q1kr.html
 ```
 
 ## Features
@@ -83,17 +123,18 @@ curl -s "https://lighterpack.com/r/b6q1kr" > test/fixtures/b6q1kr.html
 - Extracts categories with descriptions
 - Extracts items with:
   - Name and description
-  - Weight (automatically converted to grams)
+  - Weight per unit and total weight (automatically converted to grams)
   - Quantity
   - Image URLs
-  - Consumable flag
-  - Worn flag
+  - Consumable flag and total consumable weight when applicable
+  - Worn flag, worn quantity, and total worn weight when applicable
 - Supports weight units: oz, lb, g, kg (all converted to grams)
 - Handles both HTML strings and URLs
 
 ## Weight Conversion
 
 The parser automatically converts all weights to grams:
+
 - `oz` → multiply by 28.3495
 - `lb` → multiply by 453.592
 - `g` → use as-is

data/lib/lighterpack_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LighterpackParser
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lighterpack-parser.gemspec

@@ -10,9 +10,13 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Parser for Lighterpack lists'
   spec.description   = 'Parse Lighterpack HTML to extract list data including categories, items, weights, and metadata'
-  spec.homepage      = 'https://github.com/alex-ross/lighterpack-parser'
+  spec.homepage      = 'https://github.com/goulight/lighterpack-parser'
   spec.license       = 'MIT'
 
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/goulight/lighterpack-parser'
+  }
+
   spec.required_ruby_version = '>= 3.0'
 
   spec.files         = Dir['lib/**/*', 'spec/**/*', '*.md', '*.gemspec']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lighterpack-parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Packlista Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-02 00:00:00.000000000 Z
+date: 2026-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -77,10 +77,11 @@ files:
 - spec/fixtures/h23rxt.html
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/alex-ross/lighterpack-parser
+homepage: https://github.com/goulight/lighterpack-parser
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/goulight/lighterpack-parser
 post_install_message:
 rdoc_options: []
 require_paths: