easy_captcha 0.3.0 → 0.4.0

data/README.rdoc

@@ -12,51 +12,62 @@ after bundle execute
 You can configure easy_captcha in "config/initializers/easy_captcha.rb", if you want to customize the default configuration
 
   EasyCaptcha.setup do |config|
-
     # Cache
-    # config.cache = true
+    # config.cache          = true
     # Cache temp dir from Rails.root
     # config.cache_temp_dir = Rails.root + 'tmp' + 'captchas'
     # Cache size
-    # config.cache_size = 500
+    # config.cache_size     = 500
     # Cache expire
-    # config.cache_expire = 1.days
+    # config.cache_expire   = 1.days
 
     # Chars
-    # config.chars = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
+    # config.chars          = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
+
     # Length
-    # config.length = 6
-    # Font
-    # config.font_size = 24
-    # config.font_fill_color = '#333333'
-    # config.font_stroke_color = '#000000'
-    # config.font_stroke = 0
-    # config.font_family = File.expand_path('../../resources/afont.ttf', __FILE__)
-    
+    # config.length         = 6
+
     # Image
-    #config.image_height = 40
-    #config.image_width = 140
-    #config.image_background_color = "#FFFFFF"
-    
-    # Wave
-    # config.wave = true
-    # config.wave_length = (60..100)
-    # config.wave_amplitude = (3..5)
-    
-    # Sketch
-    # config.sketch = true
-    # config.sketch_radius = 3
-    # config.sketch_sigma = 1
-    
-    # Implode
-    # config.implode = 0.1
-    
-    # Blur
-    # config.blur = true
-    # config.blur_radius = 1
-    # config.blur_sigma = 2
+    # config.image_height   = 40
+    # config.image_width    = 140
+
+    # configure generator
+    # config.generator :default do |generator|
+
+      # Font
+      # generator.font_size              = 24
+      # generator.font_fill_color        = '#333333'
+      # generator.font_stroke_color      = '#000000'
+      # generator.font_stroke            = 0
+      # generator.font_family            = File.expand_path('../../resources/afont.ttf', __FILE__)
+
+      # generator.image_background_color = "#FFFFFF"
+
+      # Wave
+      # generator.wave                   = true
+      # generator.wave_length            = (60..100)
+      # generator.wave_amplitude         = (3..5)
+
+      # Sketch
+      # generator.sketch                 = true
+      # generator.sketch_radius          = 3
+      # generator.sketch_sigma           = 1
+
+      # Implode
+      # generator.implode                = 0.1
+
+      # Blur
+      # generator.blur                   = true
+      # generator.blur_radius            = 1
+      # generator.blur_sigma             = 2
+    # end
   end
 
+== Requirements
+
+* RMagick
+* Rails 3 (http://github.com/rails/rails)
+
 == Example
 
   <% form_tag '/' do %>
@@ -72,9 +83,10 @@ You can configure easy_captcha in "config/initializers/easy_captcha.rb", if you
 You find an example app under: http://github.com/traxanos/easy_captcha_example
 
 == History
- * 0.1 Init
- * 0.2 Cache support for high frequented sites
+ * 0.1 init
+ * 0.2 cache support for high frequented sites
  * 0.3 use generators, optimizations, update licence to same of all my plugins
+ * 0.4 generator support
 
 == Maintainers
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/easy_captcha.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_captcha}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marco Scholl"]
@@ -29,6 +29,9 @@ Gem::Specification.new do |s|
     "lib/easy_captcha/captcha.rb",
     "lib/easy_captcha/controller.rb",
     "lib/easy_captcha/controller_helpers.rb",
+    "lib/easy_captcha/generator.rb",
+    "lib/easy_captcha/generator/base.rb",
+    "lib/easy_captcha/generator/default.rb",
     "lib/easy_captcha/model_helpers.rb",
     "lib/easy_captcha/routes.rb",
     "lib/easy_captcha/view_helpers.rb",

data/lib/easy_captcha.rb

@@ -11,6 +11,7 @@ module EasyCaptcha
   autoload :ModelHelpers, 'easy_captcha/model_helpers'
   autoload :ViewHelpers, 'easy_captcha/view_helpers'
   autoload :ControllerHelpers, 'easy_captcha/controller_helpers'
