diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..2873e9d --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,30 @@ +# BUILDING + +The code source follows the pattern of a common gem. You can find it inside the lib folder. + +This project is prepared to use Docker! Install the docker and (if you want) the docker-compose extension to easily build it! + +```bash +docker-compose build +``` + +## Open a console with the gem installed + +```bash +docker-compose run gem bash +``` + +## Check up the code quality with RuboCop + +```bash +docker-compose run gem bundle exec rubocop -A +``` + +## Run the unit tests with RSpec + +```bash +docker-compose run gem bundle exec rspec --profile +``` + +Please, if you want to edit/contribuct to the project, take a time to read +our [LICENSE.txt](LICENSE.txt) file. diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..1f435cd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## v1.0.0-20220102 - Danilo Carolino (@danilogco) + +* Initial release diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6ea732f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +danilogcarolino@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +. Translations are available at +. diff --git a/COMMITTING.md b/COMMITTING.md new file mode 100644 index 0000000..711834e --- /dev/null +++ b/COMMITTING.md @@ -0,0 +1,213 @@ +# Conventinal Commit Messages + +See how a minor change to your commit message style can make a difference. [Examples](#examples) + +**Have a look at CLI util [git-conventional-commits](https://github.com/qoomon/git-conventional-commits) to ensure this conventions and generate changelogs** + + + +## Commit Formats + +### Default + +
+<type>(<optional scope>): <subject>
+empty separator line
+<optional body>
+empty separator line
+<optional footer>
+
+ +### Merge + +
+Merge branch '<branch name>'
+
+Follows default git merge message + +### Revert + +
+Revert "<commit headline>"
+empty separator line
+This reverts commit <commit hash>.
+<optinal reason>
+
+Follows default git revert message + +### Types + +API relevant changes + +* `feat` Commits, that adds a new feature +* `fix` Commits, that fixes a bug +* `refactor` Commits, that rewrite/restructure your code, however does not change any behaviour +* `perf` Commits are special `refactor` commits, that improves performance +* `style` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc) +* `test` Commits, that add missing tests or correcting existing tests +* `docs` Commits, that affect documentation only +* `build` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ... +* `ops` Commits, that affect operational components like infrastructure, deployment, backup, recovery, ... +* `chore` Miscellaneous commits e.g. modifying `.gitignore` + +### Scopes + +The `scope` provides additional contextual information. + +* Is an **optional** part of the format +* Allowed Scopes depends on the specific project +* Don't use issue identifiers as scopes + +### Subject + +The `subject` contains a succinct description of the change. + +* Is a **mandatory** part of the format +* Use the imperative, present tense: "change" not "changed" nor "changes" +* Don't capitalize the first letter +* No dot (.) at the end + +### Body + +The `body` should include the motivation for the change and contrast this with previous behavior. + +* Is an **optional** part of the format +* Use the imperative, present tense: "change" not "changed" nor "changes" +* This is the place to mention issue identifiers and their relations + +### Footer + +The `footer` should contain any information about **Breaking Changes** and is also the place to **reference Issues** that this commit refers to. + +* Is an **optional** part of the format +* **optionally** reference an issue by its id. +* **Breaking Changes** should start with the word `BREAKING CHANGES:` followed by space or two newlines. The rest of the commit message is then used for this. + +### Examples + +```git +feat(shopping cart): add the amazing button +``` + +```git +feat: remove ticket list endpoint + +refers to JIRA-1337 +BREAKING CHANGES: ticket enpoints no longer supports list all entites. +``` + +```git +fix: add missing parameter to service call + +The error occurred because of . +``` + +```git +build(release): bump version to 1.0.0 +``` + +```git +build: update dependencies +``` + +```git +refactor: implement calculation method as recursion +``` + +```git +style: remove empty line +``` + +```git +revert: refactor: implement calculation method as recursion + +This reverts commit 221d3ec6ffeead67cee8c730c4a15cf8dc84897a. +``` + +## Git Hook Scripts to ensure commit message header format + +### commit-msg Hook (local) + +* create following file in your local repository folder`.git-hooks/commit-msg` + +```shell +#!/usr/bin/env sh + +commit_message="$1" +# exit with a non zero exit code incase of an invalid commit message + +# use git-conventional-commits, see https://github.com/qoomon/git-conventional-commits +git-conventional-commits commit-msg-hook "$commit_message" + +# or verify $commit_message with your own tooling +# ... +``` + +* ⚠ make `.git-hooks/commit-msg` executable (unix: `chmod +x '.git-hooks/commit-msg'`) +* set git hook directory to `.githooks` `git config core.hooksPath '.git-hooks'` +* commit `.git-hooks` directory if you want to share them with your team, they only need to call the git config command once after cloning the repository + +### pre-receive Hook (server side) + +* create following file in your repository folder `.git/hooks/pre-receive` + +```shell +#!/usr/bin/env sh + +# Pre-receive hook that will block commits with messges that do not follow regex rule + +commit_msg_type_regex='feat|fix|refactor|style|test|docs|build' +commit_msg_scope_regex='.{1,20}' +commit_msg_subject_regex='.{1,100}' +commit_msg_regex="^(${commit_msg_type_regex})(\(${commit_msg_scope_regex}\))?: (${commit_msg_subject_regex})\$" +merge_msg_regex="^Merge branch '.+'\$" +revert_msg_regex="^Revert \".+\"\$" + +zero_commit="0000000000000000000000000000000000000000" + +# Do not traverse over commits that are already in the repository +excludeExisting="--not --all" + +error="" +while read oldrev newrev refname; do + # branch or tag get deleted + if [ "$newrev" = "$zero_commit" ]; then + continue + fi + + # Check for new branch or tag + if [ "$oldrev" = "$zero_commit" ]; then + rev_span=`git rev-list $newrev $excludeExisting` + else + rev_span=`git rev-list $oldrev..$newrev $excludeExisting` + fi + + for commit in $rev_span; do + commit_msg_header=$(git show -s --format=%s $commit) + if ! [[ "$commit_msg_header" =~ (${commit_msg_regex})|(${merge_msg_regex})|(${revert_msg_regex}) ]]; then + echo "$commit" >&2 + echo "ERROR: Invalid commit message format" >&2 + echo "$commit_msg_header" >&2 + error="true" + fi + done +done + +if [ -n "$error" ]; then + exit 1 +fi +``` + +* ⚠ make `.git/hooks/pre-receive` executable (unix: `chmod +x '.git/hooks/pre-receive'`) + +----- + +## References + +* +* +* +
+ +* +* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..634b925 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing + +- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet; +- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it; +- Fork the project; +- Start a feature/bugfix branch; +- Commit and push until you are happy with your contribution; +- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.; +- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it. diff --git a/Gemfile.lock b/Gemfile.lock index 0704949..1e45395 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - geo-regions (0.1.0) + geo-regions (1.0.0) ruby-enum (~> 0.9) rubyzip (~> 2.3) zip (~> 2.0) @@ -40,20 +40,20 @@ GEM diff-lcs (>= 1.2.0, < 2.0) rspec-support (~> 3.10.0) rspec-support (3.10.3) - rubocop (1.24.0) + rubocop (1.24.1) parallel (~> 1.10) parser (>= 3.0.0.0) rainbow (>= 2.2.2, < 4.0) regexp_parser (>= 1.8, < 3.0) rexml - rubocop-ast (>= 1.15.0, < 2.0) + rubocop-ast (>= 1.15.1, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 1.4.0, < 3.0) rubocop-ast (1.15.1) parser (>= 3.0.1.1) rubocop-packaging (0.5.1) rubocop (>= 0.89, < 2.0) - rubocop-performance (1.13.0) + rubocop-performance (1.13.1) rubocop (>= 1.7.0, < 2.0) rubocop-ast (>= 0.4.0) rubocop-rspec (2.7.0) @@ -87,4 +87,4 @@ DEPENDENCIES simplecov (~> 0.21) BUNDLED WITH - 2.3.3 + 2.3.4 diff --git a/HOW_TO_USE.md b/HOW_TO_USE.md new file mode 100644 index 0000000..1c8673e --- /dev/null +++ b/HOW_TO_USE.md @@ -0,0 +1,93 @@ +# HOW TO USE THE GEM + +* Add to your project: + +```ruby +gem "geo-regions" +``` + +By default, the gem uses the default locale of the i18n library. You can set a custom locale setting a custom configuration: + +```ruby +GR.configure do |config| + # The current locales available are ***de, en, es, fr, ja, pt ru and zh***. + config.locale = :en +end +``` + +You're welcome to help us to improve the database and the translations as much you want! + +* Retrieve a list of cities: + +```ruby +GR::City.all +``` + +* Retrieve a list of cities by state code and/or country code and/or similar name: + +```ruby +GR:City.find(state: "SP", country: "BR", name: "io Cl") + +# expected response +=> +[, + @is_in_european_union=0, + @name="Brazil">, + @name="Sao Paulo">, + @time_zone="America/Sao_Paulo">] +``` + +* Retrieve a list of countries: + +```ruby +GR::Country.all +``` + +* Retrieve a list of countries by the name: + +```ruby +GR:Country.find(name: "Braz") + +# expected response +=> +[, + @is_in_european_union="0", + @name="Brazil">] +``` + +* Retrieve a list of states: + +```ruby +GR::State.all +``` + +* Retrieve a list of countries by the country tag and/or the name: + +```ruby +GR::State.find(country: "BR", name: "Sao") + +# expected response +[, + @is_in_european_union=0, + @name="Brazil">, + @name="\"\"Sao Paulo\"\"">] +``` diff --git a/PUBLISHING.md b/PUBLISHING.md new file mode 100644 index 0000000..8b01ee0 --- /dev/null +++ b/PUBLISHING.md @@ -0,0 +1,9 @@ +# Publishing + +After the Github and Rubygems authenticatication, push with the following command: + +```sh +gem push --key github --host https://rubygems.pkg.github.com/dcotecnologia geo-regions-1.0.0.gem +``` + +Don't forget to generate the release. diff --git a/README.md b/README.md index 2b4d52e..944961c 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,96 @@ A very simple ruby gem to get a list of states in a country. Also, you can get a list of cities in a state, and a list of all countries of the world. -## Add to your project +## Links + +* How to Use It - [HOW_TO_USE.md](HOW_TO_USE.md). +* Code of Conduct - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). +* Contributing to the project - [CONTRIBUTING.md](CONTRIBUTING.md). +* Commit patterns - [COMITTING.md](COMITTING.md). +* Publishing the application - [PUBLISHING.md](PUBLISHING.md). +* Versioning releases - [VERSIONING.md](VERSIONING.md). +* Building the project - [BUILDING.md](BUILDING.md). +* Changelog - [CHANGELOG.md](CHANGELOG.md). + +## How to use it? + +* Add to your project: ```ruby gem "geo-regions" ``` -## Building +By default, the gem uses the default locale of the i18n library. You can set a custom locale setting a custom configuration: -```bash -docker-compose build +```ruby +GR.configure do |config| + config.locale = :en +end ``` -## Open a console with the gem installed +* Retrieve a list of cities: -```bash -docker-compose run gem bash +```ruby +GR::City.all ``` + +* Retrieve a list of cities by state code and/or country code and/or similar name: + +```ruby +GR:City.find(state: "SP", country: "BR", name: "io Cl") + +# expected response +=> +[, + @is_in_european_union=0, + @name="Brazil">, + @name="Sao Paulo">, + @time_zone="America/Sao_Paulo">] +``` + +For more samples how to use the gem, check the [HOW_TO_USE.md](HOW_TO_USE.md) file. + +If you want to edit the source code and/or contribuct to the gem, please, check the [HOW_TO_USE.md](HOW_TO_USE.md) file. + +## Problems? + +**Please do not directly email any committers with questions or problems.** A +community is best served when discussions are held in public. + +Searching the [issues](https://github.com/dcotecnologia/geo-regions-ruby/issues) +for your problem is also a good idea. + +## Contributing + +* Check out the latest master to make sure the feature hasn't been implemented +or the bug hasn't been fixed yet; +* Check out the issue tracker to make sure someone already hasn't requested it +and/or contributed it; +* Fork the project; +* Start a feature/bugfix branch; +* Commit and push until you are happy with your contribution; +* Make sure to add tests for it. This is important so I don't break it in a +future version unintentionally.; +* Please try not to mess with the Rakefile, version, or history. If you want to +have your own version, or is otherwise necessary, that is fine, but please +isolate to its own commit so I can cherry-pick around it. + +## License + +Please see [LICENSE](LICENSE.txt) for licensing details. + +## Authors + +Danilo Carolino, [@danilogco](https://github.com/danilogco) / [@DCO Tecnologia](https://github.com/dcotecnologia) diff --git a/VERSIONING.md b/VERSIONING.md new file mode 100644 index 0000000..5192f3b --- /dev/null +++ b/VERSIONING.md @@ -0,0 +1,386 @@ +Semantic Versioning 2.0.0 +============================== + +Summary +------- + +Given a version number MAJOR.MINOR.PATCH, increment the: + +1. MAJOR version when you make incompatible API changes, +1. MINOR version when you add functionality in a backwards compatible + manner, and +1. PATCH version when you make backwards compatible bug fixes. + +Additional labels for pre-release and build metadata are available as extensions +to the MAJOR.MINOR.PATCH format. + +Introduction +------------ + +In the world of software management there exists a dreaded place called +"dependency hell." The bigger your system grows and the more packages you +integrate into your software, the more likely you are to find yourself, one +day, in this pit of despair. + +In systems with many dependencies, releasing new package versions can quickly +become a nightmare. If the dependency specifications are too tight, you are in +danger of version lock (the inability to upgrade a package without having to +release new versions of every dependent package). If dependencies are +specified too loosely, you will inevitably be bitten by version promiscuity +(assuming compatibility with more future versions than is reasonable). +Dependency hell is where you are when version lock and/or version promiscuity +prevent you from easily and safely moving your project forward. + +As a solution to this problem, we propose a simple set of rules and +requirements that dictate how version numbers are assigned and incremented. +These rules are based on but not necessarily limited to pre-existing +widespread common practices in use in both closed and open-source software. +For this system to work, you first need to declare a public API. This may +consist of documentation or be enforced by the code itself. Regardless, it is +important that this API be clear and precise. Once you identify your public +API, you communicate changes to it with specific increments to your version +number. Consider a version format of X.Y.Z (Major.Minor.Patch). Bug fixes not +affecting the API increment the patch version, backwards compatible API +additions/changes increment the minor version, and backwards incompatible API +changes increment the major version. + +We call this system "Semantic Versioning." Under this scheme, version numbers +and the way they change convey meaning about the underlying code and what has +been modified from one version to the next. + +Semantic Versioning Specification (SemVer) +------------------------------------------ + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be +interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). + +1. Software using Semantic Versioning MUST declare a public API. This API +could be declared in the code itself or exist strictly in documentation. +However it is done, it SHOULD be precise and comprehensive. + +1. A normal version number MUST take the form X.Y.Z where X, Y, and Z are +non-negative integers, and MUST NOT contain leading zeroes. X is the +major version, Y is the minor version, and Z is the patch version. +Each element MUST increase numerically. For instance: 1.9.0 -> 1.10.0 -> 1.11.0. + +1. Once a versioned package has been released, the contents of that version +MUST NOT be modified. Any modifications MUST be released as a new version. + +1. Major version zero (0.y.z) is for initial development. Anything MAY change +at any time. The public API SHOULD NOT be considered stable. + +1. Version 1.0.0 defines the public API. The way in which the version number +is incremented after this release is dependent on this public API and how it +changes. + +1. Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards +compatible bug fixes are introduced. A bug fix is defined as an internal +change that fixes incorrect behavior. + +1. Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards +compatible functionality is introduced to the public API. It MUST be +incremented if any public API functionality is marked as deprecated. It MAY be +incremented if substantial new functionality or improvements are introduced +within the private code. It MAY include patch level changes. Patch version +MUST be reset to 0 when minor version is incremented. + +1. Major version X (X.y.z | X > 0) MUST be incremented if any backwards +incompatible changes are introduced to the public API. It MAY also include minor +and patch level changes. Patch and minor versions MUST be reset to 0 when major +version is incremented. + +1. A pre-release version MAY be denoted by appending a hyphen and a +series of dot separated identifiers immediately following the patch +version. Identifiers MUST comprise only ASCII alphanumerics and hyphens +[0-9A-Za-z-]. Identifiers MUST NOT be empty. Numeric identifiers MUST +NOT include leading zeroes. Pre-release versions have a lower +precedence than the associated normal version. A pre-release version +indicates that the version is unstable and might not satisfy the +intended compatibility requirements as denoted by its associated +normal version. Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, +1.0.0-x.7.z.92, 1.0.0-x-y-z.--. + +1. Build metadata MAY be denoted by appending a plus sign and a series of dot +separated identifiers immediately following the patch or pre-release version. +Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. +Identifiers MUST NOT be empty. Build metadata MUST be ignored when determining +version precedence. Thus two versions that differ only in the build metadata, +have the same precedence. Examples: 1.0.0-alpha+001, 1.0.0+20130313144700, +1.0.0-beta+exp.sha.5114f85, 1.0.0+21AF26D3----117B344092BD. + +1. Precedence refers to how versions are compared to each other when ordered. + + 1. Precedence MUST be calculated by separating the version into major, + minor, patch and pre-release identifiers in that order (Build metadata + does not figure into precedence). + + 1. Precedence is determined by the first difference when comparing each of + these identifiers from left to right as follows: Major, minor, and patch + versions are always compared numerically. + + Example: 1.0.0 < 2.0.0 < 2.1.0 < 2.1.1. + + 1. When major, minor, and patch are equal, a pre-release version has lower + precedence than a normal version: + + Example: 1.0.0-alpha < 1.0.0. + + 1. Precedence for two pre-release versions with the same major, minor, and + patch version MUST be determined by comparing each dot separated identifier + from left to right until a difference is found as follows: + + 1. Identifiers consisting of only digits are compared numerically. + + 1. Identifiers with letters or hyphens are compared lexically in ASCII + sort order. + + 1. Numeric identifiers always have lower precedence than non-numeric + identifiers. + + 1. A larger set of pre-release fields has a higher precedence than a + smaller set, if all of the preceding identifiers are equal. + + Example: 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < + 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0. + +Backus–Naur Form Grammar for Valid SemVer Versions +-------------------------------------------------- + +```md + ::= + | "-" + | "+" + | "-" "+" + + ::= "." "." + + ::= + + ::= + + ::= + + ::= + + ::= + | "." + + ::= + + ::= + | "." + + ::= + | + + ::= + | + + ::= + | + | + | + + ::= "0" + | + | + + ::= + | + + ::= + | + + ::= + | "-" + + ::= + | + + ::= "0" + | + + ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" + + ::= "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" + | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" + | "U" | "V" | "W" | "X" | "Y" | "Z" | "a" | "b" | "c" | "d" + | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" + | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" + | "y" | "z" +``` + +Why Use Semantic Versioning? +---------------------------- + +This is not a new or revolutionary idea. In fact, you probably do something +close to this already. The problem is that "close" isn't good enough. Without +compliance to some sort of formal specification, version numbers are +essentially useless for dependency management. By giving a name and clear +definition to the above ideas, it becomes easy to communicate your intentions +to the users of your software. Once these intentions are clear, flexible (but +not too flexible) dependency specifications can finally be made. + +A simple example will demonstrate how Semantic Versioning can make dependency +hell a thing of the past. Consider a library called "Firetruck." It requires a +Semantically Versioned package named "Ladder." At the time that Firetruck is +created, Ladder is at version 3.1.0. Since Firetruck uses some functionality +that was first introduced in 3.1.0, you can safely specify the Ladder +dependency as greater than or equal to 3.1.0 but less than 4.0.0. Now, when +Ladder version 3.1.1 and 3.2.0 become available, you can release them to your +package management system and know that they will be compatible with existing +dependent software. + +As a responsible developer you will, of course, want to verify that any +package upgrades function as advertised. The real world is a messy place; +there's nothing we can do about that but be vigilant. What you can do is let +Semantic Versioning provide you with a sane way to release and upgrade +packages without having to roll new versions of dependent packages, saving you +time and hassle. + +If all of this sounds desirable, all you need to do to start using Semantic +Versioning is to declare that you are doing so and then follow the rules. Link +to this website from your README so others know the rules and can benefit from +them. + +FAQ +--- + +How should I deal with revisions in the 0.y.z initial development phase? +---------------------------- + +The simplest thing to do is start your initial development release at 0.1.0 +and then increment the minor version for each subsequent release. + +How do I know when to release 1.0.0? +---------------------------- + +If your software is being used in production, it should probably already be +1.0.0. If you have a stable API on which users have come to depend, you should +be 1.0.0. If you're worrying a lot about backwards compatibility, you should +probably already be 1.0.0. + +Doesn't this discourage rapid development and fast iteration? +---------------------------- + +Major version zero is all about rapid development. If you're changing the API +every day you should either still be in version 0.y.z or on a separate +development branch working on the next major version. + +If even the tiniest backwards incompatible changes to the public API require a major version bump, won't I end up at version 42.0.0 very rapidly? +---------------------------- + +This is a question of responsible development and foresight. Incompatible +changes should not be introduced lightly to software that has a lot of +dependent code. The cost that must be incurred to upgrade can be significant. +Having to bump major versions to release incompatible changes means you'll +think through the impact of your changes, and evaluate the cost/benefit ratio +involved. + +Documenting the entire public API is too much work +---------------------------- + +It is your responsibility as a professional developer to properly document +software that is intended for use by others. Managing software complexity is a +hugely important part of keeping a project efficient, and that's hard to do if +nobody knows how to use your software, or what methods are safe to call. In +the long run, Semantic Versioning, and the insistence on a well defined public +API can keep everyone and everything running smoothly. + +What do I do if I accidentally release a backwards incompatible change as a minor version? +---------------------------- + +As soon as you realize that you've broken the Semantic Versioning spec, fix +the problem and release a new minor version that corrects the problem and +restores backwards compatibility. Even under this circumstance, it is +unacceptable to modify versioned releases. If it's appropriate, +document the offending version and inform your users of the problem so that +they are aware of the offending version. + +What should I do if I update my own dependencies without changing the public API? +---------------------------- + +That would be considered compatible since it does not affect the public API. +Software that explicitly depends on the same dependencies as your package +should have their own dependency specifications and the author will notice any +conflicts. Determining whether the change is a patch level or minor level +modification depends on whether you updated your dependencies in order to fix +a bug or introduce new functionality. We would usually expect additional code +for the latter instance, in which case it's obviously a minor level increment. + +What if I inadvertently alter the public API in a way that is not compliant with the version number change (i.e. the code incorrectly introduces a major breaking change in a patch release)? +---------------------------- + +Use your best judgment. If you have a huge audience that will be drastically +impacted by changing the behavior back to what the public API intended, then +it may be best to perform a major version release, even though the fix could +strictly be considered a patch release. Remember, Semantic Versioning is all +about conveying meaning by how the version number changes. If these changes +are important to your users, use the version number to inform them. + +How should I handle deprecating functionality? +---------------------------- + +Deprecating existing functionality is a normal part of software development and +is often required to make forward progress. When you deprecate part of your +public API, you should do two things: (1) update your documentation to let +users know about the change, (2) issue a new minor release with the deprecation +in place. Before you completely remove the functionality in a new major release +there should be at least one minor release that contains the deprecation so +that users can smoothly transition to the new API. + +Does SemVer have a size limit on the version string? +---------------------------- + +No, but use good judgment. A 255 character version string is probably overkill, +for example. Also, specific systems may impose their own limits on the size of +the string. + +Is "v1.2.3" a semantic version? +---------------------------- + +No, "v1.2.3" is not a semantic version. However, prefixing a semantic version +with a "v" is a common way (in English) to indicate it is a version number. +Abbreviating "version" as "v" is often seen with version control. Example: +`git tag v1.2.3 -m "Release version 1.2.3"`, in which case "v1.2.3" is a tag +name and the semantic version is "1.2.3". + +Is there a suggested regular expression (RegEx) to check a SemVer string? +---------------------------- + +There are two. One with named groups for those systems that support them +(PCRE [Perl Compatible Regular Expressions, i.e. Perl, PHP and R], Python +and Go). + +See: + +```regex +^(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)(?:-(?P(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ +``` + +And one with numbered capture groups instead (so cg1 = major, cg2 = minor, +cg3 = patch, cg4 = prerelease and cg5 = buildmetadata) that is compatible +with ECMA Script (JavaScript), PCRE (Perl Compatible Regular Expressions, +i.e. Perl, PHP and R), Python and Go. + +See: + +```regex +^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ +``` + +About +----- + +The Semantic Versioning specification was originally authored by [Tom +Preston-Werner](https://tom.preston-werner.com), inventor of Gravatar and +cofounder of GitHub. + +If you'd like to leave feedback, please [open an issue on +GitHub](https://github.com/semver/semver/issues). + +License +------- + +[Creative Commons ― CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) diff --git a/lib/geo-regions/country.rb b/lib/geo-regions/country.rb index 7c8be14..b0397e0 100644 --- a/lib/geo-regions/country.rb +++ b/lib/geo-regions/country.rb @@ -36,6 +36,7 @@ def self.find(name: nil) country_name = helper.sanatize_name(rec[POS.country_name]) is_in_european_union = helper.sanatize_name(rec[POS.is_in_european_union]) + next if country_name.nil? || country_name == "" next if name && !country_name.include?(name) country = new( diff --git a/lib/geo-regions/version.rb b/lib/geo-regions/version.rb index c77d8af..0fa4e44 100644 --- a/lib/geo-regions/version.rb +++ b/lib/geo-regions/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module GR - VERSION = "0.1.0" + VERSION = "1.0.0" end diff --git a/spec/lib/country_spec.rb b/spec/lib/country_spec.rb index e34cfcc..5ea6dfb 100644 --- a/spec/lib/country_spec.rb +++ b/spec/lib/country_spec.rb @@ -6,7 +6,7 @@ describe "#all" do subject { described_class.all } - it { expect(subject).to have_attributes(count: 252) } + it { expect(subject).to have_attributes(count: 250) } end describe "#is_in_european_union?" do