periodoxical 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e68e36720b518a871efe0ea34eb09f94b99880f5ebda37f5123469839b8a6b94
+  data.tar.gz: 7dd9b4f9e7439c6875dc689bd08fc4b3e145f81a886eaaa5b8f5c879f1839377
+SHA512:
+  metadata.gz: 8f5fd0e511bc2363d7487247b4fe528b5c8bd2e8b05d590b35ecf3d0726cda68b673f6f69dcb5c1e9d66b27998fb702161f8925afbc474e00df19ac13c105d6f
+  data.tar.gz: f8fc94f6e17ddeba3815c6f5baf4dc1881dd4c0fd8cfd6bf1e5e756cc393499da79c8d11f72b37fd1f3797d18c9bd1e62b95699b2c62ba3b61de524ce91f3308

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at steven@fountain.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in periodoxical.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    periodoxical (0.1.0)
+      tzinfo (>= 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binding_of_caller (1.0.1)
+      debug_inspector (>= 1.2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    debug_inspector (1.2.0)
+    diff-lcs (1.5.1)
+    method_source (1.1.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
+      pry (~> 0.13)
+    rake (10.5.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  bundler (~> 2.4)
+  periodoxical!
+  pry-byebug
+  pry-stack_explorer
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Steven Li
+
+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,86 @@
+# Periodoxical
+
+_"Up, and down, and in the end, it's only round and round and round..._" - Pink Floyd, "Us and Them"
+
+Generate periodic dates/times based on rules. Great for (but not limited to) calendar and scheduling applications. 
+See Usage for examples/details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'periodoxical'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install periodoxical
+
+## Usage
+
+```rb
+# generates 9:00AM - 10:30AM and 2:00PM - 2:30PM time blocks
+# on Mondays, Wednesdays, and Thursdays, between the dates of
+# May 23, 2024 and June 24, 2024
+
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  days_of_week: %w[mon wed thu],
+  time_blocks: [
+    {
+      start_time: '9:00AM',
+      end_time: '10:30AM'
+    },
+    {
+      start_time: '2:00PM',
+      end_time: '2:30PM'
+    }
+  ],
+  start_date: Date.parse('2024-05-23'),
+  end_date: Date.parse('2024-06-24')
+)
+# returns an array of hashes, each with a :start, :end
+#=> 
+[
+    {
+        :start=>#<DateTime: 2024-05-23T16:00:00+00:00>,
+        :end=>#<DateTime: 2024-05-23T16:00:00+00:00>
+    },
+    {
+        :start=>#<DateTime: 2024-05-23T16:00:00+00:00>,
+        :end=>#<DateTime: 2024-05-23T16:00:00+00:00>
+    },
+    {
+        :start=>#<DateTime: 2024-05-30T16:00:00+00:00>,
+        :end=>#<DateTime: 2024-05-30T16:00:00+00:00>
+    },
+    {   :start=>#<DateTime: 2024-05-30T16:00:00+00:00>,
+        :end=>#<DateTime: 2024-05-30T16:00:00+00:00>
+    },
+
+    ...
+]
+```
+
+## 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 tags, 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/[USERNAME]/periodoxical. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Periodoxical project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/periodoxical/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "periodoxical"
+
+# 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/periodoxical/version.rb

@@ -0,0 +1,3 @@
+module Periodoxical
+  VERSION = "0.1.1"
+end

data/lib/periodoxical.rb

@@ -0,0 +1,122 @@
+require "periodoxical/version"
+require "date"
+require "time"
+require "tzinfo"
+
+module Periodoxical
+  class << self
+    def generate(**opts)
+      Core.new(**opts).generate
+    end
+  end
+
+  class Core
+    VALID_DAYS_OF_WEEK = %w[mon tue wed thu fri sat sun].freeze
+    # @param [String] time_zone
+    #   Ex: 'America/Los_Angeles', 'America/Chicago',
+    #   TZInfo::DataTimezone#name from the tzinfo gem (https://github.com/tzinfo/tzinfo)
+    # @param [Date] start_date
+    # @param [Date] end_date
+    # @param [Array<String>, nil] days_of_week
+    #   Days of the week to generate the times for, if nil, then times are generated
+    #   for every day.
+    #   Ex: %w(mon tue wed sat)
+    # @param [Integer] limit
+    #   How many date times to generate.  To be used when `end_date` is nil.
+    # @param [Hash<Hash>] day_of_week_hours
+    #   To be used when hours are different between days of the week
+    #   Ex: {
+    #     mon: [{ start_time: '10:15AM', end_time: '11:35AM' }, { start_time: '9:00AM' }, {end_time: '4:30PM'} ],
+    #     tue: { start_time: '11:30PM', end_time: '12:00AM' },
+    #     fri: { start_time: '7:00PM', end_time: '9:00PM' },
+    #   }
+    def initialize(time_zone: 'Etc/UTC', days_of_week: nil,
+                   start_date:, end_date:, time_blocks: nil, day_of_week_hours: nil, limit: nil)
+      @time_zone = TZInfo::Timezone.get(time_zone)
+      @days_of_week = days_of_week
+      @time_blocks = time_blocks
+      @day_of_week_hours = day_of_week_hours
+      @start_date = start_date
+      @end_date = end_date
+      @limit = limit
+      validate!
+    end
+
+    # @return [Array<Hash<DateTime>>]
+    #   Ex: [
+    #     {
+    #       start: #<DateTime>,
+    #       end: #<DateTime>,
+    #     }
+    #   ]
+    def generate
+      if @days_of_week && @time_blocks
+        generate_from_days_of_week_time_blocks
+      end
+    end
+
+    private
+
+    def generate_from_days_of_week_time_blocks
+      times = []
+      current_date = @start_date
+      while current_date <= @end_date
+        day_of_week = day_of_week_long_to_short(current_date.strftime("%A"))
+        if @days_of_week.include?(day_of_week)
+          @time_blocks.each do |tb|
+            times << {
+              start: time_str_to_object(current_date, tb[:start_time]),
+              end: time_str_to_object(current_date, tb[:end_date])
+            }
+          end
+        end
+        current_date = current_date + 1
+      end
+      times
+    end
+
+    def validate!
+      # days of week are valid
+      if @days_of_week
+        @days_of_week.each do |day|
+          unless VALID_DAYS_OF_WEEK.include?(day.to_s)
+            raise "#{day} is not valid day of week format.  Must be: #{VALID_DAYS_OF_WEEK}"
+          end
+        end
+      end
+
+      if @day_of_week_hours
+        @day_of_week_hours.keys.each do |d|
+          unless VALID_DAYS_OF_WEEK.include?(d)
+            raise "#{d} is not a valid day of week format. Must be #{VALID_DAYS_OF_WEEK}"
+          end
+        end
+      end
+
+      unless (@days_of_week && @start_time && @end_time) || (@day_of_week_hours)
+      end
+    end
+
+    def day_of_week_long_to_short(dow)
+      {
+        "Thursday" => "thu"
+      }[dow]
+    end
+
+    # @param [String] time_str
+    #   Ex: '9:00AM'
+    # @param [Date] date
+    def time_str_to_object(date, time_str)
+      time = Time.strptime("9:00AM", "%I:%M%p")
+      date_time = DateTime.new(
+        date.year,
+        date.month,
+        date.day,
+        time.hour,
+        time.min,
+        time.sec,
+      )
+      @time_zone.local_to_utc(date_time).new_offset(@time_zone.current_period.offset.utc_total_offset)
+    end
+  end
+end

data/periodoxical.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "periodoxical/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "periodoxical"
+  spec.version       = Periodoxical::VERSION
+  spec.authors       = ["Steven Li"]
+  spec.email         = ["stevenji@gmail.com"]
+
+  spec.summary       = %q{Generating date/times based on rules.  Perfect for (but not limited to) calendar/scheduling applications.}
+  spec.description   = %q{Generating date/times based on rules.  Perfect for (but not limited to) calendar/scheduling applications. Generate times based on rules like days of the week, timezones, time blocks, start dates, end dates, etc.}
+  spec.homepage      = "https://github.com/StevenJL/periodoxical"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/StevenJL/periodoxical"
+    spec.metadata["changelog_uri"] = "https://github.com/StevenJL/periodoxical"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'tzinfo', '~> 2.0', '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.10"
+  spec.add_development_dependency "pry-stack_explorer", "~> 0.6"
+
+  spec.required_ruby_version = '>= 3.0.0'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: periodoxical
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Steven Li
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Generating date/times based on rules.  Perfect for (but not limited to)
+  calendar/scheduling applications. Generate times based on rules like days of the
+  week, timezones, time blocks, start dates, end dates, etc.
+email:
+- stevenji@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/periodoxical.rb
+- lib/periodoxical/version.rb
+- periodoxical.gemspec
+homepage: https://github.com/StevenJL/periodoxical
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/StevenJL/periodoxical
+  source_code_uri: https://github.com/StevenJL/periodoxical
+  changelog_uri: https://github.com/StevenJL/periodoxical
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Generating date/times based on rules.  Perfect for (but not limited to) calendar/scheduling
+  applications.
+test_files: []