ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/cached_file.rb

@@ -1,247 +0,0 @@
-#
-# 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/support/inflector'
-require 'ronin/model'
-
-require 'object_loader'
-
-module Ronin
-  autoload :Repository, 'ronin/repository'
-
-  #
-  # The {CachedFile} model stores information in the {Database} about
-  # files that {Cacheable} Models were cached from. {CachedFile} also
-  # manages the {Cacheable} objects that were saved in the {Database}.
-  #
-  class CachedFile
-
-    include Model
-
-    # The primary key of the cached file
-    property :id, Serial
-
-    # The path to the file where the object was defined in
-    property :path, FilePath, :required => true
-
-    # The timestamp of the cached file
-    property :timestamp, Time, :required => true
-
-    # The class name of the cached object
-    property :model_name, String, :required => true
-
-    # The repository the file was cached from
-    belongs_to :repository
-
-    # Any exceptions raise when loading a fresh object
-    attr_reader :cache_exception
-
-    # Any cache errors encountered when caching the object
-    attr_reader :cache_errors
-
-    #
-    # The path to require to access the Class of the cached object.
-    #
-    # @return [String]
-    #   The possible path inferred from the class name.
-    #
-    def model_path
-      if self.model_name
-        Support::Inflector.underscore(self.model_name)
-      end
-    end
-
-    #
-    # The Model of the cached object.
-    #
-    # @return [Class, nil]
-    #   Returns the Model of the cached object, or `nil` if the class
-    #   could not be loaded or found.
-    #
-    def cached_model
-      return unless self.model_name
-
-      # filter out unloadable models
-      begin
-        require model_path
-      rescue Gem::LoadError => e
-        raise(e)
-      rescue ::LoadError
-      end
-
-      # filter out missing class names
-      model = begin
-                DataMapper::Ext::Object.full_const_get(self.model_name)
-              rescue NameError
-                return nil
-              end
-
-      # filter out non-Cacheable models
-      return model if model < Cacheable
-    end
-
-    #
-    # The object from the Database that was cached from the file.
-    #
-    # @return [Model]
-    #   The previously cached object connected to the cache file.
-    #
-    def cached_object
-      if (model = self.cached_model)
-        return model.first(:cached_file => self)
-      end
-    end
-
-    #
-    # A freshly loaded Cacheable object from the cache file.
-    #
-    # @return [Cacheable, nil]
-    #   The first Cacheable object loaded from the cache file.
-    #   If `nil` is returned, the file did not contain any cacheable
-    #   objects or the cache file contained a syntax error.
-    #   
-    def fresh_object
-      begin
-        # load the first found context
-        blocks = ObjectLoader.load_blocks(self.path)
-      rescue Exception => e
-        @cache_exception = e
-        return nil
-      end
-
-      blocks.each do |model,block|
-        if model < Cacheable
-          # create the fresh object
-          object = model.new()
-
-          begin
-            object.instance_eval(&block)
-
-            @cache_exception = nil
-            return object
-          rescue Exception => e
-            @cache_exception = e
-          end
-        end
-      end
-
-      return nil
-    end
-
-    #
-    # Determines if the cache file was updated.
-    #
-    # @return [Boolean]
-    #   Specifies whether the cache file was updated.
-    #
-    def updated?
-      # assume updates if there is no timestamp
-      return true unless self.timestamp
-
-      if File.file?(self.path)
-        return self.path.mtime > self.timestamp
-      end
-
-      # do not assume updates, if there is no path
-      return false
-    end
-
-    #
-    # Determines if the cache file was deleted.
-    #
-    # @return [Boolean]
-    #   Specifies whether the cache file was deleted.
-    #
-    def missing?
-      !(self.path.file?)
-    end
-
-    #
-    # Caches the freshly loaded object from the cache file into the
-    # Database.
-    #
-    # @return [Boolean]
-    #   Specifies whether the object was successfully cached.
-    #
-    def cache
-      if (obj = fresh_object)
-        # reset the model-class
-        self.model_name = obj.class.to_s
-
-        # update the timestamp
-        self.timestamp = self.path.mtime
-
-        # re-cache the fresh_object
-        obj.cached_file = self
-
-        if obj.save
-          @cache_errors = nil
-          return true
-        else
-          @cache_errors = obj.errors
-        end
-      end
-
-      return false
-    end
-
-    #
-    # Syncs the cached object in the Database with the object loaded from
-    # the cache file.
-    #
-    # @return [Boolean]
-    #   Specifies whether the cached object was successfully synced.
-    #
-    def sync
-      if missing?
-        # destroy the cached file, if the actual file is missing
-        return destroy
-      elsif updated?
-        if (obj = cached_object)
-          # destroy the previously cached object
-          obj.destroy!
-        end
-
-        unless cache
-          # if we couldn't cache anything, self-destruct
-          destroy
-        end
-
-        return true
-      end
-
-      return false
-    end
-
-    #
-    # Before destroying the cached file object, also destroy the
-    # associated cached object.
-    #
-    def destroy
-      unless destroyed?
-        if (obj = self.cached_object)
-          obj.destroy!
-        end
-      end
-
-      super
-    end
-
-  end
-end

