safeguard 0.0.3 → 0.1.0

data/README.markdown

@@ -1,3 +1,13 @@
 # Safeguard
 
-## Hash-based file integrity verification utility
+Hash-based file integrity verification utility
+
+# Installation
+
+Latest version:
+
+    gem install safeguard
+
+From source:
+
+    git clone git://github.com/matheusmoreira/safeguard.git

data/bin/safeguard

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'safeguard'
 
-Safeguard::Command.run *ARGV
+Safeguard.run *ARGV

data/i18n/en.yml

@@ -0,0 +1,11 @@
+en:
+  safeguard:
+    output:
+      terminal:
+        before_verifying: "Verifying '%{file}' with %{function}..."
+        before_hashing: "Hashing '%{file}' with %{function}..."
+        after_hashing: ' %{hash}'
+        after_verifying: ' %{result}'
+        hash_missing: 'Hash not in repository'
+        file_missing: 'File not in repository'
+        initialized_repository: 'Initialized Safeguard repository in %{directory}'

data/i18n/pt.yml

@@ -0,0 +1,11 @@
+pt:
+  safeguard:
+    output:
+      terminal:
+        before_verifying: "Verificando o %{function} de '%{file}'..."
+        before_hashing: "Calculando o %{function} de '%{file}'..."
+        after_hashing: ' %{hash}'
+        after_verifying: ' %{result}'
+        hash_missing: 'Hash não está presente no repositório'
+        file_missing: 'Arquivo não está presente no repositório'
+        initialized_repository: 'Repositório do Safeguard inicializado em %{directory}'

data/lib/safeguard/command/add/hash.rb

@@ -0,0 +1,31 @@
+require 'safeguard/command/add'
+require 'safeguard/output/terminal'
+require 'safeguard/repository'
+require 'ribbon'
+
+module Safeguard
+  class Command
+    class Add
+
+      # Hashes files and stores the result in the repository.
+      #
+      #   $ safeguard add hash --sha1 *.mp3
+      class Hash < Add
+
+        add_supported_algorithms_as_options!
+        opt :force, 'Rehash files that are already in the repository'
+
+        when_called do |options, files|
+          Repository.new(options.dir).before_save do |repo|
+            functions = options.functions? []
+            hasher_options = Ribbon.new force: options.force?, functions: functions
+            mappings = Output::Terminal.create_mappings_for :before_hashing, :after_hashing
+            Ribbon.merge! hasher_options, mappings
+            repo.hash_and_add! *files, hasher_options
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/safeguard/command/add.rb

@@ -1,26 +1,19 @@
 require 'safeguard/command'
-require 'safeguard/digest'
+require 'safeguard/repository'
 
 module Safeguard
   class Command
 
-    # Adds files to a Repository.
+    # Adds files to a Repository without hashing them.
+    #
+    #   $ safeguard add *.mp3
     class Add < Command
 
-      opt :functions, '--use', Symbol,
-                      "Algorithm used to calculate the file's checksum. " <<
-                      "Currently supported: #{Digest::SUPPORTED_ALGORITHMS.join(', ')}",
-                      arity: [1,0], on_multiple: :append
-
-      opt :force, '--force', 'Rehash files that are already in the repository'
-
-      # For every argument, try to add it to the Repository in the current
-      # directory.
-      action do |options, args|
+      # For every argument, add it to the Repository in the current directory.
+      action do |options, files|
         repo = Repository.new options.dir
         repo.before_save do
-          repo.add_files! *args, :functions => options.functions,
-                                 :force => options.force?
+          repo.add! *files
         end
       end
 

data/lib/safeguard/command/hash.rb

@@ -1,33 +1,24 @@
 require 'safeguard/command'
-require 'safeguard/digest'
+require 'safeguard/output/terminal'
+require 'safeguard/repository'
+require 'ribbon'
 
 module Safeguard
   class Command
 
     # Outputs the checksum of files.
     #
-    #   $ safeguard hash *.mp3
-    #
-    # The hash function can be specified with the --hash-function option. The
-    # default is SHA1, but MD5 and CRC32 are also supported.
-    #
-    #   $ safeguard --hash-function md5 hash *.mp3
+    #   $ safeguard hash --sha1 --md5 --crc32 *.mp3
     class Hash < Command
 
-      opt :func, '--hash-function', '--hash-functions', Symbol,
-                 "Algorithm to use to calculate the file's checksum. " <<
-                 "Currently supported: #{Digest::SUPPORTED_ALGORITHMS.join(', ')}",
-                 default: :sha1, arity: [1,-1]
+      add_supported_algorithms_as_options!
 
       # For every argument, outputs its checksum if it exists as a file.
-      action do |options, args|
-        hasher = Hasher.new *args, :functions => options.func
-        hasher.each do |file, hash_data|
-          puts "#{file}:"
-          hasher.functions.each do |function|
-            puts "\t#{function} => #{hash_data[function]}"
-          end
-        end
+      action do |options, files|
+        hasher_options = Ribbon.new functions: options.functions?([])
+        mappings = Output::Terminal.create_mappings_for :before_hashing, :after_hashing
+        Ribbon.merge! hasher_options, mappings
+        Hasher.new(*files, hasher_options).hash_files!
       end
 
     end

data/lib/safeguard/command/init.rb

@@ -1,13 +1,13 @@
 require 'safeguard/command'
+require 'safeguard/output/terminal'
 require 'safeguard/repository'
-require 'fileutils'
 
 module Safeguard
   class Command
 
     # Initializes a Repository in a given directory.
     #
-    #   $ safeguard init .
+    #   $ safeguard init
     class Init < Command
 
       # Initializes a Safeguard Repository in a directory, which is either the
@@ -17,7 +17,7 @@ module Safeguard
         dir = File.expand_path(args.pop || options.dir)
         repo = Repository.new(dir)
         repo.create_directory!
-        puts "Initialized safeguard repository in #{repo.dir}"
+        Output::Terminal.initialized_repository repo.dir
       end
 
     end

data/lib/safeguard/command/verify.rb

@@ -1,31 +1,31 @@
 require 'safeguard/command'
+require 'safeguard/output/terminal'
+require 'safeguard/repository'
+require 'ribbon'
 
 module Safeguard
   class Command
 
     # Verifies the files present in a Repository.
+    #
+    #   # Verifies all files in repository using SHA1
+    #   $ safeguard verify --sha1
+    #
+    #   # Verifies all files ending in '.mp3' using CRC32
+    #   $ safeguard verify --crc32 *.mp3
     class Verify < Command
 
-      opt :functions, '--use', Symbol,
-                      "Algorithm used to calculate the file's checksum. " <<
-                      "Currently supported: #{Digest::SUPPORTED_ALGORITHMS.join(', ')}",
-                      arity: [1,0], on_multiple: :append
+      add_supported_algorithms_as_options!
 
       # Verify the files passed as arguments using information from the
       # Repository in the current directory.
-      action do |options, args|
+      action do |options, files|
         repo = Repository.new options.dir
-        functions = options.functions
-        results = repo.verify_files *args, functions: functions
-        results.keys.each do |file|
-          puts "#{file}:"
-          results[file].keys.each do |function|
-            value = results[file][function]
-            value = "File not in repository" if value == :file_missing
-            value = "Hash not in repository" if value == :hash_missing
-            puts "\t#{function} => #{value}"
-          end
-        end
+        functions = options.functions? []
+        verifier_options = Ribbon.new functions: functions
+        mappings = Output::Terminal.create_mappings_for :before_verifying, :after_verifying
+        Ribbon.merge! verifier_options, mappings
+        results = repo.verify_files *files, verifier_options
       end
 
     end

data/lib/safeguard/command.rb

@@ -1,5 +1,7 @@
+require 'safeguard/digest'
+require 'safeguard/version'
 require 'acclaim/command'
-require 'acclaim/version'
+require 'i18n'
 
 module Safeguard
 
@@ -9,20 +11,50 @@ module Safeguard
   class Command < Acclaim::Command
 
     help
-    version Acclaim::Version::STRING
+    version Safeguard::Version::STRING
 
-    opt :dir, '-D', '--dir', '--directory', 'Directory in which the repository is.',
+    opt :dir, '-D', '--directory', 'Directory in which the repository is.',
               default: Dir.pwd, arity: [1,0]
 
+    opt :locale, Symbol, 'The locale to use for language & localization.',
+                  arity: [1,0] do |options, locale|
+      I18n.locale = locale.shift
+    end
+
     action do |options, args|
       Init.execute options, args
     end
 
