Module 5 commit 6 Linting issues

Author: neural-techno

server/database/app.js

@@ -1,39 +1,35 @@
 const express = require('express');
 const mongoose = require('mongoose');
 const fs = require('fs');
-const  cors = require('cors')
-const app = express()
+const cors = require('cors');
+const app = express();
 const port = 3030;
 
-app.use(cors())
+app.use(cors());
 app.use(require('body-parser').urlencoded({ extended: false }));
 
-const reviews_data = JSON.parse(fs.readFileSync("reviews.json", 'utf8'));
-const dealerships_data = JSON.parse(fs.readFileSync("dealerships.json", 'utf8'));
-
-mongoose.connect("mongodb://mongo_db:27017/",{'dbName':'dealershipsDB'});
+const reviews_data = JSON.parse(fs.readFileSync('reviews.json', 'utf8'));
+const dealerships_data = JSON.parse(fs.readFileSync('dealerships.json', 'utf8'));
 
+mongoose.connect('mongodb://mongo_db:27017/', { dbName: 'dealershipsDB' });
 
 const Reviews = require('./review');
-
 const Dealerships = require('./dealership');
 
 try {
-  Reviews.deleteMany({}).then(()=>{
+  Reviews.deleteMany({}).then(() => {
     Reviews.insertMany(reviews_data['reviews']);
   });
-  Dealerships.deleteMany({}).then(()=>{
+  Dealerships.deleteMany({}).then(() => {
     Dealerships.insertMany(dealerships_data['dealerships']);
   });
-  
 } catch (error) {
   res.status(500).json({ error: 'Error fetching documents' });
 }
 
-
 // Express route to home
 app.get('/', async (req, res) => {
-    res.send("Welcome to the Mongoose API")
+  res.send('Welcome to the Mongoose API');
 });
 
 // Express route to fetch all reviews
@@ -49,7 +45,7 @@ app.get('/fetchReviews', async (req, res) => {
 // Express route to fetch reviews by a particular dealer
 app.get('/fetchReviews/dealer/:id', async (req, res) => {
   try {
-    const documents = await Reviews.find({dealership: req.params.id});
+    const documents = await Reviews.find({ dealership: req.params.id });
     res.json(documents);
   } catch (error) {
     res.status(500).json({ error: 'Error fetching documents' });
@@ -58,7 +54,7 @@ app.get('/fetchReviews/dealer/:id', async (req, res) => {
 
 // Express route to fetch all dealerships
 app.get('/fetchDealers', async (req, res) => {
-    try {
+  try {
     const documents = await Dealerships.find();
     res.json(documents);
   } catch (error) {
@@ -68,47 +64,47 @@ app.get('/fetchDealers', async (req, res) => {
 
 // Express route to fetch Dealers by a particular state
 app.get('/fetchDealers/:state', async (req, res) => {
-    try {
-        const documents = await Dealerships.find({ 'state': req.params.state });
-        res.json(documents);
+  try {
+    const documents = await Dealerships.find({ state: req.params.state });
+    res.json(documents);
   } catch (error) {
     res.status(500).json({ error: 'Error fetching documents' });
   }
 });
 
 // Express route to fetch dealer by a particular id
 app.get('/fetchDealer/:id', async (req, res) => {
-    try {
-    const documents = await Dealerships.findOne({ 'id': req.params.id });
+  try {
+    const documents = await Dealerships.findOne({ id: req.params.id });
     res.json(documents);
   } catch (error) {
     res.status(500).json({ error: 'Error fetching documents' });
   }
 });
 
-//Express route to insert review
+// Express route to insert review
 app.post('/insert_review', express.raw({ type: '*/*' }), async (req, res) => {
-  data = JSON.parse(req.body);
-  const documents = await Reviews.find().sort( { id: -1 } )
-  let new_id = documents[0]['id']+1
+  const data = JSON.parse(req.body);
+  const documents = await Reviews.find().sort({ id: -1 });
+  const new_id = documents[0]['id'] + 1;
 
   const review = new Reviews({
-		"id": new_id,
-		"name": data['name'],
-		"dealership": data['dealership'],
-		"review": data['review'],
-		"purchase": data['purchase'],
-		"purchase_date": data['purchase_date'],
-		"car_make": data['car_make'],
-		"car_model": data['car_model'],
-		"car_year": data['car_year'],
-	});
+    id: new_id,
+    name: data['name'],
+    dealership: data['dealership'],
+    review: data['review'],
+    purchase: data['purchase'],
+    purchase_date: data['purchase_date'],
+    car_make: data['car_make'],
+    car_model: data['car_model'],
+    car_year: data['car_year'],
+  });
 
   try {
     const savedReview = await review.save();
     res.json(savedReview);
   } catch (error) {
-		console.log(error);
+    console.log(error);
     res.status(500).json({ error: 'Error inserting review' });
   }
 });

server/database/dealership.js

@@ -2,42 +2,43 @@ const mongoose = require('mongoose');
 
 const Schema = mongoose.Schema;
 
-const dealerships = new Schema({
-	id: {
+const dealershipSchema = new Schema({
+  id: {
     type: Number,
     required: true,
-	},
-	city: {
+  },
+  city: {
     type: String,
-    required: true
+    required: true,
   },
   state: {
     type: String,
-    required: true
+    required: true,
   },
   address: {
     type: String,
-    required: true
+    required: true,
   },
   zip: {
     type: String,
-    required: true
+    required: true,
   },
   lat: {
     type: String,
-    required: true
+    required: true,
   },
   long: {
     type: String,
-    required: true
+    required: true,
   },
   short_name: {
     type: String,
+    required: false, // optional field
   },
   full_name: {
     type: String,
-    required: true
-  }
+    required: true,
+  },
 });
 
-module.exports = mongoose.model('dealerships', dealerships);
+module.exports = mongoose.model('Dealership', dealershipSchema);

server/database/inventory.js

@@ -3,31 +3,31 @@ const mongoose = require('mongoose');
 
 const Schema = mongoose.Schema;
 
-const cars = new Schema({
-dealer_id: {
+const carSchema = new Schema({
+  dealer_id: {
     type: Number,
-    required: true
-},
-make: {
+    required: true,
+  },
+  make: {
     type: String,
-    required: true
+    required: true,
   },
-model: {
+  model: {
     type: String,
-    required: true
+    required: true,
   },
-bodyType: {
+  bodyType: {
     type: String,
-    required: true
+    required: true,
   },
-year: {
+  year: {
     type: Number,
-    required: true
+    required: true,
   },
-mileage: {
+  mileage: {
     type: Number,
-    required: true
-  }
+    required: true,
+  },
 });
 
-module.exports = mongoose.model('cars', cars);
+module.exports = mongoose.model('Car', carSchema);

server/database/review.js

@@ -2,43 +2,43 @@ const mongoose = require('mongoose');
 
 const Schema = mongoose.Schema;
 
-const reviews = new Schema({
-	id: {
+const reviewSchema = new Schema({
+  id: {
     type: Number,
     required: true,
-	},
-	name: {
+  },
+  name: {
     type: String,
-    required: true
+    required: true,
   },
   dealership: {
     type: Number,
     required: true,
   },
   review: {
     type: String,
-    required: true
+    required: true,
   },
   purchase: {
     type: Boolean,
-    required: true
+    required: true,
   },
   purchase_date: {
     type: String,
-    required: true
+    required: true,
   },
   car_make: {
     type: String,
-    required: true
+    required: true,
   },
   car_model: {
     type: String,
-    required: true
+    required: true,
   },
   car_year: {
     type: Number,
-    required: true
+    required: true,
   },
 });
 
-module.exports = mongoose.model('reviews', reviews);
+module.exports = mongoose.model('Review', reviewSchema);

server/djangoapp/models.py

@@ -1,23 +1,56 @@
 # Uncomment the following imports before adding the Model code
 
 from django.db import models
-from django.utils.timezone import now
 from django.core.validators import MaxValueValidator, MinValueValidator
 
 
 # Create your models here.
 class CarMake(models.Model):
+    """
+    Represents a car make (e.g., Toyota, Ford, etc.).
+
+    The CarMake model stores information about the car manufacturer,
+    including the name, description, country of origin, and the date
+    the brand was established.
+
+    Attributes:
+        name (str): The name of the car manufacturer.
+        description (str): A description of the car manufacturer.
+        country_of_origin (str, optional): The country where the car manufacturer is based.
+        established_date (date, optional): The date when the car manufacturer was established.
+    """
+
     name = models.CharField(max_length=100)
     description = models.TextField()
-    country_of_origin = models.CharField(max_length=100, blank=True, null=True)  # Optional: field for the country of origin
-    established_date = models.DateField(blank=True, null=True)  # Optional: field for the year when the brand was established
+    country_of_origin = models.CharField(max_length=100, blank=True, null=True)
+    established_date = models.DateField(blank=True, null=True)
 
     def __str__(self):
         return self.name  # Return the name as the string representation
 
 
 class CarModel(models.Model):
-    car_make = models.ForeignKey(CarMake, on_delete=models.CASCADE)  # Many-to-One relationship
+    """
+    Represents a car model associated with a specific car make (e.g., Camry, Mustang, etc.).
+
+    The CarModel model stores details about a specific model of a car,
+    including its make, type, year, engine type, fuel type, color, price,
+    mileage, horsepower, and transmission.
+
+    Attributes:
+        car_make (ForeignKey): A reference to the CarMake model representing the car's manufacturer.
+        name (str): The name of the car model (e.g., Camry, A-Class).
+        type (str): The type of the car (e.g., Sedan, SUV, Wagon).
+        year (int): The year the car model was manufactured.
+        engine_type (str, optional): The type of engine in the car.
+        fuel_type (str): The fuel type used by the car (e.g., Petrol, Diesel, Electric, Hybrid).
+        color (str, optional): The color of the car.
+        price (decimal, optional): The price of the car.
+        mileage (float, optional): The mileage of the car.
+        horsepower (int, optional): The horsepower of the car's engine.
+        transmission (str): The type of transmission in the car (e.g., Automatic, Manual).
+    """
+    car_make = models.ForeignKey(CarMake, on_delete = models.CASCADE)
     name = models.CharField(max_length=100)
     CAR_TYPES = [
         ('SEDAN', 'Sedan'),
@@ -31,12 +64,25 @@ class CarModel(models.Model):
             MaxValueValidator(2023),
             MinValueValidator(2015)
         ])
-    engine_type = models.CharField(max_length=50, blank=True, null=True)  # Engine type (e.g., V6, V8, Electric)
-    fuel_type = models.CharField(max_length=20, choices=[('PETROL', 'Petrol'), ('DIESEL', 'Diesel'), ('ELECTRIC', 'Electric'), ('HYBRID', 'Hybrid')], default='PETROL')  # Fuel type
-    color = models.CharField(max_length=30, blank=True, null=True)  # Car color
-    price = models.DecimalField(max_digits=10, decimal_places=2, blank=True, null=True)  # Price of the car model
-    mileage = models.FloatField(blank=True, null=True)  # Mileage (miles per gallon or km per liter)
-    horsepower = models.IntegerField(blank=True, null=True)  # Engine horsepower
-    transmission = models.CharField(max_length=20, choices=[('AUTOMATIC', 'Automatic'), ('MANUAL', 'Manual')], default='AUTOMATIC')  # Transmission type
+    engine_type = models.CharField(max_length=50, blank=True, null=True)
+    fuel_type = models.CharField(
+        max_length=20,
+        choices=[
+            ('PETROL', 'Petrol'),
+            ('DIESEL', 'Diesel'),
+            ('ELECTRIC', 'Electric'),
+            ('HYBRID', 'Hybrid')
+        ],
+        default='PETROL'
+    )
+    color = models.CharField(max_length=30, blank=True, null=True)
+    price = models.DecimalField(max_digits=10, decimal_places=2, blank=True, null=True)
+    mileage = models.FloatField(blank=True, null=True)
+    horsepower = models.IntegerField(blank=True, null=True)
+    transmission = models.CharField(
+        max_length=20,
+        choices=[('AUTOMATIC', 'Automatic'), ('MANUAL', 'Manual')],
+        default='AUTOMATIC'
+    )
     def __str__(self):
-        return self.name  # Return the name as the string representation
+        return self.name