availabiliter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b67cc74bfc51556d4ec00b9fc2a1a98364d78aca1ea7975a8970e36858b023c
-  data.tar.gz: e6c267b060c68affa3d4c122d97f821221c76f543486db80a8b8704b5a3e09c1
+  metadata.gz: e4398863d21393841d616f4fd47c7cfd3d5c7c3c04839735e4508cae695f07f1
+  data.tar.gz: dc7736e7c8a5ee4498719a8976e73b5923b35b0f32154bac151009db6eeb98b7
 SHA512:
-  metadata.gz: 3a4607aff951f4a9538cacc901ed45dd3f50f739d4b3662de249fb58257cd44e24621713bfabe585b2fac257ddc45016879dc372dc031e2dc5c74a91faca99e8
-  data.tar.gz: f48c05946d0488765966a6b8bb1bc130b833fa1d132cfc0a382bc4e5e40163e06ab8aff51782ef0fb004634a6066a74ef8ca431e8c2194e954116c0952ff6a22
+  metadata.gz: 60eb5709da8cd9dedee6e7246c517f27117e23aa04cfeb69e8945e67acdaada2e5b86e1b0c5ba67a94dcd2e88b06841b8881b5a9bd179e8d76f090cb09c66240
+  data.tar.gz: cf00b270e3afbef8253100d3784ce435ada6f2ef69a00ba6af41e01e26a6473295f339dc6f9ceaaa1f21ec9136c806c1d7bccb8c06e54bc6233b9773d40a89d5

data/.github/workflows/main.yml

@@ -1,6 +1,6 @@
-name: Ruby
+name: Tests
 
-on: [push,pull_request]
+on: [pull_request]
 
 jobs:
   build:
@@ -10,9 +10,12 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.1
-    - name: Run the default task
+        ruby-version: 2.7.2
+    - name: Set up gems
       run: |
         gem install bundler -v 2.2.15
         bundle install
-        bundle exec rake
+    - name: Run rspec
+      run: rspec spec
+    - name: Run rubocop
+      run: rubocop

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,2 +1,9 @@
+## Future releases
+- DateTime calculation
+
+## 0.2.0
+- Active Support dependency removal
+- Minor changes: removal of Gemfile.lock / wrap classes in a module to avoid clash with other code sources
+
 ## 0.1.0
 - Availabilities calculation with dates

data/README.md

@@ -5,7 +5,7 @@ Availabiliter is a Ruby availability calculator for date ranges. It handles the
 - endless date ranges
 - overlapping date ranges
 - consecutive date ranges
-- one day ranges
+- one day date ranges
 
 It also allows to calculate availabilities from a dedicated date in time.
 
@@ -29,29 +29,24 @@ Or install it yourself as:
 
 ```ruby
 # Build an array with all the date ranges you are looking an availability for
-range_array = [Date.new(1999, 1, 2)..Date.new(1999, 5, 1), Date.new(2000, 1, 1)..Date.new(2000, 2, 1), Date.new(2000, 3, 1)..nil]
+holidays = [Date.new(1999, 1, 2)..Date.new(1999, 5, 1), Date.new(2000, 1, 1)..Date.new(2000, 2, 1), Date.new(2000, 3, 1)..nil]
 
-Availabiliter.get_availabilities(range_array)
+Availabiliter.get_availabilities(holidays)
 # => [Date.new(1999, 5, 2)..Date.new(1999, 12, 31), Date.new(2000, 2, 2)..Date.new(2000, 2, 29)]
 
 # If you want to retrieve availabilities starting from a specific date simply add it as a second argument
-Availabiliter.get_availabilities(range_array, Date.new(1999, 12, 15))
+Availabiliter.get_availabilities(holidays, Date.new(1999, 12, 15))
 # => [Date.new(1999, 12, 15)..Date.new(1999, 12, 31), Date.new(2000, 2, 2)..Date.new(2000, 2, 29)]
 
 # If all of your date ranges have an end the last availability will be endless
-range_array = [Date.new(1999, 1, 2)..Date.new(1999, 5, 1)]
+holidays = [Date.new(1999, 1, 2)..Date.new(1999, 5, 1)]
 
-Availabiliter.get_availabilities(range_array)
+Availabiliter.get_availabilities(holidays)
 # => [Date.new(1999, 5, 2)..]
 
 ```
-## Dependencies
-
-This gem depends solely on Active Support gem. One of the future planned improvement is to remove this dependency.
-
 ## Future improvements
 
-- remove any dependency from the project
 - support Datetime
 - support beginless ranges
 

data/availabiliter.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", "~> 6.1.3.2"
   spec.add_development_dependency "byebug", "~> 11.1.3"
   spec.add_development_dependency "rake", "~> 13.0.3"
   spec.add_development_dependency "rspec", "~> 3.10"

data/lib/availabiliter/date_range.rb

@@ -1,66 +1,68 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/date/calculations"
+require "date"
 
-# DateRange is a Range with only dates
-# DateRange start_date is always the earliest date and end_date the latest date
-class DateRange < Range
-  include Comparable
+module Availabiliter
+  # DateRange is a Range with only dates
+  # DateRange start_date is always the earliest date and end_date the latest date
+  class DateRange < Range
+    include Comparable
 
-  alias start_date begin
-  alias end_date end
+    alias start_date begin
+    alias end_date end
 
-  def initialize(start_date, end_date)
-    super
-    raise ArgumentError, "bad value for DateRange" unless valid?
-  end
+    def initialize(start_date, end_date)
+      super
+      raise ArgumentError, "bad value for DateRange" unless valid?
+    end
 
-  def independent?(other)
-    return true if other.nil?
+    def independent?(other)
+      return true if other.nil?
 
-    !overlaps?(other) && !adjacent?(other)
-  end
+      !overlaps?(other) && !adjacent?(other)
+    end
 
-  def tomorrow
-    end_date&.tomorrow
-  end
+    def tomorrow
+      end_date&.next_day
+    end
 
-  def yesterday
-    start_date.yesterday
-  end
+    def yesterday
+      start_date.prev_day
+    end
 
-  ## adjacent == touches but doesn't overlap other DateRange
-  def adjacent?(other)
-    return other.end_date == yesterday if end_date.nil?
+    ## adjacent == touches but doesn't overlap other DateRange
+    def adjacent?(other)
+      return other.end_date == yesterday if end_date.nil?
 
-    other.end_date == yesterday || other.start_date == tomorrow
-  end
+      other.end_date == yesterday || other.start_date == tomorrow
+    end
 
-  def overlaps?(other)
-    cover?(other.begin) || other.cover?(first)
-  end
+    def overlaps?(other)
+      cover?(other.begin) || other.cover?(first)
+    end
 
-  def next_availability(next_date_range)
-    return if end_date.nil?
-    return tomorrow..nil if next_date_range.nil?
-    return unless independent?(next_date_range)
+    def next_availability(next_date_range)
+      return if end_date.nil?
+      return tomorrow..nil if next_date_range.nil?
+      return unless independent?(next_date_range)
 
-    gap_start = tomorrow
-    gap_end = next_date_range.yesterday
+      gap_start = tomorrow
+      gap_end = next_date_range.yesterday
 
-    gap_start..gap_end
-  end
+      gap_start..gap_end
+    end
 
-  def furthest(other)
-    return self if end_date.nil? || other.nil?
-    return other if other.end_date.nil?
+    def furthest(other)
+      return self if end_date.nil? || other.nil?
+      return other if other.end_date.nil?
 
-    [self, other].max_by(&:end_date)
-  end
+      [self, other].max_by(&:end_date)
+    end
 
-  private
+    private
 
-  def valid?
-    start_date.instance_of?(Date) && (end_date.nil? || start_date < end_date)
+    def valid?
+      start_date.instance_of?(Date) && (end_date.nil? || start_date < end_date)
+    end
   end
 end

data/lib/availabiliter/timeframe.rb

@@ -2,66 +2,68 @@
 
 require_relative "date_range"
 
-# A TimeFrame is an object representing several DateRange instances. It can have a start.
-# It can have only one endless DateRange.
-class TimeFrame
-  attr_reader :start_date, :date_ranges
+module Availabiliter
+  # A TimeFrame is an object representing several DateRange instances. It can have a start.
+  # It can have only one endless DateRange.
+  class TimeFrame
+    attr_reader :start_date, :date_ranges
 
-  def initialize(array, start_date = nil)
-    @start_date = start_date
-    @date_ranges = build_date_ranges(array)
+    def initialize(array, start_date = nil)
+      @start_date = start_date
+      @date_ranges = build_date_ranges(array)
 
-    raise ArgumentError unless valid?
-  end
+      raise ArgumentError unless valid?
+    end
 
-  def availabilities
-    return [start_date..nil] if date_ranges.empty?
-    return build_availabilities if start_date.nil?
+    def availabilities
+      return [start_date..nil] if date_ranges.empty?
+      return build_availabilities if start_date.nil?
 
-    availabilities = build_availabilities
-    start_date < first_date_range.start_date ? availabilities.unshift(first_availability) : availabilities
-  end
+      availabilities = build_availabilities
+      start_date < first_date_range.start_date ? availabilities.unshift(first_availability) : availabilities
+    end
 
-  private
+    private
 
-  def build_date_ranges(array)
-    date_range_array = array.filter_map do |range|
-      next if out_of_timeframe?(range.end)
+    def build_date_ranges(array)
+      date_range_array = array.filter_map do |range|
+        next if out_of_timeframe?(range.end)
 
-      DateRange.new(range.begin, range.end)
-    end
+        DateRange.new(range.begin, range.end)
+      end
 
-    date_range_array.sort_by(&:start_date)
-  end
+      date_range_array.sort_by(&:start_date)
+    end
 
-  def build_availabilities
-    furthest_date_range = first_date_range
+    def build_availabilities
+      furthest_date_range = first_date_range
 
-    date_ranges.filter_map.with_index do |date_range, index|
-      next_date_range = date_ranges[index + 1]
+      date_ranges.filter_map.with_index do |date_range, index|
+        next_date_range = date_ranges[index + 1]
 
-      furthest_date_range = furthest_date_range.furthest(date_range)
-      furthest_date_range.next_availability(next_date_range)
+        furthest_date_range = furthest_date_range.furthest(date_range)
+        furthest_date_range.next_availability(next_date_range)
+      end
     end
-  end
 
-  def out_of_timeframe?(range_end)
-    start_date.present? && (range_end.present? && range_end < start_date)
-  end
+    def out_of_timeframe?(range_end)
+      !start_date.nil? && (!range_end.nil? && range_end < start_date)
+    end
 
-  def first_availability
-    start_date..first_date_range.yesterday
-  end
+    def first_availability
+      start_date..first_date_range.yesterday
+    end
 
-  def first_date_range
-    date_ranges.first
-  end
+    def first_date_range
+      date_ranges.first
+    end
 
-  def valid?
-    end_date_valid? && date_ranges.count { |date_range| date_range.end_date.nil? } <= 1
-  end
+    def valid?
+      end_date_valid? && date_ranges.count { |date_range| date_range.end_date.nil? } <= 1
+    end
 
-  def end_date_valid?
-    start_date.instance_of?(Date) || start_date.instance_of?(NilClass)
+    def end_date_valid?
+      start_date.instance_of?(Date) || start_date.instance_of?(NilClass)
+    end
   end
 end

data/lib/availabiliter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Availabiliter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: availabiliter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - lioneldebauge
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.3.2
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.16.1
-description:
+description: 
 email:
 - lionel@livecolonies.com
 executables: []
@@ -93,7 +79,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -112,7 +97,7 @@ metadata:
   homepage_uri: https://github.com/lioneldebauge/availabiliter.git
   source_code_uri: https://github.com/lioneldebauge/availabiliter.git
   changelog_uri: https://github.com/lioneldebauge/availabiliter/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -127,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Availabiliter calculates availabilities for ruby ranges within a given time
   frame.

data/Gemfile.lock

@@ -1,71 +0,0 @@
-PATH
-  remote: .
-  specs:
-    availabiliter (0.1.0)
-      activesupport (~> 6.1.3.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.16.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  arm64-darwin-20
-
-DEPENDENCIES
-  availabiliter!
-  byebug (~> 11.1.3)
-  rake (~> 13.0.3)
-  rspec (~> 3.10)
-  rubocop (~> 1.16.1)
-
-BUNDLED WITH
-   2.2.15