airac 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 471214b4bbc235944a133c4e4fb5b18889a88daab2ac740cc46b6d49af0389a2
+  data.tar.gz: a2fec0e51d6625e029beaa45b5dc4e6490158773f69c738096cda61aff575909
+SHA512:
+  metadata.gz: 79b78dbb5606224cc47d4750875373d3cf3fcbe04791d14415b26b7a37d96521759c85261a3796285ec42dc8c74c644608d1ee2aa81a6837f0480dec4094d404
+  data.tar.gz: 2e69a17ad1aa19ca18cdbc469b762f726dbdcf528f3c5fe13068e27d52856fa14d1eafa79c0e4be331f0cbfdfbd900b459375efa114e680f2941460cfac04cc1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 1.0.0
+
+#### Initial Implementation
+* Require Ruby 3
+* Simple AIRAC calculations and comparisons
+* CLI tool

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sven Schwyn
+
+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 @@
+[![Version](https://img.shields.io/gem/v/airac.svg?style=flat)](https://rubygems.org/gems/airac)
+[![Tests](https://img.shields.io/github/workflow/status/svoop/airac/Test.svg?style=flat&label=tests)](https://github.com/svoop/airac/actions?workflow=Test)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/svoop/airac.svg?style=flat)](https://codeclimate.com/github/svoop/airac/)
+[![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
+
+# AIRAC
+
+[AIRAC cycle](https://en.wikipedia.org/wiki/Aeronautical_Information_Publication) calculations for Ruby.
+
+* [Homepage](https://github.com/svoop/airac)
+* [API](https://www.rubydoc.info/gems/airac)
+* Author: [Sven Schwyn - Bitcetera](https://bitcetera.com)
+
+## Install
+
+### Security
+
+This gem is [cryptographically signed](https://guides.rubygems.org/security/#using-gems) in order to assure it hasn't been tampered with. Unless already done, please add the author's public key as a trusted certificate now:
+
+```
+gem cert --add <(curl -Ls https://raw.github.com/svoop/airac/main/certs/svoop.pem)
+```
+
+### Bundler
+
+Add the following to the <tt>Gemfile</tt> or <tt>gems.rb</tt> of your [Bundler](https://bundler.io) powered Ruby project:
+
+```ruby
+gem airac
+```
+
+And then install the bundle:
+
+```
+bundle install --trust-policy MediumSecurity
+```
+
+## Usage
+
+You can use this gem in your Ruby project:
+
+```ruby
+cycle = AIRAC::Cycle.new('2018-01-01')
+cycle.date         # => #<Date: 2017-12-07 ((2458095j,0s,0n),+0s,2299161j)>
+cycle.id           # => 1713
+(cycle + 5).id     # => 1804
+(cycle - 5).id     # => 1708
+```
+
+The cycle can be formatted similar to `Date#strftime`, however, the placeholder `%i` represents the AIRAC cycle ID:
+
+```ruby
+cycle = AIRAC::Cycle.new('2018-01-01')
+cycle.to_s                            # "1713 2017-12-07"
+cycle.to_s("@%i as per %b %-d, %Y")   # => "@1713 as per Dec 7, 2017"
+```
+
+The current AIRAC cycle scheme started on 2015-06-25, therefore any calculation which leads to dates prior to inception will cause an error:
+
+```ruby
+(cycle - 100).id   # => ArgumentError
+```
+
+The `AIRAC::Cycle` class implements `Comparable` and its instances can safely be used s `Hash` keys.
+
+If you prefer to do the math on the shell, the `airac` executable is your friend:
+
+```shell
+airac --help
+```
+
+## Development
+
+To install the development dependencies and then run the test suite:
+
+```
+bundle install
+bundle exec rake    # run tests once
+bundle exec guard   # run tests whenever files are modified
+```
+
+You're welcome to [submit issues](https://github.com/svoop/airac/issues) and contribute code by [forking the project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/exe/airac

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  ruby '>= 3.0.0'
+  gem 'airac'
+end
+
+AIRAC::Executable.new.run

data/lib/airac/cycle.rb

@@ -0,0 +1,104 @@
+module AIRAC
+
+  # AIRAC cycle date calculations
+  #
+  # @example
+  #   cycle = AIRAC::Cycle.new('2018-01-01')
+  #   cycle.date         # => #<Date: 2017-12-07 ((2458095j,0s,0n),+0s,2299161j)>
+  #   cycle.id           # => 1713
+  #   (cycle + 5).id     # => 1804
+  #   (cycle - 5).id     # => 1708
+  #   (cycle - 100).id   # => ArgumentError
+  class Cycle
+    include Comparable
+
+    # First AIRAC date following the last cycle length modification
+    ROOT_DATE = Date.parse('2015-06-25').freeze
+
+    # Length of one AIRAC cycle
+    DAYS_PER_CYCLE = 28
+
+    # @return [Date] AIRAC effective on date
+    attr_reader :date
+
+    # @return [Integer] AIRAC cycle ID
+    attr_reader :id
+
+    # @param raw_cycle [Date, String, nil] either a four digit AIRAC cycle ID
+    #   or any date within the AIRAC cycle
+    def initialize(raw_cycle=nil)
+      if raw_cycle.to_s.match?(/\A\d{4}\z/)
+        @id = raw_cycle.to_s
+        @date = date_for_id(@id)
+      else
+        raw_cycle = raw_cycle ? Date.parse(raw_cycle.to_s) : Date.today
+        fail(ArgumentError, "cannot calculate dates before #{ROOT_DATE}") if raw_cycle < ROOT_DATE
+        @date = date_for_date_within(raw_cycle)
+        @id = id_for(@date)
+      end
+    end
+
+    # @return [String]
+    def inspect
+      %Q(#<#{self.class} #{id} #{date}>)
+    end
+
+    # @param template [String, nil] strftime template with %i for AIRAC cycle
+    #   (default: '%i %Y-%m-%d')
+    # @return [String]
+    def to_s(template=nil)
+      date.strftime((template || '%i %Y-%m-%d').sub(/%i/, id))
+    end
+
+    # @param days [Numerical] add this many days
+    # @return [AIRAC::Cycle] new object with offset applied
+    def +(cycles)
+      AIRAC::Cycle.new(@date + cycles * DAYS_PER_CYCLE)
+    end
+
+    # @param cycles [Numerical] subtract this many cycles
+    # @return [AIRAC::Cycle] new object with offset applied
+    def -(cycles)
+      self + -cycles
+    end
+
+    # @see Object#<=>
+    # @return [Integer]
+    def <=>(other)
+      id <=> other.id
+    end
+
+    # @see Object#==
+    # @return [Boolean]
+    def ==(other)
+      self.class === other  && (self <=> other).zero?
+    end
+    alias_method :eql?, :==
+
+    # @see Object#hash
+    # @return [Integer]
+    def hash
+      to_s.hash
+    end
+
+    private
+
+    # Find the AIRAC date for given date within the cycle
+    def date_for_date_within(date_within)
+      ROOT_DATE + (date_within - ROOT_DATE).to_i / DAYS_PER_CYCLE * DAYS_PER_CYCLE
+    end
+
+    # Find the AIRAC date for given cycle ID
+    def date_for_id(id)
+      year = (Date.today.year.to_s[0,2] + id[0,2]).to_i
+      preceding_cycle = self.class.new(Date.parse("#{year}-01-01") - 1)
+      (preceding_cycle + id[2,2].to_i).date
+    end
+
+    # Find the AIRAC ID for the AIRAC +date+
+    def id_for(date)
+      '%04d' % ((date.year % 100) * 100 + ((date.yday - 1) / DAYS_PER_CYCLE) + 1)
+    end
+
+  end
+end

data/lib/airac/executable.rb

@@ -0,0 +1,45 @@
+module AIRAC
+
+  # Executable instantiated by the console tools
+  class Executable
+    attr_reader :options
+
+    def initialize
+      @options = {
+        format: nil,
+        offset: 0
+      }
+      OptionParser.new do |o|
+        o.banner = <<~END
+          Calculate AIRAC cycle from four digit ID or date within (default: today).
+          Usage: #{File.basename($0)} [options] [cycle]
+        END
+        o.on('-f', '--format TEMPLATE', String, "Template for strftime with %i for cycle ID") { @options[:format] = _1 }
+        o.on('-o', '--offset INTEGER', Integer, "Offset by this many cycles") { @options[:offset] = _1.to_i }
+        o.on('-A', '--about', 'show author/license information and exit') { about }
+        o.on('-V', '--version', 'show version and exit') { version }
+      end.parse!
+      @options[:raw_cycle] = ARGV.shift || Date.today
+    end
+
+    def run
+      puts (AIRAC::Cycle.new(options[:raw_cycle]) + options[:offset].to_i).to_s(options[:format])
+    rescue => error
+      message = error.respond_to?(:original_message) ? error.original_message : error.message
+      puts "ERROR: #{message}"
+    end
+
+    private
+
+    def about
+      puts 'Written by Sven Schwyn (bitcetera.com) and distributed under MIT license.'
+      exit
+    end
+
+    def version
+      puts AIRAC::VERSION
+      exit
+    end
+
+  end
+end

data/lib/airac/version.rb

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

data/lib/airac.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'date'
+
+require_relative "airac/version"
+require_relative "airac/executable"
+require_relative "airac/cycle"

data.tar.gz.sig

@@ -0,0 +1 @@
+HRh���a��	������/e8����q���F��ˑU�t�@�sB�=P,_�H7�$���_�=ߏ��!�A4��o��t��oLȈP����p�7��Q6�tۥk�X���9b����kW����nȫ��}����>�RA\a(ھ����e%����Q����+(����#x�A��)���M��'�A�3�[\ٌ$�D���,��U��f�$m�� ��u�.Oeh�R��@���^�Ң��e���n�:��

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: airac
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sven Schwyn
+autorequire:
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ0wCwYDVQQDDARydWJ5
+  MRkwFwYKCZImiZPyLGQBGRYJYml0Y2V0ZXJhMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTIxMTEwODE0MzIyM1oXDTIyMTEwODE0MzIyM1owPzENMAsGA1UEAwwEcnVi
+  eTEZMBcGCgmSJomT8ixkARkWCWJpdGNldGVyYTETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANwuD4geNdhpSVNJTtHb
+  fmVAoPxmER4oyGgaVJSidn/OjU5PcpdypMI/WIxfvjfFizq6kQYAsJZbCr6fG+UN
+  2dZGMXcAC/uKQL5nYESjCPJ4IJP/SC+fiiEpxHQk7PNFoiUVRUieUZIAfHZAdnY3
+  ye1/niW7ud0vwKIMrysKWxjgkE0Y6Af1QLzV/6brVRRC5MvHIzYJd8BiSP+wY1O8
+  VElw1f6d90KEz2vaQfX7vCxrzIbvAnYiSvM0AIPy/zigTqpW6w3w4sQxQj81oQ9U
+  9vDYtQzXj0c9VrSLvb0DgiGug2cU2bDjA4L3cBE1szX4tbfo8syYqMq51/kTGDxW
+  YNUCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJ8r
+  wy1HraZDqg3Khf9UonMWMtJUMB0GA1UdEQQWMBSBEnJ1YnlAYml0Y2V0ZXJhLmNv
+  bTAdBgNVHRIEFjAUgRJydWJ5QGJpdGNldGVyYS5jb20wDQYJKoZIhvcNAQEFBQAD
+  ggEBACI7lJKRbnRjz0T4Wb9jH4SE0A2yaHAoBzj96luVDjNyoRT3688trEZS75Sg
+  GKfChxqKncBrSpxJ0YfWbymNHfUrKhcdSifJ/TtUrTasm6LSnJYLOnLKDO3v8eL3
+  gRTq8a5wA7Xtijx3MJEyzdeUh7N+UMKuPps/flPgH5yabUxgxrvuhrXF7Z96nrsP
+  EOmNMTc8H7wo4BAKfuMcI/Gh2oCf+tAhr0bGsXyBikmJ6XA45mrOMgv19M1+aMpn
+  1+2Y1+i+4jd1B7qxIgOLxQTNIJiwE0sqU1itFfuesfgUACS7M0IV9u9Bp4hBGNEw
+  5JcY2h7owdMxXIvgk1oakgldFJc=
+  -----END CERTIFICATE-----
+date: 2022-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-sound
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Calculations for AIRAC (Aeronautical Information Regulation And Control)
+  cycles.
+email:
+- ruby@bitcetera.com
+executables:
+- airac
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/airac
+- lib/airac.rb
+- lib/airac/cycle.rb
+- lib/airac/executable.rb
+- lib/airac/version.rb
+homepage: https://github.com/svoop/airac
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/svoop/airac
+  changelog_uri: https://github.com/svoop/airac/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/svoop/airac
+  documentation_uri: https://www.rubydoc.info/gems/airac
+  bug_tracker_uri: https://github.com/svoop/airac/issues
+post_install_message:
+rdoc_options:
+- "--title"
+- AIRAC Calculations
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+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.5
+signing_key:
+specification_version: 4
+summary: AIRAC cycle calculations
+test_files: []