packwizard-parser 1.0.0

data/spec/item_parser_spec.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+RSpec.describe PackwizardParser::ItemParser do
+  let(:fixture_json) { File.read(File.join(__dir__, 'fixtures', 'tUE6BJs.json')) }
+  let(:data) { JSON.parse(fixture_json) }
+  let(:parser) { described_class.new }
+
+  describe '#parse' do
+    context 'with Plex Solo Tent row. Category: Big 3' do
+      let(:category) { data['tableData'].find { |c| c['title'] == 'Big 3' } }
+      let(:rows) { category['rows'] }
+      let(:row) { rows['row_lhkykmnb'] }
+
+      it 'extracts the item name' do
+        item = parser.parse(row)
+        expect(item.name).to eq('Plex Solo Tent')
+      end
+
+      it 'extracts the item weight' do
+        item = parser.parse(row)
+        expect(item.weight).to eq(394)
+      end
+
+      it 'extracts the item quantity' do
+        item = parser.parse(row)
+        expect(item.quantity).to eq(1)
+      end
+
+      it 'extracts the imageUrl' do
+        item = parser.parse(row)
+        expect(item.image_url).to eq('https://zpacks.com/cdn/shop/files/plexsoloclassic_2048x.jpg?v=1713272032')
+      end
+
+      it 'extracts the description' do
+        item = parser.parse(row)
+        expect(item.description).to include('The lightest of the light')
+        expect(item.description).to end_with('back and side sleepers alike.')
+      end
+
+      it 'extracts the consumable flag: False' do
+        item = parser.parse(row)
+        expect(item.consumable).to be(false)
+      end
+
+      it 'extracts the worn flag: False' do
+        item = parser.parse(row)
+        expect(item.worn).to be(false)
+      end
+
+      it 'extracts the total_weight' do
+        item = parser.parse(row)
+        expect(item.total_weight).to eq(394)
+      end
+
+      it 'extracts the total_quantity' do
+        item = parser.parse(row)
+        expect(item.quantity).to eq(1)
+      end
+
+      it 'extracts the total_consumable_weight' do
+        item = parser.parse(row)
+        expect(item.total_consumable_weight).to eq(nil)
+      end
+
+      it 'extracts the total_worn_weight' do
+        item = parser.parse(row)
+        expect(item.total_worn_weight).to eq(0)
+      end
+    end
+
+    # These testcases should check if the weight conversion of ounces to grams works
+    # Also if the consumable flag works
+
+    context 'with Snackbars row. Category: Cook System' do
+      let(:category) { data['tableData'].find { |c| c['title'] == 'Cook System' } }
+      let(:rows) { category['rows'] }
+      let(:row) { rows['row_mnfyxjad'] }
+
+      it 'extracts consumable flag: True' do
+        item = parser.parse(row)
+        expect(item.consumable).to be(true)
+      end
+
+      it 'extracts the item weight and converts oz to grams' do
+        # item weight in oz = 1, should equal 28.35 grams
+        item = parser.parse(row)
+        expect(item.weight).to be_within(0.01).of(28.35)
+      end
+
+      it 'extracts the item_total_weight and converts oz to grams' do
+        # item weight in oz = 1, quantity 4, should equal total_weight of 113.4 grams
+        item = parser.parse(row)
+        expect(item.total_weight).to be_within(0.01).of(113.4)
+      end
+
+      it 'extracts the total_consumable_weight and converts oz to grams' do
+        # item weight in oz = 1, quantity 4, should equal total_consumable_weight of 113.4 grams
+        item = parser.parse(row)
+        expect(item.total_consumable_weight).to be_within(0.01).of(113.4)
+      end
+    end
+
+    describe 'with Socks row. Category: Clothing' do
+      let(:category) { data['tableData'].find { |c| c['title'] == 'Clothing' } }
+      let(:rows) { category['rows'] }
+      let(:row) { rows['row_lhqtz6q5'] }
+
+      it 'extracts quantity' do
+        item = parser.parse(row)
+        expect(item.quantity).to eq(3)
+      end
+
+      it 'extracts weight and converts lb to grams' do
+        # item weight in lb 0.08, should equal to 36.29 grams
+        item = parser.parse(row)
+        expect(item.weight).to be_within(0.01).of(36.29)
+      end
+
+      it 'extracts the item_total_weight and converts lb to grams' do
+        # Quantity of 3, should equal to 108.87 grams
+        item = parser.parse(row)
+        expect(item.total_weight).to be_within(0.01).of(108.87)
+      end
+
+      it 'extracts the worn flag: True' do
+        item = parser.parse(row)
+        expect(item.worn).to be(true)
+      end
+
+      it 'extracts the worn_quantity, should be 1 regardless of quantity' do
+        item = parser.parse(row)
+        expect(item.worn_quantity).to eq(1)
+      end
+
+      it 'extracts the total_worn_weight and converts lb to grams' do
+        item = parser.parse(row)
+        expect(item.total_worn_weight).to be_within(0.01).of(36.29)
+      end
+    end
+
+    describe 'with Decathlon Fleece pants row. Category: Clothing' do
+      let(:category) { data['tableData'].find { |c| c['title'] == 'Clothing' } }
+      let(:rows) { category['rows'] }
+      let(:row) { rows['row_ljhklzt7'] }
+
+      it 'extracts the weight and converts kg to grams' do
+        item = parser.parse(row)
+        expect(item.weight).to be_within(0.01).of(149)
+      end
+    end
+
+    describe 'negative testcases with negative.json' do
+      let(:fixture_json) { File.read(File.join(__dir__, 'fixtures', 'negative.json')) }
+      let(:data) { JSON.parse(fixture_json) }
+      let(:parser) { described_class.new }
+      let(:category) { data['tableData'].first }
+      let(:rows) { category['rows'] }
+      let(:row) { rows['row_negative'] }
+
+      it 'negative weight should return 0.0' do
+        item = parser.parse(row)
+        expect(item.weight).to eq(0.0)
+      end
+
+      it 'negative quantity should return 0' do
+        item = parser.parse(row)
+        expect(item.quantity).to eq(0)
+      end
+
+      it 'unknown unit type (xyz) should return 0.0' do
+        item = parser.parse(row)
+        expect(item.weight).to eq(0.0)
+      end
+
+      it 'empty name should return Untitled item' do
+        item = parser.parse(row)
+        expect(item.name).to eq('Untitled item')
+      end
+
+      it 'empty description should return nil' do
+        item = parser.parse(row)
+        expect(item.description).to be_nil
+      end
+
+      it 'empty url should return nil' do
+        item = parser.parse(row)
+        expect(item.image_url).to be_nil
+      end
+    end
+  end
+end

data/spec/list_parser_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+RSpec.describe PackwizardParser::ListParser do
+  let(:fixture_json) { File.read(File.join(__dir__, 'fixtures', 'tUE6BJs.json')) }
+  let(:data) { JSON.parse(fixture_json) }
+  let(:parser) { described_class.new }
+  let(:item_parser) { PackwizardParser::ItemParser.new }
+  let(:category_parser) { PackwizardParser::CategoryParser.new }
+
+  describe '#parse' do
+    let(:list) { parser.parse(data, category_parser: category_parser, item_parser: item_parser) }
+
+    it 'extracts list name' do
+      expect(list.name).to eq('Ultralight Gear List 2023')
+    end
+
+    it 'extracts the lists description' do
+      expect(list.description).to end_with('but this pack comes close!')
+    end
+
+    it 'returns an array of Category objects' do
+      expect(list.categories).to be_a(Array)
+      expect(list.categories.length).to be > 0
+    end
+
+    it 'returns an array of Item objects' do
+      first_category = list.categories.first
+      expect(first_category.items).to be_a(Array)
+      expect(first_category.items.length).to be > 0
+    end
+  end
+
+  describe '#negative cases with negative.json' do
+    let(:fixture_json) { File.read(File.join(__dir__, 'fixtures', 'negative.json')) }
+    let(:data) { JSON.parse(fixture_json) }
+    let(:parser) { described_class.new }
+    let(:item_parser) { PackwizardParser::ItemParser.new }
+    let(:category_parser) { PackwizardParser::CategoryParser.new }
+
+    let(:list) { parser.parse(data, category_parser: category_parser, item_parser: item_parser) }
+
+    it 'extract empty list name' do
+      expect(list.name).to eq('Untitled list')
+    end
+
+    it 'extract empty description' do
+      expect(list.description).to be_nil
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+RSpec.describe PackwizardParser::Parser do
+  let(:fixture_json) { File.read(File.join(__dir__, 'fixtures', 'tUE6BJs.json')) }
+  let(:fake_response) do
+    instance_double(HTTParty::Response, success?: true, body: fixture_json, code: 200)
+  end
+
+  before do
+    allow(HTTParty).to receive(:get).and_return(fake_response)
+  end
+
+  describe "#parse" do
+    subject(:list) { described_class.new(shareable_id: 'tUE6BJs').parse }
+
+    it 'returns a List object' do
+      expect(list).to be_a(PackwizardParser::List)
+    end
+
+    it 'extracts the list name' do
+      expect(list.name).to eq('Ultralight Gear List 2023')
+    end
+
+    it 'extracts the list description' do
+      expect(list.description).to end_with('but this pack comes close!')
+    end
+
+    it 'accepts a full URL and extracts the ID' do
+      parser = described_class.new(shareable_id: 'https://www.packwizard.com/s/tUE6BJs')
+      parser.parse
+      expect(HTTParty).to have_received(:get).with(
+        PackwizardParser::Parser::API_URL,
+        hash_including(query: { shareableId: 'tUE6BJs' }),
+      )
+    end
+
+    it 'calls the API with the correct shareable ID' do
+      list
+      expect(HTTParty).to have_received(:get).with(
+        PackwizardParser::Parser::API_URL,
+        hash_including(query: { shareableId: 'tUE6BJs' })
+      )
+    end
+
+    it 'raises a failed response' do
+      allow(HTTParty).to receive(:get).and_return(
+        instance_double(HTTParty::Response, success?: false, code: 404),
+      )
+      expect { described_class.new(shareable_id: "bad").parse }.to raise_error(RuntimeError, /404/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../lib/packwizard_parser/'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Exclude integration testing as default
+  config.filter_run_excluding :integration
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: packwizard-parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aross AB / Goulight
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Parse PackWizard to extract list data including categories, items, weights,
+  and metadata
+email:
+- hello@goulight.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/packwizard_parser.rb
+- lib/packwizard_parser/category.rb
+- lib/packwizard_parser/category_parser.rb
+- lib/packwizard_parser/gram_converter.rb
+- lib/packwizard_parser/item.rb
+- lib/packwizard_parser/item_parser.rb
+- lib/packwizard_parser/list.rb
+- lib/packwizard_parser/list_parser.rb
+- lib/packwizard_parser/parser.rb
+- lib/packwizard_parser/version.rb
+- packwizard-parser.gemspec
+- spec/category_parser_spec.rb
+- spec/fixtures/negative.json
+- spec/fixtures/tUE6BJs.json
+- spec/item_parser_spec.rb
+- spec/list_parser_spec.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/goulight/packwizard-parser
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/goulight/packwizard-parser
+post_install_message:
+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.5.22
+signing_key:
+specification_version: 4
+summary: Parser for PackWizard lists
+test_files: []