simple_descriptor 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1 +1,2 @@
-2006 11 26 first release
+0.2.0 added direct bindings for ActiveRecord
+2006 11 26 first release 0.1.0

data/README

@@ -104,6 +104,30 @@ The line
 
 adds some new methods to our class that makes more easy to access a description
 
+== Too lazy? Let Simple Descriptor do the hard work for you
+
+Since 0.2.0 version Simple Descriptor provides method to automate some
+ActiveRecord models description
+
+  class Employee < ActiveRecord::Base
+    extend SimpleDescriptor::ClassDescriptor
+    validates_ar_descriptions
+  end 
+
+With just the code above you will get validations for:
+
+1) all your numeric fields defined as numeric in your DB
+2) maximum length of all the fields defined as string in the DB
+3) all the required field defined as not null in the DB
+
+and you get
+
+Employee.maxlength(field)
+
+plus a lot of pre-defined descriptions for your model that you can inspect with
+
+Employee.descriptions
+
 == Where are the description stored and how?
 
 All the descriptions are stored in a DESCRIPTIONS constant, you can always

data/Rakefile

@@ -12,8 +12,8 @@ require File.join(File.dirname(__FILE__), 'lib', 'simple_descriptor', 'version')
 
 AUTHOR = "blank"
 EMAIL = "your contact email for bug fixes and info"
-DESCRIPTION = "description of gem"
-RUBYFORGE_PROJECT = "simple_descriptor"
+DESCRIPTION = "add description to your classes and make your ActiveRecord validations smarter"
+RUBYFORGE_PROJECT = "simpledesc"
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 BIN_FILES = %w(  )
 

data/lib/simple_descriptor/class_descriptor.rb

@@ -125,7 +125,7 @@ module SimpleDescriptor #:nodoc:
       end
     end
     alias :description_of :described_value_for
-    #creates some shortcut method to access a description
+    #creates some shortcut methods to access a description
     #
     #example
     #  Person.shortcut_desctiption :limited, :as => :maxlength
@@ -163,6 +163,62 @@ module SimpleDescriptor #:nodoc:
         end
       end
     end
+    #loads standard descriptions from columns_hash of ActiveRecord classes
+    #
+    #every column will be described as db type (i.e. :integer, :string, :date etc.)
+    #
+    #string columns are described as limited with the value of the maximum length
+    #
+    #a maxlength class method will be added to provide the maximum length of a field
+    #as defined from the database
+    #
+    #This methods is called by validates_ar_descriptions unless validates_ar_descriptions is called
+    #with the :load_desc option set to false
+    #
+    #  Post.described_as :string
+    #
+    #will return all the fields of posts table that are defined as strings
+    #
+    #  Post.maxlength :title
+    #
+    #will return the maximum length of post title as defined in the database
+    #
+    def load_ar_descriptions
+      if respond_to? :columns_hash
+        columns_hash.each do |k, v|
+          describe k.to_sym, :as => v.type
+          describe k.to_sym, :as => :required if !v.null
+          case v.type
+            when :string : describe k.to_sym, :as => :limited, :with_value => v.limit
+          end
+        end
+        shortcut_description :limited, :as => :maxlength
+      else
+        raise "no columns_hash method"
+      end
+    end
+    #runs validations following the descriptions provided
+    # 1 loads all the descriptions from the database using load_ar_descriptions
+    # 2 validates presence of all required fields unless :required => false in options
+    # 3 validates maximum length of every string field unless :length => false in options
+    # 4 validates integer format for every integer field unless :integer => false in options
+    # 5 validates float format for every float field unless :float => false in options
+    # 6 validates decimal format for every decimal field unless :decimal => false in options
+    # 7 if numbers => false in options then float, decimal and integer validations won't be done
+    def validates_ar_descriptions(options = {})
+      options = {:load_desc => true, :required => true, :length => true, :numbers => true, :float => true, :decimal => true, :integer => true}.update options
+      load_ar_descriptions if options[:load_desc]
+      yield if block_given?
+      send(:validates_presence_of, described_as(:required)) if options[:required]
+      described_as(:limited).each { |field| validates_length_of field, :maximum => maxlength(field), :allow_nil => true } if options[:length]
+      if options[:numbers]
+        described_as(:integer).each { |field| validates_numericality_of field, :only_integer => true, :allow_nil => true } if options[:integer]
+        described_as(:decimal).each { |field| validates_numericality_of field } if options[:decimal]
+        described_as(:float).each { |field| validates_numericality_of field } if options[:float]
+      end
+      validates_custom_descriptions if respond_to? :validates_custom_descriptions
+    end
+ 
     private 
     def find_description_for(arg)
       descriptions.inject({}) do |h, d|

data/lib/simple_descriptor/version.rb

@@ -1,8 +1,8 @@
 module SimpleDescriptor #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: simple_descriptor
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-01-07 00:00:00 +00:00
-summary: description of gem
+  version: 0.2.0
+date: 2007-06-04 00:00:00 +01:00
+summary: add description to your classes and make your ActiveRecord validations smarter
 require_paths: 
 - lib
 email: your contact email for bug fixes and info
-homepage: http://simple_descriptor.rubyforge.org
-rubyforge_project: simple_descriptor
-description: description of gem
+homepage: http://simpledesc.rubyforge.org
+rubyforge_project: simpledesc
+description: add description to your classes and make your ActiveRecord validations smarter
 autorequire: simple_descriptor
 default_executable: 
 bindir: bin