ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/port.rb

@@ -18,10 +18,9 @@
 #
 
 require 'ronin/model'
+require 'ronin/open_port'
 
 module Ronin
-  autoload :OpenPort, 'ronin/open_port'
-
   #
   # Represents a TCP or UDP port.
   #
@@ -56,6 +55,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_i
       self.number.to_i
     end
@@ -68,6 +69,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_s
       "#{self.number}/#{self.protocol}"
     end
@@ -80,6 +83,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def inspect
       "#<#{self.class}: #{self}>"
     end

data/lib/ronin/{engine/exceptions/deploy_failed.rb → repositories.rb}

@@ -17,9 +17,7 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-module Ronin
-  module Engine
-    class DeployFailed < RuntimeError
-    end
-  end
-end
+require 'ronin/repository'
+require 'ronin/bootstrap'
+
+Ronin::Repository.activate!

data/lib/ronin/repository.rb

@@ -19,6 +19,7 @@
 
 require 'ronin/exceptions/duplicate_repository'
 require 'ronin/exceptions/repository_not_found'
+require 'ronin/script/path'
 require 'ronin/model/has_license'
 require 'ronin/model/has_authors'
 require 'ronin/model'
@@ -29,8 +30,6 @@ require 'data_paths'
 require 'yaml'
 
 module Ronin
-  autoload :CachedFile, 'ronin/cached_file'
-
   class Repository
 
     include Model
@@ -56,8 +55,8 @@ module Ronin
     # Repository `data/` directory
     DATA_DIR = 'data'
 
-    # Repository `cache/` directory
-    CACHE_DIR = 'cache'
+    # Directories containing {Script}s
+    SCRIPT_DIRS = %w[scripts cache]
 
     # The primary key of the repository
     property :id, Serial
@@ -95,8 +94,8 @@ module Ronin
     # Description of the repository
     property :description, Text
 
-    # The cached files from the repository
-    has 0..n, :cached_files
+    # The script paths from the repository
+    has 0..n, :script_paths, :model => 'Script::Path'
 
     # The `bin/` directory
     attr_reader :bin_dir
@@ -107,8 +106,8 @@ module Ronin
     # The `data/` directory
     attr_reader :data_dir
 
-    # The `cache/` directory
-    attr_reader :cache_dir
+    # Directories containing {Script}s.
+    attr_reader :script_dirs
 
     #
     # Creates a new {Repository} object.
@@ -132,13 +131,15 @@ module Ronin
     # @yieldparam [Repository] repo
     #   The newly created repository.
     #
+    # @api private
+    #
     def initialize(attributes={})
       super(attributes)
 
       @bin_dir = self.path.join(BIN_DIR)
       @lib_dir = self.path.join(LIB_DIR)
       @data_dir = self.path.join(DATA_DIR)
-      @cache_dir = self.path.join(CACHE_DIR)
+      @script_dirs = SCRIPT_DIRS.map { |dir| self.path.join(dir) }
 
       @activated = false
 
@@ -168,6 +169,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def Repository.find(name)
       name, domain = name.to_s.split('/',2)
 
@@ -202,6 +205,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def Repository.add!(options={})
       unless options.has_key?(:path)
         raise(ArgumentError,"the :path option was not given")
@@ -232,7 +237,7 @@ module Ronin
       if repo.save
         # cache any files from within the `cache/` directory of the
         # repository
-        repo.cache_files!
+        repo.cache_scripts!
       end
 
       return repo
@@ -263,6 +268,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def Repository.install!(options={})
       unless options[:uri]
         raise(ArgumentError,":uri must be passed to Repository.install")
@@ -301,7 +308,7 @@ module Ronin
       if repo.save
         # cache any files from within the `cache/` directory of the
         # repository
-        repo.cache_files!
+        repo.cache_scripts!
       end
 
       return repo
@@ -318,6 +325,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def Repository.update!
       Repository.each do |repo|
         # update the repositories contents
@@ -341,6 +350,8 @@ module Ronin
     # @example Uninstall the repository with the given name and domain.
     #   Repository.uninstall!('postmodern-repo/github.com')
     #
+    # @api private
+    #
     def Repository.uninstall!(name)
       Repository.find(name).uninstall!
     end
@@ -355,6 +366,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def Repository.activate!
       Repository.each { |repo| repo.activate! }
     end
@@ -369,6 +382,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def Repository.deactivate!
       Repository.reverse_each { |repo| repo.deactivate! }
     end
@@ -381,6 +396,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def local?
       self.domain == LOCAL_DOMAIN
     end
@@ -393,6 +410,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def remote?
       self.domain != LOCAL_DOMAIN
     end
@@ -405,6 +424,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def executables
       scripts = []
 
@@ -420,13 +441,25 @@ module Ronin
     #
     # All paths within the `cache/` directory of the repository.
     #
-    # @return [Array<Pathname>]
-    #   The paths within the `cache/` directory.
+    # @yield [path]
+    #   If a block is given, it will be passed each matching path.
+    #
+    # @yieldparam [Pathname] path
+    #   A matching path.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator object will be returned.
     #
     # @since 1.0.0
     #
-    def cache_paths
-      Pathname.glob(@cache_dir.join('**','*.rb'))
+    # @api private
+    #
+    def each_script(&block)
+      return enum_for(:each_script) unless block
+
+      @script_dirs.each do |dir|
+        Pathname.glob(dir.join('**','*.rb'),&block)
+      end
     end
 
     #
@@ -435,6 +468,8 @@ module Ronin
     # @return [Boolean]
     #   Specifies whether the repository has been activated.
     #
+    # @api private
+    #
     def activated?
       @activated == true
     end
@@ -443,12 +478,17 @@ module Ronin
     # Activates the repository by adding the {#lib_dir} to the `$LOAD_PATH`
     # global variable.
     #
+    # @api private
+    #
     def activate!
       # add the data/ directory
-      register_data_dir(@data_dir) if File.directory?(@data_dir)
+      register_data_path(@data_dir) if @data_dir.directory?
+
+      if @lib_dir.directory?
+        # ensure all paths added to $LOAD_PATH are Strings
+        path = @lib_dir.to_s
 
-      if File.directory?(@lib_dir)
-        $LOAD_PATH << @lib_dir unless $LOAD_PATH.include?(@lib_dir)
+        $LOAD_PATH << path unless $LOAD_PATH.include?(path)
       end
 
       # load the lib/init.rb file
@@ -463,17 +503,38 @@ module Ronin
     # De-activates the repository by removing the {#lib_dir} from the
     # `$LOAD_PATH` global variable.
     #
+    # @api private
+    #
     def deactivate!
-      unregister_data_dirs!
+      unregister_data_paths
 
-      $LOAD_PATH.delete(@lib_dir)
+      $LOAD_PATH.delete(@lib_dir.to_s)
 
       @activated = false
       return true
     end
 
     #
-    # Clears the {#cached_files} and re-saves the cached files within the
+    # Finds a cached script.
+    #
+    # @param [String] sub_path
+    #   The sub-path within the repository to search for.
+    #
+    # @return [Script::Path, nil]
+    #   The matching script path.
+    #
+    # @since 1.1.0
+    #
+    # @api private
+    #
+    def find_script(sub_path)
+      paths = @script_dirs.map { |dir| File.join(dir,sub_path) }
+
+      return script_paths.first(:path => paths)
+    end
+
+    #
+    # Clears the {#script_paths} and re-saves the cached files within the
     # `cache/` directory.
     #
     # @return [Repository]
@@ -481,18 +542,20 @@ module Ronin
     #
     # @since 1.0.0
     #
-    def cache_files!
-      clean_cached_files!
+    # @api private
+    #
+    def cache_scripts!
+      clean_scripts!
 
-      cache_paths.each do |path|
-        self.cached_files.new(:path => path).cache
+      each_script do |path|
+        self.script_paths.new(:path => path).cache
       end
 
       return self
     end
 
     #
-    # Syncs the {#cached_files} of the repository, and adds any new cached
+    # Syncs the {#script_paths} of the repository, and adds any new cached
     # files.
     #
     # @return [Repository]
@@ -500,23 +563,25 @@ module Ronin
     #
     # @since 1.0.0
     #
-    def sync_cached_files!
+    # @api private
+    #
+    def sync_scripts!
       # activates the repository before caching it's objects
       activate!
 
-      new_paths = cache_paths
+      new_paths = each_script.to_a
 
-      self.cached_files.each do |cached_file|
+      self.script_paths.each do |script_path|
         # filter out pre-existing paths within the `cached/` directory
-        new_paths.delete(cached_file.path)
+        new_paths.delete(script_path.path)
 
         # sync the cached file and catch any exceptions
-        cached_file.sync
+        script_path.sync
       end
 
       # cache the new paths within the `cache/` directory
       new_paths.each do |path|
-        self.cached_files.new(:path => path).cache
+        self.script_paths.new(:path => path).cache
       end
 
       # deactivates the repository
@@ -526,15 +591,17 @@ module Ronin
     end
 
     #
-    # Deletes any {#cached_files} associated with the repository.
+    # Deletes any {#script_paths} associated with the repository.
     #
     # @return [Repository]
     #   The cleaned repository.
     #
     # @since 1.0.0
     #
-    def clean_cached_files!
-      self.cached_files.clear
+    # @api private
+    #
+    def clean_scripts!
+      self.script_paths.clear
       return self
     end
 
@@ -554,6 +621,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def update!
       local_repo = Pullr::LocalRepository.new(
         :path => self.path,
@@ -569,7 +638,7 @@ module Ronin
       # save the repository
       if save
         # syncs the cached files of the repository
-        sync_cached_files!
+        sync_scripts!
       end
 
       yield self if block_given?
@@ -591,13 +660,15 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api private
+    #
     def uninstall!
       deactivate!
 
       FileUtils.rm_rf(self.path) if self.installed?
 
       # destroy any cached files first
-      clean_cached_files!
+      clean_scripts!
 
       # remove the repository from the database
       destroy if saved?
@@ -621,6 +692,8 @@ module Ronin
     #
     # Loads the metadata from {METADATA_FILE} within the repository.
     #
+    # @api private
+    #
     def initialize_metadata
       metadata_path = self.path.join(METADATA_FILE)
 

data/lib/ronin/ronin.rb

@@ -18,11 +18,10 @@
 #
 
 require 'ronin/class_methods'
-
-require 'open_namespace'
+require 'ronin/auto_load'
 
 module Ronin
-  include OpenNamespace
+  include AutoLoad
 
   #
   # Includes {ClassMethods} when {Ronin} is included.
@@ -32,6 +31,8 @@ module Ronin
   #
   # @since 1.0.0
   #
+  # @api private
+  #
   def self.included(base)
     base.send :extend, ClassMethods
   end