hanreki 1.2.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a867b87334a1a1be5954d74b9059cd465651f1a5
-  data.tar.gz: 2961b20754273404809b8c9f8f1d2d789edfb879
+SHA256:
+  metadata.gz: 944f39bf167421f37e9bb814289d58b77a791695cae547cca3d4afd7acd9d2b5
+  data.tar.gz: ca7b46cc65c16e5fe7c61ff6e4739d4a7d8194b64b35a767f312520ca987abfb
 SHA512:
-  metadata.gz: a04b6f1fe15222d4de38772121cfe025a0df77008a58a726e09cec72bf0f2b4fa3650ac7ec4e4ef1f4ef1eca17d850bd8889369c920bab1dd332114a15d44709
-  data.tar.gz: 8579bada5beea05a9b7cf71eea9e2e423a456425430e28034dc77e2c19e3a0f36cb2fba1db85351ac6b097a9bca8ec536c53036b288d96e2f466eb3d6ffed9e7
+  metadata.gz: 81b8d3882ee6bb4186b9d3c5e2acc7d43e5914bc9590bc686707526e247d809e43a90a69a3b35712dc509a304df58881be1386db997e48769bf328792d3b50a2
+  data.tar.gz: 0b406751aef3e864deba94e983811cf8e174cd75db217ecfc8b31ddc1e06cc339c40affcbdccf5e29f90e67cd753be4d188ea454ac37eaff9b01a56ebbad3aaa

data/README.md

@@ -5,6 +5,11 @@
 
 Simple schedule manager for [CAMPHOR-](https://camph.net/)
 
+## Features
+- Manage public & private schedules
+- Manage events using simple CSV master files
+- Convert master files to iCal and JSON files
+
 ## Installation
 ### Gem
 Install hanreki with gem command:
@@ -27,6 +32,23 @@ And then execute:
 ## Usage
 Run `hanreki help` or `bundle exec hanreki help`.
 
+### Create a master file
+`hanreki blank` generates a master file for the next month.
+
+### Sync
+`hanreki sync` generates iCal and JSON files from master files.
+
+### Edit
+`hanreki edit` opens a editor and validates master files.
+Hanreki chooses the editor in the following order:
+
+1. Editor specified by the environment variable: `CAMPHOR_SCHEDULE_EDITOR`
+2. Editor specified by the environment variable: `EDITOR`
+3. `vi`
+
+### Validation
+`hanreki validate` validates master files.
+
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/hanreki.gemspec

@@ -24,13 +24,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'thor', '>= 0.19', '< 2.0'
   spec.add_dependency 'icalendar', '~> 2.3'
   spec.add_dependency 'json-schema', '~> 2.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/hanreki/cli.rb

@@ -1,5 +1,6 @@
 require 'date'
 require 'thor'
+require 'hanreki/exceptions'
 require 'hanreki/schedule'
 require 'hanreki/time_util'
 require 'hanreki/version'
@@ -29,23 +30,18 @@ module Hanreki
       validate
     end
 
-    desc 'sync', 'Sync iCal, JSON, and JSONP'
+    desc 'sync', 'Sync iCal and JSON'
     def sync
-      schedule = Schedule.new
-      schedule.load_master_files
+      schedule = load_schedule
+      schedule.sort_by_date!
       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
+      schedule = load_schedule
     end
 
     desc 'version', 'Show the version information'
@@ -56,6 +52,24 @@ module Hanreki
 
     private
 
+    def load_schedule()
+      schedule = Schedule.new
+      begin
+        schedule.load_master_files
+      rescue ValidationError => e
+        message = 'validation error'
+        if e.event
+          message += " at line #{e.event.line_number}" if e.event.line_number
+          message += " in #{e.event.filename}" if e.event.filename
+          message += "\n#{e.event.row.to_s.strip}" if e.event.row
+        end
+        message += "\n#{e}"
+        puts message
+        exit 1
+      end
+      schedule
+    end
+
     # Parse a string (YYYYMM) in options[:date] and returns [YYYY, MM]
     def parse_month_in_options(options, default = nil)
       date = options[:date]

data/lib/hanreki/event.rb

@@ -1,10 +1,12 @@
 require 'icalendar'
+require 'hanreki/exceptions'
 require 'hanreki/time_util'
 
 # Event of CAMPHOR- Schedule
 class Event
   using ExtendTime
   DOWS = %w(日 月 火 水 木 金 土)
+  attr_accessor :filename, :line_number, :row
   attr_accessor :start, :end
   attr_accessor :public_summary, :private_summary
   attr_accessor :url
@@ -23,29 +25,34 @@ class Event
   # 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({})
+  def self.from_master(filename, line_number, month, line)
+    event = Event.new({
+      row: line,
+      filename: filename,
+      line_number: line_number,
+    })
     first_day = Date.parse("#{month}01")
+    raise ValidationError.new(event), 'invalid number of columns' unless line.length == 7
     day, dow, 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}"))
+    raise ValidationError.new(event), 'invalid day' unless day.length == 2
+    raise ValidationError.new(event), 'invalid day' unless (first_day...first_day.next_month).include?(Date.parse("#{month}#{day}"))
     event.start = Time.parse("#{month}#{day} #{hour_start} +09:00").getlocal("+09:00")
     event.end = Time.parse("#{month}#{day} #{hour_end} +09:00").getlocal("+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?
     # 曜日はインスタンス変数に保持しないのでここでチェックする
-    raise ArgumentError, 'invalid day of the week' unless DOWS.include? dow
-    raise ArgumentError, 'invalid day of the week' unless DOWS[event.start.wday] == dow
+    raise ValidationError.new(event), 'invalid day of the week' unless DOWS.include? dow
+    raise ValidationError.new(event), 'invalid day of the week' unless DOWS[event.start.wday] == dow
     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)
+    fail ValidationError.new(self), 'invalid type' unless [:public, :private].include?(type)
+    fail ValidationError.new(self), 'invalid time_type' unless [:time, :string].include?(time_type)
     hash = {
       start: @start,
       end: @end,
@@ -82,35 +89,41 @@ class Event
   # イベントのバリデーションを行う
   # バリデーションに成功した場合は true を返し, 失敗した場合は例外を送出する
   def validate
-    raise ArgumentError, 'invalid start & end' if @start > @end
+    raise ValidationError.new(self), 'invalid start & end' if @start > @end
 
     if @public_summary.nil? and @private_summary.nil?
-      raise ArgumentError, 'both summaries are not set'
+      raise ValidationError.new(self), 'both summaries are not set'
     end
 
     if @public_summary == 'Open'
       if @start == @end
-        raise ArgumentError, '"open" event should have duration'
+        raise ValidationError.new(self), '"open" event should have duration'
+      end
+    end
+
+    if @public_summary == 'Online Open'
+      if @start == @end
+        raise ValidationError.new(self), '"online open" event should have duration'
       end
     end
 
     if @private_summary == 'Closed'
       if not @public_summary.nil?
-        raise ArgumentError, 'invalid public summary for a closed event'
+        raise ValidationError.new(self), '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'
+        raise ValidationError.new(self), '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'
+        raise ValidationError.new(self), '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'
+        raise ValidationError.new(self), 'invalid url scheme'
       end
     end
 

data/lib/hanreki/exceptions.rb

@@ -0,0 +1,8 @@
+class ValidationError < StandardError
+  attr_reader :event
+
+  def initialize(event)
+    super
+    @event = event
+  end
+end

data/lib/hanreki/i_calendar.rb

@@ -19,8 +19,8 @@ class ICalendar
   end
 
   def set_event(event, type)
-    fail ArgumentError, 'Invalid date' unless event.start && event.end
-    fail ArgumentError, 'Invalid type' unless [:public, :private].include?(type)
+    fail ValidationError.new(event), 'invalid date' unless event.start && event.end
+    fail ValidationError.new(event), 'invalid type' unless [:public, :private].include?(type)
     @calendar.event do |e|
       e.dtstart = event.start
       e.dtend = event.end

data/lib/hanreki/schedule.rb

@@ -13,8 +13,6 @@ class Schedule
   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'
   JSON_SCHEMA_PATH = File.expand_path('../schema.json', __FILE__)
 
   def initialize
@@ -35,7 +33,7 @@ class Schedule
     @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) }
+        csv.map { |row| Event.from_master(f, $., month, row) }
       end
     end
   end
@@ -64,16 +62,6 @@ class Schedule
     end
   end
 
-  # Output private and public JSONP calendar files
-  def out_jsonp(callback = 'callback')
-    File.open(JSONP_PUBLIC_PATH, 'w') do |f|
-      f.write("#{callback}(#{events_to_json(public_events, :public)});")
-    end
-    File.open(JSONP_PRIVATE_PATH, 'w') do |f|
-      f.write("#{callback}(#{events_to_json(private_events, :private)});")
-    end
-  end
-
   # Output master file
   def out_master
     CSV.open(
@@ -88,6 +76,10 @@ class Schedule
     File.exists? file_path
   end
 
+  def sort_by_date!
+    @events.sort_by! { |e| [e.start, e.end] }
+  end
+
   private
 
   def file_path

data/lib/hanreki/version.rb

@@ -1,3 +1,3 @@
 module Hanreki
-  VERSION = '1.2.0'
+  VERSION = '4.2.0'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: hanreki
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 4.2.0
 platform: ruby
 authors:
 - CAMPHOR-
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-03 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: icalendar
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +116,7 @@ files:
 - lib/hanreki.rb
 - lib/hanreki/cli.rb
 - lib/hanreki/event.rb
+- lib/hanreki/exceptions.rb
 - lib/hanreki/i_calendar.rb
 - lib/hanreki/schedule.rb
 - lib/hanreki/schema.json
@@ -127,15 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple schedule manager for CAMPHOR-