+  autoload :Generator, 'easy_captcha/generator'
 
   # Cache
   mattr_accessor :cache
@@ -31,39 +32,15 @@ module EasyCaptcha
   # Chars
   mattr_accessor :chars
   @@chars = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
+
   # Length
   mattr_accessor :length
   @@length = 6
-  # Font
-  mattr_accessor :font_size, :font_fill_color, :font_family, :font_stroke, :font_stroke_color
-  @@font_size = 24
-  @@font_fill_color = '#333333'
-  @@font_family = File.expand_path('../../../resources/captcha.ttf', __FILE__)
-  @@font_stroke = '#000000'
-  @@font_stroke_color = 0
-  # Image
-  mattr_accessor :image_width, :image_height, :image_background_color
-  @@image_width = 140
+
+  # Length
+  mattr_accessor :image_width, :image_height
+  @@image_width  = 140
   @@image_height = 40
-  @@image_background_color = '#FFFFFF'
-  # Sketch
-  mattr_accessor :sketch, :sketch_radius, :sketch_sigma
-  @@sketch = true
-  @@sketch_radius = 3
-  @@sketch_sigma = 1
-  # Wave
-  mattr_accessor :wave, :wave_length, :wave_amplitude
-  @@wave = true
-  @@wave_length = (60..100)
-  @@wave_amplitude = (3..5)
-  # Implode
-  mattr_accessor :implode
-  @@implode = 0.05
-  # Gaussian Blur
-  mattr_accessor :blur, :blur_radius, :blur_sigma
-  @@blur = true
-  @@blur_radius = 1
-  @@blur_sigma = 2
 
   class << self
     # to configure easy_captcha
@@ -72,28 +49,57 @@ module EasyCaptcha
       yield self
     end
 
-    def sketch? #:nodoc:
-      sketch
+    def cache? #:nodoc:
+      cache
     end
 
-    def wave? #:nodoc:
-      wave
-    end
+    # select generator and configure this
+    def generator(generator = nil, &block)
+      if generator.nil?
+        @generator
+      else
+        generator = generator.to_s if generator.is_a? Symbol
 
-    def blur? #:nodoc:
-      blur
+        if generator.is_a? String
+          generator.gsub!(/^[a-z]|\s+[a-z]/) { |a| a.upcase }
+          generator = "EasyCaptcha::Generator::#{generator}".constantize
+        end
+
+        @generator = generator.new &block
+      end
     end
 
-    def cache? #:nodoc:
-      cache
+    # depracated
+    def method_missing name, *args
+      depracations = [
+          :font_size, :font_fill_color, :font_family, :font_stroke, :font_stroke_color,
+          :image_background_color, :sketch, :sketch_radius, :sketch_sigma, :wave,
+          :wave_length, :wave_amplitude, :implode, :blur, :blur_radius, :blur_sigma
+      ]
+
+      if depracations.include? name[0..-2].to_sym or depracations.include? name.to_sym
+        ActiveSupport::Deprecation.warn "EasyCaptcha.#{name} is deprecated."
+        if name[-1] == '='
+          self.generator.send(name, args.first)
+        else
+          self.generator.send(name)
+        end
+      else
+        super
+      end
     end
 
+
     # called by rails after initialize
     def init
       require 'easy_captcha/routes'
       ActiveRecord::Base.send :include, ModelHelpers
       ActionController::Base.send :include, ControllerHelpers
       ActionView::Base.send :include, ViewHelpers
+
+      # set default generator
+      generator :default
+
     end
   end
 end

data/lib/easy_captcha/captcha.rb

@@ -19,45 +19,7 @@ module EasyCaptcha
     private
 
     def generate_captcha(file = nil) #:nodoc:
