tinymce-rails 3.4.8 → 3.4.9

data/README.md

@@ -11,35 +11,65 @@ Instructions
 
     gem 'tinymce-rails'
 
-Then run `bundle install`.
+Be sure to add to the global group, not the `assets` group. Then run `bundle install`.
 
 
-**2a. Use TinyMCE with the jQuery extension**
+**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
+
+See the [TinyMCE Documentation](http://www.tinymce.com/wiki.php/Configuration) for a full list of configuration options.
+
+
+**3. Include the TinyMCE assets**
 
 Add to your application.js:
 
+    //= require tinymce
+
+or with jQuery integration:
+
     //= require tinymce-jquery
 
-and use TinyMCE in your view:
+The TinyMCE assets can be included on a per-page basis using the `tinymce_assets` helper:
 
-    <%= text_area_tag :editor, "", :rows => 40, :cols => 120 %>
+    <%= tinymce_assets %>
+    #=> <script type="text/javascript" src="/assets/tinymce.js">
 
-    <script type="text/javascript">
-      $(function() {
-        $('textarea').tinymce({
-          theme: 'advanced'
-        });
-      });
-    </script>
 
+**4. Initialize TinyMCE**
 
-**2b. Use TinyMCE without jQuery**
+For each textarea that you want to use with TinyMCE, add the "tinymce" class and ensure it has a unique ID:
 
-Add to your application.js:
+    <%= text_area_tag :editor, "", :class => "tinymce", :rows => 40, :cols => 120 %>
 
-    //= require tinymce
+Then invoke the `tinymce` helper to initialize TinyMCE:
+
+    <%= 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"] %>
+
+
+Language Packs
+--------------
 
-Use TinyMCE in your view:
+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.
+
+
+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 %>
 
@@ -58,7 +88,13 @@ To use custom plugins or skins, simply add the files to your asset load path so
 
 For example, a plugin called `mycustomplugin` could have its main JS file at `app/assets/javascripts/tinymce/plugins/mycustomplugin/editor_plugin.js`.
 
-Any files with a path beginning with `tinymce/` will be automatically precompiled.
+You should also ensure that your custom paths are added to the asset precompile paths.
+
+
+Using tinymce-rails as an Engine Dependency
+-------------------------------------------
+
+Ensure that you explicitly require `tinymce-rails` within your engine file. Including tinymce-rails as a dependency in your gemspec is not enough.
 
 
 Updating

data/Rakefile

@@ -1,7 +1,4 @@
-unless defined? TinyMCE::VERSION
-  $:.unshift File.expand_path("../lib", __FILE__)
-  require "tinymce/version"
-end
+require File.expand_path('../lib/tinymce/rails/version', __FILE__)
 
 def step(name)
   print "#{name} ..."
@@ -15,29 +12,29 @@ def download(url, filename)
   `curl -L -# #{url} -o tmp/#{filename}`
 end
 
-desc "Update TinyMCE to version specified in lib/tinymce/version.rb"
+desc "Update TinyMCE to version #{TinyMCE::Rails::TINYMCE_VERSION}"
 task :update => [ :fetch, :extract, :process ]
 
 task :fetch do
-  download("https://github.com/downloads/tinymce/tinymce/tinymce_#{TinyMCE::VERSION}.zip", "tinymce.zip")
-  download("https://github.com/downloads/tinymce/tinymce/tinymce_#{TinyMCE::VERSION}_jquery.zip", "tinymce.jquery.zip")
+  download("https://github.com/downloads/tinymce/tinymce/tinymce_#{TinyMCE::Rails::TINYMCE_VERSION}.zip", "tinymce.zip")
+  download("https://github.com/downloads/tinymce/tinymce/tinymce_#{TinyMCE::Rails::TINYMCE_VERSION}_jquery.zip", "tinymce.jquery.zip")
 end
 
 task :extract do
   step "Extracting core files" do
     `rm -rf tmp/tinymce`
     `unzip -u tmp/tinymce.zip -d tmp`
-    `rm -rf assets/precompiled/tinymce`
-    `mkdir -p assets/precompiled/tinymce`
-    `mv tmp/tinymce/jscripts/tiny_mce/* assets/precompiled/tinymce/`
+    `rm -rf vendor/assets/javascripts/tinymce`
+    `mkdir -p vendor/assets/javascripts/tinymce`
+    `mv tmp/tinymce/jscripts/tiny_mce/* vendor/assets/javascripts/tinymce/`
   end
   
   step "Extracting jQuery files" do
     `rm -rf tmp/tinymce`
     `unzip -u tmp/tinymce.jquery.zip -d tmp`
-    `mv tmp/tinymce/jscripts/tiny_mce/jquery.tinymce.js assets/precompiled/tinymce/jquery.tinymce.js`
-    `mv tmp/tinymce/jscripts/tiny_mce/tiny_mce.js assets/precompiled/tinymce/tiny_mce_jquery.js`
-    `mv tmp/tinymce/jscripts/tiny_mce/tiny_mce_src.js assets/precompiled/tinymce/tiny_mce_jquery_src.js`
+    `mv tmp/tinymce/jscripts/tiny_mce/jquery.tinymce.js vendor/assets/javascripts/tinymce/jquery.tinymce.js`
+    `mv tmp/tinymce/jscripts/tiny_mce/tiny_mce.js vendor/assets/javascripts/tinymce/tiny_mce_jquery.js`
+    `mv tmp/tinymce/jscripts/tiny_mce/tiny_mce_src.js vendor/assets/javascripts/tinymce/tiny_mce_jquery_src.js`
   end
 end
 
@@ -45,15 +42,9 @@ task :process do
   step "Fixing file encoding" do
     require 'iconv'
     converter = Iconv.new('UTF-8', 'ISO-8859-1')
-    Dir["assets/precompiled/tinymce/**/*.js"].each do |file|
+    Dir["vendor/assets/javascripts/tinymce/**/*.js"].each do |file|
       contents = converter.iconv(File.read(file)).force_encoding('UTF-8')
       File.open(file, 'w') { |f| f.write(contents) }
     end
   end
-  
-  step "Copying includeable assets" do
-    `cp assets/precompiled/tinymce/tiny_mce_src.js assets/vendor/tinymce/tiny_mce.js`
-    `cp assets/precompiled/tinymce/tiny_mce_jquery_src.js assets/vendor/tinymce/tiny_mce_jquery.js`
-    `cp assets/precompiled/tinymce/jquery.tinymce.js assets/vendor/tinymce/jquery-tinymce.js`
-  end
 end

data/app/assets/javascripts/tinymce-jquery.js

@@ -0,0 +1,3 @@
+//= require tinymce/preinit.js
+//= require tinymce/tiny_mce_jquery_src.js
+//= require tinymce/jquery.tinymce.js

data/app/assets/javascripts/tinymce.js

@@ -0,0 +1,2 @@
+//= require tinymce/preinit.js
+//= require tinymce/tiny_mce_src.js

data/app/assets/javascripts/tinymce/preinit.js.erb

@@ -0,0 +1,5 @@
+window.tinyMCEPreInit = window.tinyMCEPreInit || {
+  base:   '<%= TinyMCE::Rails::Engine.config.tinymce.base || asset_path("tinymce", :digest => false) %>',
+  query:  '<%= TinyMCE::Rails::VERSION %>',
+  suffix: ''
+};

data/lib/tasks/assets.rake

@@ -0,0 +1,7 @@
+Rake::Task['assets:precompile:primary'].enhance do
+  assets = File.expand_path(File.dirname(__FILE__) + "/../../vendor/assets/javascripts/tinymce")
+  target = File.join(Rails.public_path, Rails.application.config.assets.prefix)
+
+  mkdir_p target
+  cp_r assets, target
+end

data/lib/tinymce-rails.rb

@@ -1,2 +1 @@
-require "tinymce/version"
-require "tinymce/railtie"
+require "tinymce/rails"

data/lib/tinymce/rails.rb

@@ -0,0 +1,12 @@
+module TinyMCE
+  module Rails
+    require 'tinymce/rails/engine'
+    require 'tinymce/rails/version'
+    require "tinymce/rails/configuration"
+    require "tinymce/rails/helper"
+
+    def self.configuration
+      @configuration ||= Configuration.load(::Rails.root.join("config/tinymce.yml"))
+    end
+  end
+end

data/lib/tinymce/rails/configuration.rb

@@ -0,0 +1,67 @@
+module TinyMCE::Rails
+  class Configuration
+    def self.defaults
+      {
+        "mode"            => "textareas",
+        "theme"           => "advanced",
+        "editor_selector" => "tinymce"
+      }
+    end
+    
+    attr_reader :options
+    
+    def initialize(options)
+      @options = options
+    end
+    
+    def options_for_tinymce
+      result = {}
+      
+      options.each do |key, value|
+        if value.is_a?(Array) && value.all? { |v| v.is_a?(String) }
+          result[key] = value.join(",")
+        else
+          result[key] = value
+        end
+      end
+      
+      result["language"] ||= self.class.default_language
+      
+      result
+    end
+    
+    def merge(options)
+      self.class.new(self.options.merge(options))
+    end
+    
+    def load(filename)
+      options.merge!(YAML::load(ERB.new(IO.read(filename)).result))
+    end
+    
+    def self.load(filename)
+      config = new(defaults)
+      config.load(filename) if File.exists?(filename)
+      config
+    end
+    
+    # Default language falls back to English if current locale is not available.
+    def self.default_language
+      available_languages.include?(I18n.locale.to_s) ? I18n.locale.to_s : "en"
+    end
+    
+    # Searches asset paths for TinyMCE language files.
+    def self.available_languages
+      assets.paths.map { |path|
+        files = assets.entries(File.join(path, "tinymce/langs"))
+        files.map { |file|
+          asset = assets.attributes_for(File.join(path, file))
+          asset.logical_path.sub(/\.js$/, "")
+        }
+      }.flatten.uniq
+    end
+  
+    def self.assets
+      Rails.application.assets
+    end
+  end
+end

data/lib/tinymce/rails/engine.rb

@@ -0,0 +1,16 @@
+module TinyMCE::Rails
+  class Engine < ::Rails::Engine
+    config.tinymce = ActiveSupport::OrderedOptions.new
+    
+    # Set an explicit base path for TinyMCE assets (usually defaults to /assets/tinymce)
+    config.tinymce.base = nil
+
+    initializer "precompile", :group => :all do |app|
+      app.config.assets.precompile << "tinymce.js"
+    end
+
+    initializer "helper" do |app|
+      ActionController::Base.helper(Helper)
+    end
+  end
+end

data/lib/tinymce/rails/helper.rb

@@ -0,0 +1,29 @@
+module TinyMCE::Rails
+  module Helper
+    # Initializes TinyMCE on the current page based on the global configuration.
+    #
+    # Custom options can be set via the options hash, which will be passed to
+    # the TinyMCE init function.
+    #
+    # By default, all textareas with a class of "tinymce" will have the TinyMCE
+    # editor applied. The current locale will also be used as the language when
+    # TinyMCE language files are available, falling back to English if not
+    # available. The :editor_selector and :language options can be used to
+    # override these defaults.
+    #
+    # @example
+    #   <%= tinymce(:theme => "advanced", :editor_selector => "editorClass") %>
+    def tinymce(options={})
+      configuration = TinyMCE::Rails.configuration.merge(options)
+      
+      javascript_tag do
+        "tinyMCE.init(#{configuration.options_for_tinymce.to_json});".html_safe
+      end
+    end
+    
+    # Includes TinyMCE javascript assets via a script tag.
+    def tinymce_assets
+      javascript_include_tag "tinymce"
+    end
+  end
+end

data/lib/tinymce/rails/version.rb

@@ -0,0 +1,6 @@
+module TinyMCE
+  module Rails
+    VERSION = "3.4.9"
+    TINYMCE_VERSION = "3.4.9"
+  end
+end