carrierwave-imagesorcery 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carrierwave-sorcery.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 WaYdotNET
+
+MIT License
+
+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,100 @@
+# CarrierWave::ImageSorcery
+
+Additional processing to use [ImageSorcery](https://github.com/EricR/image_sorcery) into [CarrierWave](https://github.com/jnicklas/carrierwave).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carrierwave-imagesorcery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierwave-imagesorcery
+
+## Usage
+
+To use those, you should include specified module (ImageSorcery) into your uploader and use processors:
+
+    class AvatarUploader < CarrierWave::Uploader::Base
+      include CarrierWave::ImageSorcery
+      .....
+
+    end
+
+## Method implemented
+
+    convert
+    dimensions
+    resize_to_limit
+    resize_to_fit
+    resize_to_fill
+    resize_and_pad
+
+## Example
+
+    class Uploader < CarrierWave::Uploader::Base
+    ##
+    # Image manipulator library:
+    include CarrierWave::ImageSorcery
+
+    process :resize_and_pad => [900,300,"#ffeecc", 'South']
+    process :resize_to_fit => [1024, 768]
+
+    end
+
+## Example custom method
+
+An example to implement custom method
+
+
+    class Uploader < CarrierWave::Uploader::Base
+    include CarrierWave::ImageSorcery
+    process :watermark_text
+
+    def watermark_text(text = "© #{Time.now.year} - Carlo Bertini [WaYdotNET]")
+      manipulate! do |img|
+        args  = {
+          font: 'Helvetica', fill: 'white', stroke: '#00770080',
+          gravity: 'South', pointsize: 20, draw: " text 0,0 \"#{text}\" "
+        }
+        img.manipulate! args
+        img
+      end
+    end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Author
+
+[![endorse](http://api.coderwall.com/waydotnet/endorsecount.png)](http://coderwall.com/waydotnet)
+
+WaYdotNET, you can follow me on twitter [@WaYdotNET](http://twitter.com/WaYdotNET) or take a look at my site [waydotnet.com](http://www.waydotnet.com)
+
+## Copyright
+
+Copyright (C) 2012 Carlo Bertini - [@WaYdotNET](http://twitter.com/WaYdotNET)
+
+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 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/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => :spec

data/carrierwave-imagesorcery.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/carrierwave-imagesorcery/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Carlo Bertini"]
+  gem.email = ["waydotnet@gmail.com"]
+  gem.description = "CarrierWave Additional processing to support ImageSorcery"
+  gem.summary = "ImageSorcery carrierwave processor"
+  gem.homepage = "http://www.waydotnet.com"
+
+  gem.extra_rdoc_files = ["README.md"]
+  gem.rdoc_options = ["--main"]
+  gem.add_development_dependency "rspec"
+
+  gem.add_dependency 'carrierwave'
+  gem.add_dependency 'image_sorcery'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "carrierwave-imagesorcery"
+  gem.require_paths = ["lib"]
+  gem.version       = CarrierWave::ImageSorcery::VERSION
+end

data/lib/carrierwave-imagesorcery.rb

@@ -0,0 +1,2 @@
+require "carrierwave-imagesorcery/version"
+require "carrierwave-imagesorcery/image_sorcery"

data/lib/carrierwave-imagesorcery/image_sorcery.rb

@@ -0,0 +1,174 @@
+require 'image_sorcery'
+
+module CarrierWave
+  module ImageSorcery
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def convert(format)
+        process :convert => format
+      end
+
+      def resize_to_limit(width, height)
+        process :resize_to_limit => [width, height]
+      end
+
+      def resize_to_fit(width, height)
+        process :resize_to_fit => [width, height]
+      end
+
+      def resize_to_fill(width, height, gravity='Center')
+        process :resize_to_fill => [width, height, gravity]
+      end
+
+      def resize_and_pad(width, height, background=:transparent, gravity=::Magick::CenterGravity)
+        process :resize_and_pad => [width, height, background, gravity]
+      end
+    end
+
+     ##
+    # Changes the image encoding format to the given format
+    #
+    # See  http://www.imagemagick.org/script/command-line-options.php#format
+    #
+    # === Parameters
+    #
+    # [format (#to_s)] an abreviation of the format
+    #
+    #
+    # === Examples
+    #
+    #  image.convert(:png)
+    #
+    def convert(format)
+      manipulate! do |img|
+        img.manipulate!(:format => format.to_s.downcase)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    ##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. Will only resize the image if it is larger than the
+    # specified dimensions. The resulting image may be shorter or narrower than specified
+    # in the smaller dimension but will not be larger than the specified values.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    def resize_to_limit(width, height)
+      manipulate! do |img|
+        img.manipulate!(:resize => "#{width}x#{height}>")
+        # img = yield(img) if block_given?
+        if img
+          img
+        else
+          raise CarrierWave::ProcessingError , I18n.translate(:"errors.messages.imagesorcery_processing_error")
+        end
+        # img
+      end
+    end
+
+    ##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. The image may be shorter or narrower than
+    # specified in the smaller dimension but will not be larger than the specified values.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    #
+    #
+    def resize_to_fit(width, height)
+      manipulate! do |img|
+        img.manipulate!(:resize => "#{width}x#{height}")
+        img = yield(img) if block_given?
+        if img
+          img
+        else
+          raise CarrierWave::ProcessingError , I18n.translate(:"errors.messages.imagesorcery_processing_error")
+        end
+        # img
+      end
+    end
+
+##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the aspect ratio of the original image. If necessary, crop the image in the
+    # larger dimension.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [gravity (String)] the current gravity suggestion (default: 'Center'; options: 'NorthWest', 'North', 'NorthEast', 'West', 'Center', 'East', 'SouthWest', 'South', 'SouthEast')
+    #
+    #
+    def resize_to_fill(width, height, gravity = 'Center')
+      manipulate! do |img|
+        cols, rows = img.dimensions[:x].to_i, img.dimensions[:y].to_i
+        opt={}
+        if width != cols || height != rows
+          scale = [width/cols.to_f, height/rows.to_f].max
+          cols = (scale * (cols + 0.5)).round
+          rows = (scale * (rows + 0.5)).round
+          opt[:resize] = "#{cols}x#{rows}"
+        end
+        opt[:gravity] = gravity
+        opt[:background] = "rgba(255,255,255,0.0)"
+        opt[:extent] = "#{width}x#{height}" if cols != width || rows != height
+        img.manipulate!(opt)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+##
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. If necessary, will pad the remaining area
+    # with the given color, which defaults to transparent (for gif and png,
+    # white for jpeg).
+    #
+    # See http://www.imagemagick.org/script/command-line-options.php#gravity
+    # for gravity options.
+    #
+    # === Parameters
+    #
+    # [width (Integer)] the width to scale the image to
+    # [height (Integer)] the height to scale the image to
+    # [background (String, :transparent)] the color of the background as a hexcode, like "#ff45de"
+    # [gravity (String)] how to position the image
+    #
+    #
+    def resize_and_pad(width, height, background=:transparent, gravity='Center')
+      manipulate! do |img|
+        opt={}
+        opt[:thumbnail] = "#{width}x#{height}>"
+        background == :transparent ? opt[:background] = "rgba(255, 255, 255, 0.0)" : opt[:background] = background
+        opt[:gravity] = gravity
+        opt[:extent] = "#{width}x#{height}"
+        img.manipulate!(opt)
+        img = yield(img) if block_given?
+        img
+      end
+    end
+
+    def dimensions
+       manipulate! do |img|
+        img.dimensions
+      end
+    end
+
+    def manipulate!
+      cache_stored_file! if !cached?
+      image = Sorcery.new current_path
+      image = yield(image)
+    rescue RuntimeError, StandardError => e
+      raise CarrierWave::ProcessingError , I18n.translate(:"errors.messages.imagesorcery_processing_error", :e => e)
+    end
+  end
+end

data/lib/carrierwave-imagesorcery/version.rb

@@ -0,0 +1,5 @@
+module CarrierWave
+  module ImageSorcery
+    VERSION = "0.0.2"
+  end
+end

data/spec/lib/carrierwave-imagesorcery/image_sorcery.rb

@@ -0,0 +1,111 @@
+# # require_relative '../../spec_helper'
+# # For Ruby < 1.9.3, use this instead of require_relative
+require (File.expand_path('./../../../spec_helper', __FILE__))
+
+describe CarrierWave::ImageSorcery do
+
+  before do
+    @klass = Class.new do
+      include CarrierWave::ImageSorcery
+    end
+    @instance = @klass.new
+    FileUtils.cp(file_path('landscape.jpg'), file_path('landscape_copy.jpg'))
+    @instance.stub(:current_path).and_return(file_path('landscape_copy.jpg'))
+    @instance.stub(:cached?).and_return true
+  end
+
+  after do
+    FileUtils.rm(file_path('landscape_copy.jpg'))
+  end
+
+  describe "#convert" do
+    it "should convert from one format to another" do
+      @instance.convert('foo.png')
+      # img = ::MiniMagick::Image.open(@instance.current_path)
+      img = Sorcery.new @istance.current_path
+      identify= img.identify
+      identify.should =~ /PNG/
+    end
+  end
+
+  describe '#resize_to_fill' do
+    it "should resize the image to exactly the given dimensions" do
+      @instance.resize_to_fill(200, 200)
+      @instance.should have_dimensions(200, 200)
+    end
+
+    it "should scale up the image if it smaller than the given dimensions" do
+      @instance.resize_to_fill(1000, 1000)
+      @instance.should have_dimensions(1000, 1000)
+    end
+  end
+
+  describe '#resize_and_pad' do
+    it "should resize the image to exactly the given dimensions" do
+      @instance.resize_and_pad(200, 200)
+      @instance.should have_dimensions(200, 200)
+    end
+
+    it "should scale up the image if it smaller than the given dimensions" do
+      @instance.resize_and_pad(1000, 1000)
+      @instance.should have_dimensions(1000, 1000)
+    end
+
+    it "should pad with white" do
+      @instance.resize_and_pad(200, 200)
+      image = ::MiniMagick::Image.open(@instance.current_path)
+      x, y = 0, 0
+      color = image.run_command("convert", "#{image.escaped_path}[1x1+#{x}+#{y}]", "-depth 8", "txt:").split("\n")[1]
+      color.should include('#FFFFFF')
+    end
+
+  end
+
+  describe '#resize_to_fit' do
+    it "should resize the image to fit within the given dimensions" do
+      @instance.resize_to_fit(200, 200)
+      @instance.should have_dimensions(200, 150)
+    end
+
+    it "should scale up the image if it smaller than the given dimensions" do
+      @instance.resize_to_fit(1000, 1000)
+      @instance.should have_dimensions(1000, 750)
+    end
+  end
+
+  describe '#resize_to_limit' do
+    it "should resize the image to fit within the given dimensions" do
+      @instance.resize_to_limit(200, 200)
+      @instance.should have_dimensions(200, 150)
+    end
+
+    it "should not scale up the image if it smaller than the given dimensions" do
+      @instance.resize_to_limit(1000, 1000)
+      @instance.should have_dimensions(640, 480)
+    end
+  end
+
+  describe "test errors" do
+    context "invalid image file" do
+      before do
+        File.open(@instance.current_path, 'w') do |f|
+          f.puts "bogus"
+        end
+      end
+
+      it "should fail to process a non image file" do
+        lambda {@instance.resize_to_limit(200, 200)}.should raise_exception(CarrierWave::ProcessingError, /^Failed to manipulate with MiniMagick, maybe it is not an image\? Original Error:/)
+      end
+
+      it "should use I18n" do
+        change_locale_and_store_translations(:nl, :errors => {
+          :messages => {
+            :mini_magick_processing_error => "Kon bestand niet met MiniMagick bewerken, misschien is het geen beeld bestand? MiniMagick foutmelding: %{e}"
+          }
+        }) do
+          lambda {@instance.resize_to_limit(200, 200)}.should raise_exception(CarrierWave::ProcessingError, /^Kon bestand niet met MiniMagick bewerken, misschien is het geen beeld bestand\? MiniMagick foutmelding:/)
+        end
+      end
+    end
+  end
+end

data/spec/lib/carrierwave-imagesorcery/image_sorcery_spec.rb

@@ -0,0 +1,82 @@
+# # require_relative '../../spec_helper'
+# # For Ruby < 1.9.3, use this instead of require_relative
+require (File.expand_path('./../../../spec_helper', __FILE__))
+require 'subexec'
+
+class Uploader  < CarrierWave::Uploader::Base
+  include CarrierWave::ImageSorcery
+end
+
+describe CarrierWave::ImageSorcery do
+
+  before do
+    @klass = Class.new do
+      include CarrierWave::ImageSorcery
+    end
+    @instance = Uploader.new
+    FileUtils.cp(file_path('landscape.jpg'), file_path('landscape_copy.jpg'))
+    @instance.stub(:current_path).and_return(file_path('landscape_copy.jpg'))
+    @instance.stub(:cached?).and_return true
+  end
+
+  after do
+    FileUtils.rm(file_path('landscape_copy.jpg'))
+  end
+
+  describe "#convert" do
+    it "should convert from one format to another" do
+      @instance.convert('foo.png')
+      img = Sorcery.new file_path('foo.png')
+      img.identify.should =~ /PNG/
+    end
+  end
+
+  describe '#resize_to_fill' do
+    it "should resize the image to exactly the given dimensions" do
+      @instance.resize_to_fill(200, 200)
+      @instance.dimensions.should == check_dimension(200, 200)
+    end
+
+    it "should scale up the image if it smaller than the given dimensions" do
+      @instance.resize_to_fill(1000, 1000)
+      @instance.dimensions.should == check_dimension(1000, 1000)
+    end
+  end
+
+  describe '#resize_and_pad' do
+    it "should resize the image to exactly the given dimensions" do
+      @instance.resize_and_pad(200, 200)
+      @instance.dimensions.should == check_dimension(200, 200)
+    end
+
+    it "should scale up the image if it smaller than the given dimensions" do
+      @instance.resize_and_pad(1000, 1000)
+      @instance.dimensions.should == check_dimension(1000, 1000)
+    end
+
+  end
+
+  describe '#resize_to_fit' do
+    it "should resize the image to fit within the given dimensions" do
+      @instance.resize_to_fit(200, 200)
+      @instance.dimensions.should == check_dimension(200, 150)
+    end
+
+    it "should scale up the image if it smaller than the given dimensions" do
+      @instance.resize_to_fit(1000, 1000)
+      @instance.dimensions.should == check_dimension(1000, 750)
+    end
+  end
+
+  describe '#resize_to_limit' do
+    it "should resize the image to fit within the given dimensions" do
+      @instance.resize_to_limit(200, 200)
+      @instance.dimensions.should == check_dimension(200, 150)
+    end
+
+    it "should not scale up the image if it smaller than the given dimensions" do
+      @instance.resize_to_limit(1000, 1000)
+      @instance.dimensions.should == check_dimension(640, 480)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems' unless defined? Gem
+# require 'minitest' if RUBY_VERSION < "1.9"
+
+# we need the actual library file
+# require_relative '../lib/ms_translate'
+# For Ruby < 1.9.3, use this instead of require_relative
+require 'bundler/setup'
+require 'carrierwave'
+
+require(File.expand_path('../../lib/carrierwave-imagesorcery', __FILE__))
+require 'minitest/autorun'
+
+
+def file_path(*paths)
+  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', *paths))
+end
+
+def check_dimension(x, y)
+  {:x => "#{x}", :y => "#{y}"}
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-imagesorcery
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Carlo Bertini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_sorcery
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CarrierWave Additional processing to support ImageSorcery
+email:
+- waydotnet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- carrierwave-imagesorcery.gemspec
+- lib/carrierwave-imagesorcery.rb
+- lib/carrierwave-imagesorcery/image_sorcery.rb
+- lib/carrierwave-imagesorcery/version.rb
+- spec/fixtures/landscape.jpg
+- spec/lib/carrierwave-imagesorcery/image_sorcery.rb
+- spec/lib/carrierwave-imagesorcery/image_sorcery_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.waydotnet.com
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ImageSorcery carrierwave processor
+test_files:
+- spec/fixtures/landscape.jpg
+- spec/lib/carrierwave-imagesorcery/image_sorcery.rb
+- spec/lib/carrierwave-imagesorcery/image_sorcery_spec.rb
+- spec/spec_helper.rb
+has_rdoc: