green_eggs_and_spam 0.1.0 → 0.1.1

data/.gitignore

@@ -2,4 +2,7 @@
 .bundle
 .DS_Store
 Gemfile.lock
-pkg/*
+pkg/*
+test/dummy/db/*.sqlite3
+test/dummy/log/
+test/dummy/tmp/

data/README.md

@@ -1,7 +1,7 @@
 Green Eggs and Spam
 ===================
 
-A simple way to filter spam in your rails forms. Green eggs and spam presents the user with a simple question: **What color is this image?**
+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.
 
@@ -18,49 +18,89 @@ Install the gem just like you would any other:
     
     # or with bundler
     
-    gem 'green_eggs_and_spam', '>= 0.1.0'
+    gem 'green_eggs_and_spam', '>= 0.1.1'
         
 
-Create a handful of color coded images and name them `1.png`, `2.png`, etc. Tell Green Eggs and Spam which ones which with an initializer:
+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:
 
     # config/initializers/green_eggs_and_spam.rb
     
-    GreenEggsAndSpam::AntiSpam.key_index = { "1" => "blue", "2" => "green", "3" => "red" }
+    GreenEggsAndSpam.options[:key_index] = { "1" => "blue", "banana" => "yellow", "firetruck" => "red" }
 
 
-In your controller:
 
-    class CommentsController < ApplicationController
+Include the helper 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.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:
+
+    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.
+
+    class EggsController < ApplicationController
+      
       has_anti_spam
       
+      ...
+      
+      # merge the antispam params into your model's params before validation
       def create
-        ... # your code
-        
-        # add an error unless the anti spam question was answered correctly
-        @comment.errors[:base] << "Spam Detected! Please make sure you've properly answered the anti spam question." unless anti_spam_valid?        
+        @egg = Egg.new(params[:egg].merge(:antispam => params[:antispam]))
         
-        ... # the rest of your action
+        # validate as usual
+        if @egg.valid? && @egg.save
+          # do something
+        end
       end
       
     end
+
+
+
+### That's it!
+
+
+But what if my form isn't validating a model? No big deal, just use the `anti_spam_valid?` helper method.
     
+    class CommentsController < ApplicationController
+      
+      has_anti_spam
+      
+      ...
+      
+      # 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
     
-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 optional argument is your custom question
-        
-		  = f.submit 'send'
-		
 
-Customization:
+
+
+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.
 
@@ -75,8 +115,35 @@ So you're using `.gif`'s or you don't want the images stored in `/images/antispa
     # usage
     anti_spam_form, "Your custom color question?", { :extension => 'png', :path => '/images' }
       
+    # or set globally in your initializer
+    
+    GreenEggsAndSpam.options[:form_options] = { :extension => 'png', :path => '/images' }
+
+
+
+Demo
+----
 
+If you'd like to see GreenEggsAndSpam in action, there is a demo app located in `test/dummy`.
 
+    git://github.com/citrus/green_eggs_and_spam.git
+    cd green_eggs_and_spam
+    bundle install
+    cd test/dummy
+    rake db:migrate
+    rails s
+
+
+Testing
+-------
+
+Shoulda tests can be run using `rake test` or just `rake`.
+
+    git://github.com/citrus/green_eggs_and_spam.git
+    cd green_eggs_and_spam
+    rake
+    
+    
 License
 -------
 

data/Rakefile

@@ -1,2 +1,30 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# 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
+
+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

@@ -20,4 +20,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency("rails", ">= 3.0.0")
-end
+  
+  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

data/lib/green_eggs_and_spam/action_controller.rb

@@ -2,27 +2,33 @@ module GreenEggsAndSpam
   
   module ActionController
     
+    # Adds the `has_anti_spam` method into ActionController::Base
     def self.included(base)
       base.extend GreenEggsAndSpam::ActionController::ClassMethods
     end
     
     module ClassMethods
+    
+      # Installs GreenEggsAndSpam's functionality into the supplied controller
       def has_anti_spam
         self.send(:include, GreenEggsAndSpam::ActionController::InstanceMethods)
         self.class_eval do
           helper GreenEggsAndSpam::AntiSpamFormHelper
-          before_filter :setup_anti_spam, :only => [:index,:new, :create]
+          before_filter :setup_anti_spam, :only => [:index,:new,:create]
           private
-            def setup_anti_spam         
-              @antispam_key = GreenEggsAndSpam::AntiSpam.random_key
+            # Sets the antispam key to a random one
+            def setup_anti_spam
+              @antispam_key = GreenEggsAndSpam.random_key
             end
         end
       end
     end
     
     module InstanceMethods
+      
+      # Validates the supplied antispam params
       def anti_spam_valid?
-        GreenEggsAndSpam::AntiSpam.valid?(params)
+        GreenEggsAndSpam.validates?(params[:antispam])
       end
     end
     

data/lib/green_eggs_and_spam/active_record.rb

@@ -0,0 +1,28 @@
+require 'green_eggs_and_spam/anti_spam_validator'
+
+module GreenEggsAndSpam  
+  
+  module ActiveRecord
+    
+    # Adds the `validates_anti_spam` method into ActiveRecord::Base
+    def self.included(base)
+      base.extend GreenEggsAndSpam::ActiveRecord::ClassMethods
+    end
+    
+    module ClassMethods
+    
+      # Installs GreenEggsAndSpam's validation functionality into the supplied model
+      def validates_anti_spam
+        self.class_eval do
+          attr_accessor :antispam
+          validates_with GreenEggsAndSpam::AntiSpamValidator
+        end
+      end
+      
+    end
+    
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, GreenEggsAndSpam::ActiveRecord) if defined?(ActiveRecord)

data/lib/green_eggs_and_spam/anti_spam_validator.rb

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

data/lib/green_eggs_and_spam/form_helper.rb

@@ -1,18 +1,17 @@
 module GreenEggsAndSpam
 
   module AntiSpamFormHelper
-
+    
+    # Builds a label tag, text field and hidden field for use in a rails form
     def anti_spam_form(question="What color is this image?", options={})
       key = @antispam_key || 0
-      options = { :alt => 'AntiSpam Image', :class => 'antispam-image', :path => '/images/antispam', :extension => 'jpg' }.merge(options)
-      choices = GreenEggsAndSpam::AntiSpam.key_index.values.to_a
+      options = GreenEggsAndSpam.options[:form_options].merge(options)
+      choices = GreenEggsAndSpam.key_index.values.to_a
       choices[choices.length - 1] = "or #{choices.last}"
       [
-        label_tag(:antispam, question, :class => 'antispam-label'),
-        tag(:br),          
-      	text_field_tag(:antispam, '', :class => 'antispam-field text required', :title => choices.join(", ")),
-      	hidden_field_tag(:antispam_key, key),
-        tag(:br, :class => 'clear'),
+        label_tag('antispam[answer]', question, :class => 'antispam-label'),  
+      	text_field_tag('antispam[answer]', '', :class => 'antispam-field text required', :title => choices.join(", ")),
+      	hidden_field_tag('antispam[key]', key, :class => 'hidden'),
       	image_tag(File.join(options[:path], "#{key}.#{options[:extension]}"), :alt => options[:alt], :class => options[:class])
       ].join("\n").html_safe
     end

data/lib/green_eggs_and_spam/options.rb

@@ -0,0 +1,45 @@
+module GreenEggsAndSpam
+
+  class Options < Hash
+  
+    # Initializes the options hash with the defaults
+    def initialize
+      super
+      default!
+    end
+    
+    # Clears current options and resets to the defaults
+    def default!
+      clear.merge!(defaults)
+    end
+    
+    # The default options hash
+    def defaults
+      {
+        :key_index => { "1" => "red", "2" => "green", "3" => "blue" },
+        :form_options => { :alt => 'AntiSpam Image', :class => 'antispam-image', :path => '/images/antispam', :extension => 'png' },
+        :error_message => "Spam Detected! Please make sure you've properly answered the anti spam question."
+      }
+    end
+    
+    # Sets and option and converts its key to a symbol
+    def []=(key, value)
+      key = key.to_sym
+      case key
+        when :key_index
+          raise "Invalid Key Index" unless value.is_a?(Hash) && 1 < value.keys.length
+        when :form_options
+          raise "Invalid Form Options" unless value.is_a?(Hash)
+          value = fetch(:form_options).merge(value)
+      end
+      super(key, value)
+    end
+    
+    # Turns the key into a symbol and returns the requested value
+    def [](key)
+      super(key.to_sym)
+    end
+    
+  end
+  
+end

data/lib/green_eggs_and_spam/version.rb

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

data/lib/green_eggs_and_spam.rb

@@ -1,7 +1,35 @@
-require 'green_eggs_and_spam/anti_spam'
+require 'green_eggs_and_spam/options'
 require 'green_eggs_and_spam/action_controller'
+require 'green_eggs_and_spam/active_record'
 require 'green_eggs_and_spam/form_helper'
 
 module GreenEggsAndSpam
-  # Your code goes here...
-end
+  
+  extend self
+  
+  # Returns the options hash
+  def options
+    @options ||= Options.new
+  end
+  
+  # Returns the key index from the options hash
+  def key_index
+    options[:key_index]
+  end
+  
+  # Returns a random key
+  def random_key
+    key_index.keys.sort_by{rand}.first
+  end
+  
+  # Validates a key and answer combo
+  def validates?(params)    
+    key = params[:key].to_s
+    val = params[:answer].to_s
+    return false if key.empty? || val.empty?
+    answer = key_index[key.to_s]
+    regex = Regexp.new(answer, 'i')
+    return val.match(regex) != nil
+  end
+  
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/comments_controller.rb

@@ -0,0 +1,18 @@
+class CommentsController < ApplicationController
+
+  has_anti_spam
+  
+  def new
+  end
+
+  def create
+    if anti_spam_valid?
+      flash[:notice] = "Comment sent!"
+      redirect_to new_comment_path
+    else
+      flash[:error] = GreenEggsAndSpam.options[:error_message]
+      render :action => 'new'
+    end
+  end
+
+end

data/test/dummy/app/controllers/eggs_controller.rb

@@ -0,0 +1,24 @@
+class EggsController < ApplicationController
+
+  has_anti_spam
+  
+  def index
+    @eggs = Egg.all
+  end
+  
+  def new
+    @egg = Egg.new
+  end
+
+  def create
+    @egg = Egg.new(params[:egg].merge(:antispam => params[:antispam]))
+    if @egg.save
+      flash[:notice] = "Egg successfully created!"
+      redirect_to eggs_path
+    else
+      flash[:error] = "Egg could not be saved."
+      render :action => 'new'
+    end
+  end
+
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/egg.rb

@@ -0,0 +1,7 @@
+class Egg < ActiveRecord::Base
+  
+  validates_presence_of :name
+  
+  validates_anti_spam
+  
+end

data/test/dummy/app/views/comments/new.html.erb

@@ -0,0 +1,14 @@
+<h2>Send a Comment</h2>
+
+<%= form_tag comments_path do %>
+  <p>
+    <%= label_tag 'comment' %>
+    <%= text_field_tag 'comment', params[:comment] %> 
+  </p>
+  <p>
+    <%= anti_spam_form %>
+  </p>
+  <p>
+    <%= submit_tag 'Send' %>
+  </p>
+<% end %> 

data/test/dummy/app/views/eggs/index.html.erb

@@ -0,0 +1,14 @@
+<h2>Eggs</h2>
+<h3>Why Eggs? Because they're delicious!</h3>
+
+<%= link_to "new egg", new_egg_path %>
+
+<ul>
+  <% if @eggs.empty? %>
+    <li>No eggs have been created!</li>
+  <% else %>
+    <% @eggs.each do |egg| %>
+      <li><%= egg.inspect %></li>
+    <% end %></ul>
+  <% end %>
+</ul>

data/test/dummy/app/views/eggs/new.html.erb

@@ -0,0 +1,21 @@
+<h2>New Egg</h2>
+
+<% if 0 < @egg.errors.to_a.length %>
+  <p class="flash error">
+    <b>Errors:</b><br/>
+    <%= @egg.errors.to_a.join("<br/>").html_safe %>
+  </p>
+<% end %>
+
+<%= form_for @egg do |f| %>
+  <p>
+    <%= f.label :name %>
+    <%= f.text_field :name %> 
+  </p>
+  <p>
+    <%= anti_spam_form %>
+  </p>
+  <p>
+    <%= f.submit %>
+  </p>
+<% end %> 

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= csrf_meta_tag %>
+  <style type="text/css">
+    body {
+      font-family: "HelveticaNeue", Helvetica, Arial, sans-serif;
+      color: #080603;
+    }
+    a {
+      text-decoration: none;
+      color: #68962c;
+    }
+    .container {
+      width: 500px;
+      margin: 0 auto;
+    }
+    .header {
+      border-bottom: 1px solid #ddd;
+    }
+    .header a {
+      display: inline-block;
+      padding: 4px 10px;
+      background-color: #eee;
+    }
+    
+    .flash {
+      padding: 10px 0;
+      border-bottom: 1px solid #ddd;
+    }
+    .flash.notice {
+      color: #68962c;
+    }
+    .flash.error {
+      color: #c00e0e;
+    }
+    
+  </style>
+</head>
+<body>
+
+<div class="container">
+
+  <div class="header">
+    <h1 class="title">Green Eggs &amp; Spam Demo</h1>
+    <%= link_to "play with eggs", eggs_path %> 
+    <%= link_to "send a comment", new_comment_path %>
+  </div>
+
+  <%= content_tag(:p, flash[:notice], :class => 'flash notice') if flash[:notice] %>
+  <%= content_tag(:p, flash[:error], :class => 'flash error') if flash[:error] %>
+
+  <%= yield %>
+
+</div>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "green_eggs_and_spam"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000