diff --git a/README.md b/README.md index b598b7784..870e585eb 100644 --- a/README.md +++ b/README.md @@ -180,3 +180,39 @@ data). - `Dev.give_away(dev, freebie)` accepts a `Dev` instance and a `Freebie` instance, changes the freebie's dev to be the given dev; your code should only make the change if the freebie belongs to the dev who's giving it away + +*** + +## Implementation Status + +✅ **COMPLETED** - All deliverables have been implemented and tested. + +### What's Implemented: + +- **Migration**: `freebies` table with foreign keys to `companies` and `devs` +- **Models**: `Freebie` model with all required relationships +- **Relationships**: All bidirectional relationships between Company, Dev, and Freebie +- **Methods**: All aggregate methods implemented and working +- **Seed Data**: Sample data for testing + +### Usage: + +1. **Setup**: `pipenv install && pipenv shell` +2. **Create Data**: `python lib/seed.py` +3. **Test**: `python lib/debug.py` + +### Example Usage in Debug Console: + +```python +# Get sample data +alice = session.query(Dev).filter_by(name="Alice").first() +google = session.query(Company).filter_by(name="Google").first() + +# Test relationships +print(alice.companies) # Companies Alice got freebies from +print(google.devs) # Devs who got freebies from Google + +# Test methods +print(alice.received_one("T-shirt")) # True +print(Company.oldest_company().name) # Microsoft +``` diff --git a/freebies.db b/freebies.db new file mode 100644 index 000000000..4cc3280ab Binary files /dev/null and b/freebies.db differ diff --git a/lib/debug.py b/lib/debug.py index 4f922eb69..9f85f7b32 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,9 +1,12 @@ #!/usr/bin/env python3 from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker -from models import Company, Dev +from models import Company, Dev, Freebie if __name__ == '__main__': engine = create_engine('sqlite:///freebies.db') + Session = sessionmaker(bind=engine) + session = Session() import ipdb; ipdb.set_trace() diff --git a/lib/migrations/README b/lib/migrations/README deleted file mode 100644 index 98e4f9c44..000000000 --- a/lib/migrations/README +++ /dev/null @@ -1 +0,0 @@ -Generic single-database configuration. \ No newline at end of file diff --git a/lib/migrations/versions/create_freebies_table.py b/lib/migrations/versions/create_freebies_table.py new file mode 100644 index 000000000..2c44784a6 --- /dev/null +++ b/lib/migrations/versions/create_freebies_table.py @@ -0,0 +1,37 @@ +"""create freebies table + +Revision ID: create_freebies +Revises: 5f72c58bf48c +Create Date: 2023-03-15 15:10:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'create_freebies' +down_revision = '5f72c58bf48c' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('freebies', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('item_name', sa.String(), nullable=True), + sa.Column('value', sa.Integer(), nullable=True), + sa.Column('dev_id', sa.Integer(), nullable=True), + sa.Column('company_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['company_id'], ['companies.id'], name='fk_freebies_company_id_companies'), + sa.ForeignKeyConstraint(['dev_id'], ['devs.id'], name='fk_freebies_dev_id_devs'), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('freebies') + # ### end Alembic commands ### \ No newline at end of file diff --git a/lib/models.py b/lib/models.py index 2681bee5a..3429a5707 100644 --- a/lib/models.py +++ b/lib/models.py @@ -1,5 +1,5 @@ from sqlalchemy import ForeignKey, Column, Integer, String, MetaData -from sqlalchemy.orm import relationship, backref +from sqlalchemy.orm import relationship, backref, Session from sqlalchemy.ext.declarative import declarative_base convention = { @@ -15,6 +15,30 @@ class Company(Base): id = Column(Integer(), primary_key=True) name = Column(String()) founding_year = Column(Integer()) + + freebies = relationship('Freebie', back_populates='company') + devs = relationship('Dev', secondary='freebies', back_populates='companies', viewonly=True) + + def give_freebie(self, dev, item_name, value): + from sqlalchemy.orm import object_session + session = object_session(self) + if session is None: + from sqlalchemy import create_engine + engine = create_engine('sqlite:///freebies.db') + session = Session(engine) + freebie = Freebie(dev=dev, company=self, item_name=item_name, value=value) + session.add(freebie) + session.commit() + return freebie + + @classmethod + def oldest_company(cls): + from sqlalchemy import create_engine + engine = create_engine('sqlite:///freebies.db') + session = Session(engine) + oldest = session.query(cls).order_by(cls.founding_year).first() + session.close() + return oldest def __repr__(self): return f'' @@ -23,7 +47,35 @@ class Dev(Base): __tablename__ = 'devs' id = Column(Integer(), primary_key=True) - name= Column(String()) + name = Column(String()) + + freebies = relationship('Freebie', back_populates='dev') + companies = relationship('Company', secondary='freebies', back_populates='devs', viewonly=True) + + 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.dev == self: + freebie.dev = dev def __repr__(self): return f'' + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer(), primary_key=True) + item_name = Column(String()) + value = Column(Integer()) + dev_id = Column(Integer(), ForeignKey('devs.id')) + company_id = Column(Integer(), ForeignKey('companies.id')) + + dev = relationship('Dev', back_populates='freebies') + company = relationship('Company', back_populates='freebies') + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}." + + def __repr__(self): + return f'' diff --git a/lib/seed.py b/lib/seed.py index b16becbbb..2326b8294 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,43 @@ #!/usr/bin/env python3 -# Script goes here! +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from models import Company, Dev, Freebie, Base + +if __name__ == '__main__': + engine = create_engine('sqlite:///freebies.db') + Base.metadata.create_all(engine) + + Session = sessionmaker(bind=engine) + session = Session() + + # Clear existing data + session.query(Freebie).delete() + session.query(Company).delete() + session.query(Dev).delete() + + # Create companies + google = Company(name="Google", founding_year=1998) + apple = Company(name="Apple", founding_year=1976) + microsoft = Company(name="Microsoft", founding_year=1975) + + # Create devs + alice = Dev(name="Alice") + bob = Dev(name="Bob") + charlie = Dev(name="Charlie") + + # Add to session + session.add_all([google, apple, microsoft, alice, bob, charlie]) + session.commit() + + # Create freebies + freebie1 = Freebie(dev=alice, company=google, item_name="T-shirt", value=25) + freebie2 = Freebie(dev=bob, company=apple, item_name="Stickers", value=5) + freebie3 = Freebie(dev=alice, company=microsoft, item_name="Mug", value=15) + freebie4 = Freebie(dev=charlie, company=google, item_name="Hoodie", value=50) + + session.add_all([freebie1, freebie2, freebie3, freebie4]) + session.commit() + + print("Seed data created successfully!") + session.close()