csv_record 1.6.0 → 1.7.0

data/README.md

@@ -33,13 +33,10 @@ class Car
   include CsvRecord::Document
 
   attr_accessor :year, :make, :model, :description, :price
-
-  validates_presence_of :price, :model
 end
 ```
 
-By including this module you will gain for free the following methods:
-
+##Persistance
 ```ruby
 Car.create( # save the new record in the database
   year: 2007,
@@ -50,14 +47,19 @@ Car.create( # save the new record in the database
 )
 
 car.save # save the record in the database (either creating or changing)
-car.valid? # verifies its validity, specially if it is declared some of the available validators (e.x:validates_presence_of).
+
 car.update_attribute :year, 1999 # update a single field of an object
 car.update_attributes year: 1999, model: 'E762' # update multiple fields at the same time
 
 car.destroy # removes the record from the database
 
 car.new_record? # checks if the record is new
+```
+
+##Retrieving
+Records can be queried through the following methds:
 
+```ruby
 Car.all # retrieves all saved records
 
 Car.find car.id # find through its id
@@ -77,6 +79,7 @@ Car.last # retrieves the last record in the database
 ##Associations
 ###Belongs To
 A Belongs To association can be declared through the following method:
+
 ```ruby
 class Company
   include CsvRecord::Document
@@ -105,6 +108,7 @@ car.company # #<Company:0x007f9b249b24d8>
 
 ###Has Many
 Extending the previous example, you can use the `has_many` method to establish the inverse relationship:
+
 ```ruby
 class Company
   include CsvRecord::Document
@@ -123,37 +127,61 @@ company.cars # [#<Car:0x007f9b249b24d8>]
 ```
 
 ##Callbacks
+###Overview
 Callbacks can be used to execute code on predetermined moments.
 
+####Usage
 ```ruby
-before_create do |obj|
-  obj.do_something
-end
-
 after_create do |obj|
   obj.do_something
 end
 ```
 `obj` refers to the instance you are in
 
+###Avaiable Callbacks
+Here is a list with all the available callbacks, listed in the same order in which they will get called during the respective operations:
+
+####Creating an Object
+* before_create
+* before_validation
+* after_validation
+* after_create
+
+####Updating an Object
+* before_validation
+* after_validation
+
 ##Validations
 
 Helpers available:
 
 `validates_presence_of`: Ensures if the specified attributes were filled
 
+`validates_uniqueness_of`: Ensures that the specified attribute(s) are unique within the database
+
+`validate`: Uses custom methods to validate the model
+
 ```ruby
 class Company
   include CsvRecord::Document
-  validates_presence_of :name
+
   attr_accessor :name
+
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  validate :my_custom_validator_method
+
+  def my_custom_validator_method
+    @errors = self.errors.add attribute
+  end
 end
 
-company = Company.create :name => ''
+company = Company.create
 company.save
 # => false
 
-company = Company.create :name => ''
+company = Company.create
 company.valid?
 # => false
 company.invalid?

data/lib/csv_record/callbacks.rb

@@ -1,12 +1,13 @@
 module CsvRecord
   module Callbacks
-
     CALLBACKS = [
-      :after_create,
       :after_initialize,
-      :after_save,
+      :before_validation,
+      :after_validation,
       :before_create,
       :before_save,
+      :after_create,
+      :after_save
     ].freeze
 
     module ClassMethods

data/lib/csv_record/connector.rb

@@ -1,15 +1,20 @@
 module CsvRecord
   module Connector
+    DATABASE_FOLDER = 'db'.freeze
+    APPEND_MODE = 'a'.freeze
+    WRITE_MODE = 'wb'.freeze
+    READ_MODE = 'r'.freeze
+
     def __initialize_db_directory__
-      unless Dir.exists? 'db'
-        Dir.mkdir 'db'
+      unless Dir.exists? DATABASE_FOLDER
+        Dir.mkdir DATABASE_FOLDER
       end
     end
 
     def __initialize_db__
-      initialize_db_directory
+      __initialize_db_directory__
       unless db_initialized?
-        open_database_file 'wb' do |csv|
+        open_database_file WRITE_MODE do |csv|
           csv << fields
         end
       end
@@ -19,7 +24,8 @@ module CsvRecord
       File.exist? self.const_get('DATABASE_LOCATION')
     end
 
-    def __open_database_file__(mode='r')
+    def __open_database_file__(mode=READ_MODE)
+      __initialize_db__ if mode == READ_MODE # fix this later
       CSV.open(self.const_get('DATABASE_LOCATION'), mode, headers: true) do |csv|
         yield(csv)
       end
@@ -27,7 +33,7 @@ module CsvRecord
 
     def __parse_database_file__
       open_database_file do |csv|
-        CSV.open(self.const_get('DATABASE_LOCATION_TMP'), 'w', headers: true) do |copy|
+        CSV.open(self.const_get('DATABASE_LOCATION_TMP'), WRITE_MODE, headers: true) do |copy|
           copy << fields
           csv.entries.each do |entry|
             new_row = yield(entry)

data/lib/csv_record/reader.rb

@@ -105,6 +105,14 @@ module CsvRecord
         self.id
       end
 
+      def ==(obj)
+        self.class == obj.class && self.to_param == obj.to_param
+      end
+
+      def !=(obj)
+        self.class != obj.class || self.to_param != obj.to_param
+      end
+
       alias :attributes :__attributes__
       alias :values :__values__
       alias :to_param :__to_param__

data/lib/csv_record/validations.rb

@@ -1,22 +1,34 @@
 module CsvRecord
   module Validations
     module ClassMethods
-      attr_writer :fields_to_validate
+      [:presence, :uniqueness].each do |kind|
+        define_method "fields_to_validate_#{kind}" do
+          eval "@fields_to_validate_#{kind} || []"
+        end
+
+        define_method "__validates_#{kind}_of__" do |*attr_names|
+          eval "@fields_to_validate_#{kind} = attr_names"
+        end
 
-      def fields_to_validate
-        @fields_to_validate || []
+        eval "alias :validates_#{kind}_of :__validates_#{kind}_of__"
       end
 
-      def __validates_presence_of__(*attr_names)
-        @fields_to_validate = attr_names
+      def custom_validators
+        @custom_validators || []
       end
 
-      alias :validates_presence_of :__validates_presence_of__
+      def validate(*args, &block)
+        @custom_validators ||= []
+        args.each { |arg| @custom_validators << arg }
+        @custom_validators << block if block_given?
+      end
     end
 
     module InstanceMethods
       def __valid__?
-        validate_each(self.class.fields_to_validate)
+        trigger_presence_validations
+        trigger_uniqueness_validations
+        trigger_custom_validations
         errors.empty?
       end
 
@@ -31,13 +43,34 @@ module CsvRecord
       alias :valid? :__valid__?
 
       private
-      def validate_each(attributes)
-        attributes.each do |attribute|
+      def trigger_presence_validations
+        self.class.fields_to_validate_presence.each do |attribute|
           if self.public_send(attribute).nil?
             @errors = self.errors.add attribute
           end
         end
       end
+
+      def trigger_uniqueness_validations
+        self.class.fields_to_validate_uniqueness.each do |attribute|
+          condition = {}
+          condition[attribute] = self.public_send attribute
+          records = self.class.__where__ condition
+          if records.any? { |record| record != self }
+            @errors = self.errors.add attribute
+          end
+        end
+      end
+
+      def trigger_custom_validations
+        self.class.custom_validators.each do |validator|
+          if not validator.is_a? Proc
+            self.send validator
+          else
+            validator.call self
+          end
+        end
+      end
     end
   end
 end

data/lib/csv_record/version.rb

@@ -1,3 +1,3 @@
 module CsvRecord
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/lib/csv_record/writer.rb

@@ -26,11 +26,15 @@ module CsvRecord
       end
 
       def __save__
+        result = nil
+        self.run_before_validation_callbacks
         if self.valid?
-          self.new_record? ? self.append_registry : self.update_registry
+          result = self.new_record? ? self.append_registry : self.update_registry
         else
-          false
+          result = false
         end
+        self.run_after_validation_callbacks
+        result
       end
 
       def new_record?
@@ -66,7 +70,6 @@ module CsvRecord
       end
 
       def append_registry
-        self.class.initialize_db
         set_created_at
         write_object
       end
@@ -83,7 +86,7 @@ module CsvRecord
 
       def __write_object__
         calculate_id
-        self.class.open_database_file 'a' do |csv|
+        self.class.open_database_file CsvRecord::Connector::APPEND_MODE do |csv|
           csv << values
         end
         true

data/test/csv_record/callbacks_test.rb

@@ -19,6 +19,8 @@ describe CsvRecord::Callbacks do
 
     it ('run before_create callbacks') { klass.must_respond_to(:run_before_create_callbacks) }
     it ('run after_create callbacks') { klass.must_respond_to(:run_after_create_callbacks) }
+    it ('run before_validation callbacks') { klass.must_respond_to(:run_before_validation_callbacks) }
+    it ('run after_validation callbacks') { klass.must_respond_to(:run_after_validation_callbacks) }
     it ('run before_save callbacks') { klass.must_respond_to(:run_before_save_callbacks) }
     it ('run after_save callbacks') { klass.must_respond_to(:run_after_save_callbacks) }
     it ('run after_initialize callbacks') { klass.must_respond_to(:run_after_initialize_callbacks) }
@@ -34,5 +36,13 @@ describe CsvRecord::Callbacks do
     it 'after_create' do
       object_created.after_create_called.must_equal true
     end
+
+    it 'before_validation' do
+      object_created.before_validation_called.must_equal true
+    end
+
+    it 'after_validation' do
+      object_created.after_create_called.must_equal true
+    end
   end
 end

data/test/csv_record/reader_test.rb

@@ -1,6 +1,7 @@
 require_relative '../test_helper'
 
 require_relative '../models/car'
+require_relative '../models/jedi'
 
 describe CsvRecord::Reader do
   describe 'initializing class methods' do
@@ -11,6 +12,9 @@ describe CsvRecord::Reader do
   describe 'initializing instance methods' do
     it ('responds to values') { Car.new.must_respond_to :values }
     it ('responds to attributes') { Car.new.must_respond_to :attributes }
+    it ('responds to to_param') { Car.new.must_respond_to :to_param }
+    it ('responds to ==') { Car.new.must_respond_to :== }
+    it ('responds to !=') { Car.new.must_respond_to :!= }
   end
 
   describe 'validating the methods behavior' do
@@ -56,7 +60,7 @@ describe CsvRecord::Reader do
       Car.all.size.must_equal 2
     end
 
-    it "Retrieves all registries" do
+    it "counting the registries" do
       car.save
       Car.count.must_equal 1
       second_car.save
@@ -70,6 +74,46 @@ describe CsvRecord::Reader do
       car.to_param.must_equal 1
     end
 
+    describe '==' do
+      before do
+        yoda.save
+        luke.save
+        jedi_council.save
+      end
+
+      it 'comparing with the same registry' do
+        (yoda == yoda).must_equal true
+      end
+
+      it 'comparing with a diferent registry' do
+        (yoda == luke).must_equal false
+      end
+
+      it 'comparing with another class registry' do
+        (yoda == jedi_council).must_equal false
+      end
+    end
+
+    describe '!=' do
+      before do
+        yoda.save
+        luke.save
+        jedi_council.save
+      end
+
+      it 'comparing with the same registry' do
+        (yoda != yoda).must_equal false
+      end
+
+      it 'comparing with a diferent registry' do
+        (yoda != luke).must_equal true
+      end
+
+      it 'comparing with another class registry' do
+        (yoda != jedi_council).must_equal true
+      end
+    end
+
     describe 'simple query' do
       let (:cars) { [] }
 

data/test/csv_record/validation_test.rb

@@ -6,6 +6,7 @@ require_relative '../models/jedi_order'
 describe CsvRecord::Validations do
   describe 'initializing class methods' do
     it ('responds to validates_presence_of') { Jedi.must_respond_to :validates_presence_of }
+    it ('responds to validates_uniqueness_of') { Jedi.must_respond_to :validates_uniqueness_of }
     it ('responds to valid?') { Jedi.new.must_respond_to :valid? }
     it ('responds to invalid?') { Jedi.new.must_respond_to :invalid? }
   end
@@ -72,6 +73,38 @@ describe CsvRecord::Validations do
         invalid_jedi.valid?
         invalid_jedi.errors.length.must_equal 2
       end
+
+      it 'should contain the errors found' do
+        invalid_jedi.valid?
+        invalid_jedi.errors.must_include :name
+        invalid_jedi.errors.must_include :age
+      end
+    end
+  end
+
+  describe 'validates_uniqueness_of' do
+    before { yoda.save }
+
+    let :fake_yoda do
+      fake_yoda = Jedi.new name: 'Yoda the green', age: 238, midi_chlorians: '1k'
+    end
+
+    it 'can`t have the same name' do
+      fake_yoda.valid?.must_equal false
+    end
+  end
+
+  describe 'custom_validator' do
+    it ('responds to validate') { Jedi.must_respond_to :validate }
+
+    before { yoda.valid? }
+
+    it 'adding a custom validator' do
+      yoda.custom_validator_checker.must_equal true
+    end
+
+    it 'validate can have a block' do
+      yoda.custom_validator_checker_with_block.must_equal true
     end
   end
 end

data/test/models/callback_test_class.rb

@@ -5,11 +5,20 @@ class CallbackTestClass
   end
 
   attr_accessor :before_create_called, :after_create_called
+  attr_accessor :before_validation_called, :after_validation_called
 
   before_create do |obj|
     obj.before_create_called = true
   end
 
+  before_validation do |obj|
+    obj.before_validation_called = true
+  end
+
+  after_validation do |obj|
+    obj.after_validation_called = true
+  end
+
   after_create do |obj|
     obj.after_create_called = true
   end

data/test/models/car.rb

@@ -1,5 +1,3 @@
-require 'csv_record'
-
 class Car
   include CsvRecord::Document
 

data/test/models/jedi.rb

@@ -1,11 +1,20 @@
-require 'csv_record'
-
 class Jedi
   include CsvRecord::Document
 
+  attr_accessor :name, :age, :midi_chlorians
+  attr_reader :custom_validator_checker, :custom_validator_checker_with_block
+
   belongs_to :jedi_order
 
   validates_presence_of :name, :age
+  validates_uniqueness_of :name
+
+  validate :my_custom_validator_method
+  validate do |obj|
+    obj.instance_eval do
+      @custom_validator_checker_with_block = true
+    end
+  end
 
   def initialize(params={})
     params.each do |key, value|
@@ -13,5 +22,8 @@ class Jedi
     end
   end
 
-  attr_accessor :name, :age, :midi_chlorians
+  private
+  def my_custom_validator_method
+    @custom_validator_checker = true
+  end
 end

data/test/models/jedi_order.rb

@@ -1,8 +1,8 @@
-require 'csv_record'
-
 class JediOrder
   include CsvRecord::Document
 
+  attr_accessor :rank
+
   has_many :jedis
 
   def initialize(params={})
@@ -10,6 +10,4 @@ class JediOrder
       self.public_send("#{key}=", value)
     end
   end
-
-  attr_accessor :rank
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_record
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport