paperclip-document 0.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*~
+*.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 paperclip-document.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brice Texier
+
+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,29 @@
+# Paperclip::Document
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperclip-document'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-document
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/paperclip/document.rb

@@ -0,0 +1,44 @@
+require "paperclip/document/version"
+require "docsplit"
+require "pathname"
+
+module Paperclip
+  # Main processor
+  class DocumentProcessor < Processor
+    
+    attr_reader :instance, :tmp_dir
+
+    def initialize(file, options = {}, attachment = nil)
+      super(file, options, attachment)
+      @instance = @attachment.instance
+      @tmp_dir = Pathname.new(Dir.tmpdir).join("paperclip-document", instance.class.name, attachment.name.to_s, basename, Time.now.to_i.to_s(36) + "-" + rand(1_000_000).to_s(36))
+    end
+    
+    def file_path
+      Pathname.new(@file.path)
+    end
+
+    def basename
+      file_path.basename.to_s.gsub(/\.[^\.]+/, '')
+    end
+    
+  end
+
+  class Attachment
+
+    # Returns the content_text of the file as originally extracted, and lives in the <attachment>_content_text attribute of the model.
+    def content_text
+      instance_read(:content_text)
+    end
+
+    # Returns the pages_count of the file as originally computed, and lives in the <attachment>_pages_count attribute of the model.
+    def pages_count
+      instance_read(:pages_count)
+    end
+
+  end
+  
+
+end
+
+require "paperclip/document/processors"

data/lib/paperclip/document/processors.rb

@@ -0,0 +1,4 @@
+require "paperclip/document/processors/sketcher"
+require "paperclip/document/processors/reader"
+require "paperclip/document/processors/freezer"
+require "paperclip/document/processors/counter"

data/lib/paperclip/document/processors/counter.rb

@@ -0,0 +1,45 @@
+module Paperclip
+
+  # This processor extract the OCR text of the file
+  class Counter < DocumentProcessor
+
+    attr_accessor :pages_count_column
+
+    def initialize(file, options = {}, attachment = nil)
+      super(file, options, attachment)
+      if @options[:pages_count_column].nil? and pages_count_column?
+        @options[:pages_count_column] = default_pages_count_column
+      end
+      @pages_count_column = @options[:pages_count_column]
+
+      unless @pages_count_column
+        raise Paperclip::Error, "No pages count column given"
+      end
+    end
+
+    # Extract the pages count of all the document
+    def make
+      count = Docsplit.extract_length(file_path.to_s)
+
+      instance[pages_count_column] = count
+      instance.run_callbacks(:save) { false }
+
+      return file
+    end
+    
+    # Check if a pages count column is present
+    def pages_count_column?
+      expected_column = default_pages_count_column
+      return @attachment.instance.class.columns.detect do |column|
+        column.name.to_s == expected_column
+      end
+    end
+
+    # Returns the name of the default pages count column
+    def default_pages_count_column
+      @attachment.name.to_s + "_pages_count"
+    end
+
+  end
+
+end

data/lib/paperclip/document/processors/freezer.rb

@@ -0,0 +1,38 @@
+require 'filemagic'
+
+module Paperclip
+
+  # This processor extract first page as thumbnail
+  class Freezer < DocumentProcessor
+    def initialize(file, options = {}, attachment = nil)
+      super
+      @format = options[:format]
+      unless @format == :pdf
+        raise Paperclip::Error, "Valid format (pdf) must be specified"
+      end
+    end
+
+    # Convert the document to pdf
+    def make
+      destination_path = tmp_dir.to_s
+      destination_file = File.join(destination_path, basename + ".#{@format}")
+      if pdf_format?
+        destination_file = file_path.to_s
+      else
+        Docsplit.extract_pdf(file_path.to_s, :output => destination_path)
+      end
+      return File.open(destination_file)
+    end
+
+
+    def pdf_format?
+      file_magic = FileMagic.new
+      type = file_magic.file(file_path.to_s)
+      file_magic.close
+      type =~ /pdf/i
+    end
+
+  end
+
+
+end

data/lib/paperclip/document/processors/reader.rb

@@ -0,0 +1,53 @@
+module Paperclip
+
+  # This processor extract the OCR text of the file
+  class Reader < DocumentProcessor
+
+    attr_accessor :clean, :text_column, :language
+
+    def initialize(file, options = {}, attachment = nil)
+      super(file, options, attachment)
+      if @options[:text_column].nil? and text_column?
+        @options[:text_column] = default_text_column
+      end
+      @language = @options[:language]
+      @text_column = @options[:text_column]
+      unless @text_column
+        raise Paperclip::Error, "No content text column given"
+      end
+      @clean = !!(options.has_key?(:clean) ? options[:clean] : true)
+    end
+
+    # Extract the text of all the document
+    def make
+      destination_path = tmp_dir.to_s
+      options = {:output => destination_path, :clean => @clean}
+      options[:language] = (language.is_a?(Proc) ? language.call(attachment.instance) : language)
+      Docsplit.extract_text(file_path.to_s, options)
+      
+      destination_file = File.join(destination_path, basename + ".txt")
+      instance = @attachment.instance
+      f = File.open(destination_file)
+      instance[text_column] = f.read
+      instance.run_callbacks(:save) { false }
+      f.close
+
+      return file
+    end
+    
+    # Check if the default text column is present
+    def text_column?
+      expected_column = default_text_column
+      return instance.class.columns.detect do |column|
+        column.name.to_s == expected_column
+      end
+    end
+
+    # Returns the name of the default text column
+    def default_text_column
+      @attachment.name.to_s + "_content_text"
+    end
+
+  end
+
+end

data/lib/paperclip/document/processors/sketcher.rb

@@ -0,0 +1,39 @@
+module Paperclip
+
+  # This processor extract first page as thumbnail
+  class Sketcher < DocumentProcessor
+
+    attr_accessor :format, :density, :format
+
+    def initialize(file, options = {}, attachment = nil)
+      super(file, options, attachment)
+      @format  = (options[:format] || :jpg).to_sym
+      unless [:jpg, :png].include?(@format)
+        raise Paperclip::Error, "Valid format must be specified"
+      end
+      unless @size = options[:size]
+        @density = (options[:density] || 150).to_f
+      end
+    end
+
+    # Extract the page
+    def make
+      destination_path = tmp_dir.to_s
+      options = {:output => destination_path, :pages => [1], :format => [@format]}
+      if @size
+        options[:size] = @size
+      elsif @density
+        options[:density] = @density
+      end
+      Docsplit.extract_images(file_path.to_s, options)
+      begin
+      rescue
+        raise Paperclip::Error, "There was an error extracting the first thumbnail from #{basename}"
+      end
+      return File.open(File.join(destination_path, basename + "_1.#{@format}"))
+    end
+
+  end
+
+
+end

data/lib/paperclip/document/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module Document
+    VERSION = "0.0.0"
+  end
+end

data/paperclip-document.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip/document/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-document"
+  spec.version       = Paperclip::Document::VERSION
+  spec.authors       = ["Brice Texier"]
+  spec.email         = ["burisu@oneiros.fr"]
+  spec.summary       = %q{Processors for paperclip}
+  spec.homepage      = "http://github.com/burisu/paperclip-document"
+  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_dependency "paperclip", "~> 3.1"
+  spec.add_dependency "docsplit", "~> 0.7.2"
+  spec.add_dependency "ruby-filemagic", "~> 0.4.2"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'activerecord', "~> 3.2"
+  spec.add_development_dependency 'sqlite3'
+end

data/test/helper.rb

@@ -0,0 +1,37 @@
+require 'paperclip'
+require 'paperclip/railtie'
+require 'active_record'
+require 'pathname'
+require 'paperclip/document'
+require 'test/unit'
+
+# Connect to sqlite
+ActiveRecord::Base.establish_connection(
+  "adapter" => "sqlite3",
+  "database" => ":memory:"
+)
+
+ActiveRecord::Base.logger = Logger.new(nil)
+load(File.join(File.dirname(__FILE__), 'schema.rb'))
+
+Paperclip::Railtie.insert
+
+class Document < ActiveRecord::Base
+  has_attached_file(:original,
+                    :storage => :filesystem,
+                    :path => "./tmp/documents/:id/:style.:extension",
+                    :url => "/tmp/:id.:extension",
+                    :styles => {
+                      :archive => {:clean => true, :format =>:pdf, :processors => [:reader, :counter, :freezer]},
+                      :thumbnail => {:processors => [:sketcher], :format => :jpg}
+                    })
+end
+
+
+
+class Paperclip::Document::TestCase < Test::Unit::TestCase
+
+  def fixtures
+    Pathname.new(__FILE__).dirname.join("fixtures")
+  end
+end

data/test/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define :version => "001" do
+  create_table "documents", :force => true do |t|
+    t.string  :name
+    t.string  :original_file_name
+    t.string  :original_content_type
+    t.integer :original_updated_at
+    t.integer :original_file_size
+    t.text    :original_content_text
+    t.integer :original_pages_count
+  end
+end

data/test/test_processors.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'helper'
+
+class TestProcessors < Paperclip::Document::TestCase
+
+  def test_odt
+    f = File.open(fixtures.join("example.odt"))
+    document = Document.create!(:name => "My first document", :original => f)
+    f.close
+
+    document.reload
+    assert_equal 1, document.original.pages_count
+
+    assert !document.original.content_text.nil?
+    assert document.original.content_text.match("This is an example.")
+  end
+
+  def test_pdf
+    f = File.open(fixtures.join("example.pdf"))
+    document = Document.create!(:name => "My second document", :original => f)
+    f.close
+
+    document.reload
+    assert_equal 1, document.original.pages_count
+
+    assert !document.original.content_text.nil?
+    assert document.original.content_text.match("This is an example.")
+  end
+
+  def test_docx
+    f = File.open(fixtures.join("example.docx"))
+    document = Document.create!(:name => "My third document", :original => f)
+    f.close
+
+    document.reload
+    assert_equal 1, document.original.pages_count
+
+    assert !document.original.content_text.nil?
+    assert document.original.content_text.match("This is an example.")
+  end
+
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-document
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brice Texier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: docsplit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: 
+email:
+- burisu@oneiros.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperclip/document.rb
+- lib/paperclip/document/processors.rb
+- lib/paperclip/document/processors/counter.rb
+- lib/paperclip/document/processors/freezer.rb
+- lib/paperclip/document/processors/reader.rb
+- lib/paperclip/document/processors/sketcher.rb
+- lib/paperclip/document/version.rb
+- paperclip-document.gemspec
+- test/fixtures/example.docx
+- test/fixtures/example.odt
+- test/fixtures/example.pdf
+- test/helper.rb
+- test/schema.rb
+- test/test_processors.rb
+homepage: http://github.com/burisu/paperclip-document
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Processors for paperclip
+test_files:
+- test/fixtures/example.docx
+- test/fixtures/example.odt
+- test/fixtures/example.pdf
+- test/helper.rb
+- test/schema.rb
+- test/test_processors.rb
+has_rdoc: