image_finder 0.0.1.beta

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in image_finder.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/image_finder.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "image_finder/version"
+
+Gem::Specification.new do |s|
+  s.name        = "image_finder"
+  s.version     = ImageFinder::VERSION
+  s.authors     = ["psylone"]
+  s.email       = ["spaceflow@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Find corrupted images}
+  s.description = %q{For models with images uploaded by PaperClip You can find corrupted ones}
+
+  s.rubyforge_project = "image_finder"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('paperclip', '>= 2.3.11')
+  s.add_dependency('activesupport', '>= 3.0.0')
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/image_finder/crawler.rb

@@ -0,0 +1,44 @@
+require 'logger'
+
+module ImageFinder
+  class Crawler
+
+    # write_to_original means that corrupted image of :original style and
+    # we can't repair it
+    attr_accessor :write_to_original, :logger
+
+    def initialize model_name, batch_size = 500, start = nil
+      @batch_size = batch_size
+      @start = start
+      @model_name = model_name
+      @fields = get_image_fields @model_name
+      @logger = Logger.new @model_name
+    end
+
+    # Interface
+
+    def find_corrupted
+      klass = get_klass @model_name
+      klass.find_in_batches(batch_size: @batch_size, start: @start) do |group|
+        puts "Processing new objects batch"
+        for object in group
+          image_status object rescue logger.std.write object
+        end
+        puts "Batch was successful processed with last object id = #{object.id} of #{klass_name} class"
+      end
+    end
+
+    def image_status object
+      @fields.each do |field, styles|
+        @write_to_original = false
+        styles.each do |style|
+          next unless object.send "#{field}?" # next if object hasn't image
+          handle object, field, style, use_log: true
+        end
+      end
+    end
+
+    # Realization
+
+  end
+end

data/lib/image_finder/handler.rb

@@ -0,0 +1,30 @@
+module ImageFinder
+  module Handler
+    def handle object, field, style, options = {}
+      use_log = options[:use_log] || false
+      path = get_image_path object, field, style
+      status = check_image_consistency path
+      exitcode = $?.exitstatus
+      case [ status, exitcode ]
+        when [ true, 0 ]
+          "Image was successfully open"
+        when [ false, 1 ]
+          return logger.std.write object, field, style unless use_log
+          @write_to_original = true if style == :original
+          if write_to_original
+            logger.corrupted.write object, field, style
+          else
+            logger.recoverable.write object, field, style
+          end
+        when [ false, 127 ]
+          raise "Command not found: #{$?}"
+        else
+          raise "Unknown error type for ImageFinder: #{$?}"
+      end
+    end
+
+    def check_image_consistency path
+      system %Q[identify "#{path}" >/dev/null 2>&1]
+    end
+  end
+end

data/lib/image_finder/helpers/get_image_fields.rb

@@ -0,0 +1,11 @@
+require 'yaml'
+
+module ImageFinder
+  module Helpers
+    module GetImageFields
+      def get_image_fields model_name
+        YAML.load_file(File.join File.dirname(__FILE__), '..', '..', PAPERCLIP_FILE_NAME)[model_name]
+      end
+    end
+  end
+end

data/lib/image_finder/helpers/get_image_path.rb

@@ -0,0 +1,9 @@
+module ImageFinder
+  module Helpers
+    module GetImagePath
+      def get_image_path object, field, style
+        object.send(field).path style
+      end
+    end
+  end
+end

data/lib/image_finder/helpers/get_klass.rb

@@ -0,0 +1,11 @@
+require 'active_support/core_ext'
+
+module ImageFinder
+  module Helpers
+    module GetKlass
+      def get_klass name
+        name.to_s.camelize.constantize
+      end
+    end
+  end
+end

data/lib/image_finder/helpers.rb

@@ -0,0 +1,8 @@
+require 'image_finder/helpers/get_klass'
+require 'image_finder/helpers/get_image_fields'
+require 'image_finder/helpers/get_image_path'
+
+module ImageFinder
+  module Helpers
+  end
+end

data/lib/image_finder/logger.rb

@@ -0,0 +1,63 @@
+module ImageFinder
+  class Logger
+
+    def initialize model_name
+      @corrupted = init_logger model_name, :corrupted
+      @recoverable = init_logger model_name, :recoverable
+      @std = init_logger
+    end
+
+    # Interface
+
+    def write object, field = nil, style = nil
+      @current.warn log_entry(object, field, style)
+    end
+
+    # Need to refactor this horror
+    def corrupted
+      @current = @corrupted
+      self
+    end
+    def recoverable
+      @current = @recoverable
+      self
+    end
+    def std
+      @current = @std
+      self
+    end
+
+    # Realization
+
+    def init_logger model_name = $stdout, type = nil
+      path = logger_path(model_name, type)
+      if path.is_a? Pathname
+        dir = path.dirname
+        FileUtils.mkdir_p dir unless File.exists? dir
+      end
+      ::Logger.new path
+    end
+
+    # model_name = STDOUT if type is nil
+    def logger_path model_name, type
+      type == nil ? model_name : base_path.join(model_name.to_s.pluralize, logger_type(type)) # logger_type type sounds bad, need to change it
+    end
+
+    def logger_type type
+      type.to_s.concat '.log'
+    end
+
+    def base_path
+      LogPath.get_path
+    end
+
+    def log_entry object, field, style
+      if field
+        "#{object.class.name}.#{field} was corrupted: {id: #{object.id}, style: #{style}, path: #{get_image_path object, field, style}}"
+      else
+        "RuntimeError (#{$?}): #{object.class.name} = #{object.id}"
+      end
+    end
+
+  end
+end

data/lib/image_finder/version.rb

@@ -0,0 +1,3 @@
+module ImageFinder
+  VERSION = "0.0.1.beta"
+end

data/lib/image_finder.rb

@@ -0,0 +1,38 @@
+require "image_finder/version"
+require "image_finder/crawler"
+require "image_finder/helpers"
+require "image_finder/handler"
+require "image_finder/logger"
+
+# TODO Maybe it's possible to require entire custom rails application and run ImageFinder from bash
+
+module ImageFinder
+  class Crawler
+    include Helpers::GetKlass
+    include Helpers::GetImageFields
+    include Helpers::GetImagePath
+    include Handler
+  end
+
+  class Logger
+    include Helpers::GetKlass
+    include Helpers::GetImagePath
+  end
+
+  class LogPath < Rails::Railtie
+    config.after_initialize do
+      LOG_PATH = Rails.root.join '..', '..', 'shared', 'log', 'corrupted_images'
+    end
+
+    def self.get_path
+      LOG_PATH
+    end
+  end
+
+  module Helpers
+    module GetImageFields
+      PAPERCLIP_FILE_NAME = 'paperclip_fields.yml'
+    end
+  end
+end
+

data/lib/paperclip_fields.yml

@@ -0,0 +1,57 @@
+---
+:user:
+  :avatar:
+    - :original
+    - :small
+    - :mini
+    - :thumb
+  :logo_company_1:
+    - :original
+    - :normal
+  :logo_company_2:
+    - :original
+    - :normal
+  :logo_company_3:
+    - :original
+    - :normal
+:clan:
+  :avatar:
+    - :original
+    - :small
+    - :mini
+    - :thumb
+:calendar_event:
+  :logo:
+    - :original
+    - :thumb
+    - :small
+:game:
+  :logo:
+    - :original
+    - :thumb
+  :logo_company_1:
+    - :original
+    - :small
+    - :mini
+    - :thumb
+  :logo_company_2:
+    - :original
+    - :small
+    - :mini
+    - :thumb
+  :top:
+    - :original
+  :toptop:
+    - :original
+  :center:
+    - :original
+  :bottom:
+    - :original
+  :center_clear:
+    - :original
+:attached_image:
+  :image:
+    - :original
+    - :small
+    - :thumb
+    - :normal

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: image_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta
+  prerelease: 6
+platform: ruby
+authors:
+- psylone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: &79778290 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+  type: :runtime
+  prerelease: false
+  version_requirements: *79778290
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &79777910 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *79777910
+description: For models with images uploaded by PaperClip You can find corrupted ones
+email:
+- spaceflow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- image_finder.gemspec
+- lib/image_finder.rb
+- lib/image_finder/crawler.rb
+- lib/image_finder/handler.rb
+- lib/image_finder/helpers.rb
+- lib/image_finder/helpers/get_image_fields.rb
+- lib/image_finder/helpers/get_image_path.rb
+- lib/image_finder/helpers/get_klass.rb
+- lib/image_finder/logger.rb
+- lib/image_finder/version.rb
+- lib/paperclip_fields.yml
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: image_finder
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Find corrupted images
+test_files: []
+has_rdoc: