word-count-validator 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Darcy Laycock
+
+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,18 @@
+= word-count-validator
+
+A simple ActiveModel validator for requiring a model has a word count in a specific range.
+Uses a very basic method for generating the count (scans for \w+)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "word-count-validator"
+    gem.summary = %Q{Makes validating word counts in active_model easy}
+    gem.description = %Q{Provides validates_word_count which lets users validate a string has a minimum / maximum number of words.}
+    gem.email = "sutto@sutto.net"
+    gem.homepage = "http://github.com/Sutto/word-count-validator"
+    gem.authors = ["Darcy Laycock"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "word-count-validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/active_model/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  errors:
+    messages:
+      too_few_words: "has %{actual_count} words but requires at least %{expected_count} words"
+      too_many_words: "has %{actual_count} words but requires at most %{expected_count} words"

data/lib/active_model/validations/word_count.rb

@@ -0,0 +1,62 @@
+require 'active_model'
+require 'active_support/i18n'
+I18n.load_path << File.expand_path(File.dirname(__FILE__) + "/../locale/en.yml")
+
+module ActiveModel
+  module Validations
+    
+    class WordCountValidator < ActiveModel::EachValidator
+
+      def check_validity!
+        if options.has_key?(:in)
+          range = options.delete(:in)
+          unless range.present? && range.respond_to?(:min) && range.respond_to?(:max)
+            raise ArgumentError, "You must provide a valid range for the number of words e.g. 2..100"
+          end
+          options[:min], options[:max] = range.min, range.max
+        end
+        options[:min] = options.delete(:minimum) if options.has_key?(:minimum)
+        options[:max] = options.delete(:maximum) if options.has_key?(:maximum)
+        options[:max] ||= 100
+        options[:min] ||= 0
+        raise ArgumentError, "The min value must respond to to_i" unless options[:min].respond_to?(:to_i)
+        raise ArgumentError, "The max value must respond to to_i" unless options[:max].respond_to?(:to_i)
+        # Finally, normalize the min values.
+        options[:min] = options[:min].to_i
+        options[:max] = options[:max].to_i
+      end
+
+      def validate_each(record, attribute, value)
+        min_words, max_words  = options[:min], options[:max]
+        count = word_count_for(value)
+        if !options[:skip_min] && count < min_words
+          record.errors.add attribute, :too_few_words,  options_for(min_words, count)
+        elsif !options[:skip_max] && count > max_words
+          record.errors.add attribute, :too_many_words, options_for(max_words, count)
+        end 
+      end
+
+      def word_count_for(value)
+        value.to_s.scan(/\w+/).size
+      end
+      
+      def base_options
+        options.except(:in, :min, :max, :skip_max, :skip_min)
+      end
+      
+      def options_for(current, expected)
+        base_options.merge :expected_count => expected_count, :actual_count => current
+      end
+
+    end
+    
+    module HelperMethods
+      
+      # Lets you validate that given attributes have a word count within a specific range.
+      def validates_word_count(*attr_names)
+        validates_with WordCountValidator, _merge_attributes(attr_names)
+      end
+
+    end
+  end
+end

data/lib/word-count-validator.rb

@@ -0,0 +1 @@
+require 'active_model/validations/word_count'

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 'word-count-validator'
+
+class Test::Unit::TestCase
+end

data/test/test_word-count-validator.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestWordCountValidator < 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,79 @@
+--- !ruby/object:Gem::Specification 
+name: word-count-validator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-05 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Provides validates_word_count which lets users validate a string has a minimum / maximum number of words.
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_model/locale/en.yml
+- lib/active_model/validations/word_count.rb
+- lib/word-count-validator.rb
+- test/helper.rb
+- test/test_word-count-validator.rb
+has_rdoc: true
+homepage: http://github.com/Sutto/word-count-validator
+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: Makes validating word counts in active_model easy
+test_files: 
+- test/helper.rb
+- test/test_word-count-validator.rb