tiny_mce_helper 0.1.1 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 == master
 
+== 0.2.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+* Update tests to use mocha
+* Update tests to use ActionView::TestCase
+
 == 0.1.1 / 2008-10-19
 
 * Fix TinyMCE temp file getting closed/deleted too soon after being downloaded [Brandon Goodin]

data/README.rdoc

@@ -149,13 +149,17 @@ will generate the following javascript:
     'content_css' : '/stylesheets/tiny_mce_content.css'
   });
 
-To see additional initialization helpers, see the API for PluginAWeek::TinyMCEHelper
+To see additional initialization helpers, see the API for TinyMCEHelper
 
 == Testing
 
 Before you can run any tests, the following gem must be installed:
 * plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
+To run against a specific version of Rails:
+
+  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
+
 Since the rake tasks for installing TinyMCE and updating the configuration
 options are part of the unit tests, already-downloaded files are included with
 the plugin.  If you want to perform a "live" test which actually downloads the
@@ -164,10 +168,6 @@ the LIVE environment variable to true.  For example,
 
   rake test LIVE=true
 
-To run against a specific version of Rails:
-
-  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
-
 == Dependencies
 
 * Rails 2.0 or later

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'tiny_mce_helper'
-  s.version           = '0.1.1'
+  s.version           = '0.2.0'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Adds helper methods for creating the TinyMCE initialization script.'
   

data/install.rb

@@ -1,7 +1,7 @@
 # Install TinyMCE
 puts 'Installing TinyMCE...'
-PluginAWeek::TinyMCEHelper.install(:version => ENV['VERSION'], :target => ENV['TARGET'])
+TinyMCEHelper.install(:version => ENV['VERSION'], :target => ENV['TARGET'])
 
 # Update the configuration options
 puts 'Updating TinyMCE configuration options...'
-PluginAWeek::TinyMCEHelper.update_options
+TinyMCEHelper.update_options

data/lib/tiny_mce_helper.rb

@@ -1,264 +1,263 @@
-module PluginAWeek #:nodoc:
-  # Adds helper methods for generating the TinyMCE initialization script
-  # within your views
-  module TinyMCEHelper
-    # The path to the file which contains all valid options that can be used
-    # to configure TinyMCE
-    OPTIONS_FILE_PATH = "#{Rails.root}/config/tiny_mce_options.yml"
-    
-    # A regular expression matching options that are dynamic (i.e. they can
-    # vary on an integer or string basis)
-    DYNAMIC_OPTIONS = /theme_advanced_buttons|theme_advanced_container/
-    
-    # Whether or not to use verbose output
-    mattr_accessor :verbose
-    @@verbose = true
-    
-    # A list of all valid options that can be used to configure TinyMCE
-    mattr_accessor :valid_options
-    @@valid_options = File.exists?(OPTIONS_FILE_PATH) ? File.open(OPTIONS_FILE_PATH) {|f| YAML.load(f.read)} : []
-    
-    class << self
-      # Installs TinyMCE by downloading it and adding it to your application's
-      # javascripts folder.
-      # 
-      # Configuration options:
-      # * +version+ - The version of TinyMCE to install. Default is the latest version.
-      # * +target+ - The path to install TinyMCE to, relative to the project root. Default is "public/javascripts/tiny_mce"
-      # * +force+ - Whether to install TinyMCE, regardless of whether it already exists on the filesystem.
-      # 
-      # == Versions
-      # 
-      # By default, this will install the latest version of TinyMCE.  You can
-      # install a specific version of TinyMCE (if you are using an old API) by
-      # passing in the version number.
-      # 
-      # For example,
-      #   PluginAWeek::TinyMCEHelper.install                      # Installs the latest version
-      #   PluginAWeek::TinyMCEHelper.install(:version => '2.0.8') # Installs version 2.0.8
-      # 
-      # An exception will be raised if the specified version cannot be found.
-      # 
-      # == Target path
-      # 
-      # By default, this will install TinyMCE into Rails.root/public/javascripts/tiny_mce.
-      # If you want to install it to a different directory, you can pass in a
-      # parameter with the relative path from Rails.root.
-      # 
-      # For example,
-      #   PluginAWeek::TinyMCEHelper.install(:target => 'public/javascripts/richtext')
-      # 
-      # == Conflicting paths
-      # 
-      # If TinyMCE is found to already be installed on the filesystem, a prompt
-      # will be displayed for whether to overwrite the existing directory.  This
-      # prompt can be automatically skipped by passing in the :force option.
-      def install(options = {})
-        options.assert_valid_keys(:version, :target, :force)
-        options.reverse_merge!(:force => false)
-        
-        version = options[:version]
-        base_target = options[:target] || 'public/javascripts/tiny_mce'
-        source_path = 'tinymce'
-        target_path = File.expand_path(File.join(Rails.root, base_target))
-        
-        # If TinyMCE is already installed, make sure the user wants to continue
-        if !options[:force] && File.exists?(target_path)
-          print "TinyMCE already installed in #{target_path}. Overwrite? (y/n): "
-          while !%w(y n).include?(option = STDIN.gets.chop)
-            print "Invalid option. Overwrite #{target_path}? (y/n): "
-          end
-          return if option == 'n'
-        end
-        
-        # Get the url of the TinyMCE version
-        require 'hpricot'
-        require 'open-uri'
-        
-        puts "Finding url of TinyMCE-#{version || 'latest'} download..." if verbose
-        doc = Hpricot(open('http://sourceforge.net/project/showfiles.php?group_id=103281&package_id=111430'))
-        if version
-          url_version = version.gsub('.', '_')
-          file_element = (doc/'tr[@id*="rel0_"] a').detect {|file| file.innerHTML =~ /#{url_version}.zip$/}
-          raise ArgumentError, "Could not find TinyMCE version #{version}" if !file_element
-        else
-          file_element = (doc/'tr[@id^="pkg0_1rel0_"] a').detect {|file| file.innerHTML.to_s =~ /tinymce_([\d_]+).zip$/}
-          raise ArgumentError, 'Could not find latest TinyMCE version' if !file_element
-          
-          version = $1.gsub('_', '.')
+# Adds helper methods for generating the TinyMCE initialization script
+# within your views
+module TinyMCEHelper
+  # The path to the file which contains all valid options that can be used
+  # to configure TinyMCE
+  OPTIONS_FILE_PATH = "#{Rails.root}/config/tiny_mce_options.yml"
+  
+  # A regular expression matching options that are dynamic (i.e. they can
+  # vary on an integer or string basis)
+  DYNAMIC_OPTIONS = /theme_advanced_buttons|theme_advanced_container/
+  
+  # Whether or not to use verbose output
+  mattr_accessor :verbose
+  @@verbose = true
+  
+  # A list of all valid options that can be used to configure TinyMCE
+  mattr_accessor :valid_options
+  @@valid_options = File.exists?(OPTIONS_FILE_PATH) ? File.open(OPTIONS_FILE_PATH) {|f| YAML.load(f.read)} : []
+  
+  class << self
+    # Installs TinyMCE by downloading it and adding it to your application's
+    # javascripts folder.
+    # 
+    # Configuration options:
+    # * +version+ - The version of TinyMCE to install. Default is the latest version.
+    # * +target+ - The path to install TinyMCE to, relative to the project root. Default is "public/javascripts/tiny_mce"
+    # * +force+ - Whether to install TinyMCE, regardless of whether it already exists on the filesystem.
+    # 
+    # == Versions
+    # 
+    # By default, this will install the latest version of TinyMCE.  You can
+    # install a specific version of TinyMCE (if you are using an old API) by
+    # passing in the version number.
+    # 
+    # For example,
+    #   TinyMCEHelper.install                      # Installs the latest version
+    #   TinyMCEHelper.install(:version => '2.0.8') # Installs version 2.0.8
+    # 
+    # An exception will be raised if the specified version cannot be found.
+    # 
+    # == Target path
+    # 
+    # By default, this will install TinyMCE into Rails.root/public/javascripts/tiny_mce.
+    # If you want to install it to a different directory, you can pass in a
+    # parameter with the relative path from Rails.root.
+    # 
+    # For example,
+    #   TinyMCEHelper.install(:target => 'public/javascripts/richtext')
+    # 
+    # == Conflicting paths
+    # 
+    # If TinyMCE is found to already be installed on the filesystem, a prompt
+    # will be displayed for whether to overwrite the existing directory.  This
+    # prompt can be automatically skipped by passing in the :force option.
+    def install(options = {})
+      options.assert_valid_keys(:version, :target, :force)
+      options.reverse_merge!(:force => false)
+      
+      version = options[:version]
+      base_target = options[:target] || 'public/javascripts/tiny_mce'
+      source_path = 'tinymce'
+      target_path = File.expand_path(File.join(Rails.root, base_target))
+      
+      # If TinyMCE is already installed, make sure the user wants to continue
+      if !options[:force] && File.exists?(target_path)
+        print "TinyMCE already installed in #{target_path}. Overwrite? (y/n): "
+        while !%w(y n).include?(option = STDIN.gets.chop)
+          print "Invalid option. Overwrite #{target_path}? (y/n): "
         end
         
-        filename = file_element.innerHTML
-        file_url = file_element['href']
-        
-        # Download the file
-        puts "Downloading TinyMCE-#{version} source from #{file_url}..." if verbose
-        open(file_url) do |file|
-          file_path = file.path
-          
-          # Extract and install
-          puts "Extracting source from #{file_path}..." if verbose
-          
-          require 'zip/zip'
-          require 'zip/zipfilesystem'
-          
-          Zip::ZipFile.open(file_path) do |zipfile|
-            zipfile.entries.each do |entry|
-              if match = /tinymce\/jscripts\/tiny_mce\/(.*)/.match(entry.name)
-                FileUtils.mkdir_p("#{target_path}/#{File.dirname(match[1])}")
-                entry.extract("#{target_path}/#{match[1]}") { true }
-              end
-            end
-          end
-          
-          puts 'Done!' if verbose
-        end
+        return if option == 'n'
       end
       
-      # Uninstalls the TinyMCE installation and optional configuration file
-      # 
-      # Configuration options:
-      # * +target+ - The path that TinyMCE was installed to. Default is "public/javascripts/tiny_mce"
-      def uninstall(options = {})
-        # Remove the TinyMCE configuration file
-        File.delete(OPTIONS_FILE_PATH)
+      # Get the url of the TinyMCE version
+      require 'hpricot'
+      require 'open-uri'
+      
+      puts "Finding url of TinyMCE-#{version || 'latest'} download..." if verbose
+      doc = Hpricot(open('http://sourceforge.net/project/showfiles.php?group_id=103281&package_id=111430'))
+      if version
+        url_version = version.gsub('.', '_')
+        file_element = (doc/'tr[@id*="rel0_"] a').detect {|file| file.innerHTML =~ /#{url_version}.zip$/}
+        raise ArgumentError, "Could not find TinyMCE version #{version}" if !file_element
+      else
+        file_element = (doc/'tr[@id^="pkg0_1rel0_"] a').detect {|file| file.innerHTML.to_s =~ /tinymce_([\d_]+).zip$/}
+        raise ArgumentError, 'Could not find latest TinyMCE version' if !file_element
         
-        # Remove the TinyMCE installation
-        FileUtils.rm_rf(options[:target] || "#{Rails.root}/public/javascripts/tiny_mce")
+        version = $1.gsub('_', '.')
       end
       
-      # Updates the list of possible configuration options that can be used
-      # when initializing the TinyMCE script.  These are always installed to
-      # the application folder, config/tiny_mce_options.yml.  If this file
-      # does not exist, then the TinyMCE helper will not be able to verify
-      # that all of the initialization options are valid.
-      def update_options
-        require 'hpricot'
-        require 'open-uri'
-        require 'yaml'
+      filename = file_element.innerHTML
+      file_url = file_element['href']
+      
+      # Download the file
+      puts "Downloading TinyMCE-#{version} source from #{file_url}..." if verbose
+      open(file_url) do |file|
+        file_path = file.path
+        
+        # Extract and install
+        puts "Extracting source from #{file_path}..." if verbose
         
-        puts 'Downloading configuration options from TinyMCE Wiki...' if verbose
-        doc = Hpricot(open('http://wiki.moxiecode.com/index.php/TinyMCE:Configuration'))
-        options = (doc/'a[@title*="Configuration/"]/').collect {|option| option.to_s}.sort
-        options.reject! {|option| option =~ DYNAMIC_OPTIONS}
+        require 'zip/zip'
+        require 'zip/zipfilesystem'
         
-        File.open(OPTIONS_FILE_PATH, 'w') do |out|
-          YAML.dump(options, out)
+        Zip::ZipFile.open(file_path) do |zipfile|
+          zipfile.entries.each do |entry|
+            if match = /tinymce\/jscripts\/tiny_mce\/(.*)/.match(entry.name)
+              FileUtils.mkdir_p("#{target_path}/#{File.dirname(match[1])}")
+              entry.extract("#{target_path}/#{match[1]}") { true }
+            end
+          end
         end
+        
         puts 'Done!' if verbose
       end
     end
     
-    # Is TinyMCE being used?
-    def using_tiny_mce?
-      @uses_tiny_mce
-    end
-    
-    # Create the TinyMCE initialization scripts.  The default configuration
-    # is for a simple theme that replaces all textareas on the page.  For
-    # example, the default initialization script will generate the following:
-    # 
-    #  tinyMCE.init({
-    #    'mode' : 'textareas',
-    #    'theme' : 'simple'
-    #  });
-    # 
-    # == Customizing initialization options
-    # 
-    # To customize the options to be included in the initialization script,
-    # you can pass in a hash to +tiny_mce_init_script+.  For example,
-    # 
-    #   tiny_mce_init_script(
-    #     :theme => 'advanced',
-    #     :editor_selector => 'rich_text',
-    #     :content_css => '/stylesheets/tiny_mce_content.css',
-    #     :editor_css => '/stylesheets/tiny_mce_editor.css',
-    #     :auto_reset_designmode => true
-    #   )
-    # 
-    # will generate:
+    # Uninstalls the TinyMCE installation and optional configuration file
     # 
-    #  tinyMCE.init({
-    #    'mode' : 'textareas',
-    #    'theme' : 'advanced',
-    #    'editor_selected' : 'rich_text',
-    #    'content_css' : '/stylesheets/tiny_mce_content.css'
-    #  });
-    # 
-    # == Validating options
-    # 
-    # If additional options are passed in to initialize TinyMCE, they will be
-    # validated against the list of valid options in PluginAWeek::TinyMCEHelper#valid_options.
-    # These options are configured in the file config/tiny_mce_options.yml.
-    # You can generate this file by invoke the rake task tiny_mce:update_options.
-    def tiny_mce_init_script(options = @tiny_mce_options)
-      options ||= {}
-      options.stringify_keys!.reverse_merge!(
-        'mode' => 'textareas',
-        'theme' => 'simple'
-      )
+    # Configuration options:
+    # * +target+ - The path that TinyMCE was installed to. Default is "public/javascripts/tiny_mce"
+    def uninstall(options = {})
+      # Remove the TinyMCE configuration file
+      File.delete(OPTIONS_FILE_PATH)
       
-      # Check validity
-      plugins = options['plugins']
-      options_to_validate = options.reject {|option, value| plugins && plugins.include?(option.split('_')[0]) || option =~ DYNAMIC_OPTIONS}
-      options_to_validate.assert_valid_keys(@@valid_options) if @@valid_options && @@valid_options.any?
+      # Remove the TinyMCE installation
+      FileUtils.rm_rf(options[:target] || "#{Rails.root}/public/javascripts/tiny_mce")
+    end
+    
+    # Updates the list of possible configuration options that can be used
+    # when initializing the TinyMCE script.  These are always installed to
+    # the application folder, config/tiny_mce_options.yml.  If this file
+    # does not exist, then the TinyMCE helper will not be able to verify
+    # that all of the initialization options are valid.
+    def update_options
+      require 'hpricot'
+      require 'open-uri'
+      require 'yaml'
       
-      init_script = 'tinyMCE.init({'
+      puts 'Downloading configuration options from TinyMCE Wiki...' if verbose
+      doc = Hpricot(open('http://wiki.moxiecode.com/index.php/TinyMCE:Configuration'))
+      options = (doc/'a[@title*="Configuration/"]/').collect {|option| option.to_s}.sort
+      options.reject! {|option| option =~ DYNAMIC_OPTIONS}
       
-      options.sort.each do |key, value|
-        init_script += "\n#{key} : "
-        
-        case value
-          when String, Symbol, Fixnum
-            init_script << "'#{value}'"
-          when Array
-            init_script << "'#{value.join(',')}'"
-          when TrueClass
-            init_script << 'true'
-          when FalseClass
-            init_script << 'false'
-          else
-            raise ArgumentError, "Cannot parse value of type #{value.class} passed for TinyMCE option #{key}"
-        end
-        
-        init_script << ','
+      File.open(OPTIONS_FILE_PATH, 'w') do |out|
+        YAML.dump(options, out)
       end
-      
-      init_script.chop << "\n});"
+      puts 'Done!' if verbose
     end
+  end
+  
+  # Is TinyMCE being used?
+  def using_tiny_mce?
+    @uses_tiny_mce
+  end
+  
+  # Create the TinyMCE initialization scripts.  The default configuration
+  # is for a simple theme that replaces all textareas on the page.  For
+  # example, the default initialization script will generate the following:
+  # 
+  #  tinyMCE.init({
+  #    'mode' : 'textareas',
+  #    'theme' : 'simple'
+  #  });
+  # 
+  # == Customizing initialization options
+  # 
+  # To customize the options to be included in the initialization script,
+  # you can pass in a hash to +tiny_mce_init_script+.  For example,
+  # 
+  #   tiny_mce_init_script(
+  #     :theme => 'advanced',
+  #     :editor_selector => 'rich_text',
+  #     :content_css => '/stylesheets/tiny_mce_content.css',
+  #     :editor_css => '/stylesheets/tiny_mce_editor.css',
+  #     :auto_reset_designmode => true
+  #   )
+  # 
+  # will generate:
+  # 
+  #  tinyMCE.init({
+  #    'mode' : 'textareas',
+  #    'theme' : 'advanced',
+  #    'editor_selected' : 'rich_text',
+  #    'content_css' : '/stylesheets/tiny_mce_content.css'
+  #  });
+  # 
+  # == Validating options
+  # 
+  # If additional options are passed in to initialize TinyMCE, they will be
+  # validated against the list of valid options in TinyMCEHelper#valid_options.
+  # These options are configured in the file config/tiny_mce_options.yml.
+  # You can generate this file by invoke the rake task tiny_mce:update_options.
+  def tiny_mce_init_script(options = @tiny_mce_options)
+    options ||= {}
+    options.stringify_keys!.reverse_merge!(
+      'mode' => 'textareas',
+      'theme' => 'simple'
+    )
     
-    # Generate the TinyMCE. Any arguments will be passed to tiny_mce_init_script.
-    def tiny_mce(*args)
-      javascript_tag tiny_mce_init_script(*args)
-    end
+    # Check validity
+    plugins = options['plugins']
+    options_to_validate = options.reject {|option, value| plugins && plugins.include?(option.split('_')[0]) || option =~ DYNAMIC_OPTIONS}
+    options_to_validate.assert_valid_keys(@@valid_options) if @@valid_options && @@valid_options.any?
     
-    # The name of the TinyMCE javascript file to use.  In development, this
-    # will use the source (uncompressed) file in order to help with debugging
-    # issues that occur within TinyMCE.  In production, the compressed version
-    # of TinyMCE will be used in order to increased download speed.
-    def tiny_mce_file_name
-      Rails.env == 'development' ? 'tiny_mce/tiny_mce_src' : 'tiny_mce/tiny_mce'
-    end
+    init_script = 'tinyMCE.init({'
     
-    # Generates the javascript include for TinyMCE.  For example,
-    # 
-    #   javascript_include_tiny_mce
-    # 
-    # will generate:
-    # 
-    #   <script type="text/javascript" src="/javascripts/tiny_mce/tiny_mce.js"></script>
-    def javascript_include_tiny_mce
-      javascript_include_tag tiny_mce_file_name
+    options.sort.each do |key, value|
+      init_script += "\n#{key} : "
+      
+      case value
+        when String, Symbol, Fixnum
+          init_script << "'#{value}'"
+        when Array
+          init_script << "'#{value.join(',')}'"
+        when TrueClass
+          init_script << 'true'
+        when FalseClass
+          init_script << 'false'
+        else
+          raise ArgumentError, "Cannot parse value of type #{value.class} passed for TinyMCE option #{key}"
+      end
+      
+      init_script << ','
     end
     
-    # Conditionally includes the TinyMCE javascript file if the variable
-    # @uses_tiny_mce has been set to true.
-    def javascript_include_tiny_mce_if_used
-      javascript_include_tiny_mce if using_tiny_mce?
-    end
+    init_script.chop << "\n});"
+  end
+  
+  # Generate the TinyMCE. Any arguments will be passed to tiny_mce_init_script.
+  def tiny_mce(*args)
+    javascript_tag tiny_mce_init_script(*args)
+  end
+  
+  # The name of the TinyMCE javascript file to use.  In development, this
+  # will use the source (uncompressed) file in order to help with debugging
+  # issues that occur within TinyMCE.  In production, the compressed version
+  # of TinyMCE will be used in order to increased download speed.
+  def tiny_mce_file_name
+    Rails.env == 'development' ? 'tiny_mce/tiny_mce_src' : 'tiny_mce/tiny_mce'
+  end
+  
+  # Generates the javascript include for TinyMCE.  For example,
+  # 
+  #   javascript_include_tiny_mce
+  # 
+  # will generate:
+  # 
+  #   <script type="text/javascript" src="/javascripts/tiny_mce/tiny_mce.js"></script>
+  def javascript_include_tiny_mce
+    javascript_include_tag tiny_mce_file_name
+  end
+  
+  # Conditionally includes the TinyMCE javascript file if the variable
+  # @uses_tiny_mce has been set to true.
+  def javascript_include_tiny_mce_if_used
+    javascript_include_tiny_mce if using_tiny_mce?
   end
 end
 
 ActionController::Base.class_eval do
-  helper PluginAWeek::TinyMCEHelper
+  helper TinyMCEHelper
 end

data/tasks/tiny_mce_helper_tasks.rake

@@ -1,21 +1,21 @@
 namespace :tiny_mce do
   desc 'Downloads TinyMCE and installs it in the application. Target specific version with VERSION=x, specific target path with TARGET=y'
   task :install => :environment do
-    PluginAWeek::TinyMCEHelper.install(:version => ENV['VERSION'], :target => ENV['TARGET'])
+    TinyMCEHelper.install(:version => ENV['VERSION'], :target => ENV['TARGET'])
   end
   
   desc 'Downloads TinyMCE and installs it in the application. Target specific version with VERSION=x, specific target path with TARGET=y'
   task :update => :environment do
-    PluginAWeek::TinyMCEHelper.install(:version => ENV['VERSION'], :target => ENV['TARGET'], :force => true)
+    TinyMCEHelper.install(:version => ENV['VERSION'], :target => ENV['TARGET'], :force => true)
   end
   
   desc 'Uninstalls TinyMCE and removes any associated configuration files.'
   task :uninstall => :environment do
-    PluginAWeek::TinyMCEHelper.uninstall(:target => ENV['TARGET'])
+    TinyMCEHelper.uninstall(:target => ENV['TARGET'])
   end
   
   desc 'Updates the list of TinyMCE options and stores them in config/tiny_mce_options.yml.'
   task :update_options => :environment do
-    PluginAWeek::TinyMCEHelper.update_options
+    TinyMCEHelper.update_options
   end
 end