caption_paperclip_processor 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzEwYmRiZjY0OTY0OTgwM2NhMjg4ZjExOGVjZTk1MDEzYThhYWZjZg==
+  data.tar.gz: !binary |-
+    MWZkOTI0NGE1MGE1MDdjNTM0YjEyMDZkNGE1Mzc5MDkyNTBkYWIyZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZmEwMmJiZGVmNDRmNmM4YmZkM2FlYmJiNmFmODM4MTY1MGZmY2QzMWNmMzJk
+    YjVlMTI0YTcxNjAyNTgwYTRjY2IxZDVmNGZhNDI0NzVhOTI1NmIwODhhNzE5
+    MGZjYmI3ZGQ1NGIyNWMwNTNmNjJhNWFjZmVlODRkNmJhNGY5YTc=
+  data.tar.gz: !binary |-
+    ZWYwMjIxNTZkNDc1MjgxMzJiNzg5YzkyMjg1OTZjODc3OWM4MGIwOTg3ZGVi
+    MTA5NDI2YjU4YzRmMjA5OGUzYTAyMjE4ZDQ5ODU2MzE3Y2JhYTU5YWM0ZjI1
+    NDRlNmViZWFjMzgzMTY3ZjE3MTc0OWJhMDE1ZGU3OWZkNjk3MzU=

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,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in caption_paperclip_processor.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Shaun Dern
+
+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,49 @@
+# CaptionPaperclipProcessor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'caption_paperclip_processor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caption_paperclip_processor
+
+## Usage
+
+```ruby
+class ImageWithCaption  < ActiveRecord::Base
+  has_attached_file :image, styles: {
+    geometry: "350x250",
+    processors: [:caption],
+    caption: "Some caption text",
+    position: 'center',
+    interword_spacing: 10,
+    kerning: 2.5,
+    padding_height: 12,
+    padding_width: 26,
+    font: Rails.root.join('app', 'assets', 'fonts', 'someFont.ttf'),
+    font_color: "rgba\\(255,255,255,0.8\\)",
+    caption_background: "gray"
+  }
+end
+```
+
+The geometry will be the size of the caption that will fill the caption. Font
+size will be whatever is 'best fit' into the caption 'box'
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+

data/Rakefile

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

data/caption_paperclip_processor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caption_paperclip_processor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caption_paperclip_processor"
+  spec.version       = CaptionPaperclipProcessor::VERSION
+  spec.authors       = ["Shaun Dern"]
+  spec.email         = ["shaun@substantial.com"]
+  spec.description   = %q{Add captions to images}
+  spec.summary       = %q{Add captions to images}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "paperclip", "~> 3.4.0"
+end
+

data/lib/caption_paperclip_processor/version.rb

@@ -0,0 +1,4 @@
+module CaptionPaperclipProcessor
+  VERSION = "0.0.1"
+end
+

data/lib/caption_paperclip_processor.rb

@@ -0,0 +1,110 @@
+require "paperclip"
+
+module Paperclip
+  class Caption < Processor
+
+    def initialize file, options = {}, attachment = nil
+      super
+
+      @file             = file
+      @format           = options[:format]
+      @current_format   = File.extname(@file.path)
+      @basename         = File.basename(@file.path, @current_format)
+    end
+
+    def make
+      src = @file
+      dst = Tempfile.new([@basename, @format].compact.join("."))
+      dst.binmode
+
+      begin
+        parameters = []
+        parameters << caption_options
+        parameters << caption
+        parameters << ":source"
+        parameters << "+swap"
+        parameters << "-gravity center"
+        parameters << "-composite"
+        parameters << ":dest"
+
+        parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
+
+        success = convert(parameters, source: "#{File.expand_path(src.path)}[0]", dest: File.expand_path(dst.path))
+      rescue Cocaine::ExitStatusError => e
+        raise Paperclip::Error, "There was an error processing caption for #{@basename}" if @whiny
+      rescue Cocaine::CommandNotFoundError => e
+        raise Paperclip::Errors::CommandNotFoundError.new("Could not run the `convert` command. Please install ImageMagick.")
+      end
+
+      dst
+    end
+
+    protected
+
+    def caption_options
+      opts = []
+      opts << caption_background
+      opts << font_color
+      opts << line_height
+      opts << letter_spacing
+      opts << word_spacing
+      opts << position
+      opts << caption_size
+      opts << font
+      opts
+    end
+
+    def caption_background
+      "-background #{background_color}"
+    end
+
+    def background_color
+      @options[:caption_background] || "none"
+    end
+
+    def font_color
+      "-fill #{@options[:font_color]}" if @options[:font_color]
+    end
+
+    def font
+      "-font #{@options[:font]}" if @options[:font]
+    end
+
+    def caption
+      "caption:'#{@options[:caption] || ""}'"
+    end
+
+    def position
+      "-gravity #{@options[:position] || "center"}"
+    end
+
+    def letter_spacing
+      "-kerning #{@options[:kerning] || 1.5}"
+    end
+
+    def word_spacing
+      "-interword-spacing #{@options[:interword_spacing] || 5}"
+    end
+
+    def line_height
+      "-interline-spacing  #{@options[:interline_spacing] || 18}"
+    end
+
+    def caption_size
+      "-size #{caption_width}X#{caption_height}"
+    end
+
+    def caption_width
+      width = @options[:geometry].split(/[^\d+]/).first.to_i
+      width -= @options[:padding_width] if @options[:padding_width]
+      width
+    end
+
+    def caption_height
+      height = @options[:geometry].split(/[^\d+]/).last.to_i
+      height -= @options[:padding_height] if @options[:padding_height]
+      height
+    end
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: caption_paperclip_processor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shaun Dern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Add captions to images
+email:
+- shaun@substantial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- caption_paperclip_processor.gemspec
+- lib/caption_paperclip_processor.rb
+- lib/caption_paperclip_processor/version.rb
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Add captions to images
+test_files: []