lazier 4.1.0 → 4.2.0

data/lib/lazier/string.rb

@@ -4,7 +4,7 @@
 #
 
 module Lazier
-  # Extensions for the String class.
+  # Extensions for the `String` class.
   module String
     extend ::ActiveSupport::Concern
 
@@ -17,6 +17,15 @@ module Lazier
       encode("utf-16", invalid: :replace, undef: :replace, replace: replacement).encode("utf-8")
     end
 
+    # Makes sure the string starts with the scheme for the specified protocol.
+    #
+    # @param protocol [String] The protocol for the URL.
+    # @param secure [Boolean] If the scheme should be secure or not.
+    def ensure_url_with_scheme(protocol = "http", secure: false)
+      schema = protocol + (secure ? "s" : "")
+      self !~ /^(#{protocol}(s?):\/\/)/ ? "#{schema}://#{self}" : self
+    end
+
     # Returns the string itself for use in form helpers.
     #
     # @return [String] The string itself.

data/lib/lazier/timezone.rb

@@ -4,7 +4,7 @@
 #
 
 module Lazier
-  # Extensions for timezone objects.
+  # Extensions for `TimeZone` objects.
   module TimeZone
     extend ::ActiveSupport::Concern
 
@@ -34,7 +34,7 @@ module Lazier
       # Returns a +HH:MM formatted representation of the offset.
       #
       # @param offset [Rational|Fixnum] The offset to represent, in seconds or as a rational.
-      # @param colon [Boolean] If to put the colon in the output string.
+      # @param colon [Boolean] Whether to put the colon in the output string.
       # @return [String] The formatted offset.
       def format_offset(offset, colon = true)
         seconds_to_utc_offset(offset.is_a?(::Rational) ? (offset * 86_400).to_i : offset, colon)
@@ -78,7 +78,7 @@ module Lazier
       # # => "-0800@pacific-time-us-canada"
       # ```
       # @param tz [TimeZone|String] The zone to represent.
-      # @param with_offset [Boolean] If to include offset into the representation.
+      # @param with_offset [Boolean] Whether to include offset into the representation.
       # @return [String] A string representation which can be used for searches.
       def parameterize(tz, with_offset = true)
         tz = tz.to_str unless tz.is_a?(::String)
@@ -147,7 +147,7 @@ module Lazier
       end
     end
 
-    # Returns a list of valid aliases (city names) for this timezone (basing on offset).
+    # Returns a list of valid aliases (city names) for this timezone (basing on the offset).
     # @return [Array] A list of aliases for this timezone
     def aliases
       reference = self.class::MAPPING.fetch(name, name).gsub("_", " ")
@@ -156,8 +156,8 @@ module Lazier
 
     # Returns the current offset for this timezone, taking care of Daylight Saving Time (DST).
     #
-    # @param rational [Boolean] If to return the offset as a Rational.
-    # @param date [DateTime] The date to consider. Defaults to now.
+    # @param rational [Boolean] Whether to return the offset as a Rational.
+    # @param date [DateTime|NilClass] The date to consider. Defaults to now.
     # @return [Fixnum|Rational] The offset of this timezone.
     def current_offset(rational = false, date = nil)
       date = (date || ::DateTime.current).in_time_zone
@@ -185,7 +185,7 @@ module Lazier
 
     # Returns the current name.
     #
-    # @param dst [Boolean] If to return the name with DST indication.
+    # @param dst [Boolean] Whether to return the name with DST indication.
     # @param dst_label [String] Label for the DST indication. Defaults to ` (DST)`.
     # @param year [Fixnum] The year to which refer to. Defaults to the current year. *Only required when `dst` is true*.
     # @return [String] The name for the zone.
@@ -198,9 +198,9 @@ module Lazier
 
     # Returns the standard offset for this timezone.
     #
-    # @param rational [Boolean] If to return the offset as a Rational.
-    # @param dst [Boolean] If to return the offset when the DST is active.
-    # @param year [Fixnum] The year to which refer to. Defaults to the current year.
+    # @param rational [Boolean] Whether to return he offset as a `Rational`.
+    # @param dst [Boolean] Whether to return the offset when the DST is active.
+    # @param year [Fixnum|NilClass] The year to which refer to. Defaults to the current year.
     # @return [Fixnum|Rational] The offset of this timezone.
     def offset(rational: false, dst: false, year: nil)
       rv =
@@ -216,7 +216,7 @@ module Lazier
 
     # Checks if the timezone uses Daylight Saving Time (DST) for that date or year.
     #
-    # @param reference [Date|DateTime] The date or year to check. Defaults to the current year.
+    # @param reference [Date|DateTime|NilClass] The date or year to check. Defaults to the current year.
     # @return [Boolean] `true` if the zone uses DST for that date or year, `false` otherwise.
     def uses_dst?(reference = nil)
       if reference.is_a?(Date) || reference.is_a?(DateTime) || reference.is_a?(Time)
@@ -228,7 +228,7 @@ module Lazier
 
     # Gets a period for this timezone when the Daylight Saving Time (DST) is active (it takes care of different hemispheres).
     #
-    # @param year [Fixnum] The year to which refer to. Defaults to the current year.
+    # @param year [Fixnum|NilClass] The year to which refer to. Defaults to the current year.
     # @return [TimezonePeriod] A period when the Daylight Saving Time (DST) is active or `nil` if the timezone doesn't use DST for that year.
     def dst_period(year = nil)
       year ||= ::Date.current.year
@@ -242,8 +242,8 @@ module Lazier
 
     # Return the correction applied to the standard offset the timezone when the Daylight Saving Time (DST) is active.
     #
-    # @param rational [Boolean] If to return the offset as a Rational.
-    # @param year [Fixnum] The year to which refer to. Defaults to the current year.
+    # @param rational [Boolean] Whether to return the offset as a Rational.
+    # @param year [Fixnum|NilClass] The year to which refer to. Defaults to the current year.
     # @return [Fixnum|Rational] The correction for dst.
     def dst_correction(rational = false, year = nil)
       rv = dst_offset(year, :std_offset)
@@ -252,18 +252,16 @@ module Lazier
 
     # Formats this zone as a string.
     #
-    # @param dst [Boolean] If to represent with (DST) active.
+    # @param dst [Boolean] Whether to represent with (DST) active.
     # @param args [Hash] Parameters for the formatting:
-    #
-    #   * **label** (`String`): The label to use. Default to the current alias.
-    #   * **dst_label** (`String`): Label for the DST indication. Defaults to ` (DST)`.
-    #   * **utc_label** (`String`): Label for the UTC name. Defaults to `GMT`. *Only used when `parameterized` is `false`.
-    #   * **year** (`Fixnum`): The year to which refer to. Defaults to the current year.
-    #   * **parameterized** (`Boolean`): If to represent as parameterized.
-    #   * **with_offset** (`Boolean`): If to include offset into the representation. *Only used when `parameterized` is `true`.
-    #   * **offset_position** (`Symbol`): Where to put the offset. Valid values are `:begin` or `:end`. *Only used when `parameterized` is `false`.
-    #   * **colon** (`Boolean`): If include a colon in the offset. *Only used when `parameterized` is `false`.
-    #
+    # @option args label [String]: The label to use. Default to the current alias.
+    # @option args dst_label [String]: Label for the DST indication. Defaults to ` (DST)`.
+    # @option args utc_label [String]: Label for the UTC name. Defaults to `GMT`. *Only used when `parameterized` is `false`.
+    # @option args year [Fixnum]: The year to which refer to. Defaults to the current year.
+    # @option args parameterized [Boolean]: Whether to represent as parameterized.
+    # @option args with_offset [Boolean]: Whether to include offset into the representation. *Only used when `parameterized` is `true`.
+    # @option args offset_position [Symbol]: Where to put the offset. Valid values are `:begin` or `:end`. *Only used when `parameterized` is `false`.
+    # @option args colon [Boolean]: If include a colon in the offset. *Only used when `parameterized` is `false`.
     # @return [String] The string representation for this zone.
     def to_str(dst = false, **args)
       # PI: Ignore reek on this.

data/lib/lazier/version.rb

@@ -12,7 +12,7 @@ module Lazier
     MAJOR = 4
 
     # The minor version.
-    MINOR = 1
+    MINOR = 2
 
     # The patch version.
     PATCH = 0

data/spec/lazier/string_spec.rb

@@ -29,6 +29,20 @@ describe Lazier::String do
     end
   end
 
+  describe "#ensure_url_with_scheme" do
+    it "should return a URL with scheme" do
+      expect("http://google.com".ensure_url_with_scheme).to eq("http://google.com")
+      expect("http://google.com".ensure_url_with_scheme(secure: true)).to eq("http://google.com")
+      expect("google.com".ensure_url_with_scheme).to eq("http://google.com")
+      expect("google.com".ensure_url_with_scheme(secure: true)).to eq("https://google.com")
+
+      expect("http://google.com".ensure_url_with_scheme("ftp")).to eq("ftp://http://google.com")
+      expect("ftp://google.com".ensure_url_with_scheme("ftp", secure: true)).to eq("ftp://google.com")
+      expect("google.com".ensure_url_with_scheme("ftp")).to eq("ftp://google.com")
+      expect("google.com".ensure_url_with_scheme("ftp", secure: true)).to eq("ftps://google.com")
+    end
+  end
+
   describe "#value" do
     it "should return the string itself" do
       expect(subject.value).to eq(subject)

data/spec/spec_helper.rb

@@ -3,15 +3,8 @@
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
-require "rubygems"
 require "bundler/setup"
 require File.dirname(__FILE__) + "/../lib/lazier"
 
-RSpec.configure do |config|
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end
-
 ::I18n.enforce_available_locales = false
-Lazier::I18n.default_locale = :en
+Lazier::I18n.default_locale = :en

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazier
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Shogun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport