green_eggs_and_spam 0.1.1 → 0.2.0

data/.gitignore

@@ -1,8 +1,10 @@
 *.gem
 .bundle
 .DS_Store
+.rvmrc
 Gemfile.lock
 pkg/*
+rdoc/*
 test/dummy/db/*.sqlite3
 test/dummy/log/
-test/dummy/tmp/
+test/dummy/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx
+  - rbx-2.0
+  - ree

data/Gemfile

@@ -1,4 +1,2 @@
 source "http://rubygems.org"
-
-# Specify your gem's dependencies in green_eggs_and_spam.gemspec
 gemspec

data/README.md

@@ -1,12 +1,9 @@
-Green Eggs and Spam
-===================
+# Green Eggs and Spam [![Build Status](https://secure.travis-ci.org/citrus/green_eggs_and_spam.png)](http://travis-ci.org/citrus/green_eggs_and_spam)
 
-A simple way to filter spam in your rails forms. Green eggs and spam presents users with a simple question: **What color is this image?**
-
-You'll supply the images and a key of which one's which. The gem will handle the rest.
 
+A simple way to filter spam in your rails forms. GreenEggsAndSpam presents users with an easy question: **What color is this image?**
 
-** ----- under development ----- **
+You'll supply the images and a key of which one's which. The gem will handle the rest.
 
 
 Usage
@@ -18,7 +15,7 @@ Install the gem just like you would any other:
     
     # or with bundler
     
-    gem 'green_eggs_and_spam', '>= 0.1.1'
+    gem 'green_eggs_and_spam', '>= 0.2.0'
         
 
 Create a handful of color coded images and name them something other than their color or design. `1.png`, `banana.png` or `firetruck.png` for example. Tell GreenEggsandSpam which ones which with an initializer:
@@ -26,33 +23,41 @@ Create a handful of color coded images and name them something other than their
     # config/initializers/green_eggs_and_spam.rb
     
     GreenEggsAndSpam.options[:key_index] = { "1" => "blue", "banana" => "yellow", "firetruck" => "red" }
+    
+    
+Or just use the defaults, making your images `1.png`, `2.png`, `3.png`:
 
+    { "1" => "red", "2" => "green", "3" => "blue" }
+    
 
-
-Include the helper form:
+Include the helper in your form:
 
     = form_for @comment, :url => comment_path do |f|
       %p
-		    = f.label :comment
-		    = f.text_field :comment
-		    
-	    // Here's what your interested in:
-	    %p
-	     = anti_spam_form, "What color is this piece of bacon?" # the first optional argument is your custom question, the second are the form options
+        = f.label :comment
+        = f.text_field :comment
+        
+      // Here's what your interested in:
+      %p
+        = anti_spam_form, "What color is this piece of bacon?"
+       
+        // the first optional argument is your custom question, the second is the form options hash
         
-		  = f.submit 'send'
+      = f.submit 'send'
 
 
 
-Chances are your form is interacting with a model. If that's the case, start by adding the validator to your model like so:
+Chances are your form is interacting with a model. If that's the case, hook up the validator to your model like so:
 
     class Egg < ActiveRecord::Base
+      
       validates_anti_spam
+      
     end
     
 
 
-Next, setup your controller with the 'magic' `has_anti_spam` method. This will prepare the controller and give you access to the helper methods.
+Next, setup your controller with the `has_anti_spam` method. This will prepare the controller and give you access to the helper methods.
 
     class EggsController < ApplicationController
       
@@ -60,24 +65,26 @@ Next, setup your controller with the 'magic' `has_anti_spam` method. This will p
       
       ...
       
-      # merge the antispam params into your model's params before validation
       def create
+
+        # merge the antispam params into your model's params before validation
         @egg = Egg.new(params[:egg].merge(:antispam => params[:antispam]))
         
         # validate as usual
         if @egg.valid? && @egg.save
           # do something
         end
+        
       end
       
     end
 
 
 
-### That's it!
+### That's it! 
 
 
-But what if my form isn't validating a model? No big deal, just use the `anti_spam_valid?` helper method.
+But what if my form isn't validating a model? No big deal, just use the `anti_spam_valid?` helper method in your controller.
     
     class CommentsController < ApplicationController
       
@@ -87,10 +94,12 @@ But what if my form isn't validating a model? No big deal, just use the `anti_sp
       
       # merge the antispam params into your model's params before validation
       def create
+        
         # validate with the anti spam helper method
         if anti_spam_valid?
           # do something
         end
+        
       end
       
     end
@@ -102,7 +111,7 @@ But what if my form isn't validating a model? No big deal, just use the `anti_sp
 Customization
 -------------
 
-So you're using `.gif`'s or you don't want the images stored in `/images/antispam`. Here's some available options for the form helper.
+So you're using `.gif`'s or you're images aren't stored in `/images/antispam`. Here's some available options for the form helper.
 
     # the defaults
     {
@@ -124,7 +133,7 @@ So you're using `.gif`'s or you don't want the images stored in `/images/antispa
 Demo
 ----
 
-If you'd like to see GreenEggsAndSpam in action, there is a demo app located in `test/dummy`.
+If you'd like to see GreenEggsAndSpam in action, there is a demo app running on heroku at [http://green-eggs-and-spam-demo.heroku.com](http://green-eggs-and-spam-demo.heroku.com). There's a similar demo/test-app located in `test/dummy` if you'd like to run it locally.
 
     git://github.com/citrus/green_eggs_and_spam.git
     cd green_eggs_and_spam
@@ -134,16 +143,27 @@ If you'd like to see GreenEggsAndSpam in action, there is a demo app located in
     rails s
 
 
+
 Testing
 -------
 
-Shoulda tests can be run using `rake test` or just `rake`.
+Tests can be run with `rake test` or just `rake`.
 
     git://github.com/citrus/green_eggs_and_spam.git
     cd green_eggs_and_spam
+    bundle
     rake
     
     
+    
+To Do
+-----
+
+* Write more tests
+* Write more documentation
+* Include default images
+
+    
 License
 -------
 

data/Rakefile

@@ -1,30 +1,10 @@
-# encoding: UTF-8
-require 'rubygems'
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rake'
-require 'rake/rdoctask'
-require 'rake/testtask'
-
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
-  #t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
 task :default => :test
-
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SpreeMail'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/green_eggs_and_spam.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Spencer Steffen"]
   s.email       = ["spencer@citrusme.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/citrus/green_eggs_and_spam"
   s.summary     = %q{A simple way to filter spam in your rails forms.}
   s.description = %q{Green eggs and spam presents the user with a simple question: What color is this image? You'll supply the images and a key of which one's which, and the gem will help with the rest.}
 
@@ -21,7 +21,8 @@ Gem::Specification.new do |s|
   
   s.add_dependency("rails", ">= 3.0.0")
   
-  s.add_development_dependency("capybara", ">= 0.4.0")
-  s.add_development_dependency("shoulda", ">= 2.11.3")
-  s.add_development_dependency("sqlite3", ">= 1.3.3")
-end
+  s.add_development_dependency("minitest",        ">= 2.1.0")
+  s.add_development_dependency("minitest_should", ">= 0.1.0")
+  s.add_development_dependency("sqlite3",         ">= 1.3.3")
+  
+end

data/lib/green_eggs_and_spam.rb

@@ -23,13 +23,18 @@ module GreenEggsAndSpam
   end
   
   # Validates a key and answer combo
-  def validates?(params)    
-    key = params[:key].to_s
-    val = params[:answer].to_s
+  def validates?(params) 
+    key, val = normalized_params(params)
     return false if key.empty? || val.empty?
-    answer = key_index[key.to_s]
-    regex = Regexp.new(answer, 'i')
-    return val.match(regex) != nil
+    answer = key_index[key] rescue ""
+    return val =~ Regexp.new("^#{answer}$", 'i')
   end
   
+  private
+    
+    def normalized_params(params)
+      params ||= {}
+      [ params[:key].to_s, params[:answer].to_s ]
+    end
+  
 end

data/lib/green_eggs_and_spam/action_controller.rb

@@ -36,4 +36,4 @@ module GreenEggsAndSpam
   
 end
 
-ActionController::Base.send(:include, GreenEggsAndSpam::ActionController) if defined?(ActionController)
+ActionController::Base.send(:include, GreenEggsAndSpam::ActionController) if defined?(ActionController)

data/lib/green_eggs_and_spam/active_record.rb

@@ -25,4 +25,4 @@ module GreenEggsAndSpam
   
 end
 
-ActiveRecord::Base.send(:include, GreenEggsAndSpam::ActiveRecord) if defined?(ActiveRecord)
+ActiveRecord::Base.send(:include, GreenEggsAndSpam::ActiveRecord) if defined?(ActiveRecord)

data/lib/green_eggs_and_spam/anti_spam_validator.rb

@@ -3,9 +3,9 @@ module GreenEggsAndSpam
   class AntiSpamValidator < ActiveModel::Validator
   
     def validate(record)
-      record.errors[:base] << GreenEggsAndSpam.options[:error_message] unless GreenEggsAndSpam.validates?(record.antispam)
+      record.errors.add :base, GreenEggsAndSpam.options[:error_message] unless GreenEggsAndSpam.validates?(record.antispam)
     end
   
   end
   
-end
+end

data/lib/green_eggs_and_spam/form_helper.rb

@@ -18,4 +18,4 @@ module GreenEggsAndSpam
   
   end
   
-end
+end

data/lib/green_eggs_and_spam/options.rb

@@ -42,4 +42,4 @@ module GreenEggsAndSpam
     
   end
   
-end
+end

data/lib/green_eggs_and_spam/version.rb

@@ -1,3 +1,3 @@
 module GreenEggsAndSpam
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/dummy/config/initializers/green_eggs_and_spam.rb

@@ -0,0 +1,2 @@
+# GreenEggsAndSpam.options[:key_index] = { "firetruck" => "red", "lime" => "green", "ocean" => "blue" }
+# GreenEggsAndSpam.options[:form_options] = { :path => "/images/named" }

data/test/helper.rb

@@ -1,23 +1,14 @@
 # Configure Rails Envinronment
 ENV["RAILS_ENV"] = "test"
 
+gem "minitest"
+
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
-require "shoulda"
-
-ActionMailer::Base.delivery_method = :test
-ActionMailer::Base.perform_deliveries = true
-ActionMailer::Base.default_url_options[:host] = "test.com"
+require "minitest/autorun"
+require "minitest/should"
 
 Rails.backtrace_cleaner.remove_silencers!
 
-# Configure capybara for integration testing
-require "capybara/rails"
-Capybara.default_driver   = :rack_test
-Capybara.default_selector = :css
-
 # Run any available migration
 ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/test/test_green_eggs_and_ham.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestGreenEggsAndSpam < Test::Unit::TestCase
+class TestGreenEggsAndSpam < MiniTest::Unit::TestCase
   
   should "get key index" do
     assert GreenEggsAndSpam.key_index.is_a?(Hash)
@@ -14,20 +14,20 @@ class TestGreenEggsAndSpam < Test::Unit::TestCase
   end
   
   should "validate key index" do
-    assert_raises RuntimeError do |e|
+    assert_raises RuntimeError do |*e|
       GreenEggsAndSpam.options[:key_index] = {}
-      asset_equal "InvalidKeyIndex", e.message
+      asset_equal "InvalidKeyIndex", e.first.message
     end
-    assert_raises RuntimeError do |e|
+    assert_raises RuntimeError do |*e|
       GreenEggsAndSpam.options[:key_index] = "some string"
-      asset_equal "InvalidKeyIndex", e.message
+      asset_equal "InvalidKeyIndex", e.first.message
     end
   end
   
   should "validate form options" do
-    assert_raises RuntimeError do |e|
+    assert_raises RuntimeError do |*e|
       GreenEggsAndSpam.options[:form_options] = "some string"
-      asset_equal "InvalidKeyIndex", e.message
+      asset_equal "InvalidKeyIndex", e.first.message
     end
   end
   
@@ -50,4 +50,19 @@ class TestGreenEggsAndSpam < Test::Unit::TestCase
     assert GreenEggsAndSpam.key_index.include?(key)
   end
 
-end
+  should "validate key/answer combo" do
+    key = GreenEggsAndSpam.random_key
+    answer = { :key => key, :answer => GreenEggsAndSpam.key_index[key] }
+    assert GreenEggsAndSpam.validates?(answer)
+  end
+
+  should "return false when validation params are incorrect" do
+    answer = { :key => "foo", :answer => "bar" }
+    assert !GreenEggsAndSpam.validates?(answer)
+  end
+    
+  should "return false when validation params are nil" do
+    assert !GreenEggsAndSpam.validates?(nil)
+  end
+
+end

data/test/test_options.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestOptions < Test::Unit::TestCase
+class TestOptions < MiniTest::Unit::TestCase
 
   def setup
     GreenEggsAndSpam.options.default!
@@ -34,4 +34,4 @@ class TestOptions < Test::Unit::TestCase
     assert_equal 'nothing', GreenEggsAndSpam.options['something']
   end
   
-end
+end

metadata

@@ -1,73 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: green_eggs_and_spam
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Spencer Steffen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-23 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157479080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: capybara
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157479080
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2157478320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.4.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157478320
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: &2157477800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.11.3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157477800
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2157477340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *id004
-description: "Green eggs and spam presents the user with a simple question: What color is this image? You'll supply the images and a key of which one's which, and the gem will help with the rest."
-email: 
+  version_requirements: *2157477340
+description: ! 'Green eggs and spam presents the user with a simple question: What
+  color is this image? You''ll supply the images and a key of which one''s which,
+  and the gem will help with the rest.'
+email:
 - spencer@citrusme.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -101,6 +99,7 @@ files:
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/green_eggs_and_spam.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
@@ -116,47 +115,38 @@ files:
 - test/dummy/public/images/antispam/1.png
 - test/dummy/public/images/antispam/2.png
 - test/dummy/public/images/antispam/3.png
+- test/dummy/public/images/named/firetruck.png
+- test/dummy/public/images/named/lime.png
+- test/dummy/public/images/named/ocean.png
 - test/dummy/script/rails
 - test/helper.rb
-- test/integration/navigation_test.rb
-- test/support/integration_case.rb
 - test/test_green_eggs_and_ham.rb
 - test/test_options.rb
-has_rdoc: true
-homepage: ""
+homepage: https://github.com/citrus/green_eggs_and_spam
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3011029944543464221
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3011029944543464221
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: green_eggs_and_spam
-rubygems_version: 1.5.0
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A simple way to filter spam in your rails forms.
-test_files: 
+test_files:
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/comments_controller.rb
@@ -176,6 +166,7 @@ test_files:
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/green_eggs_and_spam.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
@@ -191,9 +182,10 @@ test_files:
 - test/dummy/public/images/antispam/1.png
 - test/dummy/public/images/antispam/2.png
 - test/dummy/public/images/antispam/3.png
+- test/dummy/public/images/named/firetruck.png
+- test/dummy/public/images/named/lime.png
+- test/dummy/public/images/named/ocean.png
 - test/dummy/script/rails
 - test/helper.rb
-- test/integration/navigation_test.rb
-- test/support/integration_case.rb
 - test/test_green_eggs_and_ham.rb
 - test/test_options.rb

data/test/integration/navigation_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class NavigationTest < ActiveSupport::IntegrationCase
-  test "truth" do
-    assert_kind_of Dummy::Application, Rails.application
-  end
-end

data/test/support/integration_case.rb

@@ -1,5 +0,0 @@
-# Define a bare test case to use with Capybara
-class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
-  include Capybara
-  include Rails.application.routes.url_helpers
-end