packlist 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d070947f5c8ef6872a58f07ebc0b8f3498c5420d
+  data.tar.gz: 615a84d4aa70c735fbe2c649b752b0b28a1bcb7e
+SHA512:
+  metadata.gz: df2073a12540f8b5acd4192b7730d783381339a9b9a5e2af2005651721d3666753a88624e11655ba1350af61fbe03c03fe5be14b2a550a69f1279f2516fd7675
+  data.tar.gz: cc32c50504f7aa6c011baae6b9b672d3d952bd3fcfc84e797c63ab0c4d538b3767939b98012d03092dbdabfda6c4f8b67ccbed660a37ad76073eb7c6a26cc538

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.pryrc
+mypacks
+.sass-cache
+docs/*.html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in packlist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jim Cushing
+
+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,131 @@
+# Packlist - Backpacking Pack Lists for Geeks
+
+Experienced backpackers know that a lighter pack helps you move faster and more comfortably, so you can enjoy the outdoors more. They also know that the best way to lighten your pack is by weighing and tracking every item. Only then can you seriously (and sometimes obsessively) evaluate what you should bring, what you should leave behind, and what you can substitute for a lighter or multiple use item.
+
+Packlist can help you inventory and track your backpacking items and help you achieve that lighter pack. There are plenty of ways to do this, such as spreadsheets and the excellent site, [LighterPack](https://lighterpack.com).
+
+Packlist is a bit different than these other options: It uses simple, and easy to read, text files to represent your pack's contents. (These files are actually small Ruby programs, but you needn't know any Ruby to use them).
+
+Using text files has some advantages. You can create a master list of all your gear, then create a copy of that file and tailor it to a specific trip. You won't bring all the same gear on a summer trip as a winter trip, nor is the gear for a weekend in the Rockies the same as a AT thru hike. Packlist makes it easy to create lists tailored to your particular trip.
+
+Additional, this is Packlist: Backpacking Lists for Geeks. The means outdoor loving geeks can use their favorite tools, like source control and their preferred text editor, to manage their pack lists.
+
+![Sample Pack](docs/sample_pack.png "Sample report generated by Packlist")
+
+
+## Installation
+
+Install Packlist with the following command:
+
+    gem install packlist
+
+(Packlist requires Ruby to run. Mac OS X and most Linux distributions have Ruby pre-installed, and installers are available for Windows.)
+
+
+## Creating a Pack List
+
+Using your preferred text editor, create a file named `my_pack.rb` with the following contents:
+
+    packlist do
+      name "Epic Backpacking Trip"
+      description "Seven nights in the Sierras"
+    end
+
+`name` and `description` can be anything you'd like.
+
+### Add a category
+
+After `description`, and before `end`, add your first category by inserting the following:
+
+    category "Shelter and sleeping" do
+    end
+
+### Add an item
+
+Between `category…do` and `end`, insert the following to add an item:
+
+    item "Tent", "4-season, 3-person tent", 8.5.lb
+
+This defined an item named "Tent", with description, "4-season, 3-person tent". It's weight is specified at 8.5 pounds. You may use other units of weight, by substituting "g", "kg", or "oz"—for grams, kilograms, or ounces, respective—for "lg". Examples:
+
+* 1200.g = 1,200 grams
+* 42.3.oz = 42.3 ounces
+* 1.2.kg = 4.5 kilograms
+* 2.65.lb = 2.65 pounds
+
+Within a category, and with your pack, you may mix and match units of measure. Packlist will perform the appropriate conversions and calculations.
+
+#### Specify Item Quantity
+
+If you have multiple quantities of a given item (like tent stakes), specify the quantity after the unit weight:
+
+    item "Tent stakes", "Aluminum Y-stakes", 14.g, 8
+
+Note that the weight is per individual item; the line above adds eight tent stakes, with a weight of 14 grams each.
+
+#### Specify Worn Items
+
+Items that are regularly warn while hiking (such as a shirt, pants, or shorts) can be added as follows:
+
+    worn "T-shirt", "Wool shirt", 150.g
+
+Worn items do not count in your base weight, nor your maximum pack weight, but they do count towards your total weight (also known as "skin out weight").
+
+Clothing that you will usually carry in your pack, such as a rain jacket, should be added with the `item` keyword:
+
+    item "Rain Jacket", "2.5 layer lightweight jacket", 200.g
+
+#### Specify Consumable Items
+
+Items which are consumed, such as food and fuel, are added with the `consumable` or `food` keywords:
+
+    consumable "Fuel", "All season fuel blend", 110.g
+    food "Breakfast", "Oatmeal", 150.g, 7
+
+(`food` is just an alias for `consumable`. You could use `consumable` for your breakfast, and even `food` for your fuel…but we don't recommend eating your fuel).
+
+### Removing an Item from your list
+
+Because your pack list is simply a text file, all you have to do to remove an item from your list is delete that line. Because it's also a Ruby program, you can also remove it by commenting out the line. Commented lines are ignored when Packlist runs and prepares your report.
+
+Commenting out a line, rather than removing it, is helpful when your not sure if you'll bring an item or not, or when you're basing a list for a new trip off of a list from an old trip. Simply make a copy of the old list, and comment out items items that you won't need on this trip. And if you decide you do need that item, just un-comment the line.
+
+Commented lines begin with a hash (#). Add a hash to the beginning of the line to comment the line out, and remove the hash to un-comment the line.
+
+You may also leave comments to yourself in the pack list in the same way:
+
+    # Do I want to bring my heavy tent, or my lightweight tarp?
+    item "Tarp", "2-person tarp", 280.g
+    # item "Tent", "4-season, 3-person tent", 8.5.lb
+
+For a complete example of a pack list, see [this sample file](docs/sample_pack.rb).
+
+## Usage
+
+To generate an HTML report for your pack list, run the following command.
+
+    packlist my_pack.rb
+
+This will output a file named `my_pack.html`. You may open this in any modern browser (Safari, Chrome, or Firefox is recommended).
+
+## Future Plans
+
+* Add option to generate a PDF report.
+* Add pie graph, showing relative weights for each category (similar to LighterPack)
+
+## Acknowledgements
+
+* Thanks to a reader on Backpackinglight.com for the initial idea.
+* Thanks to [Galen Maley](http://www.galenmaly.com) for creating [LighterPack](https://lighterpack.com), which is an excellent resource for backpackers.
+* Thanks to the many creators of the open source libraries used by Packlist.
+
+## Contributing
+
+New features and bug fixes are welcome. If you've got a bug report or feature request
+
+1. Fork it ( https://github.com/jimothyGator/packlist/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write unit tests. Minitest Spec is preferred.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Run tests (default)'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-Itest']
+  t.ruby_opts << '-rubygems' if defined? Gem
+end
+
+task :default => :test
+

data/app/assets/images/_consumed.svg.erb

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<symbol id="consumed" viewBox="0 0 128 222">
+        <path d="M25.053009,90.4603449 C25.053009,160.302439 10.394806,188.700867 18.817474,213.360437 C22.830413,225.109239 40.00122,223.724333 42.961944,213.360437 C49.785705,189.473978 37.020355,158.89535 37.020355,90.4603449 C37.020355,82.4954894 63.029236,83.8642296 63.029236,56.6383793 C63.029236,22.5631522 46.478485,0 30.704041,0 C15.982209,0 -5.68434189e-14,24.7351772 -5.68434189e-14,56.6383793 C-5.68434189e-14,82.2042966 25.053009,83.8955928 25.053009,90.4603449 L25.053009,90.4603449 Z" id="spoon" sketch:type="MSShapeGroup"></path>
+        <path d="M88.7367538,207.440963 C91.5542217,230.829957 115.016149,222.009951 117.90196,207.440963 C124.229161,175.498147 110.725062,182.029259 110.725062,119.914285 C110.725062,112.315793 127.993914,101.719946 127.993914,82.1393318 C127.993914,47.3266137 120.161297,1.42108547e-14 103.095177,1.42108547e-14 C86.7347449,1.42108547e-14 90.4806776,61.0077929 90.4806776,94.3733754 C90.4806776,108.704387 96.2690217,112.43459 96.2690217,119.149204 C96.2690217,175.792707 84.6022946,173.119069 88.7367538,207.440963 Z" id="knife" sketch:type="MSShapeGroup"></path>
+</symbol>

data/app/assets/images/_worn.svg.erb

@@ -0,0 +1,3 @@
+<symbol id="worn" viewBox="0 0 116 101" >
+            <path d="M60.0008541,5.504847 C52.8634204,5.49189712 45.7695092,1.65694841 44.2444783,7.10542736e-15 C43.5985652,7.10542736e-15 0.001,30.9647619 0.001,30.9647619 L10.1540435,58.6838095 L30.0698696,42.2714286 L30.0698696,100.185714 L59.9164783,100.185714 L60.4215217,100.185714 L90.2691739,100.185714 L90.2691739,42.2714286 L110.183957,58.6838095 L120.338043,30.9647619 C120.338043,30.9647619 76.7394348,7.10542736e-15 76.0945652,7.10542736e-15 C74.5455092,1.68305159 67.2507293,5.51800059 60.0008541,5.504847 Z" id="Shape" sketch:type="MSShapeGroup"></path>
+</symbol>

data/app/assets/stylesheets/_report.scss

@@ -0,0 +1,201 @@
+body {
+  font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif;
+  font-size: 10pt;
+}
+
+header,
+section {
+  margin: 2em auto;
+  padding: 0 1em;
+  max-width: 1200px;
+}
+
+header {
+  margin-bottom: 1em;
+  h1, p {
+    margin: 0.2em 0;
+  }
+}
+
+@media (min-width: 960px) {
+  section {
+    display: flex;
+
+    div {
+      display: flex;
+      flex-direction: column;
+    }
+
+    .summary {
+      flex: 0 1 20em;
+      order: 2;
+      padding-left: 2em;
+    }
+
+    .categories {
+      flex: 1 0 600px;
+      order: 1;
+    }
+  }
+}
+
+table {
+  tr {
+    td, th {
+      padding: 0.25em;
+    }
+  }
+}
+
+.summary {
+  margin-bottom: 2em;
+
+  table {
+    border-collapse: collapse;
+
+    tr {
+      td + td,
+      th + th {
+        padding-left: 2em;
+        text-align: right;
+      }
+    }
+
+    thead tr {
+      border-bottom: solid 1px black;
+    }
+
+    tbody,
+    tfoot {
+      tr {
+        border-style: solid;
+        border-width: 1px 0;
+      }
+    }
+
+    tbody {
+      font-weight: 400;
+      tr {
+        border-color: #ddd;
+        border-style: dotted;
+      }
+    }
+
+
+
+    tfoot {
+      font-weight: 500;
+      tr:first-child {
+        border-top-color: black;
+      }
+      tr {
+        border-color: #999;
+      }
+    }
+    th {
+      text-align: left;
+    }
+  }
+}
+
+svg.icon {
+  width: 16px;
+  height: 16px;
+  vertical-align: middle;
+
+  &.consumable {
+    fill: #009;
+  }
+
+  &.worn {
+    fill: #065;
+  }
+}
+
+
+td.quantity,
+td.item-weight,
+td.weight {
+	text-align: right;
+}
+
+div.category {
+	$checkmark-column: 1;
+
+  h2 {
+    font-size: 1.1em;
+    border-bottom: solid 2px black;
+    margin: 0;
+    line-height: 1.3;
+  }
+
+	margin-bottom: 2em;
+
+  table {
+  	margin-top: 0;
+    table-layout: fixed;
+    width: 100%;
+    border-collapse: collapse;
+    line-height: 1.6;
+
+  	p {
+  		margin: 0;
+  	}
+
+  	.item-name {
+  		font-weight: 500;
+  	}
+
+  	tfoot {
+  		font-weight: 600;
+
+      td.subtotal {
+        text-align: left;
+        font-size: 1.05em;
+      }
+
+  		td {
+  			text-align: right;
+  			border-top: solid 2px #333;
+  		}
+
+      tr {
+        border-bottom: solid 1px #333;
+      }
+
+  	}
+
+  	tbody {
+      tr {
+        border-bottom: solid 1px #ddd;
+      }
+
+    	// Checkmark
+    	td:nth-child(#{$checkmark-column}) {
+    		width: 1em;
+    	}
+
+    	td.quantity {
+    		width: 3em;
+    	}
+
+    	td.item-type {
+    		width: 2em;
+        text-align: center;
+    	}
+
+      td.item-name {
+        // width: 15em;
+      }
+
+      td.item-description {
+        width: auto;
+        font-weight: 400;
+      }
+
+    	td.item-weight {
+    		width: 5em;
+    	}
+    }
+  }
+}

data/app/assets/stylesheets/_system-font.scss

@@ -0,0 +1,57 @@
+/*! system-font.css v1.1.0 | CC0-1.0 License | github.com/jonathantneal/system-font-face */
+
+@font-face {
+	font-family: system;
+	font-style: normal;
+	font-weight: 300;
+	src: local(".SFNSText-Light"), local(".HelveticaNeueDeskInterface-Light"), local(".LucidaGrandeUI"), local("Ubuntu Light"), local("Segoe UI Light"), local("Roboto-Light"), local("DroidSans"), local("Tahoma");
+}
+
+@font-face {
+	font-family: system;
+	font-style: italic;
+	font-weight: 300;
+	src: local(".SFNSText-LightItalic"), local(".HelveticaNeueDeskInterface-Italic"), local(".LucidaGrandeUI"), local("Ubuntu Light Italic"), local("Segoe UI Light Italic"), local("Roboto-LightItalic"), local("DroidSans"), local("Tahoma");
+}
+
+@font-face {
+	font-family: system;
+	font-style: normal;
+	font-weight: 400;
+	src: local(".SFNSText-Regular"), local(".HelveticaNeueDeskInterface-Regular"), local(".LucidaGrandeUI"), local("Ubuntu"), local("Segoe UI"), local("Roboto-Regular"), local("DroidSans"), local("Tahoma");
+}
+
+@font-face {
+	font-family: system;
+	font-style: italic;
+	font-weight: 400;
+	src: local(".SFNSText-Italic"), local(".HelveticaNeueDeskInterface-Italic"), local(".LucidaGrandeUI"), local("Ubuntu Italic"), local("Segoe UI Italic"), local("Roboto-Italic"), local("DroidSans"), local("Tahoma");
+}
+
+@font-face {
+	font-family: system;
+	font-style: normal;
+	font-weight: 500;
+	src: local(".SFNSText-Medium"), local(".HelveticaNeueDeskInterface-MediumP4"), local(".LucidaGrandeUI"), local("Ubuntu Medium"), local("Segoe UI Semibold"), local("Roboto-Medium"), local("DroidSans-Bold"), local("Tahoma Bold");
+}
+
+@font-face {
+	font-family: system;
+	font-style: italic;
+	font-weight: 500;
+	src: local(".SFNSText-MediumItalic"), local(".HelveticaNeueDeskInterface-MediumItalicP4"), local(".LucidaGrandeUI"), local("Ubuntu Medium Italic"), local("Segoe UI Semibold Italic"), local("Roboto-MediumItalic"), local("DroidSans-Bold"), local("Tahoma Bold");
+}
+
+@font-face {
+	font-family: system;
+	font-style: normal;
+	font-weight: 700;
+	src: local(".SFNSText-Bold"), local(".HelveticaNeueDeskInterface-Bold"), local(".LucidaGrandeUI"), local("Ubuntu Bold"), local("Roboto-Bold"), local("DroidSans-Bold"), local("Segoe UI Bold"), local("Tahoma Bold");
+}
+
+@font-face {
+	font-family: system;
+	font-style: italic;
+	font-weight: 700;
+	src: local(".SFNSText-BoldItalic"), local(".HelveticaNeueDeskInterface-BoldItalic"), local(".LucidaGrandeUI"), local("Ubuntu Bold Italic"), local("Roboto-BoldItalic"), local("DroidSans-Bold"), local("Segoe UI Bold Italic"), local("Tahoma Bold");
+}