data/lib/ronin/engine/class_methods.rb

@@ -1,135 +0,0 @@
-#
-# 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/>.
-#
-
-module Ronin
-  module Engine
-    #
-    # Class methods for an {Engine}.
-    #
-    module ClassMethods
-      #
-      # Finds and loads all matching Ronin Engines.
-      #
-      # @param [Hash] options
-      #   Query options.
-      #
-      # @option options [String] :name
-      #   The name to search for.
-      #
-      # @option options [String] :describing
-      #   The description to search for.
-      #
-      # @option options [String] :version
-      #   The version to search for.
-      #
-      # @option options [String] :license
-      #   The license to search for.
-      #
-      # @return [Array<Engine>]
-      #   The Ronin Engine with the matching attributes.
-      #
-      # @since 1.0.0
-      #
-      def load_all(options={})
-        resources = custom_query(options)
-        
-        resources.each { |resource| resource.load_original! }
-        return resources
-      end
-
-      #
-      # Finds and loads a specific Ronin Engine.
-      #
-      # @param [Hash] options
-      #   Query options.
-      #
-      # @option options [String] :name
-      #   The name to search for.
-      #
-      # @option options [String] :describing
-      #   The description to search for.
-      #
-      # @option options [String] :version
-      #   The version to search for.
-      #
-      # @option options [String] :license
-      #   The license to search for.
-      #
-      # @return [Array<Engine>]
-      #   The Ronin Engine with the matching attributes.
-      #
-      # @since 1.0.0
-      #
-      def load_first(options={})
-        if (resource = custom_query(options).first)
-          resource.load_original!
-        end
-
-        return resource
-      end
-
-      protected
-
-      #
-      # Creates a custom query for the Ronin Engine.
-      #
-      # @param [Hash] options
-      #   Query options.
-      #
-      # @option options [String] :name
-      #   The name to search for.
-      #
-      # @option options [String] :describing
-      #   The description to search for.
-      #
-      # @option options [String] :version
-      #   The version to search for.
-      #
-      # @option options [String] :license
-      #   The license to search for.
-      #
-      # @return [DataMapper::Collection]
-      #   The custom query for the Ronin Engine.
-      #
-      # @since 1.0.0
-      #
-      def custom_query(options)
-        query = all
-
-        if options.has_key?(:name)
-          query = query.named(options.delete(:name))
-        end
-
-        if options.has_key?(:describing)
-          query = query.describing(options.delete(:describing))
-        end
-
-        if options.has_key?(:version)
-          query = query.revision(options.delete(:version))
-        end
-
-        if options.has_key?(:license)
-          query = query.licensed_under(options.delete(:license))
-        end
-
-        return query.all(options)
-      end
-    end
-  end
-end

data/lib/ronin/engine/instance_methods.rb

@@ -1,97 +0,0 @@
-#
-# 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/>.
-#
-
-module Ronin
-  module Engine
-    #
-    # Instance methods for an {Engine}.
-    #
-    module InstanceMethods
-      #
-      # Initializes the Ronin Engine.
-      #
-      # @param [Hash] attributes
-      #   The attributes or parameter values to initialize the engine with.
-      #
-      # @since 1.0.0
-      #
-      def initialize(attributes={})
-        super(attributes)
-
-        initialize_params(attributes)
-      end
-
-      #
-      # The engine type.
-      #
-      # @return [String]
-      #   The name of the engine class.
-      #
-      # @since 1.0.0
-      #
-      def engine_name
-        @ngine_name ||= self.class.base_model.name.split('::').last
-      end
-
-      #
-      # Converts the engine to a String.
-      #
-      # @return [String]
-      #   The name and version of the engine.
-      #
-      # @since 1.0.0
-      #
-      def to_s
-        if (self.name && self.version)
-          "#{self.name} #{self.version}"
-        elsif self.name
-          super
-        elsif self.version
-          self.version.to_s
-        end
-      end
-
-      #
-      # Inspects both the properties and parameters of the Ronin Engine.
-      #
-      # @return [String]
-      #   The inspected Ronin Engine.
-      #
-      # @since 1.0.0
-      #
-      def inspect
-        body = []
-
-        self.attributes.each do |name,value|
-          body << "#{name}: #{value.inspect}"
-        end
-
-        param_pairs = []
-
-        self.params.each do |name,param|
-          param_pairs << "#{name}: #{param.value.inspect}"
-        end
-
-        body << "params: {#{param_pairs.join(', ')}}"
-
-        return "#<#{self.class}: #{body.join(', ')}>"
-      end
-    end
-  end
-end