gemoji-cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 259ef6cb27019361b5ba2fde8894af3e7989091af84c38c0ca5294f621610b72
+  data.tar.gz: 7c908ec314daf7646c0b9d18f31149093d13aa0751b0e1470c3a2dbad7ed6851
+SHA512:
+  metadata.gz: 6d23ac895a205c2b768fd427e4b1a426cfd9158d5db64f266a57b9a5ef5223096431ff40876f49a72182bb7ff3e746c39b31bc125471e5414415d2fc53b9a9d9
+  data.tar.gz: dcbaff573657f536b63050c3ed4cb7eb3029e9ebf0182f0a59622fc5c2f3019a85a80c448be47449a9f2eca156dc9dfa6468d9c9d7bcdb0eb0594e22868f7a71

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+---
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  EnabledByDefault: true
+  Exclude:
+  - bin/**/*
+  - vendor/**/*
+  ExtraDetails: true
+  TargetRubyVersion: 3.4
+  UseCache: true
+inherit_mode:
+  merge:
+  - Exclude
+plugins:
+- rubocop-performance
+- rubocop-rake
+- rubocop-rspec
+- rubocop-thread_safety
+require: []
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop/bundler.yml
+  - .rubocop/gemspec.yml
+  - .rubocop/layout.yml
+  - .rubocop/lint.yml
+  - .rubocop/metrics.yml
+  - .rubocop/migration.yml
+  - .rubocop/naming.yml
+  - .rubocop/performance.yml
+  - .rubocop/rspec.yml
+  - .rubocop/rake.yml
+  - .rubocop/security.yml
+  - .rubocop/style.yml
+  - .rubocop/threadsafety.yml
+
+
+Style/DisableCopsWithinSourceCodeDirective:
+  AllowedCops:
+  - Style/MissingElse
+
+Style/DocumentationMethod:
+  inherit_mode:
+    merge:
+    - AllowedMethods
+  AllowedMethods:
+    - call

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --no-exclude-limit --no-offense-counts --no-auto-gen-timestamp`
+# using RuboCop version 1.72.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-02-24
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 OZAWA Sakuro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Gemoji::Cli
+
+TODO: Delete this and the text below, and describe your gem
+
+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.
+
+## Installation
+
+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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gemoji-cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+Dir["lib/tasks/*.rake"].each { load it }
+
+task default: %i[spec rubocop]

data/exe/gemoji

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "gemoji/cli"
+
+Dry::CLI.new(Gemoji::CLI::Commands).call

data/lib/gemoji/cli/commands/filter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gemoji
+  module CLI
+    module Commands
+      # Filter command
+      class Filter < Dry::CLI::Command
+        desc "Read standard input and convert emoji notations to corresponding Unicode sequences"
+
+        def call(*, **)
+          filter($stdin)
+        end
+
+        private def filter(io)
+          io.each_line.map do |line|
+            line.gsub!(/:([\w+-]+):/) do |match|
+              emoji = Emoji.find_by_alias($1)
+              emoji && !emoji.custom? ? emoji.raw : match
+            end
+            print line
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gemoji/cli/commands/list.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "csv"
+require "gemoji"
+
+module Gemoji
+  module CLI
+    module Commands
+      # List command
+      class List < Dry::CLI::Command
+        desc "List all recognized emoji"
+
+        option :format, default: "markdown", values: %w[markdown csv], desc: "Output format"
+
+        HEADINGS = %w[Name Raw].freeze
+        private_constant :HEADINGS
+
+        def call(**options)
+          case options[:format] # rubocop:disable Style/MissingElse
+          when "markdown"
+            list_markdown
+          when "csv"
+            list_csv
+          end
+        end
+
+        private def list_markdown
+          puts "| #{HEADINGS.join(" | ")} |"
+          puts "|------|-----|"
+          Emoji.all.each do |emoji|
+            puts "| :#{emoji.name}: | #{emoji.raw} |"
+          end
+        end
+
+        private def list_csv
+          csv = CSV.generate {|out|
+            out << HEADINGS
+            Emoji.all.each do |emoji|
+              out << [":#{emoji.name}:", emoji.raw]
+            end
+          }
+          puts csv
+        end
+      end
+    end
+  end
+end

data/lib/gemoji/cli/commands/version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Gemoji
+  module CLI
+    module Commands
+      # Version command
+      class Version < Dry::CLI::Command
+        desc "Print the version"
+
+        def call(*, **)
+          puts "#{File.basename($PROGRAM_NAME)} #{Gemoji::CLI::VERSION}"
+        end
+      end
+    end
+  end
+end

data/lib/gemoji/cli/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Gemoji
+  module CLI
+    VERSION = "1.0.0"
+    public_constant :VERSION
+  end
+end

data/lib/gemoji/cli.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "dry/cli"
+require_relative "cli/commands/filter"
+require_relative "cli/commands/list"
+require_relative "cli/commands/version"
+require_relative "cli/version"
+
+module Gemoji
+  module CLI
+    # The command registry for the CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      register "filter", Gemoji::CLI::Commands::Filter
+      register "list", Gemoji::CLI::Commands::List, aliases: ["ls"]
+      register "version", Gemoji::CLI::Commands::Version, aliases: ["v", "-v", "--version"]
+    end
+  end
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.prepend(Module.new do
+  # Additionally define rubocop:regenerate_todo task.
+  def setup_subtasks(name, *, &task_block)
+    super
+    namespace name do
+      desc "Regenerate RuboCop TODO file"
+      task(:regenerate_todo, *) do |_, task_args|
+        RakeFileUtils.verbose(verbose) do
+          yield(*[self, task_args].slice(0, task_block.arity)) if task_block
+          perform("--regenerate-todo")
+        end
+      end
+    end
+  end
+end)
+
+RuboCop::RakeTask.new

data/mise.toml

@@ -0,0 +1,2 @@
+[env]
+_.path = ["bin", "exe"]

data/sig/gemoji/cli.rbs

@@ -0,0 +1,6 @@
+module Gemoji
+  module Cli
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: gemoji-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- OZAWA Sakuro
+bindir: exe
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+description: |
+  A command-line tool that:
+  - Converts GitHub emoji codes to Unicode.
+  - Lists supported emojis in Markdown or CSV format.
+email:
+- 10973+sakuro@users.noreply.github.com
+executables:
+- gemoji
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/gemoji
+- lib/gemoji/cli.rb
+- lib/gemoji/cli/commands/filter.rb
+- lib/gemoji/cli/commands/list.rb
+- lib/gemoji/cli/commands/version.rb
+- lib/gemoji/cli/version.rb
+- lib/tasks/rubocop.rake
+- mise.toml
+- sig/gemoji/cli.rbs
+homepage: https://github.com/sakuro/gemoji-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sakuro/gemoji-cli
+  source_code_uri: https://github.com/sakuro/gemoji-cli.git
+  changelog_uri: https://github.com/sakuro/gemoji-cli/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: GitHub emoji converter and lister
+test_files: []