etoji 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9221749c7d4b81d689b5374d482a46f50b9c0b362b8e33864871bcadfc9ecf9
-  data.tar.gz: f8eeb9b427ec6a1be88811019ec245bf680579a2549e1fe3236928580596f7f6
+  metadata.gz: afd0c2d37f817f5949e3a7741963b706ab949db07a7fb73f2e36526d8942dd04
+  data.tar.gz: ac4ebdb09514199ede54c8be287d27a837f6531ba01e6980e73ed4cebeceef22
 SHA512:
-  metadata.gz: 4034b814a166c7ec57eb1414d9e01b2f861b1003ca5ca817a6dbb42b29e312115ac2fcf6c3b8a512e74ad625e720e78f86070e4df63c08b2b6cbfda9c38c183b
-  data.tar.gz: fa6f6777389c7e2a4dd9b837041ffb13527eaf7d43e4fac9663a8234f00881101f029f8109240e6264e922ca7e05b307cc184da325d27827d6df982a84a2ed56
+  metadata.gz: d3d7bd8f402ce06b70782dad76f0f29d6260b35eab0d03609ac9be96a73365229eb91fbff3facfa3fd2766f098db67408c7c019be7463cdbc37c5fa095a71102
+  data.tar.gz: 7f63e67f25db88352b044f13f462f0895dd2b7cdc040db6f2e0f717320a975f367c26da7155f170baf43f3ecf5b0f5db01fd10baa44deb0f0f915be456396449

data/.github/workflows/typecheck.yml

@@ -0,0 +1,28 @@
+name: typecheck
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.2.0'
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run steep check
+      run: bundle exec steep check

data/Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in etoji.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
+gem "rake"
+gem "rspec"
+gem "rbs", require: false
+gem "steep", require: false

data/README.md

@@ -1,6 +1,6 @@
 # Etoji
 
