tinymce-rails 3.5.9 → 3.5.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab211e85e16ec0692551345d36b4a9795cfd76b6
+  data.tar.gz: 1ce16e077f0a32322bf516d638c57286267a838d
+SHA512:
+  metadata.gz: 460047537ca0db474d68ffc3b2de2f993f77d386cc82275e3ec1fabea52a8e52176b00c0d0c272c298dc228fc8a7511f046fe5cb596613a3bd7affdb23eddbef
+  data.tar.gz: 1569dcb35a58fbf3bd9194493faae09a43a62495aa7c2323379945e44c76bb7342958207d03a3e9949da273994a4dbb2ae0756f2d9f3620ab01a3443f26d0480

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2011-13 by Sam Pohlenz
+Copyright (C) 2011-14 by Sam Pohlenz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,51 +5,58 @@ The `tinymce-rails` gem integrates the [TinyMCE](http://www.tinymce.com/) editor
 
 This gem is compatible with Rails 3.1.1 and higher (including Rails 4).
 
-Support for TinyMCE 4 is currently available in the [tinymce-4 branch](https://github.com/spohlenz/tinymce-rails/tree/tinymce-4). For the time being, parallel versions of TinyMCE (3.5.x and 4.x) will be maintained. However TinyMCE 4 will eventually be promoted to the master branch.
+This is the branch for TinyMCE 3.5.x. For TinyMCE 4, please see the [master branch](https://github.com/spohlenz/tinymce-rails).
 
-[![Build Status](https://travis-ci.org/spohlenz/tinymce-rails.png?branch=master)](https://travis-ci.org/spohlenz/tinymce-rails)
+[![Build Status](https://travis-ci.org/spohlenz/tinymce-rails.png?branch=tinymce-3)](https://travis-ci.org/spohlenz/tinymce-rails)
 
+**New in 3.5.11, 4.1.10 and 4.2.1:** Alternative asset installation methods (copy vs compile/symlink). See the [Asset Compilation](#asset-compilation) section below for details.
 
 Instructions
 ------------
 
 **1. Add `tinymce-rails` to your Gemfile**
 
-    gem 'tinymce-rails'
+```ruby
+gem 'tinymce-rails'
+```
 
 Be sure to add to the global group, not the `assets` group. Then run `bundle install`.
 
 
 **2. Create a `config/tinymce.yml` file with your global configuration options:**
 
-    theme_advanced_toolbar_location: top
-    theme_advanced_toolbar_align: left
-    theme_advanced_statusbar_location: bottom
-    theme_advanced_buttons3_add:
-      - tablecontrols
-      - fullscreen
-    plugins:
-      - table
-      - fullscreen
+```yml
+theme_advanced_toolbar_location: top
+theme_advanced_toolbar_align: left
+theme_advanced_statusbar_location: bottom
+theme_advanced_buttons3_add:
+  - tablecontrols
+  - fullscreen
+plugins:
+  - table
+  - fullscreen
+```
 
 The Rails server no longer needs to be restarted when this file is updated in development mode.
 
 To define multiple configuration sets, follow this syntax (a default configuration must be specified):
 
-    default:
-      theme_advanced_toolbar_align: left
-      theme_advanced_buttons3_add:
-        - tablecontrols
-      plugins:
-        - table
-    
-    alternate:
-      theme_advanced_toolbar_location: top
-      theme_advanced_toolbar_align: left
-      theme_advanced_buttons3_add:
-        - tablecontrols
-      plugins:
-        - table
+```yml
+default:
+  theme_advanced_toolbar_align: left
+  theme_advanced_buttons3_add:
+    - tablecontrols
+  plugins:
+    - table
+
+alternate:
+  theme_advanced_toolbar_location: top
+  theme_advanced_toolbar_align: left
+  theme_advanced_buttons3_add:
+    - tablecontrols
+  plugins:
+    - table
+```
 
 See the [TinyMCE 3 Documentation](http://www.tinymce.com/wiki.php/Configuration3x) for a full list of configuration options.
 
@@ -60,51 +67,70 @@ Use *one* of the following options to include TinyMCE assets.
 
 (1) Add to your application.js:
 
-    //= require tinymce
+```js
+//= require tinymce
+```
 
 or (2) with jQuery integration:
 
-    //= require tinymce-jquery
+```js
+//= require tinymce-jquery
+```
 
 (3) The TinyMCE assets can be included on a per-page basis using the `tinymce_assets` helper:
 
-    <%= tinymce_assets %>
-    #=> <script type="text/javascript" src="/assets/tinymce.js">
-
+```erb
+<%= tinymce_assets %>
+#=> <script type="text/javascript" src="/assets/tinymce.js">
+```
 
 **4. Initialize TinyMCE**
 
 For each textarea that you want to use with TinyMCE, add the "tinymce" class and ensure it has a unique ID:
 
-    <%= text_area_tag :editor, "", :class => "tinymce", :rows => 40, :cols => 120 %>
+```erb
+<%= text_area_tag :content, "", :class => "tinymce", :rows => 40, :cols => 120 %>
+```
+
+or if you are using Rails' form builders:
+
+```erb
+<%= f.text_area :content, :class => "tinymce", :rows => 40, :cols => 120 %>
+```
 
 Then invoke the `tinymce` helper to initialize TinyMCE:
 
-    <%= tinymce %>
+```erb
+<%= tinymce %>
+```
 
 Custom options can be passed to `tinymce` to override the global options specified in `config/tinymce.yml`:
 
-    <%= tinymce :theme => "simple", :language => "de", :plugins => ["inlinepopups", "paste"] %>
+```erb
+<%= tinymce :theme => "simple", :language => "de", :plugins => ["inlinepopups", "paste"] %>
+```
 
 Alternate configurations defined in 'config/tinymce.yml' can be used with:
 
-    <%= tinymce :alternate %>
-
+```erb
+<%= tinymce :alternate %>
+```
 
 Manual Initialization
 ---------------------
 
 Using the `tinymce` helper and global configuration file is entirely optional. The `tinyMCE.init` function can be invoked manually if desired.
 
-    <%= text_area_tag :editor, "", :rows => 40, :cols => 120 %>
-
-    <script type="text/javascript">
-      tinyMCE.init({
-        mode: 'textareas',
-        theme: 'advanced'
-      });
-    </script>
+```erb
+<%= text_area_tag :editor, "", :rows => 40, :cols => 120 %>
 
+<script type="text/javascript">
+  tinyMCE.init({
+    mode: 'textareas',
+    theme: 'advanced'
+  });
+</script>
+```
 
 Language Packs
 --------------
@@ -112,6 +138,34 @@ Language Packs
 See the [tinymce-rails-langs](https://github.com/spohlenz/tinymce-rails-langs) gem for additional language packs for TinyMCE. The `tinymce` helper will use the current locale as the language if available, falling back to English if the core language files are missing.
 
 
+Asset Compilation
+-----------------
+
+Since TinyMCE loads most of its files dynamically, some workarounds are required to ensure that the TinyMCE asset files are accessible using non-digested filenames.
+
+As of tinymce-rails 3.5.11, 4.1.10 and 4.2.1, two alternative asset installation methods are available, which can be changed by setting `config.tinymce.install` within your `config/application.rb` file. Both methods are called when you run `rake asset:precompile` (via `Rake::Task#enhance`) after the regular application assets are compiled.
+
+The default method, `copy`, copies the TinyMCE assets directly into `public/assets` and appends the file information into the asset manifest.
+
+```ruby
+config.tinymce.install = :copy
+```
+
+The new method, `compile`, adds the TinyMCE paths to the Sprockets precompilation paths and then creates symlinks from the non-digested filenames to their digested versions.
+
+```ruby
+config.tinymce.install = :compile
+```
+
+Due to compilation times, this method is only recommended using Rails 4 and up. This method is intended to eventually become the default, so please try it if it suits your environment and report any issues.
+
+If you are including TinyMCE via `application.js` or using the `tinymce_assets` helper, you do not need to manually alter the precompile paths. However if you wish to include `tinymce-jquery.js` independently (i.e. using `javascript_include_tag`), you will need to add it to the precompile list in `config/environments/production.rb`:
+
+```ruby
+config.assets.precompile << "tinymce-jquery.js"
+```
+
+
 Custom Plugins & Skins
 ----------------------
 

data/lib/tasks/tinymce-assets.rake

@@ -2,12 +2,15 @@ assets_task = Rake::Task.task_defined?('assets:precompile:primary') ? 'assets:pr
 
 Rake::Task[assets_task].enhance do
   require "tinymce/rails/asset_installer"
-  
-  assets = Pathname.new(File.expand_path(File.dirname(__FILE__) + "/../../vendor/assets/javascripts/tinymce"))
 
+  assets = Pathname.new(File.expand_path(File.dirname(__FILE__) + "/../../vendor/assets/javascripts/tinymce"))
+  
   config   = Rails.application.config
   target   = File.join(Rails.public_path, config.assets.prefix)
   manifest = config.assets.manifest
   
-  TinyMCE::Rails::AssetInstaller.new(assets, target, manifest).install
+  installer = TinyMCE::Rails::AssetInstaller.new(assets, target, manifest)
+  installer.log_level = Logger::INFO
+  installer.strategy = config.tinymce.install
+  installer.install
 end

data/lib/tinymce/rails.rb

@@ -7,7 +7,7 @@ module TinyMCE
     require "tinymce/rails/helper"
 
     def self.configuration
-      @configuration ||= ConfigurationFile.new(::Rails.root.join("config/tinymce.yml"))
+      @configuration ||= ConfigurationFile.new(Engine.config_path)
       @configuration.respond_to?(:configuration) ? @configuration.configuration : @configuration
     end
 

data/lib/tinymce/rails/asset_installer.rb

@@ -1,64 +1,62 @@
 require "tinymce/rails/asset_manifest"
 
+require "tinymce/rails/asset_installer/copy"
+require "tinymce/rails/asset_installer/compile"
+
 module TinyMCE
   module Rails
     class AssetInstaller
+      attr_reader :assets, :target, :strategy
+      attr_accessor :logger
+      
       def initialize(assets, target, manifest_path)
         @assets = assets
         @target = target
         @manifest_path = manifest_path || target
+        
+        @logger       = Logger.new($stderr)
+        @logger.level = Logger::INFO
       end
       
       def install
-        cleanup_assets
-        copy_assets
-        append_to_manifest
-        
-        manifest.write
-      end
-    
-    private
-      def manifest
-        @manifest ||= AssetManifest.load(@manifest_path)
+        (strategy || Copy).new(self).call
       end
       
-      def cleanup_assets
-        manifest.each(/^tinymce\//) do |asset|
-          manifest.remove(asset) if index_asset?(asset)
-          
-          manifest.remove_digest(asset) do |src, dest|
-            move_asset(src, dest)
-          end
-        end
+      def log_level
+        @logger.level
       end
-      
-      def copy_assets
-        FileUtils.cp_r(@assets, @target, :preserve => true)
+
+      def log_level=(level)
+        if level.is_a?(Integer)
+          @logger.level = level
+        else
+          @logger.level = Logger.const_get(level.to_s.upcase)
+        end
       end
       
-      def append_to_manifest
-        asset_files.each do |file|
-          manifest.append(logical_path(file), file)
+      def strategy=(strategy)
+        if strategy.is_a?(Class)
+          @strategy = strategy
+        else
+          @strategy = self.class.const_get(strategy.to_s.titlecase)
         end
       end
       
-      def asset_files
-        Pathname.glob("#{@assets}/**/*").select(&:file?)
+      def manifest
+        @manifest ||= AssetManifest.load(@manifest_path)
       end
-      
+    
       def logical_path(file)
         file.relative_path_from(@assets.parent).to_s
       end
       
-      def move_asset(src, dest)
-        src = File.join(@target, src)
-        dest = File.join(@target, dest)
-        
-        FileUtils.mv(src, dest, :force => true) if src != dest && File.exists?(src)
-      end
-      
-      def index_asset?(asset)
-        asset =~ /\/index\.js$/
+      def with_asset(src, dest)
+        if src != dest
+          src = File.join(@target, src)
+          dest = File.join(@target, dest)
+          
+          yield src, dest if File.exists?(src)
+        end
       end
     end
   end

data/lib/tinymce/rails/asset_installer/compile.rb

@@ -0,0 +1,44 @@
+module TinyMCE
+  module Rails
+    class AssetInstaller
+      class Compile
+        delegate :target, :manifest, :logger, :logical_path, :with_asset, :to => :@installer
+        
+        def initialize(installer)
+          @installer = installer
+        end
+        
+        def call
+          symlink_assets
+        end
+      
+      private
+        def symlink_assets
+          manifest.each(/^tinymce\//) do |asset|
+            manifest.asset_path(asset) do |src, dest|
+              symlink_asset(src, dest)
+            end
+          end
+        end
+        
+        def symlink_asset(src, dest)
+          with_asset(src, dest) do |src, dest|
+            create_symlink(src, dest)
+            create_symlink("#{src}.gz", "#{dest}.gz") if File.exists?("#{src}.gz")
+          end
+        end
+        
+        def create_symlink(src, dest)
+          target = File.basename(src)
+        
+          unless File.exists?(dest) && File.symlink?(dest) && File.readlink(dest) == target
+            logger.info "Creating symlink #{dest}"
+            FileUtils.ln_s(target, dest, :force => true)
+          else
+            logger.debug "Skipping symlink #{dest}, already exists"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tinymce/rails/asset_installer/copy.rb

@@ -0,0 +1,52 @@
+module TinyMCE
+  module Rails
+    class AssetInstaller
+      class Copy
+        delegate :assets, :target, :manifest, :logger, :logical_path, :with_asset, :to => :@installer
+        
+        def initialize(installer)
+          @installer = installer
+        end
+        
+        def call
+          cleanup_assets
+          copy_assets
+          append_to_manifest
+        
+          manifest.write
+        end
+      
+      private
+        def cleanup_assets
+          manifest.each(/^tinymce\//) do |asset|
+            manifest.remove_digest(asset) do |src, dest|
+              move_asset(src, dest)
+            end
+          end
+        end
+        
+        def copy_assets
+          logger.info "Copying assets to #{File.join(target, "tinymce")}"
+          FileUtils.cp_r(assets, target, :preserve => true)
+        end
+        
+        def append_to_manifest
+          asset_files.each do |file|
+            manifest.append(logical_path(file), file)
+          end
+        end
+        
+        def move_asset(src, dest)
+          with_asset(src, dest) do |src, dest|
+            logger.info "Removing digest from #{src}"
+            FileUtils.mv(src, dest, :force => true)
+          end
+        end
+      
+        def asset_files
+          Pathname.glob("#{assets}/**/*").select(&:file?)
+        end
+      end
+    end
+  end
+end