haversack 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d71edcac6f25267e658d600c14549b4be32fe255a2bfcbf00a2c8c73e8d7a3c6
-  data.tar.gz: e895b3122a414660d8fbf52a1d64c8e0b08c920bb13bef8ce63168fd483499e5
+  metadata.gz: 3cf37108921d996da5627939fc13908ccb719958853a6d9620c89fb2e0a0a360
+  data.tar.gz: 21f14e3402e28bdef0b0a4fda8504886a5a06468bf0ab11782ddba7a9ceec839
 SHA512:
-  metadata.gz: ea48edcbbd0f07b31b119fec4000d8c596a85368b02ff37e2f9832279e14a5eef5be49bc2ea04e314dfd1a8b5e5a1674e0c79c3c5865b9b6a253ed7973676a1c
-  data.tar.gz: 6a910b9216773f852aedacae2a96d0aa11d4997de9a8665374c024db50811a2c7dd6d1171c2d683c273f244aac2f16570cbc92a441a3a17d09d33002f8d43c15
+  metadata.gz: f496dd7d39b89a525eb35eee1a26a80997d9821a8543f002f3e27b8078cec6593de424bec8582177738dee1fe637c820c532cbe8f5991e6acf52dc804ff6a5a3
+  data.tar.gz: 0c36f081dac2c44173e92c3ebb0f24f2555d09e645976d629a831970a4b6ac59f9506222b33cdae4e904fa120cef6b3a7c45849398a7b8c1d942f8a557b5edd5

data/README.md

@@ -1,8 +1,31 @@
 # Haversack
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/haversack`. To experiment with that code, run `bin/console` for an interactive prompt.
+Haversack is an enumerable abstraction of a [Knapsack](https://en.wikipedia.org/wiki/Knapsack_problem).
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+#### Basic Usage:
+```ruby
+require 'haversack'
+
+haversack = Sack.new(capacity: 10, weight: 10)
+items     = Array.new(10) { Haversack::Item.new(weight: 1, size: 1) }
+
+haversack.contents = items
+```
+Only objects of the `Haversack::Item` class may be added to a haversack's contents.
+
+#### Haversack provides constraints upon what items may be set as the knapsack contents:
+```ruby
+too_large = Array.new(haversack.capacity + 1) { Haversack::Item.new }
+haversack.contents = too_large # => Haversack::KnapsackCapacityExceededError
+```
+
+#### Or you may add one item at a time
+```ruby
+item = Haversack::Item.new
+haversack.push item if haversack.fits_item? item
+```
 
 ## Installation
 
@@ -20,9 +43,6 @@ Or install it yourself as:
 
     $ gem install haversack
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 

data/lib/haversack/item.rb

@@ -4,7 +4,7 @@ module Haversack
     attr_accessor :size
     attr_accessor :data
     
-    def initialize(weight:, size: 1, data: nil)
+    def initialize(weight: 1, size: 1, data: nil)
       @weight = weight
       @size   = size
       @data   = data

data/lib/haversack/version.rb

@@ -1,3 +1,3 @@
 module Haversack
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haversack
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alex0112