Merge pull request #120 from ikostan/main

Merge from master

Author: ikostan

darts/.exercism/config.json

@@ -0,0 +1,29 @@
+{
+  "authors": [
+    "GascaK"
+  ],
+  "contributors": [
+    "alexpjohnson",
+    "AnAccountForReportingBugs",
+    "BethanyG",
+    "cmccandless",
+    "Dog",
+    "Grociu",
+    "tqa236",
+    "xitanggg",
+    "yawpitch"
+  ],
+  "files": {
+    "solution": [
+      "darts.py"
+    ],
+    "test": [
+      "darts_test.py"
+    ],
+    "example": [
+      ".meta/example.py"
+    ]
+  },
+  "blurb": "Calculate the points scored in a single toss of a Darts game.",
+  "source": "Inspired by an exercise created by a professor Della Paolera in Argentina"
+}

darts/.exercism/metadata.json

@@ -0,0 +1 @@
+{"track":"python","exercise":"darts","id":"d4b5c772cdca44b58cdc7ff76ffe7b00","url":"https://exercism.org/tracks/python/exercises/darts","handle":"myFirstCode","is_requester":true,"auto_approve":false}

darts/HELP.md

@@ -0,0 +1,130 @@
+# Help
+
+## Running the tests
+
+We use [pytest][pytest: Getting Started Guide] as our website test runner.
+You will need to install `pytest` on your development machine if you want to run tests for the Python track locally.
+You should also install the following `pytest` plugins:
+
+- [pytest-cache][pytest-cache]
+- [pytest-subtests][pytest-subtests]
+
+Extended information can be found in our website [Python testing guide][Python track tests page].
+
+
+### Running Tests
+
+To run the included tests, navigate to the folder where the exercise is stored using `cd` in your terminal (_replace `{exercise-folder-location}` below with your path_).
+Test files usually end in `_test.py`, and are the same tests that run on the website when a solution is uploaded.
+
+Linux/MacOS
+```bash
+$ cd {path/to/exercise-folder-location}
+```
+
+Windows
+```powershell
+PS C:\Users\foobar> cd {path\to\exercise-folder-location}
+```
+
+<br>
+
+Next, run the `pytest` command in your terminal, replacing `{exercise_test.py}` with the name of the test file:
+
+Linux/MacOS
+```bash
+$ python3 -m pytest -o markers=task {exercise_test.py}
+==================== 7 passed in 0.08s ====================
+```
+
+Windows
+```powershell
+PS C:\Users\foobar> py -m pytest -o markers=task {exercise_test.py}
+==================== 7 passed in 0.08s ====================
+```
+
+
+### Common options
+- `-o` : override default `pytest.ini` (_you can use this to avoid marker warnings_)
+- `-v` : enable verbose output.
+- `-x` : stop running tests on first failure.
+- `--ff` : run failures from previous test before running other test cases.
+
+For additional options, use `python3 -m pytest -h` or `py -m pytest -h`.
+
+
+### Fixing warnings
+
+If you do not use `pytest -o markers=task` when invoking `pytest`, you might receive a `PytestUnknownMarkWarning` for tests that use our new syntax:
+
+```bash
+PytestUnknownMarkWarning: Unknown pytest.mark.task - is this a typo?  You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/mark.html
+```
+
+To avoid typing `pytest -o markers=task` for every test you run, you can use a `pytest.ini` configuration file.
+We have made one that can be downloaded from the top level of the Python track directory: [pytest.ini][pytest.ini].
+
+You can also create your own `pytest.ini` file with the following content:
+
+```ini
+[pytest]
+markers =
+    task: A concept exercise task.
+```
+
+Placing the `pytest.ini` file in the _root_ or _working_ directory for your Python track exercises will register the marks and stop the warnings.
+More information on pytest marks can be found in the `pytest` documentation on [marking test functions][pytest: marking test functions with attributes] and the `pytest` documentation on [working with custom markers][pytest: working with custom markers].
+
+Information on customizing pytest configurations can be found in the `pytest` documentation on [configuration file formats][pytest: configuration file formats].
+
+
+### Extending your IDE or Code Editor
+
+Many IDEs and code editors have built-in support for using `pytest` and other code quality tools.
+Some community-sourced options can be found on our [Python track tools page][Python track tools page].
+
+[Pytest: Getting Started Guide]: https://docs.pytest.org/en/latest/getting-started.html
+[Python track tools page]: https://exercism.org/docs/tracks/python/tools
+[Python track tests page]: https://exercism.org/docs/tracks/python/tests
+[pytest-cache]:http://pythonhosted.org/pytest-cache/
+[pytest-subtests]:https://github.com/pytest-dev/pytest-subtests
+[pytest.ini]: https://github.com/exercism/python/blob/main/pytest.ini
+[pytest: configuration file formats]: https://docs.pytest.org/en/6.2.x/customize.html#configuration-file-formats
+[pytest: marking test functions with attributes]: https://docs.pytest.org/en/6.2.x/mark.html#raising-errors-on-unknown-marks
+[pytest: working with custom markers]: https://docs.pytest.org/en/6.2.x/example/markers.html#working-with-custom-markers
+
+## Submitting your solution
+
+You can submit your solution using the `exercism submit darts.py` command.
+This command will upload your solution to the Exercism website and print the solution page's URL.
+
+It's possible to submit an incomplete solution which allows you to:
+
+- See how others have completed the exercise
+- Request help from a mentor
+
+## Need to get help?
+
+If you'd like help solving the exercise, check the following pages:
+
+- The [Python track's documentation](https://exercism.org/docs/tracks/python)
+- The [Python track's programming category on the forum](https://forum.exercism.org/c/programming/python)
+- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
+- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
+
+Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
+
+Below are some resources for getting help if you run into trouble:
+
+- [The PSF](https://www.python.org) hosts Python downloads, documentation, and community resources.
+- [The Exercism Community on Discord](https://exercism.org/r/discord)
+- [Python Community on Discord](https://pythondiscord.com/) is a very helpful and active community.
+- [/r/learnpython/](https://www.reddit.com/r/learnpython/) is a subreddit designed for Python learners.
+- [#python on Libera.chat](https://www.python.org/community/irc/) this is where the core developers for the language hang out and get work done.
+- [Python Community Forums](https://discuss.python.org/)
+- [Free Code Camp Community Forums](https://forum.freecodecamp.org/)
+- [CodeNewbie Community Help Tag](https://community.codenewbie.org/t/help)
+- [Pythontutor](http://pythontutor.com/) for stepping through small code snippets visually.
+
+Additionally, [StackOverflow](http://stackoverflow.com/questions/tagged/python) is a good spot to search for your problem/question to see if it has been answered already.
+ If not - you can always [ask](https://stackoverflow.com/help/how-to-ask) or [answer](https://stackoverflow.com/help/how-to-answer) someone else's question.

darts/HINTS.md

@@ -0,0 +1,20 @@
+# Hints
+
+## General
+
+-  This challenge is all about calculating if a point falls _on, in, or outside_ a given circle.
+-  There are two different ways of calculating if a point falls on, in, or outside a circle.
+   - This _Stack Overflow_ Post: [Equation for Testing if a Point is Inside a Circle][point-circle-equation] outlines one method.
+   - This _DoubleRoot_ post [Position of a point relative to a circle][point-to-circle] outlines a different one.
+   - This _Math is Fun_ post covers a more general [Distance Between 2 Points][distance-between-two-points] calculation.
+- Because the dart board is a set of _concentric_ circles, the order in which you calculate points could change the answer significantly.
+  You should pay attention to which direction your calculations "move" in.
+-  Remember that this exercise has many potential solutions and many paths you can take along the way.
+   No path is manifestly "better" than another, although a particular path may be more interesting or better suited to what you want to learn or explore right now.
+-  Some paths may trade speed for clarity.
+   Others might take up more memory but be more scalable or maintainable.
+-  We encourage you to try out more than one programming strategy to see what happens.
+
+[point-circle-equation]: https://stackoverflow.com/questions/481144/equation-for-testing-if-a-point-is-inside-a-circle
+[point-to-circle]: https://doubleroot.in/lessons/circle/position-of-a-point/
+[distance-between-two-points]: https://www.mathsisfun.com/algebra/distance-2-points.html

darts/README.md

@@ -0,0 +1,59 @@
+# Darts
+
+Welcome to Darts on Exercism's Python Track.
+If you need help running the tests or submitting your code, check out `HELP.md`.
+If you get stuck on the exercise, check out `HINTS.md`, but try and solve it without using those first :)
+
+## Instructions
+
+Calculate the points scored in a single toss of a Darts game.
+
+[Darts][darts] is a game where players throw darts at a [target][darts-target].
+
+In our particular instance of the game, the target rewards 4 different amounts of points, depending on where the dart lands:
+
+![Our dart scoreboard with values from a complete miss to a bullseye](https://assets.exercism.org/images/exercises/darts/darts-scoreboard.svg)
+
+- If the dart lands outside the target, player earns no points (0 points).
+- If the dart lands in the outer circle of the target, player earns 1 point.
+- If the dart lands in the middle circle of the target, player earns 5 points.
+- If the dart lands in the inner circle of the target, player earns 10 points.
+
+The outer circle has a radius of 10 units (this is equivalent to the total radius for the entire target), the middle circle a radius of 5 units, and the inner circle a radius of 1.
+Of course, they are all centered at the same point — that is, the circles are [concentric][] defined by the coordinates (0, 0).
+
+Given a point in the target (defined by its [Cartesian coordinates][cartesian-coordinates] `x` and `y`, where `x` and `y` are [real][real-numbers]), calculate the correct score earned by a dart landing at that point.
+
+## Credit
+
+The scoreboard image was created by [habere-et-dispertire][habere-et-dispertire] using [Inkscape][inkscape].
+
+[darts]: https://en.wikipedia.org/wiki/Darts
+[darts-target]: https://en.wikipedia.org/wiki/Darts#/media/File:Darts_in_a_dartboard.jpg
+[concentric]: https://mathworld.wolfram.com/ConcentricCircles.html
+[cartesian-coordinates]: https://www.mathsisfun.com/data/cartesian-coordinates.html
+[real-numbers]: https://www.mathsisfun.com/numbers/real-numbers.html
+[habere-et-dispertire]: https://exercism.org/profiles/habere-et-dispertire
+[inkscape]: https://en.wikipedia.org/wiki/Inkscape
+
+## Source
+
+### Created by
+
+- @GascaK
+
+### Contributed to by
+
+- @alexpjohnson
+- @AnAccountForReportingBugs
+- @BethanyG
+- @cmccandless
+- @Dog
+- @Grociu
+- @tqa236
+- @xitanggg
+- @yawpitch
+
+### Based on
+
+Inspired by an exercise created by a professor Della Paolera in Argentina

darts/darts.py

@@ -0,0 +1,19 @@
+"""Darts is a game where players throw darts at a target."""
+
+
+def score(x: int, y: int) -> int:
+    """
+    Calculate the points scored in a single toss of a Darts game.
+
+    Given the x and y coordinates where a dart lands, returns the score
+    based on the distance from the center (0, 0):
+    - Inner circle (distance <= 1): 10 points
+    - Middle circle (distance <= 5): 5 points
+    - Outer circle (distance <= 10): 1 point
+    - Outside target (distance > 10): 0 points
+
+    :param x: The x-coordinate where the dart landed
+    :param y: The y-coordinate where the dart landed
+    :return: The points scored (0, 1, 5, or 10)
+    """
+    pass

darts/darts_test.py

@@ -0,0 +1,52 @@
+# pylint: disable=C0301
+
+# These tests are auto-generated with test data from:
+# https://github.com/exercism/problem-specifications/tree/main/exercises/darts/canonical-data.json
+# File last updated on 2023-07-19
+
+import unittest
+
+from darts import (
+    score,
+)
+
+
+class DartsTest(unittest.TestCase):
+    def test_missed_target(self):
+        self.assertEqual(score(-9, 9), 0)
+
+    def test_on_the_outer_circle(self):
+        self.assertEqual(score(0, 10), 1)
+
+    def test_on_the_middle_circle(self):
+        self.assertEqual(score(-5, 0), 5)
+
+    def test_on_the_inner_circle(self):
+        self.assertEqual(score(0, -1), 10)
+
+    def test_exactly_on_center(self):
+        self.assertEqual(score(0, 0), 10)
+
+    def test_near_the_center(self):
+        self.assertEqual(score(-0.1, -0.1), 10)
+
+    def test_just_within_the_inner_circle(self):
+        self.assertEqual(score(0.7, 0.7), 10)
+
+    def test_just_outside_the_inner_circle(self):
+        self.assertEqual(score(0.8, -0.8), 5)
+
+    def test_just_within_the_middle_circle(self):
+        self.assertEqual(score(-3.5, 3.5), 5)
+
+    def test_just_outside_the_middle_circle(self):
+        self.assertEqual(score(-3.6, -3.6), 1)
+
+    def test_just_within_the_outer_circle(self):
+        self.assertEqual(score(-7.0, 7.0), 1)
+
+    def test_just_outside_the_outer_circle(self):
+        self.assertEqual(score(7.1, -7.1), 0)
+
+    def test_asymmetric_position_between_the_inner_and_middle_circles(self):
+        self.assertEqual(score(0.5, -4), 5)