paperclip_watermark 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e54792a352790ac6beacfc2a71bc28fd0432a9ff
+  data.tar.gz: 7ad6f8fc9ae5dfadb9bd4f20c78a67a5305904cf
+SHA512:
+  metadata.gz: cbde95b6ed8673e80aa8222a58271648827d36961c4a79fb4754b347cf57ec6c3e75b87e5188d286a1769f149300a6645a3347101c6dfa92c06f6d4e2b7ae0ce
+  data.tar.gz: a6d7557b8c54b18aa3a69b47295bdde2e2893fde3b20ba41230fb76109c3580aa654726a9269180f97c69255448296f043612f3e797df38bcccb22eed4ac22c2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alessandro Caianiello
+
+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,57 @@
+# PaperclipWatermark
+
+## Description
+This is a simple Paperclip processor to apply watermarks on Paperclip's images. The watermark will be resized to fit the base image.
+
+Few options are available to specify the position and it opacity:
+
+`watermark_distance_from_top`: specify the position from top in percentage
+
+`watermark_position`: specify the position (NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast)
+
+`watermark_dissolve`: specify the opacity
+
+## Usage
+
+```ruby
+  # Paperclip image attachments
+  has_attached_file :attachment, :processors => [:thumbnail, :watermark],
+                    styles: {
+                                 thumb: '250x250>',
+                                 original: {
+                                          geometry: '1280x1280>',
+                                          watermark_dissolve: 30,
+                                          watermark_distance_from_top: 90,
+                                          watermark_path: "#{Rails.root}/public/images/logo.png"
+                                  }
+                               }
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paperclip_watermark'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip_watermark
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/paperclip_watermark/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/paperclip/watermark.rb

@@ -0,0 +1,88 @@
+require "paperclip/processor"
+
+module Paperclip
+  class Watermark < Paperclip::Processor
+
+    def initialize(file, options = {}, attachment = nil)
+      super
+      @file              = file
+      @whiny             = options.fetch(:whiny, true)
+      @watermark_path    = options[:watermark_path]
+      @dissolve          = options.fetch(:watermark_dissolve, 30)
+      @position          = options[:watermark_position]
+      @distance_from_top = options[:watermark_distance_from_top]
+
+      raise Paperclip::Error.new('Postion or distance_from_top required') if @position.nil? && @distance_from_top.nil?
+      raise Paperclip::Error.new('Missing watermark path') if @watermark_path.nil?
+    end
+
+    def make
+      destination = Tempfile.new([file_basename, current_format ? ".#{current_format}" : ''])
+      destination.binmode
+
+      Paperclip.run('composite', composition_options(destination.path))
+      destination
+      rescue Paperclip::Errors::CommandNotFoundError
+        raise Paperclip::Errors::CommandNotFoundError, "There was an error processing the watermark for #{@file.path}" if @whiny
+    end
+
+    def composition_options(destination_path)
+      options = []
+      options << "-dissolve #{@dissolve}%"
+      options << '-quality 100'
+      options << watermak_position
+      options << watermark_command
+      options << @file.path
+      options << destination_path
+      options.join(' ')
+    end
+
+    def watermak_position
+      if @position
+        "-gravity #{@position}"
+      else
+        "-geometry +#{calculated_watermak_position.first}+#{calculated_watermak_position.last}"
+      end
+    end
+
+    def watermark_command
+      options = []
+      options << '\\('
+      options << @watermark_path
+      options << '-resize'
+      options << "#{scaled_size_for_watermark.width}x#{scaled_size_for_watermark.height}"
+      options << '\\)'
+      options.join(' ')
+    end
+
+    def scaled_size_for_watermark
+      destination_width = file_size.width - 20
+      calculated_height = watermark_size.height.to_f / watermark_size.width.to_f * destination_width.to_f
+      Paperclip::Geometry.new(destination_width, calculated_height.to_i)
+    end
+
+    private
+
+    def watermark_size
+      @watermark_size ||= Paperclip::Geometry.from_file(@watermark_path)
+    end
+
+    def file_size
+      @file_size ||= Paperclip::Geometry.from_file(@file.path)
+    end
+
+    def file_basename
+      File.basename(@file.path, current_format)
+    end
+
+    def current_format
+      File.extname(@file.path)
+    end
+
+    def calculated_watermak_position
+      top = ((file_size.height - scaled_size_for_watermark.height)/100) * @distance_from_top
+      left = (file_size.width - scaled_size_for_watermark.width)/2
+      [left, top]
+    end
+  end
+end

data/lib/paperclip_watermark/version.rb

@@ -0,0 +1,3 @@
+module PaperclipWatermark
+  VERSION = "0.0.1"
+end

data/lib/paperclip_watermark.rb

@@ -0,0 +1,4 @@
+require "paperclip_watermark/version"
+
+module PaperclipWatermark
+end

data/paperclip_watermark.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip_watermark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip_watermark"
+  spec.version       = PaperclipWatermark::VERSION
+  spec.authors       = ["Alessandro Caianiello"]
+  spec.email         = ["github@caianiello.it"]
+  spec.summary       = %q{Paperclip Watermark with resize support}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "paperclip", "~> 4.2"
+  spec.add_development_dependency("rspec")
+end

data/spec/paperclip/watermark_spec.rb

@@ -0,0 +1,92 @@
+require 'active_support/core_ext/object/blank'
+require 'tempfile'
+require 'paperclip'
+require 'paperclip/watermark'
+require 'paperclip/errors'
+require 'paperclip/geometry'
+require 'paperclip/geometry_detector_factory'
+require 'paperclip/geometry_parser_factory'
+require 'cocaine'
+
+describe PaperclipWatermark::Watermark do
+  let(:file) { File.new(File.expand_path('../../support/dummy.jpg', __FILE__)) }
+  let(:watermark_path) { File.new(File.expand_path('../../support/logo.png', __FILE__)) }
+  let(:position) { 'Center' }
+  let(:watermark_distance_from_top) { nil }
+  let(:options) do
+    {
+      watermark_path: watermark_path,
+      watermark_position: position,
+      watermark_distance_from_top: watermark_distance_from_top
+    }
+  end
+
+  subject{ described_class.new(file, options) }
+
+  describe "#make" do
+    let(:composition_options) { 'composition_options' }
+
+    before do
+      allow(subject).to receive(:composition_options).and_return(composition_options)
+    end
+
+    it "applies a scaled watermark" do
+      expect(Paperclip).to receive(:run).with('composite', composition_options)
+      subject.make
+    end
+  end
+
+  describe "#composition_options" do
+    let(:destination) { 'destination' }
+    let(:watermark_command) { 'watermark_command' }
+
+    before do
+      allow(subject).to receive(:watermark_command).and_return(watermark_command)
+    end
+
+    it "returns the right command" do
+      command = subject.composition_options(destination)
+      expected_command = "-dissolve 30% -quality 100 -gravity Center #{watermark_command} #{file.path} destination"
+      expect(command).to eq(expected_command)
+    end
+  end
+
+  describe "#watermark_command" do
+    let(:watermark_path) { 'watermark_path' }
+    before do
+      allow(subject).to receive(:scaled_size_for_watermark).and_return(Paperclip::Geometry.new(100,100))
+    end
+
+    it "returns the right command" do
+      expected_command = '\\( watermark_path -resize 100.0x100.0 \\)'
+      expect(subject.watermark_command).to eq(expected_command)
+    end
+  end
+
+  describe "#watermak_position" do
+    let(:position) { 'Center' }
+
+    context "with a position" do
+      it "returns the gravity" do
+        expect(subject.watermak_position).to eq('-gravity Center')
+      end
+    end
+
+    context "without a position" do
+      let(:position) { nil }
+      let(:watermark_distance_from_top) { 80 }
+
+      it "returns the geometry" do
+        expect(subject.watermak_position).to eq('-geometry +10.0+208.0')
+      end
+    end
+  end
+
+  describe "#scaled_size_for_watermark" do
+    it "returns the scaled size for the watermark" do
+      result = subject.scaled_size_for_watermark
+      expect(result.width).to eq(280)
+      expect(result.height).to eq(40.0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'paperclip'
+require 'paperclip-watermark'
+require File.expand_path('../../config/environment', __FILE__)
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: paperclip_watermark
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alessandro Caianiello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: ''
+email:
+- github@caianiello.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperclip/watermark.rb
+- lib/paperclip_watermark.rb
+- lib/paperclip_watermark/version.rb
+- paperclip_watermark.gemspec
+- spec/paperclip/watermark_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy.jpg
+- spec/support/logo.png
+homepage: ''
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Paperclip Watermark with resize support
+test_files:
+- spec/paperclip/watermark_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy.jpg
+- spec/support/logo.png