Merge pull request #597 from iKostanOrg/master

[ikostan]

Merge from master

Summary by Sourcery

Implement a solution for the "Pointless Farmer" kata.

New Features:

• Add the "Pointless Farmer" kata solution, which determines the buy/sell actions needed to launder a harvested fruit on the market and end up with the same fruit.

Tests:

• Add unit tests for the "Pointless Farmer" kata solution.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements a solution to the "Pointless Farmer" kata and adds it to the project. The solution involves determining a sequence of 'buy' or 'sell' actions based on given fruit pairs and the initially harvested fruit, ensuring the final fruit matches the initial one. If no valid sequence exists, it returns 'ERROR'. The implementation includes a core function buy_or_sell that iterates through the fruit pairs, making decisions and updating the currently held fruit. A helper function make_deal determines the action for each pair. Tests are included to verify the solution's correctness.

Sequence diagram for Pointless Farmer trading process

sequenceDiagram
    participant F as Farmer
    participant M as Market
    Note over F: Has harvested fruit
    loop For each trading pair
        F->>M: Check trading pair
        alt Can trade current fruit
            F->>M: Execute 'buy' or 'sell'
            M-->>F: Receive new fruit
        else Cannot trade
            M-->>F: Return ERROR
        end
    end
    Note over F: Verify final fruit matches initial

Loading

Class diagram for Pointless Farmer solution

classDiagram
    class Solution {
        +buy_or_sell(pairs: list, harvested_fruit: str) list|str
        +make_deal(results: list, pair: tuple, currently_holding: str) str
    }
    note for Solution "Main solution class for Pointless Farmer kata"

    class TradingPair {
        +fruit1: str
        +fruit2: str
    }

    Solution ..> TradingPair: uses

Loading

State diagram for fruit trading process

stateDiagram-v2
    [*] --> HarvestedFruit
    HarvestedFruit --> Trading: Start trading
    Trading --> Trading: Execute buy/sell
    Trading --> Success: Final fruit matches initial
    Trading --> Error: Cannot complete trades
    Success --> [*]
    Error --> [*]

Loading

File-Level Changes

Change	Details	Files
Implemented the solution for the Pointless Farmer kata and added corresponding tests.	Created the buy_or_sell function to determine the sequence of actions. Implemented the make_deal helper function to handle individual fruit pair transactions. Added comprehensive unit tests using the unittest and parameterized libraries. Included a README file explaining the kata and the solution. Updated project documentation to reflect the addition of the Pointless Farmer solution. Added the solution files to the project structure. Updated the main README file with information about the new kata and a link to its solution on GitHub.	kyu_7/pointless_farmer/solution.py kyu_7/pointless_farmer/test_buy_or_sell.py kyu_7/pointless_farmer/README.md kyu_7/pointless_farmer/__init__.py docs/kyu_7/kyu_7.pointless_farmer.module.rst docs/kyu_7/kyu_7.pointless_farmer.readme.rst docs/kyu_7/kyu_7.pointless_farmer.rst kyu_7/README.md docs/kyu_7/kyu_7.rst
Updated the formatting of the solution links in the README file.	Adjusted spacing and alignment of the solution links in the README file to improve readability. Standardized the format of the links to maintain consistency across the project documentation.	kyu_7/README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

We have skipped reviewing this pull request. Here's why:

• We don't review packaging changes - Let us know if you'd like us to change this.
• All of the files are larger than we can process. We're working on it!

[codeclimate]

Code Climate has analyzed commit c25cc6c and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 90.4% (0.0% change).

View more on Code Climate.

[ikostan]

@sourcery-ai review

[sourcery-ai]

Hey @ikostan - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}