mirror of
https://github.com/daniviga/django-ram.git
synced 2026-02-03 17:40:39 +01:00
Compare commits
131 Commits
v0.14.2
...
b9e55936e1
| Author | SHA1 | Date | |
|---|---|---|---|
|
b9e55936e1
|
|||
|
268fe8f9a7
|
|||
|
289ace4a49
|
|||
|
8c216c7e56
|
|||
|
d1e741ebfd
|
|||
|
650a93676e
|
|||
|
265aed56fe
|
|||
|
167a0593de
|
|||
|
a254786ddc
|
|||
|
8d899e4d9f
|
|||
|
40df9eb376
|
|||
|
226f0b32ba
|
|||
|
3c121a60a4
|
|||
|
ab606859d1
|
|||
|
a16801eb4b
|
|||
|
b8d10a68ca
|
|||
|
e690ded04f
|
|||
|
15a7ffaf4f
|
|||
|
a11f97bcad
|
|||
|
3c854bda1b
|
|||
|
564416b3d5
|
|||
|
967ea5d495
|
|||
|
7656aa8b68
|
|||
| 1be102b9d4 | |||
| 4ec7b8fc18 | |||
| 9a469378df | |||
| ede8741473 | |||
|
49c8d804d6
|
|||
|
2ab2d00585
|
|||
|
c95064ddec
|
|||
|
16bd82de39
|
|||
|
2ae7f2685d
|
|||
|
29f9a213b4
|
|||
|
884661d4e1
|
|||
|
c7cace96f7
|
|||
|
d3c099c05b
|
|||
|
903633b5a7
|
|||
|
ee775d737e
|
|||
|
8087ab5997
|
|||
|
1899747909
|
|||
|
0880bd0817
|
|||
|
74d7df2c8b
|
|||
|
c81508bbd5
|
|||
|
b4f69d8a34
|
|||
| 676418cb67 | |||
|
98d2e7beab
|
|||
|
fb17dc2a7c
|
|||
|
5a71dc36fa
|
|||
|
c539255bf9
|
|||
|
fc527d5cd1
|
|||
|
f45d754c91
|
|||
|
e9c9ede357
|
|||
| 39b0a9378b | |||
| 6b10051bc4 | |||
|
3804c3379b
|
|||
|
1b769da553
|
|||
|
f655900411
|
|||
|
3e69b9ae6e
|
|||
|
66c3c3f51c
|
|||
|
935c439084
|
|||
|
d757388ca8
|
|||
| 536101d2ff | |||
|
955397acd5
|
|||
|
672cadd7e1
|
|||
|
464fe57536
|
|||
|
bd16c7eee7
|
|||
|
cc2e374558
|
|||
|
1c25ac9b14
|
|||
|
de126a735d
|
|||
|
18b5ab8053
|
|||
|
3acc80e2ad
|
|||
|
552ba39970
|
|||
|
222e2075ec
|
|||
|
b5c57dcd94
|
|||
|
b81c63898f
|
|||
|
76b266b1f9
|
|||
|
86657a3b9f
|
|||
|
d0d25424fb
|
|||
|
292b95b8ed
|
|||
|
dea7a594bc
|
|||
|
60195bc99f
|
|||
|
7673f0514a
|
|||
|
40f42a9ee9
|
|||
|
2e06e94fde
|
|||
|
ece8d1ad94
|
|||
|
e9ec126ada
|
|||
|
1222116874
|
|||
|
85741f090c
|
|||
|
88d718fa94
|
|||
|
a2c857a3cd
|
|||
|
647894bca7
|
|||
|
c8cc8c5ed0
|
|||
| e80dc604a7 | |||
|
5088f19b33
|
|||
|
50bfc44978
|
|||
|
453729b05c
|
|||
| 5d89cb96d2 | |||
| 04757d868a | |||
| b897141212 | |||
|
3df8b461a0
|
|||
|
284632892d
|
|||
|
bb58dcf6fa
|
|||
|
c971ff9601
|
|||
| b10e1f3952 | |||
| d16e00d66b | |||
| 1a8f2aace8 | |||
| 0413c1c5ab | |||
|
f914c79786
|
|||
|
456f1b7294
|
|||
|
f19a0995b0
|
|||
|
3dd134f132
|
|||
| ddcf06994d | |||
| c467fb24ca | |||
| db79a02c85 | |||
| d237129c99 | |||
| af54acae86 | |||
| 90211562f9 | |||
|
1e7f72e9ec
|
|||
|
26be22c0bd
|
|||
| f286ec9780 | |||
| ead9fe649b | |||
| 206b9aea57 | |||
| 8557e2b778 | |||
| 6457486445 | |||
| ee5b5f0b3a | |||
| 159bc66b59 | |||
| 0ea9978ffb | |||
| 026ab06354 | |||
| 7eddd1b52b | |||
| 11515d79ef | |||
| f2b817103f |
8
.github/workflows/django.yml
vendored
8
.github/workflows/django.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
||||
strategy:
|
||||
max-parallel: 2
|
||||
matrix:
|
||||
python-version: ['3.12', '3.13']
|
||||
python-version: ['3.13', '3.14']
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
@@ -25,7 +25,11 @@ jobs:
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
- name: Run Tests
|
||||
- name: Run Migrations
|
||||
run: |
|
||||
cd ram
|
||||
python manage.py migrate
|
||||
- name: Run Tests
|
||||
run: |
|
||||
cd ram
|
||||
python manage.py test --verbosity=2
|
||||
|
||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -127,7 +127,13 @@ dmypy.json
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
||||
# node.js / npm stuff
|
||||
node_modules
|
||||
package-lock.json
|
||||
|
||||
# our own stuff
|
||||
*.swp
|
||||
ram/storage/
|
||||
!ram/storage/.gitignore
|
||||
arduino/CommandStation-EX/build/
|
||||
utils
|
||||
|
||||
340
AGENTS.md
Normal file
340
AGENTS.md
Normal file
@@ -0,0 +1,340 @@
|
||||
# Django Railroad Assets Manager - Agent Guidelines
|
||||
|
||||
This document provides coding guidelines and command references for AI coding agents working on the Django-RAM project.
|
||||
|
||||
## Project Overview
|
||||
|
||||
Django Railroad Assets Manager (django-ram) is a Django 6.0+ application for managing model railroad collections with DCC++ EX integration. The project manages rolling stock, consists, metadata, books/magazines, and provides an optional REST API for DCC control.
|
||||
|
||||
## Environment Setup
|
||||
|
||||
### Python Requirements
|
||||
- Python 3.11+ (tested on 3.13, 3.14)
|
||||
- Django >= 6.0
|
||||
- Working directory: `ram/` (Django project root)
|
||||
- Virtual environment recommended: `python3 -m venv venv && source venv/bin/activate`
|
||||
|
||||
### Installation
|
||||
```bash
|
||||
pip install -r requirements.txt # Core dependencies
|
||||
pip install -r requirements-dev.txt # Development tools
|
||||
cd ram && python manage.py migrate # Initialize database
|
||||
python manage.py createsuperuser # Create admin user
|
||||
```
|
||||
|
||||
### Frontend Assets
|
||||
```bash
|
||||
npm install # Install clean-css-cli, terser
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
ram/ # Django project root
|
||||
├── ram/ # Core settings, URLs, base models
|
||||
├── portal/ # Public-facing frontend (Bootstrap 5)
|
||||
├── roster/ # Rolling stock management (main app)
|
||||
├── metadata/ # Manufacturers, companies, scales, decoders
|
||||
├── bookshelf/ # Books and magazines
|
||||
├── consist/ # Train consists (multiple locomotives)
|
||||
├── repository/ # Document repository
|
||||
├── driver/ # DCC++ EX API gateway (optional, disabled by default)
|
||||
└── storage/ # Runtime data (SQLite DB, media, cache)
|
||||
```
|
||||
|
||||
## Build/Lint/Test Commands
|
||||
|
||||
### Running the Development Server
|
||||
```bash
|
||||
cd ram
|
||||
python manage.py runserver # Runs on http://localhost:8000
|
||||
```
|
||||
|
||||
### Database Management
|
||||
```bash
|
||||
python manage.py makemigrations # Create new migrations
|
||||
python manage.py migrate # Apply migrations
|
||||
python manage.py showmigrations # Show migration status
|
||||
```
|
||||
|
||||
### Testing
|
||||
```bash
|
||||
# Run all tests (comprehensive test suite with 75+ tests)
|
||||
python manage.py test
|
||||
|
||||
# Run tests for a specific app
|
||||
python manage.py test roster # Rolling stock tests
|
||||
python manage.py test metadata # Metadata tests
|
||||
python manage.py test bookshelf # Books/magazines tests
|
||||
python manage.py test consist # Consist tests
|
||||
|
||||
# Run a specific test case class
|
||||
python manage.py test roster.tests.RollingStockTestCase
|
||||
python manage.py test metadata.tests.ScaleTestCase
|
||||
|
||||
# Run a single test method
|
||||
python manage.py test roster.tests.RollingStockTestCase.test_road_number_int_extraction
|
||||
python manage.py test bookshelf.tests.TocEntryTestCase.test_toc_entry_page_validation_exceeds_book
|
||||
|
||||
# Run with verbosity for detailed output
|
||||
python manage.py test --verbosity=2
|
||||
|
||||
# Keep test database for inspection
|
||||
python manage.py test --keepdb
|
||||
|
||||
# Run tests matching a pattern
|
||||
python manage.py test --pattern="test_*.py"
|
||||
```
|
||||
|
||||
### Linting and Formatting
|
||||
```bash
|
||||
# Run flake8 (configured in requirements-dev.txt)
|
||||
flake8 . # Lint entire project
|
||||
flake8 roster/ # Lint specific app
|
||||
flake8 roster/models.py # Lint specific file
|
||||
|
||||
# Note: No .flake8 config exists; uses PEP 8 defaults
|
||||
# Long lines use # noqa: E501 comments in settings.py
|
||||
|
||||
# Run black formatter with 79 character line length
|
||||
black -l 79 . # Format entire project
|
||||
black -l 79 roster/ # Format specific app
|
||||
black -l 79 roster/models.py # Format specific file
|
||||
black -l 79 --check . # Check formatting without changes
|
||||
black -l 79 --diff . # Show formatting changes
|
||||
```
|
||||
|
||||
### Admin Commands
|
||||
```bash
|
||||
python manage.py createsuperuser # Create admin user
|
||||
python manage.py purge_cache # Custom: purge cache
|
||||
python manage.py loaddata <fixture> # Load sample data
|
||||
```
|
||||
|
||||
### Debugging & Profiling
|
||||
```bash
|
||||
# Use pdbpp for debugging (installed via requirements-dev.txt)
|
||||
import pdb; pdb.set_trace() # Set breakpoint in code
|
||||
|
||||
# Use pyinstrument for profiling
|
||||
python manage.py runserver --noreload # With pyinstrument middleware
|
||||
```
|
||||
|
||||
## Code Style Guidelines
|
||||
|
||||
### General Python Style
|
||||
- **PEP 8 compliant** - Follow standard Python style guide
|
||||
- **Line length**: 79 characters preferred; 119 acceptable for complex lines
|
||||
- **Long lines**: Use `# noqa: E501` comment when necessary (see settings.py)
|
||||
- **Indentation**: 4 spaces (no tabs)
|
||||
- **Encoding**: UTF-8
|
||||
|
||||
### Import Organization
|
||||
Follow Django's import style (as seen in models.py, views.py, admin.py):
|
||||
|
||||
```python
|
||||
# 1. Standard library imports
|
||||
import os
|
||||
import re
|
||||
from itertools import chain
|
||||
from functools import reduce
|
||||
|
||||
# 2. Related third-party imports
|
||||
from django.db import models
|
||||
from django.conf import settings
|
||||
from django.contrib import admin
|
||||
from tinymce import models as tinymce
|
||||
|
||||
# 3. Local application imports
|
||||
from ram.models import BaseModel, Image
|
||||
from ram.utils import DeduplicatedStorage, slugify
|
||||
from metadata.models import Scale, Manufacturer
|
||||
```
|
||||
|
||||
**Key points:**
|
||||
- Group imports by category with blank lines between
|
||||
- Use `from module import specific` for commonly used items
|
||||
- Avoid `import *`
|
||||
- Use `as` for aliasing when needed (e.g., `tinymce.models as tinymce`)
|
||||
|
||||
### Naming Conventions
|
||||
- **Classes**: `PascalCase` (e.g., `RollingStock`, `BaseModel`)
|
||||
- **Functions/methods**: `snake_case` (e.g., `get_items_per_page()`, `image_thumbnail()`)
|
||||
- **Variables**: `snake_case` (e.g., `road_number`, `item_number_slug`)
|
||||
- **Constants**: `UPPER_SNAKE_CASE` (e.g., `BASE_DIR`, `ALLOWED_HOSTS`)
|
||||
- **Private methods**: Prefix with `_` (e.g., `_internal_method()`)
|
||||
- **Model Meta options**: Use `verbose_name`, `verbose_name_plural`, `ordering`
|
||||
|
||||
### Django Model Patterns
|
||||
|
||||
```python
|
||||
class MyModel(BaseModel): # Inherit from BaseModel for common fields
|
||||
# Field order: relationships first, then data fields, then metadata
|
||||
foreign_key = models.ForeignKey(OtherModel, on_delete=models.CASCADE)
|
||||
name = models.CharField(max_length=128)
|
||||
slug = models.SlugField(max_length=128, unique=True)
|
||||
created = models.DateTimeField(auto_now_add=True)
|
||||
|
||||
class Meta:
|
||||
ordering = ["name"]
|
||||
verbose_name = "My Model"
|
||||
verbose_name_plural = "My Models"
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
|
||||
@property
|
||||
def computed_field(self):
|
||||
"""Document properties with docstrings."""
|
||||
return self.calculate_something()
|
||||
```
|
||||
|
||||
**Model field conventions:**
|
||||
- Use `null=True, blank=True` for optional fields
|
||||
- Use `help_text` for user-facing field descriptions
|
||||
- Use `limit_choices_to` for filtered ForeignKey choices
|
||||
- Use `related_name` for reverse relations
|
||||
- Set `on_delete=models.CASCADE` explicitly
|
||||
- Use `default=None` with `null=True` for nullable fields
|
||||
|
||||
### Admin Customization
|
||||
|
||||
```python
|
||||
@admin.register(MyModel)
|
||||
class MyModelAdmin(admin.ModelAdmin):
|
||||
list_display = ("name", "created", "custom_method")
|
||||
list_filter = ("category", "created")
|
||||
search_fields = ("name", "slug")
|
||||
autocomplete_fields = ("foreign_key",)
|
||||
readonly_fields = ("created", "updated")
|
||||
save_as = True # Enable "Save as new" button
|
||||
|
||||
@admin.display(description="Custom Display")
|
||||
def custom_method(self, obj):
|
||||
return format_html('<strong>{}</strong>', obj.name)
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
```python
|
||||
# Use Django's exception classes
|
||||
from django.core.exceptions import ValidationError, ObjectDoesNotExist
|
||||
from django.http import Http404
|
||||
from django.db.utils import OperationalError, ProgrammingError
|
||||
|
||||
# Handle database errors gracefully
|
||||
try:
|
||||
config = get_site_conf()
|
||||
except (OperationalError, ProgrammingError):
|
||||
config = default_config # Provide fallback
|
||||
```
|
||||
|
||||
### Type Hints
|
||||
- **Not currently used** in this project
|
||||
- Follow existing patterns without type hints unless explicitly adding them
|
||||
|
||||
## Django-Specific Patterns
|
||||
|
||||
### Using BaseModel
|
||||
All major models inherit from `ram.models.BaseModel`:
|
||||
```python
|
||||
from ram.models import BaseModel
|
||||
|
||||
class MyModel(BaseModel):
|
||||
# Automatically includes: uuid, description, notes, creation_time,
|
||||
# updated_time, published, obj_type, obj_label properties
|
||||
pass
|
||||
```
|
||||
|
||||
### Using PublicManager
|
||||
Models use `PublicManager` for filtering published items:
|
||||
```python
|
||||
from ram.managers import PublicManager
|
||||
|
||||
objects = PublicManager() # Only returns items where published=True
|
||||
```
|
||||
|
||||
### Image and Document Patterns
|
||||
```python
|
||||
from ram.models import Image, Document, PrivateDocument
|
||||
|
||||
class MyImage(Image):
|
||||
my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)
|
||||
# Inherits: order, image, image_thumbnail()
|
||||
|
||||
class MyDocument(PrivateDocument):
|
||||
my_model = models.ForeignKey(MyModel, on_delete=models.CASCADE)
|
||||
# Inherits: description, file, private, creation_time, updated_time
|
||||
```
|
||||
|
||||
### Using DeduplicatedStorage
|
||||
For media files that should be deduplicated:
|
||||
```python
|
||||
from ram.utils import DeduplicatedStorage
|
||||
|
||||
image = models.ImageField(upload_to="images/", storage=DeduplicatedStorage)
|
||||
```
|
||||
|
||||
## Testing Practices
|
||||
|
||||
### Test Coverage
|
||||
The project has comprehensive test coverage:
|
||||
- **roster/tests.py**: RollingStock, RollingClass models (~340 lines, 19+ tests)
|
||||
- **metadata/tests.py**: Scale, Manufacturer, Company, etc. (~378 lines, 29+ tests)
|
||||
- **bookshelf/tests.py**: Book, Magazine, Catalog, TocEntry (~436 lines, 25+ tests)
|
||||
- **consist/tests.py**: Consist, ConsistItem (~315 lines, 15+ tests)
|
||||
- **ram/tests.py**: BaseModel, utility functions (~140 lines, 11+ tests)
|
||||
|
||||
### Writing Tests
|
||||
```python
|
||||
from django.test import TestCase
|
||||
from django.core.exceptions import ValidationError
|
||||
from roster.models import RollingStock
|
||||
|
||||
class RollingStockTestCase(TestCase):
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
# Create necessary related objects
|
||||
self.company = Company.objects.create(name="RGS", country="US")
|
||||
self.scale = Scale.objects.create(scale="HO", ratio="1:87", tracks=16.5)
|
||||
# ...
|
||||
|
||||
def test_road_number_int_extraction(self):
|
||||
"""Test automatic extraction of integer from road number."""
|
||||
stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="RGS-42",
|
||||
scale=self.scale,
|
||||
)
|
||||
self.assertEqual(stock.road_number_int, 42)
|
||||
|
||||
def test_validation_error(self):
|
||||
"""Test that validation errors are raised correctly."""
|
||||
with self.assertRaises(ValidationError):
|
||||
# Test validation logic
|
||||
pass
|
||||
```
|
||||
|
||||
**Testing best practices:**
|
||||
- Use descriptive test method names with `test_` prefix
|
||||
- Include docstrings explaining what each test verifies
|
||||
- Create necessary test data in `setUp()` method
|
||||
- Test both success and failure cases
|
||||
- Use `assertRaises()` for exception testing
|
||||
- Test model properties, methods, and validation logic
|
||||
|
||||
## Git & Version Control
|
||||
|
||||
- Branch: `master` (main development branch)
|
||||
- CI runs on push and PR to master
|
||||
- Follow conventional commit messages
|
||||
- No pre-commit hooks configured (consider adding)
|
||||
|
||||
## Additional Notes
|
||||
|
||||
- **Settings override**: Use `ram/local_settings.py` for local configuration
|
||||
- **Debug mode**: `DEBUG = True` in settings.py (change for production)
|
||||
- **Database**: SQLite by default (in `storage/db.sqlite3`)
|
||||
- **Static files**: Bootstrap 5.3.8, Bootstrap Icons 1.13.1
|
||||
- **Rich text**: TinyMCE for HTMLField content
|
||||
- **REST API**: Disabled by default (`REST_ENABLED = False`)
|
||||
- **Security**: CSP middleware enabled, secure cookies in production
|
||||
100
README.md
100
README.md
@@ -23,7 +23,8 @@ security assesment, pentest, ISO certification, etc.
|
||||
|
||||
This project probably doesn't match your needs nor expectations. Be aware.
|
||||
|
||||
Your model train may also catch fire while using this software.
|
||||
> [!CAUTION]
|
||||
> Your model train may catch fire while using this software.
|
||||
|
||||
Check out [my own instance](https://daniele.mynarrowgauge.org).
|
||||
|
||||
@@ -40,23 +41,49 @@ Project is based on the following technologies and components:
|
||||
|
||||
It has been developed with:
|
||||
|
||||
- [vim](https://www.vim.org/): because it rocks
|
||||
- [neovim](https://neovim.io/): because `vim` rocks, `neovim` rocks more
|
||||
- [arduino-cli](https://github.com/arduino/arduino-cli/): a mouse? What the heck?
|
||||
- [vim-arduino](https://github.com/stevearc/vim-arduino): another IDE? No thanks
|
||||
- [podman](https://podman.io/): because containers are fancy
|
||||
- [QEMU (avr)](https://qemu-project.gitlab.io/qemu/system/target-avr.html): QEMU can even make toast!
|
||||
- [QEMU (avr)](https://qemu-project.gitlab.io/qemu/system/target-avr.html): QEMU can even make toasts!
|
||||
|
||||
## Future developments
|
||||
|
||||
A bunch of random, probably useless, ideas:
|
||||
|
||||
### A bookshelf
|
||||
|
||||
✅DONE
|
||||
|
||||
Because books matter more than model trains themselves.
|
||||
|
||||
### Live assets KPI collection
|
||||
|
||||
Realtime data usage is collected via a daemon connected over TCP to the EX-CommandStation and recorded for every asset with a DCC address.
|
||||
|
||||
### Asset lifecycle
|
||||
|
||||
Data is collected to compute the asset usage and then the wear level of its components (eg. the engine).
|
||||
|
||||
### Required mainentance forecast
|
||||
|
||||
Eventually data is used to "forecast" any required maintenance, like for example the replacement of carbon brushes, gear and motor oiling.
|
||||
|
||||
### Asset export to JMRI
|
||||
|
||||
Export assets (locomotives) into the JMRI format to be loaded in the JMRI
|
||||
roster.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.10+
|
||||
- Python 3.11+
|
||||
- A USB port when running Arduino hardware (and adaptors if you have a Mac)
|
||||
|
||||
## Web portal installation
|
||||
|
||||
### Using containers
|
||||
|
||||
coming soon
|
||||
Do it yourself, otherwise, raise a request :)
|
||||
|
||||
### Manual installation
|
||||
|
||||
@@ -83,6 +110,8 @@ $ python manage.py migrate
|
||||
$ python manage.py createsuperuser
|
||||
```
|
||||
|
||||
To load some sample metadata, see the [sample_data folder instructions](./sample_data/README.md).
|
||||
|
||||
Run Django
|
||||
|
||||
```bash
|
||||
@@ -99,43 +128,52 @@ connected via serial port, to the network, allowing commands to be sent via a
|
||||
TCP socket. A response generated by the DCC++ EX board is sent to all connected clients,
|
||||
providing synchronization between multiple clients (eg. multiple JMRI instances).
|
||||
|
||||
Its use is not needed when running DCC++ EX from a [WiFi](https://dcc-ex.com/get-started/wifi-setup.html) capable board (like when
|
||||
using an ESP8266 module or a [Mega+WiFi board](https://dcc-ex.com/advanced-setup/supported-microcontrollers/wifi-mega.html)).
|
||||
Its use is not needed when running DCC++ EX from a [WiFi](https://dcc-ex.com/get-started/wifi-setup.html) capable board, like when
|
||||
using an ESP8266 module, a [Mega+WiFi board](https://dcc-ex.com/reference/hardware/microcontrollers/wifi-mega.html), or an
|
||||
[ESP32](https://dcc-ex.com/reference/hardware/microcontrollers/esp32.html) (recommended).
|
||||
|
||||
### Customize the settings
|
||||
### Manual setup
|
||||
|
||||
The daemon comes with default settings in `config.ini`.
|
||||
Settings may need to be customized based on your setup.
|
||||
You'll need [namp-ncat](https://nmap.org/ncat/) , and `stty` to setup the serial port.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Other variants of `nc` or `ncat` may not work as expected.
|
||||
|
||||
Then you can run the following commands:
|
||||
|
||||
```bash
|
||||
$ stty -F /dev/ttyACM0 -echo 115200
|
||||
$ ncat -n -k -l 2560 </dev/ttyACM0 >/dev/ttyACM0
|
||||
```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> You'll might need to change the serial port (`/dev/ttyACM0`) to match your board.
|
||||
|
||||
> [!NOTE]
|
||||
> Your user will also need access to the device file, so you might need to add it to the `dialout` group.
|
||||
|
||||
|
||||
### Using containers
|
||||
|
||||
```bash
|
||||
$ cd daemons
|
||||
$ podman build -t dcc/net-to-serial .
|
||||
$ podman run --group-add keep-groups --device /dev/ttyACM0 -p 2560:2560 dcc/net-to-serial
|
||||
```
|
||||
|
||||
### Manual setup
|
||||
|
||||
```bash
|
||||
$ cd daemons
|
||||
$ pip install -r requirements.txt
|
||||
$ python ./net-to-serial.py
|
||||
$ cd connector
|
||||
$ podman build -t dcc/connector .
|
||||
$ podman run -d --group-add keep-groups --device /dev/ttyACM0:/dev/arduino -p 2560:2560 dcc/connector
|
||||
```
|
||||
|
||||
### Test with a simulator
|
||||
|
||||
A [QEMU AVR based simulator](daemons/simulator/README.md) running DCC++ EX is bundled togheter with the `net-to-serial.py`
|
||||
daemon into a container. To run it:
|
||||
A [QEMU AVR based simulator](daemons/simulator/README.md) running DCC++ EX is bundled togheter with the connector
|
||||
into a container. To run it:
|
||||
|
||||
```bash
|
||||
$ cd daemons/simulator
|
||||
$ podman build -t dcc/net-to-serial:sim .
|
||||
$ podman run --init --cpus 0.1 -d -p 2560:2560 dcc/net-to-serial:sim
|
||||
$ cd connector/simulator
|
||||
$ podman build -t dcc/connector:sim .
|
||||
$ podman run --init --cpus 0.1 -d -p 2560:2560 dcc/connector:sim
|
||||
```
|
||||
|
||||
To be continued ...
|
||||
> [!WARNING]
|
||||
> The simulator is intended for light development and testing purposes only and far from being a complete replacement for a real hardware.
|
||||
|
||||
## Screenshots
|
||||
|
||||
@@ -146,15 +184,12 @@ To be continued ...
|
||||

|
||||
|
||||
|
||||
|
||||
#### Dark mode
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
### Backoffice
|
||||
|
||||

|
||||
@@ -166,8 +201,3 @@ To be continued ...
|
||||
### Rest API
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Submodule arduino/CommandStation-EX updated: fe2f705fa9...313d2cd3e0
Submodule arduino/WebThrottle-EX updated: d82dcc9ecf...eeec7d4af6
Submodule arduino/arduino-cli updated: a0d912da18...08ff7e2b76
Submodule arduino/dcc-ex.github.io updated: cb286e9d76...190d3adfa1
9
connector/Dockerfile
Normal file
9
connector/Dockerfile
Normal file
@@ -0,0 +1,9 @@
|
||||
FROM alpine:edge
|
||||
|
||||
RUN apk add --no-cache coreutils nmap-ncat
|
||||
|
||||
EXPOSE 2560/tcp
|
||||
|
||||
SHELL ["/bin/ash", "-c"]
|
||||
CMD stty -F /dev/arduino -echo 115200 && \
|
||||
ncat -n -k -l 2560 </dev/arduino >/dev/arduino
|
||||
19
connector/README.md
Normal file
19
connector/README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Use a container to implement a serial to net bridge
|
||||
|
||||
This uses `ncat` from [nmap](https://nmap.org/ncat/) to bridge a serial port to a network port. The serial port is passed to the Podman command (eg. `/dev/ttyACM0`) and the network port is `2560`.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Other variants of `nc` or `ncat` may not work as expected.
|
||||
|
||||
## Build and run the container
|
||||
|
||||
```bash
|
||||
$ podman buil -t dcc/bridge .
|
||||
$ podman run -d --group-add keep-groups --device=/dev/ttyACM0:/dev/arduino -p 2560:2560 --name dcc-bridge dcc/bridge
|
||||
```
|
||||
|
||||
It can be tested with `telnet`:
|
||||
|
||||
```bash
|
||||
$ telnet localhost 2560
|
||||
```
|
||||
BIN
connector/simulator/CommandStation-EX-uno-13488e1.elf
Executable file
BIN
connector/simulator/CommandStation-EX-uno-13488e1.elf
Executable file
Binary file not shown.
8
connector/simulator/Dockerfile
Normal file
8
connector/simulator/Dockerfile
Normal file
@@ -0,0 +1,8 @@
|
||||
FROM dcc/bridge
|
||||
|
||||
RUN apk update && apk add --no-cache qemu-system-avr \
|
||||
&& mkdir /io
|
||||
ADD start.sh /usr/local/bin
|
||||
ADD CommandStation-EX*.elf /io
|
||||
|
||||
ENTRYPOINT ["/usr/local/bin/start.sh"]
|
||||
13
connector/simulator/README.md
Normal file
13
connector/simulator/README.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Connector and AVR simulator
|
||||
|
||||
> [!WARNING]
|
||||
> The simulator is intended for light development and testing purposes only and far from being a complete replacement for a real hardware.
|
||||
|
||||
`qemu-system-avr` tries to use all the CPU cycles (leaving a CPU core stuck at 100%; limit CPU core usage to 10% via `--cpus 0.1`. It can be adjusted on slower machines.
|
||||
|
||||
```bash
|
||||
$ podman build -t dcc/connector:sim .
|
||||
$ podman run --init --cpus 0.1 -d -p 2560:2560 dcc/connector:sim
|
||||
```
|
||||
|
||||
All traffic will be collected on the container's `stderr` for debugging purposes.
|
||||
@@ -7,7 +7,5 @@ if [ -c /dev/pts/0 ]; then
|
||||
PTY=1
|
||||
fi
|
||||
|
||||
sed -i "s/ttyACM0/pts\/${PTY}/" /opt/dcc/config.ini
|
||||
|
||||
qemu-system-avr -machine uno -bios /io/CommandStation-EX*.elf -serial pty -daemonize
|
||||
/opt/dcc/net-to-serial.py
|
||||
ncat -n -k -l 2560 -o /dev/stderr </dev/pts/${PTY} >/dev/pts/${PTY}
|
||||
@@ -1,9 +0,0 @@
|
||||
FROM python:3.11-alpine
|
||||
|
||||
RUN mkdir /opt/dcc && pip -q install pyserial
|
||||
ADD net-to-serial.py config.ini /opt/dcc
|
||||
RUN python3 -q -m compileall /opt/dcc/net-to-serial.py
|
||||
|
||||
EXPOSE 2560/tcp
|
||||
|
||||
CMD ["python3", "/opt/dcc/net-to-serial.py"]
|
||||
@@ -1,3 +0,0 @@
|
||||
## DCC++ EX connector
|
||||
|
||||
See [README.md](../README.md)
|
||||
@@ -1,14 +0,0 @@
|
||||
[Daemon]
|
||||
LogLevel = debug
|
||||
ListeningIP = 0.0.0.0
|
||||
ListeningPort = 2560
|
||||
MaxClients = 10
|
||||
|
||||
[Serial]
|
||||
# UNO
|
||||
Port = /dev/ttyACM0
|
||||
# Mega WiFi
|
||||
# Port = /dev/ttyUSB0
|
||||
Baudrate = 115200
|
||||
# Timeout in milliseconds
|
||||
Timeout = 50
|
||||
@@ -1,120 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
import re
|
||||
import logging
|
||||
import serial
|
||||
import asyncio
|
||||
import configparser
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
class SerialDaemon:
|
||||
connected_clients = set()
|
||||
|
||||
def __init__(self, config):
|
||||
self.ser = serial.Serial(
|
||||
config["Serial"]["Port"],
|
||||
timeout=int(config["Serial"]["Timeout"]) / 1000,
|
||||
)
|
||||
self.ser.baudrate = config["Serial"]["Baudrate"]
|
||||
self.max_clients = int(config["Daemon"]["MaxClients"])
|
||||
|
||||
def __del__(self):
|
||||
try:
|
||||
self.ser.close()
|
||||
except AttributeError:
|
||||
pass
|
||||
|
||||
def __read_serial(self):
|
||||
"""Serial reader wrapper"""
|
||||
response = b""
|
||||
while True:
|
||||
line = self.ser.read_until()
|
||||
if not line.strip(): # empty line
|
||||
break
|
||||
if line.decode().startswith("<*"):
|
||||
logging.debug("Serial debug: {}".format(line))
|
||||
else:
|
||||
response += line
|
||||
logging.debug("Serial read: {}".format(response))
|
||||
|
||||
return response
|
||||
|
||||
def __write_serial(self, data):
|
||||
"""Serial writer wrapper"""
|
||||
self.ser.write(data)
|
||||
|
||||
async def handle_echo(self, reader, writer):
|
||||
"""Process a request from socket and return the response"""
|
||||
logging.info(
|
||||
"Clients already connected: {} (max: {})".format(
|
||||
len(self.connected_clients),
|
||||
self.max_clients,
|
||||
)
|
||||
)
|
||||
|
||||
addr = writer.get_extra_info("peername")[0]
|
||||
if len(self.connected_clients) < self.max_clients:
|
||||
self.connected_clients.add(writer)
|
||||
while True: # keep connection to client open
|
||||
data = await reader.read(100)
|
||||
if not data: # client has disconnected
|
||||
break
|
||||
logging.info("Received {} from {}".format(data, addr))
|
||||
self.__write_serial(data)
|
||||
response = self.__read_serial()
|
||||
for client in self.connected_clients:
|
||||
client.write(response)
|
||||
await client.drain()
|
||||
logging.info("Sent: {}".format(response))
|
||||
self.connected_clients.remove(writer)
|
||||
else:
|
||||
logging.warning(
|
||||
"TooManyClients: client {} disconnected".format(addr)
|
||||
)
|
||||
|
||||
writer.close()
|
||||
await writer.wait_closed()
|
||||
|
||||
async def return_board(self):
|
||||
"""Return the board signature"""
|
||||
line = ""
|
||||
# drain the serial until we are ready to go
|
||||
self.__write_serial(b"<s>")
|
||||
while "DCC-EX" not in line:
|
||||
line = self.__read_serial().decode()
|
||||
board = re.findall(r"<iDCC-EX.*>", line)[0]
|
||||
return board
|
||||
|
||||
|
||||
async def main():
|
||||
config = configparser.ConfigParser()
|
||||
config.read(
|
||||
Path(__file__).resolve().parent / "config.ini"
|
||||
) # mimick os.path.join
|
||||
logging.basicConfig(level=config["Daemon"]["LogLevel"].upper())
|
||||
|
||||
sd = SerialDaemon(config)
|
||||
server = await asyncio.start_server(
|
||||
sd.handle_echo,
|
||||
config["Daemon"]["ListeningIP"],
|
||||
config["Daemon"]["ListeningPort"],
|
||||
)
|
||||
addr = server.sockets[0].getsockname()
|
||||
logging.info("Serving on {} port {}".format(addr[0], addr[1]))
|
||||
logging.info(
|
||||
"Proxying to {} (Baudrate: {}, Timeout: {})".format(
|
||||
config["Serial"]["Port"],
|
||||
config["Serial"]["Baudrate"],
|
||||
config["Serial"]["Timeout"],
|
||||
)
|
||||
)
|
||||
logging.info("Initializing board")
|
||||
logging.info("Board {} ready".format(await sd.return_board()))
|
||||
|
||||
async with server:
|
||||
await server.serve_forever()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -1 +0,0 @@
|
||||
PySerial
|
||||
Binary file not shown.
@@ -1,7 +0,0 @@
|
||||
FROM dcc/net-to-serial
|
||||
|
||||
RUN apk update && apk add qemu-system-avr && mkdir /io
|
||||
ADD start.sh /opt/dcc
|
||||
ADD CommandStation-EX*.elf /io
|
||||
|
||||
ENTRYPOINT ["/opt/dcc/start.sh"]
|
||||
@@ -1,8 +0,0 @@
|
||||
# AVR Simulator
|
||||
|
||||
`qemu-system-avr` tries to use all the CPU cicles (leaving a CPU core stuck at 100%; limit CPU core usage to 10% via `--cpus 0.1`. It can be adjusted on slower machines.
|
||||
|
||||
```bash
|
||||
$ podman build -t dcc/net-to-serial:sim .
|
||||
$ podman run --init --cpus 0.1 -d -p 2560:2560 dcc/net-to-serial:sim
|
||||
```
|
||||
43
docs/nginx/nginx.conf
Normal file
43
docs/nginx/nginx.conf
Normal file
@@ -0,0 +1,43 @@
|
||||
server {
|
||||
listen [::]:443 ssl;
|
||||
listen 443 ssl;
|
||||
server_name myhost;
|
||||
|
||||
# ssl_certificate ...;
|
||||
|
||||
add_header X-Xss-Protection "1; mode=block";
|
||||
add_header Strict-Transport-Security "max-age=15768000";
|
||||
add_header Permissions-Policy "geolocation=(),midi=(),sync-xhr=(),microphone=(),camera=(),magnetometer=(),gyroscope=(),fullscreen=(self),payment=()";
|
||||
add_header Content-Security-Policy "child-src 'none'; object-src 'none'";
|
||||
|
||||
client_max_body_size 250M;
|
||||
error_page 403 404 https://$server_name/404;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:8000;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_redirect http:// https://;
|
||||
proxy_connect_timeout 1800;
|
||||
proxy_read_timeout 1800;
|
||||
proxy_max_temp_file_size 8192m;
|
||||
}
|
||||
|
||||
# static files
|
||||
location /static {
|
||||
root /myroot/ram/storage;
|
||||
}
|
||||
|
||||
# media files
|
||||
location ~ ^/media/(images|uploads) {
|
||||
root /myroot/ram/storage;
|
||||
}
|
||||
|
||||
# protected filed to be served via X-Accel-Redirect
|
||||
location /private {
|
||||
internal;
|
||||
alias /myroot/ram/storage/media;
|
||||
}
|
||||
}
|
||||
6
package.json
Normal file
6
package.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"clean-css-cli": "^5.6.3",
|
||||
"terser": "^5.44.1"
|
||||
}
|
||||
}
|
||||
@@ -1,33 +1,45 @@
|
||||
import html
|
||||
|
||||
from django.conf import settings
|
||||
from django.contrib import admin
|
||||
from django.utils.html import (
|
||||
format_html,
|
||||
format_html_join,
|
||||
strip_tags,
|
||||
mark_safe,
|
||||
)
|
||||
from adminsortable2.admin import SortableAdminBase, SortableInlineAdminMixin
|
||||
|
||||
from ram.admin import publish, unpublish
|
||||
from ram.utils import generate_csv
|
||||
from portal.utils import get_site_conf
|
||||
from repository.models import (
|
||||
BookDocument,
|
||||
CatalogDocument,
|
||||
MagazineIssueDocument,
|
||||
)
|
||||
from bookshelf.models import (
|
||||
BaseBookProperty,
|
||||
BaseBookImage,
|
||||
BaseBookDocument,
|
||||
Book,
|
||||
Author,
|
||||
Publisher,
|
||||
Catalog,
|
||||
Magazine,
|
||||
MagazineIssue,
|
||||
TocEntry,
|
||||
)
|
||||
|
||||
|
||||
class BookImageInline(SortableInlineAdminMixin, admin.TabularInline):
|
||||
model = BaseBookImage
|
||||
min_num = 0
|
||||
extra = 0
|
||||
extra = 1
|
||||
readonly_fields = ("image_thumbnail",)
|
||||
classes = ["collapse"]
|
||||
verbose_name = "Image"
|
||||
|
||||
|
||||
class BookDocInline(admin.TabularInline):
|
||||
model = BaseBookDocument
|
||||
min_num = 0
|
||||
extra = 0
|
||||
classes = ["collapse"]
|
||||
|
||||
|
||||
class BookPropertyInline(admin.TabularInline):
|
||||
model = BaseBookProperty
|
||||
min_num = 0
|
||||
@@ -37,9 +49,38 @@ class BookPropertyInline(admin.TabularInline):
|
||||
verbose_name_plural = "Properties"
|
||||
|
||||
|
||||
class BookDocInline(admin.TabularInline):
|
||||
model = BookDocument
|
||||
min_num = 0
|
||||
extra = 1
|
||||
classes = ["collapse"]
|
||||
|
||||
|
||||
class CatalogDocInline(BookDocInline):
|
||||
model = CatalogDocument
|
||||
|
||||
|
||||
class MagazineIssueDocInline(BookDocInline):
|
||||
model = MagazineIssueDocument
|
||||
|
||||
|
||||
class BookTocInline(admin.TabularInline):
|
||||
model = TocEntry
|
||||
min_num = 0
|
||||
extra = 0
|
||||
fields = (
|
||||
"title",
|
||||
"subtitle",
|
||||
"authors",
|
||||
"page",
|
||||
"featured",
|
||||
)
|
||||
|
||||
|
||||
@admin.register(Book)
|
||||
class BookAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
inlines = (
|
||||
BookTocInline,
|
||||
BookPropertyInline,
|
||||
BookImageInline,
|
||||
BookDocInline,
|
||||
@@ -52,10 +93,10 @@ class BookAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
"number_of_pages",
|
||||
"published",
|
||||
)
|
||||
autocomplete_fields = ("authors", "publisher")
|
||||
readonly_fields = ("creation_time", "updated_time")
|
||||
autocomplete_fields = ("authors", "publisher", "shop")
|
||||
readonly_fields = ("invoices", "creation_time", "updated_time")
|
||||
search_fields = ("title", "publisher__name", "authors__last_name")
|
||||
list_filter = ("publisher__name", "authors")
|
||||
list_filter = ("publisher__name", "authors", "published")
|
||||
|
||||
fieldsets = (
|
||||
(
|
||||
@@ -71,12 +112,25 @@ class BookAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
"number_of_pages",
|
||||
"publication_year",
|
||||
"description",
|
||||
"purchase_date",
|
||||
"notes",
|
||||
"tags",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Purchase data",
|
||||
{
|
||||
"fields": (
|
||||
"shop",
|
||||
"purchase_date",
|
||||
"price",
|
||||
"invoices",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Notes",
|
||||
{"classes": ("collapse",), "fields": ("notes",)},
|
||||
),
|
||||
(
|
||||
"Audit",
|
||||
{
|
||||
@@ -89,13 +143,82 @@ class BookAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
),
|
||||
)
|
||||
|
||||
def get_form(self, request, obj=None, **kwargs):
|
||||
form = super().get_form(request, obj, **kwargs)
|
||||
form.base_fields["price"].label = "Price ({})".format(
|
||||
get_site_conf().currency
|
||||
)
|
||||
return form
|
||||
|
||||
@admin.display(description="Invoices")
|
||||
def invoices(self, obj):
|
||||
if obj.invoice.exists():
|
||||
html = format_html_join(
|
||||
mark_safe("<br>"),
|
||||
'<a href="{}" target="_blank">{}</a>',
|
||||
((i.file.url, i) for i in obj.invoice.all()),
|
||||
)
|
||||
else:
|
||||
html = "-"
|
||||
return html
|
||||
|
||||
@admin.display(description="Publisher")
|
||||
def get_publisher(self, obj):
|
||||
return obj.publisher.name
|
||||
|
||||
@admin.display(description="Authors")
|
||||
def get_authors(self, obj):
|
||||
return ", ".join(a.short_name() for a in obj.authors.all())
|
||||
return obj.authors_list
|
||||
|
||||
def download_csv(modeladmin, request, queryset):
|
||||
header = [
|
||||
"Title",
|
||||
"Authors",
|
||||
"Publisher",
|
||||
"ISBN",
|
||||
"Language",
|
||||
"Number of Pages",
|
||||
"Publication Year",
|
||||
"Description",
|
||||
"Tags",
|
||||
"Shop",
|
||||
"Purchase Date",
|
||||
"Price ({})".format(get_site_conf().currency),
|
||||
"Notes",
|
||||
"Properties",
|
||||
]
|
||||
|
||||
data = []
|
||||
for obj in queryset:
|
||||
properties = settings.CSV_SEPARATOR_ALT.join(
|
||||
"{}:{}".format(property.property.name, property.value)
|
||||
for property in obj.property.all()
|
||||
)
|
||||
data.append(
|
||||
[
|
||||
obj.title,
|
||||
obj.authors_list.replace(",", settings.CSV_SEPARATOR_ALT),
|
||||
obj.publisher.name,
|
||||
obj.ISBN,
|
||||
dict(settings.LANGUAGES)[obj.language],
|
||||
obj.number_of_pages,
|
||||
obj.publication_year,
|
||||
html.unescape(strip_tags(obj.description)),
|
||||
settings.CSV_SEPARATOR_ALT.join(
|
||||
t.name for t in obj.tags.all()
|
||||
),
|
||||
obj.shop,
|
||||
obj.purchase_date,
|
||||
obj.price,
|
||||
html.unescape(strip_tags(obj.notes)),
|
||||
properties,
|
||||
]
|
||||
)
|
||||
|
||||
return generate_csv(header, data, "bookshelf_books.csv")
|
||||
|
||||
download_csv.short_description = "Download selected items as CSV"
|
||||
actions = [publish, unpublish, download_csv]
|
||||
|
||||
|
||||
@admin.register(Author)
|
||||
@@ -109,16 +232,22 @@ class AuthorAdmin(admin.ModelAdmin):
|
||||
|
||||
@admin.register(Publisher)
|
||||
class PublisherAdmin(admin.ModelAdmin):
|
||||
list_display = ("name", "country")
|
||||
list_display = ("name", "country_flag_name")
|
||||
search_fields = ("name",)
|
||||
|
||||
@admin.display(description="Country")
|
||||
def country_flag_name(self, obj):
|
||||
return format_html(
|
||||
'<img src="{}" /> {}', obj.country.flag, obj.country.name
|
||||
)
|
||||
|
||||
|
||||
@admin.register(Catalog)
|
||||
class CatalogAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
inlines = (
|
||||
BookPropertyInline,
|
||||
BookImageInline,
|
||||
BookDocInline,
|
||||
CatalogDocInline,
|
||||
)
|
||||
list_display = (
|
||||
"__str__",
|
||||
@@ -128,9 +257,14 @@ class CatalogAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
"published",
|
||||
)
|
||||
autocomplete_fields = ("manufacturer",)
|
||||
readonly_fields = ("creation_time", "updated_time")
|
||||
readonly_fields = ("invoices", "creation_time", "updated_time")
|
||||
search_fields = ("manufacturer__name", "years", "scales__scale")
|
||||
list_filter = ("manufacturer__name", "publication_year", "scales__scale")
|
||||
list_filter = (
|
||||
"published",
|
||||
"manufacturer__name",
|
||||
"publication_year",
|
||||
"scales__scale",
|
||||
)
|
||||
|
||||
fieldsets = (
|
||||
(
|
||||
@@ -146,12 +280,25 @@ class CatalogAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
"number_of_pages",
|
||||
"publication_year",
|
||||
"description",
|
||||
"purchase_date",
|
||||
"notes",
|
||||
"tags",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Purchase data",
|
||||
{
|
||||
"fields": (
|
||||
"shop",
|
||||
"purchase_date",
|
||||
"price",
|
||||
"invoices",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Notes",
|
||||
{"classes": ("collapse",), "fields": ("notes",)},
|
||||
),
|
||||
(
|
||||
"Audit",
|
||||
{
|
||||
@@ -164,6 +311,215 @@ class CatalogAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
),
|
||||
)
|
||||
|
||||
@admin.display(description="Scales")
|
||||
def get_scales(self, obj):
|
||||
return "/".join(s.scale for s in obj.scales.all())
|
||||
def get_form(self, request, obj=None, **kwargs):
|
||||
form = super().get_form(request, obj, **kwargs)
|
||||
form.base_fields["price"].label = "Price ({})".format(
|
||||
get_site_conf().currency
|
||||
)
|
||||
return form
|
||||
|
||||
@admin.display(description="Invoices")
|
||||
def invoices(self, obj):
|
||||
if obj.invoice.exists():
|
||||
html = format_html_join(
|
||||
mark_safe("<br>"),
|
||||
'<a href="{}" target="_blank">{}</a>',
|
||||
((i.file.url, i) for i in obj.invoice.all()),
|
||||
)
|
||||
else:
|
||||
html = "-"
|
||||
return html
|
||||
|
||||
def download_csv(modeladmin, request, queryset):
|
||||
header = [
|
||||
"Catalog",
|
||||
"Manufacturer",
|
||||
"Years",
|
||||
"Scales",
|
||||
"ISBN",
|
||||
"Language",
|
||||
"Number of Pages",
|
||||
"Publication Year",
|
||||
"Description",
|
||||
"Tags",
|
||||
"Shop",
|
||||
"Purchase Date",
|
||||
"Price ({})".format(get_site_conf().currency),
|
||||
"Notes",
|
||||
"Properties",
|
||||
]
|
||||
|
||||
data = []
|
||||
for obj in queryset:
|
||||
properties = settings.CSV_SEPARATOR_ALT.join(
|
||||
"{}:{}".format(property.property.name, property.value)
|
||||
for property in obj.property.all()
|
||||
)
|
||||
data.append(
|
||||
[
|
||||
obj.__str__(),
|
||||
obj.manufacturer.name,
|
||||
obj.years,
|
||||
obj.get_scales(),
|
||||
obj.ISBN,
|
||||
dict(settings.LANGUAGES)[obj.language],
|
||||
obj.number_of_pages,
|
||||
obj.publication_year,
|
||||
html.unescape(strip_tags(obj.description)),
|
||||
settings.CSV_SEPARATOR_ALT.join(
|
||||
t.name for t in obj.tags.all()
|
||||
),
|
||||
obj.shop,
|
||||
obj.purchase_date,
|
||||
obj.price,
|
||||
html.unescape(strip_tags(obj.notes)),
|
||||
properties,
|
||||
]
|
||||
)
|
||||
|
||||
return generate_csv(header, data, "bookshelf_catalogs.csv")
|
||||
|
||||
download_csv.short_description = "Download selected items as CSV"
|
||||
actions = [publish, unpublish, download_csv]
|
||||
|
||||
|
||||
@admin.register(MagazineIssue)
|
||||
class MagazineIssueAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
inlines = (
|
||||
BookTocInline,
|
||||
BookPropertyInline,
|
||||
BookImageInline,
|
||||
MagazineIssueDocInline,
|
||||
)
|
||||
list_display = (
|
||||
"__str__",
|
||||
"issue_number",
|
||||
"published",
|
||||
)
|
||||
autocomplete_fields = ("shop",)
|
||||
readonly_fields = ("magazine", "creation_time", "updated_time")
|
||||
|
||||
def get_model_perms(self, request):
|
||||
"""
|
||||
Return empty perms dict thus hiding the model from admin index.
|
||||
"""
|
||||
return {}
|
||||
|
||||
fieldsets = (
|
||||
(
|
||||
None,
|
||||
{
|
||||
"fields": (
|
||||
"published",
|
||||
"magazine",
|
||||
"issue_number",
|
||||
"publication_year",
|
||||
"publication_month",
|
||||
"ISBN",
|
||||
"language",
|
||||
"number_of_pages",
|
||||
"description",
|
||||
"tags",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Purchase data",
|
||||
{
|
||||
"classes": ("collapse",),
|
||||
"fields": (
|
||||
"shop",
|
||||
"purchase_date",
|
||||
"price",
|
||||
),
|
||||
},
|
||||
),
|
||||
(
|
||||
"Notes",
|
||||
{"classes": ("collapse",), "fields": ("notes",)},
|
||||
),
|
||||
(
|
||||
"Audit",
|
||||
{
|
||||
"classes": ("collapse",),
|
||||
"fields": (
|
||||
"creation_time",
|
||||
"updated_time",
|
||||
),
|
||||
},
|
||||
),
|
||||
)
|
||||
actions = [publish, unpublish]
|
||||
|
||||
|
||||
class MagazineIssueInline(admin.TabularInline):
|
||||
model = MagazineIssue
|
||||
min_num = 0
|
||||
extra = 0
|
||||
autocomplete_fields = ("shop",)
|
||||
show_change_link = True
|
||||
fields = (
|
||||
"preview",
|
||||
"published",
|
||||
"issue_number",
|
||||
"publication_year",
|
||||
"publication_month",
|
||||
"number_of_pages",
|
||||
"language",
|
||||
)
|
||||
readonly_fields = ("preview",)
|
||||
|
||||
class Media:
|
||||
js = ("admin/js/magazine_issue_defaults.js",)
|
||||
|
||||
|
||||
@admin.register(Magazine)
|
||||
class MagazineAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
inlines = (MagazineIssueInline,)
|
||||
|
||||
list_display = (
|
||||
"__str__",
|
||||
"publisher",
|
||||
"published",
|
||||
)
|
||||
autocomplete_fields = ("publisher",)
|
||||
readonly_fields = ("creation_time", "updated_time")
|
||||
search_fields = ("name", "publisher__name")
|
||||
list_filter = (
|
||||
"published",
|
||||
"publisher__name",
|
||||
)
|
||||
|
||||
fieldsets = (
|
||||
(
|
||||
None,
|
||||
{
|
||||
"fields": (
|
||||
"published",
|
||||
"name",
|
||||
"website",
|
||||
"publisher",
|
||||
"ISBN",
|
||||
"language",
|
||||
"description",
|
||||
"image",
|
||||
"tags",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Notes",
|
||||
{"classes": ("collapse",), "fields": ("notes",)},
|
||||
),
|
||||
(
|
||||
"Audit",
|
||||
{
|
||||
"classes": ("collapse",),
|
||||
"fields": (
|
||||
"creation_time",
|
||||
"updated_time",
|
||||
),
|
||||
},
|
||||
),
|
||||
)
|
||||
actions = [publish, unpublish]
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
# Generated by Django 5.1.2 on 2024-11-27 16:35
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.db import migrations, models
|
||||
from django.db import migrations, models, connection
|
||||
from django.db.utils import ProgrammingError, OperationalError
|
||||
|
||||
|
||||
def basebook_to_book(apps, schema_editor):
|
||||
@@ -16,6 +17,19 @@ def basebook_to_book(apps, schema_editor):
|
||||
b.authors.set(row.old_authors.all())
|
||||
|
||||
|
||||
def drop_temporary_tables(apps, schema_editor):
|
||||
try:
|
||||
with connection.cursor() as cursor:
|
||||
cursor.execute(
|
||||
'DROP TABLE IF EXISTS bookshelf_basebook_old_authors'
|
||||
)
|
||||
cursor.execute(
|
||||
'DROP TABLE IF EXISTS bookshelf_basebook_authors'
|
||||
)
|
||||
except (ProgrammingError, OperationalError):
|
||||
pass
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
@@ -101,10 +115,6 @@ class Migration(migrations.Migration):
|
||||
model_name="basebook",
|
||||
name="old_title",
|
||||
),
|
||||
migrations.RemoveField(
|
||||
model_name="basebook",
|
||||
name="old_authors",
|
||||
),
|
||||
migrations.RemoveField(
|
||||
model_name="basebook",
|
||||
name="old_publisher",
|
||||
@@ -138,4 +148,16 @@ class Migration(migrations.Migration):
|
||||
},
|
||||
bases=("bookshelf.basebook",),
|
||||
),
|
||||
# Required by Dajngo 6.0 on SQLite
|
||||
migrations.SeparateDatabaseAndState(
|
||||
state_operations=[
|
||||
migrations.RemoveField(
|
||||
model_name="basebook",
|
||||
name="old_authors",
|
||||
),
|
||||
],
|
||||
database_operations=[
|
||||
migrations.RunPython(drop_temporary_tables)
|
||||
]
|
||||
),
|
||||
]
|
||||
|
||||
36
ram/bookshelf/migrations/0019_basebook_price.py
Normal file
36
ram/bookshelf/migrations/0019_basebook_price.py
Normal file
@@ -0,0 +1,36 @@
|
||||
# Generated by Django 5.1.4 on 2024-12-29 17:06
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
def price_to_property(apps, schema_editor):
|
||||
basebook = apps.get_model("bookshelf", "BaseBook")
|
||||
for row in basebook.objects.all():
|
||||
prop = row.property.filter(property__name__icontains="price")
|
||||
for p in prop:
|
||||
try:
|
||||
row.price = float(p.value)
|
||||
except ValueError:
|
||||
pass
|
||||
row.save()
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0018_alter_basebookdocument_options"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="basebook",
|
||||
name="price",
|
||||
field=models.DecimalField(
|
||||
blank=True, decimal_places=2, max_digits=10, null=True
|
||||
),
|
||||
),
|
||||
migrations.RunPython(
|
||||
price_to_property,
|
||||
reverse_code=migrations.RunPython.noop
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,23 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-08 22:25
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0019_basebook_price"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterUniqueTogether(
|
||||
name="basebookdocument",
|
||||
unique_together=set(),
|
||||
),
|
||||
migrations.AddConstraint(
|
||||
model_name="basebookdocument",
|
||||
constraint=models.UniqueConstraint(
|
||||
fields=("book", "file"), name="unique_book_file"
|
||||
),
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,34 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-18 11:20
|
||||
|
||||
import django.utils.timezone
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0020_alter_basebookdocument_unique_together_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="basebookdocument",
|
||||
name="creation_time",
|
||||
field=models.DateTimeField(
|
||||
auto_now_add=True, default=django.utils.timezone.now
|
||||
),
|
||||
preserve_default=False,
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="basebookdocument",
|
||||
name="updated_time",
|
||||
field=models.DateTimeField(auto_now=True),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="basebookdocument",
|
||||
name="private",
|
||||
field=models.BooleanField(
|
||||
default=False, help_text="Document will be visible only to logged users"
|
||||
),
|
||||
),
|
||||
]
|
||||
50
ram/bookshelf/migrations/0022_basebook_shop.py
Normal file
50
ram/bookshelf/migrations/0022_basebook_shop.py
Normal file
@@ -0,0 +1,50 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-26 14:32
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
def shop_from_property(apps, schema_editor):
|
||||
basebook = apps.get_model("bookshelf", "BaseBook")
|
||||
shop_model = apps.get_model("metadata", "Shop")
|
||||
for row in basebook.objects.all():
|
||||
property = row.property.filter(
|
||||
property__name__icontains="shop"
|
||||
).first()
|
||||
if property:
|
||||
shop, created = shop_model.objects.get_or_create(
|
||||
name=property.value,
|
||||
defaults={"on_line": False}
|
||||
)
|
||||
|
||||
row.shop = shop
|
||||
row.save()
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0021_basebookdocument_creation_time_and_more"),
|
||||
("metadata", "0023_shop"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.RemoveConstraint(
|
||||
model_name="basebookdocument",
|
||||
name="unique_book_file",
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="basebook",
|
||||
name="shop",
|
||||
field=models.ForeignKey(
|
||||
blank=True,
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
to="metadata.shop",
|
||||
),
|
||||
),
|
||||
migrations.RunPython(
|
||||
shop_from_property,
|
||||
reverse_code=migrations.RunPython.noop
|
||||
),
|
||||
]
|
||||
17
ram/bookshelf/migrations/0023_delete_basebookdocument.py
Normal file
17
ram/bookshelf/migrations/0023_delete_basebookdocument.py
Normal file
@@ -0,0 +1,17 @@
|
||||
# Generated by Django 5.1.4 on 2025-02-09 13:47
|
||||
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0022_basebook_shop"),
|
||||
("repository", "0001_initial"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.DeleteModel(
|
||||
name="BaseBookDocument",
|
||||
),
|
||||
]
|
||||
123
ram/bookshelf/migrations/0024_alter_basebook_language.py
Normal file
123
ram/bookshelf/migrations/0024_alter_basebook_language.py
Normal file
@@ -0,0 +1,123 @@
|
||||
# Generated by Django 6.0 on 2025-12-03 22:07
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0023_delete_basebookdocument"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="basebook",
|
||||
name="language",
|
||||
field=models.CharField(
|
||||
choices=[
|
||||
("af", "Afrikaans"),
|
||||
("ar", "Arabic"),
|
||||
("ar-dz", "Algerian Arabic"),
|
||||
("ast", "Asturian"),
|
||||
("az", "Azerbaijani"),
|
||||
("bg", "Bulgarian"),
|
||||
("be", "Belarusian"),
|
||||
("bn", "Bengali"),
|
||||
("br", "Breton"),
|
||||
("bs", "Bosnian"),
|
||||
("ca", "Catalan"),
|
||||
("ckb", "Central Kurdish (Sorani)"),
|
||||
("cs", "Czech"),
|
||||
("cy", "Welsh"),
|
||||
("da", "Danish"),
|
||||
("de", "German"),
|
||||
("dsb", "Lower Sorbian"),
|
||||
("el", "Greek"),
|
||||
("en", "English"),
|
||||
("en-au", "Australian English"),
|
||||
("en-gb", "British English"),
|
||||
("eo", "Esperanto"),
|
||||
("es", "Spanish"),
|
||||
("es-ar", "Argentinian Spanish"),
|
||||
("es-co", "Colombian Spanish"),
|
||||
("es-mx", "Mexican Spanish"),
|
||||
("es-ni", "Nicaraguan Spanish"),
|
||||
("es-ve", "Venezuelan Spanish"),
|
||||
("et", "Estonian"),
|
||||
("eu", "Basque"),
|
||||
("fa", "Persian"),
|
||||
("fi", "Finnish"),
|
||||
("fr", "French"),
|
||||
("fy", "Frisian"),
|
||||
("ga", "Irish"),
|
||||
("gd", "Scottish Gaelic"),
|
||||
("gl", "Galician"),
|
||||
("he", "Hebrew"),
|
||||
("hi", "Hindi"),
|
||||
("hr", "Croatian"),
|
||||
("hsb", "Upper Sorbian"),
|
||||
("ht", "Haitian Creole"),
|
||||
("hu", "Hungarian"),
|
||||
("hy", "Armenian"),
|
||||
("ia", "Interlingua"),
|
||||
("id", "Indonesian"),
|
||||
("ig", "Igbo"),
|
||||
("io", "Ido"),
|
||||
("is", "Icelandic"),
|
||||
("it", "Italian"),
|
||||
("ja", "Japanese"),
|
||||
("ka", "Georgian"),
|
||||
("kab", "Kabyle"),
|
||||
("kk", "Kazakh"),
|
||||
("km", "Khmer"),
|
||||
("kn", "Kannada"),
|
||||
("ko", "Korean"),
|
||||
("ky", "Kyrgyz"),
|
||||
("lb", "Luxembourgish"),
|
||||
("lt", "Lithuanian"),
|
||||
("lv", "Latvian"),
|
||||
("mk", "Macedonian"),
|
||||
("ml", "Malayalam"),
|
||||
("mn", "Mongolian"),
|
||||
("mr", "Marathi"),
|
||||
("ms", "Malay"),
|
||||
("my", "Burmese"),
|
||||
("nb", "Norwegian Bokmål"),
|
||||
("ne", "Nepali"),
|
||||
("nl", "Dutch"),
|
||||
("nn", "Norwegian Nynorsk"),
|
||||
("os", "Ossetic"),
|
||||
("pa", "Punjabi"),
|
||||
("pl", "Polish"),
|
||||
("pt", "Portuguese"),
|
||||
("pt-br", "Brazilian Portuguese"),
|
||||
("ro", "Romanian"),
|
||||
("ru", "Russian"),
|
||||
("sk", "Slovak"),
|
||||
("sl", "Slovenian"),
|
||||
("sq", "Albanian"),
|
||||
("sr", "Serbian"),
|
||||
("sr-latn", "Serbian Latin"),
|
||||
("sv", "Swedish"),
|
||||
("sw", "Swahili"),
|
||||
("ta", "Tamil"),
|
||||
("te", "Telugu"),
|
||||
("tg", "Tajik"),
|
||||
("th", "Thai"),
|
||||
("tk", "Turkmen"),
|
||||
("tr", "Turkish"),
|
||||
("tt", "Tatar"),
|
||||
("udm", "Udmurt"),
|
||||
("ug", "Uyghur"),
|
||||
("uk", "Ukrainian"),
|
||||
("ur", "Urdu"),
|
||||
("uz", "Uzbek"),
|
||||
("vi", "Vietnamese"),
|
||||
("zh-hans", "Simplified Chinese"),
|
||||
("zh-hant", "Traditional Chinese"),
|
||||
],
|
||||
default="en",
|
||||
max_length=7,
|
||||
),
|
||||
),
|
||||
]
|
||||
224
ram/bookshelf/migrations/0025_magazine_magazineissue.py
Normal file
224
ram/bookshelf/migrations/0025_magazine_magazineissue.py
Normal file
@@ -0,0 +1,224 @@
|
||||
# Generated by Django 6.0 on 2025-12-08 17:47
|
||||
|
||||
import bookshelf.models
|
||||
import django.db.models.deletion
|
||||
import ram.utils
|
||||
import tinymce.models
|
||||
import uuid
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0024_alter_basebook_language"),
|
||||
("metadata", "0025_alter_company_options_alter_manufacturer_options_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="Magazine",
|
||||
fields=[
|
||||
(
|
||||
"uuid",
|
||||
models.UUIDField(
|
||||
default=uuid.uuid4,
|
||||
editable=False,
|
||||
primary_key=True,
|
||||
serialize=False,
|
||||
),
|
||||
),
|
||||
("description", tinymce.models.HTMLField(blank=True)),
|
||||
("notes", tinymce.models.HTMLField(blank=True)),
|
||||
("creation_time", models.DateTimeField(auto_now_add=True)),
|
||||
("updated_time", models.DateTimeField(auto_now=True)),
|
||||
("published", models.BooleanField(default=True)),
|
||||
("name", models.CharField(max_length=200)),
|
||||
("ISBN", models.CharField(blank=True, max_length=17)),
|
||||
(
|
||||
"image",
|
||||
models.ImageField(
|
||||
blank=True,
|
||||
storage=ram.utils.DeduplicatedStorage,
|
||||
upload_to=bookshelf.models.book_image_upload,
|
||||
),
|
||||
),
|
||||
(
|
||||
"language",
|
||||
models.CharField(
|
||||
choices=[
|
||||
("af", "Afrikaans"),
|
||||
("ar", "Arabic"),
|
||||
("ar-dz", "Algerian Arabic"),
|
||||
("ast", "Asturian"),
|
||||
("az", "Azerbaijani"),
|
||||
("bg", "Bulgarian"),
|
||||
("be", "Belarusian"),
|
||||
("bn", "Bengali"),
|
||||
("br", "Breton"),
|
||||
("bs", "Bosnian"),
|
||||
("ca", "Catalan"),
|
||||
("ckb", "Central Kurdish (Sorani)"),
|
||||
("cs", "Czech"),
|
||||
("cy", "Welsh"),
|
||||
("da", "Danish"),
|
||||
("de", "German"),
|
||||
("dsb", "Lower Sorbian"),
|
||||
("el", "Greek"),
|
||||
("en", "English"),
|
||||
("en-au", "Australian English"),
|
||||
("en-gb", "British English"),
|
||||
("eo", "Esperanto"),
|
||||
("es", "Spanish"),
|
||||
("es-ar", "Argentinian Spanish"),
|
||||
("es-co", "Colombian Spanish"),
|
||||
("es-mx", "Mexican Spanish"),
|
||||
("es-ni", "Nicaraguan Spanish"),
|
||||
("es-ve", "Venezuelan Spanish"),
|
||||
("et", "Estonian"),
|
||||
("eu", "Basque"),
|
||||
("fa", "Persian"),
|
||||
("fi", "Finnish"),
|
||||
("fr", "French"),
|
||||
("fy", "Frisian"),
|
||||
("ga", "Irish"),
|
||||
("gd", "Scottish Gaelic"),
|
||||
("gl", "Galician"),
|
||||
("he", "Hebrew"),
|
||||
("hi", "Hindi"),
|
||||
("hr", "Croatian"),
|
||||
("hsb", "Upper Sorbian"),
|
||||
("ht", "Haitian Creole"),
|
||||
("hu", "Hungarian"),
|
||||
("hy", "Armenian"),
|
||||
("ia", "Interlingua"),
|
||||
("id", "Indonesian"),
|
||||
("ig", "Igbo"),
|
||||
("io", "Ido"),
|
||||
("is", "Icelandic"),
|
||||
("it", "Italian"),
|
||||
("ja", "Japanese"),
|
||||
("ka", "Georgian"),
|
||||
("kab", "Kabyle"),
|
||||
("kk", "Kazakh"),
|
||||
("km", "Khmer"),
|
||||
("kn", "Kannada"),
|
||||
("ko", "Korean"),
|
||||
("ky", "Kyrgyz"),
|
||||
("lb", "Luxembourgish"),
|
||||
("lt", "Lithuanian"),
|
||||
("lv", "Latvian"),
|
||||
("mk", "Macedonian"),
|
||||
("ml", "Malayalam"),
|
||||
("mn", "Mongolian"),
|
||||
("mr", "Marathi"),
|
||||
("ms", "Malay"),
|
||||
("my", "Burmese"),
|
||||
("nb", "Norwegian Bokmål"),
|
||||
("ne", "Nepali"),
|
||||
("nl", "Dutch"),
|
||||
("nn", "Norwegian Nynorsk"),
|
||||
("os", "Ossetic"),
|
||||
("pa", "Punjabi"),
|
||||
("pl", "Polish"),
|
||||
("pt", "Portuguese"),
|
||||
("pt-br", "Brazilian Portuguese"),
|
||||
("ro", "Romanian"),
|
||||
("ru", "Russian"),
|
||||
("sk", "Slovak"),
|
||||
("sl", "Slovenian"),
|
||||
("sq", "Albanian"),
|
||||
("sr", "Serbian"),
|
||||
("sr-latn", "Serbian Latin"),
|
||||
("sv", "Swedish"),
|
||||
("sw", "Swahili"),
|
||||
("ta", "Tamil"),
|
||||
("te", "Telugu"),
|
||||
("tg", "Tajik"),
|
||||
("th", "Thai"),
|
||||
("tk", "Turkmen"),
|
||||
("tr", "Turkish"),
|
||||
("tt", "Tatar"),
|
||||
("udm", "Udmurt"),
|
||||
("ug", "Uyghur"),
|
||||
("uk", "Ukrainian"),
|
||||
("ur", "Urdu"),
|
||||
("uz", "Uzbek"),
|
||||
("vi", "Vietnamese"),
|
||||
("zh-hans", "Simplified Chinese"),
|
||||
("zh-hant", "Traditional Chinese"),
|
||||
],
|
||||
default="en",
|
||||
max_length=7,
|
||||
),
|
||||
),
|
||||
(
|
||||
"publisher",
|
||||
models.ForeignKey(
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
to="bookshelf.publisher",
|
||||
),
|
||||
),
|
||||
(
|
||||
"tags",
|
||||
models.ManyToManyField(
|
||||
blank=True, related_name="magazine", to="metadata.tag"
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"ordering": ["name"],
|
||||
},
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name="MagazineIssue",
|
||||
fields=[
|
||||
(
|
||||
"basebook_ptr",
|
||||
models.OneToOneField(
|
||||
auto_created=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
parent_link=True,
|
||||
primary_key=True,
|
||||
serialize=False,
|
||||
to="bookshelf.basebook",
|
||||
),
|
||||
),
|
||||
("issue_number", models.CharField(max_length=100)),
|
||||
(
|
||||
"publication_month",
|
||||
models.SmallIntegerField(
|
||||
blank=True,
|
||||
choices=[
|
||||
(1, "January"),
|
||||
(2, "February"),
|
||||
(3, "March"),
|
||||
(4, "April"),
|
||||
(5, "May"),
|
||||
(6, "June"),
|
||||
(7, "July"),
|
||||
(8, "August"),
|
||||
(9, "September"),
|
||||
(10, "October"),
|
||||
(11, "November"),
|
||||
(12, "December"),
|
||||
],
|
||||
null=True,
|
||||
),
|
||||
),
|
||||
(
|
||||
"magazine",
|
||||
models.ForeignKey(
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="issue",
|
||||
to="bookshelf.magazine",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"ordering": ["magazine", "issue_number"],
|
||||
"unique_together": {("magazine", "issue_number")},
|
||||
},
|
||||
bases=("bookshelf.basebook",),
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,244 @@
|
||||
# Generated by Django 6.0 on 2025-12-10 20:59
|
||||
|
||||
import bookshelf.models
|
||||
import ram.utils
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0025_magazine_magazineissue"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="basebook",
|
||||
name="language",
|
||||
field=models.CharField(
|
||||
choices=[
|
||||
("af", "Afrikaans"),
|
||||
("sq", "Albanian"),
|
||||
("ar-dz", "Algerian Arabic"),
|
||||
("ar", "Arabic"),
|
||||
("es-ar", "Argentinian Spanish"),
|
||||
("hy", "Armenian"),
|
||||
("ast", "Asturian"),
|
||||
("en-au", "Australian English"),
|
||||
("az", "Azerbaijani"),
|
||||
("eu", "Basque"),
|
||||
("be", "Belarusian"),
|
||||
("bn", "Bengali"),
|
||||
("bs", "Bosnian"),
|
||||
("pt-br", "Brazilian Portuguese"),
|
||||
("br", "Breton"),
|
||||
("en-gb", "British English"),
|
||||
("bg", "Bulgarian"),
|
||||
("my", "Burmese"),
|
||||
("ca", "Catalan"),
|
||||
("ckb", "Central Kurdish (Sorani)"),
|
||||
("es-co", "Colombian Spanish"),
|
||||
("hr", "Croatian"),
|
||||
("cs", "Czech"),
|
||||
("da", "Danish"),
|
||||
("nl", "Dutch"),
|
||||
("en", "English"),
|
||||
("eo", "Esperanto"),
|
||||
("et", "Estonian"),
|
||||
("fi", "Finnish"),
|
||||
("fr", "French"),
|
||||
("fy", "Frisian"),
|
||||
("gl", "Galician"),
|
||||
("ka", "Georgian"),
|
||||
("de", "German"),
|
||||
("el", "Greek"),
|
||||
("ht", "Haitian Creole"),
|
||||
("he", "Hebrew"),
|
||||
("hi", "Hindi"),
|
||||
("hu", "Hungarian"),
|
||||
("is", "Icelandic"),
|
||||
("io", "Ido"),
|
||||
("ig", "Igbo"),
|
||||
("id", "Indonesian"),
|
||||
("ia", "Interlingua"),
|
||||
("ga", "Irish"),
|
||||
("it", "Italian"),
|
||||
("ja", "Japanese"),
|
||||
("kab", "Kabyle"),
|
||||
("kn", "Kannada"),
|
||||
("kk", "Kazakh"),
|
||||
("km", "Khmer"),
|
||||
("ko", "Korean"),
|
||||
("ky", "Kyrgyz"),
|
||||
("lv", "Latvian"),
|
||||
("lt", "Lithuanian"),
|
||||
("dsb", "Lower Sorbian"),
|
||||
("lb", "Luxembourgish"),
|
||||
("mk", "Macedonian"),
|
||||
("ms", "Malay"),
|
||||
("ml", "Malayalam"),
|
||||
("mr", "Marathi"),
|
||||
("es-mx", "Mexican Spanish"),
|
||||
("mn", "Mongolian"),
|
||||
("ne", "Nepali"),
|
||||
("es-ni", "Nicaraguan Spanish"),
|
||||
("nb", "Norwegian Bokmål"),
|
||||
("nn", "Norwegian Nynorsk"),
|
||||
("os", "Ossetic"),
|
||||
("fa", "Persian"),
|
||||
("pl", "Polish"),
|
||||
("pt", "Portuguese"),
|
||||
("pa", "Punjabi"),
|
||||
("ro", "Romanian"),
|
||||
("ru", "Russian"),
|
||||
("gd", "Scottish Gaelic"),
|
||||
("sr", "Serbian"),
|
||||
("sr-latn", "Serbian Latin"),
|
||||
("zh-hans", "Simplified Chinese"),
|
||||
("sk", "Slovak"),
|
||||
("sl", "Slovenian"),
|
||||
("es", "Spanish"),
|
||||
("sw", "Swahili"),
|
||||
("sv", "Swedish"),
|
||||
("tg", "Tajik"),
|
||||
("ta", "Tamil"),
|
||||
("tt", "Tatar"),
|
||||
("te", "Telugu"),
|
||||
("th", "Thai"),
|
||||
("zh-hant", "Traditional Chinese"),
|
||||
("tr", "Turkish"),
|
||||
("tk", "Turkmen"),
|
||||
("udm", "Udmurt"),
|
||||
("uk", "Ukrainian"),
|
||||
("hsb", "Upper Sorbian"),
|
||||
("ur", "Urdu"),
|
||||
("ug", "Uyghur"),
|
||||
("uz", "Uzbek"),
|
||||
("es-ve", "Venezuelan Spanish"),
|
||||
("vi", "Vietnamese"),
|
||||
("cy", "Welsh"),
|
||||
],
|
||||
default="en",
|
||||
max_length=7,
|
||||
),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="magazine",
|
||||
name="image",
|
||||
field=models.ImageField(
|
||||
blank=True,
|
||||
storage=ram.utils.DeduplicatedStorage,
|
||||
upload_to=bookshelf.models.magazine_image_upload,
|
||||
),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="magazine",
|
||||
name="language",
|
||||
field=models.CharField(
|
||||
choices=[
|
||||
("af", "Afrikaans"),
|
||||
("sq", "Albanian"),
|
||||
("ar-dz", "Algerian Arabic"),
|
||||
("ar", "Arabic"),
|
||||
("es-ar", "Argentinian Spanish"),
|
||||
("hy", "Armenian"),
|
||||
("ast", "Asturian"),
|
||||
("en-au", "Australian English"),
|
||||
("az", "Azerbaijani"),
|
||||
("eu", "Basque"),
|
||||
("be", "Belarusian"),
|
||||
("bn", "Bengali"),
|
||||
("bs", "Bosnian"),
|
||||
("pt-br", "Brazilian Portuguese"),
|
||||
("br", "Breton"),
|
||||
("en-gb", "British English"),
|
||||
("bg", "Bulgarian"),
|
||||
("my", "Burmese"),
|
||||
("ca", "Catalan"),
|
||||
("ckb", "Central Kurdish (Sorani)"),
|
||||
("es-co", "Colombian Spanish"),
|
||||
("hr", "Croatian"),
|
||||
("cs", "Czech"),
|
||||
("da", "Danish"),
|
||||
("nl", "Dutch"),
|
||||
("en", "English"),
|
||||
("eo", "Esperanto"),
|
||||
("et", "Estonian"),
|
||||
("fi", "Finnish"),
|
||||
("fr", "French"),
|
||||
("fy", "Frisian"),
|
||||
("gl", "Galician"),
|
||||
("ka", "Georgian"),
|
||||
("de", "German"),
|
||||
("el", "Greek"),
|
||||
("ht", "Haitian Creole"),
|
||||
("he", "Hebrew"),
|
||||
("hi", "Hindi"),
|
||||
("hu", "Hungarian"),
|
||||
("is", "Icelandic"),
|
||||
("io", "Ido"),
|
||||
("ig", "Igbo"),
|
||||
("id", "Indonesian"),
|
||||
("ia", "Interlingua"),
|
||||
("ga", "Irish"),
|
||||
("it", "Italian"),
|
||||
("ja", "Japanese"),
|
||||
("kab", "Kabyle"),
|
||||
("kn", "Kannada"),
|
||||
("kk", "Kazakh"),
|
||||
("km", "Khmer"),
|
||||
("ko", "Korean"),
|
||||
("ky", "Kyrgyz"),
|
||||
("lv", "Latvian"),
|
||||
("lt", "Lithuanian"),
|
||||
("dsb", "Lower Sorbian"),
|
||||
("lb", "Luxembourgish"),
|
||||
("mk", "Macedonian"),
|
||||
("ms", "Malay"),
|
||||
("ml", "Malayalam"),
|
||||
("mr", "Marathi"),
|
||||
("es-mx", "Mexican Spanish"),
|
||||
("mn", "Mongolian"),
|
||||
("ne", "Nepali"),
|
||||
("es-ni", "Nicaraguan Spanish"),
|
||||
("nb", "Norwegian Bokmål"),
|
||||
("nn", "Norwegian Nynorsk"),
|
||||
("os", "Ossetic"),
|
||||
("fa", "Persian"),
|
||||
("pl", "Polish"),
|
||||
("pt", "Portuguese"),
|
||||
("pa", "Punjabi"),
|
||||
("ro", "Romanian"),
|
||||
("ru", "Russian"),
|
||||
("gd", "Scottish Gaelic"),
|
||||
("sr", "Serbian"),
|
||||
("sr-latn", "Serbian Latin"),
|
||||
("zh-hans", "Simplified Chinese"),
|
||||
("sk", "Slovak"),
|
||||
("sl", "Slovenian"),
|
||||
("es", "Spanish"),
|
||||
("sw", "Swahili"),
|
||||
("sv", "Swedish"),
|
||||
("tg", "Tajik"),
|
||||
("ta", "Tamil"),
|
||||
("tt", "Tatar"),
|
||||
("te", "Telugu"),
|
||||
("th", "Thai"),
|
||||
("zh-hant", "Traditional Chinese"),
|
||||
("tr", "Turkish"),
|
||||
("tk", "Turkmen"),
|
||||
("udm", "Udmurt"),
|
||||
("uk", "Ukrainian"),
|
||||
("hsb", "Upper Sorbian"),
|
||||
("ur", "Urdu"),
|
||||
("ug", "Uyghur"),
|
||||
("uz", "Uzbek"),
|
||||
("es-ve", "Venezuelan Spanish"),
|
||||
("vi", "Vietnamese"),
|
||||
("cy", "Welsh"),
|
||||
],
|
||||
default="en",
|
||||
max_length=7,
|
||||
),
|
||||
),
|
||||
]
|
||||
18
ram/bookshelf/migrations/0027_magazine_website.py
Normal file
18
ram/bookshelf/migrations/0027_magazine_website.py
Normal file
@@ -0,0 +1,18 @@
|
||||
# Generated by Django 6.0 on 2025-12-12 14:02
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0026_alter_basebook_language_alter_magazine_image_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="magazine",
|
||||
name="website",
|
||||
field=models.URLField(blank=True),
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,29 @@
|
||||
# Generated by Django 6.0 on 2025-12-21 21:56
|
||||
|
||||
import django.db.models.functions.text
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0027_magazine_website"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterModelOptions(
|
||||
name="magazine",
|
||||
options={"ordering": [django.db.models.functions.text.Lower("name")]},
|
||||
),
|
||||
migrations.AlterModelOptions(
|
||||
name="magazineissue",
|
||||
options={
|
||||
"ordering": [
|
||||
"magazine",
|
||||
"publication_year",
|
||||
"publication_month",
|
||||
"issue_number",
|
||||
]
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,29 @@
|
||||
# Generated by Django 6.0 on 2025-12-23 11:18
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0028_alter_magazine_options_alter_magazineissue_options"),
|
||||
("metadata", "0025_alter_company_options_alter_manufacturer_options_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="catalog",
|
||||
name="manufacturer",
|
||||
field=models.ForeignKey(
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="catalogs",
|
||||
to="metadata.manufacturer",
|
||||
),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="catalog",
|
||||
name="scales",
|
||||
field=models.ManyToManyField(related_name="catalogs", to="metadata.scale"),
|
||||
),
|
||||
]
|
||||
53
ram/bookshelf/migrations/0030_tocentry.py
Normal file
53
ram/bookshelf/migrations/0030_tocentry.py
Normal file
@@ -0,0 +1,53 @@
|
||||
# Generated by Django 6.0 on 2025-12-29 11:02
|
||||
|
||||
import django.db.models.deletion
|
||||
import tinymce.models
|
||||
import uuid
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0029_alter_catalog_manufacturer_alter_catalog_scales"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="TocEntry",
|
||||
fields=[
|
||||
(
|
||||
"uuid",
|
||||
models.UUIDField(
|
||||
default=uuid.uuid4,
|
||||
editable=False,
|
||||
primary_key=True,
|
||||
serialize=False,
|
||||
),
|
||||
),
|
||||
("description", tinymce.models.HTMLField(blank=True)),
|
||||
("notes", tinymce.models.HTMLField(blank=True)),
|
||||
("creation_time", models.DateTimeField(auto_now_add=True)),
|
||||
("updated_time", models.DateTimeField(auto_now=True)),
|
||||
("published", models.BooleanField(default=True)),
|
||||
("title", models.CharField(max_length=200)),
|
||||
("subtitle", models.CharField(blank=True, max_length=200)),
|
||||
("authors", models.CharField(blank=True, max_length=256)),
|
||||
("page", models.SmallIntegerField()),
|
||||
("featured", models.BooleanField(default=False)),
|
||||
(
|
||||
"book",
|
||||
models.ForeignKey(
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
related_name="toc",
|
||||
to="bookshelf.basebook",
|
||||
),
|
||||
),
|
||||
],
|
||||
options={
|
||||
"verbose_name": "Table of Contents Entry",
|
||||
"verbose_name_plural": "Table of Contents Entries",
|
||||
"ordering": ["page"],
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,28 @@
|
||||
# Generated by Django 6.0 on 2025-12-31 13:47
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("bookshelf", "0030_tocentry"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="tocentry",
|
||||
name="authors",
|
||||
field=models.CharField(blank=True),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="tocentry",
|
||||
name="subtitle",
|
||||
field=models.CharField(blank=True),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="tocentry",
|
||||
name="title",
|
||||
field=models.CharField(),
|
||||
),
|
||||
]
|
||||
@@ -1,16 +1,17 @@
|
||||
import os
|
||||
import shutil
|
||||
from urllib.parse import urlparse
|
||||
from django.db import models
|
||||
from django.conf import settings
|
||||
from django.urls import reverse
|
||||
from django.utils.dates import MONTHS
|
||||
from django.db.models.functions import Lower
|
||||
from django.core.exceptions import ValidationError
|
||||
from django_countries.fields import CountryField
|
||||
|
||||
from tinymce import models as tinymce
|
||||
|
||||
from metadata.models import Tag
|
||||
from ram.utils import DeduplicatedStorage
|
||||
from ram.models import BaseModel, Image, Document, PropertyInstance
|
||||
from metadata.models import Scale, Manufacturer
|
||||
from ram.models import BaseModel, Image, PropertyInstance
|
||||
from metadata.models import Scale, Manufacturer, Shop, Tag
|
||||
|
||||
|
||||
class Publisher(models.Model):
|
||||
@@ -35,6 +36,7 @@ class Author(models.Model):
|
||||
def __str__(self):
|
||||
return f"{self.last_name}, {self.first_name}"
|
||||
|
||||
@property
|
||||
def short_name(self):
|
||||
return f"{self.last_name} {self.first_name[0]}."
|
||||
|
||||
@@ -43,34 +45,39 @@ class BaseBook(BaseModel):
|
||||
ISBN = models.CharField(max_length=17, blank=True) # 13 + dashes
|
||||
language = models.CharField(
|
||||
max_length=7,
|
||||
choices=settings.LANGUAGES,
|
||||
default='en'
|
||||
choices=sorted(settings.LANGUAGES, key=lambda s: s[1]),
|
||||
default="en",
|
||||
)
|
||||
number_of_pages = models.SmallIntegerField(null=True, blank=True)
|
||||
publication_year = models.SmallIntegerField(null=True, blank=True)
|
||||
description = tinymce.HTMLField(blank=True)
|
||||
purchase_date = models.DateField(null=True, blank=True)
|
||||
tags = models.ManyToManyField(
|
||||
Tag, related_name="bookshelf", blank=True
|
||||
shop = models.ForeignKey(
|
||||
Shop, on_delete=models.CASCADE, null=True, blank=True
|
||||
)
|
||||
price = models.DecimalField(
|
||||
max_digits=10,
|
||||
decimal_places=2,
|
||||
null=True,
|
||||
blank=True,
|
||||
)
|
||||
purchase_date = models.DateField(null=True, blank=True)
|
||||
tags = models.ManyToManyField(Tag, related_name="bookshelf", blank=True)
|
||||
|
||||
def delete(self, *args, **kwargs):
|
||||
shutil.rmtree(
|
||||
os.path.join(
|
||||
settings.MEDIA_ROOT, "images", "books", str(self.uuid)
|
||||
),
|
||||
ignore_errors=True
|
||||
ignore_errors=True,
|
||||
)
|
||||
super(BaseBook, self).delete(*args, **kwargs)
|
||||
|
||||
|
||||
def book_image_upload(instance, filename):
|
||||
return os.path.join(
|
||||
"images",
|
||||
"books",
|
||||
str(instance.book.uuid),
|
||||
filename
|
||||
)
|
||||
return os.path.join("images", "books", str(instance.book.uuid), filename)
|
||||
|
||||
|
||||
def magazine_image_upload(instance, filename):
|
||||
return os.path.join("images", "magazines", str(instance.uuid), filename)
|
||||
|
||||
|
||||
class BaseBookImage(Image):
|
||||
@@ -83,16 +90,6 @@ class BaseBookImage(Image):
|
||||
)
|
||||
|
||||
|
||||
class BaseBookDocument(Document):
|
||||
book = models.ForeignKey(
|
||||
BaseBook, on_delete=models.CASCADE, related_name="document"
|
||||
)
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural = "Documents"
|
||||
unique_together = ("book", "file")
|
||||
|
||||
|
||||
class BaseBookProperty(PropertyInstance):
|
||||
book = models.ForeignKey(
|
||||
BaseBook,
|
||||
@@ -114,13 +111,17 @@ class Book(BaseBook):
|
||||
def __str__(self):
|
||||
return self.title
|
||||
|
||||
@property
|
||||
def publisher_name(self):
|
||||
return self.publisher.name
|
||||
|
||||
@property
|
||||
def authors_list(self):
|
||||
return ", ".join(a.short_name for a in self.authors.all())
|
||||
|
||||
def get_absolute_url(self):
|
||||
return reverse(
|
||||
"bookshelf_item",
|
||||
kwargs={"selector": "book", "uuid": self.uuid}
|
||||
"bookshelf_item", kwargs={"selector": "book", "uuid": self.uuid}
|
||||
)
|
||||
|
||||
|
||||
@@ -128,23 +129,160 @@ class Catalog(BaseBook):
|
||||
manufacturer = models.ForeignKey(
|
||||
Manufacturer,
|
||||
on_delete=models.CASCADE,
|
||||
related_name="catalogs",
|
||||
)
|
||||
years = models.CharField(max_length=12)
|
||||
scales = models.ManyToManyField(Scale)
|
||||
scales = models.ManyToManyField(Scale, related_name="catalogs")
|
||||
|
||||
class Meta:
|
||||
ordering = ["manufacturer", "publication_year"]
|
||||
|
||||
def __str__(self):
|
||||
scales = self.get_scales
|
||||
# if the object is new, return an empty string to avoid
|
||||
# calling self.scales.all() which would raise a infinite recursion
|
||||
if self.pk is None:
|
||||
return str() # empty string
|
||||
scales = self.get_scales()
|
||||
return "%s %s %s" % (self.manufacturer.name, self.years, scales)
|
||||
|
||||
def get_absolute_url(self):
|
||||
return reverse(
|
||||
"bookshelf_item",
|
||||
kwargs={"selector": "catalog", "uuid": self.uuid}
|
||||
"bookshelf_item", kwargs={"selector": "catalog", "uuid": self.uuid}
|
||||
)
|
||||
|
||||
def get_scales(self):
|
||||
return "/".join([s.scale for s in self.scales.all()])
|
||||
|
||||
get_scales.short_description = "Scales"
|
||||
|
||||
|
||||
class Magazine(BaseModel):
|
||||
name = models.CharField(max_length=200)
|
||||
publisher = models.ForeignKey(Publisher, on_delete=models.CASCADE)
|
||||
website = models.URLField(blank=True)
|
||||
ISBN = models.CharField(max_length=17, blank=True) # 13 + dashes
|
||||
image = models.ImageField(
|
||||
blank=True,
|
||||
upload_to=magazine_image_upload,
|
||||
storage=DeduplicatedStorage,
|
||||
)
|
||||
language = models.CharField(
|
||||
max_length=7,
|
||||
choices=sorted(settings.LANGUAGES, key=lambda s: s[1]),
|
||||
default="en",
|
||||
)
|
||||
tags = models.ManyToManyField(Tag, related_name="magazine", blank=True)
|
||||
|
||||
def delete(self, *args, **kwargs):
|
||||
shutil.rmtree(
|
||||
os.path.join(
|
||||
settings.MEDIA_ROOT, "images", "magazines", str(self.uuid)
|
||||
),
|
||||
ignore_errors=True,
|
||||
)
|
||||
super(Magazine, self).delete(*args, **kwargs)
|
||||
|
||||
class Meta:
|
||||
ordering = [Lower("name")]
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
|
||||
def get_absolute_url(self):
|
||||
return reverse("magazine", kwargs={"uuid": self.uuid})
|
||||
|
||||
def get_cover(self):
|
||||
if self.image:
|
||||
return self.image
|
||||
else:
|
||||
cover_issue = self.issue.filter(published=True).first()
|
||||
if cover_issue and cover_issue.image.exists():
|
||||
return cover_issue.image.first().image
|
||||
return None
|
||||
|
||||
def website_short(self):
|
||||
if self.website:
|
||||
return urlparse(self.website).netloc.replace("www.", "")
|
||||
|
||||
|
||||
class MagazineIssue(BaseBook):
|
||||
magazine = models.ForeignKey(
|
||||
Magazine, on_delete=models.CASCADE, related_name="issue"
|
||||
)
|
||||
issue_number = models.CharField(max_length=100)
|
||||
publication_month = models.SmallIntegerField(
|
||||
null=True, blank=True, choices=MONTHS.items()
|
||||
)
|
||||
|
||||
class Meta:
|
||||
unique_together = ("magazine", "issue_number")
|
||||
ordering = [
|
||||
"magazine",
|
||||
"publication_year",
|
||||
"publication_month",
|
||||
"issue_number",
|
||||
]
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.magazine.name} - {self.issue_number}"
|
||||
|
||||
def clean(self):
|
||||
if self.magazine.published is False and self.published is True:
|
||||
raise ValidationError(
|
||||
"Cannot set an issue as published if the magazine is not "
|
||||
"published."
|
||||
)
|
||||
|
||||
@property
|
||||
def get_scales(self):
|
||||
return "/".join([s.scale for s in self.scales.all()])
|
||||
def obj_label(self):
|
||||
return "Magazine Issue"
|
||||
|
||||
def preview(self):
|
||||
return self.image.first().image_thumbnail(100)
|
||||
|
||||
@property
|
||||
def publisher(self):
|
||||
return self.magazine.publisher
|
||||
|
||||
def get_absolute_url(self):
|
||||
return reverse(
|
||||
"issue", kwargs={"uuid": self.uuid, "magazine": self.magazine.uuid}
|
||||
)
|
||||
|
||||
|
||||
class TocEntry(BaseModel):
|
||||
book = models.ForeignKey(
|
||||
BaseBook, on_delete=models.CASCADE, related_name="toc"
|
||||
)
|
||||
title = models.CharField()
|
||||
subtitle = models.CharField(blank=True)
|
||||
authors = models.CharField(blank=True)
|
||||
page = models.SmallIntegerField()
|
||||
featured = models.BooleanField(
|
||||
default=False,
|
||||
)
|
||||
|
||||
class Meta:
|
||||
ordering = ["page"]
|
||||
verbose_name = "Table of Contents Entry"
|
||||
verbose_name_plural = "Table of Contents Entries"
|
||||
|
||||
def __str__(self):
|
||||
if self.subtitle:
|
||||
title = f"{self.title}: {self.subtitle}"
|
||||
else:
|
||||
title = self.title
|
||||
return f"{title} (p. {self.page})"
|
||||
|
||||
def clean(self):
|
||||
if self.page is None:
|
||||
raise ValidationError("Page number is required.")
|
||||
if self.page < 1:
|
||||
raise ValidationError("Page number is invalid.")
|
||||
try:
|
||||
if self.page > self.book.number_of_pages:
|
||||
raise ValidationError(
|
||||
"Page number exceeds the publication's number of pages."
|
||||
)
|
||||
except TypeError:
|
||||
pass # number_of_pages is None
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
from rest_framework import serializers
|
||||
from bookshelf.models import Book, Author, Publisher
|
||||
from metadata.serializers import TagSerializer
|
||||
from bookshelf.models import Book, Catalog, Author, Publisher
|
||||
from metadata.serializers import (
|
||||
ScaleSerializer,
|
||||
ManufacturerSerializer,
|
||||
TagSerializer
|
||||
)
|
||||
|
||||
|
||||
class AuthorSerializer(serializers.ModelSerializer):
|
||||
@@ -22,5 +26,28 @@ class BookSerializer(serializers.ModelSerializer):
|
||||
|
||||
class Meta:
|
||||
model = Book
|
||||
fields = "__all__"
|
||||
exclude = (
|
||||
"notes",
|
||||
"shop",
|
||||
"purchase_date",
|
||||
"price",
|
||||
)
|
||||
read_only_fields = ("creation_time", "updated_time")
|
||||
|
||||
|
||||
class CatalogSerializer(serializers.ModelSerializer):
|
||||
scales = ScaleSerializer(many=True)
|
||||
manufacturer = ManufacturerSerializer()
|
||||
tags = TagSerializer(many=True)
|
||||
|
||||
class Meta:
|
||||
model = Catalog
|
||||
exclude = (
|
||||
"notes",
|
||||
"shop",
|
||||
"purchase_date",
|
||||
"price",
|
||||
)
|
||||
read_only_fields = ("creation_time", "updated_time")
|
||||
|
||||
# FIXME: add Magazine and MagazineIssue serializers
|
||||
|
||||
16
ram/bookshelf/static/admin/js/magazine_issue_defaults.js
Normal file
16
ram/bookshelf/static/admin/js/magazine_issue_defaults.js
Normal file
@@ -0,0 +1,16 @@
|
||||
document.addEventListener('formset:added', function(event) {
|
||||
const newForm = event.target; // the new inline form element
|
||||
|
||||
const defaultLanguage = document.querySelector('#id_language').value;
|
||||
const defaultStatus = document.querySelector('#id_published').checked;
|
||||
|
||||
const languageInput = newForm.querySelector('select[name$="language"]');
|
||||
const statusInput = newForm.querySelector('input[name$="published"]');
|
||||
|
||||
if (languageInput) {
|
||||
languageInput.value = defaultLanguage;
|
||||
}
|
||||
if (statusInput) {
|
||||
statusInput.checked = defaultStatus;
|
||||
}
|
||||
});
|
||||
@@ -1,3 +1,436 @@
|
||||
from decimal import Decimal
|
||||
from django.test import TestCase
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.db import IntegrityError
|
||||
|
||||
# Create your tests here.
|
||||
from bookshelf.models import (
|
||||
Author,
|
||||
Publisher,
|
||||
Book,
|
||||
Catalog,
|
||||
Magazine,
|
||||
MagazineIssue,
|
||||
TocEntry,
|
||||
)
|
||||
from metadata.models import Manufacturer, Scale
|
||||
|
||||
|
||||
class AuthorTestCase(TestCase):
|
||||
"""Test cases for Author model."""
|
||||
|
||||
def test_author_creation(self):
|
||||
"""Test creating an author."""
|
||||
author = Author.objects.create(
|
||||
first_name="John",
|
||||
last_name="Smith",
|
||||
)
|
||||
|
||||
self.assertEqual(str(author), "Smith, John")
|
||||
self.assertEqual(author.first_name, "John")
|
||||
self.assertEqual(author.last_name, "Smith")
|
||||
|
||||
def test_author_short_name(self):
|
||||
"""Test author short name property."""
|
||||
author = Author.objects.create(
|
||||
first_name="John",
|
||||
last_name="Smith",
|
||||
)
|
||||
|
||||
self.assertEqual(author.short_name, "Smith J.")
|
||||
|
||||
def test_author_ordering(self):
|
||||
"""Test author ordering by last name, first name."""
|
||||
a1 = Author.objects.create(first_name="John", last_name="Smith")
|
||||
a2 = Author.objects.create(first_name="Jane", last_name="Doe")
|
||||
a3 = Author.objects.create(first_name="Bob", last_name="Smith")
|
||||
|
||||
authors = list(Author.objects.all())
|
||||
self.assertEqual(authors[0], a2) # Doe comes first
|
||||
self.assertEqual(authors[1], a3) # Smith, Bob
|
||||
self.assertEqual(authors[2], a1) # Smith, John
|
||||
|
||||
|
||||
class PublisherTestCase(TestCase):
|
||||
"""Test cases for Publisher model."""
|
||||
|
||||
def test_publisher_creation(self):
|
||||
"""Test creating a publisher."""
|
||||
publisher = Publisher.objects.create(
|
||||
name="Model Railroader",
|
||||
country="US",
|
||||
website="https://www.modelrailroader.com",
|
||||
)
|
||||
|
||||
self.assertEqual(str(publisher), "Model Railroader")
|
||||
self.assertEqual(publisher.country.code, "US")
|
||||
|
||||
def test_publisher_ordering(self):
|
||||
"""Test publisher ordering by name."""
|
||||
p1 = Publisher.objects.create(name="Zebra Publishing")
|
||||
p2 = Publisher.objects.create(name="Alpha Books")
|
||||
p3 = Publisher.objects.create(name="Model Railroader")
|
||||
|
||||
publishers = list(Publisher.objects.all())
|
||||
self.assertEqual(publishers[0], p2)
|
||||
self.assertEqual(publishers[1], p3)
|
||||
self.assertEqual(publishers[2], p1)
|
||||
|
||||
|
||||
class BookTestCase(TestCase):
|
||||
"""Test cases for Book model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.publisher = Publisher.objects.create(
|
||||
name="Kalmbach Publishing",
|
||||
country="US",
|
||||
)
|
||||
|
||||
self.author = Author.objects.create(
|
||||
first_name="Tony",
|
||||
last_name="Koester",
|
||||
)
|
||||
|
||||
def test_book_creation(self):
|
||||
"""Test creating a book."""
|
||||
book = Book.objects.create(
|
||||
title="Model Railroad Planning",
|
||||
publisher=self.publisher,
|
||||
ISBN="978-0-89024-567-8",
|
||||
language="en",
|
||||
number_of_pages=128,
|
||||
publication_year=2010,
|
||||
price=Decimal("24.95"),
|
||||
)
|
||||
|
||||
self.assertEqual(str(book), "Model Railroad Planning")
|
||||
self.assertEqual(book.publisher_name, "Kalmbach Publishing")
|
||||
self.assertTrue(book.published) # Default from BaseModel
|
||||
|
||||
def test_book_authors_relationship(self):
|
||||
"""Test many-to-many relationship with authors."""
|
||||
book = Book.objects.create(
|
||||
title="Test Book",
|
||||
publisher=self.publisher,
|
||||
)
|
||||
|
||||
author2 = Author.objects.create(
|
||||
first_name="John",
|
||||
last_name="Doe",
|
||||
)
|
||||
|
||||
book.authors.add(self.author, author2)
|
||||
|
||||
self.assertEqual(book.authors.count(), 2)
|
||||
self.assertIn(self.author, book.authors.all())
|
||||
|
||||
def test_book_authors_list_property(self):
|
||||
"""Test authors_list property."""
|
||||
book = Book.objects.create(
|
||||
title="Test Book",
|
||||
publisher=self.publisher,
|
||||
)
|
||||
|
||||
book.authors.add(self.author)
|
||||
|
||||
self.assertEqual(book.authors_list, "Koester T.")
|
||||
|
||||
def test_book_ordering(self):
|
||||
"""Test book ordering by title."""
|
||||
b1 = Book.objects.create(
|
||||
title="Zebra Book",
|
||||
publisher=self.publisher,
|
||||
)
|
||||
b2 = Book.objects.create(
|
||||
title="Alpha Book",
|
||||
publisher=self.publisher,
|
||||
)
|
||||
|
||||
books = list(Book.objects.all())
|
||||
self.assertEqual(books[0], b2)
|
||||
self.assertEqual(books[1], b1)
|
||||
|
||||
|
||||
class CatalogTestCase(TestCase):
|
||||
"""Test cases for Catalog model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.manufacturer = Manufacturer.objects.create(
|
||||
name="Bachmann",
|
||||
category="model",
|
||||
country="US",
|
||||
)
|
||||
|
||||
self.scale_ho = Scale.objects.create(
|
||||
scale="HO",
|
||||
ratio="1:87",
|
||||
tracks=16.5,
|
||||
)
|
||||
|
||||
self.scale_n = Scale.objects.create(
|
||||
scale="N",
|
||||
ratio="1:160",
|
||||
tracks=9.0,
|
||||
)
|
||||
|
||||
def test_catalog_creation(self):
|
||||
"""Test creating a catalog."""
|
||||
catalog = Catalog.objects.create(
|
||||
manufacturer=self.manufacturer,
|
||||
years="2023",
|
||||
publication_year=2023,
|
||||
)
|
||||
catalog.scales.add(self.scale_ho)
|
||||
|
||||
# Refresh to get the correct string representation
|
||||
catalog.refresh_from_db()
|
||||
|
||||
self.assertIn("Bachmann", str(catalog))
|
||||
self.assertIn("2023", str(catalog))
|
||||
|
||||
def test_catalog_multiple_scales(self):
|
||||
"""Test catalog with multiple scales."""
|
||||
catalog = Catalog.objects.create(
|
||||
manufacturer=self.manufacturer,
|
||||
years="2023",
|
||||
)
|
||||
|
||||
catalog.scales.add(self.scale_ho, self.scale_n)
|
||||
|
||||
scales_str = catalog.get_scales()
|
||||
self.assertIn("HO", scales_str)
|
||||
self.assertIn("N", scales_str)
|
||||
|
||||
def test_catalog_ordering(self):
|
||||
"""Test catalog ordering by manufacturer and year."""
|
||||
man2 = Manufacturer.objects.create(
|
||||
name="Atlas",
|
||||
category="model",
|
||||
)
|
||||
|
||||
c1 = Catalog.objects.create(
|
||||
manufacturer=self.manufacturer,
|
||||
years="2023",
|
||||
publication_year=2023,
|
||||
)
|
||||
c2 = Catalog.objects.create(
|
||||
manufacturer=man2,
|
||||
years="2023",
|
||||
publication_year=2023,
|
||||
)
|
||||
c3 = Catalog.objects.create(
|
||||
manufacturer=self.manufacturer,
|
||||
years="2022",
|
||||
publication_year=2022,
|
||||
)
|
||||
|
||||
catalogs = list(Catalog.objects.all())
|
||||
# Should be ordered by manufacturer name, then year
|
||||
self.assertEqual(catalogs[0], c2) # Atlas
|
||||
|
||||
|
||||
class MagazineTestCase(TestCase):
|
||||
"""Test cases for Magazine model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.publisher = Publisher.objects.create(
|
||||
name="Kalmbach Publishing",
|
||||
country="US",
|
||||
)
|
||||
|
||||
def test_magazine_creation(self):
|
||||
"""Test creating a magazine."""
|
||||
magazine = Magazine.objects.create(
|
||||
name="Model Railroader",
|
||||
publisher=self.publisher,
|
||||
website="https://www.modelrailroader.com",
|
||||
ISBN="0746-9896",
|
||||
language="en",
|
||||
)
|
||||
|
||||
self.assertEqual(str(magazine), "Model Railroader")
|
||||
self.assertEqual(magazine.publisher, self.publisher)
|
||||
|
||||
def test_magazine_website_short(self):
|
||||
"""Test website_short method."""
|
||||
magazine = Magazine.objects.create(
|
||||
name="Model Railroader",
|
||||
publisher=self.publisher,
|
||||
website="https://www.modelrailroader.com",
|
||||
)
|
||||
|
||||
self.assertEqual(magazine.website_short(), "modelrailroader.com")
|
||||
|
||||
def test_magazine_get_cover_no_image(self):
|
||||
"""Test get_cover when magazine has no image."""
|
||||
magazine = Magazine.objects.create(
|
||||
name="Test Magazine",
|
||||
publisher=self.publisher,
|
||||
)
|
||||
|
||||
# Should return None if no cover image exists
|
||||
self.assertIsNone(magazine.get_cover())
|
||||
|
||||
|
||||
class MagazineIssueTestCase(TestCase):
|
||||
"""Test cases for MagazineIssue model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.publisher = Publisher.objects.create(
|
||||
name="Kalmbach Publishing",
|
||||
)
|
||||
|
||||
self.magazine = Magazine.objects.create(
|
||||
name="Model Railroader",
|
||||
publisher=self.publisher,
|
||||
published=True,
|
||||
)
|
||||
|
||||
def test_magazine_issue_creation(self):
|
||||
"""Test creating a magazine issue."""
|
||||
issue = MagazineIssue.objects.create(
|
||||
magazine=self.magazine,
|
||||
issue_number="January 2023",
|
||||
publication_year=2023,
|
||||
publication_month=1,
|
||||
number_of_pages=96,
|
||||
)
|
||||
|
||||
self.assertEqual(str(issue), "Model Railroader - January 2023")
|
||||
self.assertEqual(issue.obj_label, "Magazine Issue")
|
||||
|
||||
def test_magazine_issue_unique_together(self):
|
||||
"""Test that magazine+issue_number must be unique."""
|
||||
MagazineIssue.objects.create(
|
||||
magazine=self.magazine,
|
||||
issue_number="January 2023",
|
||||
)
|
||||
|
||||
with self.assertRaises(IntegrityError):
|
||||
MagazineIssue.objects.create(
|
||||
magazine=self.magazine,
|
||||
issue_number="January 2023",
|
||||
)
|
||||
|
||||
def test_magazine_issue_validation(self):
|
||||
"""Test that published issue requires published magazine."""
|
||||
unpublished_magazine = Magazine.objects.create(
|
||||
name="Unpublished Magazine",
|
||||
publisher=self.publisher,
|
||||
published=False,
|
||||
)
|
||||
|
||||
issue = MagazineIssue(
|
||||
magazine=unpublished_magazine,
|
||||
issue_number="Test Issue",
|
||||
published=True,
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
issue.clean()
|
||||
|
||||
def test_magazine_issue_publisher_property(self):
|
||||
"""Test that issue inherits publisher from magazine."""
|
||||
issue = MagazineIssue.objects.create(
|
||||
magazine=self.magazine,
|
||||
issue_number="January 2023",
|
||||
)
|
||||
|
||||
self.assertEqual(issue.publisher, self.publisher)
|
||||
|
||||
|
||||
class TocEntryTestCase(TestCase):
|
||||
"""Test cases for TocEntry model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
publisher = Publisher.objects.create(name="Test Publisher")
|
||||
|
||||
self.book = Book.objects.create(
|
||||
title="Test Book",
|
||||
publisher=publisher,
|
||||
number_of_pages=200,
|
||||
)
|
||||
|
||||
def test_toc_entry_creation(self):
|
||||
"""Test creating a table of contents entry."""
|
||||
entry = TocEntry.objects.create(
|
||||
book=self.book,
|
||||
title="Introduction to Model Railroading",
|
||||
subtitle="Getting Started",
|
||||
authors="John Doe",
|
||||
page=10,
|
||||
)
|
||||
|
||||
self.assertIn("Introduction to Model Railroading", str(entry))
|
||||
self.assertIn("Getting Started", str(entry))
|
||||
self.assertIn("p. 10", str(entry))
|
||||
|
||||
def test_toc_entry_without_subtitle(self):
|
||||
"""Test TOC entry without subtitle."""
|
||||
entry = TocEntry.objects.create(
|
||||
book=self.book,
|
||||
title="Chapter One",
|
||||
page=5,
|
||||
)
|
||||
|
||||
self.assertEqual(str(entry), "Chapter One (p. 5)")
|
||||
|
||||
def test_toc_entry_page_validation_required(self):
|
||||
"""Test that page number is required."""
|
||||
entry = TocEntry(
|
||||
book=self.book,
|
||||
title="Test Entry",
|
||||
page=None,
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
entry.clean()
|
||||
|
||||
def test_toc_entry_page_validation_min(self):
|
||||
"""Test that page number must be >= 1."""
|
||||
entry = TocEntry(
|
||||
book=self.book,
|
||||
title="Test Entry",
|
||||
page=0,
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
entry.clean()
|
||||
|
||||
def test_toc_entry_page_validation_exceeds_book(self):
|
||||
"""Test that page number cannot exceed book's page count."""
|
||||
entry = TocEntry(
|
||||
book=self.book,
|
||||
title="Test Entry",
|
||||
page=250, # Book has 200 pages
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
entry.clean()
|
||||
|
||||
def test_toc_entry_ordering(self):
|
||||
"""Test TOC entries are ordered by page number."""
|
||||
e1 = TocEntry.objects.create(
|
||||
book=self.book,
|
||||
title="Chapter Three",
|
||||
page=30,
|
||||
)
|
||||
e2 = TocEntry.objects.create(
|
||||
book=self.book,
|
||||
title="Chapter One",
|
||||
page=10,
|
||||
)
|
||||
e3 = TocEntry.objects.create(
|
||||
book=self.book,
|
||||
title="Chapter Two",
|
||||
page=20,
|
||||
)
|
||||
|
||||
entries = list(TocEntry.objects.all())
|
||||
self.assertEqual(entries[0], e2) # Page 10
|
||||
self.assertEqual(entries[1], e3) # Page 20
|
||||
self.assertEqual(entries[2], e1) # Page 30
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
from django.urls import path
|
||||
from bookshelf.views import BookList, BookGet
|
||||
from bookshelf.views import BookList, BookGet, CatalogList, CatalogGet
|
||||
|
||||
urlpatterns = [
|
||||
path("book/list", BookList.as_view()),
|
||||
path("book/get/<uuid:uuid>", BookGet.as_view()),
|
||||
path("catalog/list", CatalogList.as_view()),
|
||||
path("catalog/get/<uuid:uuid>", CatalogGet.as_view()),
|
||||
]
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
from rest_framework.generics import ListAPIView, RetrieveAPIView
|
||||
from rest_framework.schemas.openapi import AutoSchema
|
||||
|
||||
from bookshelf.models import Book
|
||||
from bookshelf.serializers import BookSerializer
|
||||
from ram.views import CustomLimitOffsetPagination
|
||||
from bookshelf.models import Book, Catalog
|
||||
from bookshelf.serializers import BookSerializer, CatalogSerializer
|
||||
|
||||
|
||||
class BookList(ListAPIView):
|
||||
serializer_class = BookSerializer
|
||||
pagination_class = CustomLimitOffsetPagination
|
||||
|
||||
def get_queryset(self):
|
||||
return Book.objects.get_published(self.request.user)
|
||||
@@ -19,3 +21,22 @@ class BookGet(RetrieveAPIView):
|
||||
|
||||
def get_queryset(self):
|
||||
return Book.objects.get_published(self.request.user)
|
||||
|
||||
|
||||
class CatalogList(ListAPIView):
|
||||
serializer_class = CatalogSerializer
|
||||
pagination_class = CustomLimitOffsetPagination
|
||||
|
||||
def get_queryset(self):
|
||||
return Catalog.objects.get_published(self.request.user)
|
||||
|
||||
|
||||
class CatalogGet(RetrieveAPIView):
|
||||
serializer_class = CatalogSerializer
|
||||
lookup_field = "uuid"
|
||||
schema = AutoSchema(operation_id_base="retrieveCatalogByUUID")
|
||||
|
||||
def get_queryset(self):
|
||||
return Book.objects.get_published(self.request.user)
|
||||
|
||||
# FIXME: add Magazine and MagazineIssue views
|
||||
|
||||
@@ -1,15 +1,43 @@
|
||||
from django.contrib import admin
|
||||
from adminsortable2.admin import SortableAdminBase, SortableInlineAdminMixin
|
||||
import html
|
||||
|
||||
from django.conf import settings
|
||||
from django.contrib import admin
|
||||
|
||||
# from django.forms import BaseInlineFormSet # for future reference
|
||||
from django.utils.html import format_html, strip_tags
|
||||
from adminsortable2.admin import (
|
||||
SortableAdminBase,
|
||||
SortableInlineAdminMixin,
|
||||
# CustomInlineFormSetMixin, # for future reference
|
||||
)
|
||||
|
||||
from ram.admin import publish, unpublish
|
||||
from ram.utils import generate_csv
|
||||
from consist.models import Consist, ConsistItem
|
||||
|
||||
|
||||
# for future reference
|
||||
# class ConsistItemInlineFormSet(CustomInlineFormSetMixin, BaseInlineFormSet):
|
||||
# def clean(self):
|
||||
# super().clean()
|
||||
|
||||
|
||||
class ConsistItemInline(SortableInlineAdminMixin, admin.TabularInline):
|
||||
model = ConsistItem
|
||||
min_num = 1
|
||||
extra = 0
|
||||
autocomplete_fields = ("rolling_stock",)
|
||||
readonly_fields = ("preview", "published", "address", "type", "company", "era")
|
||||
readonly_fields = (
|
||||
"preview",
|
||||
"published",
|
||||
"scale",
|
||||
"manufacturer",
|
||||
"item_number",
|
||||
"company",
|
||||
"type",
|
||||
"era",
|
||||
"address",
|
||||
)
|
||||
|
||||
|
||||
@admin.register(Consist)
|
||||
@@ -19,11 +47,24 @@ class ConsistAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
"creation_time",
|
||||
"updated_time",
|
||||
)
|
||||
list_display = ("identifier", "published", "company", "era")
|
||||
list_filter = list_display
|
||||
search_fields = list_display
|
||||
list_filter = ("published", "company__name", "era", "scale__scale")
|
||||
list_display = (
|
||||
"__str__",
|
||||
"company__name",
|
||||
"era",
|
||||
"scale",
|
||||
"country_flag",
|
||||
"published",
|
||||
)
|
||||
search_fields = ("identifier",) + list_filter
|
||||
save_as = True
|
||||
|
||||
@admin.display(description="Country")
|
||||
def country_flag(self, obj):
|
||||
return format_html(
|
||||
'<img src="{}" title="{}" />', obj.country.flag, obj.country.name
|
||||
)
|
||||
|
||||
fieldsets = (
|
||||
(
|
||||
None,
|
||||
@@ -31,15 +72,20 @@ class ConsistAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
"fields": (
|
||||
"published",
|
||||
"identifier",
|
||||
"consist_address",
|
||||
"company",
|
||||
"scale",
|
||||
"era",
|
||||
"consist_address",
|
||||
"description",
|
||||
"image",
|
||||
"notes",
|
||||
"tags",
|
||||
)
|
||||
},
|
||||
),
|
||||
(
|
||||
"Notes",
|
||||
{"classes": ("collapse",), "fields": ("notes",)},
|
||||
),
|
||||
(
|
||||
"Audit",
|
||||
{
|
||||
@@ -51,3 +97,56 @@ class ConsistAdmin(SortableAdminBase, admin.ModelAdmin):
|
||||
},
|
||||
),
|
||||
)
|
||||
|
||||
def download_csv(modeladmin, request, queryset):
|
||||
header = [
|
||||
"ID",
|
||||
"Name",
|
||||
"Published",
|
||||
"Company",
|
||||
"Country",
|
||||
"Address",
|
||||
"Scale",
|
||||
"Era",
|
||||
"Description",
|
||||
"Tags",
|
||||
"Length",
|
||||
"Composition",
|
||||
"Item name",
|
||||
"Item type",
|
||||
"Item ID",
|
||||
]
|
||||
data = []
|
||||
for obj in queryset:
|
||||
for item in obj.consist_item.all():
|
||||
types = " + ".join(
|
||||
"{}x {}".format(t["count"], t["type"])
|
||||
for t in obj.get_type_count()
|
||||
)
|
||||
data.append(
|
||||
[
|
||||
obj.uuid,
|
||||
obj.__str__(),
|
||||
"X" if obj.published else "",
|
||||
obj.company.name,
|
||||
obj.company.country,
|
||||
obj.consist_address,
|
||||
obj.scale.scale,
|
||||
obj.era,
|
||||
html.unescape(strip_tags(obj.description)),
|
||||
settings.CSV_SEPARATOR_ALT.join(
|
||||
t.name for t in obj.tags.all()
|
||||
),
|
||||
obj.length,
|
||||
types,
|
||||
item.rolling_stock.__str__(),
|
||||
item.type,
|
||||
item.rolling_stock.uuid,
|
||||
]
|
||||
)
|
||||
|
||||
return generate_csv(header, data, "consists.csv")
|
||||
|
||||
download_csv.short_description = "Download selected items as CSV"
|
||||
|
||||
actions = [publish, unpublish, download_csv]
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-08 21:50
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0012_consist_published"),
|
||||
("roster", "0030_rollingstock_price"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddConstraint(
|
||||
model_name="consistitem",
|
||||
constraint=models.UniqueConstraint(
|
||||
fields=("consist", "rolling_stock"), name="one_stock_per_consist"
|
||||
),
|
||||
),
|
||||
]
|
||||
18
ram/consist/migrations/0014_alter_consistitem_order.py
Normal file
18
ram/consist/migrations/0014_alter_consistitem_order.py
Normal file
@@ -0,0 +1,18 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-08 22:22
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0013_consistitem_one_stock_per_consist"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="consistitem",
|
||||
name="order",
|
||||
field=models.PositiveIntegerField(default=1000),
|
||||
),
|
||||
]
|
||||
19
ram/consist/migrations/0015_consist_description.py
Normal file
19
ram/consist/migrations/0015_consist_description.py
Normal file
@@ -0,0 +1,19 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-27 21:15
|
||||
|
||||
import tinymce.models
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0014_alter_consistitem_order"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="consist",
|
||||
name="description",
|
||||
field=tinymce.models.HTMLField(blank=True),
|
||||
),
|
||||
]
|
||||
18
ram/consist/migrations/0016_alter_consistitem_order.py
Normal file
18
ram/consist/migrations/0016_alter_consistitem_order.py
Normal file
@@ -0,0 +1,18 @@
|
||||
# Generated by Django 5.1.4 on 2025-04-27 19:53
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0015_consist_description"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="consistitem",
|
||||
name="order",
|
||||
field=models.PositiveIntegerField(),
|
||||
),
|
||||
]
|
||||
42
ram/consist/migrations/0017_consist_scale.py
Normal file
42
ram/consist/migrations/0017_consist_scale.py
Normal file
@@ -0,0 +1,42 @@
|
||||
# Generated by Django 5.1.4 on 2025-05-01 09:51
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
def set_scale(apps, schema_editor):
|
||||
Consist = apps.get_model("consist", "Consist")
|
||||
|
||||
for consist in Consist.objects.all():
|
||||
try:
|
||||
consist.scale = consist.consist_item.first().rolling_stock.scale
|
||||
consist.save()
|
||||
except AttributeError:
|
||||
pass
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0016_alter_consistitem_order"),
|
||||
(
|
||||
"metadata",
|
||||
"0024_remove_genericdocument_tags_delete_decoderdocument_and_more",
|
||||
),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="consist",
|
||||
name="scale",
|
||||
field=models.ForeignKey(
|
||||
null=True,
|
||||
on_delete=django.db.models.deletion.CASCADE,
|
||||
to="metadata.scale",
|
||||
),
|
||||
),
|
||||
migrations.RunPython(
|
||||
set_scale,
|
||||
reverse_code=migrations.RunPython.noop
|
||||
),
|
||||
]
|
||||
25
ram/consist/migrations/0018_alter_consist_scale.py
Normal file
25
ram/consist/migrations/0018_alter_consist_scale.py
Normal file
@@ -0,0 +1,25 @@
|
||||
# Generated by Django 5.1.4 on 2025-05-02 11:33
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0017_consist_scale"),
|
||||
(
|
||||
"metadata",
|
||||
"0024_remove_genericdocument_tags_delete_decoderdocument_and_more",
|
||||
),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="consist",
|
||||
name="scale",
|
||||
field=models.ForeignKey(
|
||||
on_delete=django.db.models.deletion.CASCADE, to="metadata.scale"
|
||||
),
|
||||
),
|
||||
]
|
||||
18
ram/consist/migrations/0019_consistitem_load.py
Normal file
18
ram/consist/migrations/0019_consistitem_load.py
Normal file
@@ -0,0 +1,18 @@
|
||||
# Generated by Django 6.0 on 2026-01-03 12:31
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("consist", "0018_alter_consist_scale"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="consistitem",
|
||||
name="load",
|
||||
field=models.BooleanField(default=False),
|
||||
),
|
||||
]
|
||||
@@ -2,12 +2,13 @@ import os
|
||||
|
||||
from django.db import models
|
||||
from django.urls import reverse
|
||||
from django.utils.text import Truncator
|
||||
from django.dispatch import receiver
|
||||
from django.core.exceptions import ValidationError
|
||||
|
||||
from ram.models import BaseModel
|
||||
from ram.utils import DeduplicatedStorage
|
||||
from metadata.models import Company, Tag
|
||||
from metadata.models import Company, Scale, Tag
|
||||
from roster.models import RollingStock
|
||||
|
||||
|
||||
@@ -26,6 +27,7 @@ class Consist(BaseModel):
|
||||
blank=True,
|
||||
help_text="Era or epoch of the consist",
|
||||
)
|
||||
scale = models.ForeignKey(Scale, on_delete=models.CASCADE)
|
||||
image = models.ImageField(
|
||||
upload_to=os.path.join("images", "consists"),
|
||||
storage=DeduplicatedStorage,
|
||||
@@ -39,11 +41,33 @@ class Consist(BaseModel):
|
||||
def get_absolute_url(self):
|
||||
return reverse("consist", kwargs={"uuid": self.uuid})
|
||||
|
||||
def clean(self):
|
||||
if self.consist_item.filter(rolling_stock__published=False).exists():
|
||||
raise ValidationError(
|
||||
"You must publish all items in the consist before publishing the consist." # noqa: E501
|
||||
)
|
||||
@property
|
||||
def length(self):
|
||||
return self.consist_item.filter(load=False).count()
|
||||
|
||||
def get_type_count(self):
|
||||
return self.consist_item.filter(load=False).annotate(
|
||||
type=models.F("rolling_stock__rolling_class__type__type")
|
||||
).values(
|
||||
"type"
|
||||
).annotate(
|
||||
count=models.Count("rolling_stock"),
|
||||
category=models.F("rolling_stock__rolling_class__type__category"),
|
||||
order=models.Max("order"),
|
||||
).order_by("order")
|
||||
|
||||
def get_cover(self):
|
||||
if self.image:
|
||||
return self.image
|
||||
else:
|
||||
consist_item = self.consist_item.first()
|
||||
if consist_item and consist_item.rolling_stock.image.exists():
|
||||
return consist_item.rolling_stock.image.first().image
|
||||
return None
|
||||
|
||||
@property
|
||||
def country(self):
|
||||
return self.company.country
|
||||
|
||||
class Meta:
|
||||
ordering = ["company", "-creation_time"]
|
||||
@@ -54,14 +78,44 @@ class ConsistItem(models.Model):
|
||||
Consist, on_delete=models.CASCADE, related_name="consist_item"
|
||||
)
|
||||
rolling_stock = models.ForeignKey(RollingStock, on_delete=models.CASCADE)
|
||||
order = models.PositiveIntegerField(default=0, blank=False, null=False)
|
||||
load = models.BooleanField(default=False)
|
||||
order = models.PositiveIntegerField(blank=False, null=False)
|
||||
|
||||
class Meta(object):
|
||||
class Meta:
|
||||
ordering = ["order"]
|
||||
constraints = [
|
||||
models.UniqueConstraint(
|
||||
fields=["consist", "rolling_stock"],
|
||||
name="one_stock_per_consist"
|
||||
)
|
||||
]
|
||||
|
||||
def __str__(self):
|
||||
return "{0}".format(self.rolling_stock)
|
||||
|
||||
def clean(self):
|
||||
rolling_stock = getattr(self, "rolling_stock", False)
|
||||
if not rolling_stock:
|
||||
return # exit if no inline are present
|
||||
|
||||
# FIXME this does not work when creating a new consist,
|
||||
# because the consist is not saved yet and it must be moved
|
||||
# to the admin form validation via InlineFormSet.clean()
|
||||
consist = self.consist
|
||||
# Scale must match, but allow loads of any scale
|
||||
if rolling_stock.scale != consist.scale and not self.load:
|
||||
raise ValidationError(
|
||||
"The rolling stock and consist must be of the same scale."
|
||||
)
|
||||
if self.load and rolling_stock.scale.ratio != consist.scale.ratio:
|
||||
raise ValidationError(
|
||||
"The load and consist must be of the same scale ratio."
|
||||
)
|
||||
if self.consist.published and not rolling_stock.published:
|
||||
raise ValidationError(
|
||||
"You must unpublish the the consist before using this item."
|
||||
)
|
||||
|
||||
def published(self):
|
||||
return self.rolling_stock.published
|
||||
published.boolean = True
|
||||
@@ -69,15 +123,31 @@ class ConsistItem(models.Model):
|
||||
def preview(self):
|
||||
return self.rolling_stock.image.first().image_thumbnail(100)
|
||||
|
||||
def type(self):
|
||||
return self.rolling_stock.rolling_class.type
|
||||
@property
|
||||
def manufacturer(self):
|
||||
return Truncator(self.rolling_stock.manufacturer).chars(10)
|
||||
|
||||
@property
|
||||
def item_number(self):
|
||||
return self.rolling_stock.item_number
|
||||
|
||||
@property
|
||||
def scale(self):
|
||||
return self.rolling_stock.scale
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self.rolling_stock.rolling_class.type.type
|
||||
|
||||
@property
|
||||
def address(self):
|
||||
return self.rolling_stock.address
|
||||
|
||||
@property
|
||||
def company(self):
|
||||
return self.rolling_stock.company()
|
||||
return self.rolling_stock.company
|
||||
|
||||
@property
|
||||
def era(self):
|
||||
return self.rolling_stock.era
|
||||
|
||||
@@ -87,6 +157,7 @@ class ConsistItem(models.Model):
|
||||
# it is hosted here to avoid circular imports
|
||||
@receiver(models.signals.post_save, sender=RollingStock)
|
||||
def post_save_unpublish_consist(sender, instance, *args, **kwargs):
|
||||
if not instance.published:
|
||||
consists = Consist.objects.filter(consist_item__rolling_stock=instance)
|
||||
for consist in consists:
|
||||
consist.published = False
|
||||
|
||||
@@ -21,4 +21,5 @@ class ConsistSerializer(serializers.ModelSerializer):
|
||||
|
||||
class Meta:
|
||||
model = Consist
|
||||
fields = "__all__"
|
||||
exclude = ("notes",)
|
||||
read_only_fields = ("creation_time", "updated_time")
|
||||
|
||||
@@ -1,3 +1,315 @@
|
||||
from django.test import TestCase
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.db import IntegrityError
|
||||
|
||||
# Create your tests here.
|
||||
from consist.models import Consist, ConsistItem
|
||||
from roster.models import RollingClass, RollingStock
|
||||
from metadata.models import Company, Scale, RollingStockType
|
||||
|
||||
|
||||
class ConsistTestCase(TestCase):
|
||||
"""Test cases for Consist model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.company = Company.objects.create(
|
||||
name="Rio Grande Southern",
|
||||
country="US",
|
||||
)
|
||||
|
||||
self.scale = Scale.objects.create(
|
||||
scale="HOn3",
|
||||
ratio="1:87",
|
||||
tracks=10.5,
|
||||
)
|
||||
|
||||
def test_consist_creation(self):
|
||||
"""Test creating a consist."""
|
||||
consist = Consist.objects.create(
|
||||
identifier="RGS Freight #1",
|
||||
company=self.company,
|
||||
scale=self.scale,
|
||||
era="1930s",
|
||||
)
|
||||
|
||||
self.assertEqual(str(consist), "Rio Grande Southern RGS Freight #1")
|
||||
self.assertEqual(consist.identifier, "RGS Freight #1")
|
||||
self.assertEqual(consist.era, "1930s")
|
||||
|
||||
def test_consist_country_property(self):
|
||||
"""Test that consist inherits country from company."""
|
||||
consist = Consist.objects.create(
|
||||
identifier="Test Consist",
|
||||
company=self.company,
|
||||
scale=self.scale,
|
||||
)
|
||||
|
||||
self.assertEqual(consist.country, self.company.country)
|
||||
|
||||
def test_consist_dcc_address(self):
|
||||
"""Test consist with DCC address."""
|
||||
consist = Consist.objects.create(
|
||||
identifier="DCC Consist",
|
||||
company=self.company,
|
||||
scale=self.scale,
|
||||
consist_address=99,
|
||||
)
|
||||
|
||||
self.assertEqual(consist.consist_address, 99)
|
||||
|
||||
def test_consist_get_absolute_url(self):
|
||||
"""Test get_absolute_url returns correct URL."""
|
||||
consist = Consist.objects.create(
|
||||
identifier="Test Consist",
|
||||
company=self.company,
|
||||
scale=self.scale,
|
||||
)
|
||||
|
||||
url = consist.get_absolute_url()
|
||||
self.assertIn(str(consist.uuid), url)
|
||||
|
||||
|
||||
class ConsistItemTestCase(TestCase):
|
||||
"""Test cases for ConsistItem model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.company = Company.objects.create(name="RGS", country="US")
|
||||
|
||||
self.scale_hon3 = Scale.objects.create(
|
||||
scale="HOn3",
|
||||
ratio="1:87",
|
||||
tracks=10.5,
|
||||
)
|
||||
|
||||
self.scale_ho = Scale.objects.create(
|
||||
scale="HO",
|
||||
ratio="1:87",
|
||||
tracks=16.5,
|
||||
)
|
||||
|
||||
self.stock_type = RollingStockType.objects.create(
|
||||
type="Steam Locomotive",
|
||||
category="locomotive",
|
||||
order=1,
|
||||
)
|
||||
|
||||
self.rolling_class = RollingClass.objects.create(
|
||||
identifier="C-19",
|
||||
type=self.stock_type,
|
||||
company=self.company,
|
||||
)
|
||||
|
||||
self.consist = Consist.objects.create(
|
||||
identifier="Test Consist",
|
||||
company=self.company,
|
||||
scale=self.scale_hon3,
|
||||
published=True,
|
||||
)
|
||||
|
||||
self.rolling_stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="340",
|
||||
scale=self.scale_hon3,
|
||||
published=True,
|
||||
)
|
||||
|
||||
def test_consist_item_creation(self):
|
||||
"""Test creating a consist item."""
|
||||
item = ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=1,
|
||||
load=False,
|
||||
)
|
||||
|
||||
self.assertEqual(str(item), "RGS C-19 340")
|
||||
self.assertEqual(item.order, 1)
|
||||
self.assertFalse(item.load)
|
||||
|
||||
def test_consist_item_unique_constraint(self):
|
||||
"""Test that consist+rolling_stock must be unique."""
|
||||
ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=1,
|
||||
)
|
||||
|
||||
# Cannot add same rolling stock to same consist twice
|
||||
with self.assertRaises(IntegrityError):
|
||||
ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=2,
|
||||
)
|
||||
|
||||
def test_consist_item_scale_validation(self):
|
||||
"""Test that consist item scale must match consist scale."""
|
||||
different_scale_stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="341",
|
||||
scale=self.scale_ho, # Different scale
|
||||
)
|
||||
|
||||
item = ConsistItem(
|
||||
consist=self.consist,
|
||||
rolling_stock=different_scale_stock,
|
||||
order=1,
|
||||
load=False,
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
item.clean()
|
||||
|
||||
def test_consist_item_load_ratio_validation(self):
|
||||
"""Test that load ratio must match consist ratio."""
|
||||
different_scale = Scale.objects.create(
|
||||
scale="N",
|
||||
ratio="1:160", # Different ratio
|
||||
tracks=9.0,
|
||||
)
|
||||
|
||||
load_stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="342",
|
||||
scale=different_scale,
|
||||
)
|
||||
|
||||
item = ConsistItem(
|
||||
consist=self.consist,
|
||||
rolling_stock=load_stock,
|
||||
order=1,
|
||||
load=True,
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
item.clean()
|
||||
|
||||
def test_consist_item_published_validation(self):
|
||||
"""Test that unpublished stock cannot be in published consist."""
|
||||
unpublished_stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="343",
|
||||
scale=self.scale_hon3,
|
||||
published=False,
|
||||
)
|
||||
|
||||
item = ConsistItem(
|
||||
consist=self.consist,
|
||||
rolling_stock=unpublished_stock,
|
||||
order=1,
|
||||
)
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
item.clean()
|
||||
|
||||
def test_consist_item_properties(self):
|
||||
"""Test consist item properties."""
|
||||
item = ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=1,
|
||||
)
|
||||
|
||||
self.assertEqual(item.scale, self.rolling_stock.scale)
|
||||
self.assertEqual(item.company, self.rolling_stock.company)
|
||||
self.assertEqual(item.type, self.stock_type.type)
|
||||
|
||||
def test_consist_length_calculation(self):
|
||||
"""Test consist length calculation."""
|
||||
# Add three items (not loads)
|
||||
for i in range(3):
|
||||
stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number=str(340 + i),
|
||||
scale=self.scale_hon3,
|
||||
)
|
||||
ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=stock,
|
||||
order=i + 1,
|
||||
load=False,
|
||||
)
|
||||
|
||||
self.assertEqual(self.consist.length, 3)
|
||||
|
||||
def test_consist_length_excludes_loads(self):
|
||||
"""Test that consist length excludes loads."""
|
||||
# Add one regular item
|
||||
ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=1,
|
||||
load=False,
|
||||
)
|
||||
|
||||
# Add one load (same ratio, different scale tracks OK for loads)
|
||||
load_stock = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="LOAD-1",
|
||||
scale=self.scale_hon3,
|
||||
)
|
||||
ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=load_stock,
|
||||
order=2,
|
||||
load=True,
|
||||
)
|
||||
|
||||
# Length should only count non-load items
|
||||
self.assertEqual(self.consist.length, 1)
|
||||
|
||||
def test_consist_item_ordering(self):
|
||||
"""Test consist items are ordered by order field."""
|
||||
stock2 = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="341",
|
||||
scale=self.scale_hon3,
|
||||
)
|
||||
stock3 = RollingStock.objects.create(
|
||||
rolling_class=self.rolling_class,
|
||||
road_number="342",
|
||||
scale=self.scale_hon3,
|
||||
)
|
||||
|
||||
item3 = ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=stock3,
|
||||
order=3,
|
||||
)
|
||||
item1 = ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=1,
|
||||
)
|
||||
item2 = ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=stock2,
|
||||
order=2,
|
||||
)
|
||||
|
||||
items = list(self.consist.consist_item.all())
|
||||
self.assertEqual(items[0], item1)
|
||||
self.assertEqual(items[1], item2)
|
||||
self.assertEqual(items[2], item3)
|
||||
|
||||
def test_unpublish_consist_signal(self):
|
||||
"""Test that unpublishing rolling stock unpublishes consists."""
|
||||
# Create a consist item
|
||||
ConsistItem.objects.create(
|
||||
consist=self.consist,
|
||||
rolling_stock=self.rolling_stock,
|
||||
order=1,
|
||||
)
|
||||
|
||||
self.assertTrue(self.consist.published)
|
||||
|
||||
# Unpublish the rolling stock
|
||||
self.rolling_stock.published = False
|
||||
self.rolling_stock.save()
|
||||
|
||||
# Reload consist from database
|
||||
self.consist.refresh_from_db()
|
||||
|
||||
# Consist should now be unpublished
|
||||
self.assertFalse(self.consist.published)
|
||||
|
||||
@@ -1,11 +1,13 @@
|
||||
from rest_framework.generics import ListAPIView, RetrieveAPIView
|
||||
|
||||
from ram.views import CustomLimitOffsetPagination
|
||||
from consist.models import Consist
|
||||
from consist.serializers import ConsistSerializer
|
||||
|
||||
|
||||
class ConsistList(ListAPIView):
|
||||
serializer_class = ConsistSerializer
|
||||
pagination_class = CustomLimitOffsetPagination
|
||||
|
||||
def get_queryset(self):
|
||||
return Consist.objects.get_published(self.request.user)
|
||||
|
||||
@@ -1,11 +1,13 @@
|
||||
from django.contrib import admin
|
||||
from django.utils.html import format_html
|
||||
from adminsortable2.admin import SortableAdminMixin
|
||||
|
||||
from repository.models import DecoderDocument
|
||||
from metadata.models import (
|
||||
Property,
|
||||
Decoder,
|
||||
DecoderDocument,
|
||||
Scale,
|
||||
Shop,
|
||||
Manufacturer,
|
||||
Company,
|
||||
Tag,
|
||||
@@ -22,7 +24,7 @@ class PropertyAdmin(admin.ModelAdmin):
|
||||
class DecoderDocInline(admin.TabularInline):
|
||||
model = DecoderDocument
|
||||
min_num = 0
|
||||
extra = 0
|
||||
extra = 1
|
||||
classes = ["collapse"]
|
||||
|
||||
|
||||
@@ -45,18 +47,30 @@ class ScaleAdmin(admin.ModelAdmin):
|
||||
@admin.register(Company)
|
||||
class CompanyAdmin(admin.ModelAdmin):
|
||||
readonly_fields = ("logo_thumbnail",)
|
||||
list_display = ("name", "country")
|
||||
list_filter = list_display
|
||||
list_display = ("name", "country_flag_name")
|
||||
list_filter = ("name", "country")
|
||||
search_fields = ("name",)
|
||||
|
||||
@admin.display(description="Country")
|
||||
def country_flag_name(self, obj):
|
||||
return format_html(
|
||||
'<img src="{}" /> {}', obj.country.flag, obj.country.name
|
||||
)
|
||||
|
||||
|
||||
@admin.register(Manufacturer)
|
||||
class ManufacturerAdmin(admin.ModelAdmin):
|
||||
readonly_fields = ("logo_thumbnail",)
|
||||
list_display = ("name", "category")
|
||||
list_display = ("name", "category", "country_flag_name")
|
||||
list_filter = ("category",)
|
||||
search_fields = ("name",)
|
||||
|
||||
@admin.display(description="Country")
|
||||
def country_flag_name(self, obj):
|
||||
return format_html(
|
||||
'<img src="{}" /> {}', obj.country.flag, obj.country.name
|
||||
)
|
||||
|
||||
|
||||
@admin.register(Tag)
|
||||
class TagAdmin(admin.ModelAdmin):
|
||||
@@ -70,3 +84,16 @@ class RollingStockTypeAdmin(SortableAdminMixin, admin.ModelAdmin):
|
||||
list_display = ("__str__",)
|
||||
list_filter = ("type", "category")
|
||||
search_fields = ("type", "category")
|
||||
|
||||
|
||||
@admin.register(Shop)
|
||||
class ShopAdmin(admin.ModelAdmin):
|
||||
list_display = ("name", "on_line", "active", "country_flag_name")
|
||||
list_filter = ("on_line", "active")
|
||||
search_fields = ("name",)
|
||||
|
||||
@admin.display(description="Country")
|
||||
def country_flag_name(self, obj):
|
||||
return format_html(
|
||||
'<img src="{}" /> {}', obj.country.flag, obj.country.name
|
||||
)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-08 22:25
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("metadata", "0019_alter_scale_gauge"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterUniqueTogether(
|
||||
name="decoderdocument",
|
||||
unique_together=set(),
|
||||
),
|
||||
migrations.AlterUniqueTogether(
|
||||
name="rollingstocktype",
|
||||
unique_together=set(),
|
||||
),
|
||||
migrations.AddConstraint(
|
||||
model_name="decoderdocument",
|
||||
constraint=models.UniqueConstraint(
|
||||
fields=("decoder", "file"), name="unique_decoder_file"
|
||||
),
|
||||
),
|
||||
migrations.AddConstraint(
|
||||
model_name="rollingstocktype",
|
||||
constraint=models.UniqueConstraint(
|
||||
fields=("category", "type"), name="unique_category_type"
|
||||
),
|
||||
),
|
||||
]
|
||||
40
ram/metadata/migrations/0021_genericdocument.py
Normal file
40
ram/metadata/migrations/0021_genericdocument.py
Normal file
@@ -0,0 +1,40 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-17 09:31
|
||||
|
||||
import ram.utils
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("metadata", "0020_alter_decoderdocument_unique_together_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="GenericDocument",
|
||||
fields=[
|
||||
(
|
||||
"id",
|
||||
models.BigAutoField(
|
||||
auto_created=True,
|
||||
primary_key=True,
|
||||
serialize=False,
|
||||
verbose_name="ID",
|
||||
),
|
||||
),
|
||||
("description", models.CharField(blank=True, max_length=128)),
|
||||
(
|
||||
"file",
|
||||
models.FileField(
|
||||
storage=ram.utils.DeduplicatedStorage(), upload_to="files/"
|
||||
),
|
||||
),
|
||||
("private", models.BooleanField(default=False)),
|
||||
("tags", models.ManyToManyField(blank=True, to="metadata.tag")),
|
||||
],
|
||||
options={
|
||||
"verbose_name_plural": "Generic Documents",
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,66 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-18 11:20
|
||||
|
||||
import django.utils.timezone
|
||||
import django_countries.fields
|
||||
import tinymce.models
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("metadata", "0021_genericdocument"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="decoderdocument",
|
||||
name="creation_time",
|
||||
field=models.DateTimeField(
|
||||
auto_now_add=True, default=django.utils.timezone.now
|
||||
),
|
||||
preserve_default=False,
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="decoderdocument",
|
||||
name="updated_time",
|
||||
field=models.DateTimeField(auto_now=True),
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="genericdocument",
|
||||
name="creation_time",
|
||||
field=models.DateTimeField(
|
||||
auto_now_add=True, default=django.utils.timezone.now
|
||||
),
|
||||
preserve_default=False,
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="genericdocument",
|
||||
name="notes",
|
||||
field=tinymce.models.HTMLField(blank=True),
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="genericdocument",
|
||||
name="updated_time",
|
||||
field=models.DateTimeField(auto_now=True),
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="manufacturer",
|
||||
name="country",
|
||||
field=django_countries.fields.CountryField(blank=True, max_length=2),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="decoderdocument",
|
||||
name="private",
|
||||
field=models.BooleanField(
|
||||
default=False, help_text="Document will be visible only to logged users"
|
||||
),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="genericdocument",
|
||||
name="private",
|
||||
field=models.BooleanField(
|
||||
default=False, help_text="Document will be visible only to logged users"
|
||||
),
|
||||
),
|
||||
]
|
||||
40
ram/metadata/migrations/0023_shop.py
Normal file
40
ram/metadata/migrations/0023_shop.py
Normal file
@@ -0,0 +1,40 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-26 14:27
|
||||
|
||||
import django_countries.fields
|
||||
import django.db.models.functions.text
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("metadata", "0022_decoderdocument_creation_time_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name="Shop",
|
||||
fields=[
|
||||
(
|
||||
"id",
|
||||
models.BigAutoField(
|
||||
auto_created=True,
|
||||
primary_key=True,
|
||||
serialize=False,
|
||||
verbose_name="ID",
|
||||
),
|
||||
),
|
||||
("name", models.CharField(max_length=128, unique=True)),
|
||||
(
|
||||
"country",
|
||||
django_countries.fields.CountryField(blank=True, max_length=2),
|
||||
),
|
||||
("website", models.URLField(blank=True)),
|
||||
("on_line", models.BooleanField(default=True)),
|
||||
("active", models.BooleanField(default=True)),
|
||||
],
|
||||
options={
|
||||
"ordering": [django.db.models.functions.text.Lower("name")],
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,24 @@
|
||||
# Generated by Django 5.1.4 on 2025-02-09 13:47
|
||||
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("metadata", "0023_shop"),
|
||||
("repository", "0001_initial"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.RemoveField(
|
||||
model_name="genericdocument",
|
||||
name="tags",
|
||||
),
|
||||
migrations.DeleteModel(
|
||||
name="DecoderDocument",
|
||||
),
|
||||
migrations.DeleteModel(
|
||||
name="GenericDocument",
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,28 @@
|
||||
# Generated by Django 5.1.4 on 2025-05-04 20:45
|
||||
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
(
|
||||
"metadata",
|
||||
"0024_remove_genericdocument_tags_delete_decoderdocument_and_more",
|
||||
),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterModelOptions(
|
||||
name="company",
|
||||
options={"ordering": ["slug"], "verbose_name_plural": "Companies"},
|
||||
),
|
||||
migrations.AlterModelOptions(
|
||||
name="manufacturer",
|
||||
options={"ordering": ["category", "slug"]},
|
||||
),
|
||||
migrations.AlterModelOptions(
|
||||
name="tag",
|
||||
options={"ordering": ["slug"]},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,24 @@
|
||||
# Generated by Django 6.0 on 2026-01-09 12:08
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("metadata", "0025_alter_company_options_alter_manufacturer_options_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name="manufacturer",
|
||||
name="name",
|
||||
field=models.CharField(max_length=128),
|
||||
),
|
||||
migrations.AddConstraint(
|
||||
model_name="manufacturer",
|
||||
constraint=models.UniqueConstraint(
|
||||
fields=("name", "category"), name="unique_name_category"
|
||||
),
|
||||
),
|
||||
]
|
||||
@@ -1,4 +1,5 @@
|
||||
import os
|
||||
from urllib.parse import urlparse
|
||||
from django.db import models
|
||||
from django.urls import reverse
|
||||
from django.conf import settings
|
||||
@@ -6,12 +7,12 @@ from django.dispatch.dispatcher import receiver
|
||||
from django.core.exceptions import ValidationError
|
||||
from django_countries.fields import CountryField
|
||||
|
||||
from ram.models import Document
|
||||
from ram.models import SimpleBaseModel
|
||||
from ram.utils import DeduplicatedStorage, get_image_preview, slugify
|
||||
from ram.managers import PublicManager
|
||||
|
||||
|
||||
class Property(models.Model):
|
||||
class Property(SimpleBaseModel):
|
||||
name = models.CharField(max_length=128, unique=True)
|
||||
private = models.BooleanField(
|
||||
default=False,
|
||||
@@ -28,12 +29,13 @@ class Property(models.Model):
|
||||
objects = PublicManager()
|
||||
|
||||
|
||||
class Manufacturer(models.Model):
|
||||
name = models.CharField(max_length=128, unique=True)
|
||||
class Manufacturer(SimpleBaseModel):
|
||||
name = models.CharField(max_length=128)
|
||||
slug = models.CharField(max_length=128, unique=True, editable=False)
|
||||
category = models.CharField(
|
||||
max_length=64, choices=settings.MANUFACTURER_TYPES
|
||||
)
|
||||
country = CountryField(blank=True)
|
||||
website = models.URLField(blank=True)
|
||||
logo = models.ImageField(
|
||||
upload_to=os.path.join("images", "manufacturers"),
|
||||
@@ -43,7 +45,13 @@ class Manufacturer(models.Model):
|
||||
)
|
||||
|
||||
class Meta:
|
||||
ordering = ["category", "name"]
|
||||
ordering = ["category", "slug"]
|
||||
constraints = [
|
||||
models.UniqueConstraint(
|
||||
fields=["name", "category"],
|
||||
name="unique_name_category"
|
||||
)
|
||||
]
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
@@ -57,13 +65,17 @@ class Manufacturer(models.Model):
|
||||
},
|
||||
)
|
||||
|
||||
def website_short(self):
|
||||
if self.website:
|
||||
return urlparse(self.website).netloc.replace("www.", "")
|
||||
|
||||
def logo_thumbnail(self):
|
||||
return get_image_preview(self.logo.url)
|
||||
|
||||
logo_thumbnail.short_description = "Preview"
|
||||
|
||||
|
||||
class Company(models.Model):
|
||||
class Company(SimpleBaseModel):
|
||||
name = models.CharField(max_length=64, unique=True)
|
||||
slug = models.CharField(max_length=64, unique=True, editable=False)
|
||||
extended_name = models.CharField(max_length=128, blank=True)
|
||||
@@ -78,7 +90,7 @@ class Company(models.Model):
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural = "Companies"
|
||||
ordering = ["name"]
|
||||
ordering = ["slug"]
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
@@ -101,7 +113,7 @@ class Company(models.Model):
|
||||
logo_thumbnail.short_description = "Preview"
|
||||
|
||||
|
||||
class Decoder(models.Model):
|
||||
class Decoder(SimpleBaseModel):
|
||||
name = models.CharField(max_length=128, unique=True)
|
||||
manufacturer = models.ForeignKey(
|
||||
Manufacturer,
|
||||
@@ -117,7 +129,7 @@ class Decoder(models.Model):
|
||||
blank=True,
|
||||
)
|
||||
|
||||
class Meta(object):
|
||||
class Meta:
|
||||
ordering = ["manufacturer__name", "name"]
|
||||
|
||||
def __str__(self):
|
||||
@@ -129,15 +141,6 @@ class Decoder(models.Model):
|
||||
image_thumbnail.short_description = "Preview"
|
||||
|
||||
|
||||
class DecoderDocument(Document):
|
||||
decoder = models.ForeignKey(
|
||||
Decoder, on_delete=models.CASCADE, related_name="document"
|
||||
)
|
||||
|
||||
class Meta:
|
||||
unique_together = ("decoder", "file")
|
||||
|
||||
|
||||
def calculate_ratio(ratio):
|
||||
try:
|
||||
num, den = ratio.split(":")
|
||||
@@ -146,7 +149,7 @@ def calculate_ratio(ratio):
|
||||
raise ValidationError("Invalid ratio format")
|
||||
|
||||
|
||||
class Scale(models.Model):
|
||||
class Scale(SimpleBaseModel):
|
||||
scale = models.CharField(max_length=32, unique=True)
|
||||
slug = models.CharField(max_length=32, unique=True, editable=False)
|
||||
ratio = models.CharField(max_length=16, validators=[calculate_ratio])
|
||||
@@ -181,7 +184,7 @@ def scale_save(sender, instance, **kwargs):
|
||||
instance.ratio_int = calculate_ratio(instance.ratio)
|
||||
|
||||
|
||||
class RollingStockType(models.Model):
|
||||
class RollingStockType(SimpleBaseModel):
|
||||
type = models.CharField(max_length=64)
|
||||
order = models.PositiveSmallIntegerField()
|
||||
category = models.CharField(
|
||||
@@ -189,8 +192,13 @@ class RollingStockType(models.Model):
|
||||
)
|
||||
slug = models.CharField(max_length=128, unique=True, editable=False)
|
||||
|
||||
class Meta(object):
|
||||
unique_together = ("category", "type")
|
||||
class Meta:
|
||||
constraints = [
|
||||
models.UniqueConstraint(
|
||||
fields=["category", "type"],
|
||||
name="unique_category_type"
|
||||
)
|
||||
]
|
||||
ordering = ["order"]
|
||||
|
||||
def get_absolute_url(self):
|
||||
@@ -206,12 +214,12 @@ class RollingStockType(models.Model):
|
||||
return "{0} {1}".format(self.type, self.category)
|
||||
|
||||
|
||||
class Tag(models.Model):
|
||||
class Tag(SimpleBaseModel):
|
||||
name = models.CharField(max_length=128, unique=True)
|
||||
slug = models.CharField(max_length=128, unique=True)
|
||||
|
||||
class Meta(object):
|
||||
ordering = ["name"]
|
||||
class Meta:
|
||||
ordering = ["slug"]
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
@@ -226,6 +234,20 @@ class Tag(models.Model):
|
||||
)
|
||||
|
||||
|
||||
class Shop(SimpleBaseModel):
|
||||
name = models.CharField(max_length=128, unique=True)
|
||||
country = CountryField(blank=True)
|
||||
website = models.URLField(blank=True)
|
||||
on_line = models.BooleanField(default=True)
|
||||
active = models.BooleanField(default=True)
|
||||
|
||||
class Meta:
|
||||
ordering = [models.functions.Lower("name"),]
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
|
||||
|
||||
@receiver(models.signals.pre_save, sender=Manufacturer)
|
||||
@receiver(models.signals.pre_save, sender=Company)
|
||||
@receiver(models.signals.pre_save, sender=Scale)
|
||||
|
||||
@@ -1,3 +1,371 @@
|
||||
from django.test import TestCase
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.db import IntegrityError
|
||||
|
||||
# Create your tests here.
|
||||
from metadata.models import (
|
||||
Manufacturer,
|
||||
Company,
|
||||
Scale,
|
||||
RollingStockType,
|
||||
Decoder,
|
||||
Shop,
|
||||
Tag,
|
||||
calculate_ratio,
|
||||
)
|
||||
|
||||
|
||||
class ManufacturerTestCase(TestCase):
|
||||
"""Test cases for Manufacturer model."""
|
||||
|
||||
def test_manufacturer_creation(self):
|
||||
"""Test creating a manufacturer."""
|
||||
manufacturer = Manufacturer.objects.create(
|
||||
name="Blackstone Models",
|
||||
category="model",
|
||||
country="US",
|
||||
website="https://www.blackstonemodels.com",
|
||||
)
|
||||
|
||||
self.assertEqual(str(manufacturer), "Blackstone Models")
|
||||
self.assertEqual(manufacturer.slug, "blackstone-models")
|
||||
self.assertEqual(manufacturer.category, "model")
|
||||
|
||||
def test_manufacturer_slug_auto_generation(self):
|
||||
"""Test that slug is automatically generated."""
|
||||
manufacturer = Manufacturer.objects.create(
|
||||
name="Baldwin Locomotive Works",
|
||||
category="real",
|
||||
)
|
||||
|
||||
self.assertEqual(manufacturer.slug, "baldwin-locomotive-works")
|
||||
|
||||
def test_manufacturer_unique_constraint(self):
|
||||
"""Test that name+category must be unique."""
|
||||
Manufacturer.objects.create(
|
||||
name="Baldwin",
|
||||
category="real",
|
||||
)
|
||||
|
||||
# Should not be able to create another with same name+category
|
||||
with self.assertRaises(IntegrityError):
|
||||
Manufacturer.objects.create(
|
||||
name="Baldwin",
|
||||
category="real",
|
||||
)
|
||||
|
||||
def test_manufacturer_different_categories(self):
|
||||
"""Test that same name is allowed with different categories."""
|
||||
Manufacturer.objects.create(
|
||||
name="Baldwin",
|
||||
category="real",
|
||||
)
|
||||
|
||||
# Should be able to create with different category
|
||||
manufacturer2 = Manufacturer.objects.create(
|
||||
name="Alco",
|
||||
category="model",
|
||||
)
|
||||
|
||||
self.assertEqual(manufacturer2.name, "Alco")
|
||||
self.assertIsNotNone(manufacturer2.pk)
|
||||
|
||||
def test_manufacturer_website_short(self):
|
||||
"""Test website_short extracts domain."""
|
||||
manufacturer = Manufacturer.objects.create(
|
||||
name="Test Manufacturer",
|
||||
category="model",
|
||||
website="https://www.example.com/path",
|
||||
)
|
||||
|
||||
self.assertEqual(manufacturer.website_short(), "example.com")
|
||||
|
||||
def test_manufacturer_ordering(self):
|
||||
"""Test manufacturer ordering by category and slug."""
|
||||
m1 = Manufacturer.objects.create(name="Zebra", category="model")
|
||||
m2 = Manufacturer.objects.create(name="Alpha", category="accessory")
|
||||
m3 = Manufacturer.objects.create(name="Beta", category="model")
|
||||
|
||||
manufacturers = list(Manufacturer.objects.all())
|
||||
# Ordered by category, then slug
|
||||
self.assertEqual(manufacturers[0], m2) # accessory comes first
|
||||
self.assertTrue(manufacturers.index(m3) < manufacturers.index(m1))
|
||||
|
||||
|
||||
class CompanyTestCase(TestCase):
|
||||
"""Test cases for Company model."""
|
||||
|
||||
def test_company_creation(self):
|
||||
"""Test creating a company."""
|
||||
company = Company.objects.create(
|
||||
name="RGS",
|
||||
extended_name="Rio Grande Southern Railroad",
|
||||
country="US",
|
||||
freelance=False,
|
||||
)
|
||||
|
||||
self.assertEqual(str(company), "RGS")
|
||||
self.assertEqual(company.slug, "rgs")
|
||||
self.assertEqual(company.extended_name, "Rio Grande Southern Railroad")
|
||||
|
||||
def test_company_slug_generation(self):
|
||||
"""Test automatic slug generation."""
|
||||
company = Company.objects.create(
|
||||
name="Denver & Rio Grande Western",
|
||||
country="US",
|
||||
)
|
||||
|
||||
self.assertEqual(company.slug, "denver-rio-grande-western")
|
||||
|
||||
def test_company_unique_name(self):
|
||||
"""Test that company name must be unique."""
|
||||
Company.objects.create(name="RGS", country="US")
|
||||
|
||||
with self.assertRaises(IntegrityError):
|
||||
Company.objects.create(name="RGS", country="GB")
|
||||
|
||||
def test_company_extended_name_pp(self):
|
||||
"""Test extended name pretty print."""
|
||||
company = Company.objects.create(
|
||||
name="RGS",
|
||||
extended_name="Rio Grande Southern Railroad",
|
||||
country="US",
|
||||
)
|
||||
|
||||
self.assertEqual(
|
||||
company.extended_name_pp(),
|
||||
"(Rio Grande Southern Railroad)"
|
||||
)
|
||||
|
||||
def test_company_extended_name_pp_empty(self):
|
||||
"""Test extended name pretty print when empty."""
|
||||
company = Company.objects.create(name="RGS", country="US")
|
||||
|
||||
self.assertEqual(company.extended_name_pp(), "")
|
||||
|
||||
def test_company_freelance_flag(self):
|
||||
"""Test freelance flag."""
|
||||
company = Company.objects.create(
|
||||
name="Fake Railroad",
|
||||
country="US",
|
||||
freelance=True,
|
||||
)
|
||||
|
||||
self.assertTrue(company.freelance)
|
||||
|
||||
|
||||
class ScaleTestCase(TestCase):
|
||||
"""Test cases for Scale model."""
|
||||
|
||||
def test_scale_creation(self):
|
||||
"""Test creating a scale."""
|
||||
scale = Scale.objects.create(
|
||||
scale="HOn3",
|
||||
ratio="1:87",
|
||||
tracks=10.5,
|
||||
gauge="3 ft",
|
||||
)
|
||||
|
||||
self.assertEqual(str(scale), "HOn3")
|
||||
self.assertEqual(scale.slug, "hon3")
|
||||
self.assertEqual(scale.ratio, "1:87")
|
||||
self.assertEqual(scale.tracks, 10.5)
|
||||
|
||||
def test_scale_ratio_calculation(self):
|
||||
"""Test automatic ratio_int calculation."""
|
||||
scale = Scale.objects.create(
|
||||
scale="HO",
|
||||
ratio="1:87",
|
||||
tracks=16.5,
|
||||
)
|
||||
|
||||
# 1/87 * 10000 = 114.94...
|
||||
self.assertAlmostEqual(scale.ratio_int, 114, delta=1)
|
||||
|
||||
def test_scale_ratio_validation_valid(self):
|
||||
"""Test that valid ratios are accepted."""
|
||||
ratios = ["1:87", "1:160", "1:22.5", "1:48"]
|
||||
|
||||
for ratio in ratios:
|
||||
result = calculate_ratio(ratio)
|
||||
self.assertIsInstance(result, (int, float))
|
||||
|
||||
def test_scale_ratio_validation_invalid(self):
|
||||
"""Test that invalid ratios raise ValidationError."""
|
||||
with self.assertRaises(ValidationError):
|
||||
calculate_ratio("invalid")
|
||||
|
||||
with self.assertRaises(ValidationError):
|
||||
calculate_ratio("1:0") # Division by zero
|
||||
|
||||
def test_scale_ordering(self):
|
||||
"""Test scale ordering by ratio_int (descending)."""
|
||||
s1 = Scale.objects.create(scale="G", ratio="1:22.5", tracks=45.0)
|
||||
s2 = Scale.objects.create(scale="HO", ratio="1:87", tracks=16.5)
|
||||
s3 = Scale.objects.create(scale="N", ratio="1:160", tracks=9.0)
|
||||
|
||||
scales = list(Scale.objects.all())
|
||||
# Ordered by -ratio_int (larger ratios first)
|
||||
self.assertEqual(scales[0], s1) # G scale (largest)
|
||||
self.assertEqual(scales[1], s2) # HO scale
|
||||
self.assertEqual(scales[2], s3) # N scale (smallest)
|
||||
|
||||
|
||||
class RollingStockTypeTestCase(TestCase):
|
||||
"""Test cases for RollingStockType model."""
|
||||
|
||||
def test_rolling_stock_type_creation(self):
|
||||
"""Test creating a rolling stock type."""
|
||||
stock_type = RollingStockType.objects.create(
|
||||
type="Steam Locomotive",
|
||||
category="locomotive",
|
||||
order=1,
|
||||
)
|
||||
|
||||
self.assertEqual(str(stock_type), "Steam Locomotive locomotive")
|
||||
self.assertEqual(stock_type.slug, "steam-locomotive-locomotive")
|
||||
|
||||
def test_rolling_stock_type_unique_constraint(self):
|
||||
"""Test that category+type must be unique."""
|
||||
RollingStockType.objects.create(
|
||||
type="Steam Locomotive",
|
||||
category="locomotive",
|
||||
order=1,
|
||||
)
|
||||
|
||||
with self.assertRaises(IntegrityError):
|
||||
RollingStockType.objects.create(
|
||||
type="Steam Locomotive",
|
||||
category="locomotive",
|
||||
order=2,
|
||||
)
|
||||
|
||||
def test_rolling_stock_type_ordering(self):
|
||||
"""Test ordering by order field."""
|
||||
t3 = RollingStockType.objects.create(
|
||||
type="Caboose", category="railcar", order=3
|
||||
)
|
||||
t1 = RollingStockType.objects.create(
|
||||
type="Steam", category="locomotive", order=1
|
||||
)
|
||||
t2 = RollingStockType.objects.create(
|
||||
type="Boxcar", category="railcar", order=2
|
||||
)
|
||||
|
||||
types = list(RollingStockType.objects.all())
|
||||
self.assertEqual(types[0], t1)
|
||||
self.assertEqual(types[1], t2)
|
||||
self.assertEqual(types[2], t3)
|
||||
|
||||
|
||||
class DecoderTestCase(TestCase):
|
||||
"""Test cases for Decoder model."""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data."""
|
||||
self.manufacturer = Manufacturer.objects.create(
|
||||
name="ESU",
|
||||
category="accessory",
|
||||
country="DE",
|
||||
)
|
||||
|
||||
def test_decoder_creation(self):
|
||||
"""Test creating a decoder."""
|
||||
decoder = Decoder.objects.create(
|
||||
name="LokSound 5",
|
||||
manufacturer=self.manufacturer,
|
||||
version="5.0",
|
||||
sound=True,
|
||||
)
|
||||
|
||||
self.assertEqual(str(decoder), "ESU - LokSound 5")
|
||||
self.assertTrue(decoder.sound)
|
||||
|
||||
def test_decoder_without_sound(self):
|
||||
"""Test creating a non-sound decoder."""
|
||||
decoder = Decoder.objects.create(
|
||||
name="LokPilot 5",
|
||||
manufacturer=self.manufacturer,
|
||||
sound=False,
|
||||
)
|
||||
|
||||
self.assertFalse(decoder.sound)
|
||||
|
||||
def test_decoder_ordering(self):
|
||||
"""Test decoder ordering by manufacturer name and decoder name."""
|
||||
man2 = Manufacturer.objects.create(
|
||||
name="Digitrax",
|
||||
category="accessory",
|
||||
)
|
||||
|
||||
d1 = Decoder.objects.create(
|
||||
name="LokSound 5",
|
||||
manufacturer=self.manufacturer,
|
||||
)
|
||||
d2 = Decoder.objects.create(
|
||||
name="DZ123",
|
||||
manufacturer=man2,
|
||||
)
|
||||
d3 = Decoder.objects.create(
|
||||
name="LokPilot 5",
|
||||
manufacturer=self.manufacturer,
|
||||
)
|
||||
|
||||
decoders = list(Decoder.objects.all())
|
||||
# Ordered by manufacturer name, then decoder name
|
||||
self.assertEqual(decoders[0], d2) # Digitrax
|
||||
self.assertTrue(decoders.index(d3) < decoders.index(d1)) # LokPilot before LokSound
|
||||
|
||||
|
||||
class ShopTestCase(TestCase):
|
||||
"""Test cases for Shop model."""
|
||||
|
||||
def test_shop_creation(self):
|
||||
"""Test creating a shop."""
|
||||
shop = Shop.objects.create(
|
||||
name="Caboose Hobbies",
|
||||
country="US",
|
||||
website="https://www.caboosehobbies.com",
|
||||
on_line=True,
|
||||
active=True,
|
||||
)
|
||||
|
||||
self.assertEqual(str(shop), "Caboose Hobbies")
|
||||
self.assertTrue(shop.on_line)
|
||||
self.assertTrue(shop.active)
|
||||
|
||||
def test_shop_defaults(self):
|
||||
"""Test shop default values."""
|
||||
shop = Shop.objects.create(name="Local Shop")
|
||||
|
||||
self.assertTrue(shop.on_line) # Default True
|
||||
self.assertTrue(shop.active) # Default True
|
||||
|
||||
def test_shop_offline(self):
|
||||
"""Test creating an offline shop."""
|
||||
shop = Shop.objects.create(
|
||||
name="Brick and Mortar Store",
|
||||
on_line=False,
|
||||
)
|
||||
|
||||
self.assertFalse(shop.on_line)
|
||||
|
||||
|
||||
class TagTestCase(TestCase):
|
||||
"""Test cases for Tag model."""
|
||||
|
||||
def test_tag_creation(self):
|
||||
"""Test creating a tag."""
|
||||
tag = Tag.objects.create(
|
||||
name="Narrow Gauge",
|
||||
slug="narrow-gauge",
|
||||
)
|
||||
|
||||
self.assertEqual(str(tag), "Narrow Gauge")
|
||||
self.assertEqual(tag.slug, "narrow-gauge")
|
||||
|
||||
def test_tag_unique_name(self):
|
||||
"""Test that tag name must be unique."""
|
||||
Tag.objects.create(name="Narrow Gauge", slug="narrow-gauge")
|
||||
|
||||
with self.assertRaises(IntegrityError):
|
||||
Tag.objects.create(name="Narrow Gauge", slug="narrow-gauge")
|
||||
|
||||
@@ -1,12 +1,15 @@
|
||||
from django.conf import settings
|
||||
from django.contrib import admin
|
||||
from solo.admin import SingletonModelAdmin
|
||||
from tinymce.widgets import TinyMCE
|
||||
|
||||
from ram.admin import publish, unpublish
|
||||
from portal.models import SiteConfiguration, Flatpage
|
||||
|
||||
|
||||
@admin.register(SiteConfiguration)
|
||||
class SiteConfigurationAdmin(SingletonModelAdmin):
|
||||
readonly_fields = ("site_name",)
|
||||
readonly_fields = ("site_name", "rest_api", "version")
|
||||
fieldsets = (
|
||||
(
|
||||
None,
|
||||
@@ -17,8 +20,11 @@ class SiteConfigurationAdmin(SingletonModelAdmin):
|
||||
"about",
|
||||
"items_per_page",
|
||||
"items_ordering",
|
||||
"featured_items_ordering",
|
||||
"currency",
|
||||
"footer",
|
||||
"footer_extended",
|
||||
"disclaimer",
|
||||
)
|
||||
},
|
||||
),
|
||||
@@ -29,12 +35,32 @@ class SiteConfigurationAdmin(SingletonModelAdmin):
|
||||
"fields": (
|
||||
"show_version",
|
||||
"use_cdn",
|
||||
"extra_head",
|
||||
"extra_html",
|
||||
"extra_js",
|
||||
"rest_api",
|
||||
"version",
|
||||
),
|
||||
},
|
||||
),
|
||||
)
|
||||
|
||||
@admin.display(description="REST API enabled", boolean=True)
|
||||
def rest_api(self, obj):
|
||||
return settings.REST_ENABLED
|
||||
|
||||
@admin.display()
|
||||
def version(self, obj):
|
||||
return "{} (Django {})".format(obj.version, obj.django_version)
|
||||
|
||||
def formfield_for_dbfield(self, db_field, **kwargs):
|
||||
if db_field.name in ("footer", "footer_extended", "disclaimer"):
|
||||
return db_field.formfield(
|
||||
widget=TinyMCE(
|
||||
mce_attrs={"height": "200"},
|
||||
)
|
||||
)
|
||||
return super().formfield_for_dbfield(db_field, **kwargs)
|
||||
|
||||
|
||||
@admin.register(Flatpage)
|
||||
class FlatpageAdmin(admin.ModelAdmin):
|
||||
@@ -66,3 +92,4 @@ class FlatpageAdmin(admin.ModelAdmin):
|
||||
},
|
||||
),
|
||||
)
|
||||
actions = [publish, unpublish]
|
||||
|
||||
21
ram/portal/migrations/0018_siteconfiguration_currency.py
Normal file
21
ram/portal/migrations/0018_siteconfiguration_currency.py
Normal file
@@ -0,0 +1,21 @@
|
||||
# Generated by Django 5.1.4 on 2024-12-29 15:18
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
(
|
||||
"portal",
|
||||
"0017_alter_flatpage_content_alter_siteconfiguration_about_and_more",
|
||||
),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="siteconfiguration",
|
||||
name="currency",
|
||||
field=models.CharField(default="EUR", max_length=3),
|
||||
),
|
||||
]
|
||||
19
ram/portal/migrations/0019_siteconfiguration_disclaimer.py
Normal file
19
ram/portal/migrations/0019_siteconfiguration_disclaimer.py
Normal file
@@ -0,0 +1,19 @@
|
||||
# Generated by Django 5.1.4 on 2025-01-30 16:39
|
||||
|
||||
import tinymce.models
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("portal", "0018_siteconfiguration_currency"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="siteconfiguration",
|
||||
name="disclaimer",
|
||||
field=tinymce.models.HTMLField(blank=True),
|
||||
),
|
||||
]
|
||||
17
ram/portal/migrations/0020_alter_flatpage_options.py
Normal file
17
ram/portal/migrations/0020_alter_flatpage_options.py
Normal file
@@ -0,0 +1,17 @@
|
||||
# Generated by Django 5.1.4 on 2025-02-01 23:26
|
||||
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("portal", "0019_siteconfiguration_disclaimer"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterModelOptions(
|
||||
name="flatpage",
|
||||
options={"verbose_name": "page", "verbose_name_plural": "pages"},
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,43 @@
|
||||
# Generated by Django 6.0 on 2026-01-02 23:41
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("portal", "0020_alter_flatpage_options"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name="siteconfiguration",
|
||||
name="featured_items_ordering",
|
||||
field=models.CharField(
|
||||
choices=[
|
||||
("type", "By rolling stock type and company"),
|
||||
("class", "By rolling stock type and class"),
|
||||
("company", "By company and type"),
|
||||
("country", "By country and type"),
|
||||
("cou+com", "By country and company"),
|
||||
],
|
||||
default="type",
|
||||
max_length=11,
|
||||
),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="siteconfiguration",
|
||||
name="items_ordering",
|
||||
field=models.CharField(
|
||||
choices=[
|
||||
("type", "By rolling stock type and company"),
|
||||
("class", "By rolling stock type and class"),
|
||||
("company", "By company and type"),
|
||||
("country", "By country and type"),
|
||||
("cou+com", "By country and company"),
|
||||
],
|
||||
default="type",
|
||||
max_length=11,
|
||||
),
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,34 @@
|
||||
# Generated by Django 6.0.1 on 2026-01-15 11:32
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
("portal", "0021_siteconfiguration_featured_items_ordering_and_more"),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.RenameField(
|
||||
model_name="siteconfiguration",
|
||||
old_name="extra_head",
|
||||
new_name="extra_html",
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name="siteconfiguration",
|
||||
name="extra_html",
|
||||
field=models.TextField(
|
||||
blank=True,
|
||||
help_text="Extra HTML to be dinamically loaded into the site.",
|
||||
),
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name="siteconfiguration",
|
||||
name="extra_js",
|
||||
field=models.TextField(
|
||||
blank=True,
|
||||
help_text="Extra JS to be dinamically loaded into the site."
|
||||
),
|
||||
),
|
||||
]
|
||||
@@ -22,19 +22,31 @@ class SiteConfiguration(SingletonModel):
|
||||
default="6",
|
||||
)
|
||||
items_ordering = models.CharField(
|
||||
max_length=10,
|
||||
max_length=11,
|
||||
choices=[
|
||||
("type", "By rolling stock type"),
|
||||
("company", "By company name"),
|
||||
("identifier", "By rolling stock class"),
|
||||
("type", "By rolling stock type and company"),
|
||||
("class", "By rolling stock type and class"),
|
||||
("company", "By company and type"),
|
||||
("country", "By country and type"),
|
||||
("cou+com", "By country and company"),
|
||||
],
|
||||
default="type",
|
||||
)
|
||||
featured_items_ordering = items_ordering.clone()
|
||||
currency = models.CharField(max_length=3, default="EUR")
|
||||
footer = tinymce.HTMLField(blank=True)
|
||||
footer_extended = tinymce.HTMLField(blank=True)
|
||||
disclaimer = tinymce.HTMLField(blank=True)
|
||||
show_version = models.BooleanField(default=True)
|
||||
use_cdn = models.BooleanField(default=True)
|
||||
extra_head = models.TextField(blank=True)
|
||||
extra_html = models.TextField(
|
||||
blank=True,
|
||||
help_text="Extra HTML to be dinamically loaded into the site.",
|
||||
)
|
||||
extra_js = models.TextField(
|
||||
blank=True,
|
||||
help_text="Extra JS to be dinamically loaded into the site.",
|
||||
)
|
||||
|
||||
class Meta:
|
||||
verbose_name = "Site Configuration"
|
||||
@@ -45,9 +57,11 @@ class SiteConfiguration(SingletonModel):
|
||||
def site_name(self):
|
||||
return settings.SITE_NAME
|
||||
|
||||
@property
|
||||
def version(self):
|
||||
return app_version
|
||||
|
||||
@property
|
||||
def django_version(self):
|
||||
return django.get_version()
|
||||
|
||||
@@ -60,6 +74,10 @@ class Flatpage(models.Model):
|
||||
creation_time = models.DateTimeField(auto_now_add=True)
|
||||
updated_time = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta:
|
||||
verbose_name = "page"
|
||||
verbose_name_plural = "pages"
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
|
||||
|
||||
Binary file not shown.
@@ -1,5 +1,5 @@
|
||||
/*!
|
||||
* Bootstrap Icons v1.11.3 (https://icons.getbootstrap.com/)
|
||||
* Bootstrap Icons v1.13.1 (https://icons.getbootstrap.com/)
|
||||
* Copyright 2019-2024 The Bootstrap Authors
|
||||
* Licensed under MIT (https://github.com/twbs/icons/blob/main/LICENSE)
|
||||
*/
|
||||
@@ -7,8 +7,8 @@
|
||||
@font-face {
|
||||
font-display: block;
|
||||
font-family: "bootstrap-icons";
|
||||
src: url("./fonts/bootstrap-icons.woff2?dd67030699838ea613ee6dbda90effa6") format("woff2"),
|
||||
url("./fonts/bootstrap-icons.woff?dd67030699838ea613ee6dbda90effa6") format("woff");
|
||||
src: url("./fonts/bootstrap-icons.woff2?e34853135f9e39acf64315236852cd5a") format("woff2"),
|
||||
url("./fonts/bootstrap-icons.woff?e34853135f9e39acf64315236852cd5a") format("woff");
|
||||
}
|
||||
|
||||
.bi::before,
|
||||
@@ -2076,3 +2076,31 @@ url("./fonts/bootstrap-icons.woff?dd67030699838ea613ee6dbda90effa6") format("wof
|
||||
.bi-suitcase2-fill::before { content: "\f901"; }
|
||||
.bi-suitcase2::before { content: "\f902"; }
|
||||
.bi-vignette::before { content: "\f903"; }
|
||||
.bi-bluesky::before { content: "\f7f9"; }
|
||||
.bi-tux::before { content: "\f904"; }
|
||||
.bi-beaker-fill::before { content: "\f905"; }
|
||||
.bi-beaker::before { content: "\f906"; }
|
||||
.bi-flask-fill::before { content: "\f907"; }
|
||||
.bi-flask-florence-fill::before { content: "\f908"; }
|
||||
.bi-flask-florence::before { content: "\f909"; }
|
||||
.bi-flask::before { content: "\f90a"; }
|
||||
.bi-leaf-fill::before { content: "\f90b"; }
|
||||
.bi-leaf::before { content: "\f90c"; }
|
||||
.bi-measuring-cup-fill::before { content: "\f90d"; }
|
||||
.bi-measuring-cup::before { content: "\f90e"; }
|
||||
.bi-unlock2-fill::before { content: "\f90f"; }
|
||||
.bi-unlock2::before { content: "\f910"; }
|
||||
.bi-battery-low::before { content: "\f911"; }
|
||||
.bi-anthropic::before { content: "\f912"; }
|
||||
.bi-apple-music::before { content: "\f913"; }
|
||||
.bi-claude::before { content: "\f914"; }
|
||||
.bi-openai::before { content: "\f915"; }
|
||||
.bi-perplexity::before { content: "\f916"; }
|
||||
.bi-css::before { content: "\f917"; }
|
||||
.bi-javascript::before { content: "\f918"; }
|
||||
.bi-typescript::before { content: "\f919"; }
|
||||
.bi-fork-knife::before { content: "\f91a"; }
|
||||
.bi-globe-americas-fill::before { content: "\f91b"; }
|
||||
.bi-globe-asia-australia-fill::before { content: "\f91c"; }
|
||||
.bi-globe-central-south-asia-fill::before { content: "\f91d"; }
|
||||
.bi-globe-europe-africa-fill::before { content: "\f91e"; }
|
||||
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
6
ram/portal/static/bootstrap@5.3.8/dist/css/bootstrap.min.css
vendored
Normal file
6
ram/portal/static/bootstrap@5.3.8/dist/css/bootstrap.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
1
ram/portal/static/bootstrap@5.3.8/dist/css/bootstrap.min.css.map
vendored
Normal file
1
ram/portal/static/bootstrap@5.3.8/dist/css/bootstrap.min.css.map
vendored
Normal file
File diff suppressed because one or more lines are too long
7
ram/portal/static/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js
vendored
Normal file
7
ram/portal/static/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
1
ram/portal/static/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js.map
vendored
Normal file
1
ram/portal/static/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js.map
vendored
Normal file
File diff suppressed because one or more lines are too long
1
ram/portal/static/css/main.min.css
vendored
Normal file
1
ram/portal/static/css/main.min.css
vendored
Normal file
@@ -0,0 +1 @@
|
||||
html[data-bs-theme=dark] .navbar svg{fill:#fff}.card>a>img{width:100%}td>img.logo{max-width:200px;max-height:48px}td>img.logo-xl{max-width:400px;max-height:96px}td>p:last-child{margin-bottom:0}.btn>span{display:inline-block}a.badge,a.badge:hover{text-decoration:none;color:#fff}.img-thumbnail{padding:0}.w-33{width:33%!important}.table-group-divider{border-top:calc(var(--bs-border-width) * 3) solid var(--bs-border-color)}#nav-journal ol,#nav-journal ul{padding-left:1rem}#nav-journal ol:last-child,#nav-journal p:last-child,#nav-journal ul:last-child{margin-bottom:0}#footer>p{display:inline}
|
||||
7
ram/portal/static/css/src/README.md
Normal file
7
ram/portal/static/css/src/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Compile main.min.css
|
||||
|
||||
```bash
|
||||
$ npm install clean-css-cli
|
||||
$ npx cleancss -o ../main.min.css main.css
|
||||
```
|
||||
|
||||
@@ -17,6 +17,11 @@ td > img.logo-xl {
|
||||
max-height: 96px;
|
||||
}
|
||||
|
||||
/* Disable margin on last <p> in a <td> */
|
||||
td > p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.btn > span {
|
||||
display: inline-block;
|
||||
}
|
||||
@@ -38,17 +43,15 @@ a.badge, a.badge:hover {
|
||||
border-top: calc(var(--bs-border-width) * 3) solid var(--bs-border-color);
|
||||
}
|
||||
|
||||
#nav-notes > p {
|
||||
padding: .5rem;
|
||||
}
|
||||
|
||||
#nav-journal ul, #nav-journal ol {
|
||||
margin: 0;
|
||||
#nav-journal ul,
|
||||
#nav-journal ol {
|
||||
padding-left: 1rem;
|
||||
}
|
||||
|
||||
#nav-journal p {
|
||||
margin: 0;
|
||||
#nav-journal p:last-child,
|
||||
#nav-journal ul:last-child,
|
||||
#nav-journal ol:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
#footer > p {
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 5.2 KiB |
@@ -1,9 +1,7 @@
|
||||
<svg width="26" height="16" enable-background="new 0 0 26 26" version="1" viewBox="0 0 26 16" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="m2.8125 0.0010991a1.0001 1.0001 0 0 0-0.8125 1c0 0.55455-0.44545 1-1 1a1.0001 1.0001 0 0 0-1 1v10a1.0001 1.0001 0 0 0 1 1c0.55455 0 1 0.44546 1 1a1.0001 1.0001 0 0 0 1 1h20a1.0001 1.0001 0 0 0 1-1c0-0.55454 0.44546-1 1-1a1.0001 1.0001 0 0 0 1-1v-10a1.0001 1.0001 0 0 0-1-1c-0.55454 0-1-0.44545-1-1a1.0001 1.0001 0 0 0-1-1h-20a1.0001 1.0001 0 0 0-0.09375 0 1.0001 1.0001 0 0 0-0.09375 0zm0.78125 2h14.406v1h2v-1h2.4062c0.30628 0.76906 0.82469 1.2875 1.5938 1.5938v8.8125c-0.76906 0.30628-1.2875 0.82469-1.5938 1.5938h-2.4062v-1h-2v1h-14.406c-0.30628-0.76906-0.82469-1.2875-1.5938-1.5938v-8.8125c0.76906-0.30628 1.2875-0.82469 1.5938-1.5938zm14.406 2v2h2v-2zm0 3v2h2v-2zm0 3v2h2v-2z" enable-background="accumulate" overflow="visible" stroke-width="2" />
|
||||
<style>
|
||||
path {
|
||||
text-indent:0;
|
||||
text-transform:none;
|
||||
}
|
||||
</style>
|
||||
</svg>
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg width="32" height="16" preserveAspectRatio="xMidYMid" version="1.0" viewBox="0 0 24 12" xmlns="http://www.w3.org/2000/svg">
|
||||
<metadata>Created by potrace 1.15, written by Peter Selinger 2001-2017</metadata>
|
||||
<g transform="matrix(.0039261 0 0 -.0039261 -1.4249 18.53)">
|
||||
<path d="m813 4723-103-4v-309h-355l14-330h369l6-42c39-273 39-1414 0-1659l-7-39h-368l-14-330h355v-318l41-7c23-4 126-7 229-7s206 3 229 7l41 7v318h670v-318l41-7c23-4 126-7 229-7s206 3 229 7l41 7v318h670v-318l37-7c48-9 432-9 472 0l31 7v318h680v-318l31-7c39-9 423-9 469 0l35 6v314l338 3 337 2v-318l38-7c48-9 416-9 465 0l37 7v318h335v2400h-335v307l-135 6c-74 3-196 3-270 0l-135-6v-307l-337 2-338 3v302l-132 6c-73 3-194 3-268 0l-135-6v-307h-680v307l-135 6c-74 3-196 3-270 0l-135-6v-307h-670v307l-135 6c-74 3-196 3-270 0l-135-6v-307h-670v310h-63c-35 0-111 2-168 4s-150 1-206-1zm1141-666c3-12 11-97 18-187 24-309 11-1402-18-1507l-6-23h-725l-7 32c-39 197-39 1454 0 1676l6 32h726zm1218-42c20-182 30-569 25-940-6-371-21-707-33-727-3-4-169-8-368-8h-363l-7 48c-38 277-38 1365 1 1647l6 45 366-2 366-3zm1203 53c39-103 45-1264 9-1660l-7-68h-735l-6 68c-35 381-35 1263 0 1610l6 62h364c283 0 366-3 369-12zm1219-42c37-316 37-1287 0-1628l-7-58h-734l-6 73c-37 424-31 1544 8 1655 3 9 86 12 368 12h364zm841-1686c-336 0-363 1-370 18-3 9-13 152-22 317-21 431-7 1292 23 1388 5 16 31 17 369 17z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.4 KiB |
6
ram/portal/static/js/main.min.js
vendored
Normal file
6
ram/portal/static/js/main.min.js
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
/*!
|
||||
* Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
|
||||
* Copyright 2011-2023 The Bootstrap Authors
|
||||
* Licensed under the Creative Commons Attribution 3.0 Unported License.
|
||||
*/
|
||||
(()=>{"use strict";const e=()=>localStorage.getItem("theme"),t=()=>{const t=e();return t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")},a=e=>{"auto"===e&&window.matchMedia("(prefers-color-scheme: dark)").matches?document.documentElement.setAttribute("data-bs-theme","dark"):document.documentElement.setAttribute("data-bs-theme",e)};a(t());const r=(e,t=!1)=>{const a=document.querySelector("#bd-theme");if(!a)return;const r=document.querySelector(".theme-icon-active i"),o=document.querySelector(`[data-bs-theme-value="${e}"]`),s=o.querySelector(".theme-icon i").getAttribute("class");document.querySelectorAll("[data-bs-theme-value]").forEach(e=>{e.classList.remove("active"),e.setAttribute("aria-pressed","false")}),o.classList.add("active"),o.setAttribute("aria-pressed","true"),r.setAttribute("class",s),t&&a.focus()};window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change",()=>{const r=e();"light"!==r&&"dark"!==r&&a(t())}),window.addEventListener("DOMContentLoaded",()=>{r(t()),document.querySelectorAll("[data-bs-theme-value]").forEach(e=>{e.addEventListener("click",()=>{const t=e.getAttribute("data-bs-theme-value");(e=>{localStorage.setItem("theme",e)})(t),a(t),r(t,!0)})})})})(),document.addEventListener("DOMContentLoaded",function(){"use strict";const e=document.getElementById("tabSelector"),t=window.location.hash.substring(1);if(t){const a=`#nav-${t}`,r=document.querySelector(`[data-bs-target="${a}"]`);r&&(bootstrap.Tab.getOrCreateInstance(r).show(),e.value=a)}document.querySelectorAll('button[data-bs-toggle="tab"]').forEach(e=>{e.addEventListener("shown.bs.tab",e=>{const t=e.target.getAttribute("data-bs-target").replace("nav-","");history.replaceState(null,null,t)})}),e&&(e.addEventListener("change",function(){const e=this.value,t=document.querySelector(`[data-bs-target="${e}"]`);if(t){bootstrap.Tab.getOrCreateInstance(t).show()}}),document.querySelectorAll('[data-bs-toggle="tab"]').forEach(t=>{t.addEventListener("shown.bs.tab",t=>{const a=t.target.getAttribute("data-bs-target");e.value=a})}))}),document.addEventListener("DOMContentLoaded",function(){"use strict";const e=document.querySelectorAll(".needs-validation");Array.from(e).forEach(e=>{e.addEventListener("submit",t=>{e.checkValidity()||(t.preventDefault(),t.stopPropagation()),e.classList.add("was-validated")},!1)})});
|
||||
7
ram/portal/static/js/src/README.md
Normal file
7
ram/portal/static/js/src/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Compile main.min.js
|
||||
|
||||
```bash
|
||||
$ npm install terser
|
||||
$ npx terser theme_selector.js tabs_selector.js -c -m -o ../main.min.js
|
||||
```
|
||||
|
||||
43
ram/portal/static/js/src/tabs_selector.js
Normal file
43
ram/portal/static/js/src/tabs_selector.js
Normal file
@@ -0,0 +1,43 @@
|
||||
// use Bootstrap 5's Tab component to manage tab navigation and synchronize with URL hash
|
||||
document.addEventListener("DOMContentLoaded", function () {
|
||||
'use strict';
|
||||
|
||||
const selectElement = document.getElementById('tabSelector');
|
||||
// code to handle tab selection and URL hash synchronization
|
||||
const hash = window.location.hash.substring(1) // remove the '#' prefix
|
||||
if (hash) {
|
||||
const target = `#nav-${hash}`;
|
||||
const trigger = document.querySelector(`[data-bs-target="${target}"]`);
|
||||
if (trigger) {
|
||||
bootstrap.Tab.getOrCreateInstance(trigger).show();
|
||||
selectElement.value = target; // keep the dropdown in sync
|
||||
}
|
||||
}
|
||||
|
||||
// update the URL hash when a tab is shown
|
||||
document.querySelectorAll('button[data-bs-toggle="tab"]').forEach(btn => {
|
||||
btn.addEventListener('shown.bs.tab', event => {
|
||||
const newHash = event.target.getAttribute('data-bs-target').replace('nav-', '');
|
||||
history.replaceState(null, null, newHash);
|
||||
});
|
||||
});
|
||||
|
||||
// allow tab selection via a dropdown on small screens
|
||||
if (!selectElement) return;
|
||||
selectElement.addEventListener('change', function () {
|
||||
const target = this.value;
|
||||
const trigger = document.querySelector(`[data-bs-target="${target}"]`);
|
||||
if (trigger) {
|
||||
const tabInstance = bootstrap.Tab.getOrCreateInstance(trigger);
|
||||
tabInstance.show();
|
||||
}
|
||||
});
|
||||
|
||||
// keep the dropdown in sync if the user clicks a tab button
|
||||
document.querySelectorAll('[data-bs-toggle="tab"]').forEach(btn => {
|
||||
btn.addEventListener('shown.bs.tab', event => {
|
||||
const target = event.target.getAttribute('data-bs-target');
|
||||
selectElement.value = target;
|
||||
});
|
||||
});
|
||||
});
|
||||
76
ram/portal/static/js/src/theme_selector.js
Normal file
76
ram/portal/static/js/src/theme_selector.js
Normal file
@@ -0,0 +1,76 @@
|
||||
/*!
|
||||
* Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
|
||||
* Copyright 2011-2023 The Bootstrap Authors
|
||||
* Licensed under the Creative Commons Attribution 3.0 Unported License.
|
||||
*/
|
||||
|
||||
(() => {
|
||||
'use strict'
|
||||
|
||||
const getStoredTheme = () => localStorage.getItem('theme')
|
||||
const setStoredTheme = theme => localStorage.setItem('theme', theme)
|
||||
|
||||
const getPreferredTheme = () => {
|
||||
const storedTheme = getStoredTheme()
|
||||
if (storedTheme) {
|
||||
return storedTheme
|
||||
}
|
||||
|
||||
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
|
||||
}
|
||||
|
||||
const setTheme = theme => {
|
||||
if (theme === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
||||
document.documentElement.setAttribute('data-bs-theme', 'dark')
|
||||
} else {
|
||||
document.documentElement.setAttribute('data-bs-theme', theme)
|
||||
}
|
||||
}
|
||||
|
||||
setTheme(getPreferredTheme())
|
||||
|
||||
const showActiveTheme = (theme, focus = false) => {
|
||||
const themeSwitcher = document.querySelector('#bd-theme')
|
||||
|
||||
if (!themeSwitcher) {
|
||||
return
|
||||
}
|
||||
|
||||
const activeThemeIcon = document.querySelector('.theme-icon-active i')
|
||||
const btnToActive = document.querySelector(`[data-bs-theme-value="${theme}"]`)
|
||||
const biOfActiveBtn = btnToActive.querySelector('.theme-icon i').getAttribute('class')
|
||||
|
||||
document.querySelectorAll('[data-bs-theme-value]').forEach(element => {
|
||||
element.classList.remove('active')
|
||||
element.setAttribute('aria-pressed', 'false')
|
||||
})
|
||||
|
||||
btnToActive.classList.add('active')
|
||||
btnToActive.setAttribute('aria-pressed', 'true')
|
||||
activeThemeIcon.setAttribute('class', biOfActiveBtn)
|
||||
|
||||
if (focus) {
|
||||
themeSwitcher.focus()
|
||||
}
|
||||
}
|
||||
|
||||
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
|
||||
const storedTheme = getStoredTheme()
|
||||
if (storedTheme !== 'light' && storedTheme !== 'dark') {
|
||||
setTheme(getPreferredTheme())
|
||||
}
|
||||
})
|
||||
|
||||
window.addEventListener('DOMContentLoaded', () => {
|
||||
showActiveTheme(getPreferredTheme())
|
||||
document.querySelectorAll('[data-bs-theme-value]')
|
||||
.forEach(toggle => {
|
||||
toggle.addEventListener('click', () => {
|
||||
const theme = toggle.getAttribute('data-bs-theme-value')
|
||||
setStoredTheme(theme)
|
||||
setTheme(theme)
|
||||
showActiveTheme(theme, true)
|
||||
})
|
||||
})
|
||||
})
|
||||
})()
|
||||
15
ram/portal/static/js/src/validators.js
Normal file
15
ram/portal/static/js/src/validators.js
Normal file
@@ -0,0 +1,15 @@
|
||||
document.addEventListener("DOMContentLoaded", function () {
|
||||
'use strict'
|
||||
|
||||
const forms = document.querySelectorAll('.needs-validation')
|
||||
Array.from(forms).forEach(form => {
|
||||
form.addEventListener('submit', event => {
|
||||
if (!form.checkValidity()) {
|
||||
event.preventDefault()
|
||||
event.stopPropagation()
|
||||
}
|
||||
|
||||
form.classList.add('was-validated')
|
||||
}, false)
|
||||
})
|
||||
});
|
||||
26
ram/portal/templates/_includes/documents.html
Normal file
26
ram/portal/templates/_includes/documents.html
Normal file
@@ -0,0 +1,26 @@
|
||||
{% if documents %}
|
||||
<table class="table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th colspan="3" scope="row">{{ header|default:"Documents" }}</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody class="table-group-divider">
|
||||
{% for d in documents.all %}
|
||||
<tr>
|
||||
<td class="w-33">{{ d.description }}</td>
|
||||
<td class="text-nowrap">
|
||||
{% if d.private %}
|
||||
<i class="bi bi-file-earmark-lock2"></i>
|
||||
{% else %}
|
||||
<i class="bi bi-file-earmark-text"></i>
|
||||
{% endif %}
|
||||
<a href="{{ d.file.url }}" target="_blank">{{ d.filename }}</a>
|
||||
</td>
|
||||
<td class="text-end">{{ d.file.size | filesizeformat }}</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</tbody>
|
||||
</table>
|
||||
{% endif %}
|
||||
|
||||
36
ram/portal/templates/_includes/footer.html
Normal file
36
ram/portal/templates/_includes/footer.html
Normal file
@@ -0,0 +1,36 @@
|
||||
<footer class="text-body-secondary py-4">
|
||||
<div class="container d-lg-flex justify-content-between">
|
||||
<div id="footer" class="mb-1">
|
||||
<p>© {% now "Y" %}</p> {{ site_conf.footer | safe }}
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div id="footer_extended">
|
||||
{{ site_conf.footer_extended | safe }}
|
||||
</div>
|
||||
</div>
|
||||
<div class="container d-flex text-body-secondary">
|
||||
<p class="flex-fill small">Made with ❤️ for 🚂 and <i class="bi bi-github"></i> <a href="https://github.com/daniviga/django-ram">django-ram</a>
|
||||
{% if site_conf.show_version %}<br>Version {{ site_conf.version }}{% endif %}</p>
|
||||
<p class="text-end">
|
||||
{% if site_conf.disclaimer %}
|
||||
<a title="Disclaimer" href="" data-bs-toggle="modal" data-bs-target="#disclaimerModal"><i class="text-muted d-lg-none fs-5 bi bi-info-square-fill"></i><span class="d-none d-lg-inline small">Disclaimer</span></a><span class="d-none d-lg-inline small"> | </span>
|
||||
{% endif %}
|
||||
<a title="Back to top" href="#"><i class="text-muted d-lg-none fs-5 bi bi-arrow-up-left-square-fill"></i><span class="d-none d-lg-inline small">Back to top</span></a>
|
||||
</p>
|
||||
</div>
|
||||
<!-- Modal -->
|
||||
<div class="modal fade" id="disclaimerModal" tabindex="-1" aria-labelledby="disclaimerLabel" aria-hidden="true">
|
||||
<div class="modal-dialog modal-dialog-scrollable modal-dialog-centered">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h1 class="modal-title fs-5" id="disclaimerLabel">Disclaimer</h1>
|
||||
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
{{ site_conf.disclaimer | safe }}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
@@ -11,9 +11,10 @@
|
||||
<ul class="dropdown-menu" aria-labelledby="dropdownLogin">
|
||||
<li><a class="dropdown-item" href="{% url 'admin:roster_rollingstock_changelist' %}">Rolling stock</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:consist_consist_changelist' %}">Consists</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:app_list' 'metadata' %}">Metadata</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:portal_flatpage_changelist' %}">Pages</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:app_list' 'bookshelf' %}">Bookshelf</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:portal_flatpage_changelist' %}">Pages</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:app_list' 'repository' %}">Repository</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:app_list' 'metadata' %}">Metadata</a></li>
|
||||
<li><hr class="dropdown-divider"></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:index' %}">Admin</a></li>
|
||||
<li><a class="dropdown-item" href="{% url 'admin:portal_siteconfiguration_changelist' %}">Site configuration</a></li>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user