module Euler

config() { |config_options| ... } click to toggle source

Yields config_options to a block. Used to configure the Euler module.

# File lib/euler.rb, line 39
def config
  yield @@config_options
end

euler_file_path() click to toggle source

# File lib/euler.rb, line 102
def euler_file_path
  "#{root}/Eulerfile.rb"
end

get_language(language_name) click to toggle source

Returns an instance of a registered language class.

@throws Euler::LanguageNotRegisteredError if the language asked for has not already been registered.

# File lib/euler.rb, line 66
def get_language language_name
  language_string = language_name.to_s
  if @@languages[language_string].nil?
    raise Euler::LanguageNotRegisteredError.new "#{language_string} has not been registered."
  else
    @@languages[language_string].new
  end
end

method_missing(method, *args, &block) click to toggle source

Returns configuration options. If the configuration option is a Proc then this method will call it with the arguments passed to this method and return the result.

# File lib/euler.rb, line 78
def method_missing method, *args, &block
  temp = @@config_options.send method
  if temp.is_a?(Proc)
    temp.call *args
  else
    temp
  end
end

params_from_dir_or_args(args) click to toggle source

Returns an array with the first element being the problem id and the second element being the language gotten from either the args passed in or by parsing the directory the command was ran from

# File lib/euler.rb, line 109
def params_from_dir_or_args args
  from_dir = parse_params_from_directory
  [
    args.shift || from_dir.shift,
    args.shift || from_dir.shift
  ]
end

parse_params_from_directory(dir = ENV['PWD']) click to toggle source

Uses the directory_parse_strategy to attempt to parse the problem id and language of the solution's directory the command was ran from.

# File lib/euler.rb, line 119
def parse_params_from_directory dir = ENV['PWD']
  self.directory_parse_strategy(dir)
end

register_language(language_name, language = nil) click to toggle source

Register a language by calling this method with the languages name and the class for that language. To unregister a language call this method without a second argument.

Language classes require a run method which accepts an Euler::Solution and returns the result of running the solution. Optionally language classes can also have an init method which also accepts a solution. The init method does any extra steps required in initializing an empty solution.

# File lib/euler.rb, line 52
def register_language language_name, language = nil
  language_string = language_name.to_s
  @@languages[language_string.to_s] = language
end

root() click to toggle source

Returns the root directory of the current project.

# File lib/euler.rb, line 88
def root
  if @root.nil?
    root = ENV['PWD']
    until File.exists?("#{root}/Eulerfile.rb") || File.expand_path(root) == '/' do
      root = File.dirname(root)
    end
    if not File.exists?("#{root}/Eulerfile.rb")
      raise Euler::EulerFileNotFoundError.new "Unable to find an Eulerfile.rb in any of the parent directories."
    end
    @root = root
  end
  @root
end

unregister_language(language_name) click to toggle source

Unregisters a language

# File lib/euler.rb, line 58
def unregister_language language_name
  register_language(language_name)
end

Constants

Public Class Methods