blackcal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c49267c5358fa204f01ff7dca6d054f9725ae17bf3d20217bb8fcad773cca9c1
-  data.tar.gz: f52d729090a6c7c7274219c4461516eddcbdb7e50ada790922c886bf767a4209
+  metadata.gz: c23e691a5c3523795779efef15fe053f74136c0f0c1ce61acd8a57f8b988f761
+  data.tar.gz: 631199640ed9b4af0c913ae4a8b6c54ec11d5b3098996dcc0dedcac7dfb3c1e5
 SHA512:
-  metadata.gz: 3632b757a25e37ff7b90833ccde7d2fe0cce9195aa4382d027265a234e35db828e4af1cfadddc71508ea0a3567d7cad6f02ac9a4805e0016effd6e8569c3de4d
-  data.tar.gz: 775091c9427f3655f319063a6eac010fff45004362ee9577504222a88905ffe31201d7d5a67d73586afc3d88dad3615c7dc311a91b1d2c3d59f0911956758e57
+  metadata.gz: 15d610fec732303f9ea7badd1f8139298cb1161bdabf1baf6cee2c355a11cd826f3544747e7baa9159afed3818e83ae06d7fa32a68df7a4612c573e7daa49e27
+  data.tar.gz: 1792395fc246472ca622b39920c67f5829d911f1431c8853c1697ab7d380fba6bc278af3a4c24c21f73d579d6019e3f89f2b58c6bef5eefa8299513944f474f0

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 .byebug_history
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+# v0.2.0
+
+* Add `Blackcal::schedule`
+
+---
+
+## v0.1.0
+
+Is history..

data/README.md

@@ -22,16 +22,16 @@ Or install it yourself as:
 
 Schedule Mondays and Tuesdays
 ```ruby
-schedule = Blackcal::Schedule.new(weekdays: [:monday, :tuesday])
+schedule = Blackcal.schedule(weekdays: [:monday, :tuesday])
 schedule.cover?('2019-01-01 19:00')
 # => false
 schedule.cover?('2019-01-02 11:00')
 # => true
 ```
 
-Schedule between 18pm and 7am every day
+Schedule between 6pm and 7am every day
 ```ruby
-schedule = Blackcal::Schedule.new(start_hour: 18, finish_hour: 7)
+schedule = Blackcal.schedule(start_hour: 18, finish_hour: 7)
 schedule.cover?('2019-01-01 19:00')
 # => false
 schedule.cover?('2019-01-01 11:00')
@@ -40,34 +40,35 @@ schedule.cover?('2019-01-01 11:00')
 
 Schedule day 15 and 17 of month
 ```ruby
-schedule = Blackcal::Schedule.new(days: [15, 17])
+schedule = Blackcal.schedule(days: [15, 17])
 schedule.cover?('2019-01-15 19:00')
 # => false
 schedule.cover?('2019-01-01 11:00')
 # => true
 ```
 
-All options at once - schedule Tuesdays, day 15-25, between 18pm and 7am every day
+All options at once - schedule January, Mondays and Tuesdays, day 15-25, between 18pm and 7am
 ```ruby
-schedule = Blackcal::Schedule.new(
+schedule = Blackcal.schedule(
+  months: [:january],
   weekdays: [:monday, :tuesday],
   start_hour: 18, finish_hour: 7,
   days: (15..25).to_a
 )
 schedule.cover?('2019-01-15 19:00')
 # => false
-schedule.cover?('2019-01-01 11:00')
+schedule.cover?('2019-02-01 11:00')
 # => true
 ```
 
 Define when the schedule is active
 ```ruby
-Blackcal::Schedule.new(start_time: '2018-01-01 11:00', finish_time: '2019-01-01 11:00')
+Blackcal.schedule(start_time: '2018-01-01 11:00', finish_time: '2019-01-01 11:00')
 ```
 
 Matrix representation
 ```ruby
-schedule = Blackcal::Schedule.new(weekdays: :friday, start_hour: 10, finish_hour: 14)
+schedule = Blackcal.schedule(weekdays: :friday, start_hour: 10, finish_hour: 14)
 schedule.to_matrix(start_date: '2018-09-14', finish_date: '2018-09-16')
 # => [[true, ...], [true, ...]]
 ```

data/lib/blackcal/range/month_range.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Blackcal
+  # Month range
+  class MonthRange
+    MONTH_MAP = {
+      january: 1,
+      february: 2,
+      march: 3,
+      april: 4,
+      may: 5,
+      june: 6,
+      july: 7,
+      august: 8,
+      september: 9,
+      october: 10,
+      november: 11,
+      december: 12,
+    }.freeze
+
+    # @return [Array<Symbol>] months in range
+    attr_reader :months
+
+    # Initialize month range
+    # @param [Array<String>, Array<Symbol>, String, Symbol, nil] months
+    # @example
+    #   MonthRange.new(:january)
+    # @example
+    #   MonthRange.new([:december, :january])
+    def initialize(months)
+      @months = Array(months).map(&:to_sym) if months
+    end
+
+    # Returns true if it covers timestamp
+    # @return [Boolean]
+    def cover?(timestamp)
+      return false if @months.nil? || @months.empty?
+
+      months.any? do |month|
+        MONTH_MAP.fetch(month) == timestamp.month
+      end
+    end
+  end
+end

data/lib/blackcal/schedule.rb

@@ -2,10 +2,11 @@
 
 require 'time'
 
-require 'blackcal/time_range'
-require 'blackcal/time_of_day_range'
-require 'blackcal/weekday_range'
-require 'blackcal/day_range'
+require 'blackcal/range/time_range'
+require 'blackcal/range/time_of_day_range'
+require 'blackcal/range/weekday_range'
+require 'blackcal/range/month_range'
+require 'blackcal/range/day_range'
 require 'blackcal/slot_matrix'
 
 module Blackcal
@@ -16,6 +17,7 @@ module Blackcal
     # @param finish_time [Time, Date, String, nil]
     # @param start_hour [Integer, nil]
     # @param finish_hour [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]
     def initialize(
@@ -23,12 +25,14 @@ module Blackcal
       finish_time: nil,
       start_hour: nil,
       finish_hour: nil,
+      months: nil,
       weekdays: nil,
       # 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
     end
@@ -40,7 +44,7 @@ module Blackcal
       timestamp = parse_time(timestamp)
       return true if @rule_range && !@rule_range.cover?(timestamp)
 
-      [@weekdays, @days, @time_of_day].each do |range|
+      [@months, @weekdays, @days, @time_of_day].each do |range|
         return true if range && !range.cover?(timestamp)
       end
 

data/lib/blackcal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Blackcal
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/blackcal.rb

@@ -5,4 +5,10 @@ require 'blackcal/schedule'
 
 # Main module
 module Blackcal
+  # Initialize schedule
+  # @return [Schedule]
+  # @see Schedule#initialize
+  def self.schedule(**keyword_args)
+    Schedule.new(**keyword_args)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blackcal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jacob Burenstam
@@ -79,8 +79,8 @@ files:
 - ".rubocop.yml"
 - ".ruby-style-guide.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -88,13 +88,14 @@ files:
 - bin/setup
 - blackcal.gemspec
 - lib/blackcal.rb
-- lib/blackcal/day_range.rb
+- lib/blackcal/range/day_range.rb
+- lib/blackcal/range/month_range.rb
+- lib/blackcal/range/time_of_day_range.rb
+- lib/blackcal/range/time_range.rb
+- lib/blackcal/range/weekday_range.rb
 - lib/blackcal/schedule.rb
 - lib/blackcal/slot_matrix.rb
-- lib/blackcal/time_of_day_range.rb
-- lib/blackcal/time_range.rb
 - lib/blackcal/version.rb
-- lib/blackcal/weekday_range.rb
 homepage: https://github.com/buren/blackcal
 licenses:
 - MIT

data/Gemfile.lock

@@ -1,37 +0,0 @@
-PATH
-  remote: .
-  specs:
-    blackcal (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (10.0.2)
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  blackcal!
-  bundler (~> 1.16)
-  byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.2