etoji 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9221749c7d4b81d689b5374d482a46f50b9c0b362b8e33864871bcadfc9ecf9
+  data.tar.gz: f8eeb9b427ec6a1be88811019ec245bf680579a2549e1fe3236928580596f7f6
+SHA512:
+  metadata.gz: 4034b814a166c7ec57eb1414d9e01b2f861b1003ca5ca817a6dbb42b29e312115ac2fcf6c3b8a512e74ad625e720e78f86070e4df63c08b2b6cbfda9c38c183b
+  data.tar.gz: fa6f6777389c7e2a4dd9b837041ffb13527eaf7d43e4fac9663a8234f00881101f029f8109240e6264e922ca7e05b307cc184da325d27827d6df982a84a2ed56

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: test
+
+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 the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.ruby-version
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in etoji.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 mitsubosh
+
+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,32 @@
+# Etoji
+
+[![test](https://github.com/MITSUBOSHI/etoji/actions/workflows/test.yml/badge.svg)](https://github.com/MITSUBOSHI/etoji/actions/workflows/test.yml)
+
+
+Simple 干支(eto) library
+
+## Usage
+
+```ruby
+require 'etoji'
+Etoji.geto(year: 2023)
+
+# => #<data Etoji::Jyunishi::Animal
+#  number=4,
+#  emoji="🐰",
+#  character="卯",
+#  character_hiragana="う",
+#  animal_name_ja="兎",
+#  animal_name_ja_hiragana="うさぎ",
+#  animal_name_en="rabbit">
+```
+
+```ruby
+require 'etoji'
+Etoji.geto_full_string(year: 2023)
+# => "癸卯"
+```
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "etoji"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db/jikkan.json

@@ -0,0 +1,62 @@
+[
+  {
+    "number": 1,
+    "character": "甲",
+    "character_hiragana_on": "こう",
+    "character_hiragana_kun": "きのえ"
+  },
+  {
+    "number": 2,
+    "character": "乙",
+    "character_hiragana_on": "おつ",
+    "character_hiragana_kun": "きのと"
+  },
+  {
+    "number": 3,
+    "character": "丙",
+    "character_hiragana_on": "へい",
+    "character_hiragana_kun": "ひのえ"
+  },
+  {
+    "number": 4,
+    "character": "丁",
+    "character_hiragana_on": "てい",
+    "character_hiragana_kun": "ひのと"
+  },
+  {
+    "number": 5,
+    "character": "戊",
+    "character_hiragana_on": "ぼ",
+    "character_hiragana_kun": "つちのえ"
+  },
+  {
+    "number": 6,
+    "character": "己",
+    "character_hiragana_on": "き",
+    "character_hiragana_kun": "つちのと"
+  },
+  {
+    "number": 7,
+    "character": "庚",
+    "character_hiragana_on": "こう",
+    "character_hiragana_kun": "かのえ"
+  },
+  {
+    "number": 8,
+    "character": "辛",
+    "character_hiragana_on": "しん",
+    "character_hiragana_kun": "かのと"
+  },
+  {
+    "number": 9,
+    "character": "壬",
+    "character_hiragana_on": "じん",
+    "character_hiragana_kun": "みずのえ"
+  },
+  {
+    "number": 10,
+    "character": "癸",
+    "character_hiragana_on": "き",
+    "character_hiragana_kun": "みずのと"
+  }
+]

data/db/jyunishi.json

@@ -0,0 +1,134 @@
+[
+  {
+    "number": 1,
+    "emoji": "🐭",
+    "character": "子",
+    "character_hiragana": "ね",
+    "animal_name": {
+      "ja": "鼠",
+      "ja_hiragana": "ねずみ",
+      "en": "mouse"
+    }
+  },
+  {
+    "number": 2,
+    "emoji": "🐮",
+    "character": "丑",
+    "character_hiragana": "うし",
+    "animal_name": {
+      "ja": "牛",
+      "ja_hiragana": "うし",
+      "en": "cow"
+    }
+  },
+  {
+    "number": 3,
+    "emoji": "🐯",
+    "character": "寅",
+    "character_hiragana": "とら",
+    "animal_name": {
+      "ja": "虎",
+      "ja_hiragana": "とら",
+      "en": "tiger"
+    }
+  },
+  {
+    "number": 4,
+    "emoji": "🐰",
+    "character": "卯",
+    "character_hiragana": "う",
+    "animal_name": {
+      "ja": "兎",
+      "ja_hiragana": "うさぎ",
+      "en": "rabbit"
+    }
+  },
+  {
+    "number": 5,
+    "emoji": "🐲",
+    "character": "辰",
+    "character_hiragana": "たつ",
+    "animal_name": {
+      "ja": "龍",
+      "ja_hiragana": "りゅう",
+      "en": "dragon"
+    }
+  },
+  {
+    "number": 6,
+    "emoji": "🐍",
+    "character": "巳",
+    "character_hiragana": "たつ",
+    "animal_name": {
+      "ja": "蛇",
+      "ja_hiragana": "へび",
+      "en": "snake"
+    }
+  },
+  {
+    "number": 7,
+    "emoji": "🐴",
+    "character": "午",
+    "character_hiragana": "うま",
+    "animal_name": {
+      "ja": "馬",
+      "ja_hiragana": "うま",
+      "en": "horse"
+    }
+  },
+  {
+    "number": 8,
+    "emoji": "🐏",
+    "character": "未",
+    "character_hiragana": "ひつじ",
+    "animal_name": {
+      "ja": "羊",
+      "ja_hiragana": "ひつじ",
+      "en": "sheep"
+    }
+  },
+  {
+    "number": 9,
+    "emoji": "🐵",
+    "character": "申",
+    "character_hiragana": "さる",
+    "animal_name": {
+      "ja": "猿",
+      "ja_hiragana": "さる",
+      "en": "monkey"
+    }
+  },
+  {
+    "number": 10,
+    "emoji": "🐔",
+    "character": "酉",
+    "character_hiragana": "とり",
+    "animal_name": {
+      "ja": "鶏",
+      "ja_hiragana": "にわとり",
+      "en": "rooster"
+    }
+  },
+  {
+    "number": 11,
+    "emoji": "🐶",
+    "character": "戌",
+    "character_hiragana": "いぬ",
+    "animal_name": {
+      "ja": "犬",
+      "ja_hiragana": "いぬ",
+      "en": "dog"
+    }
+  },
+  {
+    "number": 12,
+    "emoji": "🐗",
+    "character": "亥",
+    "character_hiragana": "い",
+    "animal_name": {
+      "ja": "猪",
+      "ja_hiragana": "いのしし",
+      "en": "boar"
+    }
+  }
+]

data/etoji.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/etoji/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "etoji"
+  spec.version       = Etoji::VERSION
+  spec.authors       = ["mitsubosh"]
+  spec.email         = ["yuya.mitsuboshi@gmail.com"]
+
+  spec.summary       = "Simple 干支(eto) library"
+  spec.description   = "Simple 干支(eto) library"
+  spec.homepage      = "https://github.com/MITSUBOSHI/etoji"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/MITSUBOSHI/etoji"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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
+end

data/lib/etoji/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/lib/etoji/jikkan.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'json'
+
+module Etoji
+  module Jikkan
+    class NotFound < StandardError; 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],
+        character: attributes[:character],
+        character_hiragana_on: attributes[:character_hiragana_on],
+        character_hiragana_kun: attributes[:character_hiragana_kun],
+      )
+    }.freeze
+
+    def self.all
+      MEMBERS
+    end
+
+    def self.find_by_number(number)
+      @kans_by_number ||= MEMBERS.each_with_object({}) { |kan, result| result[kan.number] = kan }
+      @kans_by_number[number] or raise NotFound.new("Number: #{number} is not found")
+    end
+  end
+end

data/lib/etoji/jyunishi.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'json'
+
+module Etoji
+  module Jyunishi
+    class NotFound < StandardError; 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],
+        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)
+      )
+    }.freeze
+
+    def self.all
+      MEMBERS
+    end
+
+    def self.find_by_number(number)
+      @animals_by_number ||= MEMBERS.each_with_object({}) { |animal, result| result[animal.number] = animal }
+      @animals_by_number[number] or raise NotFound.new("Number: #{number} is not found")
+    end
+  end
+end

data/lib/etoji/version.rb

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

data/lib/etoji.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "etoji/version"
+require "etoji/jikkan"
+require "etoji/jyunishi"
+
+module Etoji
+  class Error < StandardError; end
+
+  def self.geto(year:, with_prev: false, with_next: false)
+    year_int = self.convert_year(year)
+
+    jyunishi_number = ((year_int + 8) % 12 + 1)
+    current_animal = ::Etoji::Jyunishi.find_by_number(jyunishi_number)
+
+    case [with_prev, with_next]
+    in [true, true]
+      prev_animal = ::Etoji.geto(year: year_int - 1)
+      next_animal = ::Etoji.geto(year: year_int + 1)
+      [prev_animal, current_animal, next_animal]
+    in [true, false]
+      prev_animal = ::Etoji.geto(year: year_int - 1)
+      [prev_animal, current_animal]
+    in [false, true]
+      next_animal = ::Etoji.geto(year: year_int + 1)
+      [current_animal, next_animal]
+    else
+      current_animal
+    end
+  end
+
+  def self.geto_full_string(year:)
+    year_int = self.convert_year(year)
+
+    jikkan_number = ((year_int + 6) % 10 + 1)
+    current_kan = ::Etoji::Jikkan.find_by_number(jikkan_number)
+    current_animal = ::Etoji.geto(year: year_int)
+
+    [current_kan.character, current_animal.character].join
+  end
+
+  def self.convert_year(year)
+    year = Integer(year)
+    raise 'Not allowed year is given' unless (1..3000).include?(year)
+    year
+  rescue => e
+    raise ::Etoji::Error.new("Invalid year is given, #{e.message}")
+  end
+  private_class_method :convert_year
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: etoji
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mitsubosh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-04 00:00:00.000000000 Z
+dependencies: []
+description: Simple 干支(eto) library
+email:
+- yuya.mitsuboshi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/jikkan.json
+- db/jyunishi.json
+- etoji.gemspec
+- lib/etoji.rb
+- lib/etoji/.ruby-version
+- lib/etoji/jikkan.rb
+- lib/etoji/jyunishi.rb
+- lib/etoji/version.rb
+homepage: https://github.com/MITSUBOSHI/etoji
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MITSUBOSHI/etoji
+  source_code_uri: https://github.com/MITSUBOSHI/etoji
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Simple 干支(eto) library
+test_files: []