textile_editor 0.1.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,2 @@
+*swp
+.DS_Store

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+group :test do
+  gem 'test-unit'
+end

data/Gemfile.lock

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    test-unit (2.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  test-unit

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |s|
+    s.name = 'textile-editor'
+    s.author = "Ben Mills"
+    s.email = "ben@unfiniti.com"
+    s.summary = "Provide textile toolbar to textareas"
+    s.homepage = "http://unfiniti.com"
+    
+    s.test_files = Dir['test/**/*']
+  end
+rescue LoadError
+  puts "Jeweler not installed."
+  exit 1
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the textile_editor plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the textile_editor_helper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TextileEditor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/textile_editor.rb

@@ -0,0 +1,187 @@
+module ActionView
+  module Helpers
+
+    class FormBuilder
+      def textile_editor(method, options = {})
+        @template.textile_editor(@object_name, method, options.merge(:object => @object))
+      end
+    end
+    
+    module PrototypeHelper
+    end
+    
+    module FormHelper
+      # Returns a textarea opening and closing tag set tailored for accessing a specified attribute (identified by +method+)
+      # on an object assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
+      # hash with +options+ and places the textile toolbar above it
+      #
+      # ==== Examples
+      #   textile_editor(:post, :body, :cols => 20, :rows => 40)
+      #   # => <textarea cols="20" rows="40" id="post_body" name="post[body]">
+      #   #      #{@post.body}
+      #   #    </textarea>
+      #
+      #   textile_editor(:comment, :text, :size => "20x30")
+      #   # => <textarea cols="20" rows="30" id="comment_text" name="comment[text]">
+      #   #      #{@comment.text}
+      #   #    </textarea>
+      #
+      #   textile_editor(:application, :notes, :cols => 40, :rows => 15, :class => 'app_input')
+      #   # => <textarea cols="40" rows="15" id="application_notes" name="application[notes]" class="app_input">
+      #   #      #{@application.notes}
+      #   #    </textarea>
+      #
+      #   textile_editor(:entry, :body, :size => "20x20", :disabled => 'disabled')
+      #   # => <textarea cols="20" rows="20" id="entry_body" name="entry[body]" disabled="disabled">
+      #   #      #{@entry.body}
+      #   #    </textarea>
+      def textile_editor(object_name, method, options = {})        
+        editor_id = options[:id] || '%s_%s' % [object_name, method]
+        mode      = options.delete(:simple) ? 'simple' : 'extended'
+        (@textile_editor_ids ||= []) << [editor_id.to_s, mode.to_s]
+
+        InstanceTag.new(object_name, method, self, options.delete(:object)).to_text_area_tag(options)
+      end
+      
+      def textile_editor_options(options={})
+        (@textile_editor_options ||= { :framework => :prototype }).merge! options
+      end
+      
+      def textile_editor_support
+        output = []
+        output << stylesheet_link_tag('textile-editor') 
+        output << javascript_include_tag('textile-editor')
+        output.join("\n").html_safe
+      end
+      
+      # registers a new button for the Textile Editor toolbar
+      # Parameters:
+      #   * +text+: text to display (contents of button tag, so HTML is valid as well)
+      #   * +options+: options Hash as supported by +content_tag+ helper in Rails
+      # 
+      # Example:
+      #   The following example adds a button labeled 'Greeting' which triggers an
+      #   alert:
+      # 
+      #   <% textile_editor_button 'Greeting', :onclick => "alert('Hello!')" %> 
+      #
+      # *Note*: this method must be called before +textile_editor_initialize+
+      def textile_editor_button(text, options={})
+        return textile_editor_button_separator  if text == :separator
+        button = content_tag(:button, text, options)
+        button = "TextileEditor.buttons.push(\"%s\");" % escape_javascript(button)
+        (@textile_editor_buttons ||= []) << button
+      end
+
+      def textile_editor_button_separator(options={})
+        button = "TextileEditor.buttons.push(new TextileEditorButtonSeparator('%s'));" % (options[:simple] || '')
+        (@textile_editor_buttons ||= []) << button
+      end
+
+      def textile_extract_dom_ids(*dom_ids)
+        hash = dom_ids.last.is_a?(Hash) ? dom_ids.pop : {}
+        hash.inject(dom_ids) do |ids, (object, fields)|
+          ids + Array(fields).map { |field| "%s_%s" % [object, field] }
+        end
+      end
+      
+      # adds the necessary javascript include tags, stylesheet tags,
+      # and load event with necessary javascript to active textile editor(s)
+      # sample output:
+      #    <link href="/stylesheets/textile-editor.css" media="screen" rel="Stylesheet" type="text/css" />
+      #    <script src="/javascripts/textile-editor.js" type="text/javascript"></script>
+      #    <script type="text/javascript">
+      #    document.observe('dom:loaded', function() {
+      #    TextileEditor.initialize('article_body', 'extended');
+      #    TextileEditor.initialize('article_body_excerpt', 'simple');
+      #    });
+      #    </script>  
+      # 
+      # Note: in the case of this helper being called via AJAX, the output will be reduced:
+      #    <script type="text/javascript">
+      #    TextileEditor.initialize('article_body', 'extended');
+      #    TextileEditor.initialize('article_body_excerpt', 'simple');
+      #    </script>  
+      # 
+      # This means that the support files must be loaded outside of the AJAX request, either
+      # via a call to this helper or the textile_editor_support() helper
+      def textile_editor_initialize(*dom_ids)
+        options = textile_editor_options.dup
+
+        # extract options from last argument if it's a hash
+        if dom_ids.last.is_a?(Hash)
+          hash = dom_ids.last.dup
+          options.merge! hash
+          dom_ids.last.delete :framework
+        end
+
+        editor_ids = (@textile_editor_ids || []) + textile_extract_dom_ids(*dom_ids)
+        editor_buttons = (@textile_editor_buttons || [])
+        output = []
+        output << textile_editor_support unless request.xhr?
+        output << '<script type="text/javascript">'
+        output << '/* <![CDATA[ */'
+        
+        if !request.xhr?
+          case options[:framework]
+          when :prototype
+            output << %{document.observe('dom:loaded', function() \{}
+          when :jquery
+            output << %{$(document).ready(function() \{}
+          end
+        end      
+
+        # output << %q{TextileEditor.framework = '%s';} % options[:framework].to_s
+        output << editor_buttons.join("\n") if editor_buttons.any?
+        editor_ids.each do |editor_id, mode|
+          output << %q{TextileEditor.initialize('%s', '%s');} % [editor_id, mode || 'extended']
+        end
+        output << '});' unless request.xhr?
+
+        output << '/* ]]> */'
+        output << '</script>'
+        output.join("\n").html_safe
+      end
+    end
+    
+    module FormTagHelper
+      # Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions 
+      # and includes the textile toolbar above it.
+      # 
+      # ==== Options
+      # * <tt>:size</tt> - A string specifying the dimensions (columns by rows) of the textarea (e.g., "25x10").
+      # * <tt>:rows</tt> - Specify the number of rows in the textarea
+      # * <tt>:cols</tt> - Specify the number of columns in the textarea
+      # * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
+      # * Any other key creates standard HTML attributes for the tag.
+      #
+      # ==== Examples
+      #   textile_editor_tag 'post'
+      #   # => <textarea id="post" name="post"></textarea>
+      #
+      #   textile_editor_tag 'bio', @user.bio
+      #   # => <textarea id="bio" name="bio">This is my biography.</textarea>
+      #
+      #   textile_editor_tag 'body', nil, :rows => 10, :cols => 25
+      #   # => <textarea cols="25" id="body" name="body" rows="10"></textarea>
+      #
+      #   textile_editor_tag 'body', nil, :size => "25x10"
+      #   # => <textarea name="body" id="body" cols="25" rows="10"></textarea>
+      #
+      #   textile_editor_tag 'description', "Description goes here.", :disabled => true
+      #   # => <textarea disabled="disabled" id="description" name="description">Description goes here.</textarea>
+      #
+      #   textile_editor_tag 'comment', nil, :class => 'comment_input'
+      #   # => <textarea class="comment_input" id="comment" name="comment"></textarea>
+      def textile_editor_tag(name, content = nil, options = {})
+        editor_id = options[:id] || name
+        mode      = options.delete(:simple) ? 'simple' : 'extended'
+        (@textile_editor_ids ||= []) << [editor_id.to_s, mode.to_s]
+        
+        text_area_tag(name, content, options)
+      end
+    end
+    
+  end
+end
+

data/test/abstract_unit.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'yaml'
+require 'test/unit'
+require 'rubygems'
+
+require 'action_controller'
+require 'action_controller/cgi_ext'
+require 'action_controller/test_process'
+
+# Show backtraces for deprecated behavior for quicker cleanup.
+ActiveSupport::Deprecation.debug = true
+
+ActionController::Base.logger = nil
+# ActionController::Base.ignore_missing_templates = false
+ActionController::Routing::Routes.reload rescue nil

data/test/textile_editor_test.rb

@@ -0,0 +1,195 @@
+require File.dirname(__FILE__) + '/abstract_unit'
+require File.dirname(__FILE__) + '/../lib/textile_editor'
+require 'ostruct'
+
+class TextileEditorHelperTest < Test::Unit::TestCase
+  include ActionView::Helpers::TextHelper
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::JavaScriptHelper
+  # include TextileEditorHelper
+    
+  def setup
+    @controller = Class.new do
+      attr_reader :url_for_options
+      def url_for(options, *parameters_for_method_reference)
+        @url_for_options = options
+        "http://www.example.com"
+      end
+      
+      def request;  @request  ||= ActionController::TestRequest.new;  end
+      def response; @response ||= ActionController::TestResponse.new; end
+    end
+    @controller = @controller.new    
+    @article = OpenStruct.new(:body => nil)
+  end
+  
+  # support methods
+  def request
+    @controller.request
+  end
+  
+  def create_simple_editor(object, field, options={})
+    output = textile_editor(object, field, options.merge(:simple => true))
+    assert_equal  text_area(object, field, options), output
+  end  
+
+  def create_extended_editor(object, field, options={})
+    output = textile_editor(object, field, options)
+    assert_equal  text_area(object, field, options), output
+  end  
+
+  def framework_initialize_output(framework)
+    case framework
+    when :prototype
+      %{document.observe('dom:loaded', function() \{}
+    when :jquery
+      %{$(document).ready(function() \{}
+    end
+  end
+  
+  def pre_initialize_output(framework)
+    %{<link href="/stylesheets/textile-editor.css" media="screen" rel="stylesheet" type="text/css" />
+      <script src="/javascripts/textile-editor.js" type="text/javascript"></script>
+      <script type="text/javascript">
+      /* <![CDATA[ */
+      } +
+      framework_initialize_output(framework)
+  end
+  
+  def post_initialize_output
+    %{\});
+      /* ]]> */
+      </script>
+    }
+  end
+  
+  def expected_initialize_output(framework, editors, button_data=nil)
+    expected = [pre_initialize_output(framework)]
+    expected << button_data unless button_data.nil?
+    expected << editors.map do |editor|
+      "TextileEditor.initialize('%s', '%s');" % editor
+    end
+    expected << post_initialize_output
+    expected.join("\n").split("\n").map { |e| e.lstrip }.join("\n").chomp
+  end
+  
+  # tests
+  def test_textile_editor
+    assert_nil @textile_editor_ids
+    create_extended_editor('article', 'body')
+    assert_equal [['article_body', 'extended']], @textile_editor_ids
+  end
+  
+  def test_textile_editor_simple_mode
+    assert_nil @textile_editor_ids
+    create_simple_editor('article', 'body')
+    assert_equal [['article_body', 'simple']], @textile_editor_ids
+  end
+  
+  def test_textile_editor_with_custom_id
+    assert_nil @textile_editor_ids
+    create_extended_editor('article', 'body', :id => 'my_custom_id')
+    assert_equal [['my_custom_id', 'extended']], @textile_editor_ids
+  end  
+  
+  def test_textile_editor_simple_mode_with_custom_id
+    assert_nil @textile_editor_ids
+    create_simple_editor('article', 'body', :id => 'my_custom_id')
+    assert_equal [['my_custom_id', 'simple']], @textile_editor_ids
+  end
+  
+  def test_textile_editor_initialize
+    create_extended_editor('article', 'body')
+    output = textile_editor_initialize()
+    assert_equal expected_initialize_output(:prototype, [
+      ['article_body', 'extended']
+    ]), output
+    
+    create_simple_editor('article', 'body_excerpt')
+    output = textile_editor_initialize()
+    assert_equal expected_initialize_output(:prototype, [
+      ['article_body', 'extended'],
+      ['article_body_excerpt', 'simple']
+    ]), output
+
+    output = textile_editor_initialize(:framework => :jquery)
+    assert_equal expected_initialize_output(:jquery, [
+      ['article_body', 'extended'],
+      ['article_body_excerpt', 'simple']
+    ]), output
+    
+    # test using custom default options
+    textile_editor_options :framework => :jquery
+    output = textile_editor_initialize()
+    assert_equal expected_initialize_output(:jquery, [
+      ['article_body', 'extended'],
+      ['article_body_excerpt', 'simple']
+    ]), output
+  end
+  
+  def test_textile_editor_inititalize_with_arbitrary_ids
+    output = textile_editor_initialize(:story_comment, :story_body)
+    assert_equal expected_initialize_output(:prototype, [
+      ['story_comment', 'extended'],
+      ['story_body', 'extended']
+    ]), output
+  end
+
+  def test_textile_editor_initialize_with_custom_buttons
+    b = '<button id="test_button" onclick="alert(\'Hello!\')" title="Hello world">Hello</button>'
+    button_data = ["TextileEditor.buttons.push(\"%s\");" % escape_javascript(b)]
+    actual = textile_editor_button('Hello',
+      :id => 'test_button',
+      :onclick => "alert('Hello!')", 
+      :title => 'Hello world'
+    )   
+    
+    assert_equal button_data, actual
+     
+    create_extended_editor('article', 'body')
+    output = textile_editor_initialize()
+    assert_equal expected_initialize_output(:prototype, [
+      ['article_body', 'extended']
+    ], button_data), output
+  end
+
+  def test_textile_extract_dom_ids_works_with_arrayed_hash
+    hash_with_array = { :recipe => [ :instructions, :introduction ] }
+    assert_equal [ 'recipe_instructions', 'recipe_introduction' ], textile_extract_dom_ids(hash_with_array)
+  end
+
+  def test_textile_extract_dom_ids_works_with_hash
+    hash_with_symbol = { :story  => :title }
+    assert_equal [ 'story_title' ], textile_extract_dom_ids(hash_with_symbol)
+  end
+
+  def test_textile_extract_dom_ids_works_with_ids
+    straight_id = 'article_page'
+    assert_equal [ 'article_page' ], textile_extract_dom_ids(straight_id)
+  end
+
+  def test_textile_extract_dom_ids_works_with_mixed_params
+    paramd  = %w(article_page)
+    paramd += [{ 
+      :recipe => [ :instructions, :introduction ], 
+      :story  => :title 
+    }]
+    assert_equal %w(article_page recipe_instructions recipe_introduction story_title).sort, 
+      textile_extract_dom_ids(*paramd).sort { |a,b| a.to_s <=> b.to_s }
+  end
+  
+  def test_textile_editor_button
+    b = '<button id="test_button" onclick="alert(\'Hello!\')" title="Hello world">Hello</button>'
+    expected = ['TextileEditor.buttons.push("%s");' % escape_javascript(b)]
+    
+    actual = textile_editor_button('Hello', 
+      :id => 'test_button',
+      :onclick => "alert('Hello!')", 
+      :title => 'Hello world'
+    )
+    
+    assert_equal expected, actual
+  end  
+end

data/textile_editor.gemspec

@@ -0,0 +1,41 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{textile_editor}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Mills"]
+  s.date = %q{2010-11-15}
+  s.email = %q{ben@unfiniti.com}
+  s.files = [
+    ".bundle/config",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "Rakefile",
+     "VERSION",
+     "lib/textile_editor.rb",
+     "textile_editor.gemspec",
+     "test/abstract_unit.rb",
+     "test/textile_editor_test.rb"
+  ]
+  s.homepage = %q{http://unfiniti.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provide textile toolbar to textareas}
+  s.test_files = [
+    "test/abstract_unit.rb",
+    "test/textile_editor_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+  end
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: textile_editor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Mills
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ben@unfiniti.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .bundle/config
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION
+- lib/textile_editor.rb
+- textile_editor.gemspec
+- test/abstract_unit.rb
+- test/textile_editor_test.rb
+has_rdoc: true
+homepage: http://unfiniti.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provide textile toolbar to textareas
+test_files: 
+- test/abstract_unit.rb
+- test/textile_editor_test.rb