sinatra-helpers-escape 0.1.0

data/README.md

@@ -0,0 +1,11 @@
+Sinatra helpers for HTML escaping.
+
+Author: Philipp Kempgen, [http://kempgen.net](http://kempgen.net)
+
+
+## Usage
+
+Include the module in your Sinatra application:
+
+	helpers ::Sinatra::Helpers::Escape::HTML
+

data/lib/sinatra-helpers/escape/html.rb

@@ -0,0 +1,76 @@
+require 'sinatra/base'
+#require 'rack/utils'
+
+# see Sinatra
+module Sinatra
+	# see Sinatra
+	module Helpers
+		
+		# Escaping helpers.
+		module Escape
+			
+			# HTML escaping helpers.
+			#
+			# Usage:
+			#
+			# Include the module in your Sinatra application:
+			#
+			#   helpers ::Sinatra::Helpers::Escape::HTML
+			#
+			module HTML
+				
+				# Map special characters to HTML entities.
+				ESCAPE_HTML = {
+					'&'  .freeze => '&',
+					'<'  .freeze => '&lt;',
+					'>'  .freeze => '&gt;',
+				#	'\'' .freeze => '&#x27;',
+					'\'' .freeze => '&#39;',
+					'"'  .freeze => '&quot;',
+				}
+				
+				# Regexp search pattern for special characters.
+				ESCAPE_HTML_PATTERN = ::Regexp.union( *ESCAPE_HTML.keys )
+				
+				# Escapes the string so it's safe to use in HTML.
+				#
+				# @param   str      [String]   The string to escape.
+				# @return           [String]   Escaped version of the string.
+				#
+				def h( str )
+					#::Rack::Utils.escape_html( str )
+					str.to_s.gsub( ESCAPE_HTML_PATTERN ){ |c| ESCAPE_HTML[c] }
+				end
+				
+				extend self  # make instance methods available as class methods
+			end
+			
+			# XML escaping helpers.
+			#
+			# Usage:
+			#
+			# Include the module in your Sinatra application:
+			#
+			#   helpers ::Sinatra::Helpers::Escape::XML
+			#
+			module XML
+				
+				# Escapes the string so it's safe to use in XML.
+				#
+				# @param   str      [String]   The string to escape.
+				# @return           [String]   Escaped version of the string.
+				#
+				def x( str )
+					::Sinatra::Helpers::Escape::HTML.h( str )
+				end
+				
+				extend self  # make instance methods available as class methods
+			end
+			
+		end
+	end
+	
+	#helpers Helpers::Escape::HTML
+	#::Sinatra::Base.helpers Helpers::Escape::HTML
+end
+

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-helpers-escape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Philipp Kempgen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Helpers for HTML escaping in Sinatra.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sinatra-helpers/escape/html.rb
+- README.md
+homepage: https://github.com/philipp-kempgen/sinatra-helpers-escape
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Sinatra helpers for HTML escaping.
+test_files: []
+has_rdoc: