Contents

module IconGenerator
    # Module intended to be used as a convenient mixin.
    #
    # @example Including the validator in a class
    #    class Foo
    #        include IconGenerator::Validator
    #        # Now you can use validate_arguments and
    #        # validate_file_status as if they were your very own.
    #    end
    module Validator
        # Validates the given source image file and the destination
        # directory for correctness.
        #
        # @param source [String] the source image file
        # @param destination [String] the output directory
        def validate_arguments(source, destination)
            raise IconGenerator::Error, '1st argument must be a valid image' unless source.match /\.gif$|\.jpg$|\.png$/
            raise IconGenerator::Error, '1st argument must be an existing file' unless File.exists? source
            raise IconGenerator::Error, '2nd argument must be an existing directory' unless Dir.exists? destination
        end

        # Validates the existence of the given file.
        #
        # @param filename [String] the file being tested for existence
        def validate_file_status(filename)
            raise IconGenerator::Error unless File.exists? filename
        end
    end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
icon_generator-0.10.1	lib/icon_generator/validator.rb
icon_generator-0.10.0	lib/icon_generator/validator.rb
icon_generator-0.9.0	lib/icon_generator/validator.rb
icon_generator-0.8.1	lib/icon_generator/validator.rb