-[![test](https://github.com/MITSUBOSHI/etoji/actions/workflows/test.yml/badge.svg)](https://github.com/MITSUBOSHI/etoji/actions/workflows/test.yml)
+[![test](https://github.com/MITSUBOSHI/etoji/actions/workflows/test.yml/badge.svg)](https://github.com/MITSUBOSHI/etoji/actions/workflows/test.yml)[![typecheck](https://github.com/MITSUBOSHI/etoji/actions/workflows/typecheck.yml/badge.svg)](https://github.com/MITSUBOSHI/etoji/actions/workflows/typecheck.yml)
 
 
 Simple 干支(eto) library
@@ -15,7 +15,8 @@ Etoji.geto(year: 2023)
 #  number=4,
 #  emoji="🐰",
 #  character="卯",
-#  character_hiragana="う",
+#  character_hiragana_kun="う",
+#  character_hiragana_on="ぼう",
 #  animal_name_ja="兎",
 #  animal_name_ja_hiragana="うさぎ",
 #  animal_name_en="rabbit">

data/Steepfile

@@ -0,0 +1,21 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library(
+    "json"
+  )
+
+  # NOTE: Unexpected error occured like below.
+  # lib/etoji.rb:16:4: [error] Syntax `case_match` is not supported in Steep
+  # │ Diagnostic ID: Ruby::UnsupportedSyntax
+  # │
+  # └     case [with_prev, with_next]
+  #       ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  configure_code_diagnostics do |hash|
+    hash[D::Ruby::UnsupportedSyntax] = :information
+  end
+end

data/db/jyunishi.json

@@ -3,7 +3,8 @@
     "number": 1,
     "emoji": "🐭",
     "character": "子",
-    "character_hiragana": "ね",
+    "character_hiragana_kun": "ね",
+    "character_hiragana_on": "し",
     "animal_name": {
       "ja": "鼠",
       "ja_hiragana": "ねずみ",
@@ -14,7 +15,8 @@
     "number": 2,
     "emoji": "🐮",
     "character": "丑",
-    "character_hiragana": "うし",
+    "character_hiragana_kun": "うし",
+    "character_hiragana_on": "ちゅう",
     "animal_name": {
       "ja": "牛",
       "ja_hiragana": "うし",
@@ -25,7 +27,8 @@
     "number": 3,
     "emoji": "🐯",
     "character": "寅",
-    "character_hiragana": "とら",
+    "character_hiragana_kun": "とら",
+    "character_hiragana_on": "いん",
     "animal_name": {
       "ja": "虎",
       "ja_hiragana": "とら",
@@ -36,7 +39,8 @@
     "number": 4,
     "emoji": "🐰",
     "character": "卯",
-    "character_hiragana": "う",
+    "character_hiragana_kun": "う",
+    "character_hiragana_on": "ぼう",
     "animal_name": {
       "ja": "兎",
       "ja_hiragana": "うさぎ",
@@ -47,7 +51,8 @@
     "number": 5,
     "emoji": "🐲",
     "character": "辰",
-    "character_hiragana": "たつ",
+    "character_hiragana_kun": "たつ",
+    "character_hiragana_on": "しん",
     "animal_name": {
       "ja": "龍",
       "ja_hiragana": "りゅう",
@@ -58,7 +63,8 @@
     "number": 6,
     "emoji": "🐍",
     "character": "巳",
-    "character_hiragana": "たつ",
+    "character_hiragana_kun": "み",
+    "character_hiragana_on": "し",
     "animal_name": {
       "ja": "蛇",
       "ja_hiragana": "へび",
@@ -69,7 +75,8 @@
     "number": 7,
     "emoji": "🐴",
     "character": "午",
-    "character_hiragana": "うま",
+    "character_hiragana_kun": "うま",
+    "character_hiragana_on": "ご",
     "animal_name": {
       "ja": "馬",
       "ja_hiragana": "うま",
@@ -80,7 +87,8 @@
     "number": 8,
     "emoji": "🐏",
     "character": "未",
-    "character_hiragana": "ひつじ",
+    "character_hiragana_kun": "ひつじ",
+    "character_hiragana_on": "び",
     "animal_name": {
       "ja": "羊",
       "ja_hiragana": "ひつじ",
@@ -91,7 +99,8 @@
     "number": 9,
     "emoji": "🐵",
     "character": "申",
-    "character_hiragana": "さる",
+    "character_hiragana_kun": "さる",
+    "character_hiragana_on": "しん",
     "animal_name": {
       "ja": "猿",
       "ja_hiragana": "さる",
@@ -102,7 +111,8 @@
     "number": 10,
     "emoji": "🐔",
     "character": "酉",
-    "character_hiragana": "とり",
+    "character_hiragana_kun": "とり",
+    "character_hiragana_on": "ゆう",
     "animal_name": {
       "ja": "鶏",
       "ja_hiragana": "にわとり",
@@ -113,7 +123,8 @@
     "number": 11,
     "emoji": "🐶",
     "character": "戌",
-    "character_hiragana": "いぬ",
+    "character_hiragana_kun": "いぬ",
+    "character_hiragana_on": "じゅつ",
     "animal_name": {
       "ja": "犬",
       "ja_hiragana": "いぬ",
@@ -124,7 +135,8 @@
     "number": 12,
     "emoji": "🐗",
     "character": "亥",
-    "character_hiragana": "い",
+    "character_hiragana_kun": "い",
+    "character_hiragana_on": "がい",
     "animal_name": {
       "ja": "猪",
       "ja_hiragana": "いのしし",

data/etoji.gemspec

@@ -26,9 +26,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency 'json'
 end

data/lib/etoji/jikkan.rb

@@ -4,9 +4,9 @@ require 'json'
 module Etoji
   module Jikkan
     class NotFound < StandardError; end
+    class Kan < ::Data.define(:number, :character, :character_hiragana_on, :character_hiragana_kun); end
 
     SOURCE_FILE_PATH = File.expand_path('../../../db/jikkan.json', __FILE__)
-    Kan = ::Data.define(:number, :character, :character_hiragana_on, :character_hiragana_kun)
     MEMBERS = JSON.parse(File.read(SOURCE_FILE_PATH), symbolize_names: true).map { |attributes|
       Kan.new(
         number: attributes[:number],

data/lib/etoji/jyunishi.rb

@@ -4,15 +4,16 @@ require 'json'
 module Etoji
   module Jyunishi
     class NotFound < StandardError; end
+    class Animal < ::Data.define(:number, :emoji, :character, :character_hiragana_kun, :character_hiragana_on, :animal_name_ja, :animal_name_ja_hiragana, :animal_name_en); end
 
     SOURCE_FILE_PATH = File.expand_path('../../../db/jyunishi.json', __FILE__)
-    Animal = ::Data.define(:number, :emoji, :character, :character_hiragana, :animal_name_ja, :animal_name_ja_hiragana, :animal_name_en)
     MEMBERS = JSON.parse(File.read(SOURCE_FILE_PATH), symbolize_names: true).map { |attributes|
       Animal.new(
         number: attributes[:number],
         emoji: attributes[:emoji],
         character: attributes[:character],
-        character_hiragana: attributes[:character_hiragana],
+        character_hiragana_kun: attributes[:character_hiragana_kun],
+        character_hiragana_on: attributes[:character_hiragana_on],
         animal_name_ja: attributes.dig(:animal_name, :ja),
         animal_name_ja_hiragana: attributes.dig(:animal_name, :ja_hiragana),
         animal_name_en: attributes.dig(:animal_name, :en)

data/lib/etoji/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Etoji
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/etoji.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "etoji/version"
-require "etoji/jikkan"
-require "etoji/jyunishi"
+require_relative "etoji/version"
+require_relative "etoji/jikkan"
+require_relative "etoji/jyunishi"
 
 module Etoji
   class Error < StandardError; end

data/sig/lib/etoji/jikkan.rbs

@@ -0,0 +1,22 @@
+module Etoji
+  module Jikkan
+    SOURCE_FILE_PATH: String
+    MEMBERS: Array[Kan]
+    self.@kans_by_number: Hash[Integer, Kan]
+
+    def self.all: -> Array[Kan]
+    def self.find_by_number: (Integer) -> Kan
+
+    class Kan
+      attr_reader number: Integer
+      attr_reader character: String
+      attr_reader character_hiragana_on: String
+      attr_reader character_hiragana_kun: String
+
+      def initialize: (number: Integer, character: String, character_hiragana_on: String, character_hiragana_kun: String) -> void
+    end
+
+    class NotFound < StandardError
+    end
+  end
+end

data/sig/lib/etoji/jyunishi.rbs

@@ -0,0 +1,26 @@
+module Etoji
+  module Jyunishi
+    SOURCE_FILE_PATH: String
+    MEMBERS: Array[Animal]
+    self.@animals_by_number: Hash[Integer, Animal]
+
+    def self.all: -> Array[Animal]
+    def self.find_by_number: (Integer) -> Animal
+
+    class Animal
+      attr_reader number: Integer
+      attr_reader emoji: String
+      attr_reader character: String
+      attr_reader character_hiragana_on: String
+      attr_reader character_hiragana_kun: String
+      attr_reader animal_name_ja: String
+      attr_reader animal_name_ja_hiragana: String
+      attr_reader animal_name_en: String
+
+      def initialize: (number: Integer, emoji: String, character: String, character_hiragana_on: String, character_hiragana_kun: String, animal_name_ja: String, animal_name_ja_hiragana: String, animal_name_en: String) -> void
+    end
+
+    class NotFound < StandardError
+    end
+  end
+end

data/sig/lib/etoji/version.rbs

@@ -0,0 +1,3 @@
+module Etoji
+  VERSION: String
+end

data/sig/lib/etoji.rbs

@@ -0,0 +1,11 @@
+module Etoji
+  class Error < StandardError
+  end
+
+  def self.geto: (year: Integer|String, ?with_prev: false, ?with_next: false) -> Jyunishi::Animal
+    | (year: Integer|String, with_prev: true, ?with_next: bool) -> Array[Jyunishi::Animal]
+    | (year: Integer|String, ?with_prev: bool, with_next: true) -> Array[Jyunishi::Animal]
+  def self.geto_full_string: (year: Integer|String) -> String
+
+  def self.convert_year: (Integer|String) -> Integer
+end

data/sig/patch/data.rbs

@@ -0,0 +1,3 @@
+class Data
+  def self.define: (*untyped) -> untyped
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: etoji
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - mitsubosh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
-dependencies: []
+date: 2023-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple 干支(eto) library
 email:
 - yuya.mitsuboshi@gmail.com
@@ -18,12 +32,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
+- ".github/workflows/typecheck.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
 - bin/setup
 - db/jikkan.json
@@ -34,6 +50,11 @@ files:
 - lib/etoji/jikkan.rb
 - lib/etoji/jyunishi.rb
 - lib/etoji/version.rb
+- sig/lib/etoji.rbs
+- sig/lib/etoji/jikkan.rbs
+- sig/lib/etoji/jyunishi.rbs
+- sig/lib/etoji/version.rbs
+- sig/patch/data.rbs
 homepage: https://github.com/MITSUBOSHI/etoji
 licenses:
 - MIT