blackcal 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c23e691a5c3523795779efef15fe053f74136c0f0c1ce61acd8a57f8b988f761
-  data.tar.gz: 631199640ed9b4af0c913ae4a8b6c54ec11d5b3098996dcc0dedcac7dfb3c1e5
+  metadata.gz: db977cf2c574a0e8d76891abfa30a6b8140e5ec07bfc0f2b23a215b03732d166
+  data.tar.gz: 8b3deb0295ba37f2ff1440cf8e4eed055dcdd77ac728a25e26b48edce491e381
 SHA512:
-  metadata.gz: 15d610fec732303f9ea7badd1f8139298cb1161bdabf1baf6cee2c355a11cd826f3544747e7baa9159afed3818e83ae06d7fa32a68df7a4612c573e7daa49e27
-  data.tar.gz: 1792395fc246472ca622b39920c67f5829d911f1431c8853c1697ab7d380fba6bc278af3a4c24c21f73d579d6019e3f89f2b58c6bef5eefa8299513944f474f0
+  metadata.gz: f13e108edab2e980c18b9650145b084bf01ec391e007d78612991a4a4337d47040a7dae5bcce4ad61acc8ddcb786809bafbdea3b6cf743d5e4e14c7b26035e03
+  data.tar.gz: 31e1e04b3929f06519a67a855e276b3771fc360b4e889d3f35b7bc5b3f4e0928617c8dfe2f0edd0cccca671b95e54d9d01c532cbaa4d7f08a145d219ed903271

data/.yardopts

@@ -0,0 +1,3 @@
+--markup-provider=redcarpet
+--markup=markdown
+--no-private

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+# v0.3.0
+
+* Minute level resolution support
+  - Enhance `Schedule#to_matrix`
+  - Enhance `TimeOfDayRange`
+  - New `TimeOfDay` class
+* Include `Enumerable` in all ranges
+
 # v0.2.0
 
 * Add `Blackcal::schedule`

data/README.md

@@ -24,27 +24,27 @@ Schedule Mondays and Tuesdays
 ```ruby
 schedule = Blackcal.schedule(weekdays: [:monday, :tuesday])
 schedule.cover?('2019-01-01 19:00')
-# => false
-schedule.cover?('2019-01-02 11:00')
 # => true
+schedule.cover?('2019-01-02 19:00')
+# => false
 ```
 
 Schedule between 6pm and 7am every day
 ```ruby
 schedule = Blackcal.schedule(start_hour: 18, finish_hour: 7)
 schedule.cover?('2019-01-01 19:00')
-# => false
-schedule.cover?('2019-01-01 11:00')
 # => true
+schedule.cover?('2019-01-01 11:00')
+# => false
 ```
 
 Schedule day 15 and 17 of month
 ```ruby
 schedule = Blackcal.schedule(days: [15, 17])
 schedule.cover?('2019-01-15 19:00')
-# => false
-schedule.cover?('2019-01-01 11:00')
 # => true
+schedule.cover?('2019-01-01 11:00')
+# => false
 ```
 
 All options at once - schedule January, Mondays and Tuesdays, day 15-25, between 18pm and 7am
@@ -56,9 +56,9 @@ schedule = Blackcal.schedule(
   days: (15..25).to_a
 )
 schedule.cover?('2019-01-15 19:00')
-# => false
-schedule.cover?('2019-02-01 11:00')
 # => true
+schedule.cover?('2019-02-01 11:00')
+# => false
 ```
 
 Define when the schedule is active
@@ -68,9 +68,14 @@ Blackcal.schedule(start_time: '2018-01-01 11:00', finish_time: '2019-01-01 11:00
 
 Matrix representation
 ```ruby
-schedule = Blackcal.schedule(weekdays: :friday, start_hour: 10, finish_hour: 14)
+schedule = Blackcal.schedule(weekdays: :friday, start_hour: 0, finish_hour: 14)
 schedule.to_matrix(start_date: '2018-09-14', finish_date: '2018-09-16')
-# => [[true, ...], [true, ...]]
+# => [[true, ...], [false, ...]]
+
+# defaults to hour resolution, but you can get minute resolution too
+schedule = Blackcal.schedule(weekdays: :friday, start_hour: 0, finish_hour: 14)
+schedule.to_matrix(resolution: :min, start_date: '2018-09-14', finish_date: '2018-09-16')
+# => [[true, ...], [false, ...]]
 ```
 
 ## Development

data/blackcal.gemspec

@@ -24,6 +24,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'github-markup', '~> 2.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/blackcal/range/day_range.rb

@@ -3,7 +3,9 @@
 module Blackcal
   # Number range
   class DayRange
-    # @return [Array<Symbol>] numbers in range
+    include Enumerable
+
+    # @return [Array<Integer>] numbers in range
     attr_reader :numbers
 
     # Initialize numbers range
@@ -23,5 +25,14 @@ module Blackcal
 
       numbers.include?(timestamp.day)
     end
+
+    # @return [Array<Integer>] numbers in range
+    alias_method :to_a, :numbers
+
+    # Iterate over range
+    # @see #to_a
+    def each(&block)
+      to_a.each(&block)
+    end
   end
 end

data/lib/blackcal/range/month_range.rb

@@ -3,6 +3,9 @@
 module Blackcal
   # Month range
   class MonthRange
+    include Enumerable
+
+    # Map month name to number
     MONTH_MAP = {
       january: 1,
       february: 2,
@@ -40,5 +43,14 @@ module Blackcal
         MONTH_MAP.fetch(month) == timestamp.month
       end
     end
+
+    # @return [Array<Symbol>] months in range
+    alias_method :to_a, :months
+
+    # Iterate over range
+    # @see #to_a
+    def each(&block)
+      to_a.each(&block)
+    end
   end
 end

data/lib/blackcal/range/time_of_day_range.rb

@@ -1,26 +1,94 @@
 # frozen_string_literal: true
 
+require 'blackcal/time_of_day'
+
 module Blackcal
   # Time of day range
   class TimeOfDayRange
+    include Enumerable
+
     # Initialize time of day range
+    # @param [TimeOfDay, Time, Integer, nil] start
+    # @param [TimeOfDay, Time, Integer, nil] finish
     def initialize(start, finish = nil)
-      @start = start || 0
-      @finish = finish || 0
-
-      @disallowed_hours = if @finish < @start
-                            (@start..23).to_a + (0..@finish).to_a
-                          else
-                            (@start..@finish).to_a
-                          end
+      @start = start
+      @finish = finish
     end
 
     # Returns true if it covers timestamp
     # @return [Boolean]
     def cover?(timestamp)
-      hour = timestamp.hour
-      # min = timestamp.min # TODO: Support minutes
-      @disallowed_hours.include?(hour)
+      return false if @start.nil? && @finish.nil?
+
+      t1 = TimeOfDay.new(timestamp.hour, timestamp.min)
+      if start == finish
+        t1 == start
+      elsif start > finish
+        t1 <= finish || t1 >= start
+      else
+        t1 >= start && t1 <= finish
+      end
+    end
+
+    # Return start hour
+    # @return [TimeOfDay]
+    def start
+      @start_time ||= to_time_of_day(@start || 0)
+    end
+
+    # Return finish hour
+    # @return [TimeOfDay]
+    def finish
+      @finish_time ||= to_time_of_day(@finish || 0)
+    end
+
+    # Returns range as an array
+    # @param resolution [Symbol] :hour our :min
+    # @return [Array<Array<Integer>>] times
+    def to_a(resolution: :hour)
+      return [] if @start.nil? && @finish.nil?
+
+      if finish < start
+        to_time_array(start, TimeOfDay.new(23), resolution) +
+          to_time_array(TimeOfDay.new(0), finish, resolution)
+      else
+        to_time_array(start, finish, resolution)
+      end
+    end
+
+    # Iterate over range
+    # @param resolution [Symbol] :hour our :min
+    def each(resolution: :hour, &block)
+      to_a(resolution: resolution).each(&block)
+    end
+
+    private
+
+    def to_time_array(start, finish, resolution)
+      if resolution == :hour
+        return (start.hour..finish.hour).map { |hour| [hour, 0] }
+      end
+
+      # minute resolution
+      times = []
+      (start.hour..finish.hour).each do |hour|
+        finish_min = if hour == finish.hour && finish.min != 0
+                       finish.min
+                     else
+                       59
+                     end
+        (start.min..finish_min).each { |min| times << [hour, min] }
+      end
+      times
+    end
+
+    def to_time_of_day(number_or_day)
+      return number_or_day if number_or_day.is_a?(TimeOfDay)
+      if number_or_day.is_a?(Time)
+        return TimeOfDay.new(number_or_day.hour, number_or_day.min)
+      end
+
+      TimeOfDay.new(number_or_day)
     end
   end
 end

data/lib/blackcal/range/time_range.rb

@@ -3,9 +3,13 @@
 module Blackcal
   # Time range
   class TimeRange
+    include Enumerable
+
     attr_reader :start, :finish
 
     # Initialize time range
+    # @param [Time, nil] start_time
+    # @param [Time, nil] finish_time optional
     def initialize(start_time, finish_time = nil)
       @start = start_time
       @finish = finish_time
@@ -23,5 +27,23 @@ module Blackcal
 
       false
     end
+
+    # Returns range as array
+    # @param resolution [Symbol] :hour our :min
+    # @return [Array<Array<Integer>>] times
+    def to_a(resolution: :hour)
+      resolution_multiplier = resolution == :hour ? 60 * 60 : 60
+      time_units = ((start - finish) / resolution_multiplier).abs.to_i
+
+      time_units.times.map do |time_unit|
+        start + (time_unit * resolution_multiplier)
+      end
+    end
+
+    # Iterate over range
+    # @param resolution [Symbol] :hour our :min
+    def each(resolution: :hour, &block)
+      to_a(resolution: resolution).each(&block)
+    end
   end
 end

data/lib/blackcal/range/weekday_range.rb

@@ -3,6 +3,9 @@
 module Blackcal
   # Weekday range
   class WeekdayRange
+    include Enumerable
+
+    # Map weekday name to number
     WEEKDAY_MAP = {
       sunday: 0,
       monday: 1,
@@ -35,5 +38,14 @@ module Blackcal
         WEEKDAY_MAP.fetch(weekday) == timestamp.wday
       end
     end
+
+    # @return [Array<Symbol>] weekdays in range
+    alias_method :to_a, :weekdays
+
+    # Iterate over range
+    # @see #to_a
+    def each(&block)
+      to_a.each(&block)
+    end
   end
 end

data/lib/blackcal/schedule.rb

@@ -15,11 +15,16 @@ module Blackcal
     # Initialize rule
     # @param start_time [Time, Date, String, nil]
     # @param finish_time [Time, Date, String, nil]
-    # @param start_hour [Integer, nil]
-    # @param finish_hour [Integer, nil]
+    # @param start_hour [TimeOfDay, Time, Integer, nil]
+    # @param finish_hour [TimeOfDay, Time, Integer, nil]
     # @param months [Array<String>, Array<Symbol>, String, Symbol, nil]
     # @param weekdays [Array<String>, Array<Symbol>, String, Symbol, nil]
     # @param days [Array<Integer>, Integer, nil]
+    # @see TimeRange#initialize
+    # @see TimeOfDayRange#initialize
+    # @see MonthRange#initialize
+    # @see WeekdayRange#initialize
+    # @see DayRange#initialize
     def initialize(
       start_time: nil,
       finish_time: nil,
@@ -30,11 +35,25 @@ module Blackcal
       # weeks_of_month: nil, # TODO
       days: nil
     )
-      @rule_range = TimeRange.new(parse_time(start_time), parse_time(finish_time)) if start_time || finish_time # rubocop:disable Metrics/LineLength
-      @time_of_day = TimeOfDayRange.new(start_hour, finish_hour) if start_hour || finish_hour # rubocop:disable Metrics/LineLength
-      @months = MonthRange.new(months) if months
-      @weekdays = WeekdayRange.new(weekdays) if weekdays
-      @days = DayRange.new(days) if days
+      if start_time || finish_time
+        @rule_range = TimeRange.new(parse_time(start_time), parse_time(finish_time))
+      end
+
+      if start_hour || finish_hour
+        @time_of_day = TimeOfDayRange.new(start_hour, finish_hour)
+      end
+
+      if months
+        @months = MonthRange.new(months)
+      end
+
+      if weekdays
+        @weekdays = WeekdayRange.new(weekdays)
+      end
+
+      if days
+        @days = DayRange.new(days)
+      end
     end
 
     # Returns true if calendar is open for timestamp
@@ -42,28 +61,29 @@ module Blackcal
     # @return [Boolean]
     def cover?(timestamp)
       timestamp = parse_time(timestamp)
-      return true if @rule_range && !@rule_range.cover?(timestamp)
+      return false if @rule_range && !@rule_range.cover?(timestamp)
 
-      [@months, @weekdays, @days, @time_of_day].each do |range|
-        return true if range && !range.cover?(timestamp)
-      end
+      ranges = [@months, @weekdays, @days, @time_of_day].compact
+      return false if ranges.empty?
 
-      false
+      ranges.all? { |range| range.cover?(timestamp) }
     end
 
     # Returns schedule represented as a matrix
     # @param start_date [Date]
     # @param finish_date [Date]
     # @return [Array<Array<Boolean>>]
-    def to_matrix(start_date:, finish_date:)
+    def to_matrix(start_date:, finish_date:, resolution: :hour)
       start_time = parse_time(start_date).to_time
       finish_time = parse_time(finish_date).to_time
-      matrix = SlotMatrix.new(24)
+      slots = resolution == :hour ? 24 : 24 * 60
+      matrix = SlotMatrix.new(slots)
 
       # TODO: This is needlessly inefficient..
-      seconds = (start_time - finish_time).abs
-      hours = (seconds / (60 * 60)).to_i
-      hours.times { |hour| matrix << cover?(start_time + (hour * 60 * 60)) }
+      time_range = TimeRange.new(start_time, finish_time)
+      time_range.each(resolution: resolution) do |time|
+        matrix << cover?(time)
+      end
 
       matrix.data
     end

data/lib/blackcal/slot_matrix.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module Blackcal
+  # Slot matrix
   class SlotMatrix
+    # Initialize slot matrix
+    # @param [Integer] slots max elements in each slot
     def initialize(slots)
       @matrix = [[]]
       @slots = slots

data/lib/blackcal/time_of_day.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Blackcal
+  # Represents a time of day (hour and min)
+  class TimeOfDay
+    include Comparable
+
+    # @return [Integer] hour
+    attr_reader :hour
+
+    # @return [Integer] minutes defaults to 0
+    attr_reader :min
+
+    # Initialize time of day
+    # @param [Integer] hour
+    # @param [Integer, nil] min optional argument
+    def initialize(hour, min = nil)
+      @hour = hour
+      @min = min || 0
+    end
+
+    # Compares two time of days
+    # @param [TimeOfDay, Integer] other if a number is passed it will be used as the hour
+    # @return [Integer] 1 if greater than, 0 if equal, -1 if less than
+    def <=>(other)
+      other_seconds = if other.is_a?(self.class)
+                        (other.hour * 60 * 60) + (other.min * 60)
+                      else
+                        other * 60 * 60
+                      end
+      seconds = (hour * 60 * 60) + (min * 60)
+
+      seconds <=> other_seconds
+    end
+  end
+end

data/lib/blackcal/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Blackcal
-  VERSION = '0.2.0'.freeze
+  # Gem version
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: blackcal
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-09-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +121,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-style-guide.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -95,6 +138,7 @@ files:
 - lib/blackcal/range/weekday_range.rb
 - lib/blackcal/schedule.rb
 - lib/blackcal/slot_matrix.rb
+- lib/blackcal/time_of_day.rb
 - lib/blackcal/version.rb
 homepage: https://github.com/buren/blackcal
 licenses: