bbc-week 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2f6ef9801940e51834ce4527ff27a60803d4e144a9eb09d867dc445a595f81e
+  data.tar.gz: 2df8a40832baab4aedd321eac5b63d5a367e173a16123131d50418a7759511f9
+SHA512:
+  metadata.gz: 0e30336801ebd2321686ed093faa60b3dd244095fcdfb7e756009e7bfda56b39637bfbdb9db22457f6ae4ca8960ef387d8bed4428f2c35680162ac303a6f7b4e
+  data.tar.gz: 98f4788182ab5be4e114fb31bc5a491fe2458cb6f6b4dbe9fa0b1d20b251978d4f49e1611686bb0914aafe4edf2c8c470d8cda4c3cc2baec5aa7f899b4d2f499

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bbc-week.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 British Broadcasting Corporation
+
+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,82 @@
+# BBC::Week Ruby Gem
+
+Some BBC production teams plan their programming around week numbers, counting from the start of the year. Unfortunately this is different to the definition of an [ISO Week] or commercial week. The BBC publishes a programme week wall calendar to production staff, so that they can quickly identify the week number.
+
+The rules for calculating the BBC week number are:
+- Weeks start with Saturday
+- Each week's year is the Gregorian year in which the Tuesday falls
+- The first week of the year always contains 4th January
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bbc-week'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bbc-week
+
+## Usage
+
+After requiring `bbc-week`, two methods are added to the ruby [Date] class.
+
+Days are numbered from Saturday:
+
+| Number  | Day       |
+|---------|-----------|
+| 1       | Saturday  |
+| 2       | Sunday    |
+| 3       | Monday    |
+| 4       | Tuesday   |
+| 5       | Wednesday |
+| 6       | Thursday  |
+| 7       | Friday    |
+
+
+### Date.bbc_week(year, week, day)
+
+This class method creates a new [Date] object, based on a BBC year, week and day.
+
+### Date#bbc_week
+
+This instance method returns the BBC year, week and day as an array.
+
+
+### Example Console Session
+
+```ruby
+$ ./bin/console 
+irb(main):001:0> Date.today.bbc_week
+=> [2020, 33, 6]
+irb(main):002:0> Date.bbc_week(2020, 33, 6)
+=> #<Date: 2020-08-20 ((2459082j,0s,0n),+0s,2299161j)>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/bbc/ruby-bbc-week.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+
+[ISO Week]:  https://en.wikipedia.org/wiki/ISO_week_date
+[Date]:      https://ruby-doc.org/stdlib/libdoc/date/rdoc/Date.html

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bbc-week.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/bbc/week/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bbc-week"
+  spec.version       = BBC::Week::VERSION
+  spec.authors       = ["British Broadcasting Corporation"]
+
+  spec.summary       = %q{Extension to the Date class to calculate BBC week dates}
+  spec.homepage      = "https://github.com/bbc/ruby-bbc-week"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bbc/ruby-bbc-week.git"
+
+  # 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"]
+end

data/bin/console

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

@@ -0,0 +1,36 @@
+require "bbc/week/version"
+require 'date'
+
+module BBC
+  module Week
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Create a date object from a BBC week date
+      def bbc_week(year, week, day)
+        # The week that contains Jan 4 is the first week with the majority
+        # of days in that year (regardless of what day of week is start of week)
+        jan4 = Date.new(year, 1, 4)
+
+        # Next calculate the first day of the first week of that year
+        first = jan4 - ((jan4.wday + 1) % 7)
+
+        # Then add on the days and weeks
+        first + ((week - 1) * 7) + day - 1
+      end
+    end
+
+    # Convert a Date object to BBC Week
+    def bbc_week
+      adjustment = 3 - ((self.wday + 1) % 7)
+      tuesday = self + adjustment
+      [tuesday.year, ((tuesday.yday - 1) / 7) + 1, 4 - adjustment]
+    end
+  end
+end
+
+class Date
+  include BBC::Week
+end

data/lib/bbc/week/version.rb

@@ -0,0 +1,5 @@
+module BBC
+  module Week
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: bbc-week
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- British Broadcasting Corporation
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bbc-week.gemspec
+- bin/console
+- bin/setup
+- lib/bbc/week.rb
+- lib/bbc/week/version.rb
+homepage: https://github.com/bbc/ruby-bbc-week
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bbc/ruby-bbc-week
+  source_code_uri: https://github.com/bbc/ruby-bbc-week.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Extension to the Date class to calculate BBC week dates
+test_files: []