mir 0.1.4 → 0.1.5

data/lib/mir/index.rb

@@ -13,8 +13,9 @@ module Mir
     
     # Returns a databse object used to connect to the indexing database
     #
-    # @param [String] the absolute path of the directory to be synchronized
-    # @param [Hash] database configuration settings. See ActiveRecord#Base::establish_connection
+    # @param sync_path [String] the absolute path of the directory to be synchronized
+    # @param connection_params [Hash] database configuration settings. See ActiveRecord#Base::establish_connection
+    # @return [Mir::Index]
     def initialize(sync_path, connection_params)
       @sync_path = sync_path
       @connection_params = connection_params
@@ -25,8 +26,9 @@ module Mir
     #
     # Creates necessary database and tables if this is the first time connecting
     #
-    # @option opts [Boolean] :verbose Enable on ActiveRecord reporting
-    # @option opts [Boolean] :force_flush Rebuild index no matter what
+    # @option options [Boolean] :verbose Enable on ActiveRecord reporting
+    # @option options [Boolean] :force_flush Rebuild index no matter what
+    # @return [void]
     def setup(options = {})
       options[:force_flush] ||= false
       options[:verbose] ||= false
@@ -45,6 +47,7 @@ module Mir
     ##
     # Scans the synchronization path and evaluates whether a resource has changed
     # since the last index or is new and needs to be added to the index.
+    # @return [void]
     def update
       Mir.logger.info "Updating backup index for '#{sync_path}'"
       Models::AppSetting.last_indexed_at = @last_indexed_at = DateTime.now
@@ -70,11 +73,14 @@ module Mir
     # Returns any files not present since the last re-indexing. This is useful
     # for finding files that have been deleted post-index.
     # 
-    # @return [Mir::Models::Resource]
+    # @return [Array, Mir::Models::Resource]
     def orphans
       Models::Resource.not_indexed_on(last_indexed_at)
     end
     
+    ##
+    # The date at whish the backup path was last indexed
+    # @return [DateTime]
     def last_indexed_at
       @last_indexed_at ||= Models::AppSetting.last_indexed_at
     end
@@ -82,17 +88,23 @@ module Mir
     
     ##
     # Removes any files from the index that are no longer present locally
+    # @return [void]
     def clean!
       Models::Resource.delete_all_except(last_indexed_at)
     end
     
     private
+      ##
       # Returns the path of a file relative to the backup directory
+      # @param file [String] the absolute path name of the file
+      # @return [String] the path of the file relative to the stored backup path
       def relative_path(file)
         File.absolute_path(file).gsub(sync_path,'')
       end
       
+      ##
       # Regenerates the file system index for the backup directory
+      # @return [void]
       def rebuild
         tables.each { |t| ActiveRecord::Migration.drop_table(t.table_name) if t.table_exists? }
         ActiveRecord::Migration.drop_table(:schema_migrations) if @connection.table_exists? :schema_migrations
@@ -102,7 +114,8 @@ module Mir
       
       
       ##
-      # TODO: no reason to lazy load these activemodels
+      # Loads ActiveRecord tables
+      # @todo no reason to lazy load these activemodels
       def load_tables
         @tables = []
         models = File.join(File.dirname(__FILE__), "models", "*.rb")
@@ -115,12 +128,16 @@ module Mir
         end
       end
       
+      ##
       # Returns the activerecord classes for each table used by the application
+      # @return [Array, Class]
       def tables
         @tables
       end
       
-      # Checks whether any of the tables required by the applicaiton exist
+      ##
+      # Checks whether any of the tables required by the application exist
+      # @return [Boolean]
       def tables_created?
         tables.any? { |t| t.table_exists? }
       end

data/lib/mir/logger.rb

@@ -1,9 +1,14 @@
 require 'logger'
 
 module Mir
+  # Assigns a global logger
+  # @param logger [Logger]
   def self.logger=(logger)
     @@logger = logger
   end
+  
+  # Returns the global logger instance
+  # @return [Logger]
   def self.logger
     @@logger
   end

data/lib/mir/models/resource.rb

@@ -10,7 +10,7 @@ module Mir
       # Builds a resource for the backup index from a file
       # @param [File] a file object
       # @param [String] the name of the file on the remote disk
-      # @returns [Resource] a new Resource instance that with a queued status
+      # @return [Resource] a new Resource instance that with a queued status
       def self.create_from_file_and_name(file, name)
         is_dir = File.directory?(file)
         create(:filename => name,
@@ -41,9 +41,11 @@ module Mir
         chunked_groups(qry, response_size) { |chunk| yield chunk }
       end
       
+      ##
       # Returns groups of file resources ordered by name
+      #
       # @param [Integer] the number of records to return per chunk
-      # @yields [Array] instances of Models::Resource
+      # @yield [Array] instances of Models::Resource
       def self.ordered_groups(group_size = 10)
         qry = lambda { Resource.order(:filename) }
         chunked_groups(qry, group_size) { |chunk| yield chunk }
@@ -76,7 +78,7 @@ module Mir
       end
       
       # Whether the item can be synchronized to a remote disk
-      # @returns [Boolean] true when the resource is not a directory
+      # @return [Boolean] true when the resource is not a directory
       def synchronizable?
         !is_directory?
       end

data/lib/mir/utils.rb

@@ -3,21 +3,26 @@ module Mir
     
     # Generates filename for a split file
     # filename_with_sequence("foobar.txt", 23) => foobar.txt.00000023
-    # @param [String] filename
-    # @param [Integer] the sequence number
+    # @param name [String] filename
+    # @param seq [Integer] the sequence number
+    # @return [String]
     def self.filename_with_sequence(name, seq)
       [name, ".", "%08d" % seq].join
     end
     
+    # Attempts to create the directory path specified
+    # @param path [String] the path to create
+    # @return [Dir]
     def self.try_create_dir(path)
       Dir.mkdir(path) unless Dir.exist?(path)
       Dir.new(path)
     end
     
     # Splits a file into pieces that may be reassembled later
-    # @param [File or String] File to be split
+    # @param [File|String] File to be split
     # @param [Integer] the number of bytes per each chunked file
     # @param [String] where the split files should be stored
+    # @return [void]
     def self.split_file(file, chunk_size, dest)
       try_create_dir(dest) unless Dir.exist?(dest)
       
@@ -37,6 +42,7 @@ module Mir
     # Recombines a file from pieces
     # @param [String] the directory that holds the split files
     # @param [String] the path to the assembled file
+    # @return [void]
     def self.recombine(source_dir, dest)
       parts = Dir.glob(File.join(source_dir, "*"))
       open(File.expand_path(dest), "wb") do |file|

data/lib/mir/version.rb

@@ -1,5 +1,5 @@
 module Mir
-  VERSION = [0,1,4]
+  VERSION = [0,1,5]
   
   def self.version
     VERSION.join('.')

metadata

@@ -2,7 +2,7 @@
 name: mir
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Nate Miller
@@ -98,6 +98,35 @@ files:
 - bin/mir
 - db/migrate/001_create_app_settings.rb
 - db/migrate/002_create_resources.rb
+- doc/Mir.html
+- doc/Mir/Application.html
+- doc/Mir/Config.html
+- doc/Mir/Disk.html
+- doc/Mir/Disk/Amazon.html
+- doc/Mir/Disk/IncompleteTransmission.html
+- doc/Mir/Disk/MultiPartFile.html
+- doc/Mir/Disk/RemoteFileNotFound.html
+- doc/Mir/Index.html
+- doc/Mir/Models.html
+- doc/Mir/Models/AppSetting.html
+- doc/Mir/Models/Resource.html
+- doc/Mir/Options.html
+- doc/Mir/UndefinedConfigValue.html
+- doc/Mir/Utils.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/mir.rb
 - lib/mir/application.rb
 - lib/mir/config.rb