Add Islamic Prayer Times config flow by engrbm87 · Pull Request #31590 · home-assistant/core

engrbm87 · 2020-02-07T12:01:29Z

Breaking change

Islamic Prayer Times is now its own integration and supports config flow. Please update your configuration by the following the documentation.
All sensors will display the prayer times as per the selected calculation method. Changing the calculation method will update all sensors with new prayer times.

Proposed change

Configure the Islamic Prayer Times integration through UI and update the calculation method using the options menu.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml
islamic_prayer_times:
  calculation_method: makkah

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: #12435

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

…m87/home-assistant into islamic-prayer-config-flow

…into islamic-prayer-config-flow

bdraco

There is a conflict that needs to be resolved

…into islamic-prayer-config-flow

engrbm87 · 2020-03-17T14:41:20Z

There is a conflict that needs to be resolved

Resolved

bdraco · 2020-03-17T22:06:53Z

If you are feeling ambitious the test coverage has decreased slightly with the change

Before

# pytest --cov=homeassistant/components/islamic_prayer_times/ -- tests/components/islamic_prayer_times/

Test session starts (platform: linux, Python 3.8.1, pytest 5.3.5, pytest-sugar 0.9.2)
rootdir: /root/home-assistant, inifile: setup.cfg
plugins: requests-mock-1.7.0, aiohttp-0.3.0, cov-2.8.1, sugar-0.9.2, timeout-1.3.3
collecting ... 
 tests/components/islamic_prayer_times/test_sensor.py ✓✓✓✓✓                                                                                                                                                                   100% ██████████

----------- coverage: platform linux, python 3.8.1-final-0 -----------
Name                                                        Stmts   Miss  Cover
-------------------------------------------------------------------------------
homeassistant/components/islamic_prayer_times/__init__.py       0      0   100%
homeassistant/components/islamic_prayer_times/sensor.py        99      5    95%
-------------------------------------------------------------------------------
TOTAL                                                          99      5    95%

After

# pytest --cov=homeassistant/components/islamic_prayer_times/ -- tests/components/islamic_prayer_times/
Test session starts (platform: linux, Python 3.8.1, pytest 5.3.5, pytest-sugar 0.9.2)
rootdir: /root/home-assistant, inifile: setup.cfg
plugins: requests-mock-1.7.0, aiohttp-0.3.0, cov-2.8.1, sugar-0.9.2, timeout-1.3.3
collecting ... 
 tests/components/islamic_prayer_times/test_config_flow.py ✓✓✓✓                                                                                                                                                                33% ███▍      
 tests/components/islamic_prayer_times/test_init.py ✓✓✓✓✓✓✓                                                                                                                                                                    92% █████████▎
 tests/components/islamic_prayer_times/test_sensor.py ✓                                                                                                                                                                       100% ██████████

----------- coverage: platform linux, python 3.8.1-final-0 -----------
Name                                                           Stmts   Miss  Cover
----------------------------------------------------------------------------------
homeassistant/components/islamic_prayer_times/__init__.py         83      7    92%
homeassistant/components/islamic_prayer_times/config_flow.py      30      0   100%
homeassistant/components/islamic_prayer_times/const.py             9      0   100%
homeassistant/components/islamic_prayer_times/sensor.py           57      3    95%
----------------------------------------------------------------------------------
TOTAL                                                            179     10    94%


Results (6.04s):
      12 passed

bdraco · 2020-03-17T22:07:13Z

Testing passed

bdraco · 2020-03-18T14:08:54Z

@engrbm87 looks like this just needs docs and should be good to go

engrbm87 · 2020-04-01T06:37:21Z

Is it possible to rerun the test. I am not sure what the problem is.

bdraco · 2020-04-01T14:13:59Z

@engrbm87 You'll need to rebase and then push for the CI to run again to see what the Mypy error is as the build has expired

https://developers.home-assistant.io/docs/development_catching_up/

…into islamic-prayer-config-flow

engrbm87 · 2020-04-10T08:54:58Z

I believe this is ready to be merged

MartinHjelmare · 2020-04-10T11:17:21Z

There's a merge conflict.

…into islamic-prayer-config-flow

…m87/home-assistant into islamic-prayer-config-flow

engrbm87 · 2020-04-13T11:07:57Z

Hello @MartinHjelmare , I have tried to clean up the code based on your comments and I think it is more efficient now.
I also want to highlight that these sensors should show the time as state which is the most import information for the "prayer". I included the timestamp as an attribute in case a user was using it in automation or template.

MartinHjelmare · 2020-04-15T10:21:52Z

Two outstanding comments. Otherwise looks good. All CI tests need to be run properly though before we can merge.

MartinHjelmare

Great!

…into islamic-prayer-config-flow

MartinHjelmare · 2020-04-20T08:07:09Z

Do we need the title for the options flow?

engrbm87 · 2020-04-20T08:11:39Z

Do we need the title for the options flow?

I got this error "* [TRANSLATIONS] Invalid strings.json: extra keys not allowed @ data['options']['title']". That is why i removed it

MartinHjelmare · 2020-04-20T08:41:03Z

Ok, good.

engrbm87 added 4 commits November 13, 2019 11:05

Add Islamic Prayer Times config_flow

b41c566

Add Islamic Prayer Times config_flow

211b60a

Merge branch 'islamic-prayer-config-flow' of https://github.com/engrb…

a98ee58

…m87/home-assistant into islamic-prayer-config-flow

handle options update and fix tests

4fd2cea

homeassistant added the cla-signed label Feb 7, 2020

probot-home-assistant Bot added has-tests integration: islamic_prayer_times labels Feb 7, 2020

fix sensor update handling

87460d0

engrbm87 requested a review from fabaff February 7, 2020 12:18

springstan changed the title ~~Islamic Prayer Times config flow~~ Add Islamic Prayer Times config flow Feb 7, 2020

frenck added the docs-missing label Feb 10, 2020

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

8336df4

…into islamic-prayer-config-flow

This comment has been minimized.

Sign in to view

springstan reviewed Feb 12, 2020

View reviewed changes

Comment thread homeassistant/components/islamic_prayer_times/config_flow.py

engrbm87 added 2 commits February 13, 2020 09:59

fix pylint

0e544e5

fix scheduled update and add test

d412176

bdraco reviewed Mar 16, 2020

View reviewed changes

Comment thread homeassistant/components/islamic_prayer_times/__init__.py

bdraco requested changes Mar 16, 2020

View reviewed changes

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

8f9d01b

…into islamic-prayer-config-flow

bdraco reviewed Mar 17, 2020

View reviewed changes

Comment thread tests/components/islamic_prayer_times/test_init.py Outdated

update test_init

2a61a7d

engrbm87 mentioned this pull request Mar 19, 2020

Update islamic_prayer_times.markdown home-assistant/home-assistant.io#12435

Merged

7 tasks

update flow options to show drop list

d5e6dfb

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

da7f34c

…into islamic-prayer-config-flow

Merge branch 'dev' into islamic-prayer-config-flow

33e757e

MartinHjelmare requested changes Apr 10, 2020

View reviewed changes

engrbm87 added 3 commits April 10, 2020 16:03

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

25547a3

…into islamic-prayer-config-flow

clean up code

ee453f6

Merge branch 'islamic-prayer-config-flow' of https://github.com/engrb…

3c75168

…m87/home-assistant into islamic-prayer-config-flow

MartinHjelmare reviewed Apr 13, 2020

View reviewed changes

MartinHjelmare added the breaking-change label Apr 13, 2020

MartinHjelmare reviewed Apr 13, 2020

View reviewed changes

Comment thread homeassistant/components/islamic_prayer_times/__init__.py Outdated

async scheduling and revert state to timestamp

92ca24c

MartinHjelmare reviewed Apr 15, 2020

View reviewed changes

Comment thread homeassistant/components/islamic_prayer_times/__init__.py Outdated

MartinHjelmare removed the docs-missing label Apr 15, 2020

fix update retry method

d2b9782

MartinHjelmare approved these changes Apr 19, 2020

View reviewed changes

MartinHjelmare requested changes Apr 19, 2020

View reviewed changes

Comment thread homeassistant/components/islamic_prayer_times/strings.json Outdated

MartinHjelmare self-assigned this Apr 19, 2020

engrbm87 added 3 commits April 20, 2020 09:21

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

a1c57a9

…into islamic-prayer-config-flow

update strings

d8d3df0

keep title as root key

f3dc053

MartinHjelmare approved these changes Apr 20, 2020

View reviewed changes

MartinHjelmare merged commit 2a6948e into home-assistant:dev Apr 20, 2020

lock Bot locked and limited conversation to collaborators Apr 25, 2020

Uh oh!

Conversation

engrbm87 commented Feb 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

bdraco left a comment

Choose a reason for hiding this comment

Uh oh!

engrbm87 commented Mar 17, 2020

Uh oh!

Uh oh!

bdraco commented Mar 17, 2020

Uh oh!

bdraco commented Mar 17, 2020

Uh oh!

bdraco commented Mar 18, 2020

Uh oh!

engrbm87 commented Apr 1, 2020

Uh oh!

bdraco commented Apr 1, 2020

Uh oh!

engrbm87 commented Apr 10, 2020

Uh oh!

MartinHjelmare commented Apr 10, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

engrbm87 commented Apr 13, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare commented Apr 15, 2020

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MartinHjelmare commented Apr 20, 2020

Uh oh!

engrbm87 commented Apr 20, 2020

Uh oh!

MartinHjelmare commented Apr 20, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

engrbm87 commented Feb 7, 2020 •

edited

Loading

Example entry for `configuration.yaml`: