paperclip_utils 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edb0136a20bafc183e70c8be005f63d73e6ce48b
-  data.tar.gz: da33fd10aaeda193e7cdd14e73bd288b385ca8e0
+  metadata.gz: 3b4320db1228b252e0ec23254e663d9814219859
+  data.tar.gz: be9dc86758d73abff8b65e1f0551a0b87d3e7d0e
 SHA512:
-  metadata.gz: e02327b9b03ed0818f04aca9142d4d8009384e854674a7ea093538941a55f8b626f993ba309458b30b297124344f6a2a08419360a69e0123c6f44bf5152e36de
-  data.tar.gz: d0d39cbecf6bd53b80a58e5c4cb67e039fa2e29ce984670ae919418611e8db823f89b8308d75390e1aa98bcf8cb9651544c68fef3dab83fbf79282e07e068c94
+  metadata.gz: cb2afa7f6bcbb7170a5bd8643fcb1e265325acef96b0556010dff0e881e436a678b3db3a9882067457b66c76ef1fc6ce944d898c7b998a6ac77b5d5a475683f2
+  data.tar.gz: 85456b448b69026c6ab90ac67f0f7b8d77f6eb509cffcc00c8104164a7013dc05582b8565ed6a4fe797d2d97aaf9e220c7c5f9ff9ac5c3c05584d57bfdb282ff

data/README.md

@@ -1,24 +1,26 @@
 # Paperclip Utils
 <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VKY8YAWAS5XRQ&lc=CA&item_name=Weston%20Ganger&item_number=paperclip_utils&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest" target="_blank" title="Donate"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Donate"/></a>
 
-Paperclip Utils is a helper class for easier dynamic processors and styles on your Paperclip file uploads
+Paperclip Utils is a helper class for easier dynamic processors and styles on your Paperclip file uploads. It also has a collection of custom Paperclip processors.
 
 
 # Install
 ```ruby
+# requires ruby >= 2.0
 gem install paperclip_utils
 ```
 
+# Custom Processors
+**Ghostscript** - `:ghostscript` - Fixes black boxes and errors thumbnail processing for PDF files. This is automatically included if processors includes :thumbnail which it does by default
 
-Paperclip Utils contains the following methods:
-```ruby
-Paperclip::Utils.get_processors(content_type, processors_if_allowed, fallback_processors, allowed_content_types)
+**XLS to CSV** - `:xls_to_csv` - Converts XLS/XLSX files to CSV
 
-Paperclip::Utils.get_styles(content_type, styles_if_allowed, fallback_processors, allowed_content_types)
-```
+**PDF Merge** - `:pdf_merge` - A way to handle multiple pdf uploads, requires some custom wiring, must add a `pdf_files` method to your model and temporarily save files with this though.
+
+Check the processor source to see examples if required. [See all processors & examples here](https://github.com/westonganger/paperclip_utils/tree/master/lib/paperclip_processors).
 
 
-# Usage
+# Helper Methods Usage
 ```ruby
 class Post < ActiveRecord::Base
   has_attachment :my_attachment, 
@@ -27,18 +29,35 @@ class Post < ActiveRecord::Base
     path: "public/system/:class/:attachment/:id_partition/:style/:filename",
     url: "#{ActionController::Base.relative_url_root}/system/:class/:attachment/:id_partition/:style/:filename"
 end
+
+# OR using any or all of the custom options
+
+class Post < ActiveRecord::Base
+  has_attachment :my_attachment, 
+    styles: lambda{|x| Paperclip::Utils.get_styles(x.instance.my_attachment.content_type, styles: {preview: "800x600>", thumb: "100x100>"}, fallback_styles: nil, allowed_content_types: ['application/pdf']) }, 
+    processors: lambda{|x| Paperclip::Utils.get_processors(x.my_attachment.content_type, processors: [:thumbnail, :some_other_custom_processor], fallback_processors: [:another_custom_processor], allowed_content_types: ['application/pdf']) },
+    path: "public/system/:class/:attachment/:id_partition/:style/:filename",
+    url: "#{ActionController::Base.relative_url_root}/system/:class/:attachment/:id_partition/:style/:filename"
+end
 ```
 
+# Helper Methods & Options
 
+<br>
+#### `get_styles(content_type, *optional_options)`
+**styles** - Array - Default: `[:thumbnail]`
 
-# Methods
+**fallback_styles** - Hash - Default -`{}`
 
-**get_processors** - `String(file content_type), Array(optional - default=[:ghostscript,:thumbnail]), Array(optional - default=[]), Array(optional - allowed content types)`
+**allowed_content_types** - Array - Default: `['application/pdf', 'image/png', 'image/x-png', 'image/gif', 'image/jpeg', 'image/pjpeg', 'image/jpg', 'image/tif, ''image/tiff', 'image/x-tiff']`
 
-**get_styles** - `String(file content type)Hash(optional - default={preview: "800x600>", thumb: "100x100>"}), Hash(optional - default={}), Array(optional - allowed content types)`
+<br>
+#### `get_processors(content_type, *optional_options)`
+**processors** - Array - Default: `[:ghostscript, :thumbnail]` - Notes: Automatically includes ghostscript processor if processors includes :thumbnail which it does by default
 
-**ALLOWED_CONTENT_TYPES** - Default allowed content types. `['application/pdf', 'image/png', 'image/x-png', 'image/gif', 'image/jpeg', 'image/pjpeg', 'image/jpg', 'image/tif, ''image/tiff', 'image/x-tiff']`
+**fallback_processors** - Array - Default: `[]`
 
+**allowed_content_types** - Array - Default: `['application/pdf', 'image/png', 'image/x-png', 'image/gif', 'image/jpeg', 'image/pjpeg', 'image/jpg', 'image/tif, ''image/tiff', 'image/x-tiff']`
 
 
 # Credits

data/lib/paperclip_processors/pdf_merge.rb

@@ -0,0 +1,69 @@
+# Merge pdf files (for transmittals)
+#https://gist.github.com/jessieay/5832466
+# Ex. http://stackoverflow.com/questions/17203270/combine-multi-page-pdfs-into-one-pdf-with-imagemagick
+#
+# First save your files to a temporary location then save your model with any arbitrary file attached which will not be saved.
+#
+# Example Model:
+# class SomeCsvAttachement < ActiveRecord::Base
+#   has_attached_file :data,
+#     path: ":rails_root/data/some_csv_attachements/:id_partition/:basename.:extension",
+#     processors: [:pdf_merge]
+#
+#   def pdf_files
+#     base_path = File.join(Rails.root, 'tmp')
+#     
+#     # Specific files
+#     [ File.join(base_path, 'path/to/file.pdf'), File.join(base_path, 'another/file/path.pdf') ]
+#     
+#     # Or all files in a folder
+#     Dir.glob(File.join(base_path,"/path/to/folder/*"))
+#   end
+#
+#   validates_attachment_content_type :data, content_type: ['application/pdf']
+# end
+
+module Paperclip
+  class PdfMerge < Processor
+
+    def initialize file, options = {}, attachment = nil
+      super
+      @format = File.extname(@file.path)
+      @basename = File.basename(@file.path, @format)
+      @files = attachment.instance.pdf_files
+    end
+
+    def make
+      src = @file
+      if @current_format && @current_format.downcase == '.pdf'
+        dst = Tempfile.new([@basename, @format])
+        dst.binmode
+
+        file_paths = @files.map {|file| "#{Rails.root}/tmp/#{file.original_filename}"}
+
+        all_page_file_paths = ""
+
+        file_paths.each do |file_path|
+          pdf = PDF::Reader.new(file_path)
+          count = pdf.page_count
+          counter = 0
+
+          count.times do
+            all_page_file_paths += "#{file_path}[#{counter}] "
+            counter += 1
+          end
+        end
+
+         Paperclip.run(
+           'convert',
+           "-density 150 #{all_page_file_paths} #{File.expand_path(dst.path)}"
+          )
+
+        return dst
+      else
+        return src
+      end
+    end
+
+  end
+end

data/lib/paperclip_processors/xls_to_csv.rb

@@ -0,0 +1,72 @@
+# https://github.com/igor-alexandrov/xls_to_csv-paperclip-processor
+#
+# Example Model:
+# class SomeCsvAttachement < ActiveRecord::Base
+#   has_attached_file :data,
+#     styles: {
+#       converted: {
+#         format: "csv",
+#         params: "-c, -q 3"
+#       }
+#     },
+#     path: ":rails_root/data/some_csv_attachements/:id_partition/:basename.:extension",
+#     processors: [:xls_to_csv]
+#
+#   validates_attachment_content_type :data, content_type: ['text/csv','text/comma-separated-values','text/csv','application/csv','application/excel','application/vnd.ms-excel','application/vnd.msexcel','text/anytext','text/plain']
+# end
+
+class Paperclip::XlsToCsv < Paperclip::Processor
+  attr_accessor :file, :params, :format
+
+  def initialize(file, options = {}, attachment = nil)
+    super
+
+    @file           = file
+    @params         = options[:params]
+    @current_format = File.extname(@file.path)
+    @basename       = File.basename(@file.path, @current_format)
+    @format         = options[:format]
+  end
+
+  def make
+    src = @file
+
+    if @current_format && ['.xls','xlsx'].include?(@current_format.downcase)
+      dst = Tempfile.new([@basename, @format ? "#{@format}" : 'csv'].compact.join("."))
+      begin
+        Paperclip.run(self.command, self.parameters(src, dst))
+      rescue StandardError => e
+        raise "There was an error converting #{@basename} to csv: #{e.message}"
+      end
+      return dst
+    else
+      return src 
+    end
+  end
+
+protected
+
+  def command
+    case @current_format
+    when '.xls'
+      'xls2csv'
+    when '.xlsx'
+      'xlsx2csv'
+    else
+      'cp'
+    end
+  end
+
+  def parameters(src, dst)
+    p = []
+
+    if self.command == 'xls2csv'
+      p << [@params, File.expand_path(src.path).shellescape, "> #{File.expand_path(dst.path).shellescape}"]
+    else
+      p << [File.expand_path(src.path).shellescape, File.expand_path(dst.path).shellescape]
+    end
+
+    p.flatten.compact.join(" ").strip.squeeze(" ")
+  end
+
+end

data/lib/paperclip_utils/version.rb

@@ -1,3 +1,3 @@
 module PaperclipUtils
-  VERSION = '1.2.2'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip_utils
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Weston Ganger
@@ -106,6 +106,8 @@ files:
 - README.md
 - Rakefile
 - lib/paperclip_processors/ghostscript.rb
+- lib/paperclip_processors/pdf_merge.rb
+- lib/paperclip_processors/xls_to_csv.rb
 - lib/paperclip_utils.rb
 - lib/paperclip_utils/version.rb
 - test/database.yml