textile_editor_helper 0.0.14 → 0.0.30

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## Version 0.0.30
+
+### Textile Editor Helper now supports simple_form and formtastic
+
+* Removed options for simple and extended
+* Removed preview options. The wiki pages will be updated to show different ways to have a preview feature
+* Refactored the helpers and tests
+* Added support for simple_form. fixes <a href="https://github.com/bridgeutopia/textile_editor_helper/issues/2" target="_blank">#2</a>
+* Added support for formtastic. fixes  <a href="https://github.com/bridgeutopia/textile_editor_helper/issues/4" target="_blank">#4</a>
+* Fixed some generator bugs.
+* Refactored tests and helpers to make sure there is no duplicated coda
+* Load and require simple_form and formtastic helpers and dependencies only when the gems are found.

data/README.md

@@ -1,43 +1,43 @@
-Textile Editor Helper 
-==========================
+## Textile Editor Helper [![Build Status](https://secure.travis-ci.org/bridgeutopia/textile_editor_helper.png)](http://travis-ci.org/bridgeutopia/textile_editor_helper)
 
-Textile Editor Helper is a plugin for Ruby on Rails to add a Textile toolbar above textareas
-	
-This version of Textile Editor Helper is a fork of the code found at http://svn.webtest.wvu.edu/repos/rails/plugins/textile_editor_helper/ to allow for use with the form_for method. 
+Textile Editor Helper is a plugin for Ruby on Rails to add a Textile toolbar above textareas.
 
-Dependency
-----------
+This version of Textile Editor Helper is a fork of the code found at http://svn.webtest.wvu.edu/repos/rails/plugins/textile_editor_helper/ to allow for use with the form_for method.
 
-To use Textile Editor Helper you must be using either the jQuery JavaScript library. 
 
-jQuery is required and make sure $(document).ready() method is called. Prototype is no longer supported. 
+##Dependencies
 
-For Rails 3.2, vendor/plugins was removed that is why this gem exists.
+To use Textile Editor Helper you must be using either the jQuery JavaScript library.
 
-Travis CI Build Status
------------------------
+jQuery is required and make sure $(document).ready() method is called.
 