+    # The class methods.
+    class << self
+
+      # An option will be made for every element in
+      # Digest::SUPPORTED_ALGORITHMS. They may be used together and always
+      # append to the function array, bound to the <tt>:functions</tt> key.
+      #
+      # However, due to the lack of a formally defined +functions+ option,
+      # the Acclaim option parser will not set that option to anything.
+      # Therefore, calling <tt>options.functions</tt> will return an empty
+      # ribbon if the user doesn't specify any functions on the command line.
+      #
+      # <tt>options.functions?</tt> should ALWAYS be called, preferably while
+      # providing an empty array as fallback.
+      def add_supported_algorithms_as_options!
+        Digest::SUPPORTED_ALGORITHMS.each do |algorithm|
+          option algorithm, "Use #{algorithm.to_s.upcase}." do |options|
+            options.functions = (options.functions? []) << algorithm
+          end
+        end
+      end
+
+    end
+
   end
 
 end
 
 require 'safeguard/command/add'
+require 'safeguard/command/add/hash'
 require 'safeguard/command/hash'
 require 'safeguard/command/init'
 require 'safeguard/command/verify'

data/lib/safeguard/core_ext/file.rb

@@ -1,5 +1,7 @@
 module Safeguard
   module CoreExt
+
+    # Ruby core extensions for the File class.
     module File
 
       # Default size of chunks in bytes. A megabyte is equal to 2^20 bytes, or

data/lib/safeguard/core_ext/module.rb

@@ -0,0 +1,16 @@
+module Safeguard
+  module CoreExt
+
+    # Ruby core extensions for the Module class.
+    module Module
+
+      def translation_key(*args)
+        name.split('::').push(*args).map(&:to_s).map(&:downcase).join '.'
+      end
+
+    end
+
+    ::Module.send :include, Safeguard::CoreExt::Module
+
+  end
+end

data/lib/safeguard/digest.rb

@@ -7,56 +7,54 @@ module Safeguard
   # Encapsulates checksum computation for files using a set of hash functions.
   module Digest
 
-    SUPPORTED_ALGORITHMS = %w(sha1 md5 crc32).map!(&:to_sym).freeze
-
-    # Digests a file using an +algorithm+.
-    #
-    # Algorithms are expected include the Digest::Instance module.
-    #
-    #   OpenSSL::Digest::SHA1.include? Digest::Instance
-    #   => true
-    def self.digest_with(algorithm, filename)
-      digest = algorithm.new
-      File.open(filename, 'rb') do |file|
-        file.each_chunk do |chunk|
-          digest << chunk
-        end
-      end
-      digest.hexdigest!
-    end
+    algorithms = { sha1:  OpenSSL::Digest::SHA1,
+                   md5:   OpenSSL::Digest::MD5,
+                   crc32: Safeguard::Digest::CRC32 }.freeze
 
-    private_class_method :digest_with
+    SUPPORTED_ALGORITHMS = algorithms.keys.freeze
 
-    # Computes the SHA1 sum of the given file.
-    def self.sha1(*args)
-      digest_with OpenSSL::Digest::SHA1, *args
+    # Define one method for every supported algorithm.
+    algorithms.each do |algorithm, digest_class|
+      define_singleton_method algorithm do |*args|
+        digest_with digest_class, *args
+      end
     end
 
-    # Computes the MD5 sum of the given file.
-    def self.md5(*args)
-      digest_with OpenSSL::Digest::MD5, *args
-    end
+    # The class methods.
+    class << self
+
+      # Digests a file using an +algorithm+.
+      #
+      # Algorithms are expected include the Digest::Instance module.
+      #
+      #   OpenSSL::Digest::SHA1.include? Digest::Instance
+      #   => true
+      def digest_with(algorithm, filename)
+        digest = algorithm.new
+        File.open(filename, 'rb') do |file|
+          file.each_chunk do |chunk|
+            digest << chunk
+          end
+        end
+        digest.hexdigest!
+      end
 
-    # Computes the CRC32 sum of the given file.
-    def self.crc32(*args)
-      # Read file in binary mode. Doesn't make any difference in *nix, but Ruby
-      # will attempt to convert line endings if the file is opened in text mode
-      # in other platforms.
-      digest_with Safeguard::Digest::CRC32, *args
-    end
+      # Digests a file using a hash function, which can be the symbol of any
+      # Digest module method that takes a file. Uses SHA1 by default.
+      #
+      #   Safeguard::Digest.file(file, :md5)
+      #
+      # Is equivalent to:
+      #
+      #   Safeguard::Digest.md5(file)
+      def file(file, hash_function = :sha1)
+        hash_function = hash_function.to_sym
+        unless respond_to? hash_function
+          raise ArgumentError, "Unsupported hash function: #{hash_function}"
+        end
+        send hash_function, file
+      end
 
-    # Digests a file using a hash function, which can be the symbol of any
-    # Digest module method that takes a file. Uses SHA1 by default.
-    #
-    #   Safeguard::Digest.file(file, :md5)
-    #
-    # Is equivalent to:
-    #
-    #   Safeguard::Digest.md5(file)
-    def self.file(file, hash_function = :sha1)
-      f = hash_function.to_sym
-      raise ArgumentError, "Unsupported hash function: #{f}" unless respond_to? f
-      send hash_function, file
     end
 
   end

data/lib/safeguard/hasher.rb

@@ -1,11 +1,12 @@
 require 'safeguard/digest'
+require 'safeguard/worker'
 require 'ribbon'
 require 'ribbon/core_ext/array'
 
 module Safeguard
 
   # Hashes a set of files.
-  class Hasher
+  class Hasher < Worker
 
     # The files which will be hashed.
     attr_accessor :files
@@ -13,6 +14,9 @@ module Safeguard
     # The hash functions to use.
     attr_accessor :functions
 
+    # Available callbacks.
+    has_callbacks :before_hashing, :after_hashing
+
     # Initializes a new hasher with the given files. Last argument can be an
     # options hash or ribbon which specifies the hash functions to use:
     #
@@ -20,12 +24,13 @@ module Safeguard
     #   Hasher.new *files, :functions => :sha1
     #   Hasher.new *files, :functions => [ :sha1, :md5, :crc32 ]
     def initialize(*args)
-      ribbon = args.extract_options_as_ribbon!
-      funcs = ribbon.functions? do
+      options = args.extract_ribbon!
+      funcs = options.functions? do
         raise ArgumentError, 'No hash functions specified'
       end
       self.functions = [*funcs]
       self.files = args
+      initialize_callbacks_from options
     end
 
     # Calculates the hash of each file. Updates the cached hash results.
@@ -33,7 +38,9 @@ module Safeguard
       results = Ribbon.new
       files.each do |file|
         functions.each do |function|
-          results[file][function] = Safeguard::Digest.file file, function
+          call_callback before_hashing, file, function
+          results[file][function] = result = Safeguard::Digest.file file, function
+          call_callback after_hashing, file, function, result
         end
       end
       results = Ribbon[results]

data/lib/safeguard/output/terminal.rb

@@ -0,0 +1,74 @@
+require 'safeguard/core_ext/module'
+require 'i18n'
+
+module Safeguard
+  module Output
+
+    # Encapsulates all terminal output.
+    module Terminal
+
+      class << self
+
+        # Appends the given +key+ to this module's translation key and forwards
+        # all other arguments to <tt>I18n.translate</tt>.
+        def translate(key, *args)
+          I18n.t translation_key(key), *args
+        end
+
+        # Prints a string before a file is verified without a new line.
+        def before_verifying(file, function)
+          options = { file: file, function: function }
+          print translate(:before_verifying, preprocess(options))
+        end
+
+        # Prints a string before a file is hashed without a new line.
+        def before_hashing(file, function)
+          options = { file: file, function: function }
+           print translate(:before_hashing, preprocess(options))
+        end
+
+        # Prints a string after a file is hashed with a new line.
+        def after_hashing(file, function, hash)
+          options = { file: file, function: function, hash: hash }
+          puts translate(:after_hashing, preprocess(options))
+        end
+
+        # Prints a string after a file is verified with a new line.
+        def after_verifying(file, function, result)
+          options = { file: file, function: function, result: result }
+          puts translate(:after_verifying, preprocess(options))
+        end
+
+        # Creates an options ribbon containing containing mappings to this
+        # class' methods.
+        def create_mappings_for(*keys)
+          options = Ribbon.new
+          keys.each { |key| options[key] = method key }
+          options
+        end
+
+        def initialized_repository(directory)
+          options = { directory: directory }
+          puts translate(:initialized_repository, preprocess(options))
+        end
+
+        private
+
+        # Applies common preprocessing.
+        def preprocess(options = {})
+          options[:function] &&= options[:function].to_s.upcase
+          options[:result] &&= case result = options[:result]
+            when false, nil then :Mismatch
+            when true then :OK
+            else translate result
+          end
+          options
+        end
+
+      end
+
+
+    end
+
+  end
+end

data/lib/safeguard/output.rb

@@ -0,0 +1,7 @@
+module Safeguard
+
+  # Encapsulates all output.
+  module Output
+  end
+
+end

data/lib/safeguard/repository/hash_table.rb

@@ -11,6 +11,7 @@ module Safeguard
 
       # Initializes this hash table with the contents of the given Ribbon.
       def initialize(ribbon = nil, &block)
+        ribbon = ribbon.ribbon if self.class === ribbon
         merge! ribbon, &block if ribbon
       end
 
@@ -27,14 +28,47 @@ module Safeguard
       end
 
       # Merges this hash table's data with the other's.
-      def merge!(other)
-        other = other.ribbon if other.is_a? HashTable
-        Ribbon.deep_merge! ribbon, other
+      def merge!(other, &block)
+        ribbon.deep_merge! other, &block
+      end
+
+      # Fetches a value. Same as Hash#fetch.
+      def fetch(*args, &block)
+        ribbon.fetch *args, &block
       end
 
       # Looks up the checksum data for the given +filename+.
       def [](filename)
-        ribbon[filename]
+        ribbon.ribbon[filename]
+      end
+
+      # Adds a file to the hash table.
+      #
+      # The file will not have any hash information associated with it.
+      def add(*filenames)
+        filenames.each { |filename| self[filename] }
+      end
+
+      # Same as #add, but returns +self+.
+      def <<(filename)
+        add filename
+        self
+      end
+
+      # Returns whether or not the given file is present in this hash table.
+      def has_file?(filename)
+        ribbon.has_key? filename
+      end
+
+      # Returns whether the given file has any hash information associated.
+      def has_hashes?(filename, *functions)
+        has_file?(filename) and not self[filename].empty?
+      end
+
+      # Returns whether the given file has a hash associated with the function
+      # stored.
+      def has_hash?(filename, function)
+        has_file?(filename) and self[filename].fetch function, nil
       end
 
       # Returns a list of files present in this hash table.
@@ -45,7 +79,12 @@ module Safeguard
       # The underlying wrapped ribbon used to store filenames and their
       # associated hashes.
       def ribbon
-        @ribbon ||= Ribbon::Wrapper.new
+        (@ribbon ||= Ribbon::Wrapper.new).tap do |ribbon|
+          # TODO: Possible bottleneck here. #wrap_all! is a recursive call.
+          # Keep its usage localized instead of calling it on every access?
+          # Once after every modification, perhaps?
+          ribbon.wrap_all!
+        end
       end
 
     end

data/lib/safeguard/repository.rb

@@ -53,14 +53,22 @@ module Safeguard
       save_hash_table
     end
 
+    # Adds the given files to the repository.
+    def add!(*files)
+      hash_table.add *files
+    end
+
     # Calculates the checksum of the given files and stores the results. +args+
     # will be used to instantiate a new Hasher.
-    def add_files!(*args)
-      ribbon = args.extract_ribbon!
-      hasher = Hasher.new *args, ribbon
+    #
+    # By default, the hashes of files already in the repository will not be
+    # recalculated. To force that, call with <tt>:force => true</tt>.
+    def hash_and_add!(*args)
+      options = args.extract_ribbon!
+      hasher = Hasher.new *args, options
       hasher.files.delete_if do |file|
-        hash_table.files.include? file
-      end unless ribbon.force?
+        hasher.functions.any? { |function| hash_table.has_hash? file, function }
+      end unless options.force?
       results = hasher.results
       hash_table.merge! results
     end
@@ -71,7 +79,7 @@ module Safeguard
     end
 
     # Creates a verifier using this repository's hash table.
