gale_shapley 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51db3f9f6fbc3398c570abb818fb67617c96e788db078f381f1a336d0d3b63e0
+  data.tar.gz: e0bf9a0f8a988b81db52914beb9a73545f928a636d23d03b4291d696bca52f5a
+SHA512:
+  metadata.gz: fa30cd55c7fc9e57d5c5c22e73a0b84966e54b6d81039824433c5b2fafb7600f93a91b23bcf2cbb08fbe8cd903d8a0eef93a28c4f7cb11f0c7ab8afde81cf06f
+  data.tar.gz: b8ae178fe4cc8ca40bc514782def578394ca2365e5fee7a806cbbce9c7c71af1048f97beb31e71a64574bc094d50e4dae6ef2afba696ac5c1d9f000caddecb6e

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wetsand.wfs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,42 @@
+# GaleShapley
+
+This gem provide a basic algorithm to solve 'stable marriage problem', finding a stable matching between two equally sized sets of elements given an ordering of preferences for each element.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gale_shapley'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gale_shapley
+
+## Usage
+
+I recommend NOT to use
+
+## 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/mrbigass/gale_shapley. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mrbigass/gale_shapley/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GaleShapley project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mrbigass/gale_shapley/blob/master/CODE_OF_CONDUCT.md).

data/gale_shapley.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/gale_shapley/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gale_shapley"
+  spec.version       = GaleShapley::VERSION
+  spec.authors       = ["Akito Hikasa"]
+  spec.email         = ["wetsand.wfs@gmail.com"]
+
+  spec.summary       = %q{matching algorithm}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/mrbigass/gale_shapley"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/kakubin/gale_shapley/issues",
+    "allowed_push_host" => "https://rubygems.org",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage
+  }
+
+  # 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         = %w(gale_shapley.gemspec) + Dir["*.md", "lib/**/*.rb"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+end

data/lib/gale_shapley/acceptor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Acceptor # :nodoc:
+  attr_accessor :name, :proposer
+
+  def initialize(name, preferences)
+    @name = name
+    @preferences = preferences
+    @proposer = nil
+  end
+
+  def engaged?
+    !!@proposer
+  end
+
+  def engage(proposer)
+    @proposer&.free
+    @proposer = proposer
+    @proposer.engage
+  end
+
+  def more_attractive?(proposer)
+    @preferences.index(proposer.name) < @preferences.index(@proposer.name)
+  end
+end

data/lib/gale_shapley/proposer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Proposer # :nodoc:
+  attr_reader :name
+
+  def initialize(name, preferences)
+    @name = name
+    @preferences = preferences
+    @index = 0
+    @engaged = false
+  end
+
+  def unengaged?
+    !@engaged
+  end
+
+  def engage
+    @engaged = true
+  end
+
+  def current_acceptor_name
+    @preferences[@index]
+  end
+
+  def propose(acceptor)
+    if acceptor.engaged?
+      acceptor.more_attractive?(self) ? acceptor.engage(self) : free
+    else
+      acceptor.engage(self)
+    end
+  end
+
+  def free
+    @index += 1
+    @engaged = false
+  end
+end

data/lib/gale_shapley/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GaleShapley
+  VERSION = '0.2.0'
+end

data/lib/gale_shapley.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'gale_shapley/proposer'
+require 'gale_shapley/acceptor'
+
+class GaleShapley # :nodoc:
+  class UnproperSizeError < StandardError; end
+
+  class << self
+    def resolve(proposers_preferences, acceptors_preferences)
+      init(proposers_preferences, acceptors_preferences)
+      loop_til_stable
+
+      @proposers.map { |proposer| [proposer.name, proposer.current_acceptor_name] }.to_h
+    end
+
+    private
+
+    def init(proposers_preferences, acceptors_preferences)
+      check_resolvablity(proposers_preferences, acceptors_preferences)
+
+      proposers_preferences = proposers_preferences.transform_keys(&:to_s)
+      acceptors_preferences = acceptors_preferences.transform_keys(&:to_s)
+
+      @proposers = proposers_preferences.map do |name, preferences|
+        Proposer.new(name, preferences)
+      end
+      @acceptors = acceptors_preferences.map do |name, preferences|
+        Acceptor.new(name, preferences)
+      end
+    end
+
+    def check_resolvablity(proposers_preferences, acceptors_preferences)
+      size = proposers_preferences.keys.size
+
+      unless acceptors_preferences.keys.size == size &&
+             acceptors_preferences.all? { |_, preference| preference.size == size } &&
+             proposers_preferences.all? { |_, preference| preference.size == size }
+        raise UnproperSizeError, "can't resolve due to preference size"
+      end
+    end
+
+    def loop_til_stable
+      loop do
+        unengageds = @proposers.select(&:unengaged?)
+        break if unengageds.empty?
+
+        unengageds.each do |proposer|
+          name = proposer.current_acceptor_name
+          target = @acceptors.find { |acceptor| acceptor.name == name }
+          proposer.propose(target)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: gale_shapley
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Akito Hikasa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- wetsand.wfs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- README.md
+- gale_shapley.gemspec
+- lib/gale_shapley.rb
+- lib/gale_shapley/acceptor.rb
+- lib/gale_shapley/proposer.rb
+- lib/gale_shapley/version.rb
+homepage: https://github.com/mrbigass/gale_shapley
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/kakubin/gale_shapley/issues
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mrbigass/gale_shapley
+  source_code_uri: https://github.com/mrbigass/gale_shapley
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: matching algorithm
+test_files: []