csv_record 2.1.2 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b56ddc51a9bc473b810efc0342ede311cf20fc01
+  data.tar.gz: 26a034a21daf07b878aa68ace0668ca689a567e9
+SHA512:
+  metadata.gz: 1f849ebfc371659527501acc487df4c0a78d001edb8deb5027c242369bce46aef9cbfd0f7c94265fa8070972d99678204a8243adf59c876545d68032f652acac
+  data.tar.gz: 6a934c1164d1ea2605bc4884b82efbe355b210cbb434d772c1a825a2c0a69e9f1873f91f34dd386af94cef2191867bb18bb350d16861f1b8aa9baae8b31e8ecc

data/.ruby-gemset

@@ -0,0 +1 @@
+csv_record

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.2

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3

data/README.md

@@ -1,10 +1,14 @@
 # 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)
+[![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.
+CSV Record connects Ruby classes to CSV documents in order to
+establish an almost zero-configuration persistence layer for
+applications.
 
-##Getting Started
+## Getting Started
 
 Add this line to your application's Gemfile:
 
@@ -24,7 +28,8 @@ Or install it yourself as:
 $ gem install csv_record
 ```
 
-And inside your Ruby models just require and include the CSVRecord lib and start using it in the same way as your are used to:
+And inside your Ruby models just require and include the CSVRecord
+lib and start using it in the same way as your are used to:
 
 ```ruby
 require 'csv_record'
@@ -36,27 +41,28 @@ class Jedi
 end
 ```
 
-##Persistance
-To persist the data objects created in your application your can use the following methods:
+## Persistence
+To persist the data objects created in your application you can
+use the following methods:
 
 ```ruby
-Jedi.create( # save the new record in the database
+Jedi.create( # save the new record in its CSV file
   name: 'Luke Skywalker',
   age: 18,
   midi_chlorians: '12k'
 )
 
-jedi.save # save the record in the database (either creating or changing)
+jedi.save # save the record in its CSV file (either creating or changing)
 
 jedi.update_attribute :age, 29 # update a single field of an object
 jedi.update_attributes age: 29, midi_chlorians: '18k' # update multiple fields at the same time
 
-jedi.destroy # removes the record from the database
+jedi.destroy # removes the record from its CSV file
 
 jedi.new_record? # checks if the record is new
 ```
 
-##Querying
+## Querying
 Records can be queried through the following methods:
 
 ```ruby
@@ -70,10 +76,10 @@ Jedi.find_by_name_and_age 'Luke Skywalker', 18 # find dynamically with multiple
 
 Jedi.where age: 18, name: 'Luke Skywalker', midi_chlorians: '12k' # find with a multiple parameters hash
 
-Jedi.count # returns the amount of records in the database
+Jedi.count # returns the amount of records in its CSV file
 
-Jedi.first # retrieves the first record in the database
-Jedi.last # retrieves the last record in the database
+Jedi.first # retrieves the first record in its CSV file
+Jedi.last # retrieves the last record in its CSV file
 ```
 
 Lazy querying is the default behavior now Yey!!
@@ -85,8 +91,8 @@ query # #<CsvRecord::Query:0x007fdff3d31aa0>
 query.first # #<Jedi:0x007f9df6cea478>
 ```
 
-##Associations
-###Belongs To
+## Associations
+### Belongs To
 A Belongs To association can be declared through the following method:
 
 ```ruby
@@ -117,7 +123,7 @@ jedi.save
 jedi.jedi_order # #<JediOrder:0x007f9b249b24d8>
 ```
 
-###Has Many
+### Has Many
 Extending the previous example, you can use the `has_many` method to establish the inverse relationship:
 
 ```ruby
@@ -137,7 +143,7 @@ jedi.save
 jedi_order.jedis # [#<Jedi:0x007f9b249b24d8>]
 ```
 
-###Has One
+### Has One
 The same as has_many but limited to one associated record.
 
 ```ruby
@@ -164,11 +170,11 @@ jedi.padawan = padawan
 jedi.padawan # #<Padawan:0x007f9b249b24d8>
 ```
 
-##Callbacks
-###Overview
+## Callbacks
+### Overview
 Callbacks can be used to execute code on predetermined moments.
 
-####Usage
+#### Usage
 ```ruby
 after_create do
   # learn the way of the force
@@ -176,14 +182,14 @@ end
 ```
 `self` refers to the instance you are in
 
-###Avaiable Callbacks
+### Available 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:
 
-####Finding an Object
+#### Finding an Object
 * after_initialize
 * after_find
 
-####Creating an Object
+#### Creating an Object
 * after_initialize
 * before_validation
 * after_validation
@@ -192,7 +198,7 @@ Here is a list with all the available callbacks, listed in the same order in whi
 * after_create
 * after_save
 
-####Updating an Object
+#### Updating an Object
 * before_validation
 * after_validation
 * before_save
@@ -200,16 +206,16 @@ Here is a list with all the available callbacks, listed in the same order in whi
 * after_update
 * after_save
 
-####Destroying an Object
+#### Destroying an Object
 * before_destroy
 * after_destroy
 
-##Validations
-###Helpers available:
+## Validations
+### Helpers available:
 
 `validates_presence_of`: Ensures if the specified attribute(s) were filled
 
-`validates_uniqueness_of`: Ensures that the specified attribute(s) are unique within the database
+`validates_uniqueness_of`: Ensures that the specified attribute(s) are unique within its CSV file
 
 `validate`: Uses custom method(s) to validate the model
 
@@ -240,30 +246,36 @@ jedi.invalid? # => true
 jedi.save # => false
 ```
 
-##Customizations
+## Customizations
 
-Someday you might want to go "out of the rail" that we propose. Here is what you can do now:
+Someday you might want to go "out of the rail" that we propose.
+Here is what you can do now:
 
-###Changing the table_name
+### Changing the table_name
 ```ruby
 store_as :wierd_table_name
 ```
-###Changing the field column name
+### Changing the field column name
 ```ruby
 mapping :name => :wierd_field
 ```
 
-##Bug reports
+## Bug reports
 
-If you discover a problem with CSV_Record, we would like to know about it. Please let us know on the project issues page.
+If you discover a problem with CSV_Record, we would like to know
+about it. Please let us know on the project issues page.
 
-##Contributing
+## Contributing
 
-We hope that you will consider contributing to CSV_Record. Please read this short overview for some information about how to get started:
+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/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.
+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.
 
-##Precautions
-CsvRecord creates a `db` folder in the root of your application. Be sure that it has permission to do so.
+## Precautions
+CsvRecord creates a `db` folder in the root of your application.
+Be sure that it has permission to do so.

data/Rakefile

@@ -9,4 +9,4 @@ Rake::TestTask.new do |t|
 end
 
 desc "Run tests"
-task default: :test
+task default: :test

data/csv_record.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/csv_record/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -17,10 +16,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CsvRecord::VERSION
 
-  gem.add_dependency 'activesupport', '~> 3.2.9'
+  gem.add_dependency 'activesupport', '~> 0'
 
-  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'
+  gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'timecop', '~> 0'
+  gem.add_development_dependency 'turn', '~> 0'
+  gem.add_development_dependency 'minitest', '~> 0'
+  gem.add_development_dependency 'pry', '~> 0'
+  gem.add_development_dependency 'pry-nav', '~> 0'
+  gem.add_development_dependency 'm', '~> 0'
 end

data/lib/csv_record.rb

@@ -1,26 +1,3 @@
-#--
-# Copyright (c) 2012 Lukas Alexandre
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
 require 'csv'
 
 require 'csv_record/version'

data/lib/csv_record/associations.rb

@@ -36,4 +36,4 @@ module CsvRecord::Associations
       end
     end
   end
-end
+end

data/lib/csv_record/callback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CsvRecord::Callback
   attr_accessor :kind, :code
 
@@ -7,6 +9,6 @@ class CsvRecord::Callback
   end
 
   def run_on(obj)
-    obj.instance_eval &self.code
+    obj.instance_eval(&self.code)
   end
-end
+end

data/lib/csv_record/callbacks.rb

@@ -1,4 +1,6 @@
-require 'csv_record/callback'
+# frozen_string_literal: true
+
+require_relative 'callback'
 
 module CsvRecord::Callbacks
   CALLBACK_TYPES = [
@@ -22,7 +24,7 @@ module CsvRecord::Callbacks
         const_variable = "#{callback_type}_callbacks".upcase
         const_set(const_variable, []) unless const_defined? const_variable
         if block
-          const_get(const_variable) << (CsvRecord::Callback.new callback_type, block)
+          const_get(const_variable) << CsvRecord::Callback.new(callback_type, block)
         end
       end
     end
@@ -35,9 +37,9 @@ module CsvRecord::Callbacks
   end
 
   module InstanceMethods
-    CALLBACK_TYPES.each do |callback|
-      define_method "run_#{callback}_callbacks" do
-        const_variable = "#{callback}_callbacks".upcase
+    CALLBACK_TYPES.each do |type|
+      define_method "run_#{type}_callbacks" do
+        const_variable = "#{type}_callbacks".upcase
         if self.class.const_defined? const_variable
           callbacks_collection = self.class.const_get const_variable
           callbacks_collection.each do |callback|
@@ -49,45 +51,45 @@ module CsvRecord::Callbacks
 
     [:build, :initialize].each do |initialize_method|
       define_method initialize_method do |*args|
-        result = super *args
-        self.run_after_initialize_callbacks
+        result = super(*args)
+        run_after_initialize_callbacks
         result
       end
     end
 
     def valid?
-      self.run_before_validation_callbacks
+      run_before_validation_callbacks
       is_valid = super
-      self.run_after_validation_callbacks if is_valid
+      run_after_validation_callbacks if is_valid
       is_valid
     end
 
     def destroy
-      self.run_before_destroy_callbacks
+      run_before_destroy_callbacks
       is_destroyed = super
-      self.run_after_destroy_callbacks if is_destroyed
+      run_after_destroy_callbacks if is_destroyed
       is_destroyed
     end
 
     def save(*args)
-      self.run_before_save_callbacks
+      run_before_save_callbacks
       is_saved = super
-      self.run_after_save_callbacks if is_saved
+      run_after_save_callbacks if is_saved
       is_saved
     end
 
     def append_registry
-      self.run_before_create_callbacks
+      run_before_create_callbacks
       is_saved = super
-      self.run_after_create_callbacks if is_saved
+      run_after_create_callbacks if is_saved
       is_saved
     end
 
     def update_registry
-      self.run_before_update_callbacks
+      run_before_update_callbacks
       saved = super
-      self.run_after_destroy_callbacks if saved
-      self.run_after_update_callbacks if saved
+      run_after_destroy_callbacks if saved
+      run_after_update_callbacks if saved
       saved
     end
   end
@@ -96,4 +98,4 @@ module CsvRecord::Callbacks
     receiver.extend ClassMethods
     receiver.send :include, InstanceMethods
   end
-end
+end

data/lib/csv_record/{csv_queries/condition.rb → condition.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CsvRecord::Condition
   attr_reader :field, :value
 
@@ -8,11 +10,11 @@ class CsvRecord::Condition
 
   def self.create_from_hashes(hashes)
     hashes.map do |hash|
-      new *hash
+      new(*hash)
     end
   end
 
   def to_code
     "attributes['#{@field}'] == '#{@value}'"
   end
-end
+end

data/lib/csv_record/connector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CsvRecord::Connector
   DATABASE_FOLDER = 'db'.freeze
   APPEND_MODE = 'a'.freeze
@@ -6,7 +8,7 @@ module CsvRecord::Connector
 
   # Checks wheter the database directory exists
   def __initialize_db_directory__
-    unless Dir.exists? DATABASE_FOLDER
+    unless Dir.exist?(DATABASE_FOLDER)
       Dir.mkdir DATABASE_FOLDER
     end
   end
@@ -15,7 +17,7 @@ module CsvRecord::Connector
   def __initialize_db__
     __initialize_db_directory__
     unless db_initialized?
-      open_database_file WRITE_MODE do |csv|
+      open_database_file(WRITE_MODE) do |csv|
         csv << doppelganger_fields
       end
     end
@@ -23,7 +25,7 @@ module CsvRecord::Connector
 
   # 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
@@ -43,7 +45,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
@@ -51,13 +53,13 @@ module CsvRecord::Connector
     rename_database
   end
 
-  protected
+  private
 
   # 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'
-    while not File.exists?(old_file) ; sleep(10) ; end
+    while not File.exist?(old_file) ; sleep(10) ; end
     File.delete old_file
     File.rename tmp_file, old_file
   end
@@ -66,4 +68,4 @@ module CsvRecord::Connector
   alias :initialize_db :__initialize_db__
   alias :open_database_file :__open_database_file__
   alias :parse_database_file :__parse_database_file__
-end
+end