RubyGems - packlist - Versions diffs - 0.9.0 - Mend

packlist 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

checksums.yaml +7 -0
data/.gitignore +13 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +131 -0
data/Rakefile +12 -0
data/app/assets/images/_consumed.svg.erb +5 -0
data/app/assets/images/_worn.svg.erb +3 -0
data/app/assets/stylesheets/_report.scss +201 -0
data/app/assets/stylesheets/_system-font.scss +57 -0
data/app/assets/stylesheets/styles.scss +2 -0
data/app/assets/templates/report.html.erb +124 -0
data/bin/console +14 -0
data/bin/setup +7 -0
data/docs/sample_pack.png +0 -0
data/docs/sample_pack.rb +68 -0
data/exe/packlist +16 -0
data/lib/packlist.rb +4 -0
data/lib/packlist/dsl.rb +81 -0
data/lib/packlist/model.rb +178 -0
data/lib/packlist/report.rb +18 -0
data/lib/packlist/template.rb +55 -0
data/lib/packlist/utils.rb +20 -0
data/lib/packlist/version.rb +3 -0
data/packlist.gemspec +31 -0
data/test.html +81 -0
metadata +182 -0

data/app/assets/stylesheets/styles.scss ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ @import "system-font";
2	+ @import "report";

data/app/assets/templates/report.html.erb ADDED Viewed

@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>Packlist - <%= packlist.name %></title>
+		<style type="text/css">
+				<%= partial '../stylesheets/system-font' %>
+				<%= partial '../stylesheets/report' %>
+		</style>
+	</head>
+	<body>
+		<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display: none">
+			<%= partial "../images/worn.svg" %>
+			<%= partial "../images/consumed.svg" %>
+		</svg>
+		<header>
+			<h1><%= packlist.name %></h1>
+			<p><%= packlist.description %></p>
+		</header>
+		<section>
+			<div class="summary">
+				<table>
+					<thead>
+						<tr>
+							<th>Category</th>
+							<th>Weight</th>
+						</tr>
+					</thead>
+					<tfoot>
+						<tr>
+							<td>Base</td>
+							<td class="weight"><%= packlist.base_weight.lb %></td>
+						</tr>
+						<tr>
+							<td>Consumable</td>
+							<td class="weight"><%= packlist.consumable_weight.lb %></td>
+						</tr>
+						<tr>
+							<td>Worn</td>
+							<td class="weight"><%= packlist.worn_weight.lb %></td>
+						</tr>
+						<tr>
+							<td>Max Pack Weight</td>
+							<td class="weight"><%= packlist.total_pack_weight.lb %></td>
+						</tr>
+						<tr>
+							<td>Total</td>
+							<td class="weight"><%= packlist.total_weight.lb %></td>
+						</tr>
+					</tfoot>
+					<tbody>
+						<% for category in packlist %>
+							<tr>
+								<td><%= category.name %></td>
+								<td><%= category.total_weight.lb %></td>
+							</tr>
+						<% end %>
+					</tbody>
+				</table>
+			</div>
+			<div class="categories">
+				<% for category in packlist %>
+				<div class="category">
+					<h2><%= category.name %></h2>
+					<table>
+						<tfoot>
+							<tr>
+								<td colspan="2"></td>
+								<td class="subtotal" colspan="3">Subtotal</td>
+								<td class="numeric">
+									<%= category.total_weight.g %>
+								</td>
+								<td class="numeric">
+									<%= category.total_weight.lb %>
+								</td>
+							</tr>
+						</tfoot>
+						<tbody>
+							<% for item in category %>
+							<tr>
+								<td>
+									<input type="checkbox">
+								</td>
+								<td class="item-type">
+									<% if item.worn? %>
+										<svg class="icon worn">
+											<use xlink:href="#worn" />
+										</svg>
+									<% elsif item.consumable? %>
+										<svg class="icon consumable">
+											<use xlink:href="#consumed" />
+										</svg>
+									<% end %>
+								</td>
+								<td class="item-name">
+									<%= item.name %>
+								</td>
+								<td class="item-description">
+									<%= item.description %>
+								</td>
+								<td class="quantity">
+									<% if item.quantity != 1 %>
+									<%= item.quantity %>
+									<% end %>
+								</td>
+								<td class="item-weight">
+									<%= item.total_weight.g %>
+								</td>
+								<td class="item-weight">
+									<%= item.total_weight.oz %>
+								</td>
+							</tr>
+							<% end %>
+						</tbody>
+					</table>
+				</div>
+				<% end %>
+			</div>
+		</section>
+</body>
+</html>

data/bin/console ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "packlist"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+# require "irb"
+# IRB.start

data/bin/setup ADDED Viewed

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

data/docs/sample_pack.png ADDED Viewed

Binary file

data/docs/sample_pack.rb ADDED Viewed

@@ -0,0 +1,68 @@
+packlist do
+  name "Epic Backpacking Trip"
+  description "Seven nights in the Sierras, September 2016"
+  category "Shelter and sleeping" do
+    # Weight for this item is  280 grams (280.g)
+    item "Tarp", "2-person tarp", 280.g
+    # Item quantity can be specified. Here, the weight is per
+    # item, not the total weight of all items.
+    # Here, we specify 8 tent stakes, at 14 grams each.
+    item "Tent stakes", "Aluminum Y-stakes", 14.g, 8
+    # Other units of weight can be used as well.
+    #   g - grams
+    #   kg - kilograms
+    #   oz - ounces
+    #   lb - pounds
+    # Weight for this item is 24 ounces (24.oz)
+    item "Sleeping back", "Down 20 degree bag", 24.oz
+    # Leaving the heavy 4-season tent behind, so we comment it out
+    # item "Tent", "4-season, 3-person tent", 8.5.lb
+  end
+  category "Clothing" do
+    # On a backpacking trip, you're likely to wear some of your
+    # clothes (we hope!), while others, like rain gear and extra socks
+    # will be carried most of the time in your pack.
+    worn "T-shirt", "Wool shirt", 150.g
+    worn "Sock", "Wool socks", 80.g
+    worn "Shorts", "Running shorts", 90.g
+    # Some things are better left without a description. Just use an
+    # empty string ("").
+    worn "Underwear", "", 85.g
+    # The following items are carried in the pack, not worn.
+    item "Rain Jacket", "Keepin' high and dry!", 200.g
+    item "Insulated Jacket", "Down duffy jacket", 275.g
+    item "Warm hat", "Fleece beanie", 90.g
+  end
+  # Group your pack's items into multiple categories.
+  category "Cooking" do
+    item "Stove", "Canister stove", 90.g
+    item "Cooking pot", "900ml Titanium pot", 125.g
+    # Items like fuel are consumable. They are included in your
+    # maximum pack weight, but not in your base weight.
+    consumable "Fuel", "All season fuel blend", 110.g
+    # The canister the fuel comes in is not consumable; to accurately
+    # calculate your pack weight, you should list it separately.
+    item "Fuel canister", "4 ounce fuel canister, empty weight", 90.g
+  end
+  category "Food" do
+    # Food is also consumable, of course. You can use either the
+    # "food" or "consumable" item type; the result is the same.
+    # For each meal (breakfast, snacks, dinner), we specify the weight
+    # per day, with a quantity of 7, one for each day.
+    food "Breakfast", "Oatmeal", 150.g, 7
+    food "Snacks", "G.O.R.P", 300.g, 7
+    food "Dinner", "Dehydrated gruel", 180.g, 7
+  end
+end

data/exe/packlist ADDED Viewed

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'packlist'
+def output_filename(filename)
+  basename = File.basename(filename, ".*")
+  dirname = File.dirname(filename)
+  File.join(dirname, "#{basename}.html")
+end
+ARGV.each do |file|
+  pack = PackList::DSL.load(file)
+  report = PackList::Report.new pack
+  report.save_to(output_filename(file))
+end

data/lib/packlist.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'packlist/version'
+require 'packlist/model'
+require 'packlist/dsl'
+require 'packlist/report'

data/lib/packlist/dsl.rb ADDED Viewed

@@ -0,0 +1,81 @@
+require 'packlist/model'
+module PackList
+  module DSL
+    def packlist(&block)
+      builder = PackBuilder.new &block
+      builder.build
+    end
+    module_function :packlist
+    class PackBuilder
+      def initialize(&block)
+        @categories = []
+        if block_given?
+          instance_eval &block
+        end
+      end
+      def name(name)
+        @name = name
+        self
+      end
+      def description(description)
+        @description = description
+        self
+      end
+      def build
+        PackList.new @name, @description, @categories
+      end
+      def category(name, description=nil, &block)
+        cat_builder = CategoryBuilder.new name, description, &block
+        category = cat_builder.build
+        @categories << category
+        category
+      end
+    end
+    class CategoryBuilder
+      def initialize(name, description, &block)
+        @category = Category.new name, description
+        if block_given?
+          instance_eval(&block)
+        end
+      end
+      def item(name, description, weight, quantity=1)
+        add_item(name, description, weight, :item, quantity)
+      end
+      def worn(name, description, weight, quantity=1)
+        add_item(name, description, weight, :worn, quantity)
+      end
+      def consumable(name, description, weight=:oz, quantity=1)
+        add_item(name, description, weight, :consumable, quantity)
+      end
+      alias_method :food, :consumable
+      def build
+        @category
+      end
+      private
+      def add_item(name, description, weight, type, quantity)
+        item = Item.new(name, description, weight, type, quantity: quantity)
+        @category << item
+      end
+    end
+    def self.load(filename)
+      instance_eval(File.read(filename, encoding: "UTF-8"), filename)
+    end
+  end
+end

data/lib/packlist/model.rb ADDED Viewed

@@ -0,0 +1,178 @@
+require 'forwardable'
+module PackList
+  module WeightMixin
+    [:oz, :lb, :g, :kg].each do |units|
+      send :define_method, units do
+        return Weight.new self, units
+      end
+    end
+  end
+  class Weight
+    WEIGHT_CONVERSIONS = {lb: 453.592, oz: 453.592 / 16, kg: 1000, g: 1}
+    attr_reader :quantity, :units
+    def initialize(quantity, units)
+      raise ArgumentError, "Invalid units: #{units}" unless WEIGHT_CONVERSIONS.key?(units)
+      @quantity, @units = quantity, units
+    end
+    [:oz, :lb, :g, :kg].each do |units|
+      send :define_method, units do
+        to_units units
+      end
+    end
+    def +(w)
+      # avoid changing units when either weight is zero
+      case
+      when w.quantity == 0
+        self
+      when self.quantity == 0
+        w
+      when w.units == @units
+        Weight.new w.quantity + @quantity, @units
+      else
+        self + w.to_units(@units)
+      end
+    end
+    def *(x)
+      Weight.new x * @quantity, @units
+    end
+    ZERO = Weight.new(0, :g)
+    # private
+    def in_units(new_units)
+      quantity * WEIGHT_CONVERSIONS[units] / WEIGHT_CONVERSIONS[new_units]
+    end
+    def to_units(new_units)
+      Weight.new in_units(new_units), new_units
+    end
+    def to_s
+      "#{'%.1f' % quantity} #{units}"
+    end
+  end
+  class Item
+    attr_accessor :name, :description, :weight, :quantity
+    def initialize(name, description, weight, type=nil, quantity: 1)
+      @name, @description, @quantity, @type = name, description, quantity, type
+      @weight = weight.respond_to?(:units) ? weight : Weight.new(weight, :oz)
+    end
+    def total_weight
+      return @weight * @quantity
+    end
+    def worn?
+      return @type == :worn
+    end
+    def consumable?
+      return @type == :consumable
+    end
+  end
+  class Category
+    include Enumerable
+    extend Forwardable
+    attr_accessor :name, :description
+    attr_reader :items
+    def_delegators :@items, :each, :<<, :include?, :empty?
+    def initialize(name, description=nil)
+      @name, @description = name, description
+      @items = []
+    end
+    def total_weight
+      @items.collect {|item| item.total_weight}.reduce(Weight::ZERO, :+)
+    end
+    def total_pack_weight
+      base_weight + consumable_weight
+    end
+    def worn_weight
+      items = @items.select {|item| item.worn? }
+      items.collect {|item| item.total_weight}.reduce(Weight::ZERO, :+)
+    end
+    def consumable_weight
+      items = @items.select {|item| item.consumable? }
+      items.collect {|item| item.total_weight}.reduce(Weight::ZERO, :+)
+    end
+    def base_weight
+      items = @items.reject {|item| item.worn? || item.consumable? }
+      items.collect {|item| item.total_weight}.reduce(Weight::ZERO, :+)
+    end
+    def total_quantity
+      @items.collect {|item| item.quantity}.reduce(0, :+)
+    end
+    def item_count
+      @items.length
+    end
+  end
+  class PackList
+    include Enumerable
+    extend Forwardable
+    attr_accessor :name, :description
+    attr_reader :categories
+    def_delegators :@categories, :each, :<<, :include?, :empty?
+    def initialize(name, description=nil, categories=[])
+      @name, @description = name, description
+      @categories = categories
+    end
+    def total_weight
+      @categories.collect {|category| category.total_weight}.reduce(Weight::ZERO, :+)
+    end
+    def total_pack_weight
+      base_weight + consumable_weight
+    end
+    def worn_weight
+      @categories.collect {|category| category.worn_weight}.reduce(Weight::ZERO, :+)
+    end
+    def consumable_weight
+      @categories.collect {|category| category.consumable_weight}.reduce(Weight::ZERO, :+)
+    end
+    def base_weight
+      @categories.collect {|category| category.base_weight}.reduce(Weight::ZERO, :+)
+    end
+    def total_quantity
+      @categories.collect {|category| category.total_quantity}.reduce(0, :+)
+    end
+    def item_count
+      @categories.collect {|category| category.item_count}.reduce(0, :+)
+    end
+  end
+end
+class Numeric
+  include PackList::WeightMixin
+end