haversack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cd0e17b216a5749f67cfa35838d739f4d45971dbb87b6a145cba0a41f4e9b2e
+  data.tar.gz: 727df279fe818360a8533f698700d218d3801f4939052d719fe252aa2a7dd9ba
+SHA512:
+  metadata.gz: de5429d256326f523cf432ff334944318900104477b0dba9b93bcd5079e16e1bc615e8ab10d29d6cd498c85c05482c60597948a8abe2cb3cbca3d092f3849b7e
+  data.tar.gz: 443d15a96241f0b4bb73e70653f46b1a45f3207d924bfff57e2a6014603598dc380c7acfce4dc66557ba73c5b450622ea085e6aacf55bd550120729800917c3a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in haversack.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Alex Larsen
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 alex0112
+
+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,39 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'haversack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install haversack
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/haversack.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "haversack"
+
+# 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(__FILE__)

data/bin/setup

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

data/haversack.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "haversack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "haversack"
+  spec.version       = Haversack::VERSION
+  spec.authors       = ["alex0112"]
+  spec.email         = ["alarsen0112@gmail.com"]
+
+  spec.summary       = %q{Knapsack Abstraction}
+  spec.description   = %q{Haversack is an enumberable abstraction of a Knapsack}
+  spec.homepage      = "https://github.com/alex0112/haversack"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/alex0112/haversack"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib/haversack.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "factory_bot", "~> 4.0"
+
+end

data/lib/haversack/err.rb

@@ -0,0 +1,5 @@
+module Haversack
+  class KnapsackCapacityExceededError < StandardError; end
+  class KnapsackWeightExceededError < StandardError; end
+  class KnapsackContentError < StandardError; end
+end

data/lib/haversack/item.rb

@@ -0,0 +1,13 @@
+module Haversack
+  class Item
+    attr_accessor :weight
+    attr_accessor :size
+    attr_accessor :data
+    
+    def initialize(weight:, size: 1, data: nil)
+      @weight = weight
+      @size   = size
+      @data   = data
+    end
+  end
+end

data/lib/haversack/sack.rb

@@ -0,0 +1,79 @@
+class Sack
+  include Enumerable
+
+  attr_reader :capacity, :weight, :available_capacity, :current_weight, :contents
+
+  def initialize(capacity:, weight:, contents: nil)
+    @capacity           = capacity
+    @weight             = weight
+    self.contents       = contents || [] ## Use the setter to enforce weight/capacity restrictions
+    @current_weight     = self.current_weight
+    @available_capacity = self.available_capacity
+  end
+
+  def method_missing(method_id)
+    Enumerable.respond_to? method_id ? @contents.send(method_id) : raise(NoMethodError)
+  end
+  
+  def contents=(new_contents)
+    raise Haversack::KnapsackContentError          if has_non_items? new_contents
+    raise Haversack::KnapsackCapacityExceededError if exceeds_capacity? new_contents
+    raise Haversack::KnapsackWeightExceededError   if exceeds_weight? new_contents
+    
+    @contents = new_contents
+  end
+
+  def has_non_items?(contents) ## TODO: Consider refactor: Static method?  Doesn't rely on instance data.
+    contents.any? { |e| !e.is_a? Haversack::Item }
+  end
+
+  def current_weight
+    @contents.empty? ? 0 : @contents.map { |item| item.weight }.sum
+  end
+
+  ## TODO: the *fit* methods duplicate behavior.  Consolidate them in a future itteration.
+  
+  def fits_item_weight?(item)
+    item.weight + @current_weight <= @weight
+  end
+
+  def available_capacity
+    @contents.empty? ? @capacity : (@capacity - @contents.length)
+  end
+
+  def fits_item_capacity?(item)
+    item.size < @available_capacity
+  end
+
+  def will_fit?(item)
+    (item.is_a? Haversack::Item) && (fits_item_capacity?(item) && fits_item_weight?(item))
+  end
+
+  def push(item) ## TODO: This should return an error that describes which constraint failed
+    will_fit? item ? @contents.push(item) : raise(Haversack::KnapsackContentError) 
+    @contents
+  end
+
+  def fits_contents?(contents)
+    fits_weight?(contents) && fits_capacity?(contents)
+  end
+
+  def fits_weight?(contents)
+    new_weight = contents.map { |item| item.weight }.sum
+    new_weight <= @weight
+  end
+
+  def exceeds_weight?(contents)
+    !fits_weight? contents
+  end
+
+  def fits_capacity?(contents)
+    new_capacity = contents.map { |item| item.size }.sum
+    new_capacity <= @capacity
+  end
+
+  def exceeds_capacity?(contents)
+    !fits_capacity? contents
+  end
+
+end

data/lib/haversack/version.rb

@@ -0,0 +1,3 @@
+module Haversack
+  VERSION = "0.1.0"
+end

data/lib/haversack.rb

@@ -0,0 +1,6 @@
+module Haversack
+  require "haversack/version"
+  require "haversack/sack"
+  require "haversack/item"
+  require "haversack/err"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: haversack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alex0112
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Haversack is an enumberable abstraction of a Knapsack
+email:
+- alarsen0112@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- haversack.gemspec
+- lib/haversack.rb
+- lib/haversack/err.rb
+- lib/haversack/item.rb
+- lib/haversack/sack.rb
+- lib/haversack/version.rb
+homepage: https://github.com/alex0112/haversack
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/alex0112/haversack
+  source_code_uri: https://github.com/alex0112/haversack
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/haversack.rb
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Knapsack Abstraction
+test_files: []