ms_tools 0.4.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 wmerrell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,9 @@
+= MsTools
+
+== Overview
+
+This is a collection of tools that I use in my projects. The tools included
+are helpers for use in the head section of a page, an assortment of helpers for
+use in pages and some enhanced tools to help with
+sanitizing input for pages.
+

data/lib/ms_tools/application_helpers.rb

@@ -0,0 +1,108 @@
+module MsTools
+  module ApplicationHelpers
+
+    # Outputs the corresponding flash message if any are set
+    #
+    # This function is used to output the flash messages in a nice formated
+    # way. It is typically used in the application layout.
+    #
+    def flash_messages
+      messages = []
+      %w(notice warning).each do |msg|
+        messages << content_tag(:div, flash[msg.to_sym], :id => "flash-#{msg}") unless flash[msg.to_sym].blank?
+      end
+      if flash[:error].is_a?( Hash)
+        flash_to_display << activerecord_error_list(flash[:error])
+      else
+        flash_to_display = flash[:error]
+      end
+      messages << content_tag(:div, flash_to_display, :id => "flash-error") unless flash_to_display.blank?
+      raw(messages)
+    end
+
+    # Normalizes image file names
+    #
+    # This function tries to find the file based on the name supplied. In
+    # normal use you will only need to supply the image file name without
+    # any extention. It will check for the supplied name as is, and with
+    # .png, .gif, or .jpg extentions added to the supplied name, in the
+    # public, public/images, and public/images/icons directories. If the
+    # file is found, it's normalized path name is returned. Note: It will
+    # also match any file that is explictly specified.
+    #
+    def clean_imagefile_name(name='')
+      root = Rails.public_path
+      filename = ""
+      # Shortcut to handle the most common cases.
+      if FileTest.exist?( File.join( root, "/images/#{name}.png" ) )
+        filename = "/images/#{name}.png"
+      elsif FileTest.exist?( File.join( root, "/images/icons/#{name}.png" ) )
+        filename = "/images/icons/#{name}.png"
+      else
+        # If not, check all
+        ["", ".png", ".gif", ".jpg"].each do |ext|
+          # Check if full path has been specified
+          if FileTest.exist?( File.join( root, name + ext ) )
+            filename = name + ext
+          elsif FileTest.exist?( File.join( root, "/images/", name + ext ) )
+            filename = File.join( "/images/", name + ext )
+          elsif FileTest.exist?( File.join( root, "/images/icons/", name + ext ) )
+            filename = File.join( "/images/icons/", name + ext )
+          end
+        end
+      end
+      if filename.blank?
+        filename = "/images/broken.png"
+      end
+      filename
+    end
+
+    # Formats a "command_button" class link
+    #
+    # This function creates a link with an embedded image along with text. The
+    # link has a class of "command_button" added to it. It is expected that the
+    # "command_button" class will be formatted to resemble a button.
+    #
+    def command_button(text='', image='', url='', permission=nil, options = {})
+      options.stringify_keys!
+      text     = text.blank? ? ""  : text
+      img_tag  = image_tag(clean_imagefile_name(image), :class=>"edit_icon", :alt=>" &raquo; ", :title=>text)
+      url      = url.blank? ? "#" : url
+      options['class'] = options.has_key?('class') ? options['class'] + " command_button" : "command_button"
+
+      if permission.nil? || permission
+        link_to( img_tag + text, url, options )
+      end
+    end
+
+    # Formats a "menu_icon" class link
+    #
+    # This function creates a link with an embedded image along with text. The
+    # image has a class of "menu_icon" added to it. It is expected that the
+    # "menu_icon" class will be formatted to resemble a button.
+    #
+    def image_button(text='', image='', url='', permission=nil, options = {})
+      options.stringify_keys!
+      text    = text.blank?  ? ""  : text
+      img_tag = image_tag(clean_imagefile_name(image), :class => 'menu_icon', :alt=>" &raquo; ", :title=>text)
+      url     = url.blank?   ? "#" : url
+
+      if permission.nil? || permission
+        link_to( img_tag + text, url, options )
+      end
+    end
+
+  private
+
+    def activerecord_error_list(errors)
+      error_list = '<ul class="error_list">'
+      error_list << errors.collect do |e, m|
+        "<li>#{e.humanize unless e == "base"} #{m}</li>"
+      end.to_s << '</ul>'
+      error_list
+    end
+
+  end
+end
+
+ActionView::Base.send :include, MsTools::ApplicationHelpers

data/lib/ms_tools/engine.rb

@@ -0,0 +1,7 @@
+require "ms_tools"
+require "rails"
+
+module MsTools
+  class Engine < Rails::Engine
+  end
+end

data/lib/ms_tools/head_helpers.rb

@@ -0,0 +1,125 @@
+module MsTools
+  module HeadHelpers
+
+    # Adds inline javascript data to the head section of a page.
+    #
+    # The intent of this function is to simplify your view code when you need
+    # javascript specifically for a particular page.
+    #
+    # Assumes that there is yield call in the <head> section of your layout
+    # like this:
+    #   <script type="text/javascript">
+    #     <%= yield :javascript_data %>
+    #   </script>
+    #
+    #
+    # === Usage:
+    #   <%- javascript do -%>
+    #     alert("Hello world!");
+    #   <%- end -%>
+    #
+    # This function expects a block which will be the javascript you
+    # wish to add to the page.
+    #
+    def javascript(*args, &block)
+      if block_given?
+        content = capture(&block)
+        content_for(:javascript_data) { content }
+      end
+    end
+
+    # Adds javascript files to the head section of a page.
+    #
+    # The intent of this function is to simplify your view code when you need
+    # special javascript files for a particular page.
+    # This function may be called as many times as desired, the javascript files
+    # are added in the order they are called.
+    #
+    # Assumes that there is yield call in the <head> section of your layout
+    # like this:
+    #   <%= yield :javascript_list %>
+    #
+    # All of the accumulated javascript files are added, in the order they were
+    # called when the page is generated.
+    #
+    # === Usage:
+    #   <%- javascripts 'javascriptname' -%>
+    # or
+    #   <%- javascripts ['javascriptname1', 'javascriptname2', ...] -%>
+    #
+    # The function takes either a string or and array of strings, and you
+    # may use an string that is valid for the +javascript_include_tag+ function.
+    # Be sure to include any paths for the file you wish to add.
+    #
+    def javascripts(*args)
+      items = args.class == Array ? args : args.to_a
+      items.each {|item|
+        content_for(:javascript_list) { javascript_include_tag item }
+      }
+    end
+
+    # Adds inline style information to the head section of a page.
+    #
+    # The intent of this function is to simplify your view code when you need
+    # special css style rules for a particular page.
+    #
+    # Assumes that there is yield call in the <head> section of your layout
+    # like this:
+    #   <style type="text/css">
+    #     <%= yield :stylesheet_data %>
+    #   </style>
+    #
+    #
+    # === Usage:
+    #   <%- stylesheet do -%>
+    #     body {
+    #       line-height: 1;
+    #       color: black;
+    #       background: white;
+    #     }
+    #   <%- end -%>
+    #
+    # This function expects a block which will be the css style rules you
+    # wish to add to the page. It can be any valid css text.
+    #
+    def stylesheet(*args, &block)
+      if block_given?
+        content = capture(&block)
+        content_for(:stylesheet_data) { content }
+      end
+    end
+
+    # Adds style sheet files to the head section of a page.
+    #
+    # The intent of this function is to simplify your view code when you need
+    # special style sheets for a particular page.
+    # This function may be called as many times as desired, the style sheets
+    # are added in the order they are called.
+    #
+    # Assumes that there is yield call in the <head> section of your layout
+    # like this:
+    #   <%= yield :stylesheet_list %>
+    #
+    # All of the accumulated style sheets are added, in the order they were
+    # called when the page is generated.
+    #
+    # === Usage:
+    #   <%- stylesheets 'stylesheetname' -%>
+    # or
+    #   <%- stylesheets ['stylesheetname1', 'stylesheetname2', ...] -%>
+    #
+    # The function takes either a string or and array of strings, and you
+    # may use an string that is valid for the +stylesheet_link_tag+ function.
+    # Be sure to include any paths for the file you wish to add.
+    #
+    def stylesheets(*args)
+      items = args.class == Array ? args : args.to_a
+      items.each {|item|
+        content_for(:stylesheet_list) { stylesheet_link_tag item }
+      }
+    end
+
+  end
+end
+
+ActionView::Base.send :include, MsTools::HeadHelpers

data/lib/ms_tools/sanitize.rb

@@ -0,0 +1,155 @@
+module MsTools
+  module MsSanitize
+
+    module Config
+      DEFAULT    = Sanitize::Config::DEFAULT.update({:remove_contents => ['script', 'embed', 'iframe']})
+      BASIC      = Sanitize::Config::BASIC.update({:remove_contents => ['script', 'embed', 'iframe']})
+      RESTRICTED = Sanitize::Config::RESTRICTED.update({:remove_contents => ['script', 'embed', 'iframe']})
+      RELAXED    = Sanitize::Config::RELAXED.update({:remove_contents => ['script', 'embed', 'iframe']})
+      EXTENDED   = {
+        :elements => [
+          'a', 'b', 'blockquote', 'br', 'caption', 'cite', 'code', 'col',
+          'colgroup', 'dd', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
+          'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'small', 'strike',
+          'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead',
+          'tr', 'u', 'ul'],
+
+        :attributes => {
+          'a'          => ['class', 'href', 'title'],
+          'blockquote' => ['class', 'cite'],
+          'br'         => ['class'],
+          'code'       => ['class'],
+          'col'        => ['class', 'span', 'width'],
+          'colgroup'   => ['class', 'span', 'width'],
+          'hr'         => ['class'],
+          'img'        => ['class', 'align', 'alt', 'height', 'src', 'title', 'width', 'title'],
+          'li'         => ['class', 'title'],
+          'ol'         => ['class', 'start', 'type'],
+          'p'          => ['class', 'title'],
+          'q'          => ['class', 'cite'],
+          'table'      => ['border', 'class', 'cellspacing', 'cellpadding', 'summary', 'width'],
+          'td'         => ['abbr', 'axis', 'class', 'colspan', 'rowspan', 'width', 'title'],
+          'th'         => ['abbr', 'axis', 'class', 'colspan', 'rowspan', 'scope', 'width', 'title'],
+          'ul'         => ['class', 'type']
+        },
+
+        :protocols => {
+          'a'          => {'href' => ['ftp', 'http', 'https', 'mailto', :relative]},
+          'blockquote' => {'cite' => ['http', 'https', :relative]},
+          'img'        => {'src'  => ['http', 'https', :relative]},
+          'q'          => {'cite' => ['http', 'https', :relative]}
+        },
+
+        :remove_contents => ['script', 'embed', 'iframe']
+      }
+    end
+
+    # Returns a sanitized copy of _html_, using the settings in _config_ if
+    # specified.
+    def msclean(html, options = {})
+      config = options.delete(:config) || {}
+      radius = options.delete(:radius) || false
+      if( radius ) then
+        Sanitize.clean(html.gsub(/<r:([a-z0-9 _'"=-]+) \/>/i, '(r:\1 /)'), config).gsub('&#13;',"").gsub(/\(r:([a-z0-9 _'"=-]+) \/\)/i, '<r:\1 />')
+      else
+        Sanitize.clean(html, config).gsub('&#13;',"")
+      end
+    end
+
+    # Performs Sanitize#clean in place, returning _html_, or +nil+ if no changes
+    # were made.
+    def msclean!(html, options = {})
+      config = options.delete(:config) || {}
+      radius = options.delete(:radius) || false
+      if( radius ) then
+        Sanitize.clean!(html.gsub(/<r:([a-z0-9 _'"=-]+) \/>/i, '(r:\1 /)'), config).gsub('&#13;',"").gsub(/\(r:([a-z0-9 _'"=-]+) \/\)/i, '<r:\1 />')
+      else
+        Sanitize.clean!(html, config).gsub('&#13;',"")
+      end
+    end
+
+    # A sanitizer before filter that walks all parameters before any
+    # processing takes place.
+    #
+    # == Description
+    #
+    # This is based on the sanitize_params plugin written by Jay Laney, updated
+    # by Danny Sofer to work with the Sanitizer module that is now part of
+    # the Rails core.
+    #
+    # The original version of sanitize_params used Rick Olsen's white_list plugin,
+    # but as Rick pointed out some time ago, "I recently just refactored a lot of
+    # that code into the html tokenizer library. You can now access the classes
+    # directly as HTML::Sanitizer, HTML::LinkSanitizer, and HTML::WhiteListSanitizer."
+    #
+    # Danny Sofer's version of sanitize_params does exactly that. Otherwise,
+    # it is unchanged from Jay's original code designed for scrubbing your
+    # user input clean.
+    #
+    # I modified this to work with Ryan Grove's Sanitize gem which is required
+    # by this function.
+    #
+    # == Usage
+    # 
+    # in application.rb:
+    #
+    # before_filter :sanitize_params
+    #
+    # Alternatively, add the filter to your controllers selectively.
+    #
+    # == Contact
+    #
+    # The original sanitize_params plugin was written by Jay Laney and is still
+    # available at http://code.google.com/p/sanitizeparams/
+    #
+    # This version was dereived from the forked version tweaked by Danny Sofer,
+    # which can be found at http://github.com/sofer/sanitize_params.
+    #
+    def sanitize_params(params = params)
+      params = walk_hash(params) if params
+    end
+
+    # Returns a sanitized copy of _html_, using the settings in _config_ if
+    # specified.
+    def sanitize(html, options = {})
+      msclean(html, options)
+    end
+
+    # Performs Sanitize#clean in place, returning _html_, or +nil+ if no changes
+    # were made.
+    def sanitize!(html, options = {})
+      msclean!(html, options)
+    end
+
+  private
+
+    def walk_hash(hash)
+      hash.keys.each do |key|
+        if hash[key].is_a? String
+          hash[key] = sanitize(hash[key])
+        elsif hash[key].is_a? Hash
+          hash[key] = walk_hash(hash[key])
+        elsif hash[key].is_a? Array
+          hash[key] = walk_array(hash[key])
+        end
+      end
+      hash
+    end
+
+    def walk_array(array)
+      array.each_with_index do |el,i|
+        if el.is_a? String
+          array[i] = sanitize(el)
+        elsif el.is_a? Hash
+          array[i] = walk_hash(el)
+        elsif el.is_a? Array
+          array[i] = walk_array(el)
+        end
+      end
+      array
+    end
+
+  end
+end
+
+ActionController::Base.send :include, MsTools::MsSanitize

data/lib/ms_tools.rb

@@ -0,0 +1,9 @@
+require 'action_view'
+require 'sanitize'
+require 'nokogiri'
+require 'ms_tools/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+require 'ms_tools/application_helpers'
+require 'ms_tools/head_helpers'
+require 'ms_tools/sanitize'
+module MsTools
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ms_tools'
+
+class Test::Unit::TestCase
+end

data/test/test_ms_tools.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMsTools < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: ms_tools
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Will Merrell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sanitize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A collection of functions and tools I use in my projects. Longer description.
+email: will@morelandsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/ms_tools.rb
+- lib/ms_tools/application_helpers.rb
+- lib/ms_tools/engine.rb
+- lib/ms_tools/head_helpers.rb
+- lib/ms_tools/sanitize.rb
+- LICENSE
+- README.rdoc
+- test/test_ms_tools.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/wmerrell/ms_tools
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A collection of functions and tools I use in my projects.
+test_files: 
+- test/test_ms_tools.rb
+- test/helper.rb