snail 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 262c3219f21ad619b858424c360885d11d3f1522
-  data.tar.gz: c6f39b55987d70ac3715c808e6c1b2aa45e8a747
+  metadata.gz: 812732750415ef2957431d92fcf8da7660d78402
+  data.tar.gz: 1b71a4117e610bd5c67db6b8b139c7235c9bc7b7
 SHA512:
-  metadata.gz: d6269557deae28f0d52d330824fdc99123e447e95937185412761a61782518ab6f195491e19f86017649b3421420b5ba66fe2f931e6975ff2aa34e60f5bb66c7
-  data.tar.gz: d1a6b9356bf78d26f5480cf65be7a8bdb26dbd57c5e1c7f3c33354ef5ca2556e2a784bfdac932c4cd2c0c61755f162e0ff1272ac82e0ff4d562f0b0b11d88910
+  metadata.gz: 80159381c9ad565e003cd5f001f3ad7d0125f05378235301b35306b71679bb363602538910d7dfc8f99138892c586eee8efdc61a75ce1ade8950137f18f8c32b
+  data.tar.gz: 2d95a236f10890ec2c1fb570e70fae2aeb6df23de9b1789a8df715325180654668aa1cb4eae07a18ef0bc6b6876cabd6c3e1942e49e7307e06a644582a157b47

data/README.md

@@ -48,6 +48,23 @@ Snail.new(
 => "Jon Doe\n12345 Somewhere Ln\nBENTLEY WA  6102"
 ```
 
+You can override this default behavior by specifying `with_country` as `true` or `false`:
+
+```ruby
+Snail.home_country = "Australia"
+Snail.new(
+  :name => "Jon Doe",
+  :line_1 => "12345 Somewhere Ln",
+  :line_2 => nil,
+  :city => "Bentley",
+  :region => "WA",
+  :postal_code => "6102",
+  :country => "AU"
+).to_s(with_country: true)
+
+=> "Jon Doe\n12345 Somewhere Ln\nBentley WA  6102\nAUSTRALIA"
+```
+
 See the test cases for more.
 
 ## Fun Times

data/lib/snail.rb

@@ -5,7 +5,6 @@ require 'snail/helpers'
 
 require 'cgi'
 require 'active_support/core_ext/string/output_safety'
-require 'yaml'
 
 class Snail
   include Snail::Initializable
@@ -90,12 +89,24 @@ class Snail
     @origin ||= Snail.home_country
   end
 
-  def to_s
-    [name, line_1, line_2, city_line, country_line].select{|line| !(line.nil? or line.empty?)}.join("\n")
+  def international?
+    country && self.origin != country
   end
 
-  def to_html
-    CGI.escapeHTML(to_s).gsub("\n", '<br />').html_safe
+  def to_s(with_country: nil)
+    with_country = true if with_country.nil? && international?
+
+    [
+      name,
+      line_1,
+      line_2,
+      city_line,
+      (country_line if with_country)
+    ].select{|line| !(line.nil? or line.empty?)}.join("\n")
+  end
+
+  def to_html(with_country: nil)
+    CGI.escapeHTML(to_s(with_country: with_country)).gsub("\n", '<br />').html_safe
   end
 
   # this method will get much larger. completeness is out of my scope at this time.
@@ -151,9 +162,7 @@ class Snail
   end
 
   def country_line
-    if country and self.origin != country
-      (translated_country(self.origin, country) || translated_country("US", country))
-    end
+    (translated_country(self.origin, @country) || translated_country("US", @country))
   end
 
   def translated_country(origin, country)

data/lib/snail/version.rb

@@ -1,3 +1,3 @@
 class Snail
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/test/snail_test.rb

@@ -72,20 +72,48 @@ class SnailTest < Snail::TestCase
     assert s.city_line.match(/NY  12345/)
   end
 
-  test "does not include country name for domestic addresses" do
+  test "does not include country name for domestic addresses by default" do
     s = Snail.new(@us.merge(:origin => 'US'))
     assert !s.to_s.match(/United States/i)
     s = Snail.new(@ca.merge(:origin => 'CA'))
     assert !s.to_s.match(/Canada/i)
   end
 
-  test "includes country name for international addresses" do
+  test "includes country name for domestic addresses if with_country parameter is true" do
+    s = Snail.new(@us.merge(:origin => 'US'))
+    assert s.to_s(with_country: true).match(/United States/i)
+    s = Snail.new(@ca.merge(:origin => 'CA'))
+    assert s.to_s(with_country: true).match(/Canada/i)
+  end
+
+  test "does not include country name for domestic addresses if with_country parameter is false" do
+    s = Snail.new(@us.merge(:origin => 'US'))
+    assert !s.to_s(with_country: false).match(/United States/i)
+    s = Snail.new(@ca.merge(:origin => 'CA'))
+    assert !s.to_s(with_country: false).match(/Canada/i)
+  end
+
+  test "includes country name for international addresses by default" do
     s = Snail.new(@us.merge(:origin => 'CA'))
     assert s.to_s.match(/United States/i)
     s = Snail.new(@ca.merge(:origin => 'US'))
     assert s.to_s.match(/Canada/i)
   end
 
+  test "includes country name for international addresses if with_country parameter is true" do
+    s = Snail.new(@us.merge(:origin => 'CA'))
+    assert s.to_s(with_country: true).match(/United States/i)
+    s = Snail.new(@ca.merge(:origin => 'US'))
+    assert s.to_s(with_country: true).match(/Canada/i)
+  end
+
+  test "does not include country name for international addresses if with_country parameter is false" do
+    s = Snail.new(@us.merge(:origin => 'CA'))
+    assert !s.to_s(with_country: false).match(/United States/i)
+    s = Snail.new(@ca.merge(:origin => 'US'))
+    assert !s.to_s(with_country: false).match(/Canada/i)
+  end
+
   test "includes translated country name for international addresses" do
     s = Snail.new(@us.merge(:origin => 'FR'))
     assert s.to_s.match(/ÉTATS-UNIS/i)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snail
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Lance Ivy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport