gitmoji-regex 0.1.0 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +37 -1
  3. data/README.md +165 -2
  4. data/lib/gitmoji/regex/version.rb +1 -1
  5. data/spec/spec_helper.rb +22 -1
  6. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 472cec967facea7821ca6ac337adf22ead47a8a5556cc3dc51a7122220de29b5
4
- data.tar.gz: 3052e67724706709839448d091780953f5fa5450902fc4ef282c1901fce32bda
3
+ metadata.gz: 7a34bdf4e77daed3392c972f0894b2f617f5485e6158f978b61357afb19df3a9
4
+ data.tar.gz: bffbece18bb05f5e94ee4d4dc708dace3952312642fbfbcf376ada8abcefef8b
5
5
  SHA512:
6
- metadata.gz: ecb15203b969ad67bf7069027140f4cd37967ed320a3c198f913f78ff4fd82cccc150152f0ce6befdf0a43d9bf3ba1d67c83232f186b7b9b6b36a3c60e544fb9
7
- data.tar.gz: 80584b80f9b1f2a933a5bb0cd1afaa4113447d3a9f81b823fbffae97b10e41af98ef5fa7b0b9c203aa0e18def7c79ae3d8a7517832b26a19979856631c141c49
6
+ metadata.gz: 8a78297951c52b512118df61c6ccf4374f0454dfd09ae9a9b9b57181ac94fdf1ef8ac2c2c38ff86a9d1a20c6d5c46a984ee3d54b939d4651d282059e48d9f09e
7
+ data.tar.gz: 6f5875beff86ae3d52951e1c233c4cd16fb0bea3197de9e84dcaf10034e83c7c402115c38595335ae15b264e9f5bd8830476d84f9c0cd65ddc5dd4dbb1c60c97
data/CHANGELOG.md CHANGED
@@ -1,5 +1,41 @@
1
+ # Changelog
2
+ All notable changes to this project will be documented in this file.
3
+
4
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
1
7
  ## [Unreleased]
8
+ ### Added
2
9
 
3
- ## [0.1.0] - 2022-03-28
10
+ ### Changed
11
+
12
+ ### Fixed
13
+
14
+ ### Removed
15
+
16
+ ## [0.1.3] - 2022-03-30
17
+ ### Added
18
+ - Documentation
19
+ - Badges
4
20
 
21
+ ### Fixed
22
+ - Code Coverage
23
+ - Changelog URLs
24
+
25
+ ## [0.1.2] - 2022-03-29
26
+ ### Added
27
+ - Badges and Logos
28
+
29
+ ## [0.1.1] - 2022-03-28
30
+ ### Added
31
+ - Usage documentation
32
+
33
+ ## [0.1.0] - 2022-03-28
34
+ ### Added
5
35
  - Initial release
36
+
37
+ [Unreleased]: https://github.com/pboling/gitmoji-regex/compare/.v0.1.3...HEAD
38
+ [0.1.3]: https://github.com/pboling/gitmoji-regex/compare/v0.1.2...v0.1.3
39
+ [0.1.2]: https://github.com/pboling/gitmoji-regex/compare/v0.1.1...v0.1.2
40
+ [0.1.1]: https://github.com/pboling/gitmoji-regex/compare/v0.1.0...v0.1.1
41
+ [0.1.0]: https://github.com/pboling/gitmoji-regex/compare/e71c6c3dad5bfd59ae2509531eaea3a16e21cb63...v0.1.0
data/README.md CHANGED
@@ -1,9 +1,163 @@
1
+ <p align="center">
2
+ <a href="https://gitmoji.dev/" target="_blank" rel="noopener">
3
+ <img width="120px" src="https://github.com/pboling/gitmoji-regex/raw/main/docs/images/logo/gitmoji-logo-120px.png?raw=true" alt="Gotmoji Logo Copyright (c) 2016-2022 Carlos Cuesta, MIT License">
4
+ </a>
5
+ <a href="https://rubular.com/" target="_blank" rel="noopener">
6
+ <img width="120px" src="https://github.com/pboling/gitmoji-regex/raw/main/docs/images/logo/regex-logo-120px.png?raw=true" alt="Regular Expression OOjs UI Icon by GOJU, MIT License via Wikimedia Commons">
7
+ </a>
8
+ <a href="https://www.ruby-lang.org/" target="_blank" rel="noopener">
9
+ <img width="120px" src="https://github.com/pboling/gitmoji-regex/raw/main/docs/images/logo/ruby-logo-198px.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5">
10
+ </a>
11
+ </p>
12
+
1
13
  # Gitmoji::Regex
2
14
 
3
- This gem provides a regex that allows Ruby code to test a string for a [Gitmoji](https://github.com/carloscuesta/gitmoji) character. Gitmoji is a [subset](https://raw.githubusercontent.com/carloscuesta/gitmoji/master/src/data/gitmojis.json) of the Unicode Emoji character set. This gem is _not_ a fork of, but was **inspired** by, the wonderful [emoji-regex](https://github.com/ticky/ruby-emoji-regex) gem.
15
+ This gem provides a regex that allows Ruby code to test a string for a [Gitmoji](https://github.com/carloscuesta/gitmoji) character. Gitmoji is a [subset](https://raw.githubusercontent.com/carloscuesta/gitmoji/master/src/data/gitmojis.json) of the Unicode Emoji character set. This gem is _not_ a fork of, but was **inspired** by, the wonderful [emoji_regex](https://github.com/ticky/ruby-emoji-regex) gem.
4
16
 
5
17
  This gem has no runtime dependencies.
6
18
 
19
+ <!--
20
+ Numbering rows and badges in each row as a visual "database" lookup,
21
+ as the table is extremely dense, and it can be very difficult to find anything
22
+ Putting one on each row here, to document the emoji that should be used, and for ease of copy/paste.
23
+
24
+ row #s:
25
+ 1️⃣
26
+ 2️⃣
27
+ 3️⃣
28
+ 4️⃣
29
+ 5️⃣
30
+ 6️⃣
31
+ 7️⃣
32
+
33
+ badge #s:
34
+ ⛳️
35
+ 🖇
36
+ 🏘
37
+ 🚎
38
+ 🖐
39
+ 🧮
40
+ 📗
41
+
42
+ appended indicators:
43
+ ♻️ - URL needs to be updated from SASS integration. Find / Replace is insufficient.
44
+ -->
45
+
46
+ | | Project | bundle add gitmoji-regex |
47
+ |:----|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
48
+ | 1️⃣ | name, license, docs, standards | [![RubyGems.org][⛳️name-img]][⛳️gem] [![License: MIT][🖇src-license-img]][🖇src-license] <!--[![FOSSA][🏘fossa-img]][🏘fossa]--> [![RubyDoc.info][🚎yard-img]][🚎yard] [![GitMoji][🖐gitmoji-img]][🖐gitmoji] [![SemVer 2.0.0][🧮semver-img]][semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] |
49
+ | 2️⃣ | version & activity | [![Gem Version][⛳️version-img]][⛳️gem] [![Total Downloads][🖇DL-total-img]][⛳️gem] [![Download Rank][🏘DL-rank-img]][⛳️gem] [![Source Code][🚎src-home-img]][🚎src-home] [![Open PRs][🖐prs-o-img]][🖐prs-o] [![Closed PRs][🧮prs-c-img]][🧮prs-c] <!--[![Next Version][📗next-img]][📗next]--> |
50
+ | 3️⃣ | maintanence & linting | [![Maintainability][⛳cclim-maint-img♻️]][⛳cclim-maint] [![Helpers][🖇triage-help-img]][🖇triage-help] [![Depfu][🏘depfu-img♻️]][🏘depfu♻️] [![Contributors][🚎contributors-img]][🚎contributors] [![Style][🖐style-wf-img]][🖐style-wf] [![Kloc Roll][🧮kloc-img]][🧮kloc] |
51
+ | 4️⃣ | testing | [![Open Issues][⛳iss-o-img]][⛳iss-o] [![Closed Issues][🖇iss-c-img]][🖇iss-c] [![Supported][🏘sup-wf-img]][🏘sup-wf] [![Heads][🚎heads-wf-img]][🚎heads-wf] [![Unofficial Support][🖐uns-wf-img]][🖐uns-wf] <!--[![MacOS][🧮mac-wf-img]][🧮mac-wf] [![Windows][📗win-wf-img]][📗win-wf]--> |
52
+ | 5️⃣ | coverage & security | [![CodeClimate][⛳cclim-cov-img♻️]][⛳cclim-cov] [![CodeCov][🖇codecov-img♻️]][🖇codecov] [![Coveralls][🏘coveralls-img]][🏘coveralls] [![Security Policy][🚎sec-pol-img]][🚎sec-pol] [![CodeQL][🖐codeQL-img]][🖐codeQL] [![Code Coverage][🧮cov-wf-img]][🧮cov-wf] |
53
+ | 6️⃣ | resources | [![Discussion][⛳gh-discussions-img]][⛳gh-discussions] [![Get help on Codementor][🖇codementor-img]][🖇codementor] [![Chat][🏘chat-img]][🏘chat] [![Blog][🚎blog-img]][🚎blog] [![Wiki][🖐wiki-img]][🖐wiki] |
54
+ | 7️⃣ | spread 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Tweet @ Peter][🏘tweet-img]][🏘tweet] [🌏][aboutme] [👼][angelme] [💻][coderme] [🌹][politicme] |
55
+
56
+ <!--
57
+ The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
58
+ -->
59
+
60
+ <!-- 1️⃣ name, license, docs -->
61
+ [⛳️gem]: https://rubygems.org/gems/gitmoji-regex
62
+ [⛳️name-img]: https://img.shields.io/badge/name-gitmoji--regex-brightgreen.svg?style=flat
63
+ [🖇src-license]: https://opensource.org/licenses/MIT
64
+ [🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
65
+ [🏘fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Fpboling%2Fgitmoji-regex?ref=badge_shield
66
+ [🏘fossa-img]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpboling%2Fgitmoji-regex.svg?type=shield
67
+ [🚎yard]: https://www.rubydoc.info/github/pboling/gitmoji-regex
68
+ [🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
69
+ [🖐gitmoji]: https://gitmoji.dev
70
+ [🖐gitmoji-img]: https://img.shields.io/badge/gitmoji-3.9.0-FFDD67.svg?style=flat
71
+ [🧮semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
72
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
73
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
74
+
75
+ <!-- 2️⃣ version & activity -->
76
+ [⛳️version-img]: http://img.shields.io/gem/v/gitmoji-regex.svg
77
+ [🖇DL-total-img]: https://img.shields.io/gem/dt/gitmoji-regex.svg
78
+ [🏘DL-rank-img]: https://img.shields.io/gem/rt/gitmoji-regex.svg
79
+ [🚎src-home]: https://github.com/pboling/gitmoji-regex
80
+ [🚎src-home-img]: https://img.shields.io/badge/source-github-brightgreen.svg?style=flat
81
+ [🖐prs-o]: https://github.com/pboling/gitmoji-regex/pulls
82
+ [🖐prs-o-img]: https://img.shields.io/github/issues-pr/pboling/gitmoji-regex
83
+ [🧮prs-c]: https://github.com/pboling/gitmoji-regex/pulls?q=is%3Apr+is%3Aclosed
84
+ [🧮prs-c-img]: https://img.shields.io/github/issues-pr-closed/pboling/gitmoji-regex
85
+ [📗next]: https://github.com/pboling/gitmoji-regex/milestone/1
86
+ [📗next-img]: https://img.shields.io/github/milestones/progress/pboling/gitmoji-regex/1?label=Next%20Version
87
+
88
+ <!-- 3️⃣ maintanence & linting -->
89
+ [⛳cclim-maint]: https://codeclimate.com/github/pboling/gitmoji-regex/maintainability
90
+ [⛳cclim-maint-img♻️]: https://api.codeclimate.com/v1/badges/f32e1d1148e8bad58197/maintainability
91
+ [🖇triage-help]: https://www.codetriage.com/pboling/gitmoji-regex
92
+ [🖇triage-help-img]: https://www.codetriage.com/pboling/gitmoji-regex/badges/users.svg
93
+ [🏘depfu♻️]: https://depfu.com/github/pboling/gitmoji-regex?project_id=34924
94
+ [🏘depfu-img♻️]: https://badges.depfu.com/badges/300630ab4b7c2efea20806d13d1ef41f/count.svg
95
+ [🚎contributors]: https://github.com/pboling/gitmoji-regex/graphs/contributors
96
+ [🚎contributors-img]: https://img.shields.io/github/contributors-anon/pboling/gitmoji-regex
97
+ [🖐style-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/style.yml
98
+ [🖐style-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/style.yml/badge.svg
99
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
100
+ [🧮kloc-img]: https://img.shields.io/tokei/lines/github.com/pboling/gitmoji-regex
101
+
102
+ <!-- 4️⃣ testing -->
103
+ [⛳iss-o]: https://github.com/pboling/gitmoji-regex/issues
104
+ [⛳iss-o-img]: https://img.shields.io/github/issues-raw/pboling/gitmoji-regex
105
+ [🖇iss-c]: https://github.com/pboling/gitmoji-regex/issues?q=is%3Aissue+is%3Aclosed
106
+ [🖇iss-c-img]: https://img.shields.io/github/issues-closed-raw/pboling/gitmoji-regex
107
+ [🏘sup-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/supported.yml
108
+ [🏘sup-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/supported.yml/badge.svg
109
+ [🚎heads-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/heads.yml
110
+ [🚎heads-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/heads.yml/badge.svg
111
+ [🖐uns-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/unsupported.yml
112
+ [🖐uns-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/unsupported.yml/badge.svg
113
+ [🧮mac-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/macos.yml
114
+ [🧮mac-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/macos.yml/badge.svg
115
+ [📗win-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/windows.yml
116
+ [📗win-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/windows.yml/badge.svg
117
+
118
+ <!-- 5️⃣ coverage & security -->
119
+ [⛳cclim-cov]: https://codeclimate.com/github/pboling/gitmoji-regex/test_coverage
120
+ [⛳cclim-cov-img♻️]: https://api.codeclimate.com/v1/badges/f32e1d1148e8bad58197/test_coverage
121
+ [🖇codecov-img♻️]: https://codecov.io/gh/pboling/gitmoji-regex/branch/main/graph/badge.svg?token=EJCOr0hsPq
122
+ [🖇codecov]: https://codecov.io/gh/pboling/gitmoji-regex
123
+ [🏘coveralls]: https://coveralls.io/github/pboling/gitmoji-regex?branch=main
124
+ [🏘coveralls-img]: https://coveralls.io/repos/github/pboling/gitmoji-regex/badge.svg?branch=main
125
+ [🚎sec-pol]: https://github.com/pboling/gitmoji-regex/blob/main/SECURITY.md
126
+ [🚎sec-pol-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
127
+ [🖐codeQL]: https://github.com/pboling/gitmoji-regex/security/code-scanning
128
+ [🖐codeQL-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/codeql-analysis.yml/badge.svg
129
+ [🧮cov-wf]: https://github.com/pboling/gitmoji-regex/actions/workflows/coverage.yml
130
+ [🧮cov-wf-img]: https://github.com/pboling/gitmoji-regex/actions/workflows/coverage.yml/badge.svg
131
+
132
+ <!-- 6️⃣ resources -->
133
+ [⛳gh-discussions]: https://github.com/pboling/gitmoji-regex/discussions
134
+ [⛳gh-discussions-img]: https://img.shields.io/github/discussions/pboling/gitmoji-regex
135
+ [🖇codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
136
+ [🖇codementor-img]: https://cdn.codementor.io/badges/get_help_github.svg
137
+ [🏘chat]: https://gitter.im/pboling/gitmoji-regex
138
+ [🏘chat-img]: https://img.shields.io/gitter/room/pboling/gitmoji-regex.svg
139
+ [🚎blog]: http://www.railsbling.com/tags/gitmoji-regex/
140
+ [🚎blog-img]: https://img.shields.io/badge/blog-railsbling-brightgreen.svg?style=flat
141
+ [🖐wiki]: https://github.com/pboling/gitmoji-regex/wiki
142
+ [🖐wiki-img]: https://img.shields.io/badge/wiki-examples-brightgreen.svg?style=flat
143
+
144
+ <!-- 7️⃣ spread 💖 -->
145
+ [⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
146
+ [⛳liberapay]: https://liberapay.com/pboling/donate
147
+ [🖇sponsor-img]: https://img.shields.io/badge/sponsor-pboling.svg?style=social&logo=github
148
+ [🖇sponsor]: https://github.com/sponsors/pboling
149
+ [🏘tweet-img]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
150
+ [🏘tweet]: http://twitter.com/galtzo
151
+
152
+ <!-- Maintainer Contact Links -->
153
+ [railsbling]: http://www.railsbling.com
154
+ [peterboling]: http://www.peterboling.com
155
+ [aboutme]: https://about.me/peter.boling
156
+ [angelme]: https://angel.co/peter-boling
157
+ [coderme]:http://coderwall.com/pboling
158
+ [politicme]: https://nationalprogressiveparty.org
159
+
160
+
7
161
  ## Installation
8
162
 
9
163
  Install the gem and add to the application's Gemfile by executing:
@@ -16,7 +170,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
16
170
 
17
171
  ## Usage
18
172
 
19
- TODO: Write usage instructions here
173
+ ```ruby
174
+ "🔥" =~ Gitmoji::Regex::REGEX
175
+ # => 0 # character at position 0 is a Gitmoji!
176
+ "fire" =~ Gitmoji::Regex::REGEX
177
+ # => nil
178
+ ```
20
179
 
21
180
  ## Development
22
181
 
@@ -64,6 +223,10 @@ For example:
64
223
  spec.add_dependency "gitmoji-regex", "~> 0.1"
65
224
  ```
66
225
 
226
+ ## Security
227
+
228
+ See [SECURITY.md](https://github.com/pboling/gitmoji-regex/blob/main/SECURITY.md).
229
+
67
230
  [copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
68
231
 
69
232
  [gh_discussions]: https://github.com/pboling/gitmoji-regex/discussions
data/lib/gitmoji/regex/version.rb CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Gitmoji
4
4
  module Regex
5
- VERSION = "0.1.0"
5
+ VERSION = "0.1.3"
6
6
  end
7
7
  end
data/spec/spec_helper.rb CHANGED
@@ -20,7 +20,28 @@ if DEBUG
20
20
  end
21
21
  end
22
22
 
23
- require "simplecov" if RUN_COVERAGE
23
+ if RUN_COVERAGE
24
+ require "simplecov" # Config file `.simplecov` is run immediately when simplecov loads
25
+ require "codecov"
26
+ require "simplecov-json"
27
+ require "simplecov-lcov"
28
+ require "simplecov-cobertura"
29
+ # This will override any formatter set in .simplecov
30
+ if ALL_FORMATTERS
31
+ SimpleCov::Formatter::LcovFormatter.config do |c|
32
+ c.report_with_single_file = true
33
+ c.single_report_path = "coverage/lcov.info"
34
+ end
35
+
36
+ SimpleCov.formatters = [
37
+ SimpleCov::Formatter::HTMLFormatter,
38
+ SimpleCov::Formatter::CoberturaFormatter, # XML for Jenkins
39
+ SimpleCov::Formatter::LcovFormatter,
40
+ SimpleCov::Formatter::JSONFormatter, # For CodeClimate
41
+ SimpleCov::Formatter::Codecov # For CodeCov
42
+ ]
43
+ end
44
+ end
24
45
 
25
46
  # This gem
26
47
  require "gitmoji/regex"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gitmoji-regex
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Peter Boling
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2022-03-28 00:00:00.000000000 Z
11
+ date: 2022-03-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: http
@@ -145,10 +145,10 @@ licenses:
145
145
  - MIT
146
146
  metadata:
147
147
  homepage_uri: https://github.com/pboling/gitmoji-regex
148
- source_code_uri: https://github.com/pboling/gitmoji-regex/tree/v0.1.0
149
- changelog_uri: https://github.com/pboling/gitmoji-regex/blob/v0.1.0/CHANGELOG.md
148
+ source_code_uri: https://github.com/pboling/gitmoji-regex/tree/v0.1.3
149
+ changelog_uri: https://github.com/pboling/gitmoji-regex/blob/v0.1.3/CHANGELOG.md
150
150
  bug_tracker_uri: https://github.com/pboling/gitmoji-regex/issues
151
- documentation_uri: https://www.rubydoc.info/gems/gitmoji-regex/0.1.0
151
+ documentation_uri: https://www.rubydoc.info/gems/gitmoji-regex/0.1.3
152
152
  wiki_uri: https://github.com/pboling/gitmoji-regex/wiki
153
153
  rubygems_mfa_required: 'true'
154
154
  post_install_message: