textile_editor_helper 0.0.12

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+doc
+testing
+project

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem "rake"
+# Specify your gem's dependencies in textile_editor_helper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,130 @@
+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. 
+
+Dependency
+----------
+
+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. 
+
+For Rails 3.2, vendor/plugins was removed that is why this gem exists.
+
+Travis CI Build Status
+-----------------------
+
+[![Build Status](https://secure.travis-ci.org/bridgeutopia/textile_editor_helper.png)](http://travis-ci.org/bridgeutopia/textile_editor_helper)
+
+
+To use Textile Editor Helper
+----------------------------
+
+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. 
+
+`gem 'textile_editor_helper'`
+
+`gem 'RedCloth'`
+
+`gem 'htmlentities'`
+
+and do
+
+`rails g textile_editor_helper:install`
+
+To use the Textile-Editor-Helper with a specific text area, you can choose between the following options:
+
+    <%= f.textile_editor :description %>
+
+    <%= textile_editor :user, "website" %>
+
+    <%= textile_editor_tag 'description', :description %>
+
+**Just like writing a text area tag!**
+
+At the end of your form put in the following code:
+
+    <%= textile_editor_initialize %> **Important!**
+
+
+Then, just save your view and check it out
+
+
+Simple vs. Extended
+===================
+
+TEH has a built-in mode to show only a sub-selection of available tags called simple. 
+
+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:
+
+    <%= textile_editor 'object', 'field', :simple -%>
+
+
+To Modify Textile Editor Helper
+-------------------------------
+
+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.
+
+TESTING (Cucumber is required)
+--------------------
+bundle exec rake
+
+TEH Preview
+--------------------
+Recently added a preview feature. To use: 
+
+		<%= f.textile_editor :body, :preview=>true %>
+		
+    <%= textile_editor_initialize :preview=>true %> 
+
+This is shown in detail on the wiki page. Check it out. 
+
+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 Textile
+--------------------
+
+To learn more about Textile check out: Textism, http://www.textism.com/tools/textile/index.php & Textile Reference, http://hobix.com/textile/
+
+
+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
+
+
+License
+-------
+Textile Editor Helper is released under the MIT license.
+
+
+Credits
+-------
+
+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 
+
+Inspired by
+-----------
+
+Patrick Woods, http://www.hakjoon.com/code/38/textile-quicktags-redirect & 
+Alex King, http://alexking.org/projects/js-quicktags

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+task(:default).clear
+task :default => [:cucumber]
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new

data/features/copy_assets.feature

@@ -0,0 +1,17 @@
+Feature: Copy Assets
+  In order to install the textile editor helper gem 
+	As a rails developer
+	I want to copy the assets to respective directories 
+
+
+Scenario: Assets are copied to rails asset directories
+	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"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,66 @@
+When /^I run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+When /^I add "([^\"]*)" to file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.open(path, 'a') { |f| f.write(content + "\n") }
+end
+
+Then /^the file "([^"]*)" should contain:$/ do |file, content|
+  check_file_content(file, content, true)
+end
+
+When /^I replace "([^\"]*)" with "([^\"]*)" in file "([^\"]*)"$/ do |old_content, new_content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  content = File.read(path).gsub(old_content, new_content)
+  File.open(path, 'w') { |f| f.write(content) }
+end
+
+When /^I insert "([^\"]*)" into "([^\"]*)" after line (\d+)$/ do |content, short_path, after_line|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  lines = File.read(path).split("\n")
+  lines[after_line.to_i, 0] = content
+  File.open(path, 'w') { |f| f.write(lines.join("\n")) }
+end
+
+Then /^I should see file "([^\"]*)"$/ do |path|
+  File.should exist(File.join(@current_directory, path))
+end
+
+Then /^I should see "(.*)" in file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should include(content)
+end
+
+Then /^I should not see "(.*)" in file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should_not include(content)
+end
+
+Then /^I should see the following files$/ do |table|
+  table.raw.flatten.each do |path|
+    File.should exist(File.join(@current_directory, path))
+  end
+end
+
+Then /^I should see the following in file "([^\"]*)"$/ do |short_path, table|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  table.raw.flatten.each do |content|
+    File.readlines(path).join.should include(content)
+  end
+end
+
+Then /^I should successfully run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+Then /^I should see "([^\"]*)" when running "([^\"]*)"$/ do |expected_response, command|
+  `cd #{@current_directory} && #{command}`.should include(expected_response)
+end

data/features/step_definitions/rails_setup_steps.rb

@@ -0,0 +1,9 @@
+Given /^a new Rails app$/ do
+  FileUtils.mkdir_p("tmp")
+  system("rm -rf tmp/rails_app")
+  system("rails new tmp/rails_app")
+  system("ln -s ../../../lib/generators tmp/rails_app/lib")
+  system("rm -rf tmp/rails_app/vendor")
+  system("ln -s ../../vendor tmp/rails_app")
+  @current_directory = File.expand_path("tmp/rails_app")
+end

data/lib/generators/textile_editor_helper/install_generator.rb

@@ -0,0 +1,54 @@
+module TextileEditorHelper
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../vendor', __FILE__)
+
+      private
+
+      def self.asset_pipeline_enabled?
+        (Rails.configuration.respond_to?(:assets) ? (Rails.configuration.assets || {}) : {})[:enabled]
+      end
+
+      def asset_pipeline_enabled?
+        self.class.asset_pipeline_enabled?
+      end
+
+      public
+
+      if asset_pipeline_enabled?
+        desc 'Creates a TextileEditorHelper initializer and copies assets to app/assets and public/images.'
+      else
+        desc 'Creates a TextileEditorHelper initializer and copies assets to public directories.'
+      end
+
+      def copy_javascript_asset
+        if asset_pipeline_enabled?
+          js_destination = 'app/assets/javascripts'
+          css_destination = 'app/assets/stylesheets'
+        else
+          js_destination = 'public/javascripts'
+          css_destination = 'public/stylesheets'
+        end
+
+        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
+end
+

data/lib/textile_editor_helper.rb

@@ -0,0 +1,204 @@
+require "textile_editor_helper/version"
+
+module TextileEditorHelper
+  # Your code goes here...
+end
+
+
+module ActionView
+  module 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 = {})        
+        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]
+
+				output = []
+				output << InstanceTag.new(object_name, method, self, options.delete(:object)).to_text_area_tag(options)
+				output << %q{<div id="%s_destination" class="textile-preview"></div>} % [editor_id]	if options[:preview]
+				output.join("\n").html_safe
+				
+      end
+      
+      def textile_editor_options(options={})
+        (@textile_editor_options ||= { :preview=>false }).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?
+           output << %{$(document).ready(function() \{}
+        end      
+
+        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']					
+
+					
+					output << %q{ $("#%s").keyup(function() {
+						 var textile_string = $("#%s").val(); 
+						 if($("#%s_destination")[0]) { 
+
+						   $.post("/textile_preview", { text_data: textile_string, id: "%s"} );
+							} 
+						 });
+						
+						} % [editor_id, editor_id, editor_id, editor_id] if options[:preview]
+		
+					
+        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