Class: ImageOptim

Inherits:
Object
  • Object
show all
Defined in:
lib/image_optim.rb,
lib/image_optim/cmd.rb,
lib/image_optim/space.rb,
lib/image_optim/config.rb,
lib/image_optim/runner.rb,
lib/image_optim/worker.rb,
lib/image_optim/handler.rb,
lib/image_optim/railtie.rb,
lib/image_optim/image_meta.rb,
lib/image_optim/image_path.rb,
lib/image_optim/worker/svgo.rb,
lib/image_optim/bin_resolver.rb,
lib/image_optim/hash_helpers.rb,
lib/image_optim/worker/jhead.rb,
lib/image_optim/worker/advpng.rb,
lib/image_optim/worker/pngout.rb,
lib/image_optim/option_helpers.rb,
lib/image_optim/true_false_nil.rb,
lib/image_optim/worker/optipng.rb,
lib/image_optim/worker/gifsicle.rb,
lib/image_optim/worker/jpegtran.rb,
lib/image_optim/worker/pngcrush.rb,
lib/image_optim/worker/pngquant.rb,
lib/image_optim/bin_resolver/bin.rb,
lib/image_optim/worker/jpegoptim.rb,
lib/image_optim/option_definition.rb,
lib/image_optim/bin_resolver/error.rb,
lib/image_optim/configuration_error.rb,
lib/image_optim/runner/glob_helpers.rb,
lib/image_optim/runner/option_parser.rb,
lib/image_optim/worker/class_methods.rb,
lib/image_optim/worker/jpegrecompress.rb,
lib/image_optim/non_negative_integer_range.rb,
lib/image_optim/bin_resolver/simple_version.rb,
lib/image_optim/bin_resolver/comparable_condition.rb

Overview

Main interface

Defined Under Namespace

Modules: Cmd, HashHelpers, OptionHelpers, Space Classes: BinResolver, Config, ConfigurationError, Handler, ImageMeta, ImagePath, NonNegativeIntegerRange, OptionDefinition, Railtie, Runner, TrueFalseNil, Worker

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ImageOptim

Initialize workers, specify options using worker underscored name:

pass false to disable worker

ImageOptim.new(:pngcrush => false)

or hash with options to worker

ImageOptim.new(:advpng => {:level => 3}, :optipng => {:level => 2})

use :threads to set number of parallel optimizers to run (passing true or nil determines number of processors, false disables parallel processing)

ImageOptim.new(:threads => 8)

use :nice to specify optimizers nice level (true or nil makes it 10, false makes it 0)

ImageOptim.new(:nice => 20)



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/image_optim.rb', line 59

def initialize(options = {})
  config = Config.new(options)
  @verbose = config.verbose
  $stderr << "config:\n#{config.to_s.gsub(/^/, '  ')}" if verbose

  %w[
    nice
    threads
    pack
    skip_missing_workers
    allow_lossy
  ].each do |name|
    instance_variable_set(:"@#{name}", config.send(name))
    $stderr << "#{name}: #{send(name)}\n" if verbose
  end

  @bin_resolver = BinResolver.new(self)

  @workers_by_format = Worker.create_all_by_format(self) do |klass|
    config.for_worker(klass)
  end

  log_workers_by_format if verbose

  config.assert_no_unused_options!
end

Instance Attribute Details

#allow_lossy ⇒ Object (readonly)

Allow lossy workers and optimizations



38
39
40
 
# File 'lib/image_optim.rb', line 38

def allow_lossy
  @allow_lossy
end

#nice ⇒ Object (readonly)

Nice level



23
24
25
 
# File 'lib/image_optim.rb', line 23

def nice
  @nice
end

#pack ⇒ Object (readonly)

Use image_optim_pack



32
33
34
 
# File 'lib/image_optim.rb', line 32

def pack
  @pack
end

#skip_missing_workers ⇒ Object (readonly)

Skip workers with missing or problematic binaries



35
36
37
 
# File 'lib/image_optim.rb', line 35

def skip_missing_workers
  @skip_missing_workers
end

#threads ⇒ Object (readonly)

Number of threads to run with



26
27
28
 
# File 'lib/image_optim.rb', line 26

def threads
  @threads
end

#verbose ⇒ Object (readonly)

Verbose output?



29
30
31
 
# File 'lib/image_optim.rb', line 29

def verbose
  @verbose
end

Class Method Details

.full_version ⇒ Object

Full version of image_optim



170
171
172
 
# File 'lib/image_optim.rb', line 170

def self.full_version
  "image_optim v#{version}"
end

.method_missing(method, *args, &block) ⇒ Object

Optimization methods with default options



156
157
158
159
160
161
162
 
# File 'lib/image_optim.rb', line 156

def self.method_missing(method, *args, &block)
  if method_defined?(method) && method.to_s =~ /^optimize_image/
    new.send(method, *args, &block)
  else
    super
  end
end

.version ⇒ Object

Version of image_optim gem spec loaded



165
166
167
 
# File 'lib/image_optim.rb', line 165

def self.version
  Gem.loaded_specs['image_optim'].version.to_s rescue 'DEV'
end

Instance Method Details

#env_path ⇒ Object

Join resolve_dir, default path and vendor path for PATH environment variable



186
187
188
 
# File 'lib/image_optim.rb', line 186

def env_path
  @bin_resolver.env_path
end

#optimizable?(path) ⇒ Boolean

Are there workers for file at path?

Returns:

  • (Boolean) 


175
176
177
 
# File 'lib/image_optim.rb', line 175

def optimizable?(path)
  !!workers_for_image(path)
end

#optimize_image(original) ⇒ Object

Optimize one file, return new path as OptimizedImagePath or nil if optimization failed



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/image_optim.rb', line 93

def optimize_image(original)
  original = ImagePath.convert(original)
  return unless (workers = workers_for_image(original))
  result = Handler.for(original) do |handler|
    workers.each do |worker|
      handler.process do |src, dst|
        worker.optimize(src, dst)
      end
    end
  end
  return unless result
  ImagePath::Optimized.new(result, original)
end

#optimize_image!(original) ⇒ Object

Optimize one file in place, return original as OptimizedImagePath or nil if optimization failed



109
110
111
112
113
114
 
# File 'lib/image_optim.rb', line 109

def optimize_image!(original)
  original = ImagePath.convert(original)
  return unless (result = optimize_image(original))
  result.replace(original)
  ImagePath::Optimized.new(original, result.original_size)
end

#optimize_image_data(original_data) ⇒ Object

Optimize image data, return new data or nil if optimization failed



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/image_optim.rb', line 117

def optimize_image_data(original_data)
  image_meta = ImageMeta.for_data(original_data)
  return unless image_meta && image_meta.format
  ImagePath.temp_file %W[image_optim .#{image_meta.format}] do |temp|
    temp.binmode
    temp.write(original_data)
    temp.close

    if (result = optimize_image(temp.path))
      result.binread
    end
  end
end

#optimize_images(paths, &block) ⇒ Object

Optimize multiple images if block given yields path and result for each image and returns array of yield results else return array of path and result pairs



135
136
137
 
# File 'lib/image_optim.rb', line 135

def optimize_images(paths, &block)
  run_method_for(paths, :optimize_image, &block)
end

#optimize_images!(paths, &block) ⇒ Object

Optimize multiple images in place if block given yields path and result for each image and returns array of yield results else return array of path and result pairs



143
144
145
 
# File 'lib/image_optim.rb', line 143

def optimize_images!(paths, &block)
  run_method_for(paths, :optimize_image!, &block)
end

#optimize_images_data(datas, &block) ⇒ Object

Optimize multiple image datas if block given yields original and result for each image data and returns array of yield results else return array of path and result pairs



151
152
153
 
# File 'lib/image_optim.rb', line 151

def optimize_images_data(datas, &block)
  run_method_for(datas, :optimize_image_data, &block)
end

#resolve_bin!(bin) ⇒ Object

Check existance of binary, create symlink if ENV contains path for key XXX_BIN where XXX is upper case bin name



181
182
183
 
# File 'lib/image_optim.rb', line 181

def resolve_bin!(bin)
  @bin_resolver.resolve!(bin)
end

#workers_for_image(path) ⇒ Object

Get workers for image



87
88
89
 
# File 'lib/image_optim.rb', line 87

def workers_for_image(path)
  @workers_by_format[ImagePath.convert(path).format]
end