image_voodoo 0.8.8 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 10db8a256e32e37a28b94c9246049f7029484a49
-  data.tar.gz: 27ec82a19aff0bc3171a2c0bff8338c1c7ef19e6
+SHA256:
+  metadata.gz: 432be5fdc3ce35d25ccec454aec40066f07f512fdf0d45891ecc49ff28e48368
+  data.tar.gz: cacc16a2c686344983bab91d9467ff8a80957f22db50ab037f54553bd1004823
 SHA512:
-  metadata.gz: 9bf960b9cd108f06ea22ba69a5f01f7d5ee3ca10dec63fe7a79cf6d2fe986f9a6753ef1969c8eabfa95af8509e0b19211b6ea7c0718d6106c42d998e255e6e36
-  data.tar.gz: 27e8b1a524c25f7a72b3b15c3a9e37e4bf983111410a8be64d78b45c55ce133ed185ec5cf47ab527b565828d106515fdf053ccc41ee0298b1b1b6df75fc923f3
+  metadata.gz: 421f317327a6d6ecb7c799cd1d4bee0a8a0193ce5f9395c55c2b642387d4fb8b6f62533255b565a5698d379c5ac91d19b0c0fc9fa7776116efee90c537ecf7dd
+  data.tar.gz: 2fe8bfed88aaa7645ed9eb240a652a0c47c095e72043f62dddfe5effcf415c3d833a2b5f6991ad852bb9a9bd06e4bd3363742807229c7efb0b227ab0b1d123af

data/.gitignore

@@ -1,2 +1,6 @@
 /pkg
 *~
+Gemfile.lock
+lib/image_voodoo_jars.rb
+lib/com
+.idea

data/.rubocop.yml

@@ -0,0 +1,165 @@
+# Experiment to tweak source based on what rubocop wanted me to.  I basically
+# gave up and made the following exceptions.  Personally, I find the tool did
+# find many interesting/questionable code Qs in the project but it is soooo
+# opinionated in pretty unimportant ways (like who cares how I write my
+# comments, or why can't I use kind_of? or why give me a fail for a less
+# readable but more performant pattern).
+#
+# I can obviously tweak rules (like below) but I keep hearing of people pulling
+# their hair out over all the unimportant rules; I question why this project is
+# "all-in" on it's rules versus leaving most of the style rules as some preset
+# profiles people can opt in to.
+#
+# So I am committing this and I will try and run this every now and then to
+# see what it thinks about what I wrote but you will not see this as a
+# requirement for commits since I think by the time I configured it to my
+# liking I could have finished implementing this library.  Perhaps if I
+# continue using this here and there I will end up with a profile I find
+# acceptable?  I did find value but all the piddly shit just made me angry.
+# I will reflect on it some more...
+
+# This is a Java AWT call.  It is not what the tool thinks it is...which
+# might be an issue for users interacting with Java from JRuby.
+Lint/UselessSetterCall:
+  Exclude:
+    - 'lib/image_voodoo/awt.rb'
+
+# This is just impossible for them to call properly.  I am doing something
+# like rotate_impl and it is a bunch of reasonably simple math.  If you look
+# for this transformation in a text book it will look like this code.  Putting
+# a bunch of math within different methods would get the score down but
+# it would not help readability. (addendum: I did try and break it apart more
+# and never reached 15 but got closer.  I felt this rule is neat but the
+# score really depends on what it is.
+Metrics/AbcSize:
+  Max: 16.5
+
+# This is triggered for correct_orientation_impl.  I could put these transforms
+# in a table and then execute lambdas for each orientation but this is much
+# more clear.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# A bunch of fields in a hash are basically generated data. Correcting them
+# for column seems much too pedantic.  I guess exclude is the right thing for
+# an unusual file?
+Layout/LineLength:
+  Max: 132
+  Exclude:
+    - 'lib/image_voodoo/metadata.rb'
+
+# Metadata classes have data in them.  awt.rb is big and perhaps could be
+# shrunk but it is not a hard file to navigate and the cleaving points are
+# not super obvious.  These sorts of rules feel very arbitrary and if I have
+# n highly related things and they do not fit into a more restrictive
+# taxonomy why would the file being longer matter?  I do understand the
+# motivation here but as a default rule this feels wrong to me.
+Metrics/ClassLength:
+  Max: 250
+
+# I do not find this very useful.  There is no performance difference and
+# sometimes I want to highlight this string does not involve interpolation.
+# Other times it is not worth pointing out.
+Style/StringLiterals:
+  Enabled: false
+
+# require 'english' is a step too far for $! which is so baked into my
+# head I do not want to change :)
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# I am grouping math and using lack of whitespace for separation.
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+# I prefer tight assignment for opt args.
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+# Java methods which override or implement Java method names cannot be switched
+# to snake case.  Do we really need this as a rule anyways?  I have never seen
+# a Rubyist do this as a preferred style?
+Naming/MethodName:
+  Enabled: false
+
+# bin/image_voodoo main options block.
+Metrics/BlockLength:
+  Exclude:
+    - 'bin/image_voodoo'
+
+# Hash rocket looks much more natural in a rakefile for its deps.
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+
+# Forget it.  I do parallel assignment and you will have to peel it out of
+# my cold dead hands.
+Style/ParallelAssignment:
+  Enabled: false
+
+# FIXME: consider keywords for shapes.
+# I might switch these to keyword args if I ever revisit shapes support.
+# In general lots of params do suck and are hard to remember.  This library
+# still is supposed to work in 1.8 but I can probably soon major rev this
+# and switch over to keywords.
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/image_voodoo/awt/shapes.rb'
+
+# This is complaining that 'x' and 'y' are bad names because they are less
+# than 3 chars.  Silly rule even if I appreciate what it is trying to
+# accomplish. Interestingly, in image_voodoo I do use h for height and
+# w for width.  Those probably could be written out but they are so common
+# I am basically opting for short-hand.  This is something I rarely do except
+# domain-driven code like this (x,y,h,w).
+Naming/MethodParameterName:
+  Enabled: false
+
+# This represents one of those frustrating dogmatic rules where if I followed
+# this advice I would then violate the column length rule.  I specifically
+# use traditional if indented block in cases where if_mod doesn't fit.
+# Gramatically, if_mod can be across two lines but I hate how that looks. The
+# second solution of logical &&/|| change for a raise is alien to for all but
+# assignment.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# What the hell.  Really telling people that encoding: utf-8 should not happen
+# because there are no multi-byte utf-8 characters in it?  Why add this noise?
+Style/Encoding:
+  Enabled: false
+
+# FIXME:
+# This is an unknown error which I should figure out.  It must be some
+# StandardError (which is what nothing explicit means) but I should actually
+# be more explicit here.
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/image_voodoo.rb'
+
+
+# This was complaining metadata_impl should use @metadata_impl instead of
+# @metadata.  I disagree and am unsure why I need to follow this programs
+# opinion on what a good name is?  What is commentable is if I change the
+# variable name to @gorgon it still tells me I need to use @metadata_impl.
+# So if I conditionally add any state in any method it will tell me I am
+# memoizing and have to use same ivar as the name of the method?  Is it more
+# sophisticated than that?  Should I have spent 2-3 minutes trying to figure
+# out how this rule was implemented? :)
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+# I have two modes of use for private.  If it is a small number of individual
+# methods I am explicit and inline the private.  If it is a large number of
+# methods especially when the name is fairly obvious that those will be private
+# (like render_impl) then I use block private.  Not sure telling me I can only
+# use a single style is very useful.
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+# I feel for the tiny amount of generation here a better name would not help
+# me understand it better.  This is one of those naming rules I feel is
+# probably helpful a minority of the time.  Also I have never been confused
+# by what a heredoc text represents because of my heredoc terminator?
+Naming/HeredocDelimiterNaming:
+  Enabled: false

data/.travis.yml

@@ -1,2 +1,17 @@
+language: ruby
+
+sudo: false
+
 rvm:
-  - jruby-19mode
+  - jruby-head
+
+before_install:
+  - mkdir rvm_tmp
+  - cd rvm_tmp
+
+before_script:
+  - cd ..
+  - git clone --depth 1 https://github.com/drewnoakes/metadata-extractor-images.git ../metadata-extractor-images
+
+install: JRUBY_OPTS=--dev jruby --dev -S bundle install --jobs=3 --retry=3
+

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Jars.lock

@@ -0,0 +1,3 @@
+org.yaml:snakeyaml:1.23:compile:
+com.drewnoakes:metadata-extractor:2.11.0:compile:
+com.adobe.xmp:xmpcore:5.1.3:compile:

data/Rakefile

@@ -1,13 +1,23 @@
+# frozen_string_literal: true
+
 require 'bundler'
 require 'rake/testtask'
+require 'jars/installer'
 Bundler::GemHelper.install_tasks
+Bundler.setup
+
+task :default => %i[vendor_jars test]
 
-task :default => :test
+desc 'Vendor Jars'
+task :vendor_jars do
+  test_file = File.expand_path File.join('lib', 'image_voodoo_jars.rb'), __dir__
+  Jars::Installer.vendor_jars! unless File.exist? test_file
+end
 
-desc "Run tests"
-task :test do
+desc 'Run tests'
+task :test => :vendor_jars do
   Rake::TestTask.new do |t|
-    t.libs << "lib:vendor"
+    t.libs << 'lib:vendor'
     t.test_files = FileList['test/test*.rb']
   end
 end

data/bin/image_voodoo

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #!/usr/bin/env ruby
 
 require 'optparse'
@@ -7,101 +9,91 @@ actions = []
 images = []
 original_image = nil
 
-opts = OptionParser.new do |opts|
-  opts.banner = "Usage: image_voodoo [actions] image_file"
-  opts.separator "Perform some actions on a source image."
-
-  opts.separator ""
-  opts.separator "Actions are meant to be chained. Examples:"
-  opts.separator "  # Print the dimensions"
-  opts.separator "  image_voodoo --dim small.jpg"
-  opts.separator ""
-  opts.separator "  # Convert to a thumbnail, preview, and then save the result"
-  opts.separator "  image_voodoo --thumbnail 50 --preview --save thumb.png large.jpg"
-  opts.separator ""
-  opts.separator "  # Convert source to 3 thumbnails, showing dimensions and"
-  opts.separator "  # previewing along the way"
-  opts.separator "  image_voodoo --dim --resize 50x50 --dim --preview --save t1.jpg"
-  opts.separator "    --pop --resize 40x40 --dim --preview --save t2.jpg"
-  opts.separator "    --pop --resize 30x30 --dim --preview --save t3.jpg image.jpg"
-
-  opts.separator ""
-  opts.separator "Actions:"
-
-  opts.on("-a", "--alpha color_value", "Make color transparent in image") do |c|
-    if c !~ /[[:xdigit:]]{6,6}/
-      opts.usage "color_value is rrggbb in hexidecimal format"
-    end
-    actions << lambda {|img| img.alpha(c) }
-  end
-
-  opts.on("-b", "--brightness SCALE,OFFSET", "Adjust brightness") do |args|
-    scale, offset = args.split(/,/).map {|v| v.to_f}
-    opts.usage "You need to specify proper scale and offset" unless scale && offset
-    actions << lambda {|img| img.adjust_brightness(scale, offset) }
-  end
-
-  opts.on("-B", "--border WIDTH,COLOR,STYLE", "Add a simple border") do |args|
+opts = OptionParser.new do |o|
+  o.banner = 'Usage: image_voodoo [actions] image_file'
+  o.separator 'Perform actions/transformations on an image.'
+  o.separator ''
+  o.separator 'Examples:'
+  o.separator '  image_voodoo --dim small.jpg     # Print the dimensions'
+  o.separator ''
+  o.separator '  # Make a thumbnail, preview it, and then save it.'
+  o.separator '  image_voodoo --thumbnail 50 --preview --save thumb.png large.jpg'
+  o.separator ''
+  o.separator '  # Make 2 thumbnails, showing dimensions and previewing them'
+  o.separator '  image_voodoo --dim --resize 50x50 --dim --preview --save t1.jpg'
+  o.separator '    --pop --resize 40x40 --dim --preview --save t2.jpg image.jpg'
+  o.separator ''
+  o.separator 'Actions:'
+
+  o.on('-a', '--alpha rrggbb', 'Make color transparent in image') do |c|
+    o.usage 'rrggbb is in hexidecimal format' if c !~ /[[:xdigit:]]{6,6}/
+    actions << ->(img) { img.alpha(c) }
+  end
+
+  o.on('-b', '--brightness SCALE,OFFSET', 'Adjust brightness') do |args|
+    scale, offset = args.split(/,/).map(&:to_f)
+    o.usage 'You need to specify proper scale and offset' unless scale && offset
+    actions << ->(img) { img.adjust_brightness(scale, offset) }
+  end
+
+  o.on('-B', '--border WIDTH,COLOR,STYLE', 'Add a simple border') do |args|
     width, color, style = args.split(/,/)
-    options = {:width => width, :color => color, :style => style }
-
-    actions << lambda {|img| img.add_border(options) }
+    options = { width: width, color: color, style: style }
+    actions << ->(img) { img.add_border(options) }
   end
 
-  opts.on("-d", "--dimensions", "Print the image dimensions") do
-    actions << lambda {|img| puts "#{img.width}x#{img.height}"; img }
+  o.on('-d', '--dimensions', 'Print the image dimensions') do
+    actions << ->(img) { img.tap { puts "#{img.width}x#{img.height}" } }
   end
 
-  opts.on("-g", "--greyscale", "Convert image to greyscale") do
-    actions << lambda {|img| img.greyscale }
+  o.on('-g', '--greyscale', 'Convert image to greyscale') do
+    actions << ->(img) { img.greyscale }
   end
 
-  opts.on("-h", "--flip_horizontally") do
-    actions << lambda {|img| img.flip_horizontally }
+  o.on('-h', '--flip_horizontally') do
+    actions << ->(img) { img.flip_horizontally }
   end
 
-  opts.on("-m", "--metadata") do
-    actions << lambda {|img| puts img.metadata }
+  o.on('-m', '--metadata') do
+    actions << ->(img) { img.tap { puts img.metadata } }
   end
 
-  opts.on("-n", "--negative", "Make a negative out of the image") do
-    actions << lambda {|img| img.negative }
+  o.on('-n', '--negative', 'Make a negative out of the image') do
+    actions << ->(img) { img.negative }
   end
 
-  opts.on("-o", "--orient", "Rotate image to orient it based on metadata") do
-    actions << lambda {|img| img.correct_orientation }
+  o.on('-o', '--orient', 'Rotate image to orient it based on metadata') do
+    actions << ->(img) { img.correct_orientation }
   end
 
-  opts.on("-q", "--quality 0..1", Float, "Set % of quality for lossy compression") do |quality|
-    actions << lambda {|img| img.quality(quality) }
+  o.on('-q', '--quality 0..1', Float, 'Set % of quality for lossy compression') do |quality|
+    actions << ->(img) { img.quality(quality) }
   end
 
-  opts.on("-R", "--rotate 0..360", Float, "Set angle to rotate image") do |angle|
-    actions << lambda {|img| img.rotate(angle.to_f) }
+  o.on('-R', '--rotate 0..360', Float, 'Set angle to rotate image') do |angle|
+    actions << ->(img) { img.rotate(angle.to_f) }
   end
 
-  opts.on("-r", "--resize WIDTHxHEIGHT", "Create a new image with the specified", "dimensions") do |dim|
-    width, height = dim.split(/x/i).map {|v| v.to_i}
-    opts.usage "You need to specify proper dimensions" unless width && width > 0 && height && height > 0
-    actions << lambda {|img| img.resize(width,height) }
+  o.on('-r', '--resize WIDTHxHEIGHT', 'Make a new resized image') do |dim|
+    width, height = dim.split(/x/i).map(&:to_i)
+    o.usage 'You need to specify proper dimensions' unless width && width > 0 && height && height > 0
+    actions << ->(img) { img.resize(width, height) }
   end
 
-
-  opts.on("-s", "--save FILENAME", "Save the results to a new file") do |f|
-    actions << lambda {|img| img.save(f); img }
+  o.on('-s', '--save FILENAME', 'Save the results to a new file') do |f|
+    actions << ->(img) { img.tap { img.save(f) } }
   end
 
-  opts.on("-t", "--thumbnail SIZE", Integer, "Create a thumbnail of the given size") do |size|
-    actions << lambda {|img| img.thumbnail(size) }
+  o.on('-t', '--thumbnail SIZE', Integer, 'Create a thumbnail of the given size') do |size|
+    actions << ->(img) { img.thumbnail(size) }
   end
 
-  opts.on("-v", "--flip_vertically") do
-    actions << lambda {|img| img.flip_vertically }
-  end
-
-  opts.on("-p", "--preview", "Preview the image. Close the frame window",
-    "to continue, or quit the application to", "abort the action pipeline") do
+  o.on('-v', '--flip_vertically') { actions << ->(img) { img.flip_vertically } }
 
+  o.on('-p', '--preview',
+       'Preview the image. Close the frame window',
+       'to continue, or quit the application to',
+       'abort the action pipeline') do
     headless = false
     actions << lambda do |img|
       done = false
@@ -111,36 +103,33 @@ opts = OptionParser.new do |opts|
     end
   end
 
-  opts.on("--push", "Save the current image to be popped later") do
-    actions << lambda {|img| images << img; img }
+  o.on('--push', 'Save the current image to be popped later') do
+    actions << ->(img) { img.tap { images << img } }
   end
 
-  opts.on("--pop", "Revert back to the previous saved image", "or the original source image") do
-    actions << lambda {|img| images.pop || original_image }
+  o.on('--pop', 'Revert back to the previous image') do
+    actions << -> { images.pop || original_image }
   end
 
-  opts.on("-f", "--format", "Print the image format") do
-    actions << lambda {|img| puts img.format; img }
+  o.on('-f', '--format', 'Print the image format') do
+    actions << ->(img) { img.tap { img.format } }
   end
 
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
-    exit 0
-  end
+  o.on_tail('-h', '--help', 'Show this message') { o.usage }
 
-  def opts.usage(msg)
-    puts msg
+  def o.usage(msg=nil)
+    puts msg if msg
     puts self
     exit 1
   end
 end
 opts.parse!(ARGV)
-opts.usage("You need to supply a source image filename.") unless ARGV.first
-opts.usage("You need to supply one or more actions.") unless actions.size > 0
+opts.usage('You need to supply a source image filename.') unless ARGV.first
+opts.usage('You need to supply one or more actions.') if actions.empty?
 
 # For this binstub we only want to load non-headless if we are using
 # the preview feature. top of See lib/image_voodoo.rb for more info...
-class ImageVoodoo; NEEDS_HEAD = true; end unless headless
+require 'image_voodoo/needs_head' unless headless
 
 require 'image_voodoo'
 file_name = ARGV.first

data/image_voodoo.gemspec

@@ -1,6 +1,8 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "image_voodoo/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'image_voodoo/version'
 
 Gem::Specification.new do |s|
   s.name        = 'image_voodoo'
