dtg 4.0.1 → 5.0.0

data/Rakefile

@@ -1,3 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc 'pretty up the lib'
+task :pretty do
+  exec('rbprettier --write lib/**/*.rb')
+end
 # desc "Explaining what the task does"
 # task :dtg do
 #   # Task goes here

data/bin/console

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

@@ -1,47 +1,66 @@
 # Ensure all of library added to gem
-$:.push File.expand_path("lib", __dir__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 # Maintain your gem's version:
-require "dtg/version"
+require 'dtg/version'
 
-# Describe your gem and declare its dependencies:
 Gem::Specification.new do |spec|
-  spec.name        = "dtg"
-  spec.version     = Dtg::VERSION
-  spec.authors     = ["SolarisFlare"]
-  spec.email       = ["shadowbomb20@gmail.com"]
-  spec.homepage    = "https://github.com/SolarisFlare/dtg/"
-  spec.summary     = "DTG converts from a DateTime to a DTG"
-  spec.description = "A DTG is a DateTimeGroup which is used in the military to save time.  DTG 
+  spec.name = 'dtg'
+  spec.version = Dtg::VERSION
+  spec.authors = %w[SolarisFlare]
+  spec.email = %w[shadowbomb20@gmail.com]
+  spec.homepage = 'https://github.com/SolarisFlare/dtg/README.md'
+  spec.summary = 'DTG converts from a DateTime to a DTG'
+  spec.description =
+    'A DTG is a DateTimeGroup which is used in the military to save time.  DTG 
                       are saved in the format DDHHMML MMM YY, where D is day, H is hour, L is 
                       letter, M is month, and Y is year.  The Month is the 3 character 
                       representation such as JAN for January, MAY for May, DEC for December and so 
                       on.  Year is only the last two digits of the year e.g. 2019 is just 19.  The 
                       letter is the zone code such as W for whiskey which is HST, Z for zulu which 
-                      is GMT, A-Z are the zones used."
-  spec.license     = "MIT"
-  spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? \
-                                                                  :required_rubygems_version=
-  spec.files = Dir["Gemfile", "dtg.gemspec", "Rakefile", "lib/**/*"]
-  spec.test_files = Dir["spec/**/*"]
-  spec.rubygems_version = %q{1.6.2}
-
-  # Active support is necessary for ActiveSupport::TimeWithZone integration
-  spec.add_dependency "activesupport"
+                      is GMT, A-Z are the zones used.'
+  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["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata['allowed_push_host'] = 'NOSERVER'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/SolarisFlare/dtg'
+    spec.metadata['changelog_uri'] =
+      'https://github.com/SolarisFlare/dtg/CHANGELOG.md'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+            'public gem pushes.'
   end
 
-  if spec.respond_to? :specification_version then
-    spec.specification_version = 3
+  # Specify test files that do not belong added when building gem
+  spec.test_files = Dir['spec/**/*']
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+  # 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 do |f|
+        f.match(%r{^(test|spec|features)/})
+      end
     end
-  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  # Active support is necessary for ActiveSupport::TimeWithZone integration
+  spec.add_dependency 'activesupport'
+
+  # Bundler to manage gems ad versions
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  # Rake to run tasks
+  spec.add_development_dependency 'rake', '~> 10.0'
+  # RSpec for testing suite
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  # Prettier for better formatting
+  spec.add_development_dependency 'prettier'
+  # Coveralls for test suite reporting
+  spec.add_development_dependency 'coveralls'
 end

data/lib/dtg.rb

@@ -1,12 +1,25 @@
-require_relative "dtg/version"
-require_relative "dtg/date_time_group"
-require_relative "dtg/zones"
-require_relative "dtg/time_ext"
-require_relative "dtg/date_time_ext"
-require_relative "dtg/active_support/time_with_zone_ext"
+# DTG version
+require_relative 'dtg/version'
+# Base module which contains all functionality
+require_relative 'dtg/date_time_group'
+# Zone codes and their offsets
+require_relative 'dtg/zones'
+# Format of DTG data (for conversion purposes)
+require_relative 'dtg/format'
+# Extension of DTG into Time object for native compatability
+require_relative 'dtg/time_ext'
+# Extension of DTG into DateTime object for native compatability
+require_relative 'dtg/date_time_ext'
+# Extension of DTG into ActiveSupport::TimeWithZone object for native compatability
+require_relative 'dtg/active_support/time_with_zone_ext'
 
+# Base module: Debug if active by calling Dtg.dtg to also check your current running version
 module Dtg
+  # Errors are nice
+  class Error < StandardError; end
+
+  # Announce DTG version and if incorporated properly into the application
   def self.dtg
-    "DTG gem is active"
+    "DTG gem is active running version: #{VERSION}"
   end
 end

data/lib/dtg/active_support/time_with_zone_ext.rb

@@ -1,5 +1,5 @@
-require_relative "../date_time_group"
-require "active_support/time"
+require_relative '../date_time_group'
+require 'active_support/time'
 
 class ActiveSupport::TimeWithZone
   # Insert DTG Methods into this class

data/lib/dtg/date_time_ext.rb

@@ -1,6 +1,6 @@
-require_relative "date_time_group"
-require "date"
-require "active_support/core_ext/date"
+require_relative 'date_time_group'
+require 'date'
+require 'active_support/core_ext/date'
 # require "active_support/core_ext/date_and_time"
 
 class DateTime

data/lib/dtg/date_time_group.rb

@@ -1,15 +1,17 @@
-require_relative "zones"
+require_relative 'zones'
+require_relative 'format'
 
 module DateTimeGroup
   # Zones module has timezones (UTC_Zones) as dtg listings
   include Zones
+  include Format
 
   # Convert the object to the proper zone and then format as dtg in zone
   def to_dtg(zone = :z)
     convert(zone).format(zone)
   end
 
-  # DTG Test to determine if was injected properly into class
+  # DTG Test to determine if was injected properly into class for native use
   def dtg
     "DTG gem is natively integrated with this class: #{self.class}"
   end
@@ -28,4 +30,54 @@ module DateTimeGroup
     raise "Error: #{zone} is not a valid zone" unless UTC_ZONES.key?(key)
     key == :j ? self.dup : self.in_time_zone(UTC_ZONES[key])
   end
+
+  # Parse will strip the DTG into its different fields
+  def self.parse(dtg)
+    {
+      day: dtg[FORMAT[:day_range]],
+      hour: dtg[FORMAT[:hour_range]],
+      minute: dtg[FORMAT[:minute_range]],
+      zone: dtg[FORMAT[:zone_range]],
+      month: dtg[FORMAT[:month_range]],
+      year: dtg[FORMAT[:year_range]]
+    }
+  end
+
+  # From will convert from DTG to a Time (not enough data to recreate AS or DateTime)
+  def self.from_dtg(dtg)
+    dtg_hash = parse(dtg)
+    year = dtg_hash[:year].to_i
+    if (Time.now.year % 100) < year
+      year = Time.now.year
+    else
+      year_temp = Time.now.year
+      year += year_temp - year_temp % 100
+    end
+    zone = UTC_ZONES[dtg_hash[:zone].downcase.to_sym].to_s
+    if zone.blank?
+      zone = '+00:00'
+    elsif zone == 'UTC'
+      zone = '+00:00'
+    elsif zone.size == 2
+      zone = zone[0] + '0' + zone[1] + ':00'
+    else
+      zone += ':00'
+    end
+    # Year, month, Day, Hour, Minute, Second, Offset
+    Time.new(
+      year,
+      dtg_hash[:month],
+      dtg_hash[:day].to_i,
+      dtg_hash[:hour].to_i,
+      dtg_hash[:minute].to_i,
+      0,
+      zone
+    )
+  end
+
+  # Change will convert a DTG into a different zone with respect to its zone code
+  def self.convert(dtg, zone = :w)
+    old = from_dtg(dtg)
+    old.to_dtg(zone)
+  end
 end

data/lib/dtg/format.rb

@@ -0,0 +1,59 @@
+# Data about the format of a dtg to aid parsing
+module Format
+  # Structure of a dtg
+  # 01234567890123
+  # DDHHMML MMM YY
+
+  FORMAT = {
+    # Size of 
+    size: 14,
+    # Size of day field
+    size_day: 2,
+    # Size of hour field
+    size_hour: 2,
+    # Size of minute field
+    size_minute: 2,
+    # Size of zone field
+    size_zone: 1,
+    # Size of month field
+    size_month: 3,
+    # Size of year field
+    size_year: 2,
+    # Start index of day field
+    day_start: 0,
+    # End index of day field
+    day_end: 1,
+    # Index range of day field
+    day_range: 0..1,
+    # Start index of hour field
+    hour_start: 2,
+    # End index of hour field
+    hour_end: 3,
+    # Index range of hour field
+    hour_range: 2..3,
+    # Start index of minute field
+    minute_start: 4,
+    # End index of minute field
+    minute_end: 5,
+    # Index range of minute field
+    minute_range: 4..5,
+    # Start index of zone field
+    zone_start: 6,
+    # End index of zone field
+    zone_end: 6,
+    # Index range of zone field
+    zone_range: 6..6,
+    # Start index of month field
+    month_start: 8,
+    # End index of month field
+    month_end: 10,
+    # Index range of month field
+    month_range: 8..10,
+    # Start index of year field
+    year_start: 12,
+    # End index of year field
+    year_end: 13,
+    # Index range of year field
+    year_range: 12..13
+  }
+end

data/lib/dtg/time_ext.rb

@@ -1,5 +1,5 @@
-require_relative "date_time_group"
-require "active_support/core_ext/time"
+require_relative 'date_time_group'
+require 'active_support/core_ext/time'
 
 class Time
   # Insert DTG Methods into this class

data/lib/dtg/version.rb

@@ -1,4 +1,4 @@
 module Dtg
   # DTG version of gem
-  VERSION = "4.0.1"
+  VERSION = '5.0.0'
 end

data/lib/dtg/zones.rb

@@ -20,7 +20,7 @@ module Zones
     # I: India Time: UTC +09:00 (Tokyo, Japan)
     i: +9,
     # J: Juliet Time: (Local Time Zone)
-    j: "",
+    j: '',
     # K: Kilo Time: UTC +10:00 (Sydney, Australia)
     k: +10,
     # L: Lima Time: UTC +11:00 (Honiara, Solomon Islands)
@@ -52,6 +52,6 @@ module Zones
     # Y: Yankee Time: UTC -12:00 (Suva, Fiji)
     y: -12,
     # Z: Zulu Time: UTC +-00:00 (Greenwich, England)
-    z: "UTC",
+    z: 'UTC'
   }
 end

data/spec/dtg/active_support/time_with_zone_ext_spec.rb

@@ -0,0 +1,176 @@
+RSpec.describe ActiveSupport::TimeWithZone do
+  # Set Time Zone before tests
+  before { Time.zone = 'UTC' }
+
+  # ActiveSupport::TimeWithZone preferred method of instantiation is with Time.zone.now, not new
+  let(:time) { Time.zone.now { include DateTimeGroup } }
+
+  describe '#to_dtg' do
+    context 'when zone is a symbol' do
+      context 'when symbol is lowercase' do
+        it 'converts and formats as dtg' do
+          (:a..:z).to_set.delete(:j).each do |zone|
+            expect(time.to_dtg(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone]).strftime(
+                "%d%H%M#{zone.upcase.to_s} %b %y"
+              )
+            )
+          end
+          # :j is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.to_dtg(:j)).to eq(time.format(:j))
+        end
+      end
+
+      context 'when symbol is uppercase' do
+        it 'converts and formats as dtg' do
+          (:A..:Z).to_set.delete(:J).each do |zone|
+            expect(time.to_dtg(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone.downcase]).strftime(
+                "%d%H%M#{zone.to_s} %b %y"
+              )
+            )
+          end
+          # :J is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.to_dtg(:J)).to eq(time.format(:j))
+        end
+      end
+    end
+
+    context 'when zone is a single character string' do
+      context 'when string is lowercase' do
+        it 'converts and formats as dtg' do
+          ('a'..'z').to_set.delete('j').each do |zone|
+            expect(time.to_dtg(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone.to_sym]).strftime(
+                "%d%H%M#{zone.upcase} %b %y"
+              )
+            )
+          end
+          # 'j' is separate because there is no local timezone identifier
+          # it just gets returned and formatted
+          expect(time.to_dtg('j')).to eq(time.format(:j))
+        end
+      end
+
+      context 'when string is uppercase' do
+        it 'converts and formats as dtg' do
+          ('A'..'Z').to_set.delete('J').each do |zone|
+            expect(time.to_dtg(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone.downcase.to_sym])
+                .strftime("%d%H%M#{zone} %b %y")
+            )
+          end
+          # 'J' is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.to_dtg('J')).to eq(time.format(:j))
+        end
+      end
+    end
+  end
+
+  describe '#format' do
+    context 'when zone is a symbol' do
+      context 'when symbol is lowercase' do
+        it 'formats to dtg standard' do
+          (:a..:z).each do |zone|
+            expect(time.format(zone)).to eq(
+              time.strftime("%d%H%M#{zone.upcase.to_s} %b %y")
+            )
+          end
+        end
+      end
+
+      context 'when symbol is uppercase' do
+        it 'formats to dtg standard' do
+          (:A..:Z).each do |zone|
+            expect(time.format(zone)).to eq(
+              time.strftime("%d%H%M#{zone.to_s} %b %y")
+            )
+          end
+        end
+      end
+    end
+
+    context 'when zone is a single character string' do
+      context 'when string is lowercase' do
+        it 'formats to dtg standard' do
+          ('a'..'z').each do |zone|
+            expect(time.format(zone)).to eq(
+              time.strftime("%d%H%M#{zone.upcase} %b %y")
+            )
+          end
+        end
+      end
+
+      context 'when string is uppercase' do
+        it 'formats to dtg standard' do
+          ('A'..'Z').each do |zone|
+            expect(time.format(zone)).to eq(
+              time.strftime("%d%H%M#{zone} %b %y")
+            )
+          end
+        end
+      end
+    end
+  end
+
+  describe '#convert' do
+    context 'when zone is a symbol' do
+      context 'when symbol is lowercase' do
+        it 'returns converted time to new zone' do
+          (:a..:z).to_set.delete(:j).each do |zone|
+            expect(time.convert(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone])
+            )
+          end
+          # :j is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.convert(:j)).to eq(time)
+        end
+      end
+
+      context 'when symbol is uppercase' do
+        it 'returns converted time to new zone' do
+          (:A..:Z).to_set.delete(:J).each do |zone|
+            expect(time.convert(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone.downcase])
+            )
+          end
+          # :J is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.convert(:J)).to eq(time)
+        end
+      end
+    end
+
+    context 'when zone is a single character string' do
+      context 'when string is lowercase' do
+        it 'returns converted time to new zone' do
+          ('a'..'z').to_set.delete('j').each do |zone|
+            expect(time.convert(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone.to_sym])
+            )
+          end
+          # 'j' is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.convert('j')).to eq(time)
+        end
+      end
+
+      context 'when string is uppercase' do
+        it 'returns converted time to new zone' do
+          ('A'..'Z').to_set.delete('J').each do |zone|
+            expect(time.convert(zone)).to eq(
+              time.in_time_zone(Zones::UTC_ZONES[zone.downcase.to_sym])
+            )
+          end
+          # 'J' is separate because there is no local timezone identifier,
+          # it just gets returned and formatted
+          expect(time.convert('J')).to eq(time)
+        end
+      end
+    end
+  end
+end