retail_calendars 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3db4ee8429e1bb3f4710b1fa3e1dd07c295c40a95bdcfb977afa18f98ef72b90
+  data.tar.gz: 4c7017d1445f63a09a0d9b032975e84f71340240230ac7f01ac7a513150e45b1
+SHA512:
+  metadata.gz: 4c9f9d4579f87da55626be4b854def7903c0d9ac85c08d9eceb7040421a734406ca07c43139335e9267bb13c25501f7349b2daa928d7e2f86b868ec2a2cacdf6
+  data.tar.gz: 43e9b08dc8571f407ac491854ff798cc5bbab0fdd14f270d99239629cf61be0ec5a659313fad123a53bd41bc44cdb693af5b0d84210f9452988f67986d46f8af

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+# 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.3
+before_install: gem install bundler -v 2.0.1

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 j.blum@youngcapital.nl. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in retail_calendar.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    retail_calendars (0.1.0)
+      activesupport (>= 3, < 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  retail_calendars!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Joel Blum
+
+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,56 @@
+# RetailCalendar
+
+
+
+## Installation
+
+This gem implements 4-4-5 / 4-5-4 / 5-4-4 retail calendar in a very lightweight manner.
+https://en.wikipedia.org/wiki/4%E2%80%934%E2%80%935_calendar
+
+While several similar gems that do this exist (most notably the gem retail_calendar), I couldn't find one that supports all forms 445, 454, 544 and that doesn't have serious issues and stale pull requests.
+
+Credit due to Brian K https://stackoverflow.com/questions/23531481/is-there-a-way-in-ruby-to-find-the-beginning-of-the-year-in-a-4-5-4-retail-cal
+
+IMPORTANT: when installing, make sure you type the gem's name 'retail_calendars' and not retail_calendar
+
+```ruby
+gem 'retail_calendars'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install retail_calendars
+
+## Usage
+
+    calendar = RetailCalendar::Calendar.new(type: 445)
+    
+    puts calendar.start_of_year(2020) # 2020-02-02
+    puts calendar.start_of_year_by_date(Date.today) # 2020-02-02
+    puts calendar.end_of_year(2020) # 2021-01-30
+    puts calendar.start_of_month(2020, 1) # 2020-02-02
+    puts calendar.end_of_month(2020, 1) # 2020-02-29
+    puts calendar.weeks_in_year(2020) # 52
+    puts calendar.retail_week_to_date(2, 2020) # {:start_week=>Sun, 09 Feb 2020, :end_week=>Sat, 15 Feb 2020}
+    
+## 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]/retail_calendar. 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 RetailCalendar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/retail_calendar/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 "retail_calendar"
+
+# 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/retail_calendar.rb

@@ -0,0 +1,10 @@
+require "retail_calendar/version"
+require "retail_calendar/calendar"
+require "date"
+require 'active_support'
+require 'active_support/core_ext'
+# Class for 5-4-4, 4-5-4, and 4-4-5 calendars
+module RetailCalendar
+end
+
+

data/lib/retail_calendar/calendar.rb

@@ -0,0 +1,104 @@
+module RetailCalendar
+  class Calendar
+    def initialize(type: 445, year_end_month: 1)
+      raise ArgumentError, "Bad calendar type #{type}" unless [544, 454, 445].include?(type)
+      raise ArgumentError, "Bad year-end month #{year_end_month}" unless year_end_month.between?(1, 12)
+
+      @type = type
+      @yr_end_mo = year_end_month
+    end
+
+# Return the ending date for a particular year
+    def end_of_year(year)
+      year += 1 unless @yr_end_mo == 12
+      year_end = Date.new year, @yr_end_mo, -1
+      wday = (year_end.wday + 1) % 7 # Saturday-origin day-of-week
+      # Advance or retreat to closest Saturday
+      if wday > 3 then year_end += 7 - wday
+      elsif wday > 0 then year_end -= wday
+      end
+      year_end
+    end
+
+# Return starting of retail date for a particular year
+    def start_of_year(year)
+      end_of_year(year - 1) + 1
+    end
+
+# Returns the start of the retail_year for the given date
+    def start_of_year_by_date(date)
+      date -= 1.year if date < start_of_year(date.year)
+      start_of_year(date.year)
+    end
+
+# Return starting date for a particular month
+# param: month is the merch month of the year
+    def start_of_month(year, month)
+      start = start_of_year(year) + ((month - 1) / 3).to_i * 91
+      case @type * 10 + (month - 1) % 3
+      when 4451, 4541 then start += 28
+      when 5441 then start += 35
+      when 4452 then start += 56
+      when 4542, 5442 then start += 63
+      end
+      start
+    end
+
+# Return the ending date for a particular month
+    def end_of_month(year, month)
+      if month == 12 then end_of_year year
+      else start_of_month(year, month + 1) - 1
+      end
+    end
+
+# Return the number of weeks in a particular year
+    def weeks_in_year(year)
+      ((start_of_year(year + 1) - start_of_year(year)) / 7).to_i
+    end
+
+# What week it is within the retail year from 1-53
+# @return [Integer] The week number of the year, from 1-53
+    def year_week(date)
+      (((date - start_of_year_by_date(date)) + 1) / 7.0).ceil
+    end
+
+# what month it is within the retail year for a given date
+    def year_month(date)
+      month = date.month
+      RetailCalendar.julian_to_merch(month)
+    end
+
+# accetps retail week (1..53) and returns the week's date
+    def retail_week_to_date(retail_week, year)
+      start_week =  start_of_year(year) + (retail_week - 1).weeks
+      { start_week: start_week, end_week: start_week + 6.days }
+    end
+
+# Converts a retail month to the correct julian month
+# @param merch_month [Integer] the merch month to convert
+# @return [Integer] the julian month
+    def self.merch_to_julian(merch_month)
+      raise ArgumentError if merch_month > 12 || merch_month <= 0
+
+      if merch_month == 12
+        1
+      else
+        merch_month + 1
+      end
+    end
+
+# Converts a julian month to a merch month
+#
+# @param julian_month [Integer] the julian month to convert
+# @return [Integer] the merch month
+    def self.julian_to_merch(julian_month)
+      raise ArgumentError if julian_month > 12 || julian_month <= 0
+
+      if julian_month == 1
+        12
+      else
+        julian_month - 1
+      end
+    end
+  end
+end

data/lib/retail_calendar/version.rb

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

data/retail_calendar.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "retail_calendar/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "retail_calendars"
+  spec.version       = RetailCalendar::VERSION
+  spec.authors       = ["Joel Blum"]
+  spec.email         = ["yoelblumenator@gmail.com"]
+  spec.required_ruby_version = '~> 2.0'
+  spec.summary       = %q{Implements retail calendar}
+  spec.description   = %q{Supports 445, 454 and 544 calendars}
+  spec.homepage      = "https://github.com/yoelblum/retail_calendar"
+  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/yoelblum/retail_calendar"
+    spec.metadata["changelog_uri"] = "http://todo.com"
+  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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport", ">=3", "<7"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: retail_calendars
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joel Blum
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Supports 445, 454 and 544 calendars
+email:
+- yoelblumenator@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/retail_calendar.rb
+- lib/retail_calendar/calendar.rb
+- lib/retail_calendar/version.rb
+- retail_calendar.gemspec
+- retail_calendars-0.1.0.gem
+homepage: https://github.com/yoelblum/retail_calendar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yoelblum/retail_calendar
+  source_code_uri: https://github.com/yoelblum/retail_calendar
+  changelog_uri: http://todo.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Implements retail calendar
+test_files: []