-    def create_verifier_with(*args)
+    def create_verifier_for(*args)
       ribbon = args.extract_wrapped_ribbon!
       Verifier.new *args, ribbon.merge!(hash_table: hash_table)
     end
@@ -79,7 +87,7 @@ module Safeguard
     # Recalculates the checksum of the given files and compares them to the
     # stored values. +args+ will be used to instantiate a new Verifier.
     def verify_files(*args)
-      create_verifier_with(*args).results
+      create_verifier_for(*args).results
     end
 
     # Returns the path to the repository relative to the given +dir+.

data/lib/safeguard/verifier.rb

@@ -1,12 +1,13 @@
 require 'safeguard/hasher'
 require 'safeguard/repository/hash_table'
+require 'safeguard/worker'
 require 'ribbon'
 require 'ribbon/core_ext/array'
 
 module Safeguard
 
   # Rehashes a set of files and compares the results to the stored hashes.
-  class Verifier
+  class Verifier < Worker
 
     # The hasher used to calculate the checksum of the files.
     attr_accessor :hasher
@@ -14,6 +15,9 @@ module Safeguard
     # Hash table to compare results against.
     attr_accessor :hash_table
 
+    # Available callbacks.
+    has_callbacks :before_verifying, :after_verifying
+
     # Initializes a new verifier with the given files. Last argument can be an
     # options hash or ribbon which specifies the hash table to verify against
     # and the Hasher to use. If a hasher isn't specified, a new one will be
@@ -28,17 +32,16 @@ module Safeguard
     #   Verifier.new :functions => [ :crc32, :md5 ], :hash_table => table
     #   Verifier.new *files, :functions => :crc32, :hash_table => table
     def initialize(*args)
-      ribbon = args.extract_ribbon!
-      table = ribbon.hash_table? do
+      options = args.extract_ribbon!
+      table = options.hash_table? do
         raise ArgumentError, 'No hash table to verify against'
       end
-      table = table.ribbon if Repository::HashTable === table
-      self.hash_table = Ribbon[table]
-      hash_table.wrap_all!
-      args = hash_table.keys if args.empty?
-      self.hasher = ribbon.hasher? do
-        Hasher.new *args, ribbon
+      self.hash_table = Repository::HashTable.new table
+      args = hash_table.files if args.empty?
+      self.hasher = options.hasher? do
+        Hasher.new *args, options
       end
+      initialize_callbacks_from options
     end
 
     # Uses the hasher to recalculate the hashes of the files using the specified
@@ -52,8 +55,9 @@ module Safeguard
       results = Ribbon.new
       hasher.each do |file, hash_data|
         hasher.functions.each do |function|
-          results[file][function] = if hash_table.has_key? file
-            if hash_table[file].has_key? function
+          call_callback before_verifying, file, function
+          results[file][function] = result = if hash_table.has_file? file
+            if hash_table.has_hash? file, function
               hash_data[function] == hash_table[file][function]
             else
               :hash_missing
@@ -61,6 +65,7 @@ module Safeguard
           else
             :file_missing
           end
+          call_callback after_verifying, file, function, result
         end
       end
       results = Ribbon[results]

data/lib/safeguard/version.rb

@@ -11,12 +11,12 @@ module Safeguard
     # Minor version.
     #
     # Increments denote backward-compatible changes and additions.
-    MINOR = 0
+    MINOR = 1
 
     # Patch version.
     #
     # Increments denote changes in implementation.
-    PATCH = 3
+    PATCH = 0
 
     # Build version.
     #

data/lib/safeguard/worker.rb

@@ -0,0 +1,56 @@
+require 'ribbon'
+
+module Safeguard
+
+  # Something that works behind the scenes, possibly talking to an user
+  # interface in the middle of it through callbacks.
+  class Worker
+
+    class << self
+
+      # All callbacks defined for this class.
+      def callbacks
+        @callbacks ||= []
+      end
+
+      # Defines callbacks for this class.
+      def has_callback(*names)
+        callbacks.push *names
+        names.map(&:to_sym).each do |callback|
+          iv_name = callback.to_s.prepend('@').to_sym
+          define_method callback do |&block|
+            assign_callback iv_name, &block
+          end
+        end
+      end
+
+      # Same as +has_callback+.
+      alias has_callbacks has_callback
+
+    end
+
+    protected
+
+    # Calls the given callback, passing it the rest of the arguments.
+    def call_callback(block, *args)
+      block.call *args if block.respond_to? :call
+    end
+
+    def initialize_callbacks_from(options)
+      options = Ribbon.wrap options
+      self.class.callbacks.each do |callback|
+        send callback, &options.fetch(callback, nil)
+      end
+    end
+
+    private
+
+    # Sets the callback to the given variable name if the block responds to
+    # +call+.
+    def assign_callback(name, &block)
+      instance_variable_set name, block if block.respond_to? :call
+      instance_variable_get name
+    end
+
+  end
+end

data/lib/safeguard.rb

@@ -1,16 +1,49 @@
-require 'safeguard/command'
-require 'safeguard/digest'
-require 'safeguard/hasher'
-require 'safeguard/repository'
-require 'safeguard/verifier'
-require 'safeguard/version'
+require 'i18n'
 
 # Safeguard module.
 module Safeguard
 
-  # Run a command by name with the given arguments.
-  def self.run(command, *args)
-    Command.invoke(command, *args)
+  class << self
+
+    # Run a command by name with the given arguments.
+    def run(*args)
+      initialize_i18n
+      Command.run *args
+    end
+
+    # Returns the version of Safeguard.
+    def version
+      Version::STRING
+    end
+
+    # Where the Safeguard installation is located.
+    def root
+      File.expand_path '../..', __FILE__
+    end
+
+    # Directory where translations are kept.
+    def i18n
+      File.join root, 'i18n'
+    end
+
+    # Array of translation files.
+    def translation_files
+      Dir[File.join(i18n, '*')]
+    end
+
+    def initialize_i18n
+      I18n.load_path = translation_files
+    end
+
   end
 
 end
+
+require 'safeguard/command'
+require 'safeguard/digest'
+require 'safeguard/hasher'
+require 'safeguard/output'
+require 'safeguard/repository'
+require 'safeguard/verifier'
+require 'safeguard/version'
+require 'safeguard/worker'

data/safeguard.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new('safeguard') do |gem|
 
   gem.add_runtime_dependency 'acclaim'
   gem.add_runtime_dependency 'ribbon'
+  gem.add_runtime_dependency 'i18n'
 
   gem.add_development_dependency 'rookie'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safeguard
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-12 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acclaim
-  requirement: &6175680 !ruby/object:Gem::Requirement
+  requirement: &18215560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *6175680
+  version_requirements: *18215560
 - !ruby/object:Gem::Dependency
   name: ribbon
-  requirement: &6174640 !ruby/object:Gem::Requirement
+  requirement: &18215080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *6174640
+  version_requirements: *18215080
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &18214540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18214540
 - !ruby/object:Gem::Dependency
   name: rookie
-  requirement: &6174080 !ruby/object:Gem::Requirement
+  requirement: &18214080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6174080
+  version_requirements: *18214080
 description: Hash-based file integrity verification utility
 email: matheus.a.m.moreira@gmail.com
 executables:
@@ -58,20 +69,27 @@ files:
 - README.markdown
 - Rakefile
 - bin/safeguard
+- i18n/en.yml
+- i18n/pt.yml
 - lib/safeguard.rb
 - lib/safeguard/command.rb
 - lib/safeguard/command/add.rb
+- lib/safeguard/command/add/hash.rb
 - lib/safeguard/command/hash.rb
 - lib/safeguard/command/init.rb
 - lib/safeguard/command/verify.rb
 - lib/safeguard/core_ext/file.rb
+- lib/safeguard/core_ext/module.rb
 - lib/safeguard/digest.rb
 - lib/safeguard/digest/crc32.rb
 - lib/safeguard/hasher.rb
+- lib/safeguard/output.rb
+- lib/safeguard/output/terminal.rb
 - lib/safeguard/repository.rb
 - lib/safeguard/repository/hash_table.rb
 - lib/safeguard/verifier.rb
 - lib/safeguard/version.rb
+- lib/safeguard/worker.rb
 - safeguard.gemspec
 homepage: https://github.com/matheusmoreira/safeguard
 licenses: []
@@ -87,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -397877248667330061
+      hash: -537913789085051653
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -397877248667330061
+      hash: -537913789085051653
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10