Pyjoyment 0.1.0__py3-none-any.whl

Pyjoyment/Command/Author/generate/plugin.py

@@ -0,0 +1,267 @@
+"""
+Pyjoyment.Command.Author.generate.plugin - Plugin generator command
+===================================================================
+::
+
+    Usage: APPLICATION generate plugin [OPTIONS] [NAME]
+
+      pyjo generate plugin
+      pyjo generate plugin AliceSearch
+      pyjo generate plugin -f MyApp.Ext.Test
+
+    Options:
+      -f, --full   Do not prepend "Pyjoyment.Plugin."
+      -h, --help   Show this summary of available options
+
+:mod:`Pyjoyment.Command.Author.generate.plugin` generates directory structures
+for fully functional :mod:`Pyjoyment` plugins: a distribution with
+``pyproject.toml``, which builds with hatchling, and a test, which
+``uv run python -m Pyjo.Prove -l -r t`` runs, as does ``uv run pytest``,
+with pytest of the dependency group ``dev``. The module of a plugin is in the
+namespace ``Pyjoyment.Plugin``, which the distribution adds to without the
+``__init__.py`` files of the namespace. ``AGENTS.md``, which ``CLAUDE.md``
+imports, tells a coding agent how the plugin is made, tested and built, and
+where the skills of Pyjoyment are.
+
+This is a core command, that means it is always enabled and its code a good
+example for learning to build new commands, you're welcome to fork it.
+
+See :mod:`Pyjoyment.Commands` for a list of commands that are available by
+default.
+
+See also
+--------
+
+:mod:`Pyjoyment`, https://mojolicious.org.
+
+Ported from `Mojolicious::Command::Author::generate::plugin
+<https://github.com/mojolicious/mojo/blob/v9.49/lib/Mojolicious/Command/Author/generate/plugin.pm>`_ of
+Mojolicious 9.49.
+
+Classes
+-------
+"""
+
+import Pyjo.Exception
+import Pyjoyment.Command
+
+from Pyjo.Util import class_to_path, extract_usage, getopt
+from Pyjoyment.Command.Author.generate.pyproject import _requirement  # pyright: ignore[reportPrivateUsage]
+
+
+class Pyjoyment_Command_Author_generate_plugin(Pyjoyment.Command.object):
+    """
+    :mod:`Pyjoyment.Command.Author.generate.plugin` inherits all attributes and
+    methods from :mod:`Pyjoyment.Command` and implements the following new
+    ones.
+    """
+
+    description = 'Generate Pyjoyment plugin directory structure'
+    """::
+
+        description = plugin.description
+        plugin.description = 'Foo'
+
+    Short description of this command, used for the command list.
+    """
+
+    usage = extract_usage()
+    """::
+
+        usage = plugin.usage
+        plugin.usage = 'Foo'
+
+    Usage information for this command, used for the help screen.
+    """
+
+    def run(self, *args: str) -> None:
+        """::
+
+            plugin.run(*sys.argv[1:])
+
+        Run this command.
+        """
+        arguments = list(args)
+        if not (opts := getopt(arguments, {'f|full': None})):
+            raise Pyjo.Exception.new(self.usage)
+
+        # Class
+        name = arguments[0] if arguments else 'MyPlugin'
+        class_ = name if opts.full else f'Pyjoyment.Plugin.{name}'
+        dir = '-'.join(class_.split('.'))
+        app = class_to_path(class_)
+        title = f'{class_} - Pyjoyment Plugin'
+        self.render_to_rel_file(
+            'class',
+            f'{dir}/{app}',
+            {
+                'alias': class_.rsplit('.', 1)[-1],
+                'class_': class_,
+                'identifier': class_.replace('.', '_'),
+                'name': name,
+                'title': title,
+            },
+        )
+
+        # Test
+        # Renamed from Mojolicious: t/basic.py, where Mojo has t/basic.t
+        self.render_to_rel_file('test', f'{dir}/t/basic.py', {'name': name})
+
+        # Makefile
+        # Renamed from Mojolicious: pyproject.toml, where Mojo has Makefile.PL
+        self.render_to_rel_file(
+            'pyproject', f'{dir}/pyproject.toml', {'dir': dir, 'path': app, 'requirement': _requirement()}
+        )
+
+        # Not in Mojolicious: the guide of the coding agents, AGENTS.md, which CLAUDE.md imports for Claude Code
+        self.render_to_rel_file('agents', f'{dir}/AGENTS.md', {'class_': class_, 'dir': dir, 'name': name, 'path': app})
+        self.render_to_rel_file('claude', f'{dir}/CLAUDE.md')
+
+
+new = Pyjoyment_Command_Author_generate_plugin.new
+object = Pyjoyment_Command_Author_generate_plugin
+
+__DATA__ = r'''
+@@ class
+"""
+<%= title %>
+<%= '=' * len(title) %>
+::
+
+    # Pyjoyment
+    app.plugin('<%= name %>')
+
+    # Pyjoyment.Lite
+    plugin('<%= name %>')
+
+:mod:`<%= class_ %>` is a :mod:`Pyjoyment` plugin.
+
+See also
+--------
+
+:mod:`Pyjoyment`, https://mojolicious.org.
+
+Classes
+-------
+"""
+
+import Pyjoyment.Plugin
+
+
+__version__ = '0.1.0'
+
+
+class <%= identifier %>(Pyjoyment.Plugin.object):
+    """
+    :mod:`<%= class_ %>` inherits all methods from
+    :mod:`Pyjoyment.Plugin` and implements the following new ones.
+    """
+
+    def register(self, app, conf):
+        """::
+
+            plugin.register(Pyjoyment.new(), {})
+
+        Register plugin in :mod:`Pyjoyment` application.
+        """
+
+
+object = <%= identifier %>
+% if alias != identifier:
+<%= alias %> = <%= identifier %>
+% end
+
+@@ test
+from Pyjo.Test import *
+from Pyjoyment.Lite import *
+
+import Pyjo.Test.Pyjo
+
+
+plugin('<%= name %>')
+
+
+@get('/')
+def index(c):
+    c.render(text='Hello Pyjo!')
+
+
+t = Pyjo.Test.Pyjo.new()
+t.get_ok('/').status_is(200).content_is('Hello Pyjo!')
+
+done_testing()
+
+@@ pyproject
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "<%= dir %>"
+dynamic = ["version"]
+authors = [{ name = "A Good Programmer", email = "nospam@example.com" }]
+requires-python = ">=3.12"
+dependencies = ["<%= requirement %>"]
+
+[tool.hatch.version]
+path = "<%= path %>"
+
+[tool.hatch.build.targets.wheel]
+only-include = ["<%= path %>"]
+
+[dependency-groups]
+dev = ["pytest>=9", "pytest-xdist>=3"]
+
+[tool.pytest.ini_options]
+testpaths = ["t"]
+pythonpath = ["."]
+
+@@ agents
+# <%= dir %>
+
+A plugin of [Pyjoyment](https://pyjoyment.readthedocs.io/), the port of
+Mojolicious to Python, made with `pyjo generate plugin`, a distribution of its
+own. This file says how it is made, tested and built, for whoever changes it,
+a coding agent too.
+
+## Layout
+
+- `<%= path %>`: the plugin `<%= class_ %>`, whose `register` adds its
+  helpers, hooks and routes to an application, as `plugin('<%= name %>')`.
+- `t/basic.py`: its test, with an application of `Pyjoyment.Lite`.
+- `pyproject.toml`: the distribution, whose wheel has only the module, as the
+  packages of the namespace are the ones of Pyjoyment.
+
+## Commands
+
+```sh
+uv run python -m Pyjo.Prove -l -r t      # the tests
+uv run pytest                            # the tests with pytest
+uv build                                 # the wheel and the sdist in dist/
+```
+
+## Conventions
+
+- The directories of the namespace have no `__init__.py`, which would
+  replace the packages of Pyjoyment.
+- `register` runs once, at the start of the application, and what the
+  requests share is made there; nothing in a helper or a hook blocks the
+  event loop, as `time.sleep` or `requests`.
+- A change comes with a test in `t/`, where `Pyjo.Test.Pyjo` requests an
+  application without a server.
+
+## Skills
+
+The plugin of Claude Code for Pyjoyment has skills of its idioms, of plugins
+and distributions, of the tests and of the templates:
+
+```sh
+claude plugin install pyjoyment --marketplace dex4er/Pyjoyment
+```
+
+Other agents read their files, the `SKILL.md` of each skill, in
+https://github.com/dex4er/Pyjoyment/tree/main/plugins/pyjoyment/skills.
+
+@@ claude
+@AGENTS.md
+'''

Pyjoyment/Command/Author/generate/pyproject.py

@@ -0,0 +1,123 @@
+"""
+Pyjoyment.Command.Author.generate.pyproject - pyproject.toml generator command
+==============================================================================
+::
+
+    Usage: APPLICATION generate pyproject [OPTIONS]
+
+      ./myapp.py generate pyproject
+      pyjo generate pyproject
+
+    Options:
+      -h, --help   Show this summary of available options
+
+:mod:`Pyjoyment.Command.Author.generate.pyproject` generates
+``pyproject.toml`` files for applications, with their dependencies and no
+build system, as ``uv init --app`` does, so that ``uv sync`` installs the
+dependencies without the application. The name of the project is the one of
+the current directory, and where it has a directory ``t``, the dependency
+group ``dev`` has pytest and pytest-xdist, which ``uv sync`` installs and
+``generate dockerfile`` leaves out, ``testpaths`` of pytest names ``t`` and
+``pythonpath`` the current directory, so that ``uv run pytest`` runs its test
+scripts with :mod:`Pyjo.Test.pytest_plugin`, and its tests find the
+application.
+
+This is a core command, that means it is always enabled and its code a good
+example for learning to build new commands, you're welcome to fork it.
+
+See :mod:`Pyjoyment.Commands` for a list of commands that are available by
+default.
+
+See also
+--------
+
+:mod:`Pyjoyment`, https://mojolicious.org.
+
+Ported from `Mojolicious::Command::Author::generate::makefile
+<https://github.com/mojolicious/mojo/blob/v9.49/lib/Mojolicious/Command/Author/generate/makefile.pm>`_ of
+Mojolicious 9.49.
+
+Classes
+-------
+"""
+
+# Renamed from Mojolicious: generate pyproject, where Mojo has generate makefile, as the dependencies of a project of
+# Python are in pyproject.toml, which uv reads
+
+import Pyjo.File
+import Pyjoyment.Command
+
+from Pyjo.Util import extract_usage
+from Pyjoyment.Command.version import _version  # pyright: ignore[reportPrivateUsage]
+
+import os
+import re
+
+
+class Pyjoyment_Command_Author_generate_pyproject(Pyjoyment.Command.object):
+    """
+    :mod:`Pyjoyment.Command.Author.generate.pyproject` inherits all attributes
+    and methods from :mod:`Pyjoyment.Command` and implements the following new
+    ones.
+    """
+
+    description = 'Generate "pyproject.toml"'
+    """::
+
+        description = pyproject.description
+        pyproject.description = 'Foo'
+
+    Short description of this command, used for the command list.
+    """
+
+    usage = extract_usage()
+    """::
+
+        usage = pyproject.usage
+        pyproject.usage = 'Foo'
+
+    Usage information for this command, used for the help screen.
+    """
+
+    def run(self, *args: str) -> None:
+        """::
+
+            pyproject.run(*sys.argv[1:])
+
+        Run this command.
+        """
+        # Not in Mojolicious: the name of the project, which Makefile.PL of Mojo leaves out
+        name = re.sub(r'[^A-Za-z0-9._-]+', '-', Pyjo.File.path().to_abs().basename()).strip('-._') or 'myapp'
+        # Not in Mojolicious: testpaths of pytest for the test scripts in t
+        tests = os.path.isdir('t')
+        self.render_to_rel_file(
+            'pyproject', 'pyproject.toml', {'name': name, 'requirement': _requirement(), 'tests': tests}
+        )
+
+
+# Not in Mojolicious: the requirement of the dependency on Pyjoyment, with the version that generates the files
+def _requirement() -> str:
+    version = _version()
+    return 'Pyjoyment' if version == 'n/a' else f'Pyjoyment>={version}'
+
+
+new = Pyjoyment_Command_Author_generate_pyproject.new
+object = Pyjoyment_Command_Author_generate_pyproject
+
+__DATA__ = r"""
+@@ pyproject
+[project]
+name = "<%= name %>"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = ["<%= requirement %>"]
+% if tests:
+
+[dependency-groups]
+dev = ["pytest>=9", "pytest-xdist>=3"]
+
+[tool.pytest.ini_options]
+testpaths = ["t"]
+pythonpath = ["."]
+% end
+"""

Pyjoyment/Command/Author/inflate.py

@@ -0,0 +1,101 @@
+"""
+Pyjoyment.Command.Author.inflate - Inflate command
+==================================================
+::
+
+    Usage: APPLICATION inflate [OPTIONS]
+
+      ./myapp.py inflate
+
+    Options:
+      -h, --help                Show this summary of available options
+          --home <path>         Path to home directory of your application,
+                                defaults to the value of PYJO_HOME or
+                                auto-detection
+          --log-format <name>   Format of log messages, "text" or "json",
+                                defaults to the value of PYJO_LOG_FORMAT or
+                                "text"
+      -m, --mode <name>         Operating mode for your application, defaults to
+                                the value of PYJO_MODE or "development"
+
+:mod:`Pyjoyment.Command.Author.inflate` turns templates and static files
+embedded in the ``DATA`` sections of your application into real files.
+
+This is a core command, that means it is always enabled and its code a good
+example for learning to build new commands, you're welcome to fork it.
+
+See :mod:`Pyjoyment.Commands` for a list of commands that are available by
+default.
+
+See also
+--------
+
+:mod:`Pyjoyment`, https://mojolicious.org.
+
+Ported from `Mojolicious::Command::Author::inflate
+<https://github.com/mojolicious/mojo/blob/v9.49/lib/Mojolicious/Command/Author/inflate.pm>`_ of Mojolicious 9.49.
+
+Classes
+-------
+"""
+
+import Pyjoyment.Command
+
+from Pyjo.Loader import data_section, file_is_binary
+from Pyjo.Util import encode, extract_usage
+
+import re
+
+from typing import Any
+
+
+class Pyjoyment_Command_Author_inflate(Pyjoyment.Command.object):
+    """
+    :mod:`Pyjoyment.Command.Author.inflate` inherits all attributes and methods
+    from :mod:`Pyjoyment.Command` and implements the following new ones.
+    """
+
+    description = 'Inflate embedded files to real files'
+    """::
+
+        description = inflate.description
+        inflate.description = 'Foo'
+
+    Short description of this command, used for the command list.
+    """
+
+    usage = extract_usage()
+    """::
+
+        usage = inflate.usage
+        inflate.usage = 'Foo'
+
+    Usage information for this command, used for the help screen.
+    """
+
+    def run(self, *args: str) -> None:
+        """::
+
+            inflate.run(*sys.argv[1:])
+
+        Run this command.
+        """
+        # Find all embedded files
+        all: dict[str, bytes] = {}
+        app: Any = self.app
+        for cls in [*app.renderer.classes, *app.static.classes]:
+            files: Any = data_section(cls) or {}
+            for name in files:
+                data = data_section(cls, name)
+                if not file_is_binary(cls, name):
+                    data = encode('UTF-8', str(data))
+                all[name] = data if isinstance(data, bytes) else b''
+
+        # Turn them into real files
+        for name in (name for name in all if re.search(r'\.\w+$', name)):
+            prefix = 'templates' if re.search(r'\.\w+\.\w+$', name) else 'public'
+            self.write_file(self.rel_file(f'{prefix}/{name}'), all[name])
+
+
+new = Pyjoyment_Command_Author_inflate.new
+object = Pyjoyment_Command_Author_inflate