trimify 0.1.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem "sqlite3", "~>1.3.0"
+  gem "rails", "~>2.3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.9)
+      actionpack (= 2.3.9)
+    actionpack (2.3.9)
+      activesupport (= 2.3.9)
+      rack (~> 1.1.0)
+    activerecord (2.3.9)
+      activesupport (= 2.3.9)
+    activeresource (2.3.9)
+      activesupport (= 2.3.9)
+    activesupport (2.3.9)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.1.2)
+    rails (2.3.9)
+      actionmailer (= 2.3.9)
+      actionpack (= 2.3.9)
+      activerecord (= 2.3.9)
+      activeresource (= 2.3.9)
+      activesupport (= 2.3.9)
+      rake (>= 0.8.3)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rails (~> 2.3.0)
+  rcov
+  rspec (~> 2.6.0)
+  sqlite3 (~> 1.3.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Behrang Saeedzadeh
+
+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,28 @@
+=Trimify
+
+Trimify is an ActiveRecord Plugin that allows you to easily trim leading and trailing white spaces from string attributes and optionally turn blank strings to nil.
+Only attributes you specify will be checked and converted. Using trimify on non-string attributes has no effect. 
+
+==Installation
+
+  gem install trimify
+
+==Example
+
+  class User < ActiveRecord::Base
+    trimify :first_name, :middle_name       
+    trimify :last_name, :nilify => false    # default value of :nilify is true
+  end
+  
+  user = User.create(:first_name => " Shompet ", :middle_name = "", :last_name => "")
+  user.first_name   # => "Shompet"
+  user.middle_name  # => nil
+  user.last_name    # => ""
+
+==Acknowledgments
+
+Trimify is inspired by the Nilify plugin written by Tobias Schmidt.
+
+== Copyright
+
+Copyright (c) 2011 Behrang Saeedzadeh, released under the MIT license.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "trimify"
+  gem.homepage = "http://github.com/behrangsa/trimify"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem for trimming strings in active record models.}
+  gem.description = %Q{A gem for trimming strings and optionally turning blank strings to nil}
+  gem.email = "behrangsa@gmail.com"
+  gem.authors = ["Behrang Saeedzadeh"]
+  gem.version = File.read('VERSION').chomp
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "trimify #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/trimify.rb

@@ -0,0 +1,50 @@
+module Behi
+  module Trimify
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def trimify(*args)
+        return if args.empty?
+        return unless table_exists?
+
+        options = { :nilify => true }
+        options.merge!(args.pop) if args.last.kind_of? Hash
+
+        unless self.included_modules.include?(Trimify::InstanceMethods)
+          include Trimify::InstanceMethods
+          write_inheritable_attribute :trimify_attributes, {}
+          class_inheritable_reader :trimify_attributes
+        end
+
+        attributes = args.map(&:to_sym)
+        col_options = {}
+        columns = content_columns.reject { |c| c.type != :string }.map { |c| c.name.to_sym }.select { |c| args.include?(c) }
+        columns.each { |col| col_options[col] = options }
+        write_inheritable_hash :trimify_attributes, col_options
+
+        class_eval "before_validation :trimify"
+      end
+    end
+
+    module InstanceMethods
+      def trimify
+        self.class.trimify_attributes.each do |attribute, options|
+          value = read_attribute(attribute) 
+          if value.is_a?(String)
+            value.strip!
+            value = nil if (value.blank? && options[:nilify] == true)
+            write_attribute(attribute, value)
+          end
+        end
+      end
+    end
+    
+  end
+end
+
+class ActiveRecord::Base
+  include Behi::Trimify
+end

data/spec/fixtures/category.rb

@@ -0,0 +1,4 @@
+class Category < ActiveRecord::Base
+  trimify :title
+  trimify :description
+end

data/spec/fixtures/no_table.rb

@@ -0,0 +1,3 @@
+class NoTable < ActiveRecord::Base
+  trimify :attrib
+end

data/spec/fixtures/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  trimify
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define do
+
+  create_table :users, :force => true do |t|
+    t.string   :first_name, :not_null, :type
+    t.string   :middle_name, :not_null, :type
+    t.string   :last_name, :not_null, :type
+    t.integer  :salary
+    t.datetime :birthday
+  end
+
+  create_table :posts, :force => true do |t|
+    t.string   :name
+  end
+
+  create_table :categories, :force => true do |t|
+    t.string   :title, :description
+  end
+
+end

data/spec/fixtures/specialized_user.rb

@@ -0,0 +1,2 @@
+class SpecializedUser < User
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  trimify :first_name, :middle_name
+  trimify :last_name, :nilify => false
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "rubygems"
+require "rspec"
+require "sqlite3"
+require "active_record"
+
+# load nilify
+require File.dirname(__FILE__) + '/../lib/trimify'
+
+# establish database connection, define schema and load model
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database  => ':memory:'
+ActiveRecord::Migration.verbose = false
+
+%w(schema category post user specialized_user).each do |file|
+  require File.dirname(__FILE__) + "/fixtures/#{file}"
+end

data/spec/trimify_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Behi::Trimify do
+
+  it "should add a class method to activerecord" do
+    User.methods.should include("trimify")
+  end
+
+  it "should allow multiple trimify calls" do
+    Category.trimify_attributes.should == { :title => { :nilify => true }, :description => { :nilify => true } }
+  end
+
+  it "should bequest trimify attributes" do
+    SpecializedUser.trimify_attributes.should == { 
+      :first_name => { :nilify => true }, 
+      :middle_name => { :nilify => true },
+      :last_name => { :nilify => false }
+    }
+  end
+
+  it "should not raise an exception for a non existing table" do
+    expect { require "fixtures/no_table" }.to_not raise_error(ActiveRecord::StatementInvalid)
+  end
+
+  describe "when trimifying possible attributes" do
+    before(:each) do
+      @user = User.new(:first_name => " Shompet ", :middle_name => " ", :last_name => "", :salary => 0, :birthday => Time.at(0))
+      @user.valid?
+    end
+
+    it "should trim leading and trailing white spaces" do
+      @user.first_name.should == "Shompet"
+    end
+    
+    it "should nilify strings that are trimmed down to a blank string" do
+      @user.middle_name.should be_nil
+    end
+    
+    it "should not nilify strings that are trimmed down to a blank string if :nilify is set to false" do
+      @user.last_name.should == ""
+    end
+
+    it "should not nilify not specified values" do
+      user = User.new(:not_null => "")
+      user.valid?
+      user.not_null.should == ""
+    end
+  end
+
+  describe "when calling nilify without attributes" do
+    it "should do nothing" do
+      post = Post.new(:name => "")
+      post.valid?
+      post.name.should == ""
+    end
+  end
+
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification 
+name: trimify
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Behrang Saeedzadeh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id006
+description: A gem for trimming strings and optionally turning blank strings to nil
+email: behrangsa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/trimify.rb
+- spec/fixtures/category.rb
+- spec/fixtures/no_table.rb
+- spec/fixtures/post.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/specialized_user.rb
+- spec/fixtures/user.rb
+- spec/spec_helper.rb
+- spec/trimify_spec.rb
+homepage: http://github.com/behrangsa/trimify
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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.8.5
+signing_key: 
+specification_version: 3
+summary: A gem for trimming strings in active record models.
+test_files: []
+