active_importer 0.2.4 → 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6daa340c010143c7efa4f1f94cb5cb1778c13bf
+  data.tar.gz: a45ede6787d0fee8563973292bd2456133b61ae8
+SHA512:
+  metadata.gz: 974291103c95864dc5409fa19544fd135ff1485b559193f779a7243e6abd42185ff80d602a6d868b9cc625b7d265a6e06e2e2cf5984e395645e7e4b845631931
+  data.tar.gz: 608cf19443e5e470d600cb41f0e966cacc53c563a5b68ebaa3e6d93ad4116982e9fb5273fba199ae414fbf43211c7b25894459ce83b55b040da0b689e7d0b0a5

data/README.md

@@ -48,168 +48,38 @@ columns declared.  Any extra columns are ignored.  Any errors while processing
 the data file does not interrupt the whole process.  Instead, errors are
 notified via some callbacks defined in the importer (see below).
 
-### Supported formats
+## Documentation
 
-This library currently supports reading from most spreadsheet formats, thanks
-to the wonderfull [roo](https://github.com/Empact/roo) gem.  Specifically, the
-following formats are supported:
+For mote detailed information about the different aspects of importing data
+with `active_importer`, refer to the following sections in the [wiki]().
 
-* OpenOffice
-* Excel
-* Google spreadsheets
-* Excelx
-* LibreOffice
-* CSV
+[wiki]: https://github.com/continuum/active_importer/wiki
 
-The spreadsheet contents are scanned, row by row, until a row is found that
-matches the expect header column, which should contain header cells for all the
-columns declared in the importer.  If no such row is found, the spreadsheet
-processing fails without importing any data.
+### Getting started
 
-If the header row is found, data is scanned from the next row on, until the end
-of the spreadsheet.
+* [Understanding how spreadsheets are parsed](https://github.com/continuum/active_importer/wiki/Understanding-how-spreadsheets-are-parsed)
+* [Mapping columns to attributes](https://github.com/continuum/active_importer/wiki/Mapping-columns-to-attributes)
 
-### Callbacks
+### Diving in
 
-An importer class can define blocks of code acting as callbacks, to be notified
-of certain events that occur while importing the data.
+* [Custom data processing](https://github.com/continuum/active_importer/wiki/Custom-data-processing)
+* [Helper methods](https://github.com/continuum/active_importer/wiki/Helper-methods)
+* [File extension and supported formats](https://github.com/continuum/active_importer/wiki/File-extension-and-supported-formats)
+* [Passing custom parameters](https://github.com/continuum/active_importer/wiki/Custom-parameters)
+* [Events and callbacks](https://github.com/continuum/active_importer/wiki/Callbacks)
+* [Selecting the model instance to import into (Update instead of create)](https://github.com/continuum/active_importer/wiki/Update-instead-of-create)
+* [Error handling](https://github.com/continuum/active_importer/wiki/Error-handling)
+* [Selecting the sheet to get data from](https://github.com/continuum/active_importer/wiki/Selecting-the-sheet-to-work-with)
+* [Skipping rows](https://github.com/continuum/active_importer/wiki/Skipping-rows)
 
-```ruby
-class EmployeeImporter < ActiveImporter::Base
-  imports Employee
-
-  attr_reader :row_count
-
-  column 'First name'
-  column 'Last name'
-  column 'Department', :department do |department_name|
-    Department.find_by(name: department_name)
-  end
-
-  on :row_processing do
-    model.full_name = [row['First name'], row['Last name']].join(' ')
-  end
-
-  on :import_started do
-    @row_count = 0
-  end
-
-  on :row_processed do
-    @row_count += 1
-  end
-
-  on :import_finished do
-    send_notification("Data imported successfully!")
-  end
+### Advanced features
 
-  on :import_failed do |exception|
-    send_notification("Fatal error while importing data: #{exception.message}")
-  end
-
-  private
-
-  def send_notification(message)
-    # ...
-  end
-end
-```
-
-The supported events are:
-
-- **import_failed:** Fired once **before** the beginning of the data
-  processing, if the input data cannot be processed for some reason.  If this
-  event is fired by an importer, none of its other events are ever fired.
-- **import_started:** Fired once at the beginning of the data processing,
-  before the first row is processed.
-- **row_processing:** Fired while the row is being processed to be imported
-  into a model instance.
-- **row_skipped:** Fired once for each row that matches the `skip_rows_if`
-  condition, if any.
-- **row_processed:** Fired once for each row that has been processed,
-  regardless of whether it resulted in success or error.
-- **row_success:** Fired once for each row that was imported successfully into
-  the data model.
-- **row_error:** Fired once for each row that was **not** imported successfully
-  into the data model.
-- **import_finished:** Fired once **after** all rows have been processed.
-- **import_aborted:** Fired once if the import process is aborted by invoking
-  `abort!`.
-
-More than one block of code can be provided for each of these events, and they
-will all be invoked in the same order in which they were declared.  All blocks
-are executed in the context of the importer instance, so they have access to
-all the importer attributes and instance variables.  Error-related events
-(`:import_failed` and `:row_error`) pass to the blocks the instance of the
-exception that provoked the error condition.
-
-Additionally, all the `row_*` events have access to the `row` and `model`
-variables, which reference the spreadsheet row being processed, and the model
-object where the row data is being stored, respectively.  This feature is
-specifically useful for the `:row_processing` event handler, which is triggered
-while a row is being processed, and before the corresponding data model is
-saved.  This allows to define any complex data-import logic that cannot be
-expressed in terms of mapping a column to a data field.
-
-### Selecting the model instance to import into
-
-By default, the importer will attempt to generate a new model instance per row
-processed.  The importer can be instructed to update records instead, if they
-already exist, instead of always attempting to generate a new one.
-
-```ruby
-class EmployeeImporter
-  imports Employee
-
-  fetch_model do
-    Employee.where(first_name: row['First name'], last_name: row['Last name']).first_or_initialize
-  end
-
-  # ...
-end
-```
-
-The code above specifies that, for each row, the importer should attempt to
-find an existing model for the employee with the first and last name in the row
-being processed.  If this record exist, the row data will be used to update the
-given model instance.  Otherwise, a new employee record will be created.
-
-### Selecting the sheet to get data from
-
-Spreadsheet files often have more than one sheet of data, so it is desirable to
-select which sheet to use when importing.
-
-```ruby
-class EmployeeImporter
-  imports Employee
-
-  sheet "Employees"
-
-  # ...
-end
-```
-
-The importer defined above specifies that data should be read from a sheet
-named "Employees".  By default an importer will read from the first sheet in
-the spreadsheet.
-
-Also, sheets can be specified by name or by index, starting by 1, which is the
-first sheet.  For instance, the following importer will read data from the
-third sheet, no matter what's its name.
-
-```ruby
-class EmployeeImporter
-  imports Employee
-
-  sheet 3
-
-  # ...
-end
-```
+* [Aborting the import process](https://github.com/continuum/active_importer/wiki/Aborting-the-import-process)
+* [Transactional importers](https://github.com/continuum/active_importer/wiki/Transactional-importers)
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Contributions are welcome! Take a look at our [contributions guide][] for
+details.
+
+[contributions guide]: https://github.com/continuum/active_importer/wiki/Contributing

data/active_importer.gemspec

@@ -23,4 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord"
 end

data/lib/active_importer/base.rb

@@ -53,18 +53,64 @@ module ActiveImporter
       @skip_rows_block
     end
 
-    def self.column(title, field = nil, &block)
+    def self.column(title, field = nil, options = nil, &block)
       title = title.strip
       if columns[title]
         raise "Duplicate importer column '#{title}'"
       end
-      columns[title] = { field_name: field, transform: block }
+
+      if field.is_a?(Hash)
+        raise "Invalid column '#{title}': expected a single set of options" unless options.nil?
+        options = field
+        field = nil
+      else
+        options ||= {}
+      end
+
+      if field.nil? && block_given?
+        raise "Invalid column '#{title}': must have a corresponding attribute, or it shouldn't have a block"
+      end
+
+      columns[title] = {
+        field_name: field,
+        transform: block,
+        optional: !!options[:optional],
+      }
     end
 
     def self.import(file, options = {})
       new(file, options).import
     end
 
+    #
+    # Transactions
+    #
+
+    def self.transactional(flag = true)
+      if flag
+        raise "Model class does not support transactions" unless @model_class.respond_to?(:transaction)
+      end
+      @transactional = !!flag
+    end
+
+    def self.transactional?
+      @transactional || false
+    end
+
+    def transactional?
+      @transactional || self.class.transactional?
+    end
+
+    def transaction
+      if transactional?
+        model_class.transaction { yield }
+      else
+        yield
+      end
+    end
+
+    private :transaction
+
     #
     # Callbacks
     #
@@ -117,11 +163,14 @@ module ActiveImporter
     attr_reader :header, :row, :model
     attr_reader :row_count, :row_index
     attr_reader :row_errors
-    attr_reader :context
+    attr_reader :params
 
     def initialize(file, options = {})
       @row_errors = []
-      @context = options.delete(:context)
+      @params = options.delete(:params)
+      @transactional = options.fetch(:transactional, self.class.transactional?)
+
+      raise "Importer is declared transactional at the class level" if !@transactional && self.class.transactional?
 
       @book = Roo::Spreadsheet.open(file, options)
       load_sheet
@@ -134,6 +183,7 @@ module ActiveImporter
       @row_count = 0
       @row_index = 1
       fire_event :import_failed, e
+      raise
     end
 
     def fetch_model_block
@@ -149,21 +199,27 @@ module ActiveImporter
     end
 
     def import
-      return if @book.nil?
-      fire_event :import_started
-      @data_row_indices.each do |index|
-        @row_index = index
-        @row = row_to_hash @book.row(index)
-        if skip_row?
-          fire_event :row_skipped
-          next
-        end
-        import_row
-        if aborted?
-          fire_event :import_aborted, @abort_message
-          break
+      transaction do
+        return if @book.nil?
+        fire_event :import_started
+        @data_row_indices.each do |index|
+          @row_index = index
+          @row = row_to_hash @book.row(index)
+          if skip_row?
+            fire_event :row_skipped
+            next
+          end
+          import_row
+          if aborted?
+            fire_event :import_aborted, @abort_message
+            break
+          end
         end
       end
+    rescue => e
+      fire_event :import_aborted, e.message
+      raise
+    ensure
       fire_event :import_finished
     end
 
@@ -201,9 +257,10 @@ module ActiveImporter
     end
 
     def find_header_index
+      required_column_keys = columns.keys.reject { |title| columns[title][:optional] }
       (1..@book.last_row).each do |index|
         row = @book.row(index).map { |cell| cell.to_s.strip }
-        return index if columns.keys.all? { |item| row.include?(item) }
+        return index if required_column_keys.all? { |item| row.include?(item) }
       end
       return nil
     end
@@ -225,6 +282,7 @@ module ActiveImporter
       rescue => e
         @row_errors << { row_index: row_index, error_message: e.message }
         fire_event :row_error, e
+        raise if transactional?
         return false
       end
       fire_event :row_success

data/lib/active_importer/version.rb

@@ -1,3 +1,3 @@
 module ActiveImporter
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/active_importer/base_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'stubs/employee'
 
 describe ActiveImporter::Base do
   let(:spreadsheet_data) do
@@ -24,9 +23,16 @@ describe ActiveImporter::Base do
   let(:importer) { EmployeeImporter.new('/dummy/file') }
 
   before do
-    expect(Roo::Spreadsheet).to receive(:open).at_least(:once).and_return { Spreadsheet.new(spreadsheet_data) }
+    allow(Roo::Spreadsheet).to receive(:open).at_least(:once).and_return { Spreadsheet.new(spreadsheet_data) }
     EmployeeImporter.instance_variable_set(:@fetch_model_block, nil)
     EmployeeImporter.instance_variable_set(:@sheet_index, nil)
+    EmployeeImporter.transactional(false)
+  end
+
+  describe '.column' do
+    it 'does not allow a column with block and no attribute' do
+      expect { EmployeeImporter.column('Dummy') {} }.to raise_error
+    end
   end
 
   it 'imports all data from the spreadsheet into the model' do
@@ -48,6 +54,28 @@ describe ActiveImporter::Base do
     EmployeeImporter.import('/dummy/file')
   end
 
+  it 'can receive custom parameters via the `params` option' do
+    importer = EmployeeImporter.new('/dummy/file', params: 'anything')
+    expect(importer.params).to eql('anything')
+  end
+
+  context do
+    let(:spreadsheet_data) do
+      [
+        [' Name ', 'Birth Date', 'Department', 'Unused', 'Manager'],
+        ['Mary', '2013-10-25', 'IT', 'hello'],
+        ['John', '2013-10-26', 'Sales', 'world'],
+      ]
+    end
+
+    it 'processes optional columns when present' do
+      expect(EmployeeImporter).to receive(:new).once.and_return(importer)
+      expect {
+        EmployeeImporter.import('/dummy/file')
+      }.to change(Employee.where.not(unused_field: nil), :count).by(2)
+    end
+  end
+
   context do
     let(:spreadsheet_data) { spreadsheet_data_with_errors }
 
@@ -112,7 +140,9 @@ describe ActiveImporter::Base do
 
     it 'notifies the failure' do
       expect_any_instance_of(EmployeeImporter).to receive(:import_failed)
-      EmployeeImporter.import('/dummy/file')
+      expect {
+        EmployeeImporter.import('/dummy/file')
+      }.to raise_error
     end
   end
 
@@ -184,7 +214,9 @@ describe ActiveImporter::Base do
     it 'fails if the specified sheet cannot be found' do
       expect_any_instance_of(EmployeeImporter).to receive(:import_failed)
       EmployeeImporter.sheet 5
-      EmployeeImporter.import('/dummy/file')
+      expect {
+        EmployeeImporter.import('/dummy/file')
+      }.to raise_error
     end
   end
 
@@ -228,4 +260,84 @@ describe ActiveImporter::Base do
       EmployeeImporter.import('/dummy/file')
     end
   end
+
+  describe '#initialize' do
+    context "when invoked with option 'transactional: true'" do
+      it 'declares the instance to be transactional even when the importer class is not' do
+        EmployeeImporter.transactional(false)
+        importer = EmployeeImporter.new('/dummy/file', transactional: true)
+        expect(importer).to be_transactional
+      end
+    end
+
+    context "when invoked with option 'transactional: false'" do
+      it 'does not override the class-wide setting' do
+        EmployeeImporter.transactional(true)
+        expect_any_instance_of(EmployeeImporter).to receive(:import_failed)
+        expect {
+          EmployeeImporter.new('/dummy/file', transactional: false)
+        }.to raise_error
+      end
+    end
+  end
+
+  describe '.transactional' do
+    let(:spreadsheet_data) { spreadsheet_data_with_errors }
+
+    before(:each) do
+      allow(EmployeeImporter).to receive(:new).once.and_return(importer)
+    end
+
+    context 'when called with true as an argument' do
+      before(:each) { EmployeeImporter.transactional(true) }
+
+      it 'declares all importers of its kind to be transactional' do
+        expect(EmployeeImporter).to be_transactional
+        importer = EmployeeImporter.new('/dummy/file')
+        expect(importer).to be_transactional
+      end
+
+      it 'runs the import process within a transaction' do
+        expect {
+          EmployeeImporter.import('/dummy/file') rescue nil
+        }.not_to change(Employee, :count)
+      end
+
+      it 'exposes the exception that aborted the transaction' do
+        expect {
+          EmployeeImporter.import('/dummy/file')
+        }.to raise_error
+      end
+
+      it 'still invokes the :row_error event' do
+        expect(importer).to receive(:row_error)
+        EmployeeImporter.import('/dummy/file') rescue nil
+      end
+
+      it 'still invokes the :import_finished event' do
+        expect(importer).to receive(:import_finished)
+        EmployeeImporter.import('/dummy/file') rescue nil
+      end
+
+      it 'invokes the :import_aborted event' do
+        expect(importer).to receive(:import_aborted)
+        EmployeeImporter.import('/dummy/file') rescue nil
+      end
+    end
+
+    context 'when called with false as an argument' do
+      it 'does not run the import process within a transactio' do
+        EmployeeImporter.transactional(false)
+        expect {
+          EmployeeImporter.import('/dummy/file')
+        }.to change(Employee, :count).by(2)
+      end
+
+      it 'declares all importers of its kind not to be transactional' do
+        expect(EmployeeImporter).not_to be_transactional
+        importer = EmployeeImporter.new('/dummy/file')
+        expect(importer).not_to be_transactional
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require 'active_importer'
 
+# Require files in spec/support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -21,3 +24,5 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
+
+I18n.enforce_available_locales = false

data/spec/support/active_record/models.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../schema', __FILE__)
+
+class Employee < ::ActiveRecord::Base
+  validates_exclusion_of :name, in: ['Invalid']
+end

data/spec/support/active_record/schema.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Base.logger = Logger.new('/dev/null')
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :employees, :force => true do |t|
+    t.column :name, :string
+    t.column :birth_date, :string
+    t.column :department_id, :integer
+    t.column :unused_field, :string
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+end

data/spec/{stubs/employee.rb → support/employee_importer.rb}

@@ -1,14 +1,3 @@
-require 'stubs/data_model'
-require 'stubs/spreadsheet'
-
-class Employee < DataModel
-  attr_accessor :name, :birth_date, :department, :department_id
-
-  def validate
-    errors << 'Invalid name' if name == 'Invalid'
-  end
-end
-
 class EmployeeBaseImporter < ActiveImporter::Base
   on(:import_finished) { base_import_finished }
 
@@ -24,6 +13,8 @@ class EmployeeImporter < EmployeeBaseImporter
   column 'Name', :name
   column 'Birth Date', :birth_date
   column 'Manager'
+  column 'Unused', :unused_field, optional: true
+  column 'Extra', optional: true
   column '  Department ', :department_id do |value|
     find_department(value)
   end

metadata

@@ -1,78 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: active_importer
 version: !ruby/object:Gem::Version
-  version: 0.2.4
-  prerelease: 
+  version: 0.2.5
 platform: ruby
 authors:
 - Ernesto Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roo
   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: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Import tabular data from spreadsheets or similar sources into data models
@@ -82,8 +101,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,43 +113,38 @@ files:
 - lib/active_importer/version.rb
 - spec/active_importer/base_spec.rb
 - spec/spec_helper.rb
-- spec/stubs/data_model.rb
-- spec/stubs/employee.rb
-- spec/stubs/spreadsheet.rb
+- spec/support/active_record/models.rb
+- spec/support/active_record/schema.rb
+- spec/support/employee_importer.rb
+- spec/support/spreadsheet.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3645783224165529099
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3645783224165529099
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Import tabular data into data models
 test_files:
 - spec/active_importer/base_spec.rb
 - spec/spec_helper.rb
-- spec/stubs/data_model.rb
-- spec/stubs/employee.rb
-- spec/stubs/spreadsheet.rb
+- spec/support/active_record/models.rb
+- spec/support/active_record/schema.rb
+- spec/support/employee_importer.rb
+- spec/support/spreadsheet.rb

data/spec/stubs/data_model.rb

@@ -1,62 +0,0 @@
-class DataModel
-
-  def self.count
-    @count ||= 0
-  end
-
-  attr_reader :errors
-
-  def initialize(attributes = {})
-    @new_record = true
-    @errors = []
-    attributes.each_pair do |key, value|
-      self[key] = value
-    end
-  end
-
-  def []=(field, value)
-    send("#{field}=", value)
-  end
-
-  def to_s
-    "#{self.class.name}(#{attributes})"
-  end
-
-  def save
-    if valid?
-      self.class.send(:increment_count) if @new_record
-      @new_record = false
-      true
-    else
-      false
-    end
-  end
-
-  def save!
-    raise 'Invalid model' unless save
-  end
-
-  def new_record?
-    @new_record
-  end
-
-  def valid?
-    validate
-    errors.empty?
-  end
-
-  def validate
-    # ...
-  end
-
-  private
-
-  def self.increment_count
-    count
-    @count += 1
-  end
-
-  class << self
-    private :increment_count
-  end
-end