uk_academic_calendar 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71d754790b2fdbde926c3ba208b5e860d00d5e1804ea07c74bab60d9478807d4
-  data.tar.gz: 4bbc74989d5cffb7e3fda1789a01112e45379474b0b4e6cad8e3645e8f75a507
+  metadata.gz: d8d9575b8f3803af612842832ee53b8068e4670a0bea5149b948c3f58615916f
+  data.tar.gz: 50f733b2e4fca44401fce42d16e466f66250e09d007f0afbb06f826f66d61b05
 SHA512:
-  metadata.gz: 89aadec469b4df7320211d795dbf992c7e55083f486f8767dd6083d236d0f5a3ba8208654861545d2fe0ab60022bccd51ed0deb501cbd64f94ae88f10722f672
-  data.tar.gz: 163abbbdde711855ab3e6218278a61d84b58c83025c74dc397dd346662498de48009f7761f3692f36c0b6b661dac7ab892d0f577cb014da8a1a0a3b9feffc622
+  metadata.gz: b3f2563ec589f255288daf6a6f3bf862e63ca573dbf45e8a8ea4baba30629bc6d4414e83eb8de099efbf9dc43a27fc1f618f8d08cc55c927e8a28d811bfaa486
+  data.tar.gz: f74a3b9d82241b5615221bacccb861e54590fb3894e32c193c64603fd3fd780611e4e02866fee2b0fb3e733e18f95d73a4fb65b687e9a656c73b922c71716d08

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.1.0"
+}

data/.rubocop.yml

@@ -1,5 +1,7 @@
+require: rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   NewCops: enable
 
 Style/StringLiterals:
@@ -20,3 +22,6 @@ Metrics/BlockLength:
   Exclude:
     - '*.gemspec'
     - 'spec/**/*.rb'
+
+RSpec/NestedGroups:
+  Max: 4

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [1.1.0](https://github.com/m-smiff/uk_academic_calendar/compare/uk_academic_calendar-v1.0.1...uk_academic_calendar/v1.1.0) (2024-02-25)
+
+
+### Continuous Integration
+
+* add empty object to rp manifest ([#18](https://github.com/m-smiff/uk_academic_calendar/issues/18)) ([a76b007](https://github.com/m-smiff/uk_academic_calendar/commit/a76b007d52415e50f4960ebae5536992dc76917d))
+* add release-please-config ([#14](https://github.com/m-smiff/uk_academic_calendar/issues/14)) ([be681e7](https://github.com/m-smiff/uk_academic_calendar/commit/be681e7352346f5f299e6f74086ac62bc9f72ea9))
+* correct release-please config ([#16](https://github.com/m-smiff/uk_academic_calendar/issues/16)) ([3a9fb40](https://github.com/m-smiff/uk_academic_calendar/commit/3a9fb4020cff5c5a7effeb9261ebfd36ca7793a7))
+* correct release-please config file naming ([#15](https://github.com/m-smiff/uk_academic_calendar/issues/15)) ([cf18198](https://github.com/m-smiff/uk_academic_calendar/commit/cf181986340f70caf17f689b36fcb318b4e9f073))
+* correct the rp config ([#19](https://github.com/m-smiff/uk_academic_calendar/issues/19)) ([2d13bc3](https://github.com/m-smiff/uk_academic_calendar/commit/2d13bc380614c6ff429aa2d02c2181ff9e7d1d00))
+* ensure tests are run on pushes to main ([#13](https://github.com/m-smiff/uk_academic_calendar/issues/13)) ([65bb27b](https://github.com/m-smiff/uk_academic_calendar/commit/65bb27bdbfc0ea243d8cd2a0de47df5e19d092fb))
+* fix rp permissions in workflow ([#21](https://github.com/m-smiff/uk_academic_calendar/issues/21)) ([7464b2f](https://github.com/m-smiff/uk_academic_calendar/commit/7464b2fde32e99efea5917e00922dacc51d463bc))
+* fix the rp config ([#20](https://github.com/m-smiff/uk_academic_calendar/issues/20)) ([e29fa3a](https://github.com/m-smiff/uk_academic_calendar/commit/e29fa3a450cdff41cf1bbef84769ffe24253d5e3))
+* tweaks to release-please manifest and config ([#17](https://github.com/m-smiff/uk_academic_calendar/issues/17)) ([0ba3e4e](https://github.com/m-smiff/uk_academic_calendar/commit/0ba3e4efbb22002e008d2730dab97e3927072ad3))

data/README.md

@@ -1,3 +1,6 @@
+![Gem version badge](https://badge.fury.io/rb/uk_academic_calendar.svg)
+![Tests status](https://github.com/m-smiff/uk_academic_calendar/actions/workflows/specs.yml/badge.svg)
+
 # UKAcademicCalendar
 
 Designed to assist in Ruby programs dealing with the UK Academic Calendar, i.e. the Sept - Sept academic year, and the 3 'terms' (Autumn, Spring, Summer).
@@ -46,7 +49,9 @@ See rubydoc [docs](https://www.rubydoc.info/github/m-smiff/uk_academic_calendar/
 
 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).
+## Contribution
+
+We are using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and an [automated release action](https://github.com/google-github-actions/release-please-action). Please ensure you familiarise youself with these before contributing.
 
 ## TODO
 
@@ -54,10 +59,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 - Considering the above, implementation of e.g., `#teachable_days` and `#non_teachable_days` returning sorted sets of applicable dates
 - Setting of 'contexts' so terms understand what dates to apply for a given 'context' (e.g. a particular local authority)
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/uk_academic_calendar.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/uk_academic_calendar/autumn_term.rb

@@ -7,12 +7,12 @@ module UKAcademicCalendar
   class AutumnTerm < Term
     # @return [Date] Sep 1st
     def nominal_start_date
-      @nominal_start_date ||= Date.today.beginning_of_academic_year.change(year: academic_year)
+      Date.today.beginning_of_academic_year.change(year: academic_year)
     end
 
     # @return [Date] Dec 31st
     def nominal_end_date
-      @nominal_end_date ||= nominal_start_date.end_of_year
+      nominal_start_date.end_of_year
     end
   end
 end

data/lib/uk_academic_calendar/core_ext/date.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/date'
 require_relative '../mixins/date_and_time_instance_methods'
 
 class Date

data/lib/uk_academic_calendar/core_ext/time.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/time'
 require_relative '../mixins/date_and_time_instance_methods'
 
 class Time

data/lib/uk_academic_calendar/spring_term.rb

@@ -3,7 +3,7 @@
 require_relative 'term'
 
 module UKAcademicCalendar
-  # Concrete class allowing instantiation of instances of an spring term, for a given academic year
+  # Concrete class allowing instantiation of instances of a spring term, for a given academic year
   class SpringTerm < Term
     # @return [Date] Jan 1st
     def nominal_start_date

data/lib/uk_academic_calendar/summer_term.rb

@@ -3,7 +3,7 @@
 require_relative 'term'
 
 module UKAcademicCalendar
-  # Concrete class allowing instantiation of instances of an Summer term, for a given academic year
+  # Concrete class allowing instantiation of instances of a Summer term, for a given academic year
   class SummerTerm < Term
     # @return [Date] the Monday after Easter Sunday
     def nominal_start_date

data/lib/uk_academic_calendar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UKAcademicCalendar
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/uk_academic_calendar.rb

@@ -2,6 +2,8 @@
 
 require 'uk_academic_calendar/version'
 
+require 'active_support/all'
+
 require 'uk_academic_calendar/core_ext/date'
 require 'uk_academic_calendar/core_ext/time'
 require 'uk_academic_calendar/core_ext/integer'
@@ -9,9 +11,6 @@ require 'uk_academic_calendar/autumn_term'
 require 'uk_academic_calendar/spring_term'
 require 'uk_academic_calendar/summer_term'
 
-require 'active_support/core_ext/class/subclasses'
-require 'active_support/core_ext/object/inclusion'
-
 # Top-level namespace, itself implementing a number of constants and module methods documented below.
 module UKAcademicCalendar
   # The month-number corresponding to the first month within the calendar year that the academic year starts in.

data/release-please-config.json

@@ -0,0 +1,10 @@
+{
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "uk_academic_calendar",
+      "version-file": "lib/uk_academic_calendar/version.rb",
+      "bump-minor-pre-major": true
+    }
+  }
+}

data/uk_academic_calendar.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/uk_academic_calendar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uk_academic_calendar'
+  spec.version       = UKAcademicCalendar::VERSION
+  spec.authors       = ['Matt']
+  spec.email         = ['jetnova@pm.me']
+
+  spec.summary       = 'UK Academic Calendar'
+  spec.description   = 'Designed to assist in Ruby programs dealing with the UK Academic Calendar'
+  spec.homepage      = "https://www.github.com/m-smiff/#{spec.name}"
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'documentation_uri' => "https://www.rubydoc.info/github/m-smiff/#{spec.name}/main",
+    'changelog_uri' => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    'source_code_uri' => spec.homepage,
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'abstract_class', '~> 1.0'
+  spec.add_dependency 'activesupport', '~> 7.0'
+  spec.add_dependency 'easter', '~> 0.2'
+  spec.add_dependency 'sorted_set', '~> 1.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uk_academic_calendar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-10 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_class
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: easter
   requirement: !ruby/object:Gem::Requirement
@@ -73,9 +73,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".CHANGELOG.md"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -94,14 +97,16 @@ files:
 - lib/uk_academic_calendar/summer_term.rb
 - lib/uk_academic_calendar/term.rb
 - lib/uk_academic_calendar/version.rb
+- release-please-config.json
+- uk_academic_calendar.gemspec
 homepage: https://www.github.com/m-smiff/uk_academic_calendar
 licenses:
 - MIT
 metadata:
   homepage_uri: https://www.github.com/m-smiff/uk_academic_calendar
   documentation_uri: https://www.rubydoc.info/github/m-smiff/uk_academic_calendar/main
+  changelog_uri: https://www.github.com/m-smiff/uk_academic_calendar/blob/main/CHANGELOG.md
   source_code_uri: https://www.github.com/m-smiff/uk_academic_calendar
-  changelog_uri: https://www.github.com/m-smiff/uk_academic_calendar
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -111,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="