#
# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This file is part of Ronin.
#
# Ronin is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ronin is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
#

require 'ronin/engine/class_methods'
require 'ronin/engine/instance_methods'
require 'ronin/model/model'
require 'ronin/model/has_name'
require 'ronin/model/has_description'
require 'ronin/model/has_version'
require 'ronin/model/has_license'
require 'ronin/model/has_authors'
require 'ronin/model/cacheable'
require 'ronin/ui/output/helpers'

require 'parameters'

module Ronin
  module Engine
    include UI::Output::Helpers

    #
    # Adds the following to the Class.
    #
    # * {Engine::InstanceMethods}
    # * {Model}
    # * {Model::HasName}
    # * {Model::HasDescription}
    # * {Model::HasVersion}
    # * {Model::HasLicense}
    # * {Model::HasAuthors}
    # * {Model::Cacheable}
    # * [Parameters](http://rubydoc.info/gems/parameters)
    # * {ClassMethods}
    #
    def self.included(base)
      base.send :include, Engine::InstanceMethods,
                          Model,
                          Model::HasName,
                          Model::HasDescription,
                          Model::HasVersion,
                          Model::HasLicense,
                          Model::HasAuthors,
                          Model::Cacheable,
                          Parameters

      base.send :extend, ClassMethods
    end

    # 
    # Loads a engine from a file.
    #
    # @param [String] path
    #   The path to the file.
    #
    # @return [Engine]
    #   The loaded engine.
    #
    # @see Model::Cacheable.load_from
    #
    # @since 1.0.0
    #
    def Engine.load_from(path)
      Model::Cacheable.load_from(path)
    end
  end
end