dtg 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90630b4494f916998ff85570d3bb476efe7156132cb7299522c1a5c392ff7f7a
-  data.tar.gz: 96b9b6c280a407da5f4f374fc10193595163dee905c80fd4f94a1f2cd91043df
+  metadata.gz: d41d3d30878513e54ace3d7449ba59abad4f24cc4c675f051fb50dfb17be92b9
+  data.tar.gz: c4c0f569d96219b6547310def9e4f3bc430a9628204467d7dbecc7e555aaa2c9
 SHA512:
-  metadata.gz: fd84c78104d809ab631f769df0a95a2e41ff88c326f487e58529bdad690696b52a27365d5c901f38244673c9482e110ba706f12dc68104bdaf3a44527119576d
-  data.tar.gz: c62e5497ab19a22aba3a0fd78463b33e2fab832885abbfe91dfc682905bbb4ce8a354ae12bc90dc9086a6e212195d3aa105680ef6c26c7b5593f541beedc25d3
+  metadata.gz: eaf842f9354b842328f0d7c6566969a1be7c100219045dad016ce71b22fdb3c6acc3e21e6db7c079d8d6f321381b5b0647edb80222a5579d30544e1efd9c3351
+  data.tar.gz: 1e8f778551ed82d62b6a8be5d8d7dda7e4d53aa057c5703c61e8cabf57cf05fbe8cf7290ec49f92393e35dabf8611291b03b5c4900c76ca23c0953455fb6c3d6

data/README.md

@@ -1,13 +1,85 @@
 [![GitHub version](https://badge.fury.io/gh/SolarisFlare%2Fdtg.svg)](https://badge.fury.io/gh/SolarisFlare%2Fdtg)
+[![Gem Version](https://badge.fury.io/rb/dtg.svg)](https://badge.fury.io/rb/dtg)
 [![Build Status](https://travis-ci.org/SolarisFlare/dtg.svg?branch=master)](https://travis-ci.org/SolarisFlare/dtg)
 
 # Dtg
-Short description and motivation.
+
+DTG is a ruby  gem to convert Time objects into DTG format.
+
+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.
+
+DTG integrates natively with the DateTime, Time, and ActiveSupport::TimeWithZone classes in Ruby/Rails and is callable on all Time objects.  DTG returns a visually formatted dtg converted based on knolwedge of the zone of the object and the intended zone. It is also respective of daylight savings time of your objects zone and its intended zone.
+
+DTG is the military acronym referring to what is also called nautical or maritime time zones.  These zones are mapped across the world from A-Z not including J as J references the local timezone of yourself.
+
+## Table of Contents
+
+1. [DTG](#dtg)
+2. [Table of Contents](#table-of-contents)
+3. [Usage](#usage)
+    1. [DTG Zones](#dtg-zones)
+    2. [DTG Zone Map](#dtg-zone-map)
+4. [Installation](#installation)
+5. [Testing](#testing)
+6. [Problems](#problems)
+7. [Contributing](#contributing)
+8. [License](#license)
 
 ## Usage
-How to use my plugin.
+
+DTG implements the method to_dtg into the Time class and is fully compatible with all Time objects(DateTime, Time, and TimeWithZone have been tested, custom objects should also function the same as long as their properties emulate that of the former).
+
+To use:
+
+```ruby
+TIMEOBJECT.to_dtg
+```
+
+and it will return the time object as a string in the zulu timezone in dtg format.
+
+For other DTG formats:
+
+```ruby
+TIMEOBJECT.to_dtg(:zone)
+```
+
+where zone is any single letter symbol A-Z, capital or lower case and it will return the time object as a string in the zone format.
+
+### DTG Zones
+
+- A: Alpha Time: UTC +01:00 (Paris, France)
+- B: Bravo Time: UTC +02:00 (Athens, Greece)
+- C: Charlie Time: UTC +03:00 (Moscow, Russia)
+- D: Delta Time: UTC +04:00 (Kabul, Afghanistan)
+- E: Echo Time: UTC +05:00 (New Delhi, India)
+- F: Foxtrot Time: UTC +06:00 (Dhanka, Bangladesh)
+- G: Golf Time: UTC +07:00 (Bangkok, Thailand)
+- H: Hotel Time: UTC +08:00 (Beijing, China)
+- I: India Time: UTC +09:00 (Tokyo, Japan)
+- J: Juliet Time: (Local Time Zone)
+- K: Kilo Time: UTC +10:00 (Sydney, Australia)
+- L: Lima Time: UTC +11:00 (Honiara, Solomon Islands)
+- M: Mike Time: UTC +12:00 (Wellington, New Zealand)
+- N: November Time: UTC -01:00 (Azores)
+- O: Oscar Time: UTC -02:00 (Gothab, Greenland)
+- P: Papa Time: UTC -03:00 (Buenos Aires, Argentina)
+- Q: Quebec Time: UTC -04:00 (Halifax, Nova Scotia)
+- R: Romeo Time: UTC -05:00 (New York, NY United States)
+- S: Sierra Time: UTC -06:00 (Dallas, TX United States)
+- T: Tango Time: UTC -07:00 (Denver, CO United States)
+- U: Uniform Time: UTC -08:00 (Los Angeles, CA United States)
+- V: Victor Time: UTC -09:00 (Juneau, AK United States)
+- W: Whiskey Time: UTC -10:00 (Honolulu, HI United States)
+- X: X-Ray Time: UTC -11:00 (Nome, AK United States)
+- Y: Yankee Time: UTC -12:00 (Suva, Fiji)
+- Z: Zulu Time: UTC +-00:00 (Greenwich, England)
+
+### DTG Zone Map
+
+![DTG zones displayed across the map with their offsets](dtg_zones.png?raw=true "DTG Zones")
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -24,8 +96,74 @@ Or install it yourself as:
 $ gem install dtg
 ```
 
+## Testing
+
+If you would like to test this gem before adding it to your project to see it's functionality, follow these steps:
+
+1. Clone the repository
+
+```sh
+git clone https://github.com/SolarisFlare/dtg
+```
+
+2. cd into the test/dummy directory
+
+3. Start the rails console
+
+```sh
+rails console
+```
+
+OR
+
+```sh
+rails c
+```
+
+4. Test away
+
+```ruby
+#<Tested in irb console(default rails), also works in Pry console>
+
+y = Time.zone.now
+y.dtg
+y = Time.zone.now.to_dtg(:j)
+y
+
+x = Time.now
+x.dtg
+x.to_dtg(:j)
+x.to_dtg(:J)
+x.to_dtg
+x.to_dtg(:z)
+x.to_dtg(:Z)
+x.to_dtg(:W)
+x.to_dtg(:m)
+
+z = DateTime.now
+z.dtg
+z.to_dtg
+z.convert :w
+z.to_dtg :c
+
+Time.now.to_dtg(:a)
+DateTime.now.to_dtg :Q
+Time.zone.now.to_dtg L.to_sym
+```
+
+> Note: The .dtg method will return a string naming the type of the object you called it on and can therefore be used to verify if the gem has successfully natively integrated with Ruby/Rails(should fail if not).  I included this for testing purposes to check that the right modules were being loaded with DTG and have run into no load failures but for peace of mind I left it in in case you want to see for yourself.
+
+## Problems
+
+DTG relies upon time objects that have timezone set either as Time.zone or as the default offset recorded.  I recommend setting the application timezone in the application.rb configuration file so that dtg works automatically on any generated time objects.  TimeWithZone is different and therefore has is a Time with offset and with zone.  Therefore without data loss, you can convert from TimeWithZone to DateTime or Time and maintain the same time, however, you may lose the zone code but the offset will be kept and the zone code can be recovered based on this offset but certain zones that follow daylight savings time may lose their savings-ness and will no longer spring forward or backward if converted.
+
+> DTG currently supports the following: DateTime, Time, ActiveSupport::TimeWithZone.  If you extend the Time class as does TimeWithZone, DTG may not function properly, to ensure it functions the same for TimeWithZone, I changed the conversion to_time, and then in_time_zone since ActiveSupport::TimeWithZone has strage behaviors I have not been able to understand yet.  Until it is updated to be more stable or I find the proper solution, this will not affect the gems functionality, but will just be a different(slightly less efficient: calling an extra method) way to work with ActiveSupport:TimeWithZone objects.
+
+
 ## Contributing
-Contribution directions go here.
+
+If you want to contribute please let me know though either an email or you can just submit a pull request to add anything!
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -16,12 +16,11 @@ end
 
 require 'bundler/gem_tasks'
 
-require 'rake/testtask'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  task :default => :spec
+rescue LoadError
+  # no rspec available
 end
-
-task default: :test

data/lib/dtg.rb

@@ -1,6 +1,11 @@
 require "dtg/railtie"
-require "dtg/core_ext"
+require "dtg/zones"
+require "dtg/core_datetime_ext"
+require "dtg/core_time_ext"
+require "dtg/core_timewithzone_ext"
 
 module Dtg
-  # Your code goes here...
+  def dtg
+    "DTG gem is natively integrated with this class: #{self.class}"
+  end
 end

data/lib/dtg/core_datetime_ext.rb

@@ -0,0 +1,22 @@
+require 'dtg'
+require_relative 'zones'
+
+class DateTime
+  include Dtg
+  include Zones
+
+  def to_dtg(zone = :z)
+    convert(zone).format(zone)
+  end
+
+  def format(zone = :z)
+    dtg = "%d%H%M#{zone.upcase} %b %y"
+    strftime(dtg)
+  end
+
+  def convert(zone = :z)
+    zone = zone.downcase
+    raise "Error: #{zone} is not a valid zone" unless UTC_ZONES.key?(zone)
+    zone == :j ? self : self.in_time_zone(UTC_ZONES[zone])
+  end
+end

data/lib/dtg/core_time_ext.rb

@@ -0,0 +1,22 @@
+require 'dtg'
+require_relative 'zones'
+
+class Time
+  include Dtg
+  include Zones
+
+  def to_dtg(zone = :z)
+    convert(zone).format(zone)
+  end
+
+  def format(zone = :z)
+    dtg = "%d%H%M#{zone.upcase} %b %y"
+    strftime(dtg)
+  end
+
+  def convert(zone = :z)
+    zone = zone.downcase
+    raise "Error: #{zone} is not a valid zone" unless UTC_ZONES.key?(zone)
+    zone == :j ? self : self.in_time_zone(UTC_ZONES[zone])
+  end
+end

data/lib/dtg/core_timewithzone_ext.rb

@@ -0,0 +1,22 @@
+require 'dtg'
+require_relative 'zones'
+
+class ActiveSupport::TimeWithZone
+  include Dtg
+  include Zones
+
+  def to_dtg(zone = :z)
+    convert(zone).format(zone)
+  end
+
+  def format(zone = :z)
+    dtg = "%d%H%M#{zone.upcase} %b %y"
+    strftime(dtg)
+  end
+
+  def convert(zone = :z)
+    zone = zone.downcase
+    raise "Error: #{zone} is not a valid zone" unless UTC_ZONES.key?(zone)
+    zone == :j ? self : self.to_time.in_time_zone(UTC_ZONES[zone])
+  end
+end

data/lib/dtg/version.rb

@@ -1,3 +1,3 @@
 module Dtg
-  VERSION = '1.0.0'
+  VERSION = "2.0.0"
 end

data/lib/dtg/zones.rb

@@ -0,0 +1,56 @@
+module Zones
+  UTC_ZONES = {
+    # A: Alpha Time: UTC +01:00 (Paris, France)
+    a: +1,
+    # B: Bravo Time: UTC +02:00 (Athens, Greece)
+    b: +2,
+    # C: Charlie Time: UTC +03:00 (Moscow, Russia)
+    c: +3,
+    # D: Delta Time: UTC +04:00 (Kabul, Afghanistan)
+    d: +4,
+    # E: Echo Time: UTC +05:00 (New Delhi, India)
+    e: +5,
+    # F: Foxtrot Time: UTC +06:00 (Dhanka, Bangladesh)
+    f: +6,
+    # G: Golf Time: UTC +07:00 (Bangkok, Thailand)
+    g: +7,
+    # H: Hotel Time: UTC +08:00 (Beijing, China)
+    h: +8,
+    # I: India Time: UTC +09:00 (Tokyo, Japan)
+    i: +9,
+    # J: Juliet Time: (Local Time Zone)
+    j: "",
+    # K: Kilo Time: UTC +10:00 (Sydney, Australia)
+    k: +10,
+    # L: Lima Time: UTC +11:00 (Honiara, Solomon Islands)
+    l: +11,
+    # M: Mike Time: UTC +12:00 (Wellington, New Zealand)
+    m: +12,
+    # N: November Time: UTC -01:00 (Azores)
+    n: -1,
+    # O: Oscar Time: UTC -02:00 (Gothab, Greenland)
+    o: -2,
+    # P: Papa Time: UTC -03:00 (Buenos Aires, Argentina)
+    p: -3,
+    # Q: Quebec Time: UTC -04:00 (Halifax, Nova Scotia)
+    q: -4,
+    # R: Romeo Time: UTC -05:00 (New York, NY United States)
+    r: -5,
+    # S: Sierra Time: UTC -06:00 (Dallas, TX United States)
+    s: -6,
+    # T: Tango Time: UTC -07:00 (Denver, CO United States)
+    t: -7,
+    # U: Uniform Time: UTC -08:00 (Los Angeles, CA United States)
+    u: -8,
+    # V: Victor Time: UTC -09:00 (Juneau, AK United States)
+    v: -9,
+    # W: Whiskey Time: UTC -10:00 (Honolulu, HI United States)
+    w: -10,
+    # X: X-Ray Time: UTC -11:00 (Nome, AK United States)
+    x: -11,
+    # Y: Yankee Time: UTC -12:00 (Suva, Fiji)
+    y: -12,
+    # Z: Zulu Time: UTC +-00:00 (Greenwich, England)
+    z: "UTC",
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dtg
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - SolarisFlare
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,14 +38,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: "A DTG is a DateTimeGroup which is used in the military to save time.
-  \ DTG\n                      are saved in the format DDHHMML MMM YY, where D is
+  \ DTG \n                      are saved in the format DDHHMML MMM YY, where D is
   day, H is hour, L is \n                      letter, M is month, and Y is year.
-  \ The Month is the 3 character representation\n                      such as JAN
-  for January, MAY for May, DEC for December and so on.  Year is only\n                      the
-  last two digits of the year e.g. 2019 is just 19.  The letter is the zone\n                      code
-  such as W for whiskey which is HST, Z for zulu which is GMT, A-Z are the \n                      zones
-  used."
+  \ The Month is the 3 character \n                      representation such as JAN
+  for January, MAY for May, DEC for December and so \n                      on.  Year
+  is only the last two digits of the year e.g. 2019 is just 19.  The \n                      letter
+  is the zone code such as W for whiskey which is HST, Z for zulu which \n                      is
+  GMT, A-Z are the zones used."
 email:
 - shadowbomb20@gmail.com
 executables: []
@@ -56,9 +70,12 @@ files:
 - README.md
 - Rakefile
 - lib/dtg.rb
-- lib/dtg/core_ext.rb
+- lib/dtg/core_datetime_ext.rb
+- lib/dtg/core_time_ext.rb
+- lib/dtg/core_timewithzone_ext.rb
 - lib/dtg/railtie.rb
 - lib/dtg/version.rb
+- lib/dtg/zones.rb
 - lib/tasks/dtg_tasks.rake
 homepage: https://github.com/SolarisFlare/dtg/
 licenses:

data/lib/dtg/core_ext.rb

@@ -1,70 +0,0 @@
-class Time
-    DTG_ZONES = {
-        # A: Alpha Time: UTC +01:00 (Paris, France)
-        a: +1,
-        # B: Bravo Time: UTC +02:00 (Athens, Greece)
-        b: +2,
-        # C: Charlie Time: UTC +03:00 (Moscow, Russia)
-        c: +3,
-        # D: Delta Time: UTC +04:00 (Kabul, Afghanistan)
-        d: +4,
-        # E: Echo Time: UTC +05:00 (New Delhi, India)
-        e: +5,
-        # F: Foxtrot Time: UTC +06:00 (Dhanka, Bangladesh)
-        f: +6,
-        # G: Golf Time: UTC +07:00 (Bangkok, Thailand)
-        g: +7,
-        # H: Hotel Time: UTC +08:00 (Beijing, China)
-        h: +8,
-        # I: India Time: UTC +09:00 (Tokyo, Japan)
-        i: +9,
-        # J: Juliet Time: (Local Time Zone)
-        j: '',
-        # K: Kilo Time: UTC +10:00 (Sydney, Australia)
-        k: +10,
-        # L: Lima Time: UTC +11:00 (Honiara, Solomon Islands)
-        l: +11,
-        # M: Mike Time: UTC +12:00 (Wellington, New Zealand)
-        m: +12,
-        # N: November Time: UTC -01:00 (Azores)
-        n: -1,
-        # O: Oscar Time: UTC -02:00 (Gothab, Greenland)
-        o: -2,
-        # P: Papa Time: UTC -03:00 (Buenos Aires, Argentina)
-        p: -3,
-        # Q: Quebec Time: UTC -04:00 (Halifax, Nova Scotia)
-        q: -4,
-        # R: Romeo Time: UTC -05:00 (New York, NY United States)
-        r: -5,
-        # S: Sierra Time: UTC -06:00 (Dallas, TX United States)
-        s: -6,
-        # T: Tango Time: UTC -07:00 (Denver, CO United States)
-        t: -7,
-        # U: Uniform Time: UTC -08:00 (Los Angeles, CA United States)
-        u: -8,
-        # V: Victor Time: UTC -09:00 (Juneau, AK United States)
-        v: -9,
-        # W: Whiskey Time: UTC -10:00 (Honolulu, HI United States)
-        w: -10,
-        # X: X-Ray Time: UTC -11:00 (Nome, AK United States)
-        x: -11,
-        # Y: Yankee Time: UTC -12:00 (Suva, Fiji)
-        y: -12,
-        # Z: Zulu Time: UTC +-00:00 (Greenwich, England)
-        z: 'UTC'
-    }
-
-    def to_dtg(zone = :z)
-        self.convert(zone).format(zone)
-    end
-
-    def format(zone = :z)
-        dtg = "%d%H%M#{zone.upcase} %b %y"
-        self.strftime(dtg)
-    end
-
-    def convert(zone = :z)
-        raise "Error: #{zone} is not a valid zone" unless DTG_ZONES.has_key?(zone.downcase)
-        (zone.downcase == :j) ? self : self.in_time_zone(DTG_ZONES[zone.downcase])
-    end
-end