magick_pipe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7b011b30bea993e2c44f4cc87dfa037715cf8ee
+  data.tar.gz: 5f7dade42dfdffaf995be729f2349c49a6e87b71
+SHA512:
+  metadata.gz: d95c03d160120f9c438b3a74f6353c01dc7d55c27da46c00def9dfc6b48af38f17b920973a183fb215f467f5c17e783891fa100338dc1109edbaff0b052fdd21
+  data.tar.gz: b19686863d7fbc54d0e514c11fa6c2cfb0d591855661cf26479ded1caca4c30d5402195ce0bbc050a94f7d2330800a9e70dab6e4f6bc0b70839ef9def3ee8ab2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rmagick', :require => 'RMagick'
+  gem "rspec", "~> 2.14.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.2.0)
+    mini_portile (0.6.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rmagick (2.13.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  rmagick
+  rspec (~> 2.14.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Julik Tarkhanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# magick_pipe
+
+**WARNING: this is a proof-of-concept/experimental library. Expect things to break.**
+
+Serialize RMagick operations into a processing pipeline that can be executed out-of-process.
+
+To set up a processing pipe:
+
+    script = MagickPipe.new("/Users/julik/VFX_Projectery/MattePaintings/IMG_9500.psd", frame: 0)
+    script.auto_orient
+    script.strip!
+    script.geometry! '512x512'
+    script.sharpen 0.0, 0.85
+    script.write("/Users/julik/VFX_Projectery/MattePaintings/IMG_9500_tiny.png")
+  
+No images are allocated at this point. Only when you call
+
+    script.execute!
+
+will the actual reading of the image happen. All the images allocated at the various stages
+of the processing will be deallocated using `Magick::Image#destroy!` at the end of the method.
+
+## Why is this actually useful?
+
+Well, you could do this (using [exceptional_fork](https://github.com/julik/exceptional_fork)):
+
+    ExceptionalFork.fork_and_wait { script.execute! }
+  
+This will put all the image allocations _outside_ of your main Ruby process. This will ensure
+that the fabulous RMagick memory leaks or bad deallocations will die together with the process
+that has been spun up.
+
+## Calling convention
+
+Every method that is available on a `Magick::Image` object is available in the `MagickPipe`
+object. Blocks will be preserved where possible. Since `change_geometry` with the default block is
+used so often it is made available under 
+
+## Future problems
+
+The idea is to be able to actually _serialize_ the whole processing pipe so that it can be
+passed via JSON or a query string.
+
+## Contributing to image_pipeline
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require_relative 'lib/version'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = MagickPipe::VERSION
+  gem.name = "magick_pipe"
+  gem.homepage = "http://github.com/julik/magick_pipe"
+  gem.license = "MIT"
+  gem.summary = %Q{ Serialize RMagick processing steps }
+  gem.description = %Q{ and run them in a forked subprocess, later }
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # Remove the huge PSD
+  gem.files.exclude "spec/*.psd"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "magick_pipe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/magick_pipe.rb

@@ -0,0 +1,57 @@
+require 'RMagick'
+require_relative 'version'
+class MagickPipe
+  NOOP_PROC = Proc.new {} # To prevent allocating new Procs every time we have a method with no Proc
+  
+  # Initialize a processing script with a path to the source file and the frame to use.
+  # To reliably "squash" Photoshop documents that have been saved with "Maximize Compatibiliy"
+  # enabled, set the frame to 0 (this is also the default). This will preserve the transparency
+  # throughout the whole script.
+  def initialize(source_path, frame: 0)
+    @source_path = source_path
+    @frame = frame.to_i
+    @steps = []
+  end
+  
+  # Shorcut for change_geometry() with a block argument
+  def geometry!(geometry_argument)
+    change_geometry(geometry_argument) do | rows, cols, img |
+      img.resize(rows, cols)
+    end
+  end
+  
+  # Perform all the recorded steps in sequence, and 
+  # deallocate all of the Magick::Image objects at the end.
+  def execute!
+    allocated_images = []
+    allocated_images << Magick::Image.read(@source_path)[0]
+    @steps.each do | (method_name, tail_args, block_proc) |
+      last_image = allocated_images[-1]
+      
+      # Apply the method to the image, and grab the return result
+      result = last_image.public_send(method_name, *tail_args, &block_proc)
+      
+      # If that is a new image - put it on the stack
+      if result.is_a?(Magick::Image) && result.object_id != last_image.object_id
+        allocated_images << result
+      end
+    end
+  ensure
+    allocated_images.each {|i| i.destroy! unless i.destroyed? }
+    GC.start
+  end
+  
+  # Will tell whether a method is available on Magick::Image objects.
+  def respond_to_missing?(m, *a)
+    Magick::Image.public_instance_methods.include?(m)
+  end
+  
+  # Save the method name, it's tail arguments and the optional block
+  # for later execution.
+  def method_missing(m, *a)
+    return super unless respond_to?(m)
+    proc_block = block_given? ? Proc.new : NOOP_PROC
+    @steps << [m, a, proc_block]
+  end
+end
+

data/lib/version.rb

@@ -0,0 +1,3 @@
+class MagickPipe
+  VERSION = '0.0.1'
+end

data/spec/magick_pipe_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MagickPipe" do
+  after :each do
+    File.unlink('out.png') if File.exist?('out.png')
+  end
+  
+  it "responds to Magick::Image methods" do
+    subject = MagickPipe.new("/foo.tif")
+    expect(subject).to respond_to(:resize)
+    expect(subject).to respond_to(:sharpen)
+  end
+  
+  it 'resizes and sharpens the PSD file using change_geometry and a block' do
+    path = File.dirname(__FILE__) + '/IMG_3241.psd'
+    
+    subject = MagickPipe.new(path)
+    subject.change_geometry('64x64') do |r, c, img|
+      img.resize(r, c)
+    end
+    subject.sharpen 0.0, 0.85
+    subject.write('out.png')
+    
+    expect(File).not_to be_exist('out.png')
+    subject.execute!
+    expect(File).to be_exist('out.png')
+    
+    image = Magick::Image.read('out.png')[0]
+    expect(image.rows).to be <= 64
+    expect(image.columns).to be <= 64
+  end
+  
+  it 'runs a GC after execution' do
+    path = File.dirname(__FILE__) + '/IMG_3241.psd'
+    
+    subject = MagickPipe.new(path)
+    subject.write('out.png')
+    
+    expect(GC).to receive(:start).once
+    subject.execute!
+  end
+  
+  it 'resizes and sharpens the PSD file using geometry!' do
+    path = File.dirname(__FILE__) + '/IMG_3241.psd'
+    
+    subject = MagickPipe.new(path)
+    subject.geometry! '64x64'
+    subject.sharpen 0.0, 0.85
+    subject.write('out.png')
+    
+    expect(File).not_to be_exist('out.png')
+    subject.execute!
+    expect(File).to be_exist('out.png')
+    
+    image = Magick::Image.read('out.png')[0]
+    expect(image.rows).to be <= 64
+    expect(image.columns).to be <= 64
+  end
+  
+  it 'resizes and sharpens the PSD file using geometry!' do
+    path = File.dirname(__FILE__) + '/IMG_3241.psd'
+    
+    subject = MagickPipe.new(path)
+    subject.geometry! '64x64'
+    subject.sharpen 0.0, 0.85
+    subject.write('out.png')
+    
+    expect(File).not_to be_exist('out.png')
+    subject.execute!
+    expect(File).to be_exist('out.png')
+    
+    image = Magick::Image.read('out.png')[0]
+    expect(image.rows).to be <= 64
+    expect(image.columns).to be <= 64
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'magick_pipe'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: magick_pipe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " and run them in a forked subprocess, later "
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/magick_pipe.rb
+- lib/version.rb
+- spec/magick_pipe_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/julik/magick_pipe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Serialize RMagick processing steps
+test_files: []