gemoji-cli 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +8 -1
  3. data/CHANGELOG.md +3 -0
  4. data/README.md +40 -14
  5. data/Rakefile +1 -1
  6. data/TODO.md +45 -0
  7. data/lib/gemoji/cli/version.rb +1 -1
  8. data/mise.toml +3 -0
  9. metadata +8 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 259ef6cb27019361b5ba2fde8894af3e7989091af84c38c0ca5294f621610b72
4
- data.tar.gz: 7c908ec314daf7646c0b9d18f31149093d13aa0751b0e1470c3a2dbad7ed6851
3
+ metadata.gz: 9283afcf866c4b61bb6f5b374ba6fce3871d788dde3bcea098f77a7fc0a1e21e
4
+ data.tar.gz: 6e307b2e43b8dec3b05c18da8bb77ed5ca12dbab9066a697c73cff96db0bccfd
5
5
  SHA512:
6
- metadata.gz: 6d23ac895a205c2b768fd427e4b1a426cfd9158d5db64f266a57b9a5ef5223096431ff40876f49a72182bb7ff3e746c39b31bc125471e5414415d2fc53b9a9d9
7
- data.tar.gz: dcbaff573657f536b63050c3ed4cb7eb3029e9ebf0182f0a59622fc5c2f3019a85a80c448be47449a9f2eca156dc9dfa6468d9c9d7bcdb0eb0594e22868f7a71
6
+ metadata.gz: d99a83870f3c610a221107e5001e1553cdcd5e8c47118fe496e2aaf7295855e217b0e5d84504e4bdf369888798ec0210be6bb144563a87e8e368987002044e50
7
+ data.tar.gz: 8c9454b291599d081d81282abd375386ca50fef6ecca97009ead38c741d5814ddd17c122c7e51bc1c2b75c5c914c7c1c5e2a273991f81008ad8c16d82ffa5354
data/.rubocop.yml CHANGED
@@ -7,7 +7,7 @@ AllCops:
7
7
  - bin/**/*
8
8
  - vendor/**/*
9
9
  ExtraDetails: true
10
- TargetRubyVersion: 3.4
10
+ TargetRubyVersion: 3.2
11
11
  UseCache: true
12
12
  inherit_mode:
13
13
  merge:
@@ -45,3 +45,10 @@ Style/DocumentationMethod:
45
45
  - AllowedMethods
46
46
  AllowedMethods:
47
47
  - call
48
+
49
+ RSpec/ContextWording:
50
+ inherit_mode:
51
+ merge:
52
+ - Prefixes
53
+ Prefixes:
54
+ - "on"
data/CHANGELOG.md CHANGED
@@ -1,4 +1,7 @@
1
1
  ## [Unreleased]
2
2
 
3
+ ## [1.1.0] - 2025-03-06
4
+ - Loosen version requirement of ruby to 3.2.7
5
+
3
6
  ## [1.0.0] - 2025-02-24
4
7
  - Initial release
data/README.md CHANGED
@@ -1,39 +1,65 @@
1
- # Gemoji::Cli
1
+ # gemoji-cli
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ :construction: **This project is under active development** :construction:
4
4
 
5
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gemoji/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+ A command-line interface for searching and displaying emoji characters from your terminal. Built on top of GitHub's [gemoji](https://github.com/github/gemoji) library, this tool provides an easy way to find and use emojis in your daily terminal work.
6
6
 
7
- ## Installation
7
+ ## Features
8
8
 
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
9
+ - :mag: Search emojis by name, description, or aliases
10
+ - :dart: Exact and fuzzy matching support
11
+ - :computer: Cross-platform support
10
12
 
11
- Install the gem and add to the application's Gemfile by executing:
13
+ ## Installation
12
14
 
13
15
  ```bash
14
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
16
+ gem install gemoji-cli
15
17
  ```
16
18
 
17
- If bundler is not being used to manage dependencies, install the gem by executing:
19
+ ## Usage
20
+
21
+ ### Basic Search
22
+
23
+ Search for emoji by name:
18
24
 
19
25
  ```bash
20
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
26
+ gemoji search smile
21
27
  ```
22
28
 
23
- ## Usage
29
+ This will display all emojis with "smile" in their name, description, or aliases:
30
+
31
+ ```
32
+ 😊 smile - smiling face with smiling eyes
33
+ 😃 smiley - grinning face with big eyes
34
+ 😄 smile_cat - grinning cat with smiling eyes
35
+ ...
36
+ ```
24
37
 
25
- TODO: Write usage instructions here
38
+ ### List All Emojis
39
+
40
+ Display all available emojis:
41
+
42
+ ```bash
43
+ gemoji list
44
+ ```
26
45
 
27
46
  ## Development
28
47
 
29
48
  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
49
 
31
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
50
+ To install this gem onto your local machine, run `bundle exec rake install`.
32
51
 
33
52
  ## Contributing
34
53
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemoji-cli.
54
+ 1. Fork it
55
+ 2. Create your feature branch (`git checkout -b feature/my-new-feature`)
56
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
57
+ 4. Push to the branch (`git push origin feature/my-new-feature`)
58
+ 5. Create a new Pull Request
59
+
60
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sakuro/gemoji-cli.
36
61
 
37
62
  ## License
38
63
 
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
64
+ The gem is available as open source under the terms of the
65
+ [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile CHANGED
@@ -4,6 +4,6 @@ require "bundler/gem_tasks"
4
4
  require "rspec/core/rake_task"
5
5
 
6
6
  RSpec::Core::RakeTask.new(:spec)
7
- Dir["lib/tasks/*.rake"].each { load it }
7
+ Dir["lib/tasks/*.rake"].each {|file| load file }
8
8
 
9
9
  task default: %i[spec rubocop]
data/TODO.md ADDED
@@ -0,0 +1,45 @@
1
+ # Planned Features for gemoji-cli
2
+
3
+ ## Get Command
4
+
5
+ Retrieve a specific emoji in various formats:
6
+
7
+ ```bash
8
+ # Unicode format (default)
9
+ gemoji get smile
10
+ 😊
11
+
12
+ # HTML entity
13
+ gemoji get smile --format html
14
+ 😊
15
+
16
+ # GitHub markdown
17
+ gemoji get smile --format markdown
18
+ :smile:
19
+ ```
20
+
21
+ ## Info Command
22
+
23
+ Display detailed information about a specific emoji:
24
+
25
+ ```bash
26
+ gemoji info smile
27
+ ```
28
+
29
+ Expected output:
30
+ ```
31
+ Name: smile
32
+ Unicode: 😊
33
+ HTML: 😊
34
+ Markdown: :smile:
35
+ Description: smiling face with smiling eyes
36
+ Aliases: ["blush"]
37
+ Tags: ["happy", "joy", "pleased"]
38
+ ```
39
+
40
+ ## Implementation Notes
41
+
42
+ - Both commands should support fuzzy matching for emoji names
43
+ - Format options for `get` command: unicode (default), html, markdown
44
+ - Info command should display all available metadata from the gemoji library
45
+ - Consider adding support for copying the output to clipboard
data/lib/gemoji/cli/version.rb CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Gemoji
4
4
  module CLI
5
- VERSION = "1.0.0"
5
+ VERSION = "1.1.0"
6
6
  public_constant :VERSION
7
7
  end
8
8
  end
data/mise.toml CHANGED
@@ -1,2 +1,5 @@
1
1
  [env]
2
2
  _.path = ["bin", "exe"]
3
+
4
+ [tools]
5
+ ruby = "3.2.7"
metadata CHANGED
@@ -1,13 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gemoji-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OZAWA Sakuro
8
+ autorequire:
8
9
  bindir: exe
9
10
  cert_chain: []
10
- date: 2025-02-24 00:00:00.000000000 Z
11
+ date: 2025-03-06 00:00:00.000000000 Z
11
12
  dependencies:
12
13
  - !ruby/object:Gem::Dependency
13
14
  name: csv
@@ -69,6 +70,7 @@ files:
69
70
  - LICENSE.txt
70
71
  - README.md
71
72
  - Rakefile
73
+ - TODO.md
72
74
  - exe/gemoji
73
75
  - lib/gemoji/cli.rb
74
76
  - lib/gemoji/cli/commands/filter.rb
@@ -86,6 +88,7 @@ metadata:
86
88
  source_code_uri: https://github.com/sakuro/gemoji-cli.git
87
89
  changelog_uri: https://github.com/sakuro/gemoji-cli/blob/main/CHANGELOG.md
88
90
  rubygems_mfa_required: 'true'
91
+ post_install_message:
89
92
  rdoc_options: []
90
93
  require_paths:
91
94
  - lib
@@ -93,14 +96,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
93
96
  requirements:
94
97
  - - ">="
95
98
  - !ruby/object:Gem::Version
96
- version: 3.4.2
99
+ version: 3.2.7
97
100
  required_rubygems_version: !ruby/object:Gem::Requirement
98
101
  requirements:
99
102
  - - ">="
100
103
  - !ruby/object:Gem::Version
101
104
  version: '0'
102
105
  requirements: []
103
- rubygems_version: 3.6.5
106
+ rubygems_version: 3.4.19
107
+ signing_key:
104
108
  specification_version: 4
105
109
  summary: GitHub emoji converter and lister
106
110
  test_files: []