apportion 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0164723475a1fb9b94e2f42e8cdea11a7329618d
+  data.tar.gz: bc55cb9674ec51022132a40d1192c574e95302e0
+SHA512:
+  metadata.gz: 34533ff02d06f3b15f1ff0bcb8a878eeea4ea983e13cb160df4daecf745d777ecd80dae96bd59803c4e488a4da14097e8e01017e71a8dfc4cd38a82f7439967b
+  data.tar.gz: 001cc71d1a2063588b764d86b825d7b2e1fd3f3120a9683138d30603ab0a8cc1664ed99062dfaf8721f542712724260d7afda8a62f90329728b6b5a7a7ee50e1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gfleshman@newforge-tech.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gary Fleshman
+
+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,78 @@
+# Apportion [![travis][ci_img]][travis] [![yard docs][yd_img]][yard_docs] [![code climate][cc_img]][code_climate]
+
+A Ruby implementation for apportionment
+
+### Description
+Apportionment is most often associated with the [US Congressional apportionment][congress_ep],
+using the **Equal Proportions** (or Huntington-Hill) method.
+
+In general, apportionment involves the division of a scarce resource among recipients, according
+to a pre-determined set of recipient weights. Further, a series of apportionments might occur over
+time, with each new apportionment overlaying the previous.
+
+Different domains might make use of apportionment. One example is the allocation (or distribution)
+of sellable inventory among a number of retail stores, according to the expected sales rate for
+each store. For this usage, recipients would likely begin an apportionment with varying quantities
+of existing inventory.
+
+Other apportionment methods exist, notably the [**Quota**][ams_balinski] method,
+that address issues with **Equal Proportions**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apportion'
+```
+
+And then execute
+
+    $ bundle
+
+Or install it yourself as
+
+    $ gem install apportion
+
+## Usage
+
+### Apportion.division(weights, size, options = {})
+
+Returns a hash (a key for each recipient) with the size quantity distributed among recipients
+(as values)
+
+#### Parameters
+
+`weights` (required) a [Hash] of relative integer proportions for each recipient
+
+`size` (required) an [Integer] quantity to apportion
+
+`options` (optional) [Hash] keys
+
+* **:prior_portions** a [Hash] prior portions for each recipient from a previous apportionment
+* **:required_minimum** an [Integer] smallest portion for each recipient
+
+## Development
+
+To install dependencies
+
+    $ bundle
+
+To run the tests
+
+    $ rake
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][license].
+
+[congress_ep]: https://en.wikipedia.org/wiki/United_States_congressional_apportionment#The_method_of_equal_proportions
+[ams_balinski]: https://www.maa.org/sites/default/files/pdf/upload_library/22/Ford/BalinskiYoung.pdf
+[license]: http://opensource.org/licenses/MIT
+
+[travis]: https://travis-ci.org/garyf/apportion
+[ci_img]: https://travis-ci.org/garyf/apportion.svg?branch=master
+[yard_docs]: http://www.rubydoc.info/github/garyf/apportion
+[yd_img]: http://img.shields.io/badge/yard-docs-blue.svg
+[code_climate]: https://codeclimate.com/github/garyf/apportion
+[cc_img]: https://codeclimate.com/github/garyf/apportion/badges/gpa.svg

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/apportion.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apportion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apportion"
+  spec.version       = Apportion::VERSION
+  spec.authors       = ["Gary Fleshman"]
+  spec.email         = ["gfleshman@newforge-tech.com"]
+
+  spec.summary       = 'Apportion for Ruby'
+  spec.description   = 'Ruby implementation for apportionment'
+  spec.homepage      = 'https://github.com/garyf/apportion'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'json', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/bin/console

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

@@ -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/lib/apportion/algorithm/equal_proportions.rb

@@ -0,0 +1,39 @@
+module Apportion
+  module Algorithm
+    # Selects the next recipient
+    module EqualProportions
+
+      BIG_FIXNUM = 2 ** 30
+
+      module_function
+
+      # Selects the next recipient by sorting the equal proportions rank-index of the recipients
+      #
+      # see Balinski, M. and H. Young, The Quota Method of Apportionment, Amer. Math. Monthly 82 (1975) 701-730.
+      #
+      # @param weights [Hash] relative integer proportions
+      # @param portions [Hash]
+      # @return [Symbol] recipient having the highest equal proportions rank-index
+      # @example
+      #   next_recipient({a: 41, b: 32, c: 27}, {a: 4, b: 3, c: 2})
+      #   # => :c
+
+      def next_recipient(weights, portions)
+        weights.max_by { |k, v| recipient_rank(v, portions[k]) }[0]
+      end
+
+      def recipient_rank(weight, portion)
+        return zero_rank(weight) if portion == 0
+        weight / Math.sqrt(portion * (portion + 1)).to_f
+      end
+
+      # protect from division by zero
+      def zero_rank(weight)
+        weight * BIG_FIXNUM
+      end
+
+      private_class_method :recipient_rank,
+        :zero_rank
+    end
+  end
+end

data/lib/apportion/setup.rb

@@ -0,0 +1,39 @@
+require 'apportion/util'
+
+module Apportion
+  # Configure per options
+  module Setup
+    module_function
+
+    # Determines initial portions for recipients according to optional constraints
+    #
+    # @param keys [Hash] correspond to recipients
+    # @param options [Hash]
+    # @param options [Hash] :prior_portions from a previous apportionment
+    # @option options [Integer] :required_minimum smallest portion for each recipient
+    # @return [Hash] portions
+    # @example
+    #   initial_portions({a: 41, b: 32, c: 27}, required_minimum: 2)
+    #   # => {a: 2, b: 2, c: 2}
+
+    def initial_portions(keys, options)
+      portions = Hash.new
+      int = options[:required_minimum] || 0
+      keys.each { |k| portions[k] = int }
+      hash = options[:prior_portions]
+      return portions unless hash
+      prior_portions_included(portions, hash)
+    end
+
+    def prior_portions_included(portions, prior_portions)
+      portions.merge(prior_portions) { |_k, o, n| [o, n].max }
+    end
+
+    # @raise [RuntimeError] if size too small
+    def validate(size, sum_portions)
+      fail('Size less than minimum sum_portions') if size < sum_portions
+    end
+
+    private_class_method :prior_portions_included
+  end
+end

data/lib/apportion/util.rb

@@ -0,0 +1,54 @@
+module Apportion
+  # Utility methods
+  module Util
+    module_function
+
+    # Reads a JSON file and returns a hash with symbols as keys
+    #
+    # @param path_to_directory [String]
+    # @param json_file_name [String]
+    # @return [Hash] with symbolized keys
+    # @example
+    #   file_read_json_to_hash(path_to_directory, json_file_name)
+    #   # => {a: 5, b: 2, c: 3}
+
+    def file_read_json_to_hash(path_to_directory, json_file_name)
+      hash = JSON.parse(File.read(File.join(path_to_directory, json_file_name)))
+      symbolize_keys(hash)
+    end
+
+    # Sums all of the values in a hash
+    #
+    # @param hash [Hash] with numeric values
+    # @return [Numeric] the sum of all values
+    # @example
+    #   hash_values_sum({a: 8, b: 2, c: 3})
+    #   # => 13
+
+    def hash_values_sum(hash)
+      hash.values.reduce(0) { |acc, v| acc + v }
+    end
+
+    # Returns a new hash with symbols as keys
+    #
+    # @param hash [Hash]
+    # @return [Hash] a new hash with all string keys converted to symbols,
+    #   provided that the keys respond to #to_sym
+    # @see cf. rails activesupport/lib/active_support/core_ext/hash/keys.rb
+    # @example
+    #   symbolize_keys({'a' =>  0, 'b' => '2', c: '3'})
+    #   # => {a: 0, b: '2', c: '3'}
+
+    def symbolize_keys(hash)
+      transform_keys(hash) { |key| key.to_sym rescue key }
+    end
+
+    def transform_keys(hash)
+      result_hash = Hash.new
+      hash.keys.each { |k| result_hash[yield(k)] = hash[k] }
+      result_hash
+    end
+
+    private_class_method :transform_keys
+  end
+end

data/lib/apportion/version.rb

@@ -0,0 +1,3 @@
+module Apportion
+  VERSION = '0.0.1'
+end

data/lib/apportion.rb

@@ -0,0 +1,40 @@
+require 'apportion/algorithm/equal_proportions'
+require 'apportion/setup'
+require 'apportion/util'
+
+# Top level interface, or API, to distribute a quantity among recipients
+module Apportion
+  include Apportion::Setup
+  include Apportion::Util
+  module_function
+
+  # Distributes a quantity among recipients by dividing proportionally according to relative
+  # weights using the 'equal proportions' algorithm
+  #
+  # @param weights [Hash] relative integer proportions
+  # @param size [Integer] quantity to apportion
+  # @param options [Hash]
+  # @option options [Hash] :prior_portions from a previous apportionment
+  # @option options [Integer] :required_minimum smallest portion for each recipient
+  # @return [Hash] portions
+  # @example
+  #   division({a: 41, b: 32, c: 27}, 7)
+  #   # => {a: 3, b: 2, c: 2}
+
+  def division(weights, size, options = {})
+    portions = initial_portions(weights.keys, options)
+    sum_portions = hash_values_sum(portions)
+    validate(size, sum_portions)
+    next_step(weights, portions, sum_portions, size)
+  end
+
+  # recursively
+  def next_step(weights, portions, sum_portions, size)
+    return portions if sum_portions == size
+    key = Algorithm::EqualProportions.next_recipient(weights, portions)
+    next_portions = portions.merge(key => portions[key] + 1)
+    next_step(weights, next_portions, sum_portions + 1, size)
+  end
+
+  private_class_method :next_step
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: apportion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary Fleshman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Ruby implementation for apportionment
+email:
+- gfleshman@newforge-tech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apportion.gemspec
+- bin/console
+- bin/setup
+- lib/apportion.rb
+- lib/apportion/algorithm/equal_proportions.rb
+- lib/apportion/setup.rb
+- lib/apportion/util.rb
+- lib/apportion/version.rb
+homepage: https://github.com/garyf/apportion
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Apportion for Ruby
+test_files: []
+has_rdoc: