paperclip_montage 0.1.0

data/README.md

@@ -0,0 +1,67 @@
+
+Paperclip Montage
+=================
+
+Paperclip Montages aim is to make it easier to create Paperclip avatars for meta models. It is a wrapper for ImageMagick's `montage` tool.
+
+This was build for [Oplerno](http://www.oplerno.com/)'s online education platform for combining course avatars so they can be displayed as certificate avatars.
+
+[![Build Status](https://travis-ci.org/webhat/paperclip_montage.svg)](https://travis-ci.org/webhat/paperclip_montage)
+
+Installation
+============
+
+```
+gem 'paperclip_montage'
+```
+
+```
+gem install paperclip_montage
+```
+
+Example
+=======
+
+This is a simple example in which `Meta` creates a combined avatar. 
+
+```ruby
+class Avatar < ActiveRecord::Base
+	has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+
+	has_and_belongs_to_many :metas
+
+	validates_attachment_content_type :avatar, :content_type => /\Aimage\/.*\Z/
+end
+```
+
+```ruby
+class Meta < ActiveRecord::Base
+	#after_update :reprocess_montage
+
+	has_and_belongs_to_many :avatars
+
+	has_attached_file :montage,
+		processors: [:montage],
+		:styles => { medium: { geometry: "300x300>", source: :avatars} , thumb: { geometry: "100x100>" } }
+
+	validates_attachment :montage, :attachment_presence => true,
+		:content_type => { :content_type => "image/jpeg" }
+
+	def reprocess_montage
+		montage.reprocess!
+	end
+end
+```
+
+After any changes to the icon for an `Avatar` the method `reprocess_montage` must be called on the `Meta` object.
+
+
+Acknowledgements
+================
+Test image by Matthias Georg - https://www.flickr.com/photos/114805503@N05/15811868778/ 
+
+Help from these sources:
+* https://github.com/janfoeh/paperclip-optimizer
+* https://github.com/thoughtbot/paperclip
+* https://gist.github.com/laurynas/708077
+* http://matthewhutchinson.net/2010/10/25/editing-file-uploads-with-a-paperclip-processor

data/Rakefile

@@ -0,0 +1,50 @@
+# 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 './lib/paperclip/myversion.rb'
+Jeweler::Tasks.new do |gem|
+  gem.name = "paperclip_montage"
+  gem.homepage = "http://github.com/webhat/paperclip_montage"
+  gem.license = "LGPLv2"
+  gem.summary = "Paperclip Montage"
+  gem.description = "This module stores the image files in Redis"
+  gem.authors = ["Daniel W. Crompton"]
+	gem.email = ['paperclip+montage@specialbrands.net']
+  gem.version = Paperclip::Version::STRING
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/{models,paperclip}/*_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 = "paperclip_montage #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config/Guardfile

@@ -0,0 +1,14 @@
+
+guard :rspec, cmd: 'bundle exec rspec' do
+	watch(%r{^spec/.+_spec\.rb$})
+	watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+	watch('spec/spec_helper.rb')           { "spec" }
+	watch ("config/Guardfile") { UI.info "Exiting guard because config changed"; exit 0 }
+
+	# Ignore
+	ignore %r{^spec/rails-app/}
+end
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+end

data/lib/generators/paperclip_montage/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate paperclip_montage Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/paperclip_montage/paperclip_montage_generator.rb

@@ -0,0 +1,3 @@
+class PaperclipMontageGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+end

data/lib/paperclip/montage.rb

@@ -0,0 +1,94 @@
+# Using https://gist.github.com/laurynas/708077 as a guide
+module Paperclip
+	class Montage < Processor
+		attr_accessor :whiny
+
+		def initialize file, options = {}, attachment = nil
+			super
+			@file            =  file
+			@format          =  options[:format]
+			@source          =  options[:source]
+			setup_montage_sources @source
+			setup_geometry options[:geometry]
+			@current_format  =  File.extname(@file.path)
+			@basename        =  File.basename(@file.path,  @current_format)
+			@whiny           =  options[:whiny].nil? ? true : options[:whiny]
+			@attachment      =  attachment
+		end
+
+		def setup_geometry geometry
+			@height, @width  =  '100', '100'
+			@height, @width  =  geometry.split('x') unless geometry.nil?
+		end
+
+		def setup_montage_sources source
+			source_instance_vars
+
+			if source.is_a?(Symbol)
+				return if @attachment.instance.nil?
+				source = @attachment.instance.send(source).map { |f| File.open(f.avatar.path( :original )) }
+			end
+
+			return if source.nil? || source.empty?
+
+			source_instance_vars source, source.length
+		end
+
+		def source_instance_vars files = nil, imgs = 4
+			@files = files
+			@num_of_imgs = imgs
+		end
+
+		def make
+			command = 'montage'
+
+			dst = Tempfile.new([@basename, @format].compact.join("."))
+			dst.binmode
+
+			# -title 'Certificate'
+			args =  "-background '#ffffff' -geometry #{height}x#{width}+#{grid} #{input_files_text} #{output_file dst}"
+
+			Paperclip.run(command, args)
+
+			dst
+		end
+
+		def width
+			@width.gsub(/[^0-9]/,'').to_i/side
+		end
+
+		def height
+			@height.gsub(/[^0-9]/,'').to_i/side
+		end
+
+		def side
+			input_files.length/2
+		end
+
+		def grid
+			"#{side}+#{side}"
+		end
+
+		def input_files_text
+			input_files.join(' ')
+		end
+
+		def input_files
+			(0..@num_of_imgs-1).collect do |i|
+				if @files.nil?
+					absolute_file( @file )
+				else
+					absolute_file( @files[i] )
+				end
+			end
+		end
+
+		def output_file dst
+			absolute_file dst
+		end
+
+		def absolute_file file
+			"#{ File.expand_path(file.path) }"
+		end
+	end
+end

data/lib/paperclip/myversion.rb

@@ -0,0 +1,11 @@
+# in lib/paperclip/version.rb
+class Paperclip
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end
+

data/lib/paperclip_montage.rb

@@ -0,0 +1,5 @@
+module Paperclip
+	autoload :Version, 'paperclip/version'
+	autoload :Montage, 'paperclip/montage'
+	autoload :Watermark, 'paperclip/watermark'
+end

data/paperclip_montage.gemspec

@@ -0,0 +1,154 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: paperclip_montage 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "paperclip_montage"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Daniel W. Crompton"]
+  s.date = "2014-12-14"
+  s.description = "This module stores the image files in Redis"
+  s.email = ["paperclip+montage@specialbrands.net"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Guardfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "config/Guardfile",
+    "lib/generators/paperclip_montage/USAGE",
+    "lib/generators/paperclip_montage/paperclip_montage_generator.rb",
+    "lib/paperclip/montage.rb",
+    "lib/paperclip/myversion.rb",
+    "lib/paperclip_montage.rb",
+    "paperclip_montage.gemspec",
+    "spec/fixtures/valid.jpg",
+    "spec/fixtures/valid1.png",
+    "spec/fixtures/valid2.png",
+    "spec/fixtures/valid3.png",
+    "spec/fixtures/valid4.png",
+    "spec/paperclip/montage_spec.rb",
+    "spec/rails-app/.gitignore",
+    "spec/rails-app/.rspec",
+    "spec/rails-app/Gemfile",
+    "spec/rails-app/Guardfile",
+    "spec/rails-app/README.rdoc",
+    "spec/rails-app/Rakefile",
+    "spec/rails-app/app/assets/images/.keep",
+    "spec/rails-app/app/assets/javascripts/application.js",
+    "spec/rails-app/app/assets/stylesheets/application.css",
+    "spec/rails-app/app/controllers/application_controller.rb",
+    "spec/rails-app/app/controllers/concerns/.keep",
+    "spec/rails-app/app/helpers/application_helper.rb",
+    "spec/rails-app/app/models/.keep",
+    "spec/rails-app/app/models/avatar.rb",
+    "spec/rails-app/app/models/avatars_meta.rb",
+    "spec/rails-app/app/models/concerns/.keep",
+    "spec/rails-app/app/models/meta.rb",
+    "spec/rails-app/app/views/layouts/application.html.erb",
+    "spec/rails-app/bin/bundle",
+    "spec/rails-app/bin/rails",
+    "spec/rails-app/bin/rake",
+    "spec/rails-app/bin/spring",
+    "spec/rails-app/config.ru",
+    "spec/rails-app/config/Guardfile",
+    "spec/rails-app/config/application.rb",
+    "spec/rails-app/config/boot.rb",
+    "spec/rails-app/config/database.yml",
+    "spec/rails-app/config/environment.rb",
+    "spec/rails-app/config/environments/development.rb",
+    "spec/rails-app/config/environments/production.rb",
+    "spec/rails-app/config/environments/test.rb",
+    "spec/rails-app/config/initializers/assets.rb",
+    "spec/rails-app/config/initializers/backtrace_silencers.rb",
+    "spec/rails-app/config/initializers/cookies_serializer.rb",
+    "spec/rails-app/config/initializers/filter_parameter_logging.rb",
+    "spec/rails-app/config/initializers/inflections.rb",
+    "spec/rails-app/config/initializers/mime_types.rb",
+    "spec/rails-app/config/initializers/session_store.rb",
+    "spec/rails-app/config/initializers/wrap_parameters.rb",
+    "spec/rails-app/config/locales/en.yml",
+    "spec/rails-app/config/routes.rb",
+    "spec/rails-app/config/secrets.yml",
+    "spec/rails-app/db/migrate/20141212000615_create_avatars.rb",
+    "spec/rails-app/db/migrate/20141212000731_create_meta.rb",
+    "spec/rails-app/db/migrate/20141214193102_create_avatars_meta.rb",
+    "spec/rails-app/db/schema.rb",
+    "spec/rails-app/db/seeds.rb",
+    "spec/rails-app/public/404.html",
+    "spec/rails-app/public/422.html",
+    "spec/rails-app/public/500.html",
+    "spec/rails-app/public/favicon.ico",
+    "spec/rails-app/public/robots.txt",
+    "spec/rails-app/spec/models/avatar_spec.rb",
+    "spec/rails-app/spec/models/avatars_meta_spec.rb",
+    "spec/rails-app/spec/models/meta_spec.rb",
+    "spec/rails-app/spec/rails_helper.rb",
+    "spec/rails-app/spec/spec_helper.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/webhat/paperclip_montage"
+  s.licenses = ["LGPLv2"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Paperclip Montage"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<paperclip>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard-yard>, [">= 0"])
+      s.add_development_dependency(%q<rails>, [">= 3.1.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<coveralls>, [">= 0"])
+    else
+      s.add_dependency(%q<paperclip>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<guard-yard>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 3.1.0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<coveralls>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<paperclip>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<guard-yard>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 3.1.0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<coveralls>, [">= 0"])
+  end
+end
+

data/spec/paperclip/montage_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+RSpec.describe Paperclip::Montage do
+	before(:all) do
+		@file = get_fixture(:jpg)
+	end
+	after(:all) do
+		@file.close
+	end
+	it '#initialize' do
+		expect(described_class.new @file).to_not be_nil
+	end
+	it '#initialize nil' do
+		expect{
+			described_class.new nil
+		}.to raise_error
+	end
+	it '#make' do
+		expect(described_class.new(@file).make).to be_kind_of(Tempfile)
+	end
+	it '.make' do
+		expect(described_class.make(@file)).to be_kind_of(Tempfile)
+	end
+	context 'multiple files' do
+		before do
+			@file1 = get_fixture(:png, 'valid1')
+			@file2 = get_fixture(:png, 'valid2')
+			@file3 = get_fixture(:png, 'valid3')
+			@file4 = get_fixture(:png, 'valid4')
+		end
+
+		it 'creates a montage' do
+			options = {geometry: '200x200', source: [@file1, @file2, @file3, @file4]}
+			montage = described_class.new @file, options
+			tempfile = montage.make
+			expect(tempfile).to be_kind_of(Tempfile)
+			#ObjectSpace.undefine_finalizer(tempfile)
+		end
+
+		it 'creates a montage with source nil' do
+			options = {geometry: '200x200', source: nil}
+			montage = described_class.new @file, options
+			tempfile = montage.make
+			expect(tempfile).to be_kind_of(Tempfile)
+			#ObjectSpace.undefine_finalizer(tempfile)
+		end
+
+		it 'creates a montage with source empty' do
+			options = {geometry: '200x200', source: []}
+			montage = described_class.new @file, options
+			tempfile = montage.make
+			expect(tempfile).to be_kind_of(Tempfile)
+			#ObjectSpace.undefine_finalizer(tempfile)
+		end
+	end
+end