textfilter 0.1.1

data/README.markdown

@@ -0,0 +1,29 @@
+Problem
+=======
+ - Evil hackers try to insert html/script into model fields
+ - Too long texts, and any other sort of stuff we need to take care of...
+
+Solution
+========
+Before asignment apply text filters to the value.
+To use something like strip_tags here you should define it on String see [ActionView helpers on String](http://pragmatig.wordpress.com/2009/05/30/all-actionview-helpers-on-strings)
+
+Usage
+=====
+ - As Rails plugin  `script/plugin install git://github.com/grosser/text_filter.git`
+ - As gem `sudo gem install text_filter `
+
+
+Example:
+    class Product < ActiveRecord::Base
+      text_filter :title, :description, :with => :strip_tags #=> on each assign: product.title = product.title.strip_tags
+      text_filter :summary, :with => [:strip_tags, {:truncate=>5}] #=> on each assign: product.summary = product.summary.strip_tags.truncate(5)
+    end
+
+Note: with a multi-key-hash in `:with` order of execution is random (before ruby 1.9), e.g. :truncate=>10, :something_else=>[1,2]
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile

@@ -0,0 +1,21 @@
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
+
+begin
+  project = 'textfilter'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project
+    gem.summary = "ActiveRecord/Rails filter text fields before assigning them"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project}"
+    gem.authors = ["Michael Grosser"]
+    gem.files += (FileList["{lib,spec}/**/*"] + FileList["VERSION"] + FileList["README.markdown"]).to_a.sort
+    gem.add_dependency ['activerecord']
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/init.rb

@@ -0,0 +1,2 @@
+#Needed to load when used as Rails plugin
+require 'text_filter'

data/lib/text_filter.rb

@@ -0,0 +1,22 @@
+module TextFilter
+  module ClassMethods
+    def text_filter(*args)
+      options = args.extract_options![:with]
+      args.each do |attribute|
+        define_method "#{attribute}=" do |value|
+          if value.is_a? String
+            [*options].each do |method|
+              if method.is_a? Hash
+                method.each {|name, args| value = value.send(name, *args)}
+              else
+                value = value.send(method)
+              end
+            end
+          end
+          write_attribute attribute, value
+        end
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:extend, TextFilter::ClassMethods)

data/spec/models.rb

@@ -0,0 +1,39 @@
+#simple method versions for test...
+class String
+  def strip_tags
+    gsub(/<.*?>/,'')
+  end
+
+  def simple_format
+    "<p>#{self}</p>"
+  end
+
+  def truncate(length)
+    self[0...length-3]+'...'
+  end
+
+  def replace_by_char(char)
+    char*length
+  end
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+  end
+
+  create_table :products do |t|
+    t.string :title, :description
+  end
+end
+
+#create model
+class User < ActiveRecord::Base
+  text_filter :name, :with => :strip_tags
+end
+
+class Product < ActiveRecord::Base
+  text_filter :title, :description, :with => :strip_tags
+  text_filter :title, :with => [{:truncate=>10}, :simple_format]
+  text_filter :summary, :with => [{:truncate=>10, :replace_by_char=>'x'}, :simple_format]
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'active_record'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+# ---- setup environment/plugin
+ActiveRecord::Base.establish_connection({
+  :adapter => "sqlite3",
+  :database => ":memory:",
+})
+
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+require File.expand_path("../init", File.dirname(__FILE__))
+
+require 'spec/models'

data/spec/text_filter_spec.rb

@@ -0,0 +1,55 @@
+require 'spec/spec_helper'
+
+describe String do
+  it "can strip tags" do
+    "<a>xx</a>".strip_tags.should == 'xx'
+  end
+end
+
+describe TextFilter do
+  before do
+    @user = User.new
+    @product = Product.new
+  end
+
+  it "is called on assign" do
+    @user.name = '<a>xx</a>'
+    @user.name.should == 'xx'
+  end
+
+  it "does nothing with blank" do
+    @user.name = ''
+    @user.name.should == ''
+  end
+
+  it "does nothing with nil" do
+    @user.name = nil
+    @user.name.should == nil
+  end
+
+  it "does nothing with numbers" do
+    @user.name = 123
+    @user.name.should == 123
+  end
+
+  it "works with multiple fields" do
+    @product.description = '<a>xx</a>'
+    @product.description.should == 'xx'
+  end
+
+  it "works with nested options" do
+    @product.title = '12345678901234567890'
+    @product.title.should == '<p>1234567...</p>'
+  end
+
+  it "works with multiple nested options" do
+    @product.summary = '12345678901234567890'
+    @product.summary.should == '<p>xxxxxxx...</p>'
+  end
+
+  #this behavior cannot be overwritten, but just to be on the safe side...
+  it "returns the assigned value" do
+    result = (@product.summary = 'abcd')
+    result.should == 'abcd'
+  end
+end

data/textfilter.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{textfilter}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-12-13}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "VERSION",
+     "init.rb",
+     "lib/text_filter.rb",
+     "lib/text_filter.rb",
+     "spec/models.rb",
+     "spec/models.rb",
+     "spec/spec_helper.rb",
+     "spec/spec_helper.rb",
+     "spec/text_filter_spec.rb",
+     "spec/text_filter_spec.rb",
+     "textfilter.gemspec"
+  ]
+  s.homepage = %q{http://github.com/grosser/textfilter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ActiveRecord/Rails filter text fields before assigning them}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/text_filter_spec.rb",
+     "spec/models.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: textfilter
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/text_filter.rb
+- spec/models.rb
+- spec/spec_helper.rb
+- spec/text_filter_spec.rb
+- textfilter.gemspec
+has_rdoc: true
+homepage: http://github.com/grosser/textfilter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ActiveRecord/Rails filter text fields before assigning them
+test_files: 
+- spec/spec_helper.rb
+- spec/text_filter_spec.rb
+- spec/models.rb