class ImgChecker

img_checker ruby gem This gem checks for images which exceept the specified limit in the img_config.yml file. Authored by Abishek V Ashok and Ankit R Gadiya of FOSSASIA

img_checker 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.

img_checker 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 this program. If not, see <www.gnu.org/licenses/>.

Public Class Methods

new(config_file) click to toggle source

# File lib/img_checker/img_checker.rb, line 20
def initialize(config_file)
  require_relative 'version'
  puts "Starting Image Checker version #{VERSION::STRING}"

  # Initialize the config file
  require 'yaml'
  @config = YAML.load(File.open(config_file))
  # This int is to count the number of big images that exceed the specified
  # widthor height
  @big_images = 0
end

Public Instance Methods

check_dimensions?(image, width, height) click to toggle source

Check the image dimensions

# File lib/img_checker/img_checker.rb, line 33
def check_dimensions?(image, width, height)
  require 'fastimage'
  image_size = FastImage.size(image)
  if image_size[0] > width || image_size[1] > height
    puts "The image #{image} is larger than #{width}px x #{height}px [w x h]"
    @big_images += 1
    return false
  end
  true
end

check_images?() click to toggle source

# File lib/img_checker/img_checker.rb, line 44
def check_images?
  valid_sizes = true
  # For each direcotry hash do
  @config.each do |dir_config|
    # Get the directory path, height and width from the config file
    directory = Dir[dir_config['directory']]
    height = dir_config['height']
    width = dir_config['width']
    directory.each do |image|
      valid_sizes = false unless check_dimensions?(image, width, height)
    end
  end
  valid_sizes
end

ok?() click to toggle source

# File lib/img_checker/img_checker.rb, line 59
def ok?
  if check_images?
    puts 'All images are ok... Hurray!'
  else
    big_images = @big_images
    puts 'Image Checker: These images exceeds the specified dimensions'
    abort "#{big_images} image(s) have greater dimensions then specified."
    return false
  end
  true
end