mirador_rails 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06b7705ed53e7c5585e14c85b3bbd91968a5e8a1
-  data.tar.gz: 16bdbe4f3722f5fe4f0730fa1d887142982fd11a
+  metadata.gz: 679bf3fdaa9d65a617d66b8200f1c7171524c44e
+  data.tar.gz: f0e4ab8e8614570b837de736a0dad548ba4a4e18
 SHA512:
-  metadata.gz: 4dea2e72dacae6b4f8f92387f5d9f0cf21c86113c936d4aba76bef603b6ec7751bd982f4e7425211b38ab36967259d023b2e2edb5afc7baccc54cc0896775f02
-  data.tar.gz: dc0e6dd3b7b98e3ffec5df99010bb237534bc0ddb52b9ac3f838f3434516bf45026e596e8f7910b3157be8df2523c99bea9f7648e456929b58897cdae4cf124b
+  metadata.gz: d73aab219e38369f8c9a7b0c7fce392a8cbf3812e51dd170c9471b47ecc4896f3210f626a3645cb03c98e6278af60f8618756a08d0dcd4025e369c99992ac6f4
+  data.tar.gz: 59fbe2b01f083c7283eff5187ef0de444ff16e5ff6f3292181dd204e0c37e9bfd1bfec9f86fb423a095a4f6b72e6bb96834217fdf1f59c30158c3f76ca264769

data/README.md

@@ -20,6 +20,12 @@ Or install it yourself as:
 
     $ gem install mirador_rails
 
+### Mount the Engine
+In your `routes.rb` file mount the MiradorRails::Engine
+```ruby
+mount MiradorRails::Engine, at: MiradorRails::Engine.locales_mount_path
+```
+
 ## Usage
 
 You can require the mirador js by requiring the following:

data/app/controllers/mirador_rails/locales_controller.rb

@@ -0,0 +1,10 @@
+module MiradorRails
+  class LocalesController < ::ApplicationController
+
+    def locale
+      language = params.fetch(:locale) { I18n.default_locale.to_s }
+      locale = MiradorRails::Locale.new(language)
+      render json: locale.file_source
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+MiradorRails::Engine.routes.draw do
+  match '/:locale/translation',
+        to: 'mirador_rails/locales#locale',
+        via: :get,
+        as: :locales,
+        defaults: { format: :json }
+end

data/lib/mirador_rails/exceptions.rb

@@ -0,0 +1,6 @@
+module MiradorRails
+  module Exceptions
+    class LocaleNotFound < StandardError
+    end
+  end
+end

data/lib/mirador_rails/locale.rb

@@ -0,0 +1,24 @@
+module MiradorRails
+  class Locale
+    attr_reader :language
+
+    def initialize(language)
+      @language = language
+    end
+
+    def path
+      "#{language}/translation.json"
+    end
+
+    def file_source
+      raise MiradorRails::Exceptions::LocaleNotFound, "Could not find #{path}" if file.blank?
+      file.source.force_encoding('UTF-8')
+    end
+
+    def file
+      # Rails.application.assets is `nil` in production mode (where compile assets is enabled).
+      # This workaround is based off of this comment: https://github.com/fphilipe/premailer-rails/issues/145#issuecomment-225992564
+      (Rails.application.assets || ::Sprockets::Railtie.build_environment(Rails.application)).find_asset(path)
+    end
+  end
+end

data/lib/mirador_rails/version.rb

@@ -1,3 +1,3 @@
 module MiradorRails
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/mirador_rails.rb

@@ -1,12 +1,19 @@
+require 'mirador_rails/exceptions'
+require 'mirador_rails/locale'
 require 'mirador_rails/version'
 require 'mirador_rails/view_helpers'
 require 'font-awesome-rails'
 require 'material_icons'
+require 'openseadragon'
+require 'jquery-rails'
+require 'tinymce-rails'
 
 module MiradorRails
+  ##
+  # MiradorRails Engine
   class Engine < ::Rails::Engine
-    initializer 'mirador_rails.precompile' do |app|
-      app.config.assets.precompile += %w(locales/* plugins/* themes/* skins/*)
+    cattr_accessor :locales_mount_path do
+      '/locales'
     end
 
     initializer 'mirador_rails.helpers' do

data/mirador_rails.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'font-awesome-rails'
   spec.add_dependency 'material_icons'
+  spec.add_dependency 'openseadragon'
+  spec.add_dependency 'jquery-rails'
+  spec.add_dependency 'tinymce-rails'
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"

data/tasks/mirador_rails.rake

@@ -25,25 +25,59 @@ task :update, [:version] do |_t, args|
   end
   mirador_dir = File.join(tmp_dir, 'build', 'mirador')
   vendor_dir = File.join(File.expand_path('..', File.dirname(__FILE__)), 'vendor', 'assets')
-  dirs_to_modify = %w(images locales plugins skins themes)
-  dirs_to_remap = %w(plugins skins themes)
+  dirs_to_modify = %w(images locales)
 
   puts "Removing and copying #{dirs_to_modify}"
   dirs_to_modify.map { |d| FileUtils.rm_rf(File.join(vendor_dir, d)) }
   dirs_to_modify.map do |d|
-    if dirs_to_remap.include?(d)
-      FileUtils.mkdir_p(File.join(vendor_dir, d))
-      FileUtils.cp_r(File.join(mirador_dir, d), File.join(vendor_dir, d, d))
-    else
-      FileUtils.cp_r(File.join(mirador_dir, d), File.join(vendor_dir, d))
-    end
+    FileUtils.cp_r(File.join(mirador_dir, d), File.join(vendor_dir, d))
   end
 
   puts 'Copying stylesheets'
   FileUtils.cp(File.join(mirador_dir, 'css', 'mirador-combined.css') , File.join(vendor_dir, 'stylesheets'))
 
   puts 'Copying javascripts'
-  FileUtils.cp(Dir.glob(File.join(mirador_dir, 'mirador.min.js*')), File.join(vendor_dir, 'javascripts'))
+  FileUtils.cp(Dir.glob(File.join(mirador_dir, 'mirador.js')), File.join(vendor_dir, 'javascripts', 'mirador'))
+
+  puts 'Updating js to use erb'
+  mirador_erb = File.join(vendor_dir, 'javascripts', 'mirador', 'mirador.js.erb')
+  mirador_js = File.join(vendor_dir, 'javascripts', 'mirador', 'mirador.js')
+
+  text = File.read(mirador_js)
+  puts 'Replacing images with erb tags'
+  content = text.gsub("var backgroundImage = _this.state.getStateProperty('buildPath') + _this.state.getStateProperty('imagesPath') + 'debut_dark.png';", "var backgroundImage = \"<%= asset_path('debut_dark.png') %>\"")
+
+  puts 'Comment out border image replacement, using SCSS instead'
+  content = content.gsub("el.css('background-image','url('+this.getImagePath(imageName)+')');", 'el // Comment out, using SCSS instead \1')
+
+  puts 'Replacing i18next template, with MiradorRails controller route (default)'
+  content = content.gsub("loadPath: _this.state.getStateProperty('buildPath') + _this.state.getStateProperty('i18nPath')+'{{lng}}/{{ns}}.json'", "loadPath: '<%= MiradorRails::Engine.locales_mount_path %>' + '/{{lng}}/{{ns}}.json'")
+
+  puts 'Removes tinymce library'
+  content = content.gsub(/^!function\(e,t\).*(tinymce\S*){10,}.*\/\*!\n\n handlebars/m, "/*!\n\n handlebars")
+
+  puts 'Removing OpenSeaDragon'
+  content = content.gsub(/\/\/! openseadragon .*\/\/# sourceMappingURL=openseadragon.js.map/m, '')
+
+  puts 'Removing jQuery'
+  content = content.gsub(/\/\*! jQuery v.*\/*! jQuery Migrate/m, '/*! jQuery Migrate')
+
+  puts 'Remove qtip map'
+  content = content.gsub("//# sourceMappingURL=jquery.qtip.min.js.map", "\n")
+
+  File.open(mirador_erb, 'w') { |f| f << content }
+  FileUtils.rm(mirador_js)
+
+  puts 'Removing FontAwesome from css'
+  css_file = File.join(vendor_dir, 'stylesheets', 'mirador-combined.css')
+  text = File.read(css_file)
+  content = text.gsub(/\/\*!\n\s\*\s\sFont Awesome.*\/*! jQuery UI/m, '/*! jQuery UI')
+  File.open(css_file, 'w') { |f| f << content }
 
-  puts 'Update successful, make sure to remove the FontAwesome and MaterialIcon blocks from mirador-combined.css'
+  puts 'Removing MaterialIcons from css'
+  css_file = File.join(vendor_dir, 'stylesheets', 'mirador-combined.css')
+  text = File.read(css_file)
+  content = text.gsub(/@font-face {\s*font-family: 'Material Icons';.*}/m, '')
+  content = content.gsub(/\.material-icons {\s*font-family: 'Material Icons';.*}/m, '')
+  File.open(css_file, 'w') { |f| f << content }
 end