Built on top of https://github.com/nix-gui/nix-gui/pull/172

Fixes https://github.com/nix-gui/nix-gui/issues/141

Changes:

• Remove all coloring except from "status circles". Coloring entire QListWidgetItems, QGroupBox's, and buttons doesn't work well with dark themes.
• Change yellow and green shade
• Use QStyledItemDelegate to create OptionListItemDelegate which handles rendering of both editable and uneditable navlist items. This delegate allows the placement of icons, status circles, text, and extra text.

This PR is related to #226 and is the output of the following command run in each subdirectory:

for f in *.org; do pandoc "$f" -s -o "${f%.org}.md"; done

I also git rm the org files.

fixes https://github.com/nix-gui/nix-gui/issues/18

Edit:

test_load_edit_save showed a major weakness in the API: StateModels aren't independent. That is if you edit a state and persist it, loading a new StateModel will result in retrieval of the pre-edit state. This is because get_option_data is wrapped with lru_cache.

Therefore to get the test working I stripped the lru_cache decorator. This results in redundant calculations of modules options, and the tests take over 600 seconds on my end. Therefore in this PR I will also:

• [x] resolve https://github.com/nix-gui/nix-gui/issues/49
• [x] write a cache decorator which checks if the contents of a file have changed, otherwise returns the cached result

Fixes #54

• [x] fix test case so it correctly fails if set module is used
• [x] minor improvements to code and tests
• [x] dependency injection inget_option_tree
• [x] import set module by changing lib.nix

Currently the evalModuleStub changes result in no position being returned.

Error for set modules before this change:

E               error: while evaluating 'get_modules_defined_attrs' at /build/k204x5pv8a4s0ach7h0g08wibc09gdgd-source/nixui/nix/lib.nix:48:31, called from (string):1:1:
E               while evaluating 'collectDeclarationPositions' at /build/k204x5pv8a4s0ach7h0g08wibc09gdgd-source/nixui/nix/lib.nix:12:42, called from /build/k204x5pv8a4s0ach7h0g08wibc09gdgd-source/nixui/nix/lib.nix:55:5:
E               while evaluating 'evalModuleStub' at /build/k204x5pv8a4s0ach7h0g08wibc09gdgd-source/nixui/nix/lib.nix:21:20, called from /build/k204x5pv8a4s0ach7h0g08wibc09gdgd-source/nixui/nix/lib.nix:53:36:
E               attempt to call something which is not a function but a set, at /build/k204x5pv8a4s0ach7h0g08wibc09gdgd-source/nixui/nix/lib.nix:21:33

Output before this change:

[{'loc': ['environment', 'etc'], 'position': {'column': 3, 'file': '/build/ffjx8jqw8fn6ijcqdd0nrqrcb5x73gja-source/nixui/tests/sample/configuration.nix', 'line': 104}}, {'loc': ['environment', 'systemPackages'], 'position': {'column': 3, 'file': '/build/ffjx8jqw8fn6ijcqdd0nrqrcb5x73gja-source/nixui/tests/sample/configuration.nix', 'line': 167}}...

Output after this change:

[{'loc': ['appstream', 'enable'], 'position': None}, {'loc': ['assertions'], 'position': None}

Need to look more into how https://github.com/NixOS/nixpkgs/blob/master/nixos/lib/eval-config.nix and https://github.com/NixOS/nixpkgs/blob/a3df3d05e5db17b26ff886f53a58761a547561cc/lib/modules.nix works to fix this issue and merge.

fixes https://github.com/nix-gui/nix-gui/issues/188

Important for review: Architecture documented

• rendered at https://github.com/nix-gui/nix-gui/blob/dev-docs/docs/development/architecture.org

Minor changes:

• development.org reorganized into multiple files,
• FieldsGroupBox refactored out of nav_interface.py

This documentation describes the state of Nix-Gui after the following issues are tackled:

• https://github.com/nix-gui/nix-gui/issues/173
• https://github.com/nix-gui/nix-gui/issues/216
• https://github.com/nix-gui/nix-gui/issues/218

Hi,

From patches to patches, it progresses =D

I tried again, and it failed again :

CONFIGURATION_PATH=/etc/nixos/configuration.nix nixFlakes run github:lapp0/nix-gui
warning: ignoring the user-specified setting 'experimental-features', because it is a restricted setting and you are not a trusted user
Traceback (most recent call last):
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/bin/.nix-gui-wrapped", line 9, in <module>
    sys.exit(main())
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/main.py", line 10, in main
    statemodel = state_model.StateModel()
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/state_model.py", line 26, in __init__
    self.current_values = api.get_option_values_map()
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/utils/copy_decorator.py", line 6, in fn
    return copy.copy(wrapped(*args, **kwargs))
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/options/api.py", line 75, in get_option_values_map
    for option, option_data in get_option_data().items()
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/utils/copy_decorator.py", line 6, in fn
    return copy.copy(wrapped(*args, **kwargs))
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/options/api.py", line 48, in get_option_data
    configured_values = {'.'.join(k): v for k, v in parser.get_all_option_values(os.environ['CONFIGURATION_PATH']).items()}
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/options/parser.py", line 10, in get_all_option_values
    for attr_loc, attr_data in nix_eval.get_modules_defined_attrs(module_path).items():
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/options/nix_eval.py", line 59, in get_modules_defined_attrs
    leaves = nix_instantiate_eval(leaves_expr_template.substitute(module_path=module_path), strict=True)
  File "/nix/store/1wb8vhks5nhai197qjy3jwv0s6k181gf-python3.8-nix-gui-0.1.0/lib/python3.8/site-packages/nixui/options/nix_eval.py", line 21, in nix_instantiate_eval
    res = subprocess.check_output(cmd, stderr=log_pipe)
  File "/nix/store/66fbv9mmx1j4hrn9y06kcp73c3yb196r-python3-3.8.9/lib/python3.8/subprocess.py", line 415, in check_output
    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
  File "/nix/store/66fbv9mmx1j4hrn9y06kcp73c3yb196r-python3-3.8.9/lib/python3.8/subprocess.py", line 516, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['nix-instantiate', '--eval', '-E', '\nlet\n  config = import /etc/nixos/configuration.nix {config = {}; pkgs = import <nixpkgs> {}; lib = import <nixpkgs/lib>;};\n  closure = builtins.tail (builtins.genericClosure {\n    startSet = [{ key = builtins.toJSON []; value = {value = config;}; }];\n    operator = {key, value}: builtins.filter (x: x != null) (\n      if\n        builtins.isAttrs value.value\n      then\n        builtins.map (new_key:\n          let\n            pos = (builtins.unsafeGetAttrPos new_key value.value);\n          in\n            if\n              builtins.isNull pos || (pos.file != builtins.toString "/etc/nixos/configuration.nix")\n            then null\n            else {\n              key = builtins.toJSON ((builtins.fromJSON key) ++ [new_key]);\n              value = {\n                value = builtins.getAttr new_key value.value;\n                inherit pos;\n              };\n            }\n        ) (builtins.attrNames value.value)\n      else []\n    );\n  });\n  leaves = builtins.filter (x: !(builtins.isAttrs x.value.value)) closure;\nin\nbuiltins.map (x: {name = builtins.fromJSON x.key; position = x.value.pos;}) leaves\n    ', '--json', '--strict']' returned non-zero exit status 1.

I copied the executed script in the command line and got this error

nix-shell script.nix
error: attempt to call something which is not a function but a set, at /tmp/script.nix:2:12
(use '--show-trace' to show detailed location information)

before the patch, text was not visible with qt dark theme

i tried to fix the richtext class, but ... waste of time, no success simple solution: render navlist as plain text

Navlist colors are set based on whether the option or a descendant is changed either in configuration or in memory. This is operation more expensive than it should be.

Hi,

Is this app mobile friendly?

I think it would be nice to consider usage on the pinephone/mobile optimization for future developments.

I would definitely prefer to use NixOS on the pinephone "without coding".

Some inspiration:

https://github.com/JasonG-FR/PineBattery

https://mobile.nixos.org/

fixes #72

fixes #57

• [X] implement undo via Updates
• [X] ~~parser.persist_updates: iterate over Updates and apply their changes~~
  • [X] Possible better alternative: update configuration files by calculating changes to OptionTree
• [x] ensure DiffWidget works with the changes
• [x] update architecture.org to reflect how Updates and persisting now work in Nix-Gui
• [X] handle all TODOs
• (referenced / created separate issues below)
• [x] ~~update version to nix-gui to 0.2.0, as this fixes the last remaining issue in milestone 1~~ (moved to https://github.com/nix-gui/nix-gui/issues/240)

New issues to address shortcomings of this PR

During creation of this PR, new (non-urgent) requirements for Nix-Gui have been discovered / created, but are out of scope for this already-oversized PR.

• https://github.com/nix-gui/nix-gui/issues/243
• https://github.com/nix-gui/nix-gui/issues/244
• https://github.com/nix-gui/nix-gui/issues/245
• https://github.com/nix-gui/nix-gui/issues/246
• https://github.com/nix-gui/nix-gui/issues/247
• https://github.com/nix-gui/nix-gui/issues/75

Immediate follow up PR

Code injection is messy and doesn't work properly at all for lists.

• https://github.com/nix-gui/nix-gui/pull/248

After enabling flakes, when this happens:

[demo@nixos:~]$ nix run github:nix-gui/nix-gui
INFO:Retrieving option values for module "/etc/nixos/configuration.nix"
ERROR:[Errno 2] No such file or directory: '/etc/nixos/<nixpkgs/nixos/modules/installer/virtualbox-demo.nix>'

I guess this is because of the config piece that imports that in /etc/nixos/configuration.nix:

# ... snip ...
imports = [ <nixpkgs/nixos/modules/installer/virtualbox-demo.nix> ];
# ... snip ...

When I try to run it again, no error is displayed but it's also all blank:

I ran nix --experimental-features 'nix-command flakes' run github:nix-gui/nix-gui and I get attribute 'defaultApp.x86_64-linux' should have type 'derivation' I am running fedora silverblue 37 and used this guide to install nix.

cd nix-gui
nix develop
cd nixui
p=/nix/store/ip17r412b9by9nwb0ri0avrzhvv49ajc-source
export NIX_PATH=$p:nixpkgs=$p:nixos-config=$(readlink -f tests/sample/configuration.nix)

# workaround for https://github.com/nix-gui/nix-gui/issues/275
sed -i '/echo ${toString config.services.nix-serve.port}/d' tests/sample/configuration.nix

pytest -svv tests/test_api.py::test_get_option_tree

)
>               raise NixEvalError(err_str)
E               nixui.options.nix_eval.NixEvalError: NixEvalError("""
E               error: attribute 'cycle' missing
E               
E                      at /nix/store/ip17r412b9by9nwb0ri0avrzhvv49ajc-source/nixos/modules/tasks/filesystems.nix:259:119:
E               
E                         258|       { assertion = ! (fileSystems' ? cycle);
E                         259|         message = "The ‘fileSystems’ option can't be topologically sorted: mountpoint dependency path ${ls " -> " fileSystems'.cycle} loops to ${ls ", " fileSystems'.loops}";
E                            |                                                                                                                       ^
E                         260|       }

https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/tasks/filesystems.nix#L277

  ###### implementation

  config = {

    assertions = let
      ls = sep: concatMapStringsSep sep (x: x.mountPoint);
      notAutoResizable = fs: fs.autoResize && !(hasPrefix "ext" fs.fsType || fs.fsType == "f2fs");
    in [
      { assertion = ! (fileSystems' ? cycle);
        message = "The ‘fileSystems’ option can't be topologically sorted: mountpoint dependency path ${ls " -> " fileSystems'.cycle} loops to ${ls ", " fileSystems'.loops}";
      }
      { assertion = ! (any notAutoResizable fileSystems);
        message = let
          fs = head (filter notAutoResizable fileSystems);
        in
          "Mountpoint '${fs.mountPoint}': 'autoResize = true' is not supported for 'fsType = \"${fs.fsType}\"':${if fs.fsType == "auto" then " fsType has to be explicitly set and" else ""} only the ext filesystems and f2fs support it.";
      }
    ];

cd nix-gui
nix develop
cd nixui
p=/nix/store/ip17r412b9by9nwb0ri0avrzhvv49ajc-source
export NIX_PATH=$p:nixpkgs=$p:nixos-config=$(readlink -f tests/sample/configuration.nix)
pytest -svv tests/test_api.py::test_get_option_tree

E               nixui.options.nix_eval.NixEvalError: NixEvalError("""
E               error: attribute 'services' missing
E               
E                      at /tmp/nix-gui/nixui/tests/sample/configuration.nix:95:25:
E               
E                          94|         # test getting config
E                          95|         echo ${toString config.services.nix-serve.port}
E                            |                         ^
E                          96|       '';