-[![Build Status](https://secure.travis-ci.org/bridgeutopia/textile_editor_helper.png)](http://travis-ci.org/bridgeutopia/textile_editor_helper)
+For Rails 3.2, vendor/plugins was removed that is why this gem exists. Rails versions below 3.2 are not supported. Ruby version 1.8.7 is not supported.
 
 
-To use Textile Editor Helper
-----------------------------
+## Rails Quickstart
 
 Directions to get the helper up and running for your install:
 
-First, you'll need to add the gems required. RedCloth and htmlentities are for the preview feature. 
+First, you'll need to add the gems required. RedCloth (or an alterntative) and htmlentities are also required.
 
-`gem 'textile_editor_helper'`
+	 gem 'textile_editor_helper'
 
-`gem 'RedCloth'`
+	 gem 'RedCloth'
 
-`gem 'htmlentities'`
+	 gem 'htmlentities'
 
 and do
 
-`rails g textile_editor_helper:install`
+	rails g textile_editor_helper:install
 
-To use the Textile-Editor-Helper with a specific text area, you can choose between the following options:
+It's important that you read the example provided. Your application.js should look like the following. Make sure to update the order of your JS files.
+
+    //= require jquery
+    //= require jquery_ujs
+    //= require textile-editor
+    //= require textile-editor-config
+
+To use the Textile Editor Helper with a specific text area, you can choose between the following options:
 
     <%= f.textile_editor :description %>
 
@@ -45,114 +45,73 @@ To use the Textile-Editor-Helper with a specific text area, you can choose betwe
 
     <%= textile_editor_tag 'description', :description %>
 
-**Just like writing a text area tag!**
+### For simple_form users
 
-At the end of your form put in the following code:
-
-    <%= textile_editor_initialize %> **Important!**
+    <%= f.input :body, :as => :textile_editor %>
 
+### For formtastic users
 
-Then, just save your view and check it out
+    <%= f.input :body, :as => :textile_editor %>
 
+**Just like writing a text area tag!**
 
-Simple vs. Extended
-===================
+At the end of your form put in the following code:
 
-TEH has a built-in mode to show only a sub-selection of available tags called simple. 
+    <%= textile_editor_initialize %> **Important!**
 
-Currently the _simple_ tags are: _bold_, _underline_, _italic_, _strikethrough_.
 
-To create a text area that will only use the 'simple' tags create your text area with the following code:
+Then, just save your view and check it out.
 
-    <%= textile_editor 'object', 'field', :simple=>true -%>
+## Examples
 
-or
-		
-	 <%= f.textile_editor :body, :simple=>true %>
+<a href="https://github.com/bridgeutopia/textile_editor_helper/wiki/Examples" target="_blank">Basic Examples</a>
 
+Recently created a Rails 3.2.8 app that uses simple_form and textile_editor_helper, <a href="https://github.com/bridgeutopia/textile-editor-helper-examples" target="_blank">check it out</a>.
 
-To Modify Textile Editor Helper
--------------------------------
+## Testing
 
-Most of the options that you might want to modify (e.g. access keystroke or whether a tag is available in simple) are found in textile_editor_config.js. Pretty straightforward.
+	git clone git://github.com/bridgeutopia/textile_editor_helper.git
+	cd textile_editor_helper
+	bundle install
+	bundle exec rake
 
-TESTING (Cucumber is required)
---------------------
-bundle exec rake
 
-TEH Preview
---------------------
-Recently added a preview feature. To use: 
+## Preview Feature
 
-		<%= f.textile_editor :body, :preview=>true %>
-		
-    <%= textile_editor_initialize :preview=>true %> 
+Textile Editor Preview feature is no longer supported. The wiki page will be updated to show two different ways of adding the preview feature to your app.
 
-Update the helper. If you wish to move this helper to ApplicationHelper to make it work for all views, you have to remove view_context.
+## Requests for improvement
 
-	  def to_html(m)
-	    require 'redcloth'
-	    require 'htmlentities'
+A lot of features have been removed and added here. This is completely refactored for simplicity and support of form builders other than the Rails default.
+To request for improvement, please do not send email to the maintainer. Create an issue instead. Thank you.
 
-	    coder = HTMLEntities.new
-	    m = coder.decode(m)
-	    m = RedCloth.new(m).to_html 
-	    view_context.raw m
-		end
-		
-Update code:
 
-		def to_html(m)
-		  require 'redcloth'
-		  require 'htmlentities'
+## More Info on Textile
 
-		  coder = HTMLEntities.new
-		  m = coder.decode(m)
-		  m = RedCloth.new(m).to_html 
-		  raw m
-		end
-		
-This is shown in detail on the wiki page. Check it out. 
+To learn more about Textile check out: <a href="http://www.textism.com/tools/textile/index.php" target="_blank">Textism</a> & <a href="http://hobix.com/textile/" target="_blank">Textile Reference</a>
 
-Styling TEH Preview
---------------------
-Add this to your CSS file and modify as needed: 
 
-		.textile-preview {
-			width:83%;
-		  padding:20px;
-		  margin:10px 0px;
-		  border:5px dotted #eee;
-		  display:block;
-		}
+## More Info on Slate
 
+slate is the CMS in development at West Virginia University that led to the development of Textile Editor Helper. Learn more at: http://slateinfo.blogs.wvu.edu
 
-More Info on Textile
---------------------
 
-To learn more about Textile check out: Textism, http://www.textism.com/tools/textile/index.php & Textile Reference, http://hobix.com/textile/
+## License
 
+Textile Editor Helper is released under the MIT license.
 
-More Info on Slate
-------------------
 
-slate is the CMS in development at West Virginia University that led to the development of Textile Editor Helper. Learn more at: http://slateinfo.blogs.wvu.edu
+## Acknowledgements
 
+Textile Editor Helper was created by Dave Olsen (Javascript) and Chris Scharf (Ruby/Rails) of <a href="http://webservices.wvu.edu/" target="_blank">West Virginia University Web Services</a>
 
-License
--------
-Textile Editor Helper is released under the MIT license.
+The project is now maintained by <a href="http://blog.bridgeutopiaweb.com" target="_blank">Katherine G. Pe</a>
 
 
-Credits
--------
+## Inspired by
 
-Textile Editor Helper was created by Dave Olsen (Javascript) and Chris Scharf (Ruby/Rails) of West Virginia University Web Services (http://webservices.wvu.edu/)
 
-The project is now, unofficially maintained by Nicolás Hock 
+<a href="http://www.hakjoon.com/code/38/textile-quicktags-redirect" target="_blank">Patrick Woods</a> &
+<a href="http://alexking.org/projects/js-quicktags" target="_blank">Alex King</a>
 
-Inspired by
------------
 
-Patrick Woods, http://www.hakjoon.com/code/38/textile-quicktags-redirect & 
-Alex King, http://alexking.org/projects/js-quicktags

data/Rakefile

@@ -1,8 +1,13 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'cucumber/rake/task'
+
 task(:default).clear
-task :default => [:cucumber]
+task :default => [:cucumber, :test]
 
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
 
-require 'cucumber/rake/task'
-Cucumber::Rake::Task.new
+Cucumber::Rake::Task.new

data/features/copy_assets.feature

@@ -1,17 +1,12 @@
 Feature: Copy Assets
-  In order to install the textile editor helper gem 
+  In order to install the textile editor helper gem
 	As a rails developer
-	I want to copy the assets to respective directories 
+	I want to copy the assets to respective directories
 
-
-Scenario: Assets are copied to rails asset directories
+Scenario: Assets are copied to rails asset directories if the default generator is used
 	Given a new Rails app
 	When I run "rails g textile_editor_helper:install"
 	Then I should see file "app/assets/stylesheets/textile-editor.css"
 	And I should see file "app/assets/javascripts/textile-editor-config.js"
-	And I should see file "app/assets/javascripts/textile-editor.js"
-	And I should see file "public/images/textile-editor/italic.png"
-	And I should see file "app/controllers/textile_preview_controller.rb"
-	And I should see file "app/helpers/textile_preview_helper.rb"
-	And I should see file "app/views/textile_preview/show.js.coffee"
-	And I should see "textile_preview" in file "config/routes.rb"
+  And I should see file "app/assets/javascripts/textile-editor.js"
+  And I should see file "public/images/textile-editor/italic.png"

data/lib/generators/textile_editor_helper/install_generator.rb

@@ -21,7 +21,7 @@ module TextileEditorHelper
         desc 'Creates a TextileEditorHelper initializer and copies assets to public directories.'
       end
 
-      def copy_javascript_asset
+      def copy_assets
         if asset_pipeline_enabled?
           js_destination = 'app/assets/javascripts'
           css_destination = 'app/assets/stylesheets'
@@ -33,20 +33,11 @@ module TextileEditorHelper
         copy_file 'assets/javascripts/textile-editor.js', "#{js_destination}/textile-editor.js"
         copy_file 'assets/javascripts/textile-editor-config.js', "#{js_destination}/textile-editor-config.js"
         copy_file 'assets/stylesheets/textile-editor.css', "#{css_destination}/textile-editor.css"
-        copy_file 'app/controllers/textile_preview_controller.rb', "app/controllers/textile_preview_controller.rb"
-        copy_file 'app/helpers/textile_preview_helper.rb', "app/helpers/textile_preview_helper.rb"
-        
-
-        lines = File.read("config/routes.rb").split("\n")
-        lines[3, 0] = "match 'textile_preview' => 'textile_preview#show'"
-        File.open("config/routes.rb", 'w') { |f| f.write(lines.join("\n")) }
-        
-        
-        directory 'app/views/textile_preview', 'app/views/textile_preview'
+
         directory 'assets/images/textile-editor', 'public/images/textile-editor'
-        
+
         readme 'README' if behavior == :invoke
-        
+
       end
     end
   end

data/lib/helpers/default.rb

@@ -0,0 +1,138 @@
+require_relative 'textile_editor_initialize'
+
+module ActionView::Helpers
+  class FormBuilder
+    def textile_editor(method, options = {})
+      @template.textile_editor(@object_name, method, options.merge(:object => @object))
+    end
+  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 = {})
+      output = []
+      output << InstanceTag.new(object_name, method, self, options.delete(:object)).to_text_area_tag(options.merge(:class=>"textile_editor"))
+      output.join("\n").html_safe
+    end
+
+    def textile_editor_options(options={})
+      (@textile_editor_options ||= { }).merge! options
+    end
+
+
+    def textile_editor_initialize
+      unless request.xhr?
+        TextileEditorInitialize.textile_editor_initialize
+      else
+        [].join("\n").html_safe
+      end
+    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+
+    # TO DO: Test for this feature
+    def textile_editor_button(text, options={})
+      return textile_editor_button_separator  if text == :separator
+      button = content_tag(:button, text, options)
+      button = "TextileEditor.buttons.push(""#{button}"");".html_safe
+      (@textile_editor_buttons ||= []) << button
+    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
+
+  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 = {})
+      text_area_tag(name, content, options.merge(:class=>"textile_editor"))
+    end
+  end
+end

data/lib/helpers/formtastic.rb

@@ -0,0 +1,39 @@
+require_relative 'textile_editor_initialize'
+
+module Formtastic
+  module Helpers
+    module FormHelper
+      def textile_editor_initialize
+        unless request.xhr?
+          TextileEditorInitialize.textile_editor_initialize
+        else
+          [].join("\n").html_safe
+        end
+      end
+    end
+  end
+
+  module Inputs
+
+    class TextileEditorInput
+      include Base
+      include Base::Placeholder
+
+      def input_html_options
+        {
+          :cols => builder.default_text_area_width,
+          :rows => builder.default_text_area_height,
+          :class => "textile_editor"
+        }.merge(super)
+      end
+
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.text_area(method, input_html_options)
+        end
+      end
+
+    end
+  end
+end

data/lib/helpers/simple_form.rb

@@ -0,0 +1,27 @@
+require_relative 'textile_editor_initialize'
+
+module SimpleForm
+  module ActionViewExtensions
+    module FormHelper
+
+      def textile_editor_initialize
+        unless request.xhr?
+          TextileEditorInitialize.textile_editor_initialize
+        else
+          [].join("\n").html_safe
+        end
+      end
+
+    end
+  end
+
+  module Inputs
+    class TextileEditorInput < Base
+
+      def input
+        @builder.text_area(attribute_name, input_html_options)
+      end
+
+    end
+  end
+end

data/lib/helpers/textile_editor_initialize.rb

@@ -0,0 +1,19 @@
+class TextileEditorInitialize
+
+  class << self
+    def textile_editor_initialize
+      output = []
+      output << '<script type="text/javascript">'
+      output << %{$(document).ready(function() \{}
+      output << '/* <![CDATA[ */'
+      output << %{$.each($('textarea.textile_editor'),function(i,el){
+                    TextileEditor.initialize($(el).attr('id'));
+                  });}
+      output << '/* ]]> */'
+      output << '});'
+      output << '</script>'
+      output.join("\n").html_safe
+    end
+  end
+
+end

data/lib/textile_editor_helper/version.rb

@@ -1,3 +1,3 @@
 module TextileEditorHelper
-  VERSION = "0.0.14"
+  VERSION = "0.0.30"
 end