tinymce_hammer 0.2.2

data/.gitignore

@@ -0,0 +1,5 @@
+.svn
+*.*.swp
+*.swp
+.swp
+pkg/

data/README.rdoc

@@ -0,0 +1,200 @@
+= tinymce_hammer
+
+== Attention
+
+<b>This is the Rails 3 gem version of tinymce_hammer. If you want to use tinymce_hammer with Rails 2, please checkout branch rails2.</b>
+
+See the plugin website for guides/tutorials: http://tinymcehammer.lanalot.com/
+
+tinymce_hammer makes its easy to use the TinyMCE WYSIWYG editor inside a Ruby
+On Rails (2.3/3+) application.  What it does:
+
+* Easy to use, two-step installation and you are ready to go.  Form helpers are
+  provided for most common cases.
+
+* Flexible, need to lazy load TinyMCE w/javascript?  Need two different editors
+  on the same page?  Want to use your own form helpers? No problem.
+
+* Fast, TinyMCE requests lots of .js files for the most basic of editor
+  configurations.  It does all this over XMLHttpRequest.  tinymce_hammer
+  eliminates this by combining all required library files (plugins, themes,
+  languages, etc) into one javascript file.
+
+== Installation
+
+1. Manually as system wide gem:
+
+    $ gem install tinymce_hammer
+    
+  Or inside your Gemfile:
+    
+    gem 'tinymce_hammer'
+
+  Remember to run:
+  
+    $ bundle install
+
+2. <b>This fork does not contain a bundled tinymce version!</b> So download it here:
+
+    http://tinymce.moxiecode.com/download/download.php
+
+3. And copy it to:
+
+     your_app/public/javascript/tiny_mce
+
+== Basic Usage
+
+The easiest way to use tinymce_hammer involves 2 steps:
+
+1. Call the follow function in your layout/template.  It can go anywhere
+   really, but inside the head tags is prefered:
+
+     <%= init_tinymce_hammer_if_required %>
+
+2. Use one of the following 3 methods to add a tinymce enabled textarea tag
+   to your page.
+
+=== Example 1: tinymce_tag (form tag helper)
+
+This is your basic drop-in replacement for text_area_tag:
+
+  <%= tinymce_tag('comment[body]', 'Your comment goes here ...') %>
+
+=== Example 2: tinymce (form helper)
+
+This is just like the text_area helper, it assumes there is an instance
+variable, and if found will pull data from that to populate the field with.
+
+  <%= tinymce(:comment, :body) %>
+
+=== Example 3: tinymce (form builder helper)
+
+  <%- form_for @comment do |form| -%>
+    <%= form.label :body %>
+    <%= form.tinymce :body %>
+  <% end %>
+
+=== Example 4: via Javascript:
+
+You cannot use the tinymce textarea form helper when using this initializing method, 
+but you can add your own classname to your textarea and pass this as parameter to the 
+init_tinymce() helper.
+	
+=== Example viewfile:
+	
+	<% form_for @post do |f| %>
+	<%= f.text_area :body, class => "my_tinymce" %>
+	<% end %>
+	<%= init_tinymce('my_tinymce') %>
+	
+You can choose whatever you want as the classname for the text_area. Just assure to pass 
+this classname also to the textarea you want to be a tinyMCE Editor. This helps to initialize 
+only the returned form and not all textareas already on the page.
+Very handy! See the RDoc for more about the parameters.
+
+NOTICE! This helper DOES NOT load the combined js file for you. So include it with the javascript_include_tag
+helper as usual.
+
+== Deployment
+
+Tinymce defaults to caching the combined js file using ActionController's
+caches_page method. This causes problems in certain deployed environments 
+(like Heroku) where you can not write to disk, or to web servers that don't
+pass requests for js files through.  To avoid this issue run the following
+rake task:
+
+  rake tinymce:cache_js
+
+You can commit the js file that builds to your repository and that should avoid
+deploy time issues.  You could also add that to a capistrano recipe.
+
+== Advanced Usage
+
+The basic examples above get a TinyMCE editor up and running quickly.  You
+might have more specific needs that the basic approach doesn't fill.  You
+might:
+
+* want to lazy load TinyMCE dynamically after page load
+* only want the combined javascript TinyMCE file provided by tinymce_hammer
+* require multiple editors on the same page that are configured differently
+* need to register javascript callbacks with TinyMCE
+
+In all of the above cases its best to load the combined JS file and call
+the tinyMCE.init() javascript function yourself.  I'll leave that up to you
+how and when.  The url to the combine file is:
+
+  /javascripts/tinymce_hammer.js
+
+It works great to lazy load (I personally use LazyLoad from
+http://wonko.com/post/painless_javascript_lazy_loading_with_lazyload).  
+
+== Configuration
+
+tinymce_hammer has five configuration options.  Its best to place them in an
+intializer (like config/initializer/tinymce_hammer.rb).  Here they are with their
+default values: 
+
+* Tinymce::Hammer.install_path  
+
+    '/javascripts/tiny_mce'
+
+* Tinymce::Hammer.plugins       
+
+    ['paste']
+
+* Tinymce::Hammer.languages     
+
+    ['en']
+
+* Tinymce::Hammer.themes        
+
+    ['advanced']
+
+* Tinymce::Hammer.init          
+
+    [
+      [:paste_convert_headers_to_strong, true],
+      [:paste_convert_middot_lists, true],
+      [:paste_remove_spans, true],
+      [:paste_remove_styles, true],
+      [:paste_strip_class_attributes, true],
+      [:theme, 'advanced'],
+      [:theme_advanced_toolbar_align, 'left'],
+      [:theme_advanced_toolbar_location, 'top'],
+      [:theme_advanced_buttons1, 'undo,redo,cut,copy,paste,pastetext,|,bold,italic,strikethrough,blockquote,charmap,bullist,numlist,removeformat,|,link,unlink,image,|,cleanup,code'],
+      [:theme_advanced_buttons2, ''],
+      [:theme_advanced_buttons3, ''],
+      [:valid_elements, "a[href|title],blockquote[cite],br,caption,cite,code,dl,dt,dd,em,i,img[src|alt|title|width|height|align],li,ol,p,pre,q[cite],small,strike,strong/b,sub,sup,u,ul"],
+    ]
+
+NOTE: install_path is the path inside public to your TinyMCE installation.
+
+NOTE: please don't set the <tt>mode</tt> option for the init.  This is managed
+by tinymce_hammer.  If this doesn't work for your, try the advanced usage.
+
+== Sample Configuration
+
+  Tinymce::Hammer.install_path = '/javascripts/lib/tiny_mce'
+
+  Tinymce::Hammer.plugins = %w(safari table paste tabfocus)
+
+  Tinymce::Hammer.init = [
+    [:paste_convert_headers_to_strong, true],
+    [:paste_convert_middot_lists, true],
+    [:paste_remove_spans, true],
+    [:paste_remove_styles, true],
+    [:paste_strip_class_attributes, true],
+    [:theme, 'advanced'],
+    [:theme_advanced_toolbar_align, 'left'],
+    [:theme_advanced_toolbar_location, 'top'],
+    [:theme_advanced_buttons1, 'undo,redo,cut,copy,paste,pastetext,|,bold,italic,strikethrough,blockquote,charmap,bullist,numlist,removeformat,|,link,unlink,image,|,cleanup,code'],
+    [:theme_advanced_buttons2, ''],
+    [:theme_advanced_buttons3, ''],
+    [:valid_elements, "a[href|title],blockquote[cite],br,caption,cite,code,dl,dt,dd,em,i,img[src|alt|title|width|height|align],li,ol,p,pre,q[cite],small,strike,strong/b,sub,sup,u,ul"],
+  ]
+
+== Questions
+
+The best way to get help is to post to the mailing list (google group).  
+
+  http://groups.google.com/group/tinymce_hammer/topics

data/Rakefile

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/app/controllers/tinymce/hammer_controller.rb

@@ -0,0 +1,13 @@
+class Tinymce::HammerController < ActionController::Base
+  
+  caches_page :combine
+  
+  before_filter do |c|
+    c.headers["Content-Type"] = "text/javascript; charset=utf-8"
+  end
+
+  def combine
+    render :text => Tinymce::Hammer::Combiner.combined_js, :layout => false
+  end
+ 
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  match '/javascripts/tinymce_hammer.js' => 'tinymce/hammer#combine',
+    :as => 'tinymce_hammer_js'
+end

data/lib/tasks/tinymce.rake

@@ -0,0 +1,7 @@
+namespace :tinymce do
+  
+  task :cache_js => :environment do
+    Tinymce::Hammer.cache_js
+  end
+
+end

data/lib/tinymce/engine.rb

@@ -0,0 +1,23 @@
+require 'action_controller/base'
+require 'action_view'
+
+require File.join(File.dirname(__FILE__), "hammer.rb")
+
+%w(builder_methods combiner controller_methods view_helpers).each do |class_name|
+  require File.join(File.dirname(__FILE__), "hammer", class_name)
+end
+
+module Tinymce
+  class Engine < Rails::Engine
+  
+    # Load rake tasks
+    rake_tasks do
+     load File.join(File.dirname(__FILE__), '..', 'tasks', 'tinymce.rake')
+    end
+  
+  end
+end
+
+ActionController::Base.send(:include, Tinymce::Hammer::ControllerMethods)
+ActionView::Base.send(:include, Tinymce::Hammer::ViewHelpers)
+ActionView::Helpers::FormBuilder.send(:include, Tinymce::Hammer::BuilderMethods)

data/lib/tinymce/hammer.rb

@@ -0,0 +1,48 @@
+module Tinymce
+  module Hammer
+
+    mattr_accessor :install_path, :src, :languages, :themes, :plugins, :setup
+
+    @@install_path = '/javascripts/tiny_mce'
+
+    @@src = false
+
+    @@setup = nil
+
+    @@plugins = ['paste']
+
+    @@languages = ['en']
+
+    @@themes = ['advanced']
+
+    @@init = {
+      :paste_convert_headers_to_strong => true,
+      :paste_convert_middot_lists => true,
+      :paste_remove_spans => true,
+      :paste_remove_styles => true,
+      :paste_strip_class_attributes => true,
+      :theme => 'advanced',
+      :theme_advanced_toolbar_align => 'left',
+      :theme_advanced_toolbar_location => 'top',
+      :theme_advanced_buttons1 => 'undo,redo,cut,copy,paste,pastetext,|,bold,italic,strikethrough,blockquote,charmap,bullist,numlist,removeformat,|,link,unlink,image,|,cleanup,code',
+      :theme_advanced_buttons2 => '',
+      :theme_advanced_buttons3 => '',
+      :valid_elements => "a[href|title,blockquote[cite],br,caption,cite,code,dl,dt,dd,em,i,img[src|alt|title|width|height|align],li,ol,p,pre,q[cite],small,strike,strong/b,sub,sup,u,ul" ,
+    }
+
+    def self.init= js
+      @@init = js
+    end
+
+    def self.init
+      @@init
+    end
+
+    def self.cache_js
+      File.open("#{Rails.root}/public/javascripts/tinymce_hammer.js", 'w') do |file|
+        file.write Combiner.combined_js
+      end
+    end
+
+  end
+end

data/lib/tinymce/hammer/builder_methods.rb

@@ -0,0 +1,9 @@
+module Tinymce::Hammer::BuilderMethods
+
+  def tinymce method, options = {}
+    @template.require_tinymce_hammer
+    @template.append_class_name(options, 'tinymce')
+    self.text_area(method, options)
+  end
+  
+end

data/lib/tinymce/hammer/combiner.rb

@@ -0,0 +1,97 @@
+module Tinymce::Hammer::Combiner
+
+  REQUIRED = true
+  OPTIONAL = false
+  MARK_DONE = true
+
+  # Combines the following files into a single .js file, and caches that file
+  # to disk (when action_controller.perform_caching == true).   
+  #
+  # * tiny_mce.js (the main library)
+  # * each requested language file (like en.js)
+  # * each requested theme's editor_template.js
+  # * each requested theme's language files
+  # * each requested plugin's editor_plugin.js
+  # * each requested plugin's language files
+  #
+  # On-top of combining .js files support js is added to the top and end of this
+  # file to alert tiny_mce that these files have been loaded into the dom and
+  # no XMLHttpRequests are required to load these dynamically.
+  def self.combined_js
+
+    init_content
+
+    suffix = Tinymce::Hammer.src ? '_src' : ''
+
+    # add the tiny mce library
+    add_content("tiny_mce#{suffix}.js", REQUIRED)
+
+    # add languages
+    Tinymce::Hammer.languages.each do |lang|
+      add_content("langs/#{lang}.js", REQUIRED, MARK_DONE)
+    end
+
+    # add themes (and their languages)
+    Tinymce::Hammer.themes.each do |theme|
+      add_content("themes/#{theme}/editor_template#{suffix}.js", REQUIRED, MARK_DONE)
+      Tinymce::Hammer.languages.each do |lang|
+        add_content("themes/#{theme}/langs/#{lang}.js", OPTIONAL, MARK_DONE)
+      end
+    end
+
+    # add plugins (and their languages)
+    Tinymce::Hammer.plugins.each do |plugin|
+      add_content("plugins/#{plugin}/editor_plugin#{suffix}.js" , OPTIONAL, MARK_DONE)
+      Tinymce::Hammer.languages.each do |lang|
+        add_content("plugins/#{plugin}/langs/#{lang}.js", OPTIONAL, MARK_DONE)
+      end
+    end
+
+    @content + @events.join("\n")
+
+  end
+
+  protected
+
+  # this code tells tiny_mce where its main library files are located and that
+  # it was loaded via a combined file.
+  def self.init_content
+    @content = "
+(function(){var DomReady=window.DomReady={};var userAgent=navigator.userAgent.toLowerCase();var browser={version:(userAgent.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1],safari:/webkit/.test(userAgent),opera:/opera/.test(userAgent),msie:(/msie/.test(userAgent))&&(!/opera/.test(userAgent)),mozilla:(/mozilla/.test(userAgent))&&(!/(compatible|webkit)/.test(userAgent))};var readyBound=false;var isReady=false;var readyList=[];function domReady(){if(!isReady){isReady=true;if(readyList){for(var fn=0;fn<readyList.length;fn++){readyList[fn].call(window,[]);}
+readyList=[];}}};function addLoadEvent(func){var oldonload=window.onload;if(typeof window.onload!='function'){window.onload=func;}else{window.onload=function(){if(oldonload){oldonload();}
+func();}}};function bindReady(){if(readyBound){return;}
+readyBound=true;if(document.addEventListener&&!browser.opera){document.addEventListener('DOMContentLoaded',domReady,false);}
+if(browser.msie&&window==top)(function(){if(isReady)return;try{document.documentElement.doScroll('left');}catch(error){setTimeout(arguments.callee,0);return;}
+domReady();})();if(browser.opera){document.addEventListener('DOMContentLoaded',function(){if(isReady)return;for(var i=0;i<document.styleSheets.length;i++)
+if(document.styleSheets[i].disabled){setTimeout(arguments.callee,0);return;}
+domReady();},false);}
+if(browser.safari){var numStyles;(function(){if(isReady)return;if(document.readyState!='loaded'&&document.readyState!='complete'){setTimeout(arguments.callee,0);return;}
+if(numStyles===undefined){var links=document.getElementsByTagName('link');for(var i=0;i<links.length;i++){if(links[i].getAttribute('rel')=='stylesheet'){numStyles++;}}
+var styles=document.getElementsByTagName('style');numStyles+=styles.length;}
+if(document.styleSheets.length!=numStyles){setTimeout(arguments.callee,0);return;}
+domReady();})();}
+addLoadEvent(domReady);};DomReady.ready=function(fn,args){bindReady();if(isReady){fn.call(window,[]);}else{readyList.push(function(){return fn.call(window,[]);});}};bindReady();})();
+
+
+window.tinyMCEPreInit = {
+  base : '#{Tinymce::Hammer.install_path}',
+  suffix : '',  
+  query : ''
+}
+window.tinyMCE_GZ = { loaded : true };"
+
+    @events = []
+  end
+
+  def self.add_content path, required, mark_done = false
+    url_path = File.join(Tinymce::Hammer.install_path, path)
+    disk_path = File.join(Rails.root, 'public', Tinymce::Hammer.install_path, path)
+    if required or File.exists?(disk_path)
+      @content += File.read(disk_path)
+      if mark_done
+        @events << "tinymce.ScriptLoader.markDone(tinyMCE.baseURI.toAbsolute('#{url_path}'));";
+      end
+    end
+  end
+
+end

data/lib/tinymce/hammer/controller_methods.rb

@@ -0,0 +1,18 @@
+module Tinymce::Hammer::ControllerMethods
+
+  def self.included base
+    base.send(:hide_action, :require_tinymce_hammer)
+    base.send(:helper_method, :require_tinymce_hammer)
+    base.send(:hide_action, :tinymce_hammer_required?)
+    base.send(:helper_method, :tinymce_hammer_required?)
+  end
+
+  def require_tinymce_hammer
+    @tinymce_hammer_required = true
+  end
+
+  def tinymce_hammer_required?
+    @tinymce_hammer_required == true
+  end
+
+end

data/lib/tinymce/hammer/view_helpers.rb

@@ -0,0 +1,99 @@
+module Tinymce::Hammer::ViewHelpers
+
+  # If you call this method in your document head two script tags will be
+  # inserted when tinymce is required, otherwise nothing will be inserted.
+  def init_tinymce_hammer_if_required
+    if tinymce_hammer_required?
+      tinymce_hammer_javascript_tags
+    else
+      nil
+    end
+  end
+
+  def init_tinymce_hammer
+    tinymce_hammer_javascript_tags
+  end
+
+  # Returns two script tags.  The first loads the combined javascript file
+  # containing tinymce.  The second tag initializes tiny mce.
+  def tinymce_hammer_javascript_tags
+
+    init = ::Tinymce::Hammer.init
+    if init.is_a?(Hash)
+      init = HashWithIndifferentAccess.new(init)
+      init = init.keys.sort.collect(&:to_s).sort.collect{|key|
+        [key, init[key]]
+      }
+    end
+    init = init.collect {|key,value| "#{key} : #{value.to_json}" }.join(', ')
+
+    setup = "init.setup = #{Tinymce::Hammer.setup};" if Tinymce::Hammer.setup
+
+    return "
+<script src='#{tinymce_hammer_js_path}' type='text/javascript'></script>
+<script type='text/javascript'>
+  TinymceHammer = {
+    init : function() {
+      var init = { #{init} };
+      init.mode = 'specific_textareas';
+      init.editor_selector = 'tinymce';
+      init.plugins = '#{Tinymce::Hammer.plugins.join(',')}';
+      init.language = '#{I18n.locale}';
+      #{setup}
+      tinyMCE.init(init);
+    },
+    addEditor : function(dom_id) {
+      tinyMCE.execCommand('mceAddControl', true, dom_id);
+    }
+  }
+  DomReady.ready(TinymceHammer.init);
+</script>".html_safe
+  end
+
+  # Returns the TinymceHammer initializer javascript only. Very handy for AJAX calls and on-demand initializing.
+  # You can pass a classname for the textarea you want to initialize, or an array of classnames you want to be initialized.
+  def init_tinymce(classname="tinymce")
+    init = Tinymce::Hammer.init.collect{|key,value|
+      "#{key} : #{value.to_json}"
+    }.join(', ')
+    selector = classname.is_a?(Array) ? classname.join(",") : classname.to_s
+    setup = "init.setup = #{Tinymce::Hammer.setup};" if Tinymce::Hammer.setup
+    init = <<-JS
+      <script type="text/javascript">
+        TinymceHammer = {
+          init : function() {
+            var init = { #{init} };
+            init.mode = 'specific_textareas';
+            init.editor_selector = '#{selector}';
+            init.plugins = '#{Tinymce::Hammer.plugins.join(',')}';
+            init.language = '#{Tinymce::Hammer.languages.first}';
+            #{setup}
+            tinyMCE.init(init);
+          }
+        };
+        TinymceHammer.init();
+      </script>
+    JS
+  end
+
+  def tinymce_tag name, content = '', options = {}
+    require_tinymce_hammer
+    append_class_name(options, 'tinymce')
+    text_area_tag(name, content, options)
+  end
+
+  def tinymce object_name, method, options = {}
+    require_tinymce_hammer
+    append_class_name(options, 'tinymce')
+    text_area(object_name, method, options)
+  end
+
+  def append_class_name options, class_name #:nodoc:
+    key = options.has_key?('class') ? 'class' : :class 
+    unless options[key].to_s =~ /(^|\s+)#{class_name}(\s+|$)/
+      options[key] = "#{options[key]} #{class_name}".strip
+    end
+    options
+  end
+
+end

data/lib/tinymce_hammer.rb

@@ -0,0 +1 @@
+require 'tinymce/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3

data/tinymce_hammer.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tinymce_hammer}
+  s.version = "0.2.2"
+  
+  s.authors = ["Trevor Rowe", "Thomas von Deyen"]
+  s.date = %q{2011-06-05}
+  s.summary = %q{TinyMCE WYSIWYG editor for your Rails 3 application.}
+  s.description = %q{TinyMCE Hammer makes its easy to use the TinyMCE WYSIWYG editor inside a Ruby
+    On Rails (3+) application.}
+  s.email = %q{tvdeyen@gmail.com}
+  s.files = `git ls-files`.split("\n")
+  s.homepage = %q{https://github.com/tvdeyen/tinymce_hammer}
+  s.require_paths = ["lib"]
+  
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: tinymce_hammer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Trevor Rowe
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |-
+  TinyMCE Hammer makes its easy to use the TinyMCE WYSIWYG editor inside a Ruby
+      On Rails (3+) application.
+email: tvdeyen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- app/controllers/tinymce/hammer_controller.rb
+- config/routes.rb
+- lib/tasks/tinymce.rake
+- lib/tinymce/engine.rb
+- lib/tinymce/hammer.rb
+- lib/tinymce/hammer/builder_methods.rb
+- lib/tinymce/hammer/combiner.rb
+- lib/tinymce/hammer/controller_methods.rb
+- lib/tinymce/hammer/view_helpers.rb
+- lib/tinymce_hammer.rb
+- tinymce_hammer.gemspec
+has_rdoc: true
+homepage: https://github.com/tvdeyen/tinymce_hammer
+licenses: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: TinyMCE WYSIWYG editor for your Rails 3 application.
+test_files: []
+