-      canvas = Magick::Image.new(EasyCaptcha.image_width, EasyCaptcha.image_height) do |variable|
-        self.background_color = EasyCaptcha.image_background_color unless EasyCaptcha.image_background_color.nil?
-      end
-
-      # Render the text in the image
-      canvas.annotate(Magick::Draw.new, 0, 0, 0, 0, code) {
-        self.gravity     = Magick::CenterGravity
-        self.font_family = EasyCaptcha.font_family
-        self.font_weight = Magick::LighterWeight
-        self.fill        = EasyCaptcha.font_fill_color
-        if EasyCaptcha.font_stroke.to_i > 0
-          self.stroke       = EasyCaptcha.font_stroke_color
-          self.stroke_width = EasyCaptcha.font_stroke
-        end
-        self.pointsize = EasyCaptcha.font_size
-      }
-
-      # Blur
-      canvas = canvas.blur_image(EasyCaptcha.blur_radius, EasyCaptcha.blur_sigma) if EasyCaptcha.blur?
-
-      # Wave
-      w = EasyCaptcha.wave_length
-      a = EasyCaptcha.wave_amplitude
-      canvas = canvas.wave(rand(a.last - a.first) + a.first, rand(w.last - w.first) + w.first) if EasyCaptcha.wave?
-
-      # Sketch
-      canvas = canvas.sketch(EasyCaptcha.sketch_radius, EasyCaptcha.sketch_sigma, rand(180)) if EasyCaptcha.sketch?
-
-      # Implode
-      canvas = canvas.implode(EasyCaptcha.implode.to_f) if EasyCaptcha.implode.is_a? Float
-
-      # Crop image because to big after waveing
-      canvas = canvas.crop(Magick::CenterGravity, EasyCaptcha.image_width, EasyCaptcha.image_height)
-
-      unless file.nil?
-        canvas.write(file) { self.format = 'PNG' }
-      end
-      @image = canvas.to_blob { self.format = 'PNG' }
-      canvas.destroy!
+      @image = EasyCaptcha.generator.generate(@code, file)
     end
   end
 end

data/lib/easy_captcha/generator.rb

@@ -0,0 +1,8 @@
+module EasyCaptcha
+  # module for generators
+  module Generator
+    autoload :Base, 'easy_captcha/generator/base'
+    autoload :Default, 'easy_captcha/generator/default'
+
+  end
+end

data/lib/easy_captcha/generator/base.rb

@@ -0,0 +1,19 @@
+module EasyCaptcha
+  module Generator
+
+    # base class for generators
+    class Base
+
+      # generator for captcha images
+      def initialize(&block)
+        defaults
+        yield self if block_given?
+      end
+
+      # default values for generator
+      def defaults
+      end
+
+    end
+  end
+end

data/lib/easy_captcha/generator/default.rb

@@ -0,0 +1,104 @@
+module EasyCaptcha
+  module Generator
+
+    # default generator
+    class Default < Base
+
+      # set default values
+      def defaults
+        @font_size              = 24
+        @font_fill_color        = '#333333'
+        @font_family            = File.expand_path('../../../../resources/captcha.ttf', __FILE__)
+        @font_stroke            = '#000000'
+        @font_stroke_color      = 0
+        @image_background_color = '#FFFFFF'
+        @sketch                 = true
+        @sketch_radius          = 3
+        @sketch_sigma           = 1
+        @wave                   = true
+        @wave_length            = (60..100)
+        @wave_amplitude         = (3..5)
+        @implode                = 0.05
+        @blur                   = true
+        @blur_radius            = 1
+        @blur_sigma             = 2
+      end
+
+      # Font
+      attr_accessor :font_size, :font_fill_color, :font_family, :font_stroke, :font_stroke_color
+
+      # Background
+      attr_accessor :image_background_color
+
+      # Sketch
+      attr_accessor :sketch, :sketch_radius, :sketch_sigma
+
+      # Wave
+      attr_accessor :wave, :wave_length, :wave_amplitude
+
+      # Implode
+      attr_accessor :implode
+
+      # Gaussian Blur
+      attr_accessor :blur, :blur_radius, :blur_sigma
+
+      def sketch? #:nodoc:
+        @sketch
+      end
+
+      def wave? #:nodoc:
+        @wave
+      end
+
+      def blur? #:nodoc:
+        @blur
+      end
+
+      # generate image
+      def generate(code, file = nil)
+        config = self
+        canvas = Magick::Image.new(EasyCaptcha.image_width, EasyCaptcha.image_height) do |variable|
+          self.background_color = config.image_background_color unless config.image_background_color.nil?
+        end
+
+        # Render the text in the image
+        canvas.annotate(Magick::Draw.new, 0, 0, 0, 0, code) {
+          self.gravity     = Magick::CenterGravity
+          self.font_family = config.font_family
+          self.font_weight = Magick::LighterWeight
+          self.fill        = config.font_fill_color
+          if config.font_stroke.to_i > 0
+            self.stroke       = config.font_stroke_color
+            self.stroke_width = config.font_stroke
+          end
+          self.pointsize = config.font_size
+        }
+
+        # Blur
+        canvas = canvas.blur_image(config.blur_radius, config.blur_sigma) if config.blur?
+
+        # Wave
+        w = config.wave_length
+        a = config.wave_amplitude
+        canvas = canvas.wave(rand(a.last - a.first) + a.first, rand(w.last - w.first) + w.first) if config.wave?
+
+        # Sketch
+        canvas = canvas.sketch(config.sketch_radius, config.sketch_sigma, rand(180)) if config.sketch?
+
+        # Implode
+        canvas = canvas.implode(config.implode.to_f) if config.implode.is_a? Float
+
+        # Crop image because to big after waveing
+        canvas = canvas.crop(Magick::CenterGravity, EasyCaptcha.image_width, EasyCaptcha.image_height)
+
+        unless file.nil?
+          canvas.write(file) { self.format = 'PNG' }
+        end
+        image = canvas.to_blob { self.format = 'PNG' }
+        canvas.destroy!
+        image
+      end
+
+    end
+  end
+end

