miyabi 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4cce51bc6a0dd5533d754d2df91cb70b79bacf43fef0d8bb543894931118a9
-  data.tar.gz: 5523168b8206d1fa59601abb7ce23c5886de7b5948fa0820dac28c96a5b4570f
+  metadata.gz: 1103a78e1af969ad03b878f820fb9a7f0d9363dbe29aff68b7540dc1e7ff3949
+  data.tar.gz: 16371b54fef10e351692081b844b5d03c527526acd876f6a9d80afa36d20ba25
 SHA512:
-  metadata.gz: 1acb6a56705b8f019171b624c1f68b78a2328118e0726cb054f10f19084c053f19722f65a0fc88b474a51e6c36b5cb22b36f193655a4f4049a8b10bd8c6241b7
-  data.tar.gz: 56c8c59c54ef513ffee048bd4342b79e7e4847b74ef639a11fe2613a53ba519ce96f7e45f3080e3abe5fe308579dc2ed40be621c24e275aec89727c43c017f42
+  metadata.gz: b9141239952ac1a220b140a480c4a600a6ced23568128468384ca6a1be12fbcf02987243ca7b96268925b44588220504a056e4261b1a573dd78a47ee675d2810
+  data.tar.gz: db3caac3764db0c5bc5811d667a893f2a529a31c40f1aeef71c996c489f636ea0767d473e20b84df31ffae875df3f0b802e5813e12b4a9f43c5ff241c63a5cae

data/.envrc

@@ -0,0 +1,2 @@
+watch_file manifest.scm
+use guix

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+/sig/miyabi.gen.rbs

data/.rubocop_todo.yml

@@ -1,21 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-05-13 02:36:18 UTC using RuboCop version 1.50.2.
+# on 2024-11-13 10:06:34 UTC using RuboCop version 1.48.1.
 # 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.
 
 # Offense count: 5
-# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
-# NamePrefix: is_, has_, have_
-# ForbiddenPrefixes: is_, has_, have_
-# AllowedMethods: is_a?
-# MethodDefinitionMacros: define_method, define_singleton_method
-Naming/PredicateName:
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterGuardClause:
   Exclude:
-    - 'spec/**/*'
-    - 'lib/check.rb'
+    - 'lib/miyabi/check_string.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 145
 
 # Offense count: 3
 # Configuration parameters: AllowedConstants.
@@ -23,6 +23,6 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-    - 'lib/check.rb'
-    - 'lib/format.rb'
     - 'lib/miyabi.rb'
+    - 'lib/miyabi/check_string.rb'
+    - 'lib/miyabi/format_string.rb'

data/CHANGELOG.md

@@ -9,6 +9,23 @@ The format is based on [Keep a Changelog][cl], and this project adheres to [Sema
 
 ## [Unreleased]
 
+## 0.3.1
+
+This is a maintenance release.
+
+* Lint source codes.
+* Add RBS file.
+
+## [0.3.0]
+
+### Added
+
+* method aliases: `hiragana?`, `hira?`, `japanese?`, `katakana?`, `kanji?`, `roman?`, `to_katakana?`, and `to_hiragana`.
+
+### Others
+
+* Add GNU Guix support.
+
 ## [0.2.1]
 
 ### Fixed

data/README.md

@@ -49,6 +49,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+If you use the GNU Guix, `guix shell` to enter the development environment, then `rake` to run tests.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/h-akaishi/miyabi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -4,3 +4,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+task :gensig do
+  sh 'typeprof', '-r', 'nokogiri', '-o', 'sig/miyabi.gen.rbs', 'sig/miyabi.rbs', *Dir['lib/**/*.rb']
+end

data/lib/check.rb

@@ -1,4 +1,4 @@
-require_relative "miyabi/check_string"
+require_relative 'miyabi/check_string'
 
 class String
   include ::Miyabi::CheckString

data/lib/format.rb

@@ -1,4 +1,4 @@
-require_relative "miyabi/format_string"
+require_relative 'miyabi/format_string'
 
 class String
   include ::Miyabi::FormatString

data/lib/miyabi/check_string.rb

@@ -1,28 +1,39 @@
 module Miyabi
   module CheckString
-    def is_hira?
+    def hiragana?
       return true if self =~ /\p{hiragana}/
       false
     end
 
-    def is_japanese?
+    alias is_hira? hiragana?
+    alias hira? hiragana?
+
+    def japanese?
       return true if self =~ /\A(?:\p{Hiragana}|\p{Katakana}|[ー－]|[一-龠々])+\z/
       false
     end
 
-    def is_kana?
+    alias is_japanese? japanese?
+
+    def katakana?
       return true if self =~ /\p{katakana}/
       false
     end
 
-    def is_kanji?
+    alias is_kana? katakana?
+
+    def kanji?
       return true if self =~ /^[一-龥]+$/
       false
     end
 
-    def is_roman?
+    alias is_kanji? kanji?
+
+    def roman?
       return true if self =~ /^[a-zA-Z]+$/
       false
     end
+
+    alias is_roman? roman?
   end
 end

data/lib/miyabi/format_string.rb

@@ -12,13 +12,17 @@ module Miyabi
     end
 
     def to_kana
-      self.tr('ぁ-ん','ァ-ン')
+      tr('ぁ-ん', 'ァ-ン')
     end
 
+    alias to_katakana to_kana
+
     def to_hira
-      self.tr('ァ-ン','ぁ-ん')
+      tr('ァ-ン', 'ぁ-ん')
     end
 
+    alias to_hiragana to_hira
+
     def to_roman
       s = to_kana
       KATAKANA_TO_ROMAN_MAPPING.each do |kana, roman|
@@ -147,7 +151,7 @@ module Miyabi
         'ペ' => 'pe',
         'ポ' => 'po',
         'ヴ' => 'vu',
-        'ー' => '-',
+        'ー' => '-'
       }
 
     private_constant :KATAKANA_TO_ROMAN_MAPPING

data/lib/miyabi/version.rb

@@ -1,3 +1,3 @@
 module Miyabi
-  VERSION = '0.2.1'
+  VERSION = '0.3.1'
 end

data/manifest.scm

@@ -0,0 +1,11 @@
+(use-modules (guix packages)
+             (gnu packages ruby))
+
+(define-public ruby-nokogiri'
+  (package
+   (inherit ruby-nokogiri)
+   (arguments
+    (cons* #:ruby ruby-3.2
+           (package-arguments ruby-nokogiri)))))
+
+(packages->manifest (list ruby-nokogiri' ruby-rspec ruby-3.2 ruby-rubocop))

data/sig/miyabi.rbs

@@ -0,0 +1,36 @@
+# TypeProf 0.21.3
+
+# Classes
+class String
+  include Miyabi::FormatString
+  include Miyabi::CheckString
+end
+
+module Miyabi
+  VERSION: String
+
+  module CheckString
+    def hiragana?: -> bool
+    alias is_hira? hiragana?
+    alias hira? hiragana?
+    def japanese?: -> bool
+    alias is_japanese? japanese?
+    def katakana?: -> bool
+    alias is_kana? katakana?
+    def kanji?: -> bool
+    alias is_kanji? kanji?
+    def roman?: -> bool
+    alias is_roman? roman?
+  end
+
+  module FormatString
+    KATAKANA_TO_ROMAN_MAPPING: Hash[String, String]
+
+    def to_kanhira: -> String
+    def to_kana: -> String
+    alias to_katakana to_kana
+    def to_hira: -> String
+    alias to_hiragana to_hira
+    def to_roman: -> String
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miyabi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Hironori Akaishi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-17 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -64,7 +65,9 @@ files:
 - lib/miyabi/check_string.rb
 - lib/miyabi/format_string.rb
 - lib/miyabi/version.rb
+- manifest.scm
 - miyabi.gemspec
+- sig/miyabi.rbs
 homepage: https://github.com/isy/miyabi
 licenses:
 - MIT
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: kana,hira,kanji formatter