tp_common 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b356520bfa9dafe1b9d9faf0085ab4036e1e5dca
-  data.tar.gz: a015f6bd07598ffe465aa90e51730670e73ca2b5
+  metadata.gz: 4bf78bbec3e7eb66ca30db9547608273bf7ae424
+  data.tar.gz: be07e3981aa0085c53a7de8321b49b5700ec0feb
 SHA512:
-  metadata.gz: 2bb409e4a85367d909016d000374132818be6ea00c9f18b5dfa9c2ce554ead08144ecdd9d8d7255a2775f28ffcdb3c86fca45a9a3701c2850afb67b05c6738d7
-  data.tar.gz: c7dbe6e37ca7f854a9883f2550fa7c4b3b992b95820cb20e965f0728157e398b519386e3afa61cc7edc273be672b4682ce001d2335a2593d59b6aebb16477858
+  metadata.gz: e48f961396cc11f1cafc047ccf3db3a157f6f333965de9c6d23bb3042f50c95d67a93c1fbee165f5cff7734f9441025432f36e42dcde156e1cb7f78a08e03b53
+  data.tar.gz: 87f69132d8cd2d176117ce59eb9c97a0e9e3b703f2a0bb2930792a8c11cbf592b1ae0221a09040cb6eae5a89b988fdf287473f2928e0e14a7ff003dfd6aacd57

data/README.md

@@ -1,8 +1,8 @@
-# TpCommon
+[![Build Status](https://travis-ci.org/anvox/tp_common.svg?branch=master)](https://travis-ci.org/anvox/tp_common)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tp_common`. To experiment with that code, run `bin/console` for an interactive prompt.
+# TpCommon
 
-TODO: Delete this and the text above, and describe your gem
+This gem contains common libraries which shared between projects used in TINYpulse.
 
 ## Installation
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Reference http://www.rubydoc.info/gems/tp_common for more detail of each module.
 
 ## Development
 

data/lib/tp_common/railtie.rb

@@ -1,4 +1,7 @@
 module TpCommon
+  # Hook libraries initialize to Rails if using in rails app.
+  # Use this way to wait Rails.application is initialized, so we could use rails application config.
+  #
   class Railtie < ::Rails::Railtie
     config.after_initialize do
       TpCommon::Timezones::Config.config

data/lib/tp_common/timezones/config.rb

@@ -1,6 +1,8 @@
 module TpCommon
   module Timezones
     class Config
+      # Try to load TpCommon::Timezones::LIST_ZONES in config/timezones.yml from rails app.
+      # if not, load the default in timezones/config/timezones.yml
       def self.config
         return if TpCommon::Timezones.const_defined?("LIST_ZONES")
         if defined?(::Rails::Railtie)
@@ -17,6 +19,10 @@ module TpCommon
         TpCommon::Timezones.const_set("LIST_ZONES", load_default_timezones)
       end
 
+      # Private
+      # Load the default TpCommon::Timezones::LIST_ZONES in timezones/config/timezones.yml
+      # This method is clone from Rails' config_for
+      #
       def self.load_default_timezones
         file_path = File.join(File.dirname(__FILE__),"config/timezones.yml")
         yaml = Pathname.new(file_path)

data/lib/tp_common/timezones.rb

@@ -1,13 +1,20 @@
 require 'tp_common/timezones/config'
 
 module TpCommon
+  # Helper methods for handle, display timezones.
+  # Use TP's custom mapping timezones instead of ActiveRecord or TzInfo
+  #
   module Timezones
     # LIST_ZONES = # Dynamic defined in TpCommon::Timezones::Config
 
+    # Get current date in specific timezone.
+    # timezone is LIST_ZONES[time_zone_key]
+    #
     def self.current_date_in_time_zone(time_zone_key)
-      self.converted_time(Time.now, time_zone_key).strftime('%Y-%m-%d %H:%M:%S').to_date
+      self.converted_time(Time.now.utc, time_zone_key).strftime('%Y-%m-%d %H:%M:%S').to_date
     end
 
+    # Human readable offset: GMT+7, GMT-9,...
     def self.offset_in_words(zone_name)
       offset = Time.now.in_time_zone(zone_name).utc_offset
       in_words = 'GMT'
@@ -19,6 +26,10 @@ module TpCommon
       in_words
     end
 
+    # Zone title which display in select options.
+    # if this zone applied DST, display sun_emoji at tail
+    # Display as: title + offset_in_words [+ sun_emoji]
+    #
     def self.zone_title(zone)
       zone_value = LIST_ZONES[zone]
       return nil unless zone_value
@@ -28,6 +39,8 @@ module TpCommon
       [zone_value[:title], self.offset_in_words(zone_value[:name]), dst_icon].reject{|part| part.empty? }.join(" ")
     end
 
+    # The same as (see #zone_title) but doesn't display DST sun_emoji
+    #
     def self.zone_title_without_dst(zone)
       zone_value = LIST_ZONES[zone]
       return nil unless zone_value
@@ -35,20 +48,28 @@ module TpCommon
       [zone_value[:title], self.offset_in_words(zone_value[:name])].reject{|part| part.empty? }.join(" ")
     end
 
+    # LIST_ZONES which map to format [text_to_display, key_identity]
+    # For use in render select tag
+    #
     def self.list_for_select
       LIST_ZONES.map{ |k, v| [self.zone_title(k), k] }
     end
 
     # return hash offsets. Ex: {'GMT' => 0, ...}
+    #
     def self.list_zone_offsets
       Hash[LIST_ZONES.map{ |k, v| [k, Time.now.in_time_zone(v[:name]).utc_offset] }]
     end
 
+    # Convert back a time in zone (defined in LIST_ZONES) to utc time
+    #
     def self.local_to_utc(time, zone)
       zone_value = LIST_ZONES[zone]
       ActiveSupport::TimeZone.new(zone_value[:name]).local_to_utc(time)
     end
 
+    # Opposite of #local_to_utc It conver a time to time in zone defined in LIST_ZONES
+    #
     def self.converted_time(time, zone)
       if time
         zone_value = LIST_ZONES[zone]
@@ -61,11 +82,15 @@ module TpCommon
       end
     end
 
+    # Get zone name by time_zone_key
+    #
     def self.zone_abbreviation(time_zone_key)
       zone_value = LIST_ZONES[time_zone_key]
       zone_value[:name]
     end
 
+    # Return a DateTime object of param time in specific timezone decide by time_zone_key
+    #
     def self.relative_time_in_time_zone(time, time_zone_key)
       zone = zone_abbreviation(time_zone_key)
       DateTime.parse(time.strftime("%d %b %Y %H:%M:%S #{time.in_time_zone(zone).formatted_offset}"))

data/lib/tp_common/version.rb

@@ -1,3 +1,3 @@
 module TpCommon
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/tp_common.rb

@@ -3,12 +3,13 @@ require 'active_support/all'
 require 'psych'
 require 'yaml'
 
-require 'pry-byebug'
-
 if defined?(::Rails::Railtie)
   require 'tp_common/railtie'
 end
 
+# Main scope of libraries.
+# Dont put anything here.
+#
 module TpCommon
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tp_common
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - An Vo