calendar_china 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c09d2aa913863fdac341affb1cb53d0d3e84528540bb9261b4f863e6f66581b3
-  data.tar.gz: 89b3ae6494b08dd991f510214aa6cba3fc22a11145660a86bc3ba6969ece8acb
+  metadata.gz: e51679d9d8c820cb85946f5fd0224cc5d576fdd349872f4294596fb111ffeef8
+  data.tar.gz: 8d08eb79716230d1be81f968939f901b4208ee73fa6c2f99e9c3ccf2160252f4
 SHA512:
-  metadata.gz: b3a6d72984d4737763d266f6983e2a8504df2aee64cdf92d88a60e8dd36b2f8efca707dd56dc625f973291e5c8e8f67b2f7088ce42bf7a27699920972b49f1ca
-  data.tar.gz: 8e88c3f0c0443023fca9901f2c5e3be487ae38a77fc9e329db401ff6d48a9531b1f12e5e40a9b101e23956b5b811e26b60221ec0860f5c3138b7bd842b57a614
+  metadata.gz: 59d3ac60984a3034a8f9a96f43865abf174fef864f6522cb38ab2cf8b66c53baf7d7659aad9102296cebb695e5a5afd0bd3bf2c4e37e2d1e1962acea8814d28b
+  data.tar.gz: be7fab0d966b3aa68e904a4c3fb2cb56294cbdda20a7fcb3f70239b10044436ed148d5d7bafe300f5324b3b0c5925462c2d90b034b6a9b2cf52c7fc585c416c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    calendar_china (0.1.0)
+    calendar_china (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,10 @@
 # CalendarChina
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/calendar_china`. To experiment with that code, run `bin/console` for an interactive prompt.
+Due to the extremely weird holidays in China, we have to customize the calendar.
 
-TODO: Delete this and the text above, and describe your gem
+NOTE: need to update these lib/data/{xxxx}.json on time.
+
+These datasource are retrieved from the [holiday-cn](https://github.com/NateScarlet/holiday-cn), and thanks to NateScarlet
 
 ## Installation
 
@@ -12,6 +14,12 @@ Add this line to your application's Gemfile:
 gem 'calendar_china'
 ```
 
+Or use github
+
+```ruby
+gem 'calendar_china', github: 'JohnnyTing/calendar_china'
+```
+
 And then execute:
 
     $ bundle install
@@ -22,7 +30,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+ By default, initialize current year and date. you also can specify the fields. Below is an example:
+ ```ruby
+  ccd = CalendarChina::Date.new("2020", "2020-01-01")
+  
+  # return true
+  ccd.is_holiday?
+  
+  # return true
+  ccd.is_rest?
+  
+  # return false
+  ccd.is_workday?
+  
+  # return hash:  {:date=>"2020-01-02", :days=>0}, date field is next workday lasted, days field is via these days arrives next workday
+  ccd.next_workday
+ ```
 
 ## Development
 
@@ -32,7 +55,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/calendar_china. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/calendar_china/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/JohnnyTing/calendar_china. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/JohnnyTing/calendar_china/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +64,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the CalendarChina project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/calendar_china/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CalendarChina project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JohnnyTing/calendar_china/blob/master/CODE_OF_CONDUCT.md).

data/lib/calendar_china.rb

@@ -1,4 +1,4 @@
-require "calendar_china/version"
+require 'calendar_china/version'
 require 'calendar_china/methods'
 require 'active_support/all'
 require 'json'
@@ -6,14 +6,27 @@ require_relative 'helpers/date_helper'
 
 module CalendarChina
   class Error < StandardError; end
+
+  # China's Calendar. For more details, see the calendar_china/methods.rb
+  #
+  # NOTE: need to update the lib/data/{xxxx}.json on time.
+  # retrieve these json file from https://github.com/NateScarlet/holiday-cn, and thanks to NateScarlet
   class Date
     include CalendarChina::Methods
     include DateHelper
 
     attr_accessor :china_year, :china_date
+
+    # By default, initialize current year and date.
+    # you also can specify the fields. Below is some examples for usage:
+    # ccd = CalendarChina::Date.new("2020", "2020-01-01")
+    # ccd.is_holiday? => true
+    # ccd.is_rest? => true
+    # ccd.is_workday? => false
+    # ccd.next_workday => {:date=>"2020-01-02", :days=>0}
     def initialize(year = current_year, date = current_date)
       @china_year = year
-      @china_date = right_date(date)
+      @china_date = adjust_date(date)
     end
   end
 end

data/lib/calendar_china/version.rb

@@ -1,3 +1,3 @@
 module CalendarChina
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/data/2015.json

@@ -0,0 +1,145 @@
+{
+  "$schema": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/schema.json",
+  "$id": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/2015.json",
+  "year": 2015,
+  "papers": [
+    "http://www.gov.cn/zhengce/content/2014-12/16/content_9302.htm"
+  ],
+  "days": [
+    {
+      "name": "元旦",
+      "date": "2015-01-01",
+      "isOffDay": true
+    },
+    {
+      "name": "元旦",
+      "date": "2015-01-02",
+      "isOffDay": true
+    },
+    {
+      "name": "元旦",
+      "date": "2015-01-03",
+      "isOffDay": true
+    },
+    {
+      "name": "元旦",
+      "date": "2015-01-04",
+      "isOffDay": false
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-15",
+      "isOffDay": false
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-18",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-19",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-20",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-21",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-22",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-23",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-24",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2015-02-28",
+      "isOffDay": false
+    },
+    {
+      "name": "清明节",
+      "date": "2015-04-05",
+      "isOffDay": true
+    },
+    {
+      "name": "清明节",
+      "date": "2015-04-06",
+      "isOffDay": true
+    },
+    {
+      "name": "劳动节",
+      "date": "2015-05-01",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2015-06-20",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2015-06-22",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节",
+      "date": "2015-09-27",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-01",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-02",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-03",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-04",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-05",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-06",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-07",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2015-10-10",
+      "isOffDay": false
+    }
+  ]
+}

data/lib/data/2016.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/schema.json",
+  "$id": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/2016.json",
+  "year": 2016,
+  "papers": [
+    "http://www.gov.cn/zhengce/content/2015-12/10/content_10394.htm"
+  ],
+  "days": [
+    {
+      "name": "元旦",
+      "date": "2016-01-01",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-06",
+      "isOffDay": false
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-07",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-08",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-09",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-10",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-11",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-12",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-13",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2016-02-14",
+      "isOffDay": false
+    },
+    {
+      "name": "清明节",
+      "date": "2016-04-04",
+      "isOffDay": true
+    },
+    {
+      "name": "劳动节",
+      "date": "2016-05-01",
+      "isOffDay": true
+    },
+    {
+      "name": "劳动节",
+      "date": "2016-05-02",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2016-06-09",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2016-06-10",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2016-06-11",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2016-06-12",
+      "isOffDay": false
+    },
+    {
+      "name": "中秋节",
+      "date": "2016-09-15",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节",
+      "date": "2016-09-16",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节",
+      "date": "2016-09-17",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节",
+      "date": "2016-09-18",
+      "isOffDay": false
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-01",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-02",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-03",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-04",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-05",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-06",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-07",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-08",
+      "isOffDay": false
+    },
+    {
+      "name": "国庆节",
+      "date": "2016-10-09",
+      "isOffDay": false
+    }
+  ]
+}

data/lib/data/2017.json

@@ -0,0 +1,155 @@
+{
+  "$schema": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/schema.json",
+  "$id": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/2017.json",
+  "year": 2017,
+  "papers": [
+    "http://www.gov.cn/zhengce/content/2016-12/01/content_5141603.htm"
+  ],
+  "days": [
+    {
+      "name": "元旦",
+      "date": "2017-01-01",
+      "isOffDay": true
+    },
+    {
+      "name": "元旦",
+      "date": "2017-01-02",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-01-22",
+      "isOffDay": false
+    },
+    {
+      "name": "春节",
+      "date": "2017-01-27",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-01-28",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-01-29",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-01-30",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-01-31",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-02-01",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-02-02",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2017-02-04",
+      "isOffDay": false
+    },
+    {
+      "name": "清明节",
+      "date": "2017-04-01",
+      "isOffDay": false
+    },
+    {
+      "name": "清明节",
+      "date": "2017-04-02",
+      "isOffDay": true
+    },
+    {
+      "name": "清明节",
+      "date": "2017-04-03",
+      "isOffDay": true
+    },
+    {
+      "name": "清明节",
+      "date": "2017-04-04",
+      "isOffDay": true
+    },
+    {
+      "name": "劳动节",
+      "date": "2017-05-01",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2017-05-27",
+      "isOffDay": false
+    },
+    {
+      "name": "端午节",
+      "date": "2017-05-28",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2017-05-29",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2017-05-30",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-09-30",
+      "isOffDay": false
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-01",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-02",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-03",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-04",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-05",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-06",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-07",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节、国庆节",
+      "date": "2017-10-08",
+      "isOffDay": true
+    }
+  ]
+}

data/lib/data/2018.json

@@ -0,0 +1,155 @@
+{
+  "$schema": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/schema.json",
+  "$id": "https://raw.githubusercontent.com/NateScarlet/holiday-cn/master/2018.json",
+  "year": 2018,
+  "papers": [
+    "http://www.gov.cn/zhengce/content/2017-11/30/content_5243579.htm"
+  ],
+  "days": [
+    {
+      "name": "元旦",
+      "date": "2018-01-01",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-11",
+      "isOffDay": false
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-15",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-16",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-17",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-18",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-19",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-20",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-21",
+      "isOffDay": true
+    },
+    {
+      "name": "春节",
+      "date": "2018-02-24",
+      "isOffDay": false
+    },
+    {
+      "name": "清明节",
+      "date": "2018-04-05",
+      "isOffDay": true
+    },
+    {
+      "name": "清明节",
+      "date": "2018-04-06",
+      "isOffDay": true
+    },
+    {
+      "name": "清明节",
+      "date": "2018-04-07",
+      "isOffDay": true
+    },
+    {
+      "name": "清明节",
+      "date": "2018-04-08",
+      "isOffDay": false
+    },
+    {
+      "name": "劳动节",
+      "date": "2018-04-28",
+      "isOffDay": false
+    },
+    {
+      "name": "劳动节",
+      "date": "2018-04-29",
+      "isOffDay": true
+    },
+    {
+      "name": "劳动节",
+      "date": "2018-04-30",
+      "isOffDay": true
+    },
+    {
+      "name": "劳动节",
+      "date": "2018-05-01",
+      "isOffDay": true
+    },
+    {
+      "name": "端午节",
+      "date": "2018-06-18",
+      "isOffDay": true
+    },
+    {
+      "name": "中秋节",
+      "date": "2018-09-24",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-09-29",
+      "isOffDay": false
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-09-30",
+      "isOffDay": false
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-01",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-02",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-03",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-04",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-05",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-06",
+      "isOffDay": true
+    },
+    {
+      "name": "国庆节",
+      "date": "2018-10-07",
+      "isOffDay": true
+    }
+  ]
+}

data/lib/helpers/date_helper.rb

@@ -3,14 +3,14 @@ module DateHelper
     ::Date.current.year
   end
 
-  def right_date(date)
+  def adjust_date(date)
     case date
     when String
       date
     when ::Date, DateTime
-      date.strftime('%F')
+      format_date(date)
     when Integer
-      Time.at(date).strftime('%F')
+      format_date(Time.at(date))
     end
   end
 
@@ -19,6 +19,6 @@ module DateHelper
   end
 
   def current_date
-    ::Date.current.strftime('%F')
+    format_date(::Date.current)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calendar_china
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - JohnnyTing
@@ -52,6 +52,10 @@ files:
 - lib/calendar_china.rb
 - lib/calendar_china/methods.rb
 - lib/calendar_china/version.rb
+- lib/data/2015.json
+- lib/data/2016.json
+- lib/data/2017.json
+- lib/data/2018.json
 - lib/data/2019.json
 - lib/data/2020.json
 - lib/helpers/date_helper.rb