availabiliter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b67cc74bfc51556d4ec00b9fc2a1a98364d78aca1ea7975a8970e36858b023c
+  data.tar.gz: e6c267b060c68affa3d4c122d97f821221c76f543486db80a8b8704b5a3e09c1
+SHA512:
+  metadata.gz: 3a4607aff951f4a9538cacc901ed45dd3f50f739d4b3662de249fb58257cd44e24621713bfabe585b2fac257ddc45016879dc372dc031e2dc5c74a91faca99e8
+  data.tar.gz: f48c05946d0488765966a6b8bb1bc130b833fa1d132cfc0a382bc4e5e40163e06ab8aff51782ef0fb004634a6066a74ef8ca431e8c2194e954116c0952ff6a22

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug historic
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.7.2
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+- Availabilities calculation with dates

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in availabiliter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+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

data/LICENSE.txt

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

@@ -0,0 +1,70 @@
+# Availabiliter
+
+Availabiliter is a Ruby availability calculator for date ranges. It handles the following edge cases:
+
+- endless date ranges
+- overlapping date ranges
+- consecutive date ranges
+- one day ranges
+
+It also allows to calculate availabilities from a dedicated date in time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'availabiliter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install availabiliter
+
+## Usage
+
+```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]
+
+Availabiliter.get_availabilities(range_array)
+# => [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))
+# => [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)]
+
+Availabiliter.get_availabilities(range_array)
+# => [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
+
+## 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 the created tag, 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/lioneldebauge/availabiliter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/availabiliter.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/availabiliter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "availabiliter"
+  spec.version       = Availabiliter::VERSION
+  spec.authors       = ["lioneldebauge"]
+  spec.email         = ["lionel@livecolonies.com"]
+
+  spec.summary       = "Availabiliter calculates availabilities for ruby ranges within a given time frame."
+  spec.homepage      = "https://github.com/lioneldebauge/availabiliter.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.2")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lioneldebauge/availabiliter.git"
+  spec.metadata["changelog_uri"] = "https://github.com/lioneldebauge/availabiliter/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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"
+  spec.add_development_dependency "rubocop", "~> 1.16.1"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "availabiliter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/availabiliter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "availabiliter/version"
+require_relative "availabiliter/timeframe"
+
+# Availability calculator class
+module Availabiliter
+  class << self
+    def get_availabilities(array, timeframe_start = nil)
+      TimeFrame.new(array, timeframe_start).availabilities
+    end
+  end
+end

data/lib/availabiliter/date_range.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/date/calculations"
+
+# 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
+
+  def initialize(start_date, end_date)
+    super
+    raise ArgumentError, "bad value for DateRange" unless valid?
+  end
+
+  def independent?(other)
+    return true if other.nil?
+
+    !overlaps?(other) && !adjacent?(other)
+  end
+
+  def tomorrow
+    end_date&.tomorrow
+  end
+
+  def yesterday
+    start_date.yesterday
+  end
+
+  ## 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
+
+  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)
+
+    gap_start = tomorrow
+    gap_end = next_date_range.yesterday
+
+    gap_start..gap_end
+  end
+
+  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
+
+  private
+
+  def valid?
+    start_date.instance_of?(Date) && (end_date.nil? || start_date < end_date)
+  end
+end

data/lib/availabiliter/timeframe.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+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
+
+  def initialize(array, start_date = nil)
+    @start_date = start_date
+    @date_ranges = build_date_ranges(array)
+
+    raise ArgumentError unless valid?
+  end
+
+  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
+
+  private
+
+  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
+
+    date_range_array.sort_by(&:start_date)
+  end
+
+  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]
+
+      furthest_date_range = furthest_date_range.furthest(date_range)
+      furthest_date_range.next_availability(next_date_range)
+    end
+  end
+
+  def out_of_timeframe?(range_end)
+    start_date.present? && (range_end.present? && range_end < start_date)
+  end
+
+  def first_availability
+    start_date..first_date_range.yesterday
+  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 end_date_valid?
+    start_date.instance_of?(Date) || start_date.instance_of?(NilClass)
+  end
+end

data/lib/availabiliter/version.rb

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: availabiliter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lioneldebauge
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-13 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+description:
+email:
+- lionel@livecolonies.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- availabiliter.gemspec
+- bin/console
+- bin/setup
+- lib/availabiliter.rb
+- lib/availabiliter/date_range.rb
+- lib/availabiliter/timeframe.rb
+- lib/availabiliter/version.rb
+homepage: https://github.com/lioneldebauge/availabiliter.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Availabiliter calculates availabilities for ruby ranges within a given time
+  frame.
+test_files: []