data/lib/generators/templates/easy_captcha.rb

@@ -1,44 +1,51 @@
 EasyCaptcha.setup do |config|
   # Cache
-  # config.cache = true
+  # config.cache          = true
   # Cache temp dir from Rails.root
   # config.cache_temp_dir = Rails.root + 'tmp' + 'captchas'
   # Cache size
-  # config.cache_size = 500
+  # config.cache_size     = 500
   # Cache expire
-  # config.cache_expire = 1.days
+  # config.cache_expire   = 1.days
 
   # Chars
-  # config.chars = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
+  # config.chars          = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
+
   # Length
-  # config.length = 6
-  # Font
-  # config.font_size = 24
-  # config.font_fill_color = '#333333'
-  # config.font_stroke_color = '#000000'
-  # config.font_stroke = 0
-  # config.font_family = File.expand_path('../../resources/afont.ttf', __FILE__)
+  # config.length         = 6
 
   # Image
-  #config.image_height = 40
-  #config.image_width = 140
-  #config.image_background_color = "#FFFFFF"
-
-  # Wave
-  # config.wave = true
-  # config.wave_length = (60..100)
-  # config.wave_amplitude = (3..5)
-
-  # Sketch
-  # config.sketch = true
-  # config.sketch_radius = 3
-  # config.sketch_sigma = 1
-
-  # Implode
-  # config.implode = 0.1
-
-  # Blur
-  # config.blur = true
-  # config.blur_radius = 1
-  # config.blur_sigma = 2
+  # config.image_height   = 40
+  # config.image_width    = 140
+
+  # configure generator
+  # config.generator :default do |generator|
+
+    # Font
+    # generator.font_size              = 24
+    # generator.font_fill_color        = '#333333'
+    # generator.font_stroke_color      = '#000000'
+    # generator.font_stroke            = 0
+    # generator.font_family            = File.expand_path('../../resources/afont.ttf', __FILE__)
+
+    # generator.image_background_color = "#FFFFFF"
+
+    # Wave
+    # generator.wave                   = true
+    # generator.wave_length            = (60..100)
+    # generator.wave_amplitude         = (3..5)
+
+    # Sketch
+    # generator.sketch                 = true
+    # generator.sketch_radius          = 3
+    # generator.sketch_sigma           = 1
+
+    # Implode
+    # generator.implode                = 0.1
+
+    # Blur
+    # generator.blur                   = true
+    # generator.blur_radius            = 1
+    # generator.blur_sigma             = 2
+  # end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Marco Scholl
@@ -138,6 +138,9 @@ files:
 - lib/easy_captcha/captcha.rb
 - lib/easy_captcha/controller.rb
 - lib/easy_captcha/controller_helpers.rb
+- lib/easy_captcha/generator.rb
+- lib/easy_captcha/generator/base.rb
+- lib/easy_captcha/generator/default.rb
 - lib/easy_captcha/model_helpers.rb
 - lib/easy_captcha/routes.rb
 - lib/easy_captcha/view_helpers.rb
@@ -161,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3005660918227227729
+      hash: -88900623567721278
       segments: 
       - 0
       version: "0"