fckeditor 0.1.0

data/README

@@ -0,0 +1,45 @@
+FCKeditor
+
+========================================================
+
+This is a class which creates the correct HTML to use the FCKeditor.
+
+TODO:
+-create connectors
+-create better docs
+
+Howto use with rails:
+
+1. Install the gem
+
+2. require the gem in your controller like:
+
+--
+require 'rubygems'
+require_gem 'fckeditor'
+--
+
+3. Create a new editor instance like this:
+
+--
+@editor = FCKeditor.new('name_of_editor')
+--
+
+In your controller offcourse
+
+4. Change properties of the editor, you can change:
+
+-instance_name,
+-width,
+-height,
+-toolbar_set,
+-value,
+-base_path,
+-xml
+-config
+
+5. Dump the map of the FCKeditor in the public map
+
+6. Create the editor in your rhtml file with:
+
+@editor.create

data/lib/connector.rb

@@ -0,0 +1,5 @@
+require 'rexml'
+
+module Connector
+
+end

data/lib/fckeditor.rb

@@ -0,0 +1,112 @@
+require 'cgi'
+
+#Class which handles the creation of an instance of the FCKEditor in the browser
+class FCKEditor
+	#Properties
+	attr_accessor :instance_name,
+	              :width,
+								:height,
+								:toolbar_set,
+								:value,
+								:base_path,
+								:xml
+								
+	attr_writer   :config
+	
+	#Contructor, sets default values and instance_name which must be unique
+	def initialize (instance_name)
+		@instance_name, @base_path, @width, @height, @toolbar_set, @value, @config, @xml = instance_name, '/../FCKeditor', '100%', '200', 'Default', '', Array.new, true
+	end
+	
+	#Creates the HTML for the editor based on the user agent string
+	def create (user_agent)		
+		if is_compatible? user_agent
+			link = build_link(@base_path + '/editor/fckeditor.html',
+			                  {:InstanceName => @instance_name,
+			                   :Toolbar => @toolbar_set} )
+			
+			html = build_tag('input', {:type => 'hidden',
+			                            :id => @instance_name,
+																	:name => @instance_name,
+																	:value => CGI::escapeHTML(@value)}
+											 )
+											 
+			html += build_tag('input', 
+			                  {:type => 'hidden',
+			                   :id => @instance_name + '___Config',
+												 :value => self.config}
+											 )
+											 
+			html += build_tag('iframe',
+			                  {:id => @instance_name + '___Frame',
+                         :src => link,
+												 :width => @width,
+												 :height => @height,
+												 :frameborder => 'no',
+												 :scrolling => 'no'},
+												false
+											 )						 
+		else
+			html = build_tag('textarea',
+			                 {:name => @instance_name,
+											  :rows => 4,
+												:cols => 40,
+												:style => "width: #{@width}; height: #{@height}",
+												:wrap => 'virtual'},
+											 false,
+											 CGI::escapeHTML(@value)
+											)
+		end
+		
+		"<div>#{html}</div>"
+	end
+	
+	#Build a link with params, :base is the directory, the rest of the key/value pairs are html encoded and are used as parameters for the link
+	def build_link (path, params)
+		path + '?' + params.dup.to_a.delete_if { |value|
+			value[0].to_s.empty?
+		}.map { |value|
+			value[0].to_s + '=' + value[1].to_s
+		}.join('&')
+	end
+	
+	#Builds a HTML tag
+	#The tag_name is the name of the tag
+	#Params: key/value pairs form the tags parameters
+	#Self-closing: true => <tag_name content />
+	#              false => <tag_name content></tag_name
+	#text: text between opening and closing tag, works only if self_closing = false
+	def build_tag (tag_name, params = {}, self_closing = true, text = '')
+		content = params.dup.to_a.delete_if { |value|
+			value[0].to_s.empty?
+		}.map { |value|
+			CGI::escapeHTML(value[0].to_s) + '="' + CGI::escapeHTML(value[1].to_s) + '"'
+		}.join(' ')
+		
+		return self_closing ? "<#{tag_name} #{content}#{' /' if @xml}>" : "<#{tag_name} #{content}>#{text}</#{tag_name}>"
+	end
+	
+	#Config values encoded as url params
+	def config
+		@config.dup.to_a.map { |value|
+			value[0].to_s + '=' + value[1].to_s
+		}.join('&')
+	end
+	
+	#Checks if the browser is compatible based on the user agent string
+	def is_compatible? (user_agent)
+		if user_agent.include? 'MSIE' and (not user_agent.include? 'mac' or user_agent.include? 'Opera')
+			version = user_agent[(user_agent.rindex('MSIE') + 5), 3].to_f
+			return version > 5.5
+		elsif user_agent.include? 'Gecko/'
+			version = user_agent[(user_agent.rindex('Gecko/') + 6), 8].to_i
+			return version >= 20030210
+		else
+			return false
+		end
+	end
+	
+	private :build_link,
+	        :build_tag,
+	        :is_compatible?
+end

metadata

@@ -0,0 +1,40 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.3
+specification_version: 1
+name: fckeditor
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-07-18
+summary: A class for generating the HTML needed for the FCKEditor
+require_paths: 
+  - lib
+email: tim@stokman.net
+homepage: timstokman.net
+rubyforge_project: fckeditor
+description: 
+autorequire: fckeditor
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Tim Stokman
+files: 
+  - lib/fckeditor.rb
+  - lib/connector.rb
+  - README
+test_files: []
+rdoc_options: []
+extra_rdoc_files: 
+  - README
+executables: []
+extensions: []
+requirements: []
+dependencies: []