Rubeuler 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
 0.0.1 - Initial release, allows you to initialize an instance of Rubeuler::Problem with required options `:number` (int) and `:answer` (string of ruby code). Answer is evaluated and compared to answer predefined in Rubeuler::Problem#solutions method.   Result is returned indicating success/failure and the time elapsed when running the code in `:answer`
+
 0.0.2 - Fixed Rakefile (gave myself the ability to use `rake release`); Updated description in gemspec
+
 0.0.3 - Moved Rubeuler::Problem#solutions to Rubeuler::Solution#for_problem to make the intended use more intuitive
+
+0.0.4 - Add tests using minitest
+
+0.0.5 - Feature: Track other variables... the options `tracked: {foo: @foo}` would track a variable set as `@foo` in Rubeuler::Problem's `:answer` argument
+				Improve on tests, improve timer by moving Benchmark closer to code being evaluated,
+        

data/README.md

@@ -1,4 +1,4 @@
-Rubeuler
+Rubeuler (sounds like rube-oiler)
 ========
 
 For Rubyists who enjoy solving and optimizing [Project Euler](http://www.projecteuler.net) problems. It uses `Benchmark` so be sure to use this with Ruby >= 1.9.3

data/lib/rubeuler/base.rb

@@ -6,6 +6,8 @@ module Rubeuler
 
     def load_options(*option_names, options)
       option_names.each{|o| load_option(o, options) }
+
+      option_names << instance_variable_set("@tracked", options[:tracked]) if options[:tracked]
     end
   end
 end

data/lib/rubeuler/problem.rb

@@ -7,22 +7,33 @@ module Rubeuler
     def initialize(options)
       load_options(:number, :answer, options)
       raise TypeError, ':answer should be a string' unless @answer.is_a?(String)
+      raise TypeError, ':number should be an integer' unless @number.is_a?(Fixnum)
     end
 
     def execute!
-      time = Benchmark.measure { @data = answer }.real
+      time = timed_answer
       true_or_false = @data == solution ? true : false
 
-      return Rubeuler::Result.new(success: true_or_false, problem: @number, data: @data, runtime: time)
+      return Rubeuler::Result.new(success: true_or_false, problem: @number, data: data, runtime: time)
     end
 
     private
-    def answer
-      instance_eval(@answer.gsub("\n",";"))
+    def timed_answer
+      timer_endpoints = ["Benchmark.measure { @data =", "}.real"]
+      instance_eval(timer_endpoints.join(@answer.gsub("\n",";")))
     end
 
     def solution
       Rubeuler::Solution.for_problem(@number)
     end
+
+    def data
+      result_data = {
+        solution: @data
+      }
+      @tracked.each { |k,v| result_data.merge!({ k => instance_eval(v.to_s) }) } if @tracked
+
+      result_data
+    end
   end
 end

data/lib/rubeuler/result.rb

@@ -5,5 +5,17 @@ module Rubeuler
       @data = options[:data]
       @runtime = options[:runtime]
     end
+
+    def data
+      @data
+    end
+
+    def runtime
+      @runtime
+    end
+
+    def successful?
+      !!@success
+    end
   end
 end

data/lib/rubeuler/solution.rb

@@ -9,7 +9,7 @@ module Rubeuler
         "5" => 0,
         "6" => 0,
         "7" => 0
-      }[number.to_s]
+      }.fetch(number.to_s) { raise RuntimeError.new("Undefined solution for problem: #{number.to_s}") }
     end
   end
 end

data/lib/rubeuler/version.rb

@@ -1,3 +1,3 @@
 module Rubeuler
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/rubeuler/problem_test.rb

@@ -1,8 +1,7 @@
 require "minitest_helper"
-require "rubeuler"
 
 describe Rubeuler::Problem do
-  describe ".sexecute!" do
+  describe ".execute!" do
     it "returns a result" do
       Rubeuler::Problem.new(number: 1, answer: "0").execute!.must_be_kind_of(Rubeuler::Result)
     end
@@ -25,10 +24,29 @@ describe Rubeuler::Problem do
 
     it "complains if :answer is not a string" do
       begin
-      Rubeuler::Problem.new(number: 1, answer: 0)
+        Rubeuler::Problem.new(number: 1, answer: 0)
       rescue => e
-        e.must_be_kind_of(TypeError)
+        error = e
       end
+      error.must_be_kind_of(TypeError)
+    end
+
+    it "complains if :number is not an integer" do
+      begin
+        Rubeuler::Problem.new(number: :the_letter_a, answer: "0")
+      rescue => e
+        error = e
+      end
+      error.must_be_kind_of(TypeError)
+    end
+  end
+
+  describe "#data" do
+    it "can track extra instance_variables" do
+      res = Rubeuler::Problem.new(number: 1, answer: "@foo, @baz = :bar, :bang; 111*0", tracked: {foo: "@foo", baz: "@bang"}).execute!
+      res.must_be_kind_of(Rubeuler::Result)
+      res.data.keys.include?(:foo).must_equal(true)
+      res.data.keys.include?(:baz).must_equal(true)
     end
   end
 end

data/test/rubeuler/solution_test.rb

@@ -0,0 +1,18 @@
+require "minitest_helper"
+
+describe Rubeuler::Problem do
+  describe ".execute!" do
+    it "returns a solution if predefined" do
+      Rubeuler::Solution.for_problem(1).must_be_kind_of(Numeric)
+    end
+
+    it "produces an error if key for the problem specified is not defined" do
+      begin
+        @problem = Rubeuler::Solution.for_problem(:orange)
+      rescue => e
+        e.must_be_kind_of(RuntimeError)
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Rubeuler
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -79,6 +79,7 @@ files:
 - rubeuler.gemspec
 - test/minitest_helper.rb
 - test/rubeuler/problem_test.rb
+- test/rubeuler/solution_test.rb
 homepage: http://github.com/rthbound/rubeuler
 licenses: []
 post_install_message: 
@@ -107,3 +108,4 @@ summary: Evaluates whether a block produces a predefined response. Returns diagn
 test_files:
 - test/minitest_helper.rb
 - test/rubeuler/problem_test.rb
+- test/rubeuler/solution_test.rb