solar_terms_24 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f15bcb96c0c6c3df06a9dd6ee78674ec3989e6145b80395f85c5eb5d8066d79
+  data.tar.gz: 9d1c839c510ca6a35fb0c76965e08b7e3b27921cf7c0a95ab9d2d7712081026d
+SHA512:
+  metadata.gz: 207af75cae0041c4f8924122e5e3dad13bc5ce2d8f9114059a5b716451f0e23a49919a3b1dfd55d69b2d7ff61a49e8e068dcf4c7ac9f1132cb407c0e82c786f0
+  data.tar.gz: d0f40428a096d8a58afdc0a2b256ecb73ed5ba3e1e09ff4e9002b9a03fc56c63edd30a7a51e6096e3613b3c2bd48c4cd812028bf8e9400990842d369a41e4b2c

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Enabled: false
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/ToJSON:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in solar_terms_24.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    solar_terms_24 (1.0.0)
+      faraday (~> 2.0)
+      i18n (~> 1.0)
+      thor (~> 1.0)
+      tzinfo (~> 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.5.1)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debug (~> 1.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  solar_terms_24!
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kevin Luo
+
+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,158 @@
+# SolarTerms24
+
+## Introduction
+
+`solar_terms_24` calculates and collects 24 solar terms each year. It utilizes [NASA's JPL Horizons System API](https://ssd.jpl.nasa.gov/horizons/) to calculate the longitude of ecliptic data. Those solar terms’ times can be translated into different **timezone** or **languages**.
+
+[Solar term](https://en.wikipedia.org/wiki/Solar_term)(節氣, 節気, 节气,  절기, Tiết khí) is any of twenty-four periods in traditional Chinese lunisolar calendars and still used by many East-Asia countries. The solar terms are also used to calculate [intercalary months](https://en.wikipedia.org/wiki/Intercalation_(timekeeping)).
+
+This gem aims to solve 2 main problems while finding those solar terms times of each year:
+
+### 1. Ecliptic time
+
+The times of solar terms are decided by **the longitude of the earth on the ecliptic**, which changes every year. [NASA's JPL Horizons System API](https://ssd.jpl.nasa.gov/horizons/) provides accurate ecliptic data so this gem can precisely calculate the solar terms time.  This gem already caches 1900-2100's data. I bet this should be enough; however, you can try to search any year and it will call API to do the calculation.
+
+### 2. Timezone
+
+The time of solar terms is different in different countries because of different timezones. You can specify the timezones and languages to address this internationalization issue.
+
+This gem is inspired by a Python package [solarterms](https://github.com/kumkee/solarterms)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solar_terms_24'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install solar_terms_24
+
+## Usage
+
+### Shell
+
+The simplest way to use is through the command line:
+```bash
+$ solar_terms_24 list 2022
+# Minor Cold: 2022-01-05 09:14
+# Major Cold: 2022-01-20 02:39
+# Start Of Spring: 2022-02-03 20:50
+# Spring Showers: 2022-02-18 16:43
+# Awakening Of Insects: 2022-03-05 14:43
+# Spring Equinox: 2022-03-20 15:33
+# Pure Brightness: 2022-04-04 19:20
+# Grain Rain: 2022-04-20 02:24
+# Start Of Summer: 2022-05-05 12:25
+# Grain Buds: 2022-05-21 01:22
+# Grain In Ear: 2022-06-05 16:25
+# Summer Solstice: 2022-06-21 09:13
+# Minor Heat: 2022-07-07 02:38
+# Major Heat: 2022-07-22 20:07
+# Start Of Autumn: 2022-08-07 12:29
+# End Of Heat: 2022-08-23 03:16
+# White Dew: 2022-09-07 15:32
+# Autumn Equinox: 2022-09-23 01:03
+# Cold Dew: 2022-10-08 07:22
+# Frost: 2022-10-23 10:35
+# Start Of Winter: 2022-11-07 10:45
+# Minor Snow: 2022-11-22 08:20
+# Major Snow: 2022-12-07 03:46
+# Winter Solstice: 2022-12-21 21:48
+```
+The default timezone is `UTC` and the language is `en` so it may be more useful if you specify them:
+
+```bash
+$ solar_terms_24 list 2022 --timezone=Asia/Taipei  --lang=zh-TW
+# 小寒: 2022-01-05 17:14
+# 大寒: 2022-01-20 10:39
+# 立春: 2022-02-04 04:50
+# 雨水: 2022-02-19 00:43
+# 驚蟄: 2022-03-05 22:43
+# 春分: 2022-03-20 23:33
+# 清明: 2022-04-05 03:20
+# 穀雨: 2022-04-20 10:24
+# 立夏: 2022-05-05 20:25
+# 小滿: 2022-05-21 09:22
+# 芒種: 2022-06-06 00:25
+# 夏至: 2022-06-21 17:13
+# 小暑: 2022-07-07 10:38
+# 大暑: 2022-07-23 04:07
+# 立秋: 2022-08-07 20:29
+# 處暑: 2022-08-23 11:16
+# 白露: 2022-09-07 23:32
+# 秋分: 2022-09-23 09:03
+# 寒露: 2022-10-08 15:22
+# 霜降: 2022-10-23 18:35
+# 立冬: 2022-11-07 18:45
+# 小雪: 2022-11-22 16:20
+# 大雪: 2022-12-07 11:46
+# 冬至: 2022-12-22 05:48
+```
+### In code
+
+```ruby
+year = 2022
+solar_terms = SolarTerms24::SolarTerms.new(year)
+solar_term = solar_terms.winter_solstice
+solar_term.name
+# => "Winter Solstice"
+solar_term.date.strftime('%Y-%m-%d')
+# => 2022-12-21
+# => solar_term.date is a Date object
+solar_term.datetime.strftime('%Y-%m-%d %H:%M:%S')
+# => 2022-12-21 21:48:14
+# => solar_term.datetime is a DateTime object
+
+solar_terms = SolarTerms24::SolarTerms.new(year, timezone: 'Asia/Taipei', lang: 'zh-TW')
+solar_term = solar_terms.winter_solstice
+solar_term.name
+# => "冬至"
+solar_term.date.strftime('%Y-%m-%d')
+# => 2022-12-22
+solar_term.datetime.strftime('%Y-%m-%d %H:%M:%S')
+# => "2022-12-22 05:48:14"
+```
+
+## Options
+### Languages
+
+These are the supported languages:
+
+* en (English, default)
+* ja (Japanese)
+* ko (Korean)
+* vi (Vietnamese)
+* zh-CN (Simpified Chinese)
+* zh-TW (Tranditional Chinese)
+
+### Timezone
+
+It uses the gem [tzinfo], so all timezones in [IANA Time Zone Database](http://www.iana.org/time-zones) are supported. For example,
+  * UTC (default)
+  * Asia/Ho_Chi_Minh
+  * Asia/Seoul
+  * Asia/Taipei
+  * Asia/Tokyo
+
+Full list is [here](./Timezones.md)
+
+## 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.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kevinluo201/solar_terms_24.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]