hanreki 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e77d8514fb895c71dd9ae36bd0ef6874936525e0
-  data.tar.gz: be23696bb36d0636eda9aa4c22d4b4cee5d25f0a
+  metadata.gz: 3ce2183461786fb22b00f52b7717e8c378b3ee42
+  data.tar.gz: e8989a1d2a10e6b4c54bdcfdd22751c558fb84af
 SHA512:
-  metadata.gz: 0b7b180e7240204fa3927262c2718d3399a77357d011e82a6d8ec5ee712d62b732fd2079c24be6e3742354a3235392a5b9520a3bfc97e8f5f14bb948cd86082d
-  data.tar.gz: 3ade6ed6586926a0c25e37e56fa539431f0a2d03628f1588b8a692590ae38e10e90ef8590c74e694285f5737a38be50ae6f5487f2121636bd91449ccd9a4d8a3
+  metadata.gz: 56ab148a883d11a01bb45a789555aea9e22334638954d709af39b49ed459a626fdc5fd4c58a7ad0d1b31b0d969a35c255dc0b001e07cf1be30fd8d5e09cfacde
+  data.tar.gz: 957ee0ac1079a57dc19f1b25bcda5d04988726d54ce003ba5439c98c48e6da44bc9c7b45d378949fb55d8cbef8373d3586269040028e10d8d1d57a9d1e2c51fa

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.1
+  - 2.2
   - 2.3.1
-before_install: gem install bundler -v 1.12.5
+before_install:
+  - gem install bundler
+notifications:
+  slack:
+    secure: SqYPNEedzTJqs9XHn0SW1RvPVG2GPcMJWMrE4hg35WnzZk7rSk9DbHqjjZo1+qAS8MF/du68KKPRJe1KewerK+Zub2wwsFAR2Wvp0Elrq2fgKKNMY67ulG+ET6f2Mz9Uij83CO9fBxbCXxqja+nTbHZhx7YM5B9KSAqwNs6DYahxtueLiqK4y4YVULt/KUvo9mA2gjIbeTZE0TZ/se0pXVtunh/UFW+CE34rkTT3zoUtk4CcCO/wMXu56vwqyHluwwmhVVjvMB96WYrJ3O2R9ef3Cm9rfzAeyJ0LDBddOwr+z4ZsI2Yz+b270bM6F1Mb6sDO48WGi12u8JRRGECy/GA8R93Jo6mnC+cEPx50XElPE5njbI56LRBuzAjimEyxpwfA9UWBgRDGmHyEc3B16ri/DKknEE+YxEvsEfgKSt012sXBS0gYO6jIz318GMxdj6+EYYVJXwJMj8MZlCUtvfgqq4qQwk/vBDK9BAcfDjIbayWLEnenXJWnRwW7gVn4hQG4qx+TUUZDcgiZ+adFcMLZjvd500GSOeV8H+4U5pR0MWIzuC1MTAIYB4E7Tma2QQqU2dG3ztHqo4ubApTb/qBpcYrFOjCBPT2ItGC85mSlGMs4vgMnVUGyFaLR5u4PYe6Hd/uNfE6i8ayJ2E1STFVUuwD0EdOXqEZT6ulnvD4=

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 CAMPHOR-
+
+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

@@ -1,12 +1,18 @@
 # Hanreki
 
-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/hanreki`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/camphor-/hanreki.svg?branch=master)](https://travis-ci.org/camphor-/hanreki)
 
-TODO: Delete this and the text above, and describe your gem
+Simple schedule manager for [CAMPHOR-](https://camph.net/)
 
 ## Installation
+### Gem
+Install hanreki with gem command:
 
-Add this line to your application's Gemfile:
+    $ gem install hanreki
+    $ hanreki
+
+### Bundler
+You can also install hanreki with bundler. Add this line to your Gemfile:
 
 ```ruby
 gem 'hanreki'
@@ -15,22 +21,15 @@ gem 'hanreki'
 And then execute:
 
     $ bundle
-
-Or install it yourself as:
-
-    $ gem install hanreki
+    $ bundle exec hanreki
 
 ## Usage
-
-TODO: Write usage instructions here
+TODO
 
 ## 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 tags, 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/[USERNAME]/hanreki.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/camphor-/hanreki.

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  timezone:
+    UTC
+  ruby:
+    version: 2.1.5
+dependencies:
+  pre:
+    - gem install bundler

data/hanreki.gemspec

@@ -12,13 +12,17 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Simple schedule manager for CAMPHOR-'
   spec.description   = 'Simple schedule manager for CAMPHOR-'
   spec.homepage      = 'https://github.com/camphor-/hanreki'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'icalendar', '~> 2.3'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/hanreki/cli.rb

@@ -1,6 +1,66 @@
+require 'date'
 require 'thor'
+require 'hanreki/schedule'
+require 'hanreki/time_util'
 
 module Hanreki
   class CLI < Thor
+    using ExtendTime
+
+    desc 'blank --date [YYYYMM]', 'Generate a blank master file'
+    method_option :date, type: :numeric
+    def blank
+      year, month = parse_month_in_options(options, Date.today.next_month)
+      schedule = Schedule.initialize_for_month(year, month)
+      raise 'file already exists' if schedule.master_file_exists?
+      schedule.out_master
+    end
+
+    desc 'edit --date [YYYYMM]', 'Open a master file in the editor'
+    method_option :date, type: :numeric
+    def edit
+      year, month = parse_month_in_options(options, Date.today)
+      master_file = sprintf('master/%04d%02d.csv', year, month)
+      raise 'file does not exist' unless File.exists? master_file
+
+      editor = ENV['CAMPHOR_SCHEDULE_EDITOR'] || ENV['EDITOR'] || 'vi'
+      system "#{editor} #{master_file}"
+      validate
+    end
+
+    desc 'sync', 'Sync iCal, JSON, and JSONP'
+    def sync
+      schedule = Schedule.new
+      schedule.load_master_files
+      schedule.out_ical
+      schedule.out_json
+      schedule.out_jsonp
+    end
+
+    desc 'validate', 'Validate master files'
+    def validate
+      schedule = Schedule.new
+      begin
+        schedule.load_master_files
+      rescue => e
+        raise "validation error: #{e}"
+      end
+    end
+
+    private
+
+    # Parse a string (YYYYMM) in options[:date] and returns [YYYY, MM]
+    def parse_month_in_options(options, default = nil)
+      date = options[:date]
+      if options[:date]
+        begin
+          Time.parse_month(options[:date].to_s)
+        rescue ArgumentError => e
+          raise "invalid date option: #{e.message}"
+        end
+      elsif default
+        [default.year, default.month]
+      end
+    end
   end
 end

data/lib/hanreki/event.rb

@@ -0,0 +1,125 @@
+require 'icalendar'
+require 'hanreki/time_util'
+
+# Event of CAMPHOR- Schedule
+class Event
+  using ExtendTime
+  WDAYS = %w(日 月 火 水 木 金 土)
+  attr_accessor :start, :end
+  attr_accessor :public_summary, :private_summary
+  attr_accessor :url
+
+  def initialize(attributes)
+    # Create assign methods for event attributes
+    attributes.each do |attribute, v|
+      send("#{attribute}=", v) if respond_to?("#{attribute}=")
+    end if attributes
+    yield self if block_given?
+  end
+
+  # マスターファイルの1行を読み込む処理
+  # CSV を読む混む際にしかチェックできないバリデーションはここで行う.
+  # その他のバリデーションは #validate で行う.
+  # month: String (e.g. 201510)
+  # line: CSV::Row
+  # (eg. [01, 水, 15:00, 20:00, "HOUSE 開館", "HOUSE 当番 @ivstivs", https://camph.net])
+  def self.from_master(month, line)
+    event = Event.new({})
+    first_day = Date.parse("#{month}01")
+    day, _, hour_start, hour_end, public_summary, private_summary, url = line.fields.map { |c| c.to_s.strip }
+    # Zero-fill (eg. 1 -> 01, 02 -> 02)
+    day = day.rjust(2, "0")
+    raise ArgumentError, 'invalid day' unless day.length == 2
+    raise ArgumentError, 'invalid day' unless (first_day...first_day.next_month).include?(Date.parse("#{month}#{day}"))
+    event.start = Time.parse("#{month}#{day} #{hour_start} +09:00")
+    event.end = Time.parse("#{month}#{day} #{hour_end} +09:00")
+    event.public_summary = public_summary unless public_summary.empty?
+    event.private_summary = private_summary unless private_summary.empty?
+    event.url = url unless url.empty?
+    event.validate
+    event
+  end
+
+  def to_h(type, time_type = :time)
+    fail ArgumentError, 'Invalid type' unless [:public, :private].include?(type)
+    fail ArgumentError, 'Invalid time_type' unless [:time, :string].include?(time_type)
+    hash = {
+      start: @start,
+      end: @end,
+      url: @url
+    }
+    case type
+    when :public then hash[:title] = @public_summary
+    when :private then hash[:title] = @private_summary
+    end
+    if time_type == :string
+      hash[:start] = hash[:start].iso8601
+      hash[:end] = hash[:end].iso8601
+    end
+    hash
+  end
+
+  # Format for master CSV files
+  def to_master
+    wday = WDAYS[@start.wday]
+    date_str = @start.strftime('%d')
+    start_string = @start.strftime('%R')
+    end_string =  @end.strftime('%R')
+    [date_str, wday, start_string, end_string, @public_summary, @private_summary, @url]
+  end
+
+  def private?
+    !@private_summary.nil?
+  end
+
+  def public?
+    !@public_summary.nil?
+  end
+
+  # イベントのバリデーションを行う
+  # バリデーションに成功した場合は true を返し, 失敗した場合は例外を送出する
+  def validate
+    raise ArgumentError, 'invalid start & end' if @start > @end
+
+    if @public_summary.nil? and @private_summary.nil?
+      raise ArgumentError, 'both summaries are not set'
+    end
+
+    if @private_summary == 'Closed'
+      if not @public_summary.nil?
+        raise ArgumentError, 'invalid public summary for a closed event'
+      end
+
+      if not @start.is_midnight_in_jst
+        raise ArgumentError, 'start must be 0:00 for a closed event'
+      end
+
+      if not @end.is_midnight_in_jst
+        raise ArgumentError, 'end must be 0:00 for a closed event'
+      end
+    end
+
+    unless @url.nil?
+      unless @url.start_with?('http://') or @url.start_with?('https://')
+        raise ArgumentError, 'invalid url scheme'
+      end
+    end
+
+    true
+  end
+
+  # Header for master CSV files
+  def self.master_header
+    %w(day day_of_week hour_start hour_end public_summary private_summary url)
+  end
+
+  def ==(other)
+    self.class == other.class && self.state == other.state
+  end
+
+  protected
+
+  def state
+    [@start, @end, @public_summary, @private_summary, @url]
+  end
+end

data/lib/hanreki/i_calendar.rb

@@ -0,0 +1,55 @@
+require 'icalendar'
+require 'hanreki/time_util'
+
+# iCal
+class ICalendar
+  using ExtendTime
+  def initialize(file = nil)
+    @calendar = Icalendar::Calendar.new
+    if file
+      @calendar = Icalendar.parse(file).first
+    else
+      make_blank
+    end
+  end
+
+  def to_s
+    @calendar.publish
+    @calendar.to_ical
+  end
+
+  def set_event(event, type)
+    fail ArgumentError, 'Invalid date' unless event.start && event.end
+    fail ArgumentError, 'Invalid type' unless [:public, :private].include?(type)
+    @calendar.event do |e|
+      e.dtstart = event.start
+      e.dtend = event.end
+      e.url = event.url
+      case type
+      when :public then e.summary = event.public_summary
+      when :private then e.summary = event.private_summary
+      end
+    end
+  end
+
+  private
+
+  # Generate new calendar
+  def make_blank
+    @calendar.append_custom_property('X-WR-CALNAME', 'CAMPHOR- Events')
+    set_timezone
+  end
+
+  def set_timezone
+    # TODO: Rewrite with tzinfo
+    @calendar.timezone do |t|
+      t.tzid = 'Asia/Tokyo'
+      t.standard do |s|
+        s.tzoffsetfrom = '+0900'
+        s.tzoffsetto   = '+0900'
+        s.tzname       = 'JST'
+        s.dtstart      = '19700101T000000'
+      end
+    end
+  end
+end

data/lib/hanreki/schedule.rb

@@ -0,0 +1,131 @@
+require 'csv'
+require 'date'
+require 'json'
+require 'hanreki/event'
+require 'hanreki/i_calendar'
+require 'hanreki/time_util'
+
+# Schedule for CAMPHOR- HOUSE assignments and other events
+class Schedule
+  using ExtendTime
+  ICAL_PUBLIC_PATH = 'ical/camphor_public_events.ics'
+  ICAL_PRIVATE_PATH = 'ical/camphor_private_events.ics'
+  JSON_PUBLIC_PATH = 'json/camphor_public_events.json'
+  JSON_PRIVATE_PATH = 'json/camphor_private_events.json'
+  JSONP_PUBLIC_PATH = 'jsonp/camphor_public_events.js'
+  JSONP_PRIVATE_PATH = 'jsonp/camphor_private_events.js'
+
+  def initialize
+    # マスターファイルを生成する際のファイル名の決定に使用
+    @first_day_of_month = nil
+    @events = []
+  end
+
+  # 指定された月の初期割り当てを @events に設定する
+  def self.initialize_for_month(year, month)
+    schedule = Schedule.new
+    schedule.send(:initialize_assignments, year, month)
+    schedule
+  end
+
+  # マスターファイルを読み込んで @events に設定する
+  def load_master_files
+    @events = Dir.glob('master/*.csv').flat_map do |f|
+      month = f.match(/master\/(\d+).csv/)[1]
+      CSV.open(f, headers: true) do |csv|
+        csv.map { |line| Event.from_master(month, line) }
+      end
+    end
+  end
+
+  # Output private and public iCal calendar files
+  def out_ical
+    File.open(ICAL_PUBLIC_PATH, 'w') do |f|
+      ical = ICalendar.new
+      public_events.each { |event| ical.set_event(event, :public) }
+      f.write(ical)
+    end
+    File.open(ICAL_PRIVATE_PATH, 'w') do |f|
+      ical = ICalendar.new
+      private_events.each { |event| ical.set_event(event, :private) }
+      f.write(ical)
+    end
+  end
+
+  # Output private and public JSON calendar files
+  def out_json
+    File.open(JSON_PUBLIC_PATH, 'w') do |f|
+      JSON.dump(public_events.map { |event| event.to_h(:public, :string) } , f)
+    end
+    File.open(JSON_PRIVATE_PATH, 'w') do |f|
+      JSON.dump(private_events.map { |event| event.to_h(:private, :string) } , f)
+    end
+  end
+
+  # Output private and public JSONP calendar files
+  def out_jsonp(callback = 'callback')
+    File.open(JSONP_PUBLIC_PATH, 'w') do |f|
+      events = public_events.map { |event| event.to_h(:public, :string) }
+      f.write("#{callback}(#{events.to_json});")
+    end
+    File.open(JSONP_PRIVATE_PATH, 'w') do |f|
+      events = private_events.map { |event| event.to_h(:private, :string) }
+      f.write("#{callback}(#{events.to_json});")
+    end
+  end
+
+  # Output master file
+  def out_master
+    CSV.open(
+      file_path, 'w',
+      headers: Event.master_header, write_headers: true
+    ) do |master_file|
+      @events.each { |event| master_file << event.to_master }
+    end
+  end
+
+  def master_file_exists?
+    File.exists? file_path
+  end
+
+  private
+
+  def file_path
+    "master/#{@first_day_of_month.strftime('%Y%m')}.csv".freeze
+  end
+
+  def initialize_assignments(year, month)
+    @first_day_of_month =
+      begin
+        Date.new(year, month, 1)
+      rescue TypeError
+        raise ArgumentError, 'Invalid year and month'
+      end
+
+    days = @first_day_of_month...@first_day_of_month.next_month
+    @events = days.map { |day| default_assignment(day) }
+  end
+
+  def default_assignment(date)
+    # Set timezone explicitly (DO NOT use date.to_time, it uses local timezone)
+    time = Time.new(date.year, date.month, date.day, 0, 0, 0, '+09:00')
+    start, _end, public_summary, private_summary =
+      case time.wday
+      when 0 then [time.next_day(0), time.next_day(1), '', 'Closed']
+      when 1..5 then [time.next_hour(15), time.next_hour(20), 'Open', '@']
+      when 6 then [time.next_hour(13), time.next_hour(20), 'Open', '@']
+      end
+    Event.new(
+      start: start, end: _end,
+      public_summary: public_summary,
+      private_summary: private_summary)
+  end
+
+  def public_events
+    @events.select(&:public?)
+  end
+
+  def private_events
+    @events.select(&:private?)
+  end
+end

