validatable_associations 0.1.0

data/README.rdoc

@@ -0,0 +1,56 @@
+= ValidatableAssociations
+
+ValidatableAssociations is an add-on to Jay Fields
+{Validatable}[http://validatable.rubyforge.org] library. This add-on lets you
+specify associations to other validatable classes and allows you to set up a
+decent validatable structure.
+
+== Install
+
+  $ script/plugin install git://github.com/rubiii/validatable_associations.git
+
+== Associations
+
+A very simple example of a "User has one Gorilla" association:
+
+  class User
+    include Validatable
+    include ValidatableAssociations
+
+    has_one :gorilla
+
+    attr_accessor :username, :password
+
+    validates_presence_of :username
+    validates_length_of :password, :minimum => 6
+  end
+
+  class Gorilla
+    include Validatable
+    include ValidatableAssociations
+
+    attr_accessor :name, :size
+
+    validates_presence_of :name
+    validates_numericality_of :size
+  end
+
+==== Currently implemented associations:
+
+The first version of this add-on only includes has_one associations.
+I intend to only add more associations if I need them myself or if anyone convinces
+me that he really needs support for another type of association.
+
+== Validation
+
+Calling the valid? method (provided by the Validatable library) on an instance of
+one of your validatable Classes will also run the validations off all associations
+of the Class.
+
+== Mass-assignment
+
+You can use mass-assignment to assign multiple values to your Class at once.
+This also includes every one of its associations.
+
+  user = User.new :username => "apricot", :password => "secret",
+    :gorilla => { :name => "Joe", :size => 4411 }

data/Rakefile

@@ -0,0 +1,45 @@
+require "rubygems"
+require "rake"
+require "spec/rake/spectask"
+require "rake/rdoctask"
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |spec|
+  spec.spec_files = FileList["spec/**/*_spec.rb"]
+  spec.spec_opts << "--color"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = "ValidatableAssociations"
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rdoc.options = ["--line-numbers", "--inline-source"]
+end
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |spec|
+    spec.name = "validatable_associations"
+    spec.author = "Daniel Harrington"
+    spec.email = "me@rubiii.com"
+    spec.homepage = "http://github.com/rubiii/validatable_associations"
+    spec.summary = "Association add-on for the Validatable gem"
+    spec.description = spec.summary
+
+    spec.files = FileList["init.rb", "[A-Z]*", "{lib,spec}/**/*.{rb,xml}"]
+
+    spec.rdoc_options += [
+      "--title", "validatable_associations",
+      "--main", "README.rdoc",
+      "--line-numbers",
+      "--inline-source"
+    ]
+
+    spec.add_development_dependency("validatable", "1.6.7")
+    spec.add_development_dependency("rspec", ">= 1.2.8")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1 @@
+require "validatable_associations"

data/lib/validatable_associations.rb

@@ -0,0 +1,117 @@
+# == ValidatableAssociations
+# 
+# ValidatableAssociations is an add-on to the Validatable gem by Jay Fields.
+# It adds the most common association methods provided by Rails to your
+# validatable Class and allows to set up a decent validatable structure.
+module ValidatableAssociations
+
+  # ValidatableAssociations::ClassMethods
+  #
+  # Includes class methods for setting up the associations.
+  module ClassMethods
+
+    # Reader/writer method for has_one associations. Sets 1-n +associations+
+    # or defaults to return all previously specified associations if no
+    # parameters were given.
+    def has_one(*associations)
+      @has_one = [] unless @has_one
+      return @has_one if associations.empty?
+      @has_one = associations.map { |association| association.to_s }
+    end
+
+  end
+
+  def self.included(base) #:nodoc:
+    base.extend(ClassMethods)
+  end
+
+  # The initialize method handles mass-assignment of a given Hash of
+  # +attributes+ to their instance variables.
+  def initialize(attributes = {})
+    return if !attributes || attributes.empty?
+    attributes.each { |ivar, value| assign_to(ivar, value) }
+  end
+
+  # Catches calls to undefined methods. Checks if the +method+ called matches
+  # a reader/writer method of an association and handles the read/write process.
+  # Delegates to super otherwise.
+  def method_missing(method, *args)
+    association_name = to_association_name(method)
+    super unless self.class.has_one.include? association_name
+
+    association_to_set = find_or_create_association(association_name, args[0])
+    self.instance_variable_set("@#{association_name}", association_to_set)
+    association_to_set
+  rescue NameError
+    super
+  end
+
+  # Returns whether the validations of this model and all associated models
+  # passed successfully.
+  def valid?
+    validate_associations
+    super && associations_valid?
+  end
+
+private
+
+  # Assigns a given +value+ to a given +ivar+. Tries to use the writer method
+  # for the given instance variable and defaults to setting it directly in case
+  # no writer method was found.
+  def assign_to(ivar, value)
+    if assign_via_writer? ivar
+      self.send("#{ivar}=", value)
+    else
+      self.instance_variable_set("@#{ivar}", value)
+    end
+  end
+
+  # Checks whether a given +ivar+ should be assigned via an existing writer
+  # method or directly.
+  def assign_via_writer?(ivar)
+    self.methods.include?("#{ivar}=") || self.class.has_one.include?(ivar)
+  end
+
+  # Takes an +association_name+ and returns an existing association matching
+  # the given name. Instantiates a new association in case it hasn't been
+  # initialized already or in case of given +arguments+.
+  def find_or_create_association(association_name, arguments = nil)
+    if arguments
+      to_constant(association_name).new arguments
+    else
+      association = self.instance_variable_get("@#{association_name}")
+      association = to_constant(association_name).new unless association
+      association
+    end
+  end
+
+  # Validates all models associated with this model and stores the results.
+  def validate_associations
+    @association_validity = self.class.has_one.map do |association|
+      self.send(association).valid?
+    end
+  end
+
+  # Returns whether the validations of all models associated with this model
+  # passed successfully.
+  def associations_valid?
+    !@association_validity.include?(false)
+  end
+
+  # Expects the name of a reader/writer +method+ and turns it into a valid
+  # name for an association.
+  def to_association_name(method)
+    association_name = method.to_s
+    association_name.slice!(-1) if association_name[-1, 1] == "="
+    association_name
+  end
+
+  # Converts a given +symbol+ from snake_case into an existing Constant.
+  # Note that the constanize method might raise a NameError in case the given
+  # symbol could not be mapped to a Constant.
+  def to_constant(symbol)
+    symbol.to_s.camelize.constantize
+  end
+
+end
+

data/spec/lib/validatable_associations_spec.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper")
+
+describe ValidatableAssociations do
+
+  it "definitely needs some tests"
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+gem "rspec", ">= 1.2.8"
+require "spec"
+require "validatable"
+require File.join(File.dirname(__FILE__), "..", "lib", "validatable_associations")

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: validatable_associations
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: validatable
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.6.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+description: Association add-on for the Validatable gem
+email: me@rubiii.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/validatable_associations.rb
+- spec/lib/validatable_associations_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rubiii/validatable_associations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- validatable_associations
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Association add-on for the Validatable gem
+test_files: 
+- spec/lib/validatable_associations_spec.rb
+- spec/spec_helper.rb