Skip to content

Commit

Permalink
Technical/Update gem dependencies (#104)
Browse files Browse the repository at this point in the history
* Updated Truemail::RegexConstant::REGEX_EMAIL_PATTERN
* Updated gem development dependencies
* Updated linter config
* Updated gem version, changelog, documentation
  • Loading branch information
bestwebua authored Nov 14, 2020
1 parent 5b8c111 commit eb118bd
Show file tree
Hide file tree
Showing 16 changed files with 237 additions and 51 deletions.
2 changes: 1 addition & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ checks:
plugins:
rubocop:
enabled: true
channel: rubocop-0-93
channel: rubocop-1-3

reek:
enabled: true
36 changes: 36 additions & 0 deletions .github/BRANCH_NAMING_CONVENTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Branch naming convention

## Branch naming

> Please note for new pull requests create new branches from current `develop` branch only.
Branch name should include type of your contribution and context. Please follow next pattern for naming your branches:

```bash
feature/add-some-feature
technical/some-technical-improvements
bugfix/fix-some-bug-name
```

## Before PR actions

### Squash commits

Please squash all branch commits into the one before openning your PR from your fork. It's simple to do with the git:

```bash
git rebase -i [hash your first commit of your branch]~1
git rebase -i 6467fe36232401fa740af067cfd8ac9ec932fed2~1 # example
```

### Add commit description

Please complete your commit description folowing next pattern:

```
Technical/Add info files # should be the same name as your branch name
* Added license, changelog, contributing, code of conduct docs
* Added GitHub templates
* Updated project license link
```
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve
title: [BUG]
labels: bug
assignees: bestwebua

---

<!-- Thanks for helping to make Truemail better! Before submit your bug, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->

### New bug checklist

- [ ] I have updated `truemail` to the latest version
- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)

### Bug description
<!-- Please include what's happening, expected behavior, and any relevant code samples -->

##### Complete output when running truemail, including the stack trace and command used

<details>
<pre>[INSERT OUTPUT HERE]</pre>
</details>
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for Truemail
title: [FEATURE]
labels: enhancement
assignees: bestwebua

---

<!-- Thanks for helping to make Truemail better! Before submit your new feature request, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->

### New feature request checklist

- [ ] I have updated `truemail` to the latest version
- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)

### Feature description

<!-- Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Describe the solution you'd like. A clear and concise description of what you want to happen.
Describe alternatives you've considered. A clear and concise description of any alternative solutions or features you've considered. -->
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
---
name: Issue report
about: Create a report to help us improve
title: [ISSUE]
labels: ''
assignees: bestwebua

---

<!-- Thanks for helping to make Truemail better! Before submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->

### New Issue Checklist
### New issue checklist

- [ ] I have updated truemail to the latest version
- [ ] I have updated `truemail` to the latest version
- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)

### Issue Description
### Issue description
<!-- Please include what's happening, expected behavior, and any relevant code samples -->

##### Complete output when running truemail, including the stack trace and command used
Expand Down
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Question
about: Ask your question to Truemail team
title: [QUESTION]
labels: question
assignees: bestwebua

---

<!-- Thanks for helping to make Truemail better! Before submit your question, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->

### New question checklist

- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail/blob/master/CONTRIBUTING.md)
- [ ] I have read the [documentation](https://truemail-rb.org/truemail-gem)
- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail/issues)

### Question

<!-- Your question context here -->
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# PR Details

<!-- Provide a general summary of your changes in the Title above -->
<!-- PR name should the same name as your branch name, example: -->
<!-- Branch name is: feature/add-some-feature -->
<!-- PR name should be: Feature/Add some feature -->

## Description

Expand Down
42 changes: 42 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,24 @@ Style/SoleNestedConditional:
Style/ClassEqualityComparison:
Enabled: true

Style/ArgumentsForwarding:
Enabled: true

Style/CollectionCompact:
Enabled: true

Style/DocumentDynamicEvalDefinition:
Enabled: true

Style/NegatedIfElseCondition:
Enabled: true

Style/NilLambda:
Enabled: true

Style/SwapValues:
Enabled: true

Layout/LineLength:
Max: 140

Expand Down Expand Up @@ -221,6 +239,27 @@ Lint/HashCompareByIdentity:
Lint/RedundantSafeNavigation:
Enabled: true

Lint/DuplicateBranch:
Enabled: true

Lint/DuplicateRegexpCharacterClassElement:
Enabled: true

Lint/EmptyBlock:
Enabled: true

Lint/EmptyClass:
Enabled: true

Lint/NoReturnInBeginEndBlocks:
Enabled: false

Lint/ToEnumArguments:
Enabled: true

Lint/UnmodifiedReduceAccumulator:
Enabled: true

Performance/AncestorsInclude:
Enabled: true

Expand Down Expand Up @@ -274,3 +313,6 @@ RSpec/MultipleDescribes:

RSpec/MultipleMemoizedHelpers:
Enabled: false

RSpec/StubbedMock:
Enabled: false
18 changes: 15 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,30 @@

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.2] - 2020.11.14

### Fixed

Timeouts time units in `Setting global configuration` of Truemail documentation's section. Thanks to [@wikiti](https://github.com/wikiti) for report.

### Changed

- Refactored `Truemail::RegexConstant::REGEX_EMAIL_PATTERN`
- Updated gem development dependencies
- Updated gem documentation

## [2.0.1] - 2020.10.20

### Changed

- gem development dependencies
- gem documentation
- Updated gem development dependencies
- Updated gem documentation

## [2.0.0] - 2020.10.19

### Fixed

SMTP connection errors: invalid `HELO` hostname (`localhost`), duplicate `HELO` (`verifier domain`).
SMTP connection errors: invalid `HELO` hostname (`localhost`), duplicate `HELO` (`verifier domain`). Thanks to [@nenoganchev](https://github.com/nenoganchev) for report.

### Changed

Expand Down
29 changes: 15 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@ Following these guidelines helps to communicate that you respect the time of the

## Using the issue tracker

The issue tracker is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests).
The issue tracker is the preferred channel for [issue/bug reports](#issuebug-reports), [feature requests](#feature-requests), [questions](#questions) and submitting [pull requests](#pull-requests).

<a name="bugs"></a>
## Bug/issue reports
## Issue/bug reports

A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:
Guidelines for issue/bug reports:

1. **Use the GitHub issue search** &mdash; check if the issue has already been reported
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository
3. Truemail [issue template](.github/ISSUE_TEMPLATE.md)
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or `develop` branch in the repository
3. Truemail [issue template](.github/ISSUE_TEMPLATE/issue_report.md)/[bug template](.github/ISSUE_TEMPLATE/bug_report.md)

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

<a name="features"></a>
## Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

<a name="pull-requests"></a>
## Questions

We're always open to a new conversations. So if you have any questions just ask us.

## Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Expand All @@ -39,7 +39,8 @@ Please adhere to the coding conventions used throughout a project (indentation,
Guidelines for pull requests:

1. Truemail [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
2. Fork the repo
3. Run the tests. This is to make sure your starting point works. Tests can be run via ```rspec```
4. Create a new branch and make your changes. This includes tests for features!
5. Push to your fork and submit a pull request
2. Fork the repo, checkout to `develop` branch
3. Run the tests. This is to make sure your starting point works
4. Read our [branch naming convention](.github/BRANCH_NAMING_CONVENTION.md)
5. Create a new branch and make your changes. This includes tests for features!
6. Push to your fork and submit a pull request to `develop` branch
43 changes: 22 additions & 21 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
truemail (2.0.1)
truemail (2.0.2)
simpleidn (~> 0.1.1)

GEM
Expand Down Expand Up @@ -31,7 +31,7 @@ GEM
overcommit (0.57.0)
childprocess (>= 0.6.3, < 5)
iniparse (~> 1.4)
parallel (1.19.2)
parallel (1.20.0)
parser (2.7.2.0)
ast (~> 2.4.1)
pry (0.13.1)
Expand All @@ -50,35 +50,36 @@ GEM
rainbow (>= 2.0, < 4.0)
regexp_parser (1.8.2)
rexml (3.2.4)
rspec (3.9.0)
rspec-core (~> 3.9.0)
rspec-expectations (~> 3.9.0)
rspec-mocks (~> 3.9.0)
rspec-core (3.9.3)
rspec-support (~> 3.9.3)
rspec-expectations (3.9.2)
rspec (3.10.0)
rspec-core (~> 3.10.0)
rspec-expectations (~> 3.10.0)
rspec-mocks (~> 3.10.0)
rspec-core (3.10.0)
rspec-support (~> 3.10.0)
rspec-expectations (3.10.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.9.0)
rspec-mocks (3.9.1)
rspec-support (~> 3.10.0)
rspec-mocks (3.10.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.9.0)
rspec-support (3.9.3)
rubocop (0.93.1)
rspec-support (~> 3.10.0)
rspec-support (3.10.0)
rubocop (1.3.0)
parallel (~> 1.10)
parser (>= 2.7.1.5)
rainbow (>= 2.2.2, < 4.0)
regexp_parser (>= 1.8)
rexml
rubocop-ast (>= 0.6.0)
rubocop-ast (>= 1.1.1)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 1.4.0, < 2.0)
rubocop-ast (0.8.0)
rubocop-ast (1.1.1)
parser (>= 2.7.1.5)
rubocop-performance (1.8.1)
rubocop (>= 0.87.0)
rubocop-ast (>= 0.4.0)
rubocop-rspec (1.43.2)
rubocop (~> 0.87)
rubocop-rspec (2.0.0)
rubocop (~> 1.0)
rubocop-ast (>= 1.1.0)
ruby-progressbar (1.10.1)
ruby_parser (3.15.0)
sexp_processor (~> 4.9)
Expand Down Expand Up @@ -112,10 +113,10 @@ DEPENDENCIES
pry-byebug (~> 3.9)
rake (~> 13.0, >= 13.0.1)
reek (~> 6.0, >= 6.0.2)
rspec (~> 3.9)
rubocop (~> 0.93.1)
rspec (~> 3.10)
rubocop (~> 1.3)
rubocop-performance (~> 1.8, >= 1.8.1)
rubocop-rspec (~> 1.43, >= 1.43.2)
rubocop-rspec (~> 2.0)
simplecov (~> 0.17.1)
truemail!
truemail-rspec (~> 0.2.1)
Expand Down
Loading

0 comments on commit eb118bd

Please sign in to comment.