csv_record 2.0.0 → 2.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rvmrc

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
+  - 1.9.2
   - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,6 +1,6 @@
 # CsvRecord
 
-[[![Build Status](https://travis-ci.org/lukelex/csv_record.png?branch=2.0.0)](https://travis-ci.org/lukelex/csv_record) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/lukelex/csv_record) [![Dependency Status](https://gemnasium.com/lukasalexandre/csv_record.png)](https://gemnasium.com/lukasalexandre/csv_record) [![Gem Version](https://fury-badge.herokuapp.com/rb/csv_record.png)](http://badge.fury.io/rb/csv_record)
+[![Build Status](https://travis-ci.org/lukelex/csv_record.png?branch=2.0.0)](https://travis-ci.org/lukelex/csv_record) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/lukelex/csv_record) [![Dependency Status](https://gemnasium.com/lukasalexandre/csv_record.png)](https://gemnasium.com/lukasalexandre/csv_record) [![Gem Version](https://fury-badge.herokuapp.com/rb/csv_record.png)](http://badge.fury.io/rb/csv_record)
 
 
 CSV Record connects Ruby classes to CSV documents database to establish an almost zero-configuration persistence layer for applications.
@@ -11,7 +11,7 @@ CSV Record connects Ruby classes to CSV documents database to establish an almos
 
 The CSV_Record Wiki has lots of additional information about CSV_Record. Please browse the Wiki after finishing this README:
 
-wiki.github.com/lukasalexandre/csv_record
+https://github.com/lukelex/csv_record/wiki
 
 ##Bug reports
 
@@ -21,7 +21,7 @@ If you discover a problem with CSV_Record, we would like to know about it. Howev
 
 We hope that you will consider contributing to CSV_Record. Please read this short overview for some information about how to get started:
 
-https://github.com/lukasalexandre/csv_record/wiki/Contributing
+https://github.com/lukelex/csv_record/wiki/Contributing
 
 You will usually want to write tests for your changes. To run the test suite, go into CSV_Record's top-level directory and run "bundle install" and "rake". For the tests to pass.
 

data/Rakefile

@@ -5,7 +5,7 @@ require "rake/testtask"
 Rake::TestTask.new do |t|
   t.libs.push "lib"
   t.test_files = FileList['test/csv_record/*_test.rb', 'test/monkey_patches/*_test.rb']
-  t.verbose = true
+  t.verbose = false
 end
 
 desc "Run tests"

data/csv_record.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["lukasalexandre@gmail.com"]
   gem.description   = %q{CSV Object-relational mapping for Ruby}
   gem.summary       = %q{CSV Record connects Ruby classes to CSV documents database to establish an almost zero-configuration persistence layer for applications.}
-  gem.homepage      = "https://github.com/lukasalexandre/csv_record"
+  gem.homepage      = "https://github.com/lukelex/csv_record"
 
   gem.license = 'MIT'
 
@@ -17,11 +17,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CsvRecord::VERSION
 
-  gem.add_dependency 'activesupport'
+  gem.add_dependency 'activesupport', '~> 3.2.9'
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'timecop'
-  gem.add_development_dependency 'turn'
-  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rake', '~> 0.9.2.2'
+  gem.add_development_dependency 'timecop', '~> 0.5.3'
+  gem.add_development_dependency 'turn', '~> 0.9.6'
+  gem.add_development_dependency 'minitest', '~> 4.3.1'
 end

data/lib/csv_record/callbacks.rb

@@ -39,9 +39,9 @@ module CsvRecord::Callbacks
       define_method "run_#{callback}_callbacks" do
         const_variable = "#{callback}_callbacks".upcase
         if self.class.const_defined? const_variable
-          callbacks_collection = self.class.const_get(const_variable)
+          callbacks_collection = self.class.const_get const_variable
           callbacks_collection.each do |callback|
-            callback.run_on(self)
+            callback.run_on self
           end
         end
       end
@@ -49,7 +49,7 @@ module CsvRecord::Callbacks
 
     [:build, :initialize].each do |initialize_method|
       define_method initialize_method do |*args|
-        result = super(*args)
+        result = super *args
         self.run_after_initialize_callbacks
         result
       end

data/lib/csv_record/connector.rb

@@ -16,14 +16,14 @@ module CsvRecord::Connector
     __initialize_db_directory__
     unless db_initialized?
       open_database_file WRITE_MODE do |csv|
-        csv << fields
+        csv << doppelganger_fields
       end
     end
   end
 
   # Checks wheter the database file exists
   def db_initialized?
-    File.exist? self.const_get('DATABASE_LOCATION')
+    File.exist? self.const_get 'DATABASE_LOCATION'
   end
 
   # Open the database file
@@ -32,7 +32,7 @@ module CsvRecord::Connector
   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)
+      yield csv
     end
   end
 
@@ -42,7 +42,7 @@ module CsvRecord::Connector
       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)
+          new_row = yield entry
           copy << new_row if new_row
         end
       end
@@ -54,10 +54,10 @@ module CsvRecord::Connector
 
   # Rename the TMP database file to replace the original
   def rename_database
-    old_file = self.const_get('DATABASE_LOCATION')
-    tmp_file = self.const_get('DATABASE_LOCATION_TMP')
+    old_file = self.const_get 'DATABASE_LOCATION'
+    tmp_file = self.const_get 'DATABASE_LOCATION_TMP'
     File.delete old_file
-    File.rename(tmp_file, old_file)
+    File.rename tmp_file, old_file
   end
 
   alias :initialize_db_directory :__initialize_db_directory__

data/lib/csv_record/csv_fields.rb

@@ -0,0 +1,45 @@
+class CsvRecord::CsvFields
+  include Enumerable
+
+  def fields
+    @fields ||= []
+  end
+
+  def <<(field)
+    self.fields << field
+  end
+
+  def include?(field)
+    self.has_doppelganger? field
+  end
+
+  [:name, :doppelganger].each do |attribute|
+    define_method "has_#{attribute}?" do |field|
+      self.fields.any? do |field_model|
+        field_model.public_send(attribute) == field
+      end
+    end
+  end
+
+  def find_with_doppelganger(doppelganger)
+    self.fields.select do |field|
+      field.is? doppelganger
+    end.first
+  end
+
+  def each(&block)
+    self.fields.each &block
+  end
+
+  def method_missing(meth, *args, &block)
+    if self.to_a.respond_to? meth
+      self.to_a.public_send meth, *args, &block
+    else
+      super # You *must* call super if you don't handle the
+            # method, otherwise you'll mess up Ruby's method
+            # lookup.
+    end
+  end
+
+  alias :add :<<
+end

data/lib/csv_record/csv_queries/query.rb

@@ -39,7 +39,7 @@ class CsvRecord::Query
   end
 
   def each(&block)
-    to_a.each(&block)
+    to_a.each &block
   end
 
   def empty?

data/lib/csv_record/{reader.rb → csv_readers/class_reader.rb}

@@ -1,4 +1,4 @@
-require_relative 'csv_queries/query'
+require 'csv_record/csv_queries/query'
 
 module CsvRecord::Reader
   module ClassMethods
@@ -7,13 +7,20 @@ module CsvRecord::Reader
     def build(params={})
       inst = new
       params.each do |key, value|
-        inst.public_send("#{key}=", value)
+        attribute = fields.find_with_doppelganger(key)
+        attr_name = attribute ? attribute.name : key
+        inst.public_send "#{attr_name}=", value
       end if params
+      yield inst if block_given?
       inst
     end
 
     def __fields__
-      @relevant_instance_variables
+      @fields ||= CsvRecord::CsvFields.new
+    end
+
+    def __doppelganger_fields__
+      self.__fields__.map &:doppelganger
     end
 
     def all
@@ -70,31 +77,6 @@ module CsvRecord::Reader
     alias :find :__find__
     alias :count :__count__
     alias :where :__where__
-  end
-
-  module InstanceMethods
-    def __values__
-      self.class.fields.map { |attribute| self.public_send(attribute) }
-    end
-
-    def __attributes__
-      Hash[self.class.fields.zip self.values]
-    end
-
-    def __to_param__
-      self.id.to_s
-    end
-
-    def ==(obj)
-      self.class == obj.class and 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__
+    alias :doppelganger_fields :__doppelganger_fields__
   end
 end

data/lib/csv_record/csv_readers/instance_reader.rb

@@ -0,0 +1,29 @@
+module CsvRecord::Reader
+  module InstanceMethods
+    def __values__
+      self.class.fields.map do |attribute|
+        self.public_send attribute.name
+      end
+    end
+
+    def __attributes__
+      Hash[self.class.fields.zip self.values]
+    end
+
+    def __to_param__
+      self.id.to_s
+    end
+
+    def ==(obj)
+      self.class == obj.class and 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__
+  end
+end

data/lib/csv_record/csv_readers/reader.rb

@@ -0,0 +1,9 @@
+require 'csv_record/csv_readers/class_reader'
+require 'csv_record/csv_readers/instance_reader'
+
+module CsvRecord::Reader
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/csv_record/csv_validations/custom_validation.rb

@@ -7,7 +7,7 @@ class CsvRecord::CustomValidation
 
   def run_on(obj)
     if self.message.is_a? Proc
-      obj.instance_eval &(self.message)
+      obj.instance_eval &self.message
     else
       obj.send self.message
     end

data/lib/csv_record/csv_validations/validations.rb

@@ -20,7 +20,7 @@ module CsvRecord::Validations
       define_method "__#{class_macro}__" do |*field_names|
         field_names.each do |field|
           validation_obj = validation_class_name.new field
-          self.public_send("add_to_#{validator_collection}", validation_obj)
+          self.public_send "add_to_#{validator_collection}", validation_obj
         end
       end
 
@@ -55,7 +55,7 @@ module CsvRecord::Validations
     def errors
       unless @errors
         @errors = []
-        def @errors.add(attribute)
+        def @errors.add attribute
           self << attribute
         end
       end

data/lib/csv_record/csv_writers/class_writer.rb

@@ -0,0 +1,52 @@
+module CsvRecord::Writer
+  module ClassMethods
+    def __create__(attributes={})
+      instance = self.build attributes
+      yield instance if block_given?
+      result = instance.save
+      instance
+    end
+
+    [:attr_accessor, :attr_writer].each do |custom_accessor|
+      define_method custom_accessor do |*attributes|
+        attributes.each do |attribute|
+          unless self.fields.has_name? attribute
+            self.fields << CsvRecord::Field.new(attribute)
+          end
+        end
+        super *attributes
+      end
+    end
+
+    def store_as(name)
+      @table_name = name.to_s.underscore.pluralize
+      redefine_database_location
+
+      @table_name
+    end
+
+    def table_name
+      @table_name ||= store_as name
+    end
+
+    def mapping(config=[])
+      config.each do |field, doppelganger|
+        unless self.fields.include? field
+          self.fields << (CsvRecord::Field.new field, doppelganger)
+        end
+      end
+    end
+
+    def redefine_database_location
+      if const_defined?('DATABASE_LOCATION') || const_defined?('DATABASE_LOCATION_TMP')
+        send :remove_const, 'DATABASE_LOCATION'
+        send :remove_const, 'DATABASE_LOCATION_TMP'
+      end
+
+      const_set 'DATABASE_LOCATION', "db/#{@table_name}.csv"
+      const_set 'DATABASE_LOCATION_TMP', "db/#{@table_name}_tmp.csv"
+    end
+
+    alias :create :__create__
+  end
+end

data/lib/csv_record/{writer.rb → csv_writers/instance_writer.rb}

@@ -1,22 +1,4 @@
 module CsvRecord::Writer
-  module ClassMethods
-    def __create__(attributes={})
-      instance = self.build attributes
-      result = instance.save
-      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
-
   module InstanceMethods
     def self.included(receiver)
       receiver.send :attr_accessor, :id
@@ -41,11 +23,14 @@ module CsvRecord::Writer
 
     def __update_attributes__(params={validate: true})
       validate = params[:validate]
-      params.delete(:validate)
+      params.delete :validate
 
       params.each do |field, value|
         self.public_send "#{field}=", value
       end
+
+      yield self if block_given?
+
       self.save validate
     end
 
@@ -66,12 +51,10 @@ module CsvRecord::Writer
     end
 
     def append_registry
-      set_created_at
       write_object
     end
 
     def update_registry
-      set_updated_at
       self.class.parse_database_file do |row|
         new_row = row
         new_row = self.values if self.id.to_i == row.field('id').to_i

data/lib/csv_record/csv_writers/writer.rb

@@ -0,0 +1,9 @@
+require 'csv_record/csv_writers/instance_writer'
+require 'csv_record/csv_writers/class_writer'
+
+module CsvRecord::Writer
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/csv_record/document.rb

@@ -1,32 +1,31 @@
 require 'active_support/core_ext/string/inflections.rb'
 
 require 'csv_record/connector'
-require 'csv_record/writer'
-require 'csv_record/reader'
+require 'csv_record/csv_writers/writer'
+require 'csv_record/csv_readers/reader'
 require 'csv_record/timestamps'
 require 'csv_record/callbacks'
 require 'csv_record/helpers'
 require 'csv_record/associations'
 require 'csv_record/csv_validations/validations'
 
+require 'csv_record/csv_fields'
+require 'csv_record/field'
+require 'csv_record/exceptions'
+
 # This is the base module for all domain objects that need to be persisted to
 # the database.
 module CsvRecord::Document
   def self.included(receiver)
-    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.extend         CsvRecord::Validations::ClassMethods
-    receiver.send :include, CsvRecord::Writer::InstanceMethods
-    receiver.send :include, CsvRecord::Reader::InstanceMethods
-    receiver.send :include, CsvRecord::Timestamps
+    receiver.send :include, CsvRecord::Reader
+    receiver.send :include, CsvRecord::Writer
     receiver.send :include, CsvRecord::Validations::InstanceMethods
     receiver.send :include, CsvRecord::Callbacks
+    receiver.send :include, CsvRecord::Timestamps
+
+    receiver.store_as receiver.name
   end
 end

data/lib/csv_record/exceptions.rb

@@ -0,0 +1 @@
+class UndefienedCsvField < Exception ; end

data/lib/csv_record/field.rb

@@ -0,0 +1,21 @@
+class CsvRecord::Field
+  attr_reader :name, :doppelganger
+
+  def initialize(name, doppelganger=nil)
+    @name = name
+    @doppelganger = doppelganger
+  end
+
+  def doppelganger
+    @doppelganger || @name
+  end
+
+  def to_s
+    self.name.to_s
+  end
+
+  def is?(value)
+    self.doppelganger.to_sym == value.to_sym ||
+      self.name.to_sym == value.to_sym
+  end
+end

data/lib/csv_record/helpers.rb

@@ -20,7 +20,7 @@ end
 
 class String
   def constantize
-    self.split('_').map {|w| w.capitalize}.join
+    self.split('_').map { |w| w.capitalize }.join
   end
   def to_class
     Object.const_get self.constantize.singularize

data/lib/csv_record/timestamps.rb

@@ -2,8 +2,17 @@
 # timestamp.
 module CsvRecord::Timestamps
   def self.included(receiver)
-    receiver.send :attr_accessor, :created_at
-    receiver.send :attr_accessor, :updated_at
+    receiver.class_eval do
+      attr_accessor :created_at, :updated_at
+
+      before_create do
+        set_created_at
+      end
+
+      after_update do
+        set_updated_at
+      end
+    end
   end
 
 private

data/lib/csv_record/version.rb

@@ -1,3 +1,6 @@
 module CsvRecord
-  VERSION = '2.0.0'
+  MAJOR = 2
+  MINOR = 1
+  PATCH = 0
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end

data/test/csv_record/associations_test.rb

@@ -1,7 +1,4 @@
 require_relative '../test_helper'
-require_relative '../models/jedi'
-require_relative '../models/jedi_order'
-require_relative '../models/padawan'
 
 describe CsvRecord::Associations do
   describe 'belongs_to' do

data/test/csv_record/callbacks_test.rb

@@ -1,5 +1,4 @@
 require_relative '../test_helper'
-require_relative '../models/callback_test_class'
 
 describe CsvRecord::Callbacks do
   describe "Check the callback definitions" do

data/test/csv_record/connector_test.rb

@@ -1,7 +1,5 @@
 require_relative '../test_helper'
 
-require_relative '../models/jedi'
-
 describe CsvRecord::Connector do
   describe 'initializing methods' do
     it ('responds to initialize_db_directory') { Jedi.must_respond_to :initialize_db_directory }

data/test/csv_record/helpers_test.rb

@@ -1,7 +1,6 @@
 require_relative '../test_helper'
 
 describe 'CsvRecord::Helpers' do
-
   it 'check if a string is an integer' do
     '2000'.integer?.must_equal true
   end

data/test/csv_record/query_test.rb

@@ -1,5 +1,4 @@
 require_relative '../test_helper'
-require_relative '../models/jedi'
 
 describe CsvRecord::Query do
   let (:query) { CsvRecord::Query.new Jedi, age: 37 }