drawy 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8b0b6bd2c7117dfeae351bc9c26f2925f10cddc
+  data.tar.gz: dea46241155f3594e67a864e0ba5352a23f231f2
+SHA512:
+  metadata.gz: 79ee0b06b46993b85b4532830c2b791ad5e56d8e96d727e90a3b28d3074ad98fdebdc064ac56f570bf6f5f69df5eb0048d741ffe070019b25651b777570b41b6
+  data.tar.gz: be679cb029c8ff2201c6d6333f4075dd94328b30ccf394f17064963723cdf0c1e50c76e91bcb0b01e7964cd3cf2039232de7ad75bb6af950d08f138c5d6045d0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.1.3@drawy --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neil Rosenstech
+
+MIT License
+
+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,43 @@
+# Drawy
+
+Just a CLI application written in Ruby
+
+## Installation
+
+Just execute:
+
+    $ gem install drawy
+
+## Usage
+
+Require the gem:
+
+```ruby
+require 'drawy'
+```
+
+And run Drawy:
+
+```ruby
+Drawy.run
+```
+
+## Running the tests
+
+Just clone this repo and execute:
+
+    $ rake test
+
+## Alternative installation/usage
+
+Clone the repo and execute:
+
+    $ bundle
+
+Make drawy executable:
+
+    $ chmod a+x bin/drawy.rb
+
+Then run it:
+
+    $ ruby -Ilib ./bin/drawy

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+

data/bin/drawy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'drawy'
+
+Drawy.run

data/drawy.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drawy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "drawy"
+  spec.version       = Drawy::VERSION
+  spec.authors       = ["Neil Rosenstech"]
+  spec.email         = ["tohellandback@hotmail.fr"]
+  spec.summary       = %q{Drawy makes it easy to setup a "drawing lot" for christmas or any particular occasion}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/Raindal/drawy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4.3"
+end

data/lib/drawy/application.rb

@@ -0,0 +1,68 @@
+module Drawy
+  class Application
+
+    # To expand the application, just add an entry in the menu
+    # and write the corresponding method
+    # The entry is of form ['Text to display', :method_to_route_to]
+
+    MENU = [
+      ['Register someone for the drawing', :register],
+      ['Proceed to drawing', :draw],
+      ['Check someone\'s result', :check],
+      ['Exit', :exit]
+    ]
+
+    class << self
+      def start
+        @menu_numbers = *(1..MENU.size)
+        route_for(menu)
+        start
+      end
+
+      def menu
+        Drawy::IO.show 'What would you like to do?'
+        MENU.each_with_index { |a, i| Drawy::IO.show "#{i+1}. #{a.first}" }
+        Drawy::IO.accept :integer, "Enter the number corresponding to the action you want to perform: #{@menu_numbers}"
+      end
+
+      def route_for(number = nil)
+        return send(MENU[number-1][1]) if @menu_numbers.include?(number)
+        raise Drawy::InputError, "Please choose a number in #{@menu_numbers}"
+      end
+
+      def register
+        name         = Drawy::IO.accept :string, 'Enter the name of the person you want to register:'
+        partner_name = Drawy::IO.accept :string, 'Enter the name of his/her partner (leave blank if the person is single):'
+        Drawy::Validator.validate_uniqueness_of(name, partner_name)
+        Drawy::Engine.add_people [name, partner_name]
+      end
+
+      def draw
+        Drawy::Validator.validate_people_format
+        Drawy::IO.show 'Drawing...'
+        Drawy::Engine.draw
+        Drawy::IO.show 'Done! You can now check everyone\'s result.'
+      end
+
+      def check
+        if Drawy::Engine.result.nil?
+          raise Drawy::InputError, 'You must proceed to drawing before checking someone'
+        end
+
+        name = Drawy::IO.accept :string, 'Enter the name of the person you want to check:'
+
+        if name.empty?
+          raise Drawy::InputError, 'Entered name is empty... ignoring.'
+        end
+
+        result = Drawy::Engine.result[name.downcase]
+        Drawy::IO.show "#{name.capitalize} should buy #{result.capitalize} a gift."
+      end
+
+      def exit
+        Drawy::IO.show 'See you soon'
+        Kernel.exit
+      end
+    end
+  end
+end

data/lib/drawy/engine.rb

@@ -0,0 +1,72 @@
+module Drawy
+  class Engine
+    class << self
+      attr_accessor :people, :result, :couples
+
+      def add_people(names)
+        self.people  ||= []
+        self.couples ||= {}
+
+        names.delete_if(&:empty?)
+        names.map!(&:downcase)
+
+        couples[names.first] = names.last if names.size == 2
+        self.people += names
+      end
+
+      def draw(options = {})
+        # shuffle: false option is used for testing purposes
+        people.shuffle! unless options[:shuffle] == false
+        list = build_list
+
+        # Here build_list returns a list like so: %w(john dan anna camille)
+        # Now we want to have direct access to a person's associated person so that
+        # looking up the result for "john" returns "dan" without having to go through the array for every requested name
+        # Therefore we need result to be { 'john' => 'dan', 'dan' => 'anna', 'anna' => 'camille', 'camille' => 'john' }
+        self.result = Hash[list.zip(list.rotate)]
+      end
+
+      # This probably deserves a bit of insight on what's going on
+      # Basically we just build a list from people names keeping the order (note that people array has been shuffled)
+      # If we encounter a person following its partner we just take the next person first and add the partner after
+      #
+      # Example:
+      # We have %w(john anna dan camille henrik) in names and we have { 'john' => 'anna' } in couples
+      # Step 1: remove john and put him in the list => list = %w(john)
+      # Step 2: remove anna, she's in couple with john so remove dan and put him in the list => list = %w(john dan)
+      # Step 3: now anna is not in couple with dan so add her to the list => list = %w(john dan anna)
+      # Step 4: remove camille and put her in the list => list = %w(john dan anna camille)
+      # Step 5: remove henrik and put him in the list => list = %w(john dan anna camille henrik)
+      # An extra step is sometimes needed if the last person is in couple with the previous one because
+      # there's nobody left to add in between the two so we just arbitrarily put him at position 1
+      #
+      # The complexity is O(n), n representing the number of people
+
+      def build_list
+        list = []
+        names = people.dup
+
+        while names.any?
+          if is_couple?(list[-1], names[0])
+            aside = names.shift
+            break if names.empty?
+            list << names.shift
+            list << aside
+            aside = nil
+          else
+            list << names.shift
+          end
+        end
+
+        list.insert(1, aside) if aside
+
+        list
+      end
+
+      def is_couple?(x, y)
+        return false if [x, y].include?(nil)
+        couples[x] == y || couples[y] == x
+      end
+    end
+  end
+end

data/lib/drawy/error.rb

@@ -0,0 +1,5 @@
+module Drawy
+  class Error < StandardError; end
+  class InputError < Error; end
+  class ValidationError < Error; end
+end

data/lib/drawy/io.rb

@@ -0,0 +1,15 @@
+module Drawy
+  class IO
+    class << self
+      def show(string)
+        puts "\n#{string}"
+      end
+
+      def accept(type, string)
+        print "\n#{string} "
+        return $stdin.gets.to_i if type == :integer
+        $stdin.gets.chomp
+      end
+    end
+  end
+end

data/lib/drawy/validator.rb

@@ -0,0 +1,29 @@
+module Drawy
+  class Validator
+    class << self
+      def validate_uniqueness_of(*args)
+        return if Drawy::Engine.people.nil?
+        faulty_names = Drawy::Engine.people & args
+        return if faulty_names.empty?
+        raise Drawy::ValidationError, "The following name(s) already exist(s): #{faulty_names}"
+      end
+
+      def validate_people_format
+        people = Drawy::Engine.people
+        if people.nil? || people.empty? || people.size < 2
+          raise Drawy::ValidationError, 'You must register at least 2 people or couples before drawing'
+        # A couple plus one person creates a triangle making the distribution impossible given the rules
+        # We either end up with one person in couple buying a gift for its partner or the 3rd
+        # person receiving 2 gifts and someone receiving none
+        elsif couple_plus_one?(people, Drawy::Engine.couples)
+          raise Drawy::ValidationError, 'The current pool only contains a couple and one person, please add more people'
+        end
+      end
+
+      def couple_plus_one?(people, couples)
+        return true if people.size == 3 && couples.keys.size == 1
+        false
+      end
+    end
+  end
+end

data/lib/drawy/version.rb

@@ -0,0 +1,3 @@
+module Drawy
+  VERSION = "0.0.2"
+end

data/lib/drawy.rb

@@ -0,0 +1,23 @@
+require 'optparse'
+require 'drawy/version'
+require 'drawy/application'
+
+module Drawy
+  autoload :Engine,          'drawy/engine'
+  autoload :IO,              'drawy/io'
+  autoload :Validator,       'drawy/validator'
+  autoload :Error,           'drawy/error'
+  autoload :InputError,      'drawy/error'
+  autoload :ValidationError, 'drawy/error'
+
+  class << self
+    def run
+      Drawy::Application.start
+    rescue Drawy::Error => e
+      $stderr.puts "#------------ #{e.message} ------------#"
+      run
+    rescue StandardError => e
+      abort "#{e.backtrace.join("\n")}\n\n#{e.class} - #{e.message}\n\nSomething went wrong."
+    end
+  end
+end

data/test/test_engine.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+
+class TestEngine < Minitest::Test
+  def setup
+    Drawy::Engine.people  = nil
+    Drawy::Engine.couples = nil
+    Drawy::Engine.result  = nil
+  end
+
+  def test_add_people
+    x, y, z = ['john', 'anna'], ['dan'], ['camille']
+
+    Drawy::Engine.add_people(x)
+    Drawy::Engine.add_people(y)
+    Drawy::Engine.add_people(z)
+
+    assert_equal x + y + z, Drawy::Engine.people
+  end
+
+  def test_add_people_builds_couples
+    x, y = ['john', 'anna'], ['dan', 'camille']
+
+    Drawy::Engine.add_people(x)
+    Drawy::Engine.add_people(y)
+
+    # Couples should be of form { 'john' => 'anna', 'dan' => 'camille' }
+    assert_equal 'anna',    Drawy::Engine.couples['john']
+    assert_equal 'camille', Drawy::Engine.couples['dan']
+  end
+
+  def test_add_people_downcases_names
+    x = ['John']
+
+    Drawy::Engine.add_people(x)
+
+    assert_equal 'john', Drawy::Engine.people.first
+  end
+
+  def test_add_people_deletes_empty_names
+    x = ['john', '']
+
+    Drawy::Engine.add_people(x)
+
+    assert_equal ['john'], Drawy::Engine.people
+  end
+
+  def test_draw
+    Drawy::Engine.people  = %w(john anna dan camille)
+    Drawy::Engine.couples = { 'john' => 'anna' }
+
+    Drawy::Engine.draw(shuffle: false)
+
+    assert_equal({ 'john' => 'dan', 'dan' => 'anna', 'anna' => 'camille', 'camille' => 'john' }, Drawy::Engine.result)
+  end
+
+  def test_build_list
+    scenarii.each do |people, couples, expectation|
+      Drawy::Engine.people  = people
+      Drawy::Engine.couples = couples
+
+      # Go to build_list method definition for a more detailed explanation
+      # of where those expectations are coming from
+      assert_equal expectation, Drawy::Engine.build_list
+    end
+  end
+
+  def test_is_couple?
+    Drawy::Engine.couples = { 'john' => 'anna' }
+
+    assert_equal true,  Drawy::Engine.is_couple?('john', 'anna')
+    assert_equal true,  Drawy::Engine.is_couple?('anna', 'john')
+    assert_equal false, Drawy::Engine.is_couple?('dan', 'camille')
+    assert_equal false, Drawy::Engine.is_couple?('john', nil)
+  end
+
+  private
+
+  # Different scenarii to test edge cases
+  # Each case is of form [people, couples, expectation]
+
+  def scenarii
+    [
+      # couple at the beginning
+      [%w(john anna dan camille), { 'john' => 'anna' }, %w(john dan anna camille)],
+      # couple at the end
+      [%w(john anna dan camille), { 'dan' => 'camille' }, %w(john camille anna dan)],
+      # 2 couples only
+      [%w(john anna dan camille), { 'john' => 'anna', 'dan' => 'camille' }, %w(john dan anna camille)],
+      # 3 couples only
+      [%w(john anna dan camille henrik luna), { 'john' => 'anna', 'dan' => 'camille', 'henrik' => 'luna' }, %w(john luna dan anna camille henrik)],
+      # no couple
+      [%w(john anna dan camille henrik luna), {}, %w(john anna dan camille henrik luna)]
+    ]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+require 'drawy'

data/test/test_validator.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class TestValidator < Minitest::Test
+  def setup
+    Drawy::Engine.people = nil
+  end
+
+  def test_validate_uniqueness_of_unique_names
+    assert_nil Drawy::Validator.validate_uniqueness_of
+    assert_nil Drawy::Validator.validate_uniqueness_of('john', 'anna')
+
+    Drawy::Engine.people = %w(dan camille henrik)
+
+    assert_nil Drawy::Validator.validate_uniqueness_of('john', 'anna')
+  end
+
+  def test_validate_uniqueness_of_used_names
+    Drawy::Engine.people = ['john']
+
+    assert_raises Drawy::ValidationError do
+      Drawy::Validator.validate_uniqueness_of('john', 'anna')
+    end
+  end
+
+  def test_validate_people_format
+    [nil, [], ['john']].each do |people_value|
+      Drawy::Engine.people = people_value
+
+      assert_raises Drawy::ValidationError do
+        Drawy::Validator.validate_people_format
+      end
+    end
+
+    Drawy::Engine.people  = %w(john anna dan)
+    Drawy::Engine.couples = { 'john' => 'anna' }
+
+    assert_raises Drawy::ValidationError do
+      Drawy::Validator.validate_people_format
+    end
+  end
+
+  def test_couple_plus_one?
+    people  = %w(john anna dan)
+    couples = { 'john' => 'anna' }
+
+    assert_equal true, Drawy::Validator.couple_plus_one?(people, couples)
+
+    people  = %w(john anna dan camille)
+    couples = { 'john' => 'anna' }
+
+    assert_equal false, Drawy::Validator.couple_plus_one?(people, couples)
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: drawy
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Neil Rosenstech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+description: Drawy makes it easy to setup a "drawing lot" for christmas or any particular
+  occasion
+email:
+- tohellandback@hotmail.fr
+executables:
+- drawy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rvmrc"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/drawy
+- drawy-0.0.1.gem
+- drawy.gemspec
+- lib/drawy.rb
+- lib/drawy/application.rb
+- lib/drawy/engine.rb
+- lib/drawy/error.rb
+- lib/drawy/io.rb
+- lib/drawy/validator.rb
+- lib/drawy/version.rb
+- test/test_engine.rb
+- test/test_helper.rb
+- test/test_validator.rb
+homepage: https://github.com/Raindal/drawy
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Drawy makes it easy to setup a "drawing lot" for christmas or any particular
+  occasion
+test_files:
+- test/test_engine.rb
+- test/test_helper.rb
+- test/test_validator.rb