@@ -12,11 +14,16 @@ Gem::Specification.new do |s|
   s.summary     = 'Image manipulation in JRuby with ImageScience compatible API'
   s.description = 'Image manipulation in JRuby with ImageScience compatible API'
 
-  s.rubyforge_project = "image_voodoo"
-
   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", "vendor"]
-  s.has_rdoc      = true
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = %w[lib vendor]
+
+  s.add_development_dependency 'jar-dependencies'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'ruby-maven'
+  s.add_development_dependency 'test-unit'
+
+  s.requirements << 'jar com.drewnoakes, metadata-extractor, 2.11.0'
 end

data/lib/image_science.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'image_voodoo'
 # HA HA...let the pin-pricking begin
-ImageScience = ImageVoodoo
+ImageScience = ImageVoodoo

data/lib/image_voodoo/awt/core_ext/buffered_image.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'java'
+
+# Hide in ImageVoodoo so awt.rb can see this and we will not polute global
+class ImageVoodoo
+  java_import java.awt.image.BufferedImage
+
+  # Re-open to add convenience methods.
+  class BufferedImage
+    def each
+      height.times { |j| width.times { |i| yield i, j } }
+    end
+  end
+end

data/lib/image_voodoo/awt/core_ext/graphics2d.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'java'
+
+# Hide in ImageVoodoo so awt.rb can see this and we will not polute global
+class ImageVoodoo
+  java_import java.awt.Graphics2D
+
+  # Re-open to add convenience methods.
+  class Graphics2D
+    def draw_this_image(image)
+      draw_image image, 0, 0, nil
+    end
+  end
+end

data/lib/image_voodoo/awt/shapes.rb

@@ -1,5 +1,44 @@
+# frozen_string_literal: true
+
 class ImageVoodoo
+  # (Experimental) An attempt at some primitive drawing in images.
   module Shapes
+    # FIXME: if image has alpha values the border shows through since it is
+    #   a solid fill.
+    ##
+    # *AWT* (experimental) Add a border to the image and yield/return a new
+    # image.  The following options are supported:
+    #   - width: How thick is the border (default: 3)
+    #   - color: Which color is the border (in rrggbb hex value)
+    #   - style: etched, raised, plain (default: plain)
+    #
+    def add_border(options = {})
+      border_width = options[:width].to_i || 2
+      new_width, new_height = width + 2*border_width, height + 2*border_width
+      target = paint(BufferedImage.new(new_width, new_height, color_type)) do |g|
+        paint_border(g, new_width, new_height, options)
+        g.draw_image(@src, nil, border_width, border_width)
+      end
+      block_given? ? yield(target) : target
+    end
+
+    def paint_border(g, new_width, new_height, options)
+      g.color = hex_to_color(options[:color])
+      fill_method, *args = border_style(options)
+      g.send fill_method, 0, 0, new_width, new_height, *args
+    end
+
+    def border_style(options)
+      case (options[:style] || "").to_s
+      when "raised" then
+        [:fill3DRect, true]
+      when "etched" then
+        [:fill3DRect, false]
+      else
+        [:fill_rect]
+      end
+    end
+
     ##
     # *AWT* Draw a square
     #
@@ -18,14 +57,14 @@ class ImageVoodoo
     # *AWT* Draw a rounded square
     #
     def square_rounded(x, y, dim, rgb, arc_width=0, fill=true)
-      rect_rounded(x,y, dim, dim, rgb, arc_width, arc_width, fill)
+      rect_rounded(x, y, dim, dim, rgb, arc_width, arc_width, fill)
     end
 
     ##
     # *AWT* Draw a rounded rectangle
     #
     def rect_rounded(x, y, width, height, rgb, arc_width=0, arc_height=0, fill=true)
-      as_color(ImageVoodoo.hex_to_color(rgb)) do |g|
+      as_color(hex_to_color(rgb)) do |g|
         if fill
           g.fill_round_rect x, y, width, height, arc_width, arc_height
         else
@@ -44,4 +83,3 @@ class ImageVoodoo
     end
   end
 end
-