DataBanks

Summary

DataBanks is a lightweight library that facilitates the creation and use of objects that represent data with persistent storage.

This functionality exhibits Object Relational Mapping (ORM) and allows for an object-oriented approach to performing database operations. When extended into a new class, DataBanks sets up a relational mapping between the new model and an existing table in the database.

Demo

Instructions for using DataBanks:

1. Clone / download the repository

2. cd into the directory

3. If you'd like to use the demo database, follow 4-7; if you'd like to use your own database, follow 8-15

4. sqlite3 books.db < books.sql

5. sqlite3 books.db

6. Run irb or pry

7. load 'data_banks_demo.rb'

8. Create your own tables in SQLite3 like so:

CREATE TABLE patients (
  id INTEGER PRIMARY KEY,
  fname VARCHAR(255) NOT NULL,
  lname VARCHAR(255) NOT NULL,
  condition VARCHAR(255) NOT NULL,
  FOREIGN KEY(doctor_id) REFERENCES doctor(id)
)

9. sqlite3 your_database.db < #{FILE_NAME}.sql
10. sqlite3 your_database.db
11. Run irb or pry
12. load 'lib/data_banks.rb
13. DBConnection.open(DEMO_DB_FILE)
14. Create classes like so:

class Patient < DataBanks
    belongs_to :doctor
    finalize!
end

15. Use the API below

API

class Books < DataBanks
end

DataBanks provides similar core ActiveRecord methods:

• ::all generates an array of objects containing attributes, one for each item in the table

Book.all
=> [
    {id: 1, title: "The Hobbit", author_id: 1},
    {id: 2, title: "Metamorphosis", author_id: 2},
    {id: 3, title: "Candide", author_id: 3},
    {id: 4, title: "Don Quixote", author_id: 4},
    {id: 5, title: "Unclaimed Book", author_id: nil}
   ]

• ::find(id) finds the datum in a table by an id and returns a new object with all of the associated data

book = Book.find(5)

which you can then update using the update method:

book.update(author_id: 1)
book.author_id
=> 1

• ::where(params) returns an array of objects for the data matching the given params

Book.where(author_id: 2)
=> [
    {id: 2, title: "Metamorphosis", author_id: 2}
    ]

DataBanks provides similar core ActiveRecord associations:

• has_many

  class Book < DataBanks
    belongs_to :author
  end
  
  class Author < DataBanks
    has_many :books
  end
  
  author = Author.find(1)
  author.books = [
    {id: 1, title: "The Hobbit", author_id: 1}
    ]

• belongs_to

  class Author < DataBanks
    belongs_to :primary_language
  end
  
  class PrimaryLanguage <DataBanks
    has_many :authors
  end
  
  author = Author.find(3)
  author.primary_language
  => {id: 3, name: "French"}

• has_one_through

  class Book < DataBanks
    belongs_to :author
  end
  
  class Author < DataBanks
    has_many :books
    belongs_to :primary_language
  end
  
  class PrimaryLanguage < DataBanks
    has_many :authors
  end
  
  book = Book.find(4)
  book.primary_language
  => {id: 4, name: "Spanish"}

Note: While DataBanks allows users to provide their own names for associations, it is recommended to use the default one in most cases

Libraries

• SQLite3 (gem)
• ActiveSupport::Inflector