diff --git a/lib/__pycache__/models.cpython-38.pyc b/lib/__pycache__/models.cpython-38.pyc new file mode 100644 index 000000000..67c204390 Binary files /dev/null and b/lib/__pycache__/models.cpython-38.pyc differ diff --git a/lib/freebies.db b/lib/freebies.db index 12beb1c96..f599b28a3 100644 Binary files a/lib/freebies.db and b/lib/freebies.db differ diff --git a/lib/migrations/README b/lib/migrations/README index 98e4f9c44..10c293485 100644 --- a/lib/migrations/README +++ b/lib/migrations/README @@ -1 +1,54 @@ -Generic single-database configuration. \ No newline at end of file +# Freebie Tracker + +This project is a Freebie Tracker application that manages companies, developers (devs), and freebies given by companies to devs. It uses a relational database to store information about these entities and their relationships. + +## Entities and Relationships + +The application models three main entities: + +- **Company**: Represents a company that can give freebies to developers. Each company has an ID, name, and founding year. +- **Dev**: Represents a developer who can receive freebies from companies. Each dev has an ID and a name. +- **Freebie**: Represents a free item given by a company to a developer. Each freebie has an ID, item name, value, and foreign keys linking it to a dev and a company. + +### Relationships + +- A **Company** can give many **Freebies** (one-to-many). +- A **Dev** can receive many **Freebies** (one-to-many). +- There is a many-to-many relationship between **Company** and **Dev** through the **Freebie** association. + +## Entity Relationship Diagram (ERD) + +``` ++----------------+ +----------------+ +----------------+ +| Company | | Freebie | | Dev | ++----------------+ +----------------+ +----------------+ +| id (PK) |1 *| id (PK) |* 1| id (PK) | +| name |----------| item_name |----------| name | +| founding_year | | value | | | ++----------------+ | dev_id (FK) | +----------------+ + | company_id (FK)| + +----------------+ +``` + +- The lines indicate relationships: + - One Company can have many Freebies. + - One Dev can have many Freebies. + - Freebie acts as a join table linking Companies and Devs. + +## Usage + +The application allows you to: + +- Track companies and their founding years. +- Track developers. +- Record freebies given by companies to developers. +- Query relationships such as which freebies a dev has received or which devs a company has given freebies to. + +## Example Methods + +- `Company.oldest_company(session)`: Returns the oldest company by founding year. +- `Company.give_freebie(session, dev, item_name, value)`: Company gives a freebie to a dev. +- `Dev.received_one(item_name)`: Checks if a dev has received a specific item. +- `Dev.give_away(session, dev, freebie)`: Dev gives away a freebie to another dev. + +--- diff --git a/lib/migrations/__pycache__/env.cpython-38.pyc b/lib/migrations/__pycache__/env.cpython-38.pyc new file mode 100644 index 000000000..beb6e7d44 Binary files /dev/null and b/lib/migrations/__pycache__/env.cpython-38.pyc differ diff --git a/lib/migrations/versions/8a1b2c3d4e5f_create_freebies.py b/lib/migrations/versions/8a1b2c3d4e5f_create_freebies.py new file mode 100644 index 000000000..abbd8c9b5 --- /dev/null +++ b/lib/migrations/versions/8a1b2c3d4e5f_create_freebies.py @@ -0,0 +1,30 @@ +"""create freebies table + +Revision ID: 8a1b2c3d4e5f +Revises: 5f72c58bf48c +Create Date: 2024-06-01 12:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8a1b2c3d4e5f' +down_revision = '5f72c58bf48c' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table('freebies', + sa.Column('id', sa.Integer(), primary_key=True, nullable=False), + sa.Column('item_name', sa.String(), nullable=False), + sa.Column('value', sa.Integer(), nullable=False), + sa.Column('dev_id', sa.Integer(), sa.ForeignKey('devs.id'), nullable=False), + sa.Column('company_id', sa.Integer(), sa.ForeignKey('companies.id'), nullable=False) + ) + + +def downgrade() -> None: + op.drop_table('freebies') diff --git a/lib/migrations/versions/__pycache__/5f72c58bf48c_create_companies_devs.cpython-38.pyc b/lib/migrations/versions/__pycache__/5f72c58bf48c_create_companies_devs.cpython-38.pyc new file mode 100644 index 000000000..f0d1e387f Binary files /dev/null and b/lib/migrations/versions/__pycache__/5f72c58bf48c_create_companies_devs.cpython-38.pyc differ diff --git a/lib/migrations/versions/__pycache__/7a71dbf71c64_create_db.cpython-38.pyc b/lib/migrations/versions/__pycache__/7a71dbf71c64_create_db.cpython-38.pyc new file mode 100644 index 000000000..e7c9ea4df Binary files /dev/null and b/lib/migrations/versions/__pycache__/7a71dbf71c64_create_db.cpython-38.pyc differ diff --git a/lib/migrations/versions/__pycache__/8a1b2c3d4e5f_create_freebies.cpython-38.pyc b/lib/migrations/versions/__pycache__/8a1b2c3d4e5f_create_freebies.cpython-38.pyc new file mode 100644 index 000000000..ed814970a Binary files /dev/null and b/lib/migrations/versions/__pycache__/8a1b2c3d4e5f_create_freebies.cpython-38.pyc differ diff --git a/lib/models.py b/lib/models.py index 2681bee5a..1060745ba 100644 --- a/lib/models.py +++ b/lib/models.py @@ -16,14 +16,49 @@ class Company(Base): name = Column(String()) founding_year = Column(Integer()) + freebies = relationship('Freebie', backref='company') + devs = relationship('Dev', secondary='freebies', viewonly=True) + def __repr__(self): return f'' + def give_freebie(self, dev, item_name, value): + new_freebie = Freebie(item_name=item_name, value=value, dev=dev, company=self) + return new_freebie + + @classmethod + def oldest_company(cls, session): + return session.query(cls).order_by(cls.founding_year).first() + class Dev(Base): __tablename__ = 'devs' id = Column(Integer(), primary_key=True) name= Column(String()) + freebies = relationship('Freebie', backref='dev') + companies = relationship('Company', secondary='freebies', viewonly=True) + def __repr__(self): return f'' + + def received_one(self, item_name): + return any(freebie.item_name == item_name for freebie in self.freebies) + + def give_away(self, dev, freebie): + if freebie in self.freebies: + freebie.dev = dev + return freebie + return None + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer(), primary_key=True) + item_name = Column(String(), nullable=False) + value = Column(Integer(), nullable=False) + dev_id = Column(Integer(), ForeignKey('devs.id'), nullable=False) + company_id = Column(Integer(), ForeignKey('companies.id'), nullable=False) + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" diff --git a/lib/seed.py b/lib/seed.py index b16becbbb..2a4cba191 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,35 @@ -#!/usr/bin/env python3 +from lib.models import Company, Dev, Freebie, Base +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker -# Script goes here! +engine = create_engine('sqlite:///lib/freebies.db') +Base.metadata.bind = engine +DBSession = sessionmaker(bind=engine) +session = DBSession() + +# Clear existing data +session.query(Freebie).delete() +session.query(Company).delete() +session.query(Dev).delete() +session.commit() + +# Seed Companies +company1 = Company(name="TechCorp", founding_year=1990) +company2 = Company(name="InnovateLLC", founding_year=1985) +session.add_all([company1, company2]) +session.commit() + +# Seed Devs +dev1 = Dev(name="Alice") +dev2 = Dev(name="Bob") +session.add_all([dev1, dev2]) +session.commit() + +# Seed Freebies +freebie1 = Freebie(item_name="Sticker", value=5, dev=dev1, company=company1) +freebie2 = Freebie(item_name="T-Shirt", value=20, dev=dev1, company=company2) +freebie3 = Freebie(item_name="Mug", value=10, dev=dev2, company=company1) +session.add_all([freebie1, freebie2, freebie3]) +session.commit() + +print("Seed data added successfully.")