activestorage-office-previewer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a33977bb24c7a89382dbab79fc7c2711b8c2a78e9fad5ee6e772219f261f5f67
+  data.tar.gz: '0593c3cc8b6d01d48994b8d02d7447f96b485b41d15e8d80b33eed01bd6b1c8e'
+SHA512:
+  metadata.gz: a8a4248278c81b4631bf453d0ecd74b153e12ecc58df1d1a250451c0d9eab31700eb66e02b7cd033bab538062e0465fc77f16687293c78e1e5371d3afe677e27
+  data.tar.gz: 307b7c2b958bc914a0d3f9a28b789a6a2301111832d1522439c7170e748a4081cf1f5d3aa1720b66f228f44c9f940dffc101042ea1748f26d674def3cd7a65df

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.byebug_history

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,151 @@
+PATH
+  remote: .
+  specs:
+    activestorage-office-previewer (0.1.0)
+      activestorage (>= 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.1)
+      actionpack (= 6.0.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.1)
+      actionpack (= 6.0.1)
+      activejob (= 6.0.1)
+      activerecord (= 6.0.1)
+      activestorage (= 6.0.1)
+      activesupport (= 6.0.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.1)
+      actionpack (= 6.0.1)
+      actionview (= 6.0.1)
+      activejob (= 6.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.1)
+      actionview (= 6.0.1)
+      activesupport (= 6.0.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.1)
+      actionpack (= 6.0.1)
+      activerecord (= 6.0.1)
+      activestorage (= 6.0.1)
+      activesupport (= 6.0.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.1)
+      activesupport (= 6.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.1)
+      activesupport (= 6.0.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activerecord (6.0.1)
+      activemodel (= 6.0.1)
+      activesupport (= 6.0.1)
+    activestorage (6.0.1)
+      actionpack (= 6.0.1)
+      activejob (= 6.0.1)
+      activerecord (= 6.0.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_magick (4.9.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.6)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.1)
+      actioncable (= 6.0.1)
+      actionmailbox (= 6.0.1)
+      actionmailer (= 6.0.1)
+      actionpack (= 6.0.1)
+      actiontext (= 6.0.1)
+      actionview (= 6.0.1)
+      activejob (= 6.0.1)
+      activemodel (= 6.0.1)
+      activerecord (= 6.0.1)
+      activestorage (= 6.0.1)
+      activesupport (= 6.0.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.1)
+      actionpack (= 6.0.1)
+      activesupport (= 6.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activestorage-office-previewer!
+  bundler (~> 1.17)
+  byebug
+  mini_magick (~> 4.9.5)
+  minitest (~> 5.13.0)
+  rails (>= 6.0.0)
+  rake (~> 13.0.0)
+  sqlite3 (~> 1.4.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Basecamp, LLC
+
+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,24 @@
+# Active Storage previewer for Microsoft Office files
+
+Use [LibreOffice](https://www.libreoffice.org/) to generate previews for Microsoft Word documents, Microsoft PowerPoint presentations, and Microsoft Excel spreadsheets in [Active Storage](https://guides.rubyonrails.org/active_storage_overview.html).
+
+## Requirements
+
+* Rails 6.0 or newer
+* [LibreOffice](https://www.libreoffice.org/) 6.2 or newer
+
+## Usage
+
+Add the `activestorage-office-previewer` gem to your app’s Gemfile and run `bundle install`:
+
+```ruby
+gem "activestorage-office-previewer"
+```
+
+Generate previews of Microsoft Office files using Active Storage’s [preview feature](https://guides.rubyonrails.org/active_storage_overview.html#previewing-files).
+
+## License
+
+This gem is released under the terms of the MIT license.
+
+LibreOffice is released under the terms of the [Mozilla Public License, version 2.0](https://www.libreoffice.org/about-us/licenses/).

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/activestorage-office-previewer.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name     = "activestorage-office-previewer"
+  s.version  = "0.1.0"
+  s.authors  = "George Claghorn"
+  s.email    = "george@basecamp.com"
+  s.summary  = "Active Storage previewer for Microsoft Office files based on LibreOffice"
+  s.homepage = "https://github.com/basecamp/activestorage-office-previewer"
+  s.license  = "MIT"
+
+  s.required_ruby_version = ">= 2.6.0"
+
+  s.files      = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+
+  s.add_dependency "activestorage", ">= 6.0.0"
+
+  s.add_development_dependency "bundler", "~> 1.17"
+  s.add_development_dependency "rake", "~> 13.0.0"
+  s.add_development_dependency "minitest", "~> 5.13.0"
+  s.add_development_dependency "mini_magick", "~> 4.9.5"
+  s.add_development_dependency "sqlite3", "~> 1.4.1"
+  s.add_development_dependency "byebug"
+
+  s.add_development_dependency "rails", ">= 6.0.0"
+end

data/lib/active_storage/previewer/office_previewer.rb

@@ -0,0 +1,57 @@
+require "active_storage/previewer"
+
+class ActiveStorage::Previewer::OfficePreviewer < ActiveStorage::Previewer
+  ACCEPTABLE_CONTENT_TYPES = [
+    "application/msword", # .doc
+    "application/vnd.openxmlformats-officedocument.wordprocessingml.document", # .docx
+
+    "application/vnd.ms-powerpoint", # .ppt
+    "application/vnd.openxmlformats-officedocument.presentationml.presentation", # .pptx
+
+    "application/vnd.ms-excel", # .xls
+    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" # .xlsx
+  ]
+
+  class << self
+    def accept?(blob)
+      blob.content_type.in?(ACCEPTABLE_CONTENT_TYPES) && soffice_exists?
+    end
+
+    def soffice_exists?
+      if @soffice_exists.nil?
+        @soffice_exists = system(soffice_path, "--version", out: File::NULL, err: File::NULL)
+      else
+        @soffice_exists
+      end
+    end
+
+    def soffice_path
+      ActiveStorage.paths[:soffice] || "soffice"
+    end
+  end
+
+  def preview
+    download_blob_to_tempfile do |input|
+      draw_poster_image_from input do |output|
+        yield io: output, filename: "#{blob.filename.base}.png", content_type: "image/png"
+      end
+    end
+  end
+
+  private
+    def draw_poster_image_from(file, &block)
+      system soffice_path, "--headless", "--invisible", "--convert-to", "png",
+        "--outdir", tmpdir, file.path, out: File::NULL, err: File::NULL
+      consume "#{tmpdir}/#{File.basename(file.path, ".*")}.png", &block
+    end
+
+    def consume(path, &block)
+      File.open(path, "rb", &block)
+    ensure
+      File.delete(path)
+    end
+
+    def soffice_path
+      self.class.soffice_path
+    end
+end

data/lib/activestorage-office-previewer.rb

@@ -0,0 +1,7 @@
+require "active_storage"
+require "active_storage/previewer/office_previewer"
+
+if defined?(Rails)
+  require "active_storage/engine"
+  Rails.application.config.active_storage.previewers += [ ActiveStorage::Previewer::OfficePreviewer ]
+end

data/test/database/setup.rb

@@ -0,0 +1,6 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection \
+  adapter: "sqlite3", database: ":memory:", migrations_paths: File.expand_path("../dummy/db/migrate", __dir__)
+
+ActiveRecord::Base.connection.migration_context.migrate

data/test/dummy/.browserslistrc

@@ -0,0 +1 @@
+defaults

data/test/dummy/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity

data/test/dummy/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/test/dummy/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end