tanuki_emoji 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14e9a274c028f5da0ca9855c5ea0c15e39c67c9a555213bba590f0b72b3d072
-  data.tar.gz: e4c90eaabfaed8eb22c87f4097162978dec6f73edcbdf21db36cb5d2c939c587
+  metadata.gz: c67213658b22404d9912d1a6704748c1106602013ea3263e819dff1c05ee4dc8
+  data.tar.gz: 205335429c995e7fc884867b50caed6beb2f1bec90c9a4fa3bf31afdc364aa64
 SHA512:
-  metadata.gz: f06e63daa5501849456c2cf95d754286fdb41bc96283f11ada069cc9c97a2f6ea5f608f453c07f9138e7e19579857193c7ebb79d5413a65ff4832c053732c0c2
-  data.tar.gz: 3b3362d115678f62563757e655121e901a26c23c674da95a6a10ae7553d6d01d00609243f0a5f591f775ecb70c3588122c127e5615de50c3e1503a05424df24f
+  metadata.gz: a32137a26584a98e2e59954829e769cfdacb126986debc443118477cae7c5bd16cde127a75cb606c9674e31545102df12792ac58ff25bab479d49676553be297
+  data.tar.gz: 4fc240c5cd68e53f5721063f74f32b4bd2e4f60840882fb55dc31cb23163615f0096d4616bed8c730ac198322d87a5328c9b6cf7b0ab7e1e2b95fb0cdad43207

data/.gitignore

@@ -9,6 +9,8 @@
 /.idea
 .rspec_status
 /*.gem
+/app/assets/**/*
+.DS_Store
 
 # rspec failure tracking
 .rspec_status

data/.gitlab/CODEOWNERS

@@ -0,0 +1,2 @@
+[Maintainers]
+* @brodock @cablett @mwoolf @kerrizor @brytannia @splattael @digitalmoksha @smcgivern @jlear

data/.gitlab-ci.yml

@@ -17,20 +17,33 @@
 
 rspec:
   extends: .ruby
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
   script:
+    - bundle exec rake update_assets
     - bundle exec rake spec
   artifacts:
     reports:
       junit: rspec.xml
       cobertura: coverage/coverage.xml
 
+gem:
+  extends: .ruby
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
+  script:
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+
 rubocop:
   extends: .ruby
   script:
     - bundle exec rake rubocop
 
 include:
-  - template: SAST.gitlab-ci.yml
+  - template: Security/SAST.gitlab-ci.yml
   - template: Dependency-Scanning.gitlab-ci.yml
   - template: Security/License-Scanning.gitlab-ci.yml
   - template: Code-Quality.gitlab-ci.yml

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/noto-emoji"]
+	path = vendor/noto-emoji
+	url = https://github.com/googlefonts/noto-emoji

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/CHANGELOG.md

@@ -6,8 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2021-08-26
+### Modified
+- Characters can be compared and will be considered equal when all of its attributes matches
+- `:+1:` and `:-1:` which are aliases for `:thumbsup:` and `:thumbsdown:` can now be used with `find_by_alpha_code`
+- added tests for both `find_by_alpha_code` and `find_by_codepoints` and make sure `find_by_alpha_code` can handle `nil` correctly
+
+## [0.2.2] - 2021-08-23
+### Modified
+- Fixed autoload load_path
+
+## [0.2.1] - 2021-07-09
+### Modified
+- Noto Emoji assets were not included due to bug in gemspec code. Now it is.
+
+## [0.2.0] - 2021-07-09
+### Added
+- Bundled Noto Emoji assets for each corresponding indexed Emoji
+- `Character` responds to `#image_name` pointing to Noto Emoji filenames
+- `TanukiEmoji` responds to `.images_path` pointing to Emoji assets folder
+
 ## [0.1.0] - 2021-07-04
 ### Added
 - Initial release with index and Character information support
 
-[0.1.0]:https://gitlab.com/brodock/tanuki_emoji/-/releases/v0.1.0
+[0.1.0]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.1.0
+[0.2.0]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.2.0
+[0.2.1]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.2.1
+[0.2.2]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.2.2

data/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+## Developer Certificate of Origin and License
+
+By contributing to GitLab B.V., you accept and agree to the following terms and
+conditions for your present and future contributions submitted to GitLab B.V.
+Except for the license granted herein to GitLab B.V. and recipients of software
+distributed by GitLab B.V., you reserve all right, title, and interest in and to
+your Contributions.
+
+All contributions are subject to the Developer Certificate of Origin and license set out at 
+[docs.gitlab.com/ce/legal/developer_certificate_of_origin](https://docs.gitlab.com/ce/legal/developer_certificate_of_origin).
+
+<!-- This notice should stay as the first item in the CONTRIBUTING.md file. -->
+
+## Code of conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be
+reported by emailing contact@gitlab.com.
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version 1.1.0,
+available at [https://contributor-covenant.org/version/1/1/0/](https://contributor-covenant.org/version/1/1/0/).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tanuki_emoji (0.1.0)
+    tanuki_emoji (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -66,4 +66,4 @@ DEPENDENCIES
   tanuki_emoji!
 
 BUNDLED WITH
-   2.2.9
+   2.2.15

data/README.md

@@ -4,7 +4,10 @@ This library helps you implement Emoji support in a ruby application by providin
 information.
 
 We currently provides a pre-indexed set of Emojis, compatible with [Gemojione](https://github.com/bonusly/gemojione)
-index from 3.3.0. In the future we expect to cover the most recent version of Unicode. 
+index from 3.3.0. In the future we expect to cover the most recent version of Unicode.
+
+This gem bundles Emoji assets from [Noto Emoji](https://github.com/googlefonts/noto-emoji), to be used as fallback when
+Emoji is not available or not fully supported on target system.
 
 ## Installation
 
@@ -17,7 +20,7 @@ gem 'tanuki_emoji'
 And then execute:
 
 ```shell
-    $ bundle install
+$ bundle install
 ```
 
 ## Usage
@@ -52,6 +55,19 @@ TanukiEmoji.find_by_alpha_code('horse')
 #=> #<TanukiEmoji::Character:horse 🐴(1f434)>
 ```
 
+To retrieve an alternative image for the character:
+```ruby
+c = TanukiEmoji.find_by_alpha_code('horse')
+#=> #<TanukiEmoji::Character:horse 🐴(1f434)>
+
+c.image_name
+#=> "emoji_u1f434.png"
+
+# Use the image_name with bundled assets from Noto Emoji:
+File.join(TanukiEmoji.images_path, c.image_name)
+#=> "/path/to/tanuki_emoji/app/assets/images/tanuki_emoji/emoji_u1f434.png"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
@@ -64,8 +80,15 @@ which will create a git tag for the version, push git commits and the created ta
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/brodock/tanuki_emoji.
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Noto Emoji assets and build tools are [Apache license, version 2.0](https://github.com/googlefonts/noto-emoji/blob/main/LICENSE)
+licensed.
+
+Flag images are under
+public domain or otherwise excempt from copyright
+([more info](https://github.com/googlefonts/noto-emoji/blob/main/third_party/region-flags/LICENSE)).

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
+require "tanuki_emoji"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w[--format documentation --color --require spec_helper]
@@ -11,10 +12,44 @@ end
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
-
 desc 'Code coverage detail'
 task :simplecov do
   ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
 end
+
+task default: %i[spec rubocop]
+
+desc 'Update images from vendor/noto-emoji to app/assets folder'
+task update_assets: ['noto_emoji:generate_flags'] do
+  png_path = File.join(__dir__, 'vendor/noto-emoji/png/72')
+  flag_path = File.join(__dir__, 'vendor/noto-emoji/build/flags')
+  TanukiEmoji.index.all.each do |emoji|
+    if emoji.flag?
+      source_flag = File.join(flag_path, emoji.image_name)
+      cp(source_flag, TanukiEmoji.images_path)
+
+      next
+    end
+
+    source_png = File.join(png_path, emoji.image_name)
+    cp(source_png, TanukiEmoji.images_path)
+  end
+end
+
+namespace :noto_emoji do
+  noto_emoji_path = File.join(__dir__, 'vendor/noto-emoji')
+
+  task :generate_flags do
+    chdir(File.expand_path(noto_emoji_path)) do
+      Dir['third_party/region-flags/png/*.png'].each do |file|
+        filename = File.basename(file)
+        puts filename
+
+        sh("make build/flags/#{filename}")
+      end
+    end
+  end
+end
+
+Rake::Task[:build].enhance [:update_assets]