math24 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6471c0c4c26dce758c64a452f953efa61de09207
-  data.tar.gz: 66c302a541221b82957288e5307dc69cb32f204c
+  metadata.gz: 7f74b8740c44cb687f969796f75da38eb4f8be35
+  data.tar.gz: 00af2b3953d8ba39dbace437aa492e98d06eb5b4
 SHA512:
-  metadata.gz: ac6023283a671d39976afafc69cd542507c55bb7adab00428b6d10f9964188ba13e83aa9655ef5b5e902fe62ba1227be3c510a6967006bbd50ecb4e8b947c50d
-  data.tar.gz: ce45ecf3083ad9beb4a0ccd0d551add26c07b1219373bbfefdb1cd096b8736637ce66cdcad93bb74c03e9018a2f0cc1f473e50558c295948ea5014565b3a1ff0
+  metadata.gz: f0b61333de0fc6abe2a4f0aeb37e7b04460b6d95badf210101c89489ff9695727dcead8ce0e47db3d6fb9481b27644a6b7ee2c005e8d037ef625d2feb943c20e
+  data.tar.gz: 739035936665c88a482592b1180a7659dd3d567bfc32c42aff6d71b4cce51a8f47362e8394154cdee4db45b56b87d589924fc16b437a6ac2e3519040bed0f03f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+math24-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    math24 (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  math24!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Randall Reed, Jr.
+
+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,73 @@
+# Math24
+[![CircleCI](https://circleci.com/gh/randallreedjr/math24/tree/master.svg?style=svg)](https://circleci.com/gh/randallreedjr/math24/tree/master)
+
+Math24 is a gem providing functionality to play the base version of the Math 24
+ game. In the base version of Math 24, a player must combine 4 integers, using
+ addition (+), subtraction (-), multiplication (\*), or division (/) to reach 24.
+ Extensions to the game included fraction, decimals, exponents, and other
+ mathematical functions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'math24', '~>2.0.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install math24
+
+*Note that the `< 2.0.0` version of the gem is deprecated.*
+
+## Usage
+
+As of version `2.0.0`, the interactive CLI version of the game has been removed.
+
+### Generate a Math 24 problem
+
+Generate a Math 24 problem. This method will return an array of four integers,
+guaranteed to be a solvable Math 24 problem.
+
+```
+Math24.generate_problem
+```
+
+### Check a solution
+
+Verify a potential solution for the given problem. The problem should be passed
+as an array of four integers, while the solution should be a string. This
+method will return true if the solution is valid, and false otherwise.
+
+```
+Math24.check(problem, solution)
+```
+
+### Solve a problem
+
+Solve a given Math 24 problem. The problem should be passed as an array of four
+integers. This method will return an expression string containing the same four
+integers from the given problem that, when evaluated, will equal 24.
+
+```
+Math24.solve(problem)
+```
+
+## 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/randallreedjr/math24.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "math24"
+
+# 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/math24/version.rb

@@ -0,0 +1,3 @@
+module Math24
+  VERSION = "2.0.0"
+end

data/lib/math24.rb

@@ -1,35 +1,66 @@
-require 'math24solver'
+require "math24/version"
 
-class Math24
+module Math24
+  OPERATORS = ['+','-','*','/']
+  def self.generate_problem
+    loop do
+      problem = Array.new(4) { rand(1...9) }
+      return problem if solve(problem)
+    end
+  end
 
-  attr_accessor :numbers
-  attr_reader :last_answer
+  def self.solve(problem)
+    raise ArgumentError unless /\A\d{4}\z/.match problem.join
 
-  def initialize
-  end
+    op_permutation = OPERATORS.repeated_permutation(3)
+    # Unique permutations removes duplicates when a number appears multiple
+    # times in the problem
+    num_permutation = problem.permutation(4).to_a.uniq
+
+    num_permutation.each do |numbers|
+      op_permutation.each do |operators|
+        begin
+          forward_result = instance_eval("((#{numbers[0].to_f} #{operators[0]} #{numbers[1]}.to_f) #{operators[1]} #{numbers[2]}.to_f) #{operators[2]} #{numbers[3].to_f}")
+        rescue ZeroDivisionError
+          forward_result = 0
+        end
+
+        begin
+          alternate_result = instance_eval("(#{numbers[0].to_f} #{operators[0]} #{numbers[1].to_f}) #{operators[1]} (#{numbers[2].to_f} #{operators[2]} #{numbers[3].to_f})")
+        rescue ZeroDivisionError
+          alternate_result = 0
+        end
+
+        begin
+          reverse_result = instance_eval("#{numbers[0].to_f} #{operators[0]} (#{numbers[1].to_f} #{operators[1]} (#{numbers[2].to_f} #{operators[2]} #{numbers[3].to_f}))")
+        rescue ZeroDivisionError
+          reverse_result = 0
+        end
 
-  def solution?(solution)
-    if solution.scan(/\A(\(*(\d{1}[()\s]*[*+-\/]+[()\s]*){3}\d{1}\)*)\z/).flatten.first == solution
-      @last_answer = instance_eval(solution)
-      return last_answer == 24
-    else
-      @last_answer = "???"
+        if forward_result == 24
+          if (operators.include?("+") || operators.include?("-")) && (operators.include?("*") || operators.include?("/"))
+            #Might need parentheses for order of operations
+            return "((#{numbers[0]} #{operators[0]} #{numbers[1]}) #{operators[1]} #{numbers[2]}) #{operators[2]} #{numbers[3]}"
+          else
+            return "#{numbers[0]} #{operators[0]} #{numbers[1]} #{operators[1]} #{numbers[2]} #{operators[2]} #{numbers[3]}"
+          end
+        elsif alternate_result == 24
+          return "(#{numbers[0]} #{operators[0]} #{numbers[1]}) #{operators[1]} (#{numbers[2]} #{operators[2]} #{numbers[3]})"
+        elsif reverse_result == 24
+          return "#{numbers[0]} #{operators[0]} (#{numbers[1]} #{operators[1]} (#{numbers[2]} #{operators[2]} #{numbers[3]}))"
+        end
+      end
     end
+
     return false
   end
 
-  def generate_problem()
-    loop do
-      numbers = []
-      4.times do |i|
-        numbers << rand(1..9).to_s
-      end
-      math24 = Math24Solver.new()
-      math24.numbers = numbers
-      if math24.solve() != "No solution found"
-        @numbers = numbers
-        return numbers
-      end
+    def self.check(problem, solution)
+      raise ArgumentError unless /\A\d{4}\z/.match problem.join
+      raise ArgumentError unless solution.is_a? String
+      raise ArgumentError unless /\A(\(*(\d{1}[()\s]*[*+-\/]+[()\s]*){3}\d{1}\)*)\z/.match(solution)
+
+      problem.count {|i| solution.include?(i.to_s) } == 4 &&
+        instance_eval(solution) == 24
     end
-  end
-end
+end

data/math24.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'math24/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "math24"
+  spec.version       = Math24::VERSION
+  spec.authors       = ["Randall Reed, Jr."]
+  spec.email         = ["randallreedjr@gmail.com"]
+
+  spec.summary       = %q{Gem to provide Math 24 game functionality.}
+  spec.description   = %q{Randomly generates a solvable 24 Game problem, verifies user's solution, or finds a solution for a given set of numbers.}
+  spec.homepage      = "http://www.getto24.com"
+  spec.license       = "MIT"
+
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -1,27 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: math24
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Randall Reed, Jr.
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
-dependencies: []
-description: Randomly generates a solvable 24 Game problem, verifies user's solution
-email: randallreedjr@gmail.com
-executables:
-- math24
+date: 2016-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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Randomly generates a solvable 24 Game problem, verifies user's solution,
+  or finds a solution for a given set of numbers.
+email:
+- randallreedjr@gmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/math24
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/math24.rb
-- lib/math24gamecli.rb
-- lib/math24solver.rb
-homepage: http://rubygems.org/gems/math24
+- lib/math24/version.rb
+- math24.gemspec
+homepage: http://www.getto24.com
 licenses:
 - MIT
 metadata: {}
@@ -41,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Command-line Math 24 game
+summary: Gem to provide Math 24 game functionality.
 test_files: []

data/bin/math24

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'math24'
-require_relative '../lib/math24solver.rb'
-require_relative '../lib/math24gamecli.rb'
-
-cli = Math24GameCli.new
-cli.run()

data/lib/math24gamecli.rb

@@ -1,20 +0,0 @@
-require 'math24'
-class Math24GameCli
-  def run()
-    game = Math24.new()
-    problem = game.generate_problem().join(' ')
-
-    loop do
-      puts "Solve: #{problem}"
-      attempt = gets.chomp
-      break if attempt.downcase == "exit"
-
-      if game.solution?(attempt)
-        puts "Correct!\n\n" 
-        problem = game.generate_problem().join(' ')
-      else
-        puts "Try again...\n\n" unless problem.empty?
-      end
-    end
-  end
-end

data/lib/math24solver.rb

@@ -1,68 +0,0 @@
-class Math24Solver
-  attr_accessor :numbers
-  attr_reader :operators
-  attr_accessor :target
-
-  def initialize(operators = ["+", "-", "*", "/"])
-    @operators = operators
-    @target = 24
-  end
-
-  def solve(problem_numbers = [])
-    if problem_numbers.empty?
-      return "Please provide numbers" if @numbers.empty?
-    else
-      @numbers = problem_numbers
-    end
-
-    @numbers.each do |number|
-      if (number.to_i < 1) || (number.to_i > 9) || (number.to_f != number.to_i)
-        return "Please only enter integers between 1 and 9"
-      end
-    end
-    
-    op_permutation = @operators.repeated_permutation(3)
-    num_permutation = @numbers.permutation(4).to_a.uniq
-    
-    num_permutation.each do |numbers|
-      op_permutation.each do |operators|
-        begin
-          forward_result = instance_eval("((#{numbers[0].to_f} #{operators[0]} #{numbers[1]}.to_f) #{operators[1]} #{numbers[2]}.to_f) #{operators[2]} #{numbers[3].to_f}")
-        rescue ZeroDivisionError
-          forward_result = 0
-        end
-        begin
-          alternate_result = instance_eval("(#{numbers[0].to_f} #{operators[0]} #{numbers[1].to_f}) #{operators[1]} (#{numbers[2].to_f} #{operators[2]} #{numbers[3].to_f})")
-        rescue ZeroDivisionError
-          alternate_result = 0
-        end
-
-        begin
-          reverse_result = instance_eval("#{numbers[0].to_f} #{operators[0]} (#{numbers[1].to_f} #{operators[1]} (#{numbers[2].to_f} #{operators[2]} #{numbers[3].to_f}))")
-        rescue ZeroDivisionError
-          reverse_result = 0
-        end
-
-        if forward_result == @target
-          if (operators.include?("+") || operators.include?("-")) && (operators.include?("*") || operators.include?("/"))
-            #Might need parentheses for order of operations
-            return "((#{numbers[0]} #{operators[0]} #{numbers[1]}) #{operators[1]} #{numbers[2]}) #{operators[2]} #{numbers[3]} = 24"
-          else
-            return "#{numbers[0]} #{operators[0]} #{numbers[1]} #{operators[1]} #{numbers[2]} #{operators[2]} #{numbers[3]} = 24"
-          end
-        elsif alternate_result == @target
-          return "(#{numbers[0]} #{operators[0]} #{numbers[1]}) #{operators[1]} (#{numbers[2]} #{operators[2]} #{numbers[3]}) = 24"
-        elsif reverse_result == @target
-          return "#{numbers[0]} #{operators[0]} (#{numbers[1]} #{operators[1]} (#{numbers[2]} #{operators[2]} #{numbers[3]})) = 24"
-        end
-      end
-    end
-    return "No solution found"
-  end
-end
-
-
-
-
-
-