euler-manager 0.0.1

data/example/2/python/2.py

@@ -0,0 +1,5 @@
+import euler
+
+answer = 0
+
+print(answer)

data/example/Eulerfile.rb

@@ -0,0 +1,87 @@
+# The Eulerfile.rb has user specific configuration.
+#
+# The location of the answers file and problems directory are both configurable.
+# Additionally the strategy used to assign solutions directories, to create
+# those directories, and to parse the directory the the +euler+ command is being
+# ran from are all also configurable.  See below for an example configuration.
+
+Euler.config do |config|
+
+  data_dir = "#{File.dirname(__FILE__)}/../data"
+
+  config.answers_file "#{data_dir}/answers.yml"
+  config.problems_dir "#{data_dir}/problems"
+
+  # The +directory_strategy+ is a Proc which returns the directory assigned to a
+  # a given solution.
+  config.directory_strategy lambda { |solution|
+    "#{Euler.root}/#{solution.problem_id}/#{solution.language}"
+  }
+
+  # The +create_directory_strategy+ is a Proc which is ran to create directories
+  # for solutions and anything else that is required to initialize a solution.
+  # By default a +README.md+ file is created at the root of the problem with the
+  # problem's name and description.
+  config.create_directory_strategy lambda { |solution|
+    problem = solution.problem
+    dir     = solution.dir
+
+    FileUtils.mkdir_p(dir)
+    readme_path = "#{dir}/../README.md"
+    if not File.exists?(readme_path) then File.open(readme_path, 'w') do |f|
+      f.write("# [#{problem.name}](#{problem.url})\n\n#{problem.content}")
+    end end
+  }
+
+  # Attempts to parse a directory for the +problem_id+ and +language+.  Returns
+  # a an array where the first element is the problem id and the second element
+  # is the language.
+  config.directory_parse_strategy lambda { |dir|
+    problem_id = (Regexp.new("#{Euler.root}/(\\d+)").match(dir)     || [])[1]
+    language   = (Regexp.new("#{Euler.root}/\\d+/(.+)").match(dir)  || [])[1]
+
+    [problem_id, language]
+  }
+
+  # Returns every solution done so far.
+  config.all_solutions_strategy lambda {
+    Dir["#{Euler.root}/*"].select { |f|
+      File.directory?(f) and /\/\d+$/ === f
+    }.map { |problem_dir|
+      Dir["#{problem_dir}/*"].map { |solution_dir|
+        if File.directory?(solution_dir)
+          args = Euler.parse_params_from_directory(solution_dir)
+          Euler::Solution.new(*args)
+        else
+          nil
+        end
+      }
+    }.flatten.compact
+  }
+
+end
+
+# It can also register or language classes which are used to initialize and run
+# problems.
+
+Euler.register_language('python', Class.new do
+
+  # The run method must return the result of running the solution.
+  def run solution
+    `python #{solution.dir}/#{solution.problem_id}.py`
+  end
+
+  # The init method is used to do any extra initialization for a solution.  This
+  # method is not required
+  #
+  # This example symlinks lib/euler.py into the solution's directory and then
+  # writes a base file into the directory.
+  def init solution
+    FileUtils.symlink("#{Euler.root}/lib/euler.py", "#{solution.dir}/euler.py")
+
+    File.open("#{solution.dir}/#{solution.problem_id}.py", 'w') do |f|
+      f.write("import euler\n\nanswer = 0\n\nprint(answer)\n")
+    end
+  end
+
+end)

data/example/README.md

@@ -0,0 +1,26 @@
+# Euler Manager Example
+
+## Eulerfile
+
+The root of your project Euler solutions needs to have an `Eulerfile.rb`.
+
+In this file you can configure the locations of Euler manager's data, the
+strategies it uses to manage and parse directories and register languages.
+
+Euler manager uses some pretty sensible defaults and comes with a number of
+languages already configured.  Its likely you will be able to get by with having
+your `Eulerfile.rb` be blank.
+
+## Directory Structure
+
+By default Euler manager creates solution directories with the top directory
+being the ID of the problem and the child directory being the language of the
+solution.
+
+Also by default Euler manger creates a `README.md` file in the problem directory
+with the problem's name and description.
+
+### /lib
+
+Its recommended to have a `lib` directory where you can store common functions
+in the languages you're solving problems in.

data/example/lib/euler.scala

@@ -0,0 +1,5 @@
+package euler
+
+object euler {
+
+}

data/lib/euler.rb

@@ -0,0 +1,190 @@
+require 'fileutils'
+require 'ostruct'
+
+require_relative 'euler/version'
+
+require_relative 'euler/errors'
+require_relative 'euler/problem'
+require_relative 'euler/solution'
+
+module Euler
+
+  # This class holds the Euler module's configuration.
+
+  class ConfigOptions
+
+    # Initialize an empty OpenStruct to hold configuration options
+    def initialize
+      @config = OpenStruct.new
+    end
+
+    # To set a config option call the corresponding method with an argument.
+    # To retrieve a config option call the corresponding method without an argument.
+    def method_missing method, *args, &block
+      if args.empty?
+        @config.send(method)
+      else
+        @config.send("#{method}=", args.first)
+      end
+    end
+
+  end
+
+  class << self
+
+    @@config_options = Euler::ConfigOptions.new
+    @@languages      = Hash.new
+
+    # Yields config_options to a block.  Used to configure the Euler module.
+    def config
+      yield @@config_options
+    end
+
+    # 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.
+    def register_language language_name, language = nil
+      language_string = language_name.to_s
+      @@languages[language_string.to_s] = language
+    end
+
+    # Unregisters a language
+    def unregister_language language_name
+      register_language(language_name)
+    end
+
+    # Returns an instance of a registered language class.
+    #
+    # @throws Euler::LanguageNotRegisteredError if the language asked for has
+    # not already been registered.
+    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
+
+    # 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.
+    def method_missing method, *args, &block
+      temp = @@config_options.send method
+      if temp.is_a?(Proc)
+        temp.call *args
+      else
+        temp
+      end
+    end
+
+    # Returns the root directory of the current project.
+    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
+
+    def euler_file_path
+      "#{root}/Eulerfile.rb"
+    end
+
+    # 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
+    def params_from_dir_or_args args
+      from_dir = parse_params_from_directory
+      [
+        args.shift || from_dir.shift,
+        args.shift || from_dir.shift
+      ]
+    end
+
+    # Uses the +directory_parse_strategy+ to attempt to parse the problem id and
+    # language of the solution's directory the command was ran from.
+    def parse_params_from_directory dir = ENV['PWD']
+      self.directory_parse_strategy(dir)
+    end
+
+  end
+
+end
+
+# Initialize the Euler module's configuration to the default values.
+Euler.config do |config|
+
+  data_dir = "#{File.dirname(__FILE__)}/../data"
+
+  config.answers_file "#{data_dir}/answers.yml"
+  config.problems_dir "#{data_dir}/problems"
+
+  # The +directory_strategy+ is a Proc which returns the directory assigned to a
+  # a given solution.
+  config.directory_strategy lambda { |solution|
+    "#{Euler.root}/#{solution.problem_id}/#{solution.language}"
+  }
+
+  # The +create_directory_strategy+ is a Proc which is ran to create directories
+  # for solutions and anything else that is required to initialize a solution.
+  # By default a +README.md+ file is created at the root of the problem with the
+  # problem's name and description.
+  config.create_directory_strategy lambda { |solution|
+    problem = solution.problem
+    dir     = solution.dir
+
+    FileUtils.mkdir_p(dir)
+    readme_path = "#{dir}/../README.md"
+    if not File.exists?(readme_path) then File.open(readme_path, 'w') do |f|
+      f.write("# [#{problem.name}](#{problem.url})\n\n#{problem.content}")
+    end end
+  }
+
+  # Attempts to parse a directory for the +problem_id+ and +language+.  Returns
+  # a an array where the first element is the problem id and the second element
+  # is the language.
+  config.directory_parse_strategy lambda { |dir|
+    problem_id = (Regexp.new("#{Euler.root}/(\\d+)").match(dir)     || [])[1]
+    language   = (Regexp.new("#{Euler.root}/\\d+/(.+)").match(dir)  || [])[1]
+
+    [problem_id, language]
+  }
+
+  # Returns every solution done so far.
+  config.all_solutions_strategy lambda {
+    Dir["#{Euler.root}/*"].select { |f|
+      File.directory?(f) and /\/\d+$/ === f
+    }.map { |problem_dir|
+      Dir["#{problem_dir}/*"].map { |solution_dir|
+        if File.directory?(solution_dir)
+          args = Euler.parse_params_from_directory(solution_dir)
+          Euler::Solution.new(*args)
+        else
+          nil
+        end
+      }
+    }.flatten.compact
+  }
+
+end
+
+# Include the default language definitions.
+require_relative 'euler/languages'
+
+# Attempt to load user defined configuration
+begin
+  require Euler.euler_file_path
+rescue; end

data/lib/euler/errors.rb

@@ -0,0 +1,7 @@
+module Euler
+
+  class EulerFileNotFoundError < StandardError; end
+
+  class LanguageNotRegisteredError < StandardError; end
+
+end

data/lib/euler/languages.rb

@@ -0,0 +1,12 @@
+# Loads the default language definitions using a white list.
+[
+
+  'coffeescript',
+  'javascript',
+  'python',
+  'ruby',
+  'scala'
+
+].each do |lang|
+  require_relative "./languages/#{lang}"
+end

data/lib/euler/languages/coffeescript.rb

@@ -0,0 +1,25 @@
+Euler.register_language('coffeescript', Class.new do
+
+  # Run the solution
+  def run solution
+    `coffee #{file_path(solution)}`
+  end
+
+  # Copy the template into the solution's directory
+  def init solution
+    FileUtils.cp(template_path, file_path(solution))
+  end
+
+  private
+
+    # Returns the path to the solution
+    def file_path solution
+      "#{solution.dir}/#{solution.problem.id}.coffee"
+    end
+
+    # Returns the path to the template
+    def template_path
+      "#{File.dirname(__FILE__)}/templates/coffeescript.coffee"
+    end
+
+end)

data/lib/euler/languages/javascript.rb

@@ -0,0 +1,25 @@
+Euler.register_language('javascript', Class.new do
+
+  # Run the solution
+  def run solution
+    `node #{file_path(solution)}`
+  end
+
+  # Copy the template into the solution's directory
+  def init solution
+    FileUtils.cp(template_path, file_path(solution))
+  end
+
+  private
+
+    # Returns the path to the solution
+    def file_path solution
+      "#{solution.dir}/#{solution.problem.id}.js"
+    end
+
+    # Returns the path to the template
+    def template_path
+      "#{File.dirname(__FILE__)}/templates/javascript.js"
+    end
+
+end)

data/lib/euler/languages/python.rb

@@ -0,0 +1,27 @@
+Euler.register_language('python', Class.new do
+
+  # Run the solution
+  def run solution
+    `python #{file_path(solution)}`
+  end
+
+  # Copy the template into the solution's directory
+  def init solution
+    FileUtils.symlink("#{Euler.root}/lib/euler.py", "#{solution.dir}/euler.py")
+
+    FileUtils.cp(template_path, file_path(solution))
+  end
+
+  private
+
+    # Returns the path to the solution
+    def file_path solution
+      "#{solution.dir}/#{solution.problem.id}.py"
+    end
+
+    # Returns the path to the template
+    def template_path
+      "#{File.dirname(__FILE__)}/templates/python.py"
+    end
+
+end)

data/lib/euler/languages/ruby.rb

@@ -0,0 +1,25 @@
+Euler.register_language('ruby', Class.new do
+
+  # Run the ruby solution
+  def run solution
+    `ruby #{file_path(solution)}`
+  end
+
+  # Copy the template into the solution's directory
+  def init solution
+    FileUtils.cp(template_path, file_path(solution))
+  end
+
+  private
+
+    # Returns the path to the solution
+    def file_path solution
+      "#{solution.dir}/#{solution.problem.id}.rb"
+    end
+
+    # Returns the path to the ruby template
+    def template_path
+      "#{File.dirname(__FILE__)}/templates/ruby.rb"
+    end
+
+end)