data/lib/hanreki/time_util.rb

@@ -0,0 +1,39 @@
+require 'time'
+
+# Add some useful methods to Time, provided as refinement
+module ExtendTime
+  refine Time do
+    SECONDS_OF_HOUR = 60 * 60
+    SECONDS_OF_DAY = SECONDS_OF_HOUR * 24
+
+    # n 日後の Time を返す
+    def next_day(n = 1)
+      self + (n * SECONDS_OF_DAY)
+    end
+
+    # n 時間後の Time を返す
+    def next_hour(n = 1)
+      self + (n * SECONDS_OF_HOUR)
+    end
+
+    # JST で 0:00 a.m. がどうかを返す
+    def is_midnight_in_jst
+      seconds_in_local = ((self.hour * 60) + self.min) * 60 + self.sec
+      seconds_in_jst = seconds_in_local - self.utc_offset + 9 * 60 * 60
+      seconds_in_jst % (24 * 60 * 60) == 0
+    end
+  end
+
+  refine Time.singleton_class do
+    # YYYYMM 形式の String をパースして [YYYY, MM] を返す
+    # パースに失敗した場合は ArgumentError を送出する
+    def parse_month(date)
+      match = /^(\d{4})(\d{2})$/.match(date)
+      raise ArgumentError, 'invalid date format' if match.nil?
+      year, month = match.captures.map(&:to_i)
+      raise ArgumentError, 'invalid year' unless (1970..2030).include? year
+      raise ArgumentError, 'invalid month' unless (1..12).include? month
+      [year, month]
+    end
+  end
+end

data/lib/hanreki/version.rb

@@ -1,3 +1,3 @@
 module Hanreki
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/hanreki.rb

@@ -1,4 +1,7 @@
 require 'hanreki/cli'
+require 'hanreki/event'
+require 'hanreki/schedule'
+require 'hanreki/time_util'
 require 'hanreki/version'
 
 module Hanreki

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanreki
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - CAMPHOR-
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,17 +92,24 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - exe/hanreki
 - hanreki.gemspec
 - lib/hanreki.rb
 - lib/hanreki/cli.rb
+- lib/hanreki/event.rb
+- lib/hanreki/i_calendar.rb
+- lib/hanreki/schedule.rb
+- lib/hanreki/time_util.rb
 - lib/hanreki/version.rb
 homepage: https://github.com/camphor-/hanreki
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -98,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="