gimei 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216d95783e46b3cdc2064cd313f95b132c27bac29226303edc8b803fde526331
-  data.tar.gz: 3d2e0e555591948b532d86d53bd7256bc963e33b5eb3e8b9cd4acaa7ba67deb2
+  metadata.gz: 5790029efdd49745df0cae0618b7be59b722ca1fd3041ec0d16458677f176f90
+  data.tar.gz: a6751528cd6333057e08b0bd39cda08cc59a91b768a4f0eff1707087b6c1c0ab
 SHA512:
-  metadata.gz: 9e38714869d50eb7103cec576217cf034f56a353546e6424d8d7e8a0b7db9364d55cd0da3e6ec35c3ea6cc4b77be88773522706c46064232918468597916b646
-  data.tar.gz: 41035cbcb85d036bc177a7b01a494cab298d82c579402c0e560c474cef28d972860aafd1b84bc7e0562471db54810f554f541a1f25fe6e8e13b376b7c9ffad19
+  metadata.gz: 9228724dd0f8bb2695b6555a13d2f338ef331497dd93140d932a3033a4830544b7e5d2ba05525714d2fb70a764377b1e0b397cb60df5627dbffb13fcd4b15044
+  data.tar.gz: 819cfbcbdd87a6219595a109b1d16e41a7f21e45b4b939cbdda944752148c89d593ab3e2d8500c3459a8fd6bd935abaa56903b661692aa64a0626ca54cc19075

data/.github/workflows/test.yml

@@ -20,41 +20,18 @@ jobs:
       fail-fast: false
 
       matrix:
-        ruby:
-          - ruby:2.2
-          - ruby:2.3
-          - ruby:2.4
-          - ruby:2.5
-          - ruby:2.6
-          - ruby:2.7
-          - ruby:3.0
-          - ruby:3.1
-          - ruby:3.2
-          - rubylang/ruby:master-jammy
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', 'head']
         include:
-          - ruby: rubylang/ruby:master-jammy
-            allow_failures: "true"
+          - ruby-version: 'head'
+            allow_failures: 'true'
 
     steps:
-      - uses: actions/checkout@v3
-
-      - name: Cache vendor/bundle
-        uses: actions/cache@v3
-        id: cache_gem
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          path: vendor/bundle
-          key: v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ github.sha }}
-          restore-keys: |
-            v1-gem-${{ runner.os }}-${{ matrix.ruby }}-
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
-
-      - name: bundle update
-        run: |
-          set -xe
-          bundle config path vendor/bundle
-          bundle update --jobs $(nproc) --retry 3
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
-
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
       - name: Run test
         run: |
           set -xe
@@ -63,3 +40,15 @@ jobs:
 
       - name: Coveralls
         uses: coverallsapp/github-action@v2
+
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+      - name: Run type check
+        run: bundle exec steep check --with-expectations

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+https://github.com/willnet/gimei/releases に移行しました
+
 ## 1.1.0
 
 - Gimei::Name#family, #given を追加 [@nard-tech](https://github.com/nard-tech) (https://github.com/willnet/gimei/pull/50)

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gimei.gemspec
 gemspec
 gem 'simplecov', require: false
+gem 'steep', require: false

data/README.md

@@ -238,7 +238,6 @@ Gimei.address.kanji #=> "熊本県日進市東場内"
 
 ## Supported versions
 
-- 2.2.x
 - 2.3.x
 - 2.4.x
 - 2.5.x
@@ -247,6 +246,7 @@ Gimei.address.kanji #=> "熊本県日進市東場内"
 - 3.0.x
 - 3.1.x
 - 3.2.x
+- 3.3.x
 
 ## 他言語による実装
 
@@ -255,7 +255,7 @@ Gimei.address.kanji #=> "熊本県日進市東場内"
 - Emacs Lisp [gongo/emacs-gimei](https://github.com/gongo/emacs-gimei)
 - Go         [mattn/go-gimei](https://github.com/mattn/go-gimei)
 - Java       [moznion/gimei-java](https://github.com/moznion/gimei-java)
-- Node.js    [demiglacesource/node-gimei](https://github.com/demiglacesource/node-gimei)
+- Node.js    [sabakan404/node-gimei](https://github.com/sabakan404/node-gimei)
 - Perl       [youpong/Data-Gimei](https://github.com/youpong/Data-Gimei)
 - Python     [nabetama/gimei](https://github.com/nabetama/gimei)
 - TypeScript [abcb2/type-gimei](https://github.com/abcb2/type-gimei)

data/Steepfile

@@ -0,0 +1,13 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library "forwardable"
+  library "yaml"
+
+  configure_code_diagnostics(D::Ruby.strict)
+end
+

data/lib/gimei/address.rb

@@ -43,7 +43,7 @@ class Gimei::Address
     end
 
     def initialize
-      @prefectures = Gimei.addresses['addresses']['prefecture'].sample(random: Gimei.config.rng)
+      @prefectures = Gimei.addresses['addresses']['prefecture'].sample(random: Gimei.config.rng) #: [String, String, String]
     end
 
     alias_method :to_s, :kanji
@@ -67,7 +67,7 @@ class Gimei::Address
     end
 
     def initialize
-      @cities = Gimei.addresses['addresses']['city'].sample(random: Gimei.config.rng)
+      @cities = Gimei.addresses['addresses']['city'].sample(random: Gimei.config.rng) #: [String, String, String]
     end
 
     alias_method :to_s, :kanji
@@ -91,7 +91,7 @@ class Gimei::Address
     end
 
     def initialize
-      @towns = Gimei.addresses['addresses']['town'].sample(random: Gimei.config.rng)
+      @towns = Gimei.addresses['addresses']['town'].sample(random: Gimei.config.rng) #: [String, String, String]
     end
 
     alias_method :to_s, :kanji

data/lib/gimei/name.rb

@@ -15,14 +15,16 @@ class Gimei::Name
     end
 
     %i[kanji hiragana katakana romaji first last family given].each do |method_name|
-      define_method(method_name) do |gender = nil|
-        new(gender).public_send(method_name)
-      end
+      class_eval(<<~METHOD, __FILE__, __LINE__ + 1)
+        def #{method_name}(gender = nil)
+          new(gender).#{method_name}
+        end
+      METHOD
     end
   end
 
   def initialize(gender = nil)
-    @gender = gender || Gimei::GENDERS.sample(random: Gimei.config.rng)
+    @gender = gender || Gimei::GENDERS.sample(random: Gimei.config.rng) #: :male | :female
     @first = First.new @gender
     @last = Last.new
   end
@@ -71,7 +73,7 @@ class Gimei::Name
     def_delegators :@name, :kanji, :hiragana, :katakana, :to_s, :romaji
 
     def initialize(gender = nil)
-      @gender = gender || Gimei::GENDERS.sample(random: Gimei.config.rng)
+      @gender = gender || Gimei::GENDERS.sample(random: Gimei.config.rng) #: :male | :female
       @name = NameWord.new(Gimei.names['first_name'][@gender.to_s].sample(random: Gimei.config.rng))
     end
 
@@ -89,7 +91,8 @@ class Gimei::Name
     def_delegators :@name, :kanji, :hiragana, :katakana, :to_s, :romaji
 
     def initialize
-      @name = NameWord.new(Gimei.names['last_name'].sample(random: Gimei.config.rng))
+      name = Gimei.names['last_name'].sample(random: Gimei.config.rng) #: [String, String, String]
+      @name = NameWord.new(name)
     end
   end
 

data/lib/gimei/version.rb

@@ -1,3 +1,3 @@
 class Gimei
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/gimei.rb

@@ -9,7 +9,7 @@ require 'gimei/config'
 class Gimei
   extend Forwardable
 
-  GENDERS = [:male, :female].freeze
+  GENDERS = [:male, :female].freeze #: [:male, :female]
 
   def_delegators :@name,
                  :first, :last, :gender,
@@ -24,7 +24,7 @@ class Gimei
   class << self
     extend Forwardable
 
-    def_delegators Gimei::Name, :male, :female
+    def_delegators 'Gimei::Name', :male, :female
     def_delegators :address, :prefecture, :city, :town
 
     def name(gender = nil)
@@ -40,9 +40,11 @@ class Gimei
     end
 
     %i[kanji hiragana katakana romaji first last family given].each do |method_name|
-      define_method(method_name) do |gender = nil|
-        name(gender).public_send(method_name)
-      end
+      class_eval(<<~METHOD, __FILE__, __LINE__ + 1)
+        def #{method_name}(gender = nil)
+          new(gender).#{method_name}
+        end
+       METHOD
     end
 
     def address

data/sig/gimei/address.rbs

@@ -0,0 +1,42 @@
+class Gimei
+  class Address
+    attr_reader prefecture: Prefecture
+    attr_reader city: City
+    attr_reader town: Town
+    def initialize: -> void
+    def kanji: -> String
+    def hiragana: -> String
+    def katakana: -> String
+    def romaji: -> String
+
+    class Prefecture
+      @prefectures: [String, String, String]
+
+      def kanji: -> String
+      def hiragana: -> String
+      def katakana: -> String
+      def romaji: -> String
+      def initialize: -> void
+    end
+
+    class City
+      @cities: [String, String, String]
+
+      def kanji: -> String
+      def hiragana: -> String
+      def katakana: -> String
+      def romaji: -> String
+      def initialize: -> void
+    end
+
+    class Town
+      @towns: [String, String, String]
+
+      def kanji: -> String
+      def hiragana: -> String
+      def katakana: -> String
+      def romaji: -> String
+      def initialize: -> void
+    end
+  end
+end

data/sig/gimei/config.rbs

@@ -0,0 +1,6 @@
+class Gimei
+  class Config
+    attr_accessor rng: singleton(Random)
+    def initialize: (?rng: singleton(Random)) -> void
+  end
+end

data/sig/gimei/name.rbs

@@ -0,0 +1,58 @@
+class Gimei
+  class Name
+    attr_reader first: First
+    attr_reader last: Last
+    attr_reader gender: gender_type
+    def self.male: -> Name
+    def self.female: -> Name
+    def initialize: (?(gender_type)? gender) -> void
+    def kanji: -> String
+    def hiragana: -> String
+    def katakana: -> String
+    def romaji: -> String
+    def male?: -> bool
+    def female?: -> bool
+    alias family last
+    alias given first
+
+    class First
+      extend Forwardable
+      @gender: gender_type
+      @name: NameWord
+
+      def self.male: -> First
+      def self.female: -> First
+      def initialize: (?(gender_type)? gender) -> void
+      def kanji: -> String
+      def hiragana: -> String
+      def katakana: -> String
+      def to_s: -> String
+      def romaji: -> String
+      def male?: -> bool
+      def female?: -> bool
+    end
+
+    class Last
+      extend Forwardable
+      @gender: gender_type
+      @name: NameWord
+
+      def initialize: -> void
+      def kanji: -> String
+      def hiragana: -> String
+      def katakana: -> String
+      def to_s: -> String
+      def romaji: -> String
+    end
+
+    class NameWord
+      @name: [String, String, String]
+
+      def initialize: ([String, String, String] name) -> void
+      def kanji: -> String
+      def hiragana: -> String
+      def katakana: -> String
+      def romaji: -> String
+    end
+  end
+end

data/sig/gimei/romaji.rbs

@@ -0,0 +1,4 @@
+module Romaji
+  def self.romaji2kana: (String, Hash[Symbol, Symbol]?) -> String
+  def self.kana2romaji: (String) -> String
+end

data/sig/gimei/unique_generator.rbs

@@ -0,0 +1,23 @@
+class Gimei
+  class RetryLimitExceeded < StandardError
+  end
+
+  class UniqueGenerator
+    self.@previous_results: Hash[Symbol, Set[String]]
+
+    def self.previous_results: -> Hash[Symbol, Set[String]]
+    def initialize: (Class klass, Integer max_retries) -> void
+    def previous_results: -> Hash[Symbol, Set[String]]
+    def clear: (?Symbol? key) -> void
+    def define_unique_method: (Symbol method_name, ?Symbol previous_result_key) -> Symbol
+    def name: -> Name
+    def first: -> Name::First
+    def last: -> Name::Last
+    alias family last
+    alias given first
+
+    private
+    attr_reader klass: Class
+    attr_reader max_retries: Integer
+  end
+end

data/sig/gimei/version.rbs

@@ -0,0 +1,3 @@
+class Gimei
+  VERSION: String
+end

data/sig/gimei.rbs

@@ -0,0 +1,30 @@
+class Gimei
+  type gender_type = :female | :male
+
+  GENDERS: [:male, :female]
+  extend Forwardable
+  self.@names: untyped # (Hash['first_name', Hash[('male' | 'female'), Array[[String, String, String]]]] | Hash['last_name', Array[[String, String, String]]])
+  self.@addresses: Hash['addresses', Hash[('prefecture' | 'city' | 'town'), [String, String, String]]]
+  self.@unique: UniqueGenerator
+  self.@config: Config
+
+  attr_reader name: Name
+  attr_reader address: Address
+  def self.male: -> Name
+  def self.female: -> Name
+  def self.name: (?gender_type? gender) -> Name
+  def self.names: -> untyped # (Hash['first_name', Hash[('male' | 'female'), Array[[String, String, String]]]] | Hash['last_name', Array[[String, String, String]]])
+  def self.addresses: -> Hash['addresses', Hash[('prefecture' | 'city' | 'town'), Array[[String, String, String]]]]
+  def self.kanji: -> String
+  def self.hiragana: -> String
+  def self.katakana: -> String
+  def self.romaji: -> String
+  def self.first: -> Name::First
+  def self.last: -> Name::Last
+  def self.address: -> Address
+  def self.unique: (?Integer max_retries) -> UniqueGenerator
+  def self.config: -> Config
+  def initialize: (?gender_type? gender) -> void
+  alias self.family self.last
+  alias self.given self.first
+end

data/steep_expectations.yml

@@ -0,0 +1,23 @@
+---
+- file: lib/gimei.rb
+  diagnostics:
+  - range:
+      start:
+        line: 27
+        character: 4
+      end:
+        line: 27
+        character: 18
+    severity: ERROR
+    message: Type `singleton(::Class)` does not have method `def_delegators`
+    code: Ruby::NoMethod
+  - range:
+      start:
+        line: 28
+        character: 4
+      end:
+        line: 28
+        character: 18
+    severity: ERROR
+    message: Type `singleton(::Class)` does not have method `def_delegators`
+    code: Ruby::NoMethod

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gimei
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - willnet
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2024-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: romaji
@@ -67,6 +67,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - _config.yml
 - gimei.gemspec
 - lib/data/addresses.yml
@@ -77,11 +78,19 @@ files:
 - lib/gimei/name.rb
 - lib/gimei/unique_generator.rb
 - lib/gimei/version.rb
+- sig/gimei.rbs
+- sig/gimei/address.rbs
+- sig/gimei/config.rbs
+- sig/gimei/name.rbs
+- sig/gimei/romaji.rbs
+- sig/gimei/unique_generator.rbs
+- sig/gimei/version.rbs
 - spec/address_spec.rb
 - spec/gimei_spec.rb
 - spec/name_spec.rb
 - spec/spec_helper.rb
 - spec/unique_spec.rb
+- steep_expectations.yml
 homepage: https://github.com/willnet/gimei
 licenses:
 - MIT
@@ -101,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: random Japanese name and address generator. support kanji, hiragana, and