japanese_calendar 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c2955f1d5776dec68bc1620dae1b8315c4c694e
-  data.tar.gz: fe0a89815a5329db733182628d778f61c352e20d
+  metadata.gz: 24d6b788116b03f3cda9eb3777c06fd528990b9e
+  data.tar.gz: 7e51d4fa12dd788b786102db9a602ae5e76e8acc
 SHA512:
-  metadata.gz: 2f4c1c8e048cbf17cd5f509222523e5e67bcc12cbaba2986cbdda1fba3b6963f4b3ad196765adec045c7e4c387a09025f0714c2ba7e2ca3a5f17674385def892
-  data.tar.gz: c6b360e001018b91c86e9f27bf906d26ccfb98f1f784431a63d48f73190b1485edf59db8e9840d1afea875605983c40d6f1ab6d1e26195a1948ae2861f3941ef
+  metadata.gz: 3b778089d926467aae31b406e8f7ccef7512fd3e836078c398e6d609eed645a329fde41f41c8b5b5b5a512b1349f85f5d4d6d861b1396e683ebafb1b8bead51b
+  data.tar.gz: 37381cf4c47ca1cbfe0fbb9a2d54effa435dcd01e71cffa3aa0b88094580795ee8984bcb760028f43decca3454d9443949a3ead6368810009d10cc7fe27f742b

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  DisabledByDefault: true
+  TargetRubyVersion: 2.3
 
 #################### Lint ################################
 

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in japanese_calendar.gemspec

data/README.md

@@ -20,13 +20,13 @@ Or install it yourself as:
 
 ## Usage
 
-To get the Japanese era name, use the `era_name` method:
+To get a Japanese era name, use the `era_name` method:
 
 ```
 Time.new(1989,  1,  8).era_name # => "平成"
 Time.new(1926, 12, 25).era_name # => "昭和"
 Time.new(1912,  7, 30).era_name # => "大正"
-Time.new(1868,  1, 25).era_name # => "明治"
+Time.new(1873,  1,  1).era_name # => "明治"
 ```
 
 You can convert to a Japanese year with the `era_year` method:
@@ -38,6 +38,22 @@ Time.new(1926, 12, 24).era_year # => 15
 Time.new(1912,  7, 29).era_year # => 45
 ```
 
+To get a string representation of the Japanese era, use the `strftime` method:
+
+```
+time = Time.new(1989, 1, 1)
+time.strftime("%K")               # => "平成"
+time.strftime("%O")               # => "Heisei"
+time.strftime("%^O")              # => "HEISEI"
+time.strftime("%o")               # => "H"
+time.strftime("%J")               # => "01"
+time.strftime("%-J")              # => "1"
+time.strftime("%_J")              # => " 1"
+time.strftime("%K%-J年%-m月%-d日") # => "平成1年1月1日"
+time.strftime("%o%J.%m.%d")       # => H01.01.01
+time.strftime("%b %-d %O %-J")    # => Jan 1 Heisei 1
+```
+
 ## 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.

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "japanese_calendar"

data/exe/japanese_calendar

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "japanese_calendar"

data/japanese_calendar.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'japanese_calendar/version'

data/lib/japanese_calendar.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 require "japanese_calendar/version"
 require "japanese_calendar/core_ext/time"

data/lib/japanese_calendar/core_ext/time.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require "japanese_calendar/era"
 
 class Time
-  include JapaneseCalendar::Era
+  prepend JapaneseCalendar::Era
 end

data/lib/japanese_calendar/era.rb

@@ -1,27 +1,22 @@
+# frozen_string_literal: true
 module JapaneseCalendar
   module Era
-    PERIODS = [
-      { name: "平成", beginning_of_period: Time.new(1989,  1,  8) },
-      { name: "昭和", beginning_of_period: Time.new(1926, 12, 25) },
-      { name: "大正", beginning_of_period: Time.new(1912,  7, 30) },
-      { name: "明治", beginning_of_period: Time.new(1868,  1, 25) }
-    ]
-
-    # Returns the Japanese era name (nengo) since the end of the Edo period.
+    # Returns the Japanese era name (nengo) since 1 January 1873 (Meiji 6).
     #
     #   Time.new(1989,  1,  8).era_name # => "平成"
     #   Time.new(1926, 12, 25).era_name # => "昭和"
     #   Time.new(1912,  7, 30).era_name # => "大正"
-    #   Time.new(1868,  1, 25).era_name # => "明治"
+    #   Time.new(1873,  1,  1).era_name # => "明治"
     #
     # Raises an error when the Japanese era name cannot be found.
     #
-    #   Time.new(1868,  1, 24).era_name # => RuntimeError
-    def era_name
-      find_era[:name]
+    #   Time.new(1872, 12, 31).era_name # => RuntimeError
+    def era_name(character = :kanji)
+      raise ArgumentError unless %i(kanji romaji).include?(character)
+      find_era[:name][character]
     end
 
-    # Returns the Japanese year since the end of the Edo period.
+    # Returns the Japanese year since 1 January 1873 (Meiji 6).
     #
     #   Time.new(2016, 12, 11).era_year # => 28
     #   Time.new(1989,  1,  7).era_year # => 64
@@ -30,13 +25,51 @@ module JapaneseCalendar
     #
     # Raises an error when the Japanese year cannot be found.
     #
-    #   Time.new(1868,  1, 24).era_year # => RuntimeError
+    #   Time.new(1872, 12, 31).era_year # => RuntimeError
     def era_year
       year - find_era[:beginning_of_period].year + 1
     end
 
+    # Formats time according to the directives in the given format string.
+    #
+    #   date_of_birth = Time.new(1978, 7, 19)
+    #
+    #   date_of_birth.strftime("%K")  # => "昭和"
+    #   date_of_birth.strftime("%O")  # => "Showa"
+    #   date_of_birth.strftime("%^O") # => "SHOWA"
+    #   date_of_birth.strftime("%o")  # => "S"
+    #   date_of_birth.strftime("%J")  # => "53"
+    #
+    #   date_of_birth.strftime("%K%-J年")  # => "昭和53年"
+    #
+    # Raises an error when the Japanese year cannot be found.
+    #
+    #   Time.new(1872, 12, 31).strftime("%K%-J年") # => RuntimeError
+    def strftime(format)
+      string = format.dup
+      string.gsub!(/%J/,   "%02d" % era_year)
+      string.gsub!(/%-J/,  "%d"   % era_year)
+      string.gsub!(/%_J/,  "%2d"  % era_year)
+      string.gsub!(/%K/,   era_name.to_s)
+      string.gsub!(/%O/,   era_name(:romaji).to_s)
+      string.gsub!(/%\^O/, era_name(:romaji).upcase.to_s)
+      string.gsub!(/%o/,   era_name(:romaji)[0].to_s)
+      super(string)
+    end
+
     private
+      MEIJI_6 = Time.new(1873, 1, 1)
+
+      PERIODS = [
+        { name: { kanji: "平成", romaji: "Heisei" }, beginning_of_period: Time.new(1989,  1,  8) },
+        { name: { kanji: "昭和", romaji: "Showa" },  beginning_of_period: Time.new(1926, 12, 25) },
+        { name: { kanji: "大正", romaji: "Taisho" }, beginning_of_period: Time.new(1912,  7, 30) },
+        { name: { kanji: "明治", romaji: "Meiji" },  beginning_of_period: Time.new(1868,  1, 25) }
+      ].freeze
+
       def find_era
+        raise "#{self.class.name.downcase} out of range" if self < MEIJI_6
+
         ifnone = proc { raise "#{self.class.name.downcase} out of range" }
         PERIODS.find(ifnone) { |period| period[:beginning_of_period] <= self }
       end

data/lib/japanese_calendar/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module JapaneseCalendar
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: japanese_calendar
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Yamamoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2016-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler