equation_system 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b01551b37db2aaf2b29ccb33ed8b056d800a6119
+  data.tar.gz: 5e25df4ba443e5bb39bb0f5ff60958bd33fdd893
+SHA512:
+  metadata.gz: 85c9843699b8a08e54b3e37eb9a4979405c3ab2b2dc2aa1c32999668ffdfa72343b42e34732c117567c7ab99ee9cc73efa718f69be4f350f29c3711540f9e392
+  data.tar.gz: d60d47944d1c957499981acd78901691ae37bd0bf62a8aada69102616cb6ff892025b064e5c42fda49754bcdb18a6adeb6168e33897559e194fce84c6cb57e29

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Winston Durand
+
+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,62 @@
+# EquationSystem
+
+This gem will generate a system of equations up to an arbitrary size.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'equation_system'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install equation_system
+
+## Usage
+
+For ruby usage:
+``` ruby
+var_count = 3 # number of variables for the system of equations (required)
+
+equation_system = EquationSystem.new(var_count, range: -10..10, allow_zero: false, failsafe: 10)
+# => #<EquationSystem::System:0x007faa498...>
+
+# Get the equations
+equation_system.equations
+# => ["5x + 2y + 2z = -24", "-5x - 7y - 5z = -8", "-7x - 5y - 2z = 28"]
+
+# Get the answers
+equation_system.answers
+# => {:x=>-8, :y=>4, :z=>4}
+
+# Use to get any one variable value
+equation_system.solution_for_x
+# => -8
+```
+
+This gem also adds the commandline tool `equation_system`.
+It can return the output in the json format.
+``` json
+{"equations":["7x - 8y - 5z = -21","-9x - 10y - 10z = -202","6x - 8y + 4z = 52"],"variables":{"x":8,"y":4,"z":9}}
+```
+
+Call with `-h` or `--help` for the help menu
+```
+Usage: equation_system.rb [options]
+    -v, --variables COUNT            Number of variables for the system of equations (required)
+    -r, --range RANGE                Range of function given a whole number
+    -j, --json                       Output in JSON
+    -h, --help                       Shows this help message
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/R167/equation_system/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/equation_system

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'equation_system'
+
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: equation_system [options]"
+
+  opts.on("-v", "--variables COUNT", Integer, "Number of variables for the system of equations (required)") do |vars|
+    options[:variables] = vars
+  end
+  
+  opts.on("-r", "--range RANGE", Integer, "Range of function given a whole number") do |range|
+    options[:range] = range
+  end
+  
+  opts.on("-j", "--json", "Output in JSON") do
+    options[:json] = true
+  end
+  
+  opts.on("-h", "--help", "Shows this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+unless options[:variables].is_a?(Integer)
+  puts "Missing number of variables for equation"
+  puts "Call with -h or --help for help"
+  exit(1)
+end
+
+options[:range] ||= Math.log(options[:variables], 1.12).ceil+1
+range = options[:range].abs
+
+equation_system = EquationSystem::System.new(options[:variables], range: (-range..range))
+
+if options[:json]
+  require 'json'
+  puts equation_system.to_json
+else
+  puts equation_system.equations
+  puts
+  equation_system.answers.each do |var, val|
+    puts "%#{Math.log(options[:variables], 26).ceil}s => %+03d" % [var, val]
+  end
+end

data/equation_system.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'equation_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "equation_system"
+  spec.version       = EquationSystem::VERSION
+  spec.authors       = ["Winston Durand"]
+  spec.email         = ["me@winstondurand.com"]
+  spec.summary       = %q{Generates a system of equations.}
+  spec.description   = %q{Generates a system of equations made solely of integer values.}
+  spec.homepage      = ""
+  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.required_ruby_version = '>= 2.0.0'
+  
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/lib/equation_system/exceptions.rb

@@ -0,0 +1,9 @@
+module EquationSystem  
+  class Error < StandardError; end
+  
+  class TooFewVariablesError < Error; end
+  
+  class RangeTooSmallError < Error; end
+  
+  class FailSafeError < Error; end
+end

data/lib/equation_system/system.rb

@@ -0,0 +1,88 @@
+module EquationSystem
+  class System 
+    def initialize(variables, range: -10..10, allow_zero: false, failsafe: 10)
+      raise FailSafeError, "Failsafe cannot be less than 1" if failsafe < 1
+      @prng = Random.new
+      @answers = generate_answers(variables, range, allow_zero)
+      @equations = generate_equations(@answers, range, allow_zero, failsafe)
+    end
+  
+    def equations
+      @equations
+    end
+  
+    def answers
+      @answers
+    end
+  
+    def method_missing(method, *args, &block)
+      match = method.to_s.match(/^solution_for_([a-z]+)$/)
+      if match && @answers[match[1].to_sym]
+        @answers[match[1].to_sym]
+      else
+        super
+      end
+    end
+    
+    def to_json
+      require 'json' unless defined?(JSON)
+      {:equations => @equations, :variables => @answers}.to_json
+    end
+  
+    private
+  
+    def generate_equations(answers, range, allow_zero, failsafe)
+      equations = []
+      answers.length.times do
+        failsafe.times do |fails|
+          equation = ""
+          total = 0
+          answers.each do |var, val|
+            coeffecient = random_num(range, allow_zero)
+            total += coeffecient * val
+            equation << " %+#{val.is_a?(Float) ? 'f' : 'd' }%s" % [coeffecient, var]
+          end
+          equation = equation.gsub(/(\+|-)/, '\1 ').gsub(/1([a-z])/, '\1').gsub(/^ (-)?\+? /, '\1')
+          equation << " = #{total}"
+          if equations.include?(equation)
+            raise RangeTooSmallError, "Unable to get unique equation after #{failsafe} tries" unless fails == failsafe - 1
+          else
+            equations << equation
+            break
+          end
+        end 
+      end
+      equations
+    end
+  
+    def generate_answers(variables, range, allow_zero)
+      ret = {}
+      vars = []
+      if variables <= 3 && variables > 0
+        vars = %w(x y z)[0, variables]
+      elsif variables > 3
+        cur = 'a'
+        variables.times do
+          vars << cur.dup
+          cur.next!
+        end
+      else
+        raise TooFewVariablesError, "Too few variables, '#{variables}' is not a valid number"
+      end
+
+      vars.each do |var|
+        ret[var.to_sym] = random_num(range, allow_zero)
+      end
+    
+      ret
+    end
+  
+    def random_num(range, allow_zero)
+      r = 0
+      begin
+        r = @prng.rand(range)
+      end until r != 0 || allow_zero
+      r
+    end
+  end
+end

data/lib/equation_system/version.rb

@@ -0,0 +1,3 @@
+module EquationSystem
+  VERSION = "1.0.0"
+end

data/lib/equation_system.rb

@@ -0,0 +1,9 @@
+require_relative "equation_system/version"
+require_relative "equation_system/system"
+require_relative "equation_system/exceptions"
+
+module EquationSystem
+  def self.new(*args)
+    EquationSystem::System.new(*args)
+  end
+end

data/spec/equation_system_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe EquationSystem do
+  it 'should have a version number' do
+    EquationSystem::VERSION.should_not be_nil
+  end
+  
+  it 'should respond to #new' do
+    EquationSystem.new(1).should be_a(EquationSystem::System)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'equation_system'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]  # default, enables both `should` and `expect`
+  end
+end

data/spec/system_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'json'
+
+describe EquationSystem::System do
+  describe "known scenario" do
+    let(:equation_system){ EquationSystem::System.new(1, range: 1..1) }
+  
+    it "should generate valid json" do
+      JSON.parse(equation_system.to_json).should == {"equations"=>["x = 1"], "variables"=>{"x"=>1}}
+    end
+  
+    it "should have answers" do
+      equation_system.answers.should be_truthy
+    end
+  
+    it "should have equations" do
+      equation_system.equations.should be_truthy
+    end
+  
+    it "should respond to solution_for" do
+      equation_system.solution_for_x.should be_truthy
+    end
+  end
+  
+  describe "errors" do
+    it "should raise an error when too small of range" do
+      expect { EquationSystem::System.new(10, range: 1..1) }.to raise_error EquationSystem::RangeTooSmallError
+    end
+    
+    it "should raise an error when too few variables" do
+      expect { EquationSystem::System.new(0) }.to raise_error EquationSystem::TooFewVariablesError
+    end
+    
+    it "should raise an error when the failsafe is too small" do
+      expect { EquationSystem::System.new(3, failsafe: 0) }.to raise_error EquationSystem::FailSafeError
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: equation_system
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Winston Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Generates a system of equations made solely of integer values.
+email:
+- me@winstondurand.com
+executables:
+- equation_system
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/equation_system
+- equation_system.gemspec
+- lib/equation_system.rb
+- lib/equation_system/exceptions.rb
+- lib/equation_system/system.rb
+- lib/equation_system/version.rb
+- spec/equation_system_spec.rb
+- spec/spec_helper.rb
+- spec/system_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Generates a system of equations.
+test_files:
+- spec/equation_system_spec.rb
+- spec/spec_helper.rb
+- spec/system_spec.rb