glossync 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b3fca7e886ee98004c3a5294042a66e8c19d99959b5e6fa160423c5fbbbc8cf
-  data.tar.gz: beb018ec951d554c688e791f8b4bc3681a2b8d24f15bc572d04bfb4ed721aa1b
+  metadata.gz: d9691ad226bb7f81bec886d45d957fabb312707ed74c0c21bdb65a9a83273420
+  data.tar.gz: 16f7f0279a84bc2419df6426a8212c1c746bc097ff2fd748c31f9ae562517f10
 SHA512:
-  metadata.gz: 0a096bdba1209036d5ef2e19c905eac2f8a91b06d6c8786d950136c15f779d7654d4bf8ecc605b0e14e63eba17b2ffa0eef7043f7cf438acb04024f5fd77d9c4
-  data.tar.gz: ea9431a5e8670775fd0c959adbc6c4249662cc5f849c0fbe234bac9fc1745734f4dfb2882c2d59dbb6fcbe9bec74b854387cc8ed48dfd887b7739c2051616092
+  metadata.gz: 3b673baf2a80741bb0e9e7b8fd5ab270bbfc4007821a27a454f81d5fcdf0ed80886844afcf7453f3a8c1d0f57b3ec8d5c8ed8d8ae451a004bd0d578dd24e6b3d
+  data.tar.gz: 5654114e854ad28c2b7b5e6f6054dda4c27037d85ad5fdfa12360452bcaef5bd9442087cbf0321a11db98482a1de9af7691dff5280a5a59d69c54fff9b78feb3

data/lib/glossync/config.rb

@@ -6,6 +6,8 @@ module Glossync
     base_locale:                 :en,
   }.freeze
 
+  # define convinence methods for each of the configuration paramaters special
+  # methods added for parameters that take booleans, e.g. dont_xxxx or xxxx!
   DEFAULT_CONFIG.each do |k, v|
     (case v
     when true, false
@@ -23,11 +25,14 @@ module Glossync
   end
 
   class << self
+    # A hash which stores all of Glossync's global options.
     attr_reader :options
 
+    # If called with a block, executes the block setting the argument to Glossync,
+    # else returns the options hash
     def config(&block)
-      @options ||= {}
-      block.call(Glossync)
+      @options ||= DEFAULT_CONFIG.clone
+      block_given? ? block.call(Glossync) : @options
     end
   end
 end

data/lib/glossync/exceptions.rb

@@ -1,4 +1,6 @@
 module Glossync
+  # Raised if Glossync is used before a valid tl_store is set.
+  # @see Glossync#tl_store
   class NoTranslationStore < StandardError
     def initialize(*)
       super('please set Glossync.tl_store')

data/lib/glossync/missing_translation_handler.rb

@@ -1,23 +1,42 @@
 module Glossync
+  # Holds various missing translation handlers.  Any object is a missing
+  # translation handler if it responds to the method handle with an arity of 4
   module MissingTranslationHandler
+
+    # The default handler, simply returns the error message
     class Default
+      # handles an I18n MissingTranslation error
+      # @param error the error thrown by I18n, should always be a MissingTranslation
+      # @param who the self of the class that caught the error
+      # @param field the field that has a missing translation
+      # @param locale the locale that was being translated to
+      # @return [String]
       def handle(error, _who, _field, _locale)
         error.message
       end
     end
 
+    # Raises the error message
     class Raiser
+      # :nodoc:
       def handle(error, _, _, _)
         raise error
       end
     end
 
+    # This handler attempts to translate the given string to the target language using
+    # the Google Translate API
     class GoogleTranslate
+      # @param key the key for the Google Translate API
       def initialize(key)
         @api_key = key
         @cache = {}
       end
 
+      # Translate text to the to locale
+      # @param text the text to translate
+      # @param to the locale to translate to
+      # @return [String] the translated text or an error message
       def translate(text, to)
         EasyTranslate.translate(
           text,
@@ -25,8 +44,11 @@ module Glossync
           to: to,
           key: @api_key
         )
+      rescue SocketError
+        "failed to connect to google translate api"
       end
 
+      # :nodoc:
       def handle(_, who, field, locale)
         key = who.tl_key(field)
 

data/lib/glossync/version.rb

@@ -1,3 +1,3 @@
 module Glossync
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/lib/glossync.rb

@@ -107,7 +107,7 @@ module Glossync
 
   # Call I18n.translate for the key corresponding to field
   #
-  # @example QuizAnswer.first.tl_key(:answer) => "True"
+  # @example QuizAnswer.first.tl(:answer) => "True"
   #
   # @param field the field to translate
   # @return [String] the translated string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glossync
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Stone Tickle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler