├── .editorconfig ├── .gitignore ├── CHANGELOG.rst ├── LICENSE ├── LICENSE_EXCEPTION ├── MANIFEST.in ├── README.rst ├── demo ├── __init__.py ├── settings.py ├── templates │ ├── base.html │ ├── form.html │ └── index.html ├── urls.py └── users │ ├── __init__.py │ ├── admin.py │ ├── migrations │ ├── 0001_initial.py │ └── __init__.py │ └── models.py ├── jsonstore ├── __init__.py ├── fields.py └── queryset.py ├── manage.py ├── setup.cfg ├── setup.py ├── tests ├── __init__.py ├── apps.py ├── fields │ ├── __init__.py │ ├── test_boolean_field.py │ ├── test_char_field.py │ ├── test_date_field.py │ ├── test_datetime_field.py │ ├── test_nullbooleanfield.py │ └── test_time_field.py ├── models.py ├── settings.py ├── templates │ └── index.html ├── test_json_field.py ├── test_model_api.py ├── test_model_form.py ├── test_query_api.py └── urls.py └── tox.ini /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | trim_trailing_whitespace = true 6 | end_of_line = lf 7 | indent_style = space 8 | insert_final_newline = true 9 | indent_size = 2 10 | 11 | [*.py] 12 | indent_size = 4 13 | 14 | [*.{md,rst,in}] 15 | indent_style = ignore 16 | indent_size = ignore 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .media 3 | .tox 4 | .coverage 5 | .vscode 6 | build 7 | html 8 | dist 9 | django_jsonstore.egg-info 10 | MANIFEST 11 | dj*.sqlite3 12 | node_modules/ 13 | docs/_build/** 14 | npm-debug.log 15 | -------------------------------------------------------------------------------- /CHANGELOG.rst: -------------------------------------------------------------------------------- 1 | ========= 2 | Changelog 3 | ========= 4 | 5 | 0.5.1 2023-01-16 6 | ---------------- 7 | 8 | Package deprication on favor of django-viewflow 9 | 10 | 11 | 0.5.0 2020-12-31 12 | ---------------- 13 | 14 | Support for Django 3.1 JSONField 15 | 16 | 0.4.1 2019-11-07 17 | ---------------- 18 | 19 | * Fix boolean field 20 | 21 | 22 | 0.4.0 2019-11-07 23 | ---------------- 24 | 25 | * Whole idea simplified. The library renamed to 'jsonstore' 26 | 27 | 28 | 0.3.0 2019-11-01 29 | ---------------- 30 | 31 | * Support for date/time/datetime values 32 | * Support for help_text (description) and verbose_name (verboseName) field specs 33 | 34 | 35 | 0.2.0 2019-10-25 36 | ---------------- 37 | 38 | * Support for Python 2.7 and django 1.11/3.0 39 | 40 | 41 | 0.1.0 2019-10-21 42 | ---------------- 43 | 44 | * Initial Release 45 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /LICENSE_EXCEPTION: -------------------------------------------------------------------------------- 1 | VIEWFLOW LIBRARY EXCEPTION 2 | 3 | Copyright (c) 2019 Mikhail Podgurskiy 4 | 5 | This Viewflow Library Exception ("Exception") is an additional 6 | permission under section 7 of the GNU Affero General Public License, 7 | version 3 ("AGPLv3"). It applies to a viewflow library that bears a 8 | notice placed by the copyright holder of the library stating that the 9 | library is governed by AGPLv3 along with this Exception. 10 | 11 | 1. Grant of Additional Permission. 12 | 13 | If you modify the Program or any covered work, without changing its 14 | source code, only by linking or combining some or all bundles of the 15 | Program with separate works covered by AGPL- incompatible license 16 | terms, the licensors of this Program grant you the additional 17 | permission to convey the resulting work. 18 | 19 | If you modify the Program, and your modified version becomes subject 20 | to the requirement stated in AGPLv3, section 13, you may satisfy this 21 | requirement by providing access to the Corresponding Source of your 22 | modified version to each user that explicitly requests such 23 | Corresponding Source, no later than 15 days following the date on 24 | which such request was received. 25 | 26 | 27 | 2. No Weakening of Viewflow Copyleft. 28 | 29 | The availability of this Exception does not imply any general 30 | presumption that third-party software is unaffected by the copyleft 31 | requirements of the license of Viewflow 32 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include LICENSE_EXCEPTION 3 | include MANIFEST.in 4 | include README.rst 5 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ======================= 2 | Django JSONStore 3 | ======================= 4 | 5 | IN ORDER TO REDUCE MAINTENANCE COST, THE PACKAGE FUNCTIONALITY HAS BEEN MOVED INTO THE 6 | `django-viewflow `_ 7 | 8 | PLEASE, CONSIDE TO UPGRADE AND UPDATE IMPORTS: 9 | 10 | 11 | .. code:: bash 12 | 13 | $ pip install django-viewflow>=2.0.0b1 14 | 15 | 16 | .. code:: python 17 | 18 | from viewflow import jsonstore 19 | 20 | 21 | Description 22 | =========== 23 | 24 | Expose Django JSONField data as virtual model fields 25 | 26 | Use ModelForm and ModelAdmin as usual. Perform simple queries. Migrate to real 27 | table columns when needed without code change. 28 | 29 | Suitable to store dumb business data, quick prototypes without DB migrations, 30 | and replace multi-table inheritance joins. 31 | 32 | .. image:: https://img.shields.io/pypi/v/django-jsonstore.svg 33 | :target: https://pypi.python.org/pypi/django-jsonstore 34 | 35 | .. image:: https://img.shields.io/pypi/pyversions/django-jsonstore.svg 36 | :target: https://pypi.python.org/pypi/django-jsonstore 37 | 38 | .. image:: https://img.shields.io/pypi/djversions/django-jsonstore.svg 39 | :target: https://pypi.python.org/pypi/django-jsonstore 40 | 41 | *Use with caution! Replacing relational structures with JSON data should be 42 | mindfull architecture decision.* 43 | 44 | Works with any JSONField `django.contrib.postgres `_, 45 | `django-annoying `_, 46 | `django-mysql `_, 47 | upcoming django `Cross-db JSONField `_ 48 | 49 | *Work in progress* part of https://json-schema.org definitions are only supported. 50 | 51 | Quick start 52 | =========== 53 | 54 | .. code:: python 55 | 56 | import jsonstore 57 | from django import forms 58 | from django.contrib import admin 59 | from django.db import models 60 | from .??. import JSONField 61 | 62 | class Employee(models.Model): 63 | data = JSONField(default={}) 64 | full_name = jsonstore.CharField(max_length=250) 65 | hire_date = jsonstore.DateField() 66 | salary = jsonstore.DecimalField(max_digits=10, decimal_places=2) 67 | 68 | class EmployeeForm(forms.ModelForm): 69 | class Meta: 70 | model = Employee 71 | fields = ['full_name', 'hire_date', 'salary'] 72 | 73 | @admin.register(Employee) 74 | class EmployeeAdmin(admin.ModelAdmin): 75 | list_display = ['full_name', 'hire_date'] 76 | fields = ['full_name', ('hire_date', 'salary')] 77 | 78 | 79 | Demo 80 | ==== 81 | 82 | The demo shows how to handle multiple User types within single table with 83 | JSONField and `Django-Polymodels `_ proxies. 84 | 85 | .. code:: bash 86 | 87 | $ export DATABASE_URL=postgresql://viewflow:viewflow@localhost/viewflow 88 | $ export DJANGO_SETTINGS_MODULE=demo.settings 89 | $ tox python manage.py migrate 90 | $ tox python manage.py runserver 91 | 92 | 93 | License 94 | ======= 95 | 96 | Django JSONStore is an Open Source project licensed under the terms of 97 | the AGPL license - `The GNU Affero General Public License v3.0 98 | `_ with the Additional Permissions 99 | described in `LICENSE_EXCEPTION <./LICENSE_EXCEPTION>`_ 100 | 101 | You can more read about AGPL at `AGPL FAQ `_ 102 | This package license scheme follows to GCC Runtime library licensing. If you use 103 | Linux already, probably this package license, should not bring anything new to 104 | your stack. 105 | 106 | Latest changelog 107 | ================ 108 | 109 | 0.5.1 2023-01-16 110 | ---------------- 111 | 112 | Package deprication on favor of django-viewflow 113 | -------------------------------------------------------------------------------- /demo/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /demo/settings.py: -------------------------------------------------------------------------------- 1 | import os 2 | import django 3 | import dj_database_url 4 | 5 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 6 | BASE_DIR = os.path.dirname(os.path.abspath(__file__)) 7 | 8 | 9 | # Quick-start development settings - unsuitable for production 10 | # See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/ 11 | 12 | # SECURITY WARNING: keep the secret key used in production secret! 13 | SECRET_KEY = 't#cv48$dw8)5!$jovf^^1)amhjq121m&l=a_ibx7$fat^8w7gn' 14 | 15 | # SECURITY WARNING: don't run with debug turned on in production! 16 | DEBUG = True 17 | 18 | ALLOWED_HOSTS = [] 19 | 20 | 21 | # Application definition 22 | 23 | INSTALLED_APPS = [ 24 | 'django.contrib.auth', 25 | 'django.contrib.admin', 26 | 'django.contrib.contenttypes', 27 | 'django.contrib.sessions', 28 | 'django.contrib.messages', 29 | 'django.contrib.staticfiles', 30 | 'demo.users', 31 | ] 32 | 33 | MIDDLEWARE = [ 34 | 'django.middleware.security.SecurityMiddleware', 35 | 'django.contrib.sessions.middleware.SessionMiddleware', 36 | 'django.middleware.common.CommonMiddleware', 37 | 'django.middleware.csrf.CsrfViewMiddleware', 38 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 39 | 'django.contrib.messages.middleware.MessageMiddleware', 40 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 41 | ] 42 | 43 | ROOT_URLCONF = 'demo.urls' 44 | 45 | TEMPLATES = [ 46 | { 47 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 48 | 'DIRS': [os.path.join(BASE_DIR, 'templates')], 49 | 'APP_DIRS': True, 50 | 'OPTIONS': { 51 | 'context_processors': [ 52 | 'django.template.context_processors.debug', 53 | 'django.template.context_processors.request', 54 | 'django.contrib.auth.context_processors.auth', 55 | 'django.contrib.messages.context_processors.messages', 56 | ], 57 | }, 58 | }, 59 | ] 60 | 61 | # Database 62 | # https://docs.djangoproject.com/en/2.2/ref/settings/#databases 63 | 64 | DATABASES = { 65 | 'default': dj_database_url.config() or { 66 | 'ENGINE': 'django.db.backends.sqlite3', 67 | 'NAME': os.path.join(BASE_DIR, 'dj{}{}.sqlite3'.format(*django.VERSION[:2])), 68 | } 69 | } 70 | 71 | # Custom user model 72 | # https://docs.djangoproject.com/en/2.2/topics/auth/customizing/ 73 | 74 | AUTH_USER_MODEL = 'users.User' 75 | 76 | 77 | # Internationalization 78 | # https://docs.djangoproject.com/en/2.2/topics/i18n/ 79 | 80 | LANGUAGE_CODE = 'en-us' 81 | 82 | TIME_ZONE = 'UTC' 83 | 84 | USE_I18N = True 85 | 86 | USE_L10N = True 87 | 88 | USE_TZ = True 89 | 90 | 91 | # Static files (CSS, JavaScript, Images) 92 | # https://docs.djangoproject.com/en/2.2/howto/static-files/ 93 | 94 | STATIC_URL = '/static/' 95 | 96 | 97 | # Logginh 98 | # https://docs.djangoproject.com/en/2.0/topics/logging/ 99 | 100 | LOGGING = { 101 | 'version': 1, 102 | 'filters': { 103 | 'require_debug_true': { 104 | '()': 'django.utils.log.RequireDebugTrue', 105 | } 106 | }, 107 | 'handlers': { 108 | 'console': { 109 | 'level': 'DEBUG', 110 | 'class': 'logging.StreamHandler', 111 | } 112 | }, 113 | 'loggers': { 114 | 'django.db.backends': { 115 | 'level': 'DEBUG', 116 | 'handlers': ['console'], 117 | } 118 | } 119 | } 120 | -------------------------------------------------------------------------------- /demo/templates/base.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | JSONField Schema Sample 7 | 8 | 9 | 10 | {% block content %}{% endblock %} 11 | 12 | 13 | -------------------------------------------------------------------------------- /demo/templates/form.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block content %} 4 |
5 | {% csrf_token %} 6 |
7 | Edit {{ object.content_type|capfirst }} 8 | {{ form }} 9 | 10 | 11 | 12 | {% endblock content %} 13 |
14 |
15 | -------------------------------------------------------------------------------- /demo/templates/index.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block content %} 4 | 5 | {% for user in user_list %} 6 | 7 | 8 | 9 | 12 | 13 | {% endfor %} 14 |
{{ user.username }}{{ user.content_type }}{% with url=user.get_absolute_url %} 10 | {% if url %}edit{% endif %} 11 | {% endwith %}
15 |
16 | Add an Employee 17 | Add a Client 18 |
19 | {% endblock content %} 20 | -------------------------------------------------------------------------------- /demo/urls.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.views import generic 3 | from django.urls import path 4 | 5 | from .users import models 6 | 7 | 8 | urlpatterns = [ 9 | path('', generic.ListView.as_view( 10 | template_name='index.html', 11 | queryset=models.User.objects.select_subclasses(), 12 | )), 13 | path('employee/add/', generic.CreateView.as_view( 14 | template_name='form.html', 15 | model=models.Employee, 16 | fields=('username', 'hire_date', 'salary', 'department'), 17 | success_url='/', 18 | ), name='employee_add'), 19 | path('employee//', generic.UpdateView.as_view( 20 | template_name='form.html', 21 | model=models.Employee, 22 | fields=('username', 'hire_date', 'salary', 'department'), 23 | success_url='/', 24 | ), name='employee_edit'), 25 | path('client/add/', generic.CreateView.as_view( 26 | template_name='form.html', 27 | model=models.Client, 28 | fields=('username', 'address', 'zip_code', 'city', 'vip'), 29 | success_url='/', 30 | ), name='client_add'), 31 | path('client//', generic.UpdateView.as_view( 32 | template_name='form.html', 33 | model=models.Client, 34 | fields=('username', 'address', 'zip_code', 'city', 'vip'), 35 | success_url='/', 36 | ), name='client_edit'), 37 | path('admin/', admin.site.urls), 38 | ] 39 | -------------------------------------------------------------------------------- /demo/users/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /demo/users/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.contrib.auth.admin import UserAdmin 3 | from . import models 4 | 5 | 6 | @admin.register(models.User) 7 | class UserAdmin(UserAdmin): 8 | list_display = UserAdmin.list_display + ('data', ) 9 | exclude = ['content_type', 'data'] 10 | 11 | 12 | @admin.register(models.Employee) 13 | class EmployeeAdmin(UserAdmin): 14 | list_display = ['username', 'first_name', 'last_name', 'salary', 'department'] 15 | fieldsets = UserAdmin.fieldsets + ( 16 | ("Employee data", {'fields': ('hire_date', 'salary', 'department')}), 17 | ) 18 | 19 | 20 | @admin.register(models.Client) 21 | class ClientAdmin(UserAdmin): 22 | list_display = ('username', 'first_name', 'last_name', 'city') 23 | list_filter = ('vip', ) 24 | fieldsets = UserAdmin.fieldsets + ( 25 | ("Client data", {'fields': ('address', 'zip_code', 'city', 'vip')}), 26 | ) 27 | -------------------------------------------------------------------------------- /demo/users/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 2.2.5 on 2019-10-21 11:50 2 | 3 | import django.contrib.auth.validators 4 | import django.contrib.postgres.fields.jsonb 5 | from django.db import migrations, models 6 | import django.db.models.deletion 7 | import django.utils.timezone 8 | 9 | 10 | class Migration(migrations.Migration): 11 | 12 | initial = True 13 | 14 | dependencies = [ 15 | ('contenttypes', '0002_remove_content_type_name'), 16 | ('auth', '0011_update_proxy_permissions'), 17 | ] 18 | 19 | operations = [ 20 | migrations.CreateModel( 21 | name='User', 22 | fields=[ 23 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 24 | ('password', models.CharField(max_length=128, verbose_name='password')), 25 | ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')), 26 | ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')), 27 | ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')), 28 | ('first_name', models.CharField(blank=True, max_length=30, verbose_name='first name')), 29 | ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')), 30 | ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')), 31 | ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')), 32 | ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')), 33 | ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')), 34 | ('data', django.contrib.postgres.fields.jsonb.JSONField(null=True)), 35 | ('content_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='+', to='contenttypes.ContentType')), 36 | ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.Group', verbose_name='groups')), 37 | ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.Permission', verbose_name='user permissions')), 38 | ], 39 | options={ 40 | 'abstract': False, 41 | }, 42 | ), 43 | migrations.CreateModel( 44 | name='Client', 45 | fields=[ 46 | ], 47 | options={ 48 | 'proxy': True, 49 | 'indexes': [], 50 | 'constraints': [], 51 | }, 52 | bases=('users.user',), 53 | ), 54 | migrations.CreateModel( 55 | name='Employee', 56 | fields=[ 57 | ], 58 | options={ 59 | 'proxy': True, 60 | 'indexes': [], 61 | 'constraints': [], 62 | }, 63 | bases=('users.user',), 64 | ), 65 | ] 66 | -------------------------------------------------------------------------------- /demo/users/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /demo/users/models.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | 3 | from django.contrib.auth.models import AbstractUser 4 | from django.contrib.auth.models import UserManager 5 | from django.urls import reverse 6 | from polymodels.managers import PolymorphicManager 7 | from polymodels.models import PolymorphicModel 8 | 9 | 10 | class UserManager(PolymorphicManager, UserManager): 11 | pass 12 | 13 | 14 | class User(PolymorphicModel, AbstractUser): 15 | data = jsonstore.JSONField(null=True, default=dict) 16 | objects = UserManager() 17 | 18 | 19 | class Employee(User): 20 | hire_date = jsonstore.DateField() 21 | salary = jsonstore.DecimalField(max_digits=10, decimal_places=2) 22 | department = jsonstore.CharField(max_length=200, choices=[ 23 | ('Marketing', 'Marketing'), 24 | ('Development', 'Development'), 25 | ('Sales', 'Sales'), 26 | ]) 27 | 28 | def get_absolute_url(self): 29 | return reverse('employee_edit', args=[self.pk]) 30 | 31 | class Meta: 32 | proxy = True 33 | 34 | 35 | class Client(User): 36 | address = jsonstore.CharField(max_length=250) 37 | zip_code = jsonstore.CharField(max_length=250) 38 | city = jsonstore.CharField(max_length=250) 39 | vip = jsonstore.BooleanField() 40 | 41 | def get_absolute_url(self): 42 | return reverse('client_edit', args=[self.pk]) 43 | 44 | class Meta: 45 | proxy = True 46 | -------------------------------------------------------------------------------- /jsonstore/__init__.py: -------------------------------------------------------------------------------- 1 | from .fields import ( 2 | JSONField, 3 | BooleanField, CharField, DateField, DateTimeField, 4 | DecimalField, EmailField, FloatField, 5 | IntegerField, IPAddressField, GenericIPAddressField, 6 | NullBooleanField, TextField, TimeField, URLField 7 | ) 8 | 9 | 10 | __all__ = ( 11 | 'JSONField', 12 | 'BooleanField', 'CharField', 'DateField', 'DateTimeField', 13 | 'DecimalField', 'EmailField', 'FloatField', 14 | 'IntegerField', 'IPAddressField', 'GenericIPAddressField', 15 | 'NullBooleanField', 'TextField', 'TimeField', 'URLField' 16 | ) 17 | 18 | 19 | import warnings 20 | 21 | warnings.warn("The package was merged into django-viewflow. Please consider to switch to django-viewflow>=2.0.0b1") -------------------------------------------------------------------------------- /jsonstore/fields.py: -------------------------------------------------------------------------------- 1 | import copy 2 | from datetime import date, datetime 3 | from importlib import import_module 4 | 5 | import django 6 | from django.conf import settings 7 | from django.core.exceptions import FieldError 8 | from django.db.models import fields 9 | from django.utils import dateparse, timezone 10 | 11 | try: 12 | from functools import partialmethod 13 | except ImportError: 14 | # python 2.7, so we are on django 1.11 15 | from django.utils.functional import curry as partialmethod 16 | 17 | 18 | def JSONField(*args, **kwargs): 19 | """ 20 | Returns json field implementation depends on the 21 | default db connection type or `db_vendor` keyword argument 22 | """ 23 | db_vendor = kwargs.pop('db_vendor', None) 24 | if db_vendor is None: 25 | backend = import_module('{}.base'.format(settings.DATABASES['default']['ENGINE']).replace('_psycopg2', '')) 26 | db_vendor = backend.DatabaseWrapper.vendor 27 | 28 | try: 29 | from django.db.models import JSONField as DJ_JSONField 30 | return DJ_JSONField(*args, **kwargs) 31 | except ImportError: 32 | pass 33 | 34 | if db_vendor == 'postgresql': 35 | from django.contrib.postgres.fields import JSONField as PG_JSONField 36 | return PG_JSONField(*args, **kwargs) 37 | elif db_vendor == 'mysql': 38 | try: 39 | from django_mysql.models import JSONField as MY_JSONField 40 | except ImportError: 41 | raise ImportError("django-mysql isn't installed") 42 | else: 43 | return MY_JSONField(*args, **kwargs) 44 | elif db_vendor == 'oracle': 45 | try: 46 | from oracle_json_field.fields import JSONField as OR_JSONField 47 | except ImportError: 48 | raise ImportError("oracle-json-field isn't installed") 49 | else: 50 | return OR_JSONField(*args, **kwargs) 51 | else: 52 | if django.VERSION >= (3, 0): 53 | # Quick six for django-annoying 54 | import six 55 | from django import utils 56 | utils.six = six 57 | 58 | try: 59 | from annoying.fields import JSONField as DEFAULT_JSONField 60 | except ImportError: 61 | raise ImportError("django-annoying isn't installed") 62 | else: 63 | return DEFAULT_JSONField(*args, **kwargs) 64 | 65 | 66 | class JSONFieldDescriptor(object): 67 | def __init__(self, field): 68 | self.field = field 69 | 70 | def __get__(self, instance, cls=None): 71 | if instance is None: 72 | return self 73 | json_value = getattr(instance, self.field.json_field_name) 74 | if isinstance(json_value, dict): 75 | value = json_value.get(self.field.attname, None) 76 | if hasattr(self.field, 'from_json'): 77 | value = self.field.from_json(value) 78 | return value 79 | return None 80 | 81 | def __set__(self, instance, value): 82 | json_value = getattr(instance, self.field.json_field_name) 83 | if json_value: 84 | assert isinstance(json_value, dict) 85 | else: 86 | json_value = {} 87 | 88 | if hasattr(self.field, 'to_json'): 89 | value = self.field.to_json(value) 90 | 91 | if not value and self.field.blank and not self.field.null: 92 | try: 93 | del json_value[self.field.attname] 94 | except KeyError: 95 | pass 96 | else: 97 | json_value[self.field.attname] = value 98 | 99 | setattr(instance, self.field.json_field_name, json_value) 100 | 101 | 102 | class JSONFieldMixin(object): 103 | """ 104 | Override django.db.model.fields.Field.contribute_to_class 105 | to make a field always private, and register custom access descriptor 106 | """ 107 | def __init__(self, *args, **kwargs): 108 | self.json_field_name = kwargs.pop('json_field_name', 'data') 109 | super(JSONFieldMixin, self).__init__(*args, **kwargs) 110 | 111 | def contribute_to_class(self, cls, name, private_only=False): 112 | self.set_attributes_from_name(name) 113 | self.model = cls 114 | self.concrete = False 115 | self.column = self.json_field_name 116 | cls._meta.add_field(self, private=True) 117 | 118 | if not getattr(cls, self.attname, None): 119 | descriptor = JSONFieldDescriptor(self) 120 | setattr(cls, self.attname, descriptor) 121 | 122 | if self.choices is not None: 123 | setattr(cls, 'get_%s_display' % self.name, 124 | partialmethod(cls._get_FIELD_display, field=self)) 125 | 126 | def get_lookup(self, lookup_name): 127 | # Always return None, to make get_transform been called 128 | return None 129 | 130 | def get_transform(self, name): 131 | class TransformFactoryWrapper: 132 | def __init__(self, json_field, transform, original_lookup): 133 | self.json_field = json_field 134 | self.transform = transform 135 | self.original_lookup = original_lookup 136 | 137 | def __call__(self, lhs, **kwargs): 138 | lhs = copy.copy(lhs) 139 | lhs.target = self.json_field 140 | lhs.output_field = self.json_field 141 | transform = self.transform(lhs, **kwargs) 142 | transform._original_get_lookup = transform.get_lookup 143 | transform.get_lookup = lambda name: transform._original_get_lookup(self.original_lookup) 144 | return transform 145 | 146 | json_field = self.model._meta.get_field(self.json_field_name) 147 | transform = json_field.get_transform(self.name) 148 | if transform is None: 149 | raise FieldError( 150 | "JSONField '%s' has no support for key '%s' %s lookup" % 151 | (self.json_field_name, self.name, name) 152 | ) 153 | 154 | return TransformFactoryWrapper(json_field, transform, name) 155 | 156 | def convert_json_value(self, value, expression, connection): 157 | if isinstance(value, str): 158 | import json 159 | return json.loads(value)[self.name] 160 | return value 161 | 162 | def get_db_converters(self, connection): 163 | converters = super().get_db_converters(connection) 164 | converters += [self.convert_json_value] 165 | return converters 166 | 167 | 168 | class BooleanField(JSONFieldMixin, fields.BooleanField): 169 | def __init__(self, *args, **kwargs): 170 | super(BooleanField, self).__init__(*args, **kwargs) 171 | if django.VERSION < (2, ): 172 | self.blank = False 173 | 174 | 175 | class CharField(JSONFieldMixin, fields.CharField): 176 | pass 177 | 178 | 179 | class DateField(JSONFieldMixin, fields.DateField): 180 | def to_json(self, value): 181 | if value: 182 | assert isinstance(value, (datetime, date)) 183 | return value.strftime('%Y-%m-%d') 184 | 185 | def from_json(self, value): 186 | if value is not None: 187 | return dateparse.parse_date(value) 188 | 189 | 190 | class DateTimeField(JSONFieldMixin, fields.DateTimeField): 191 | def to_json(self, value): 192 | if value: 193 | if not timezone.is_aware(value): 194 | value = timezone.make_aware(value) 195 | return value.isoformat() 196 | 197 | def from_json(self, value): 198 | if value: 199 | return dateparse.parse_datetime(value) 200 | 201 | 202 | class DecimalField(JSONFieldMixin, fields.DecimalField): 203 | pass 204 | 205 | 206 | class EmailField(JSONFieldMixin, fields.EmailField): 207 | pass 208 | 209 | 210 | class FloatField(JSONFieldMixin, fields.FloatField): 211 | pass 212 | 213 | 214 | class IntegerField(JSONFieldMixin, fields.IntegerField): 215 | pass 216 | 217 | 218 | class IPAddressField(JSONFieldMixin, fields.IPAddressField): 219 | pass 220 | 221 | 222 | class GenericIPAddressField(JSONFieldMixin, fields.GenericIPAddressField): 223 | pass 224 | 225 | 226 | class NullBooleanField(JSONFieldMixin, fields.NullBooleanField): 227 | pass 228 | 229 | 230 | class TextField(JSONFieldMixin, fields.TextField): 231 | pass 232 | 233 | 234 | class TimeField(JSONFieldMixin, fields.TimeField): 235 | def to_json(self, value): 236 | if value: 237 | if not timezone.is_aware(value): 238 | value = timezone.make_aware(value) 239 | return value.isoformat() 240 | 241 | def from_json(self, value): 242 | if value: 243 | return dateparse.parse_time(value) 244 | 245 | 246 | class URLField(JSONFieldMixin, fields.URLField): 247 | pass 248 | -------------------------------------------------------------------------------- /jsonstore/queryset.py: -------------------------------------------------------------------------------- 1 | class JSONSchemaQuerySetMixin(): 2 | def _setup(self): 3 | # find all JSONFieldMixin fields 4 | pass 5 | 6 | def _substitute_keys(self, keys): 7 | pass 8 | 9 | def filter(self): 10 | pass 11 | 12 | def order_by(self): 13 | pass 14 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | 6 | try: 7 | from IPython.core import ultratb 8 | except: 9 | pass 10 | else: 11 | sys.excepthook = ultratb.FormattedTB(mode='Verbose', color_scheme='Linux', call_pdb=1) 12 | 13 | 14 | os.environ['EMAIL_BACKEND'] = 'django.core.mail.backends.console.EmailBackend' 15 | 16 | 17 | if __name__ == "__main__": 18 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings") 19 | try: 20 | from django.core.management import execute_from_command_line 21 | except ImportError as exc: 22 | raise ImportError( 23 | "Couldn't import Django. Are you sure it's installed and " 24 | "available on your PYTHONPATH environment variable? Did you " 25 | "forget to activate a virtual environment?" 26 | ) 27 | execute_from_command_line(sys.argv) 28 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.rst -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | from setuptools import setup 4 | 5 | 6 | setup( 7 | name='django-jsonstore', 8 | version='0.5.1', 9 | author='Mikhail Podgurskiy', 10 | author_email='kmmbvnr@gmail.com', 11 | description='Expose JSONField data as a virtual django model fields.', 12 | long_description=open('README.rst').read(), 13 | platforms=['Any'], 14 | keywords=['django', 'json', 'orm'], 15 | url='http://github.com/viewflow/jsonstore', 16 | classifiers=[ 17 | 'Development Status :: 3 - Alpha', 18 | 'Intended Audience :: Developers', 19 | 'Natural Language :: English', 20 | 'Operating System :: OS Independent', 21 | 'Framework :: Django', 22 | 'Framework :: Django :: 2.0', 23 | 'Framework :: Django :: 2.1', 24 | 'Framework :: Django :: 2.2', 25 | 'Framework :: Django :: 3.0', 26 | 'Framework :: Django :: 3.1', 27 | 'Programming Language :: Python :: 2.7', 28 | 'Programming Language :: Python :: 3', 29 | 'Programming Language :: Python :: 3.6', 30 | 'Programming Language :: Python :: 3.7', 31 | 'Programming Language :: Python :: 3.8', 32 | 'Topic :: Software Development :: Libraries :: Python Modules', 33 | 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)', 34 | ], 35 | install_requires=[ 36 | 'Django>=1.11', 37 | 'six', 38 | ], 39 | packages=['jsonstore'], 40 | include_package_data=True, 41 | zip_safe=False 42 | ) 43 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/apps.py: -------------------------------------------------------------------------------- 1 | import os 2 | from django.apps import AppConfig 3 | 4 | 5 | class TestsConfig(AppConfig): 6 | name = 'tests' 7 | path = os.path.dirname(os.path.abspath(__file__)) 8 | 9 | -------------------------------------------------------------------------------- /tests/fields/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/fields/test_boolean_field.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | from django.db import models 3 | from django.test import TestCase 4 | 5 | 6 | class BooleanFieldModel(models.Model): 7 | data = jsonstore.JSONField() 8 | boolean_field = jsonstore.BooleanField(json_field_name='data') 9 | 10 | 11 | class Test(TestCase): 12 | def test_crud(self): 13 | model = BooleanFieldModel(boolean_field=False) 14 | self.assertIsInstance( 15 | model._meta.get_field('boolean_field'), 16 | models.BooleanField 17 | ) 18 | self.assertEqual(model.data, { 19 | 'boolean_field': False 20 | }) 21 | model.save() 22 | 23 | model = BooleanFieldModel.objects.get() 24 | self.assertEqual(model.data, { 25 | 'boolean_field': False 26 | }) 27 | self.assertEqual(model.boolean_field, False) 28 | -------------------------------------------------------------------------------- /tests/fields/test_char_field.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | from django.db import models 3 | from django.test import TestCase 4 | 5 | 6 | class CharFieldModel(models.Model): 7 | data = jsonstore.JSONField(default=dict) 8 | char_field = jsonstore.CharField(max_length=250, blank=True) 9 | required_char_field = jsonstore.CharField(max_length=250) 10 | 11 | 12 | class Test(TestCase): 13 | def test_crud(self): 14 | model = CharFieldModel(char_field='test') 15 | self.assertIsInstance( 16 | model._meta.get_field('char_field'), 17 | models.CharField 18 | ) 19 | self.assertEqual(model.data, { 20 | 'char_field': 'test', 21 | 'required_char_field': '', 22 | }) 23 | model.save() 24 | 25 | model = CharFieldModel.objects.get() 26 | self.assertEqual(model.data, { 27 | 'char_field': 'test', 28 | 'required_char_field': '', 29 | }) 30 | self.assertEqual(model.char_field, 'test') 31 | 32 | def test_null_value(self): 33 | model = CharFieldModel() 34 | self.assertEqual(model.char_field, None) 35 | self.assertEqual(model.data, {}) 36 | -------------------------------------------------------------------------------- /tests/fields/test_date_field.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | from datetime import date 3 | from django.db import models 4 | from django.test import TestCase 5 | 6 | 7 | class DateFieldModel(models.Model): 8 | data = jsonstore.JSONField() 9 | date_field = jsonstore.DateField(blank=True, null=False) 10 | 11 | 12 | class Test(TestCase): 13 | def test_crud(self): 14 | model = DateFieldModel(date_field=date(2020, 1, 31)) 15 | self.assertIsInstance( 16 | model._meta.get_field('date_field'), 17 | models.DateField 18 | ) 19 | self.assertEqual(model.data, { 20 | 'date_field': '2020-01-31' 21 | }) 22 | model.save() 23 | 24 | model = DateFieldModel.objects.get() 25 | self.assertEqual(model.data, { 26 | 'date_field': '2020-01-31' 27 | }) 28 | self.assertEqual(model.date_field, date(2020, 1, 31)) 29 | 30 | def test_null_value(self): 31 | model = DateFieldModel(date_field=None) 32 | self.assertEqual(model.date_field, None) 33 | self.assertEqual(model.data, {}) 34 | -------------------------------------------------------------------------------- /tests/fields/test_datetime_field.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | from django.db import models 3 | from django.test import TestCase 4 | from django.utils import timezone 5 | 6 | 7 | class DateTimeFieldModel(models.Model): 8 | data = jsonstore.JSONField() 9 | datetime_field = jsonstore.DateTimeField(blank=True, null=False) 10 | 11 | 12 | class Test(TestCase): 13 | def test_crud(self): 14 | model = DateTimeFieldModel(datetime_field=timezone.datetime(2020, 1, 31, 12, 59, 3)) 15 | self.assertIsInstance( 16 | model._meta.get_field('datetime_field'), 17 | models.DateTimeField 18 | ) 19 | self.assertEqual(model.data, { 20 | 'datetime_field': '2020-01-31T12:59:03+00:00' 21 | }) 22 | model.save() 23 | 24 | model = DateTimeFieldModel.objects.get() 25 | self.assertEqual(model.data, { 26 | 'datetime_field': '2020-01-31T12:59:03+00:00' 27 | }) 28 | self.assertEqual( 29 | model.datetime_field, 30 | timezone.make_aware(timezone.datetime(2020, 1, 31, 12, 59, 3))) 31 | 32 | def test_null_value(self): 33 | model = DateTimeFieldModel(datetime_field=None) 34 | self.assertEqual(model.datetime_field, None) 35 | self.assertEqual(model.data, {}) 36 | -------------------------------------------------------------------------------- /tests/fields/test_nullbooleanfield.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | from django.db import models 3 | from django.test import TestCase 4 | 5 | 6 | class NullBooleanFieldModel(models.Model): 7 | data = jsonstore.JSONField() 8 | nullboolean_field = jsonstore.NullBooleanField() 9 | 10 | 11 | class Test(TestCase): 12 | def test_crud(self): 13 | model = NullBooleanFieldModel(nullboolean_field=False) 14 | self.assertIsInstance( 15 | model._meta.get_field('nullboolean_field'), 16 | models.NullBooleanField 17 | ) 18 | self.assertEqual(model.data, { 19 | 'nullboolean_field': False 20 | }) 21 | model.save() 22 | 23 | model = NullBooleanFieldModel.objects.get() 24 | self.assertEqual(model.data, { 25 | 'nullboolean_field': False 26 | }) 27 | self.assertEqual(model.nullboolean_field, False) 28 | 29 | def test_null_value(self): 30 | model = NullBooleanFieldModel(nullboolean_field=None) 31 | self.assertEqual(model.nullboolean_field, None) 32 | self.assertEqual(model.data, { 33 | 'nullboolean_field': None 34 | }) 35 | -------------------------------------------------------------------------------- /tests/fields/test_time_field.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | 3 | from datetime import time 4 | from django.db import models 5 | from django.test import TestCase 6 | 7 | 8 | class TimeFieldModel(models.Model): 9 | data = jsonstore.JSONField() 10 | time_field = jsonstore.TimeField(blank=True, null=False) 11 | 12 | 13 | class Test(TestCase): 14 | def test_crud(self): 15 | model = TimeFieldModel(time_field=time(12, 59)) 16 | self.assertIsInstance( 17 | model._meta.get_field('time_field'), 18 | models.TimeField 19 | ) 20 | self.assertEqual(model.data, { 21 | 'time_field': '12:59:00+00:00' 22 | }) 23 | model.save() 24 | 25 | model = TimeFieldModel.objects.get() 26 | self.assertEqual(model.data, { 27 | 'time_field': '12:59:00+00:00' 28 | }) 29 | self.assertEqual(model.time_field, time(12, 59)) 30 | 31 | def test_null_value(self): 32 | model = TimeFieldModel(time_field=None) 33 | self.assertEqual(model.time_field, None) 34 | self.assertEqual(model.data, {}) 35 | -------------------------------------------------------------------------------- /tests/models.py: -------------------------------------------------------------------------------- 1 | import jsonstore 2 | from django.db import models 3 | 4 | 5 | class Order(models.Model): 6 | data = jsonstore.JSONField() 7 | 8 | 9 | class Person(models.Model): 10 | data = jsonstore.JSONField() 11 | name = jsonstore.CharField(max_length=250) 12 | address = jsonstore.CharField(max_length=250, blank=True) 13 | 14 | 15 | class Client(Person): 16 | birthdate = jsonstore.DateField() 17 | business_phone = jsonstore.CharField(max_length=250) 18 | 19 | 20 | class VIPClient(Client): 21 | approved = jsonstore.BooleanField() 22 | personal_phone = jsonstore.CharField(max_length=250) 23 | 24 | class Meta: 25 | proxy = True 26 | -------------------------------------------------------------------------------- /tests/settings.py: -------------------------------------------------------------------------------- 1 | import os 2 | import django 3 | import dj_database_url 4 | 5 | 6 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 7 | BASE_DIR = os.path.dirname(os.path.abspath(__file__)) 8 | 9 | 10 | # Quick-start development settings - unsuitable for production 11 | # See https://docs.djangoproject.com/en/dev/howto/deployment/checklist/ 12 | 13 | # SECURITY WARNING: keep the secret key used in production secret! 14 | SECRET_KEY = '1yj0rz&=bm8ihml!00o4nbi%eddugle)w9hi2*+tn^7*980wa8' 15 | 16 | # SECURITY WARNING: don't run with debug turned on in production! 17 | DEBUG = True 18 | 19 | ALLOWED_HOSTS = ['*'] 20 | 21 | 22 | # Application definition 23 | 24 | INSTALLED_APPS = [ 25 | 'tests.apps.TestsConfig', 26 | ] 27 | 28 | MIDDLEWARE = [ 29 | 'django.middleware.security.SecurityMiddleware', 30 | 'django.middleware.locale.LocaleMiddleware', 31 | 'django.middleware.common.CommonMiddleware', 32 | 'django.middleware.csrf.CsrfViewMiddleware', 33 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 34 | ] 35 | 36 | ROOT_URLCONF = 'tests.urls' 37 | 38 | TEMPLATES = [ 39 | { 40 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 41 | 'DIRS': [os.path.join(BASE_DIR, 'templates')], 42 | 'APP_DIRS': True, 43 | 'OPTIONS': { 44 | 'context_processors': [ 45 | 'django.template.context_processors.debug', 46 | 'django.template.context_processors.request', 47 | ], 48 | }, 49 | }, 50 | ] 51 | 52 | # WSGI_APPLICATION = 'tests.wsgi.application' 53 | 54 | # Auth 55 | 56 | AUTHENTICATION_BACKENDS = ( 57 | 'django.contrib.auth.backends.ModelBackend', 58 | 'guardian.backends.ObjectPermissionBackend' 59 | ) 60 | 61 | # Database 62 | # https://docs.djangoproject.com/en/dev/ref/settings/#databases 63 | 64 | DATABASES = { 65 | 'default': dj_database_url.config() or { 66 | 'ENGINE': 'django.db.backends.sqlite3', 67 | 'NAME': os.path.join(BASE_DIR, 'dj{}{}.sqlite3'.format(*django.VERSION[:2])), 68 | } 69 | } 70 | 71 | MIGRATION_MODULES = { 72 | 'admin': None, 73 | 'auth': None, 74 | 'contenttypes': None, 75 | 'sessions': None, 76 | 'messages': None, 77 | 'staticfiles': None, 78 | 'tests': None, 79 | } 80 | 81 | 82 | # Internationalization 83 | # https://docs.djangoproject.com/en/dev/topics/i18n/ 84 | 85 | LANGUAGE_CODE = 'en-us' 86 | 87 | TIME_ZONE = 'UTC' 88 | 89 | USE_I18N = True 90 | 91 | USE_L10N = True 92 | 93 | USE_TZ = True 94 | 95 | 96 | # Static files (CSS, JavaScript, Images) 97 | # https://docs.djangoproject.com/en/dev/howto/static-files/ 98 | 99 | STATIC_URL = '/static/' 100 | 101 | STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static')] 102 | 103 | MEDIA_ROOT = os.path.join(BASE_DIR, '..', '.media') 104 | 105 | MEDIA_URL = '/media/' 106 | 107 | # Logging 108 | # https://docs.djangoproject.com/en/2.0/topics/logging/ 109 | 110 | LOGGING = { 111 | 'version': 1, 112 | 'filters': { 113 | 'require_debug_true': { 114 | '()': 'django.utils.log.RequireDebugTrue', 115 | } 116 | }, 117 | 'handlers': { 118 | 'console': { 119 | 'level': 'DEBUG', 120 | 'class': 'logging.StreamHandler', 121 | } 122 | }, 123 | 'loggers': { 124 | 'django.db.backends': { 125 | 'level': 'DEBUG', 126 | 'handlers': ['console'], 127 | } 128 | } 129 | } 130 | 131 | # Fixtures 132 | # https://docs.djangoproject.com/en/2.0/howto/initial-data/ 133 | 134 | FIXTURE_DIRS = ( 135 | # os.path.join(BASE_DIR, 'fixtures'), 136 | ) 137 | -------------------------------------------------------------------------------- /tests/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | JSONField Schema Sample 7 | 8 | 9 | 10 |
11 | {% csrf_token %} 12 |
13 | A Person 14 | {{ form }} 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /tests/test_json_field.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | from .models import Order 3 | 4 | 5 | class Test(TestCase): 6 | def test_json_crud(self): 7 | Order.objects.create(data={'amount': 10}) 8 | self.assertEqual(Order.objects.first().data, {'amount': 10}) 9 | -------------------------------------------------------------------------------- /tests/test_model_api.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | from .models import Person 4 | 5 | 6 | class Test(TestCase): 7 | def test_person_crud(self): 8 | person = Person(name='John Doe') 9 | self.assertEqual(person.name, 'John Doe') 10 | self.assertEqual(person.data, {'name': 'John Doe'}) 11 | 12 | person.save() 13 | person.refresh_from_db() 14 | 15 | self.assertEqual(person.name, 'John Doe') 16 | self.assertEqual(person.data, {'name': 'John Doe'}) 17 | 18 | def test_values_list(self): 19 | Person.objects.create(name='john') 20 | query = Person.objects.values_list('name') 21 | self.assertEqual(list(query), [('john',)]) 22 | -------------------------------------------------------------------------------- /tests/test_model_form.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | from django.test import TestCase 3 | 4 | from .models import Person, Client, VIPClient 5 | 6 | 7 | class PersonForm(forms.ModelForm): 8 | class Meta: 9 | model = Person 10 | exclude = ['data'] 11 | 12 | 13 | class ClientForm(forms.ModelForm): 14 | class Meta: 15 | model = Client 16 | exclude = ['data'] 17 | 18 | 19 | class VIPClientForm(forms.ModelForm): 20 | class Meta: 21 | model = VIPClient 22 | exclude = ['data'] 23 | 24 | 25 | class Test(TestCase): 26 | def test_person_form(self): 27 | form = PersonForm() 28 | self.assertIn('name', form.fields) 29 | 30 | def test_client_form(self): 31 | form = ClientForm() 32 | self.assertIn('name', form.fields, "Inherited field 'name' not found") 33 | # self.assertIn('business_phone', form.fields, "Field 'business_phone' not found") 34 | 35 | def test_vipclient_form(self): 36 | form = VIPClientForm() 37 | self.assertIn('name', form.fields, 'Inherited field name not found') 38 | # self.assertIn('personal_phone', form.fields, "Field 'personal_phone' not found") 39 | -------------------------------------------------------------------------------- /tests/test_query_api.py: -------------------------------------------------------------------------------- 1 | from unittest import skipUnless 2 | from django.db import connection 3 | from django.test import TestCase 4 | from .models import Person 5 | 6 | 7 | @skipUnless( 8 | connection.vendor in ['postgresql', 'mysql', 'oracle'], 9 | "Databases with first-class JSONField support" 10 | ) 11 | class Test(TestCase): 12 | def setUp(self): 13 | Person.objects.create(name='John Doe') 14 | Person.objects.create(name='Will Smith') 15 | 16 | def test_iexact_query(self): 17 | person = Person.objects.get(name='John Doe') 18 | self.assertEqual(person.name, 'John Doe') 19 | 20 | def test_isnull_query(self): 21 | persons = Person.objects.filter(name__isnull=True) 22 | self.assertEqual(0, persons.count()) 23 | persons = Person.objects.filter(name__isnull=False) 24 | self.assertEqual(2, persons.count()) 25 | -------------------------------------------------------------------------------- /tests/urls.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | from django.views import generic 3 | 4 | try: 5 | from django.urls import url 6 | except ImportError: 7 | from django.conf.urls import url 8 | 9 | from . import models 10 | 11 | 12 | class PersonForm(forms.ModelForm): 13 | class Meta: 14 | model = models.VIPClient 15 | exclude = ['data'] 16 | 17 | 18 | urlpatterns = [ 19 | url('^$', generic.FormView.as_view( 20 | form_class=PersonForm, 21 | template_name='index.html', 22 | success_url='/')) 23 | ] 24 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = {py27}-dj{111} 3 | py{37,38}-dj{22,30,31} 4 | skipsdist = True 5 | 6 | [testenv] 7 | commands = {posargs:./manage.py test tests/} 8 | deps = 9 | dj111: Django==1.11.29 10 | dj22: Django==2.2.17 11 | dj30: Django==3.0.11 12 | dj31: Django==3.1.4 13 | django-annoying==0.10.5 14 | py27: django-mysql==2.5.0 15 | py37: django-mysql==3.2.0 16 | oracle-json-field==0.0.7 17 | six==1.12.0 18 | 19 | # development 20 | ipdb 21 | tblib 22 | django-polymodels==1.5.1 23 | dj-database-url 24 | django-extensions 25 | psycopg2-binary 26 | mysqlclient 27 | py27: cx_Oracle==7.3 28 | py37: cx-Oracle 29 | py38: cx-Oracle 30 | 31 | setenv = 32 | PYTHONPATH={toxinidir} 33 | PYTHONDONTWRITEBYTECODE=1 34 | 35 | passenv = 36 | DJANGO_SETTINGS_MODULE 37 | DATABASE_URL 38 | 39 | 40 | [testenv:integration] 41 | basepython=python3.7 42 | whitelist_externals=env 43 | commands = env DATABASE_URL=mysql://viewflow:viewflow@localhost/viewflow tox 44 | env DATABASE_URL=postgres://viewflow:viewflow@localhost/viewflow tox 45 | env DATABASE_URL=oracle://viewflow:viewflow@localhost/viewflow tox 46 | 47 | [flake8] 48 | max-line-length = 130 49 | --------------------------------------------------------------------------------