ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/{engine/engine.rb → script/script.rb}

@@ -17,66 +17,103 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/engine/class_methods'
-require 'ronin/engine/instance_methods'
+require 'ronin/script/instance_methods'
+require 'ronin/script/class_methods'
+require 'ronin/script/path'
 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 'object_loader'
+require 'data_paths/finders'
 require 'parameters'
 
 module Ronin
-  module Engine
+  #
+  # @since 1.1.0
+  #
+  module Script
     include UI::Output::Helpers
 
     #
     # Adds the following to the Class.
     #
-    # * {Engine::InstanceMethods}
+    # * {Script::InstanceMethods}
     # * {Model}
     # * {Model::HasName}
     # * {Model::HasDescription}
     # * {Model::HasVersion}
     # * {Model::HasLicense}
     # * {Model::HasAuthors}
-    # * {Model::Cacheable}
+    # * [ObjectLoader](http://rubydoc.info/gems/object_loader)
+    # * [DataPaths::Finders](http://rubydoc.info/gems/data_paths)
     # * [Parameters](http://rubydoc.info/gems/parameters)
     # * {ClassMethods}
     #
+    # @api semipublic
+    #
     def self.included(base)
-      base.send :include, Engine::InstanceMethods,
+      base.send :include, InstanceMethods,
                           Model,
                           Model::HasName,
                           Model::HasDescription,
                           Model::HasVersion,
                           Model::HasLicense,
                           Model::HasAuthors,
-                          Model::Cacheable,
+                          ObjectLoader,
+                          DataPaths::Finders,
                           Parameters
 
       base.send :extend, ClassMethods
+
+      base.module_eval do
+        # The class-name of the cached object
+        property :type, DataMapper::Property::Discriminator
+
+        # The cached file of the object
+        belongs_to :script_path, Ronin::Script::Path, :required => false
+      end
+
+      Path.has 1, base.relationship_name, base, :child_key => [:script_path_id]
     end
 
     # 
-    # Loads a engine from a file.
+    # Loads a script from a file.
     #
     # @param [String] path
     #   The path to the file.
     #
-    # @return [Engine]
-    #   The loaded engine.
+    # @return [Script]
+    #   The loaded script.
     #
-    # @see Model::Cacheable.load_from
+    # @see Cacheable.load_from
     #
-    # @since 1.0.0
+    # @since 1.1.0
     #
-    def Engine.load_from(path)
-      Model::Cacheable.load_from(path)
+    # @api public
+    #
+    def Script.load_from(path)
+      path = File.expand_path(path)
+      script = ObjectLoader.load_objects(path).find do |obj|
+        obj.class < Script
+      end
+
+      unless script
+        raise("No cacheable object defined in #{path.dump}")
+      end
+
+      script.instance_variable_set('@script_loaded',true)
+      script.script_path = Path.new(
+        :path => path,
+        :timestamp => File.mtime(path),
+        :class_name => script.class.to_s
+      )
+
+      return script
     end
   end
 end

data/lib/ronin/{engine/verifiable.rb → script/testable.rb}

@@ -17,82 +17,95 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/engine/exceptions/verification_failed'
+require 'ronin/script/exceptions/test_failed'
+require 'ronin/ui/output/helpers'
 
 module Ronin
-  module Engine
+  module Script
     #
-    # Adds verification methods to an {Engine}.
+    # Adds testing methods to an {Script}.
     #
-    module Verifiable
+    # @since 1.1.0
+    #
+    module Testable
+      include UI::Output::Helpers
+
       #
-      # Initializes the verifiable engine.
+      # Initializes the testable script.
       #
       # @param [Hash] attributes
-      #   Additional attributes for the engine.
+      #   Additional attributes for the script.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api semipublic
       #
       def initialize(attributes={})
         super(attributes)
 
-        @verify_blocks = []
+        @test_blocks = []
       end
 
       #
-      # Verifies that the engine is properly configured.
+      # Tests that the script is properly configured.
       #
       # @return [true]
       #   The exploit is built and ready for deployment.
       #
-      # @see verify
+      # @see test
+      #
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api semipublic
       #
-      def verify!
-        print_info "Verifying #{engine_name} ..."
+      def test!
+        print_info "Testing #{script_type} ..."
 
-        @verify_blocks.each { |block| block.call() }
+        @test_blocks.each { |block| block.call() }
 
-        print_info "#{engine_name} verified!"
+        print_info "#{script_type} tested!"
         return true
       end
 
       protected
 
       #
-      # Flunks the verification.
+      # Flunks the testing process.
       #
       # @param [String] message
-      #   The message on why the verification failed.
+      #   The message on why the testing failed.
       #
-      # @raise [VerificationFailed]
-      #   The verification failure message.
+      # @raise [TestFailed]
+      #   The testing failure message.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
       def flunk(message)
-        raise(VerificationFailed,message)
+        raise(TestFailed,message)
       end
 
       #
-      # Registers a given block to be called when the engine is verified.
+      # Registers a given block to be called when the script is tested.
       #
       # @yield []
-      #   The given block will be called when the engine is being verified.
+      #   The given block will be called when the script is being tested.
+      #
+      # @return [Script]
+      #   The script.
       #
-      # @return [Engine]
-      #   The engine.
+      # @since 1.1.0
       #
-      # @since 1.0.0
+      # @api public
       #
-      def verify(&block)
-        @verify_blocks << block
+      def test(&block)
+        @test_blocks << block
         return self
       end
 
       #
-      # Verifies an expression is true.
+      # Tests whether an expression is true.
       #
       # @param [String] message
       #   The failure message if the expression was not true.
@@ -103,17 +116,19 @@ module Ronin
       # @return [true]
       #   The expression was true.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The expression was not true.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
-      def verify?(message,&block)
-        verify { flunk(message) unless block.call() }
+      def test?(message,&block)
+        test { flunk(message) unless block.call() }
       end
 
       #
-      # Verifies a method has the expected value.
+      # Tests whether a method has the expected value.
       #
       # @param [Symbol] name
       #   The method to call.
@@ -127,15 +142,17 @@ module Ronin
       # @return [true]
       #   The method returned the expected value.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method did not return the expected value.
       #
-      # @since 1.0.0
+      # @since 1.1.0
       #
-      def verify_equal(name,expected_value,message=nil)
+      # @api public
+      #
+      def test_equal(name,expected_value,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} (#{actual_value.inspect}) must equal #{expected_value.inspect}"
 
@@ -144,7 +161,7 @@ module Ronin
       end
 
       #
-      # Verifies a method does not have the unexpected value.
+      # Tests whether a method does not have the unexpected value.
       #
       # @param [Symbol] name
       #   The method to call.
@@ -158,15 +175,17 @@ module Ronin
       # @return [true]
       #   The method did not return the unexpected value.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method did return the unexpected value.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
-      def verify_not_equal(name,unexpected_value,message=nil)
+      def test_not_equal(name,unexpected_value,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} (#{actual_value.inspect}) cannot equal #{unexpected_value.inspect}"
 
@@ -175,7 +194,7 @@ module Ronin
       end
 
       #
-      # Verifies a method returns a non-`nil` value.
+      # Tests whether a method returns a non-`nil` value.
       #
       # @param [Symbol] name
       #   The method to call.
@@ -186,15 +205,17 @@ module Ronin
       # @return [true]
       #   The method returned a non-`nil` value.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method returned `nil`.
       #
-      # @since 1.0.0
+      # @since 1.1.0
       #
-      def verify_set(name,message=nil)
+      # @api public
+      #
+      def test_set(name,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} is not set"
 
@@ -209,7 +230,7 @@ module Ronin
       end
 
       #
-      # Verifies a method matches the pattern.
+      # Tests whether a method matches the pattern.
       #
       # @param [Symbol] name
       #   The method to call.
@@ -223,15 +244,17 @@ module Ronin
       # @return [true]
       #   The method matched the pattern.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method did not match the pattern.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
-      def verify_match(name,pattern,message=nil)
+      def test_match(name,pattern,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} (#{actual_value.inspect}) must match #{pattern.inspect}"
 
@@ -240,7 +263,7 @@ module Ronin
       end
 
       #
-      # Verifies a method does not matches the pattern.
+      # Tests whether a method does not matches the pattern.
       #
       # @param [Symbol] name
       #   The method to call.
@@ -254,15 +277,17 @@ module Ronin
       # @return [true]
       #   The method matched the pattern.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method did not match the pattern.
       #
-      # @since 1.0.0
+      # @since 1.1.0
       #
-      def verify_no_match(name,pattern,message=nil)
+      # @api public
+      #
+      def test_no_match(name,pattern,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} (#{actual_value.inspect}) cannot match #{pattern.inspect}"
 
@@ -271,7 +296,7 @@ module Ronin
       end
 
       #
-      # Verify a method has a value in the expected values.
+      # Tests a method has a value in the expected values.
       #
       # @param [Symbol] name
       #   The method name.
@@ -285,15 +310,17 @@ module Ronin
       # @return [true]
       #   The method returned one of the expected values.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method did not return one of the expected values.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
-      def verify_in(name,expected_values,message=nil)
+      def test_in(name,expected_values,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} (#{actual_value.inspect}) must be one of #{expected_values.inspect}"
 
@@ -302,7 +329,7 @@ module Ronin
       end
 
       #
-      # Verify a method does not have a value in the unexpected values.
+      # Tests a method does not have a value in the unexpected values.
       #
       # @param [Symbol] name
       #   The method name.
@@ -316,15 +343,17 @@ module Ronin
       # @return [true]
       #   The method did not return one of the unexpected values.
       #
-      # @raise [VerificationFailed]
+      # @raise [TestFailed]
       #   The method did return one of the unexpected values.
       #
-      # @since 1.0.0
+      # @since 1.1.0
+      #
+      # @api public
       #
-      def verify_not_in(name,unexpected_values,message=nil)
+      def test_not_in(name,unexpected_values,message=nil)
         name = name.to_sym
 
-        verify do
+        test do
           actual_value = self.send(name)
           message ||= "#{name} (#{actual_value.inspect}) cannot be one of #{unexpected_values.inspect}"