csv_record 1.4.0 → 1.5.0

data/README.md

@@ -27,10 +27,12 @@ $ gem install csv_record
 ## Usage
 
 ```ruby
-requite 'csv_record'
+require 'csv_record'
 
 class Car
   include CsvRecord::Document
+
+  attr_accessor :year, :make, :model, :description, :price
 end
 ```
 
@@ -70,6 +72,54 @@ Car.first # retrieves the first record in the database
 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
+
+  attr_accessor :name
+end
+
+class Car
+  include CsvRecord::Document
+
+  belongs_to :company
+end
+
+company = Company.create :name => 'Chuts'
+
+car = Car.new :model => 'F450'
+
+car.company = company
+# or
+car.company_id = company.id
+
+car.save
+
+car.company # #<Company:0x007f9b249b24d8>
+```
+
+###Has Many
+Extending the previous example, you can use the `has_many` method to stablish the inverse relationship:
+```ruby
+class Company
+  include CsvRecord::Document
+
+  has_many :cars
+
+  attr_accessor :name
+end
+
+company = Company.create :name => 'Chutz'
+
+car.company = company
+car.save
+
+company.cars # [#<Car:0x007f9b249b24d8>]
+```
+
 ##Callbacks
 Callbacks can be used to execute code on predetermined moments.
 
@@ -82,6 +132,7 @@ after_create do |obj|
   obj.do_something
 end
 ```
+`obj` refers to the instance you are in
 
 ##Precautions
 CsvRecord creates a `db` folder in the root of your application. Be sure that it has permission to do so.

data/csv_record.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CsvRecord::VERSION
 
+  gem.add_dependency 'activesupport'
+
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'timecop'
   gem.add_development_dependency 'turn'

data/lib/csv_record/associations.rb

@@ -0,0 +1,31 @@
+module CsvRecord
+  module Associations
+    def belongs_to(klass)
+      klass_name = klass.to_s
+
+      self.class_eval do
+        self.send :attr_writer, "#{klass}_id"
+
+        define_method klass do
+          klass_name.to_class.find self.id
+        end
+        define_method "#{klass}=" do |value|
+          self.send "#{klass}_id=", value.to_param
+        end
+        define_method "#{klass}_id" do
+          eval("@#{klass}_id").to_i
+        end
+      end
+    end
+
+    def has_many(klass)
+      klass_name = klass.to_s
+
+      self.class_eval do
+        define_method klass do
+          klass_name.to_class.where :"#{self.underscored_class_name}_id" => self.id
+        end
+      end
+    end
+  end
+end

data/lib/csv_record/document.rb

@@ -1,9 +1,12 @@
+require 'active_support/core_ext/string/inflections.rb'
+
 require 'csv_record/connector'
 require 'csv_record/writer'
 require 'csv_record/reader'
 require 'csv_record/timestamps'
 require 'csv_record/callbacks'
 require 'csv_record/helpers'
+require 'csv_record/associations'
 
 module CsvRecord
 
@@ -11,21 +14,19 @@ module CsvRecord
   # the database.
   module Document
     def self.included(receiver)
-      self.const_set('DATABASE_LOCATION',"db/#{parse_caller(caller[1]).downcase}.csv")
-      self.const_set('DATABASE_LOCATION_TMP',"db/#{parse_caller(caller[1]).downcase}_tmp.csv")
+      klass = receiver.name
+
+      receiver.const_set 'DATABASE_LOCATION',"db/#{klass.underscore.pluralize}.csv"
+      receiver.const_set 'DATABASE_LOCATION_TMP',"db/#{klass.underscore.pluralize}_tmp.csv"
 
       receiver.extend         CsvRecord::Connector
       receiver.extend         CsvRecord::Writer::ClassMethods
       receiver.extend         CsvRecord::Reader::ClassMethods
+      receiver.extend         CsvRecord::Associations
       receiver.send :include, CsvRecord::Writer::InstanceMethods
       receiver.send :include, CsvRecord::Reader::InstanceMethods
       receiver.send :include, CsvRecord::Timestamps
       receiver.send :include, CsvRecord::Callbacks
     end
-
-    def self.parse_caller(at)
-      /(?:(\<class\:)(\w+))/ =~ at
-      $2
-    end
   end
 end

data/lib/csv_record/helpers.rb

@@ -8,4 +8,28 @@ class Object
     self.to_s =~ /^\d+\.\d+$/
     !$0.empty?
   end
+
+  def to_param
+    self
+  end
+
+  def underscored_class_name
+    self.class.name.underscore
+  end
+end
+
+class String
+  def constantize
+    self.split('_').map {|w| w.capitalize}.join
+  end
+  def to_class
+    Object.const_get self.constantize.singularize
+  end
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
 end

data/lib/csv_record/reader.rb

@@ -7,12 +7,12 @@ module CsvRecord
         inst = new
         params.each do |key, value|
           inst.public_send("#{key}=", value)
-        end
+        end if params
         inst
       end
 
       def __fields__
-        instance_methods(false).select { |m| m.to_s !~ /=$/ }
+        @relevant_instance_variables
       end
 
       def all
@@ -35,9 +35,8 @@ module CsvRecord
         end
       end
 
-      def __find__(param)
-        param = param.id unless param.is_a? Integer
-        (__where__ id: param).first
+      def __find__(condition)
+        (__where__ id: condition.to_param).first
       end
 
       def __where__(params)
@@ -102,8 +101,13 @@ module CsvRecord
         Hash[self.class.fields.zip self.values]
       end
 
+      def __to_param__
+        self.id
+      end
+
       alias :attributes :__attributes__
       alias :values :__values__
+      alias :to_param :__to_param__
     end
   end
 end

data/lib/csv_record/version.rb

@@ -1,3 +1,3 @@
 module CsvRecord
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/csv_record/writer.rb

@@ -1,5 +1,3 @@
-require 'csv'
-
 module CsvRecord
   module Writer
     module ClassMethods
@@ -11,6 +9,14 @@ module CsvRecord
         instance
       end
 
+      [:attr_accessor, :attr_writer].each do |custom_accessor|
+        define_method custom_accessor do |*args|
+          @relevant_instance_variables ||= []
+          args.each { |arg| @relevant_instance_variables << arg }
+          super *args
+        end
+      end
+
       alias :create :__create__
     end
 
@@ -53,6 +59,9 @@ module CsvRecord
 
       def calculate_id
         @id = self.class.count + 1
+        # if self.respond_to? :jedi_order_id
+        #   p "#{self.class} -> #{@id} -> #{self.jedi_order_id}"
+        # end
       end
 
       def append_registry

data/test/csv_record/associations_test.rb

@@ -0,0 +1,48 @@
+require_relative '../test_helper'
+
+require_relative '../models/jedi'
+require_relative '../models/jedi_order'
+
+describe CsvRecord::Associations do
+  describe 'initializing class methods' do
+    it ('responds to belongs_to') { Jedi.must_respond_to :belongs_to }
+    it ('responds to jedi_order') { Jedi.new.must_respond_to :jedi_order }
+    it ('responds to jedi_order=') { Jedi.new.must_respond_to :jedi_order= }
+    it ('responds to jedi_order_id') { Jedi.new.must_respond_to :jedi_order_id }
+    it ('responds to has_many') { JediOrder.must_respond_to :has_many }
+  end
+
+  describe 'belongs_to behavior' do
+    it 'checking to param extraction' do
+      jedi_council.save
+      luke.save
+      luke.jedi_order = jedi_council
+      luke.jedi_order_id.wont_be_nil
+      luke.jedi_order_id.must_be_instance_of Fixnum
+      luke.jedi_order_id.must_equal 1
+    end
+
+    it 'has a single jedi order associated' do
+      jedi_council.save
+      luke.jedi_order = jedi_council
+      luke.save.must_equal true
+      first_jedi = Jedi.first
+      first_jedi.jedi_order.wont_be_nil
+      first_jedi.jedi_order_id.must_be_instance_of Fixnum
+      first_jedi.jedi_order.must_be_instance_of JediOrder
+    end
+  end
+
+  describe 'has_many behavior' do
+    it 'has many jedis associated' do
+      jedi_council.save
+      yoda.jedi_order = jedi_council
+      yoda.save
+      Jedi.create name: 'Qui-Gon Jinn', age: 37, midi_chlorians: '3k', jedi_order: jedi_council
+      luke.save
+      jedis = jedi_council.jedis
+      jedis.count.must_equal 2
+      jedis.first.must_be_instance_of Jedi
+    end
+  end
+end

data/test/csv_record/reader_test.rb

@@ -63,6 +63,13 @@ describe CsvRecord::Reader do
       Car.count.must_equal 2
     end
 
+    it 'checking to_param' do
+      car.save
+      car.to_param.wont_be_nil
+      car.to_param.must_be_instance_of Fixnum
+      car.to_param.must_equal 1
+    end
+
     describe 'simple query' do
       let (:cars) { [] }
 
@@ -118,8 +125,8 @@ describe CsvRecord::Reader do
         result = Car.where year: 2008, make: 'Chevroletion'
         result.must_be_empty
       end
-
     end
+
     describe 'dynamic finders' do
       before do
         car.save

data/test/csv_record/writer_test.rb

@@ -22,7 +22,7 @@ describe CsvRecord::Writer do
 
   describe 'validating the methods behavior' do
     let(:second_car) do
-      Car.new(
+      Car.build(
         year: 2007,
         make: 'Chevrolet',
         model: 'F450',

data/test/models/jedi.rb

@@ -0,0 +1,15 @@
+require 'csv_record'
+
+class Jedi
+  include CsvRecord::Document
+
+  belongs_to :jedi_order
+
+  def initialize(params={})
+    params.each do |key, value|
+      self.public_send("#{key}=", value)
+    end
+  end
+
+  attr_accessor :name, :age, :midi_chlorians
+end

data/test/models/jedi_order.rb

@@ -0,0 +1,15 @@
+require 'csv_record'
+
+class JediOrder
+  include CsvRecord::Document
+
+  has_many :jedis
+
+  def initialize(params={})
+    params.each do |key, value|
+      self.public_send("#{key}=", value)
+    end
+  end
+
+  attr_accessor :rank
+end

data/test/test_helper.rb

@@ -2,6 +2,8 @@ require 'minitest/spec'
 require 'minitest/autorun'
 require 'turn'
 
+require 'csv_record'
+
 module TestHelper
   BASE_PATH = File.expand_path("../fixtures", __FILE__)
 
@@ -24,4 +26,27 @@ class MiniTest::Spec
       price: 3000.00
     )
   end
+
+  let(:jedi_council) { JediOrder.build rank: 'council' }
+  let(:luke) do
+    Jedi.build(
+      name: 'Luke Skywalker',
+      age: 18,
+      midi_chlorians: '12k'
+    )
+  end
+  let(:yoda) do
+    Jedi.build(
+      name: 'Yoda the green',
+      age: 852,
+      midi_chlorians: '8k'
+    )
+  end
+  let(:qui_gon_jinn) do
+    Jedi.build(
+      name: 'Qui-Gon Jinn',
+      age: 37,
+      midi_chlorians: '3k'
+    )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_record
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +90,7 @@ files:
 - Rakefile
 - csv_record.gemspec
 - lib/csv_record.rb
+- lib/csv_record/associations.rb
 - lib/csv_record/callbacks.rb
 - lib/csv_record/connector.rb
 - lib/csv_record/document.rb
@@ -82,6 +99,7 @@ files:
 - lib/csv_record/timestamps.rb
 - lib/csv_record/version.rb
 - lib/csv_record/writer.rb
+- test/csv_record/associations_test.rb
 - test/csv_record/callbacks_test.rb
 - test/csv_record/connector_test.rb
 - test/csv_record/csv_record_test.rb
@@ -92,6 +110,8 @@ files:
 - test/csv_record/writer_test.rb
 - test/models/callback_test_class.rb
 - test/models/car.rb
+- test/models/jedi.rb
+- test/models/jedi_order.rb
 - test/test_helper.rb
 homepage: https://github.com/lukasalexandre/csv_record
 licenses: []
@@ -119,6 +139,7 @@ specification_version: 3
 summary: CSV Record connects Ruby classes to CSV documents database to establish an
   almost zero-configuration persistence layer for applications.
 test_files:
+- test/csv_record/associations_test.rb
 - test/csv_record/callbacks_test.rb
 - test/csv_record/connector_test.rb
 - test/csv_record/csv_record_test.rb
@@ -129,4 +150,6 @@ test_files:
 - test/csv_record/writer_test.rb
 - test/models/callback_test_class.rb
 - test/models/car.rb
+- test/models/jedi.rb
+- test/models/jedi_order.rb
 - test/test_helper.rb