series_joiner 1.0.0 → 1.1.0

data/README.rdoc

@@ -20,10 +20,9 @@ Add the following to your Gemfile:
 
 join_as_series() accepts the following options:
 
-  :delimiter       # inserted between items, except for the final two (default => ',')
+  :delimiter       # inserted between items, except for the final two (default => ', ')
   :final_delimiter # inserted between the final two items (if > 2), but before the conjunction (default => '')
-  :conjunction     # inserted between the final two items (default => 'and')
-  :padding         # inserted after delimiters, as well as before and after conjunctions (default => ' ')
+  :conjunction     # inserted between the final two items (default => ' and ')
 
 By default, items are joined as follows:
 
@@ -37,11 +36,11 @@ By default, items are joined as follows:
 
 Here are some examples using custom delimiters and/or conjunctions:
 
-  ['a', 'b', 'c'].join_as_series(:delimiter => ';') #=> 'a; b and c'
+  ['a', 'b', 'c'].join_as_series(:delimiter => '; ') #=> 'a; b and c'
 
-  ['a', 'b', 'c'].join_as_series(:conjunction => 'or') #=> 'a, b or c'
+  ['a', 'b', 'c'].join_as_series(:conjunction => ' or ') #=> 'a, b or c'
 
-  ['a', 'b', 'c'].join_as_series(:delimiter => ';', :conjunction => '; or,') #=> 'a; b; or, c'
+  ['a', 'b', 'c'].join_as_series(:delimiter => '; ', :conjunction => '; or,') #=> 'a; b; or, c'
 
 The use of the serial comma (i.e. the final comma sometimes used before the conjunction) is much debated in grammar (http://en.wikipedia.org/wiki/Serial_comma). By default, SeriesJoiner does not use the serial comma. However, the <tt>:final_delimiter</tt> option can be set to <tt>','</tt> to include it:
 
@@ -53,6 +52,13 @@ This gem is generated with jeweler and uses shoulda for testing. To run tests:
 
   rake test
 
+== Notes
+
+This gem may be compared with the Rails ActiveSupport extension to Array <tt>to_sentence()</tt> (https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/array/conversions.rb). Here are a couple differences:
+* <tt>to_sentence()</tt> requires ActiveSupport, while <tt>join_as_series</tt> has no Rails dependencies;
+* <tt>to_sentence()</tt> has I18n support baken in; and,
+* <tt>to_sentence()</tt> requires two options (<tt>:two_words_connector</tt> and <tt>:last_word_connector</tt>) to override a conjunction, instead of the one (<tt>:conjunction</tt>) required by <tt>join_as_series</tt> 
+
 == License
 
 MIT License. Copyright (c) 2011 Cerebris Corporation. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/series_joiner.rb

@@ -5,13 +5,11 @@ module SeriesJoiner
   #   :delimiter       => inserted between items, except for the final two (default => ',')
   #   :final_delimiter => inserted between the final two items (if > 2), but before the conjunction (default => '')
   #   :conjunction     => inserted between the final two items (default => 'and')
-  #   :padding         => inserted after delimiters, as well as before and after conjunctions (default => ' ')
   #
   def join_as_series(options = {})
-    padding = options[:padding] || ' '
-    delimiter = options[:delimiter] || ','
+    delimiter = options[:delimiter] || ', '
     final_delimiter = options[:final_delimiter] || ''
-    conjunction = options[:conjunction] || 'and'
+    conjunction = options[:conjunction] || ' and '
 
     sz = self.size
     if sz > 0
@@ -19,11 +17,11 @@ module SeriesJoiner
       if sz > 1
         if sz > 2
           for i in 1..(sz - 2)
-            r += delimiter + padding + self[i]
+            r += delimiter + self[i]
           end
           r += final_delimiter
         end
-        r += padding + conjunction + padding + self[sz - 1]
+        r += conjunction + self[sz - 1]
       end
     end
     return r

data/series_joiner.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{series_joiner}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Gebhardt"]

data/test/test_series_joiner.rb

@@ -21,7 +21,7 @@ class TestSeriesJoiner < Test::Unit::TestCase
   
   context "using an 'or' conjunction" do
     setup do
-      @options = {:conjunction => 'or'}
+      @options = {:conjunction => ' or '}
     end
     
     should "join an array of one item" do
@@ -40,7 +40,7 @@ class TestSeriesJoiner < Test::Unit::TestCase
 
   context "using a ';' delimiter" do
     setup do
-      @options = {:delimiter => ';'}
+      @options = {:delimiter => '; '}
     end
     
     should "join an array of one item" do
@@ -57,41 +57,41 @@ class TestSeriesJoiner < Test::Unit::TestCase
     end
   end
 
-  context "using a ',' final delimiter" do
+  context "using a ';' delimiter properly" do
     setup do
-      @options = {:final_delimiter => ','}
+      @options = {:delimiter => '; ', :conjunction => '; or, '}
     end
     
     should "join an array of one item" do
       assert_equal 'a', ['a'].join_as_series(@options)
     end
     should "join an array of two items" do
-      assert_equal 'a and b', ['a', 'b'].join_as_series(@options)
+      assert_equal 'a; or, b', ['a', 'b'].join_as_series(@options)
     end
     should "join an array of three items" do
-      assert_equal 'a, b, and c', ['a', 'b', 'c'].join_as_series(@options)
+      assert_equal 'a; b; or, c', ['a', 'b', 'c'].join_as_series(@options)
     end
     should "join an array of four items" do
-      assert_equal 'a, b, c, and d', ['a', 'b', 'c', 'd'].join_as_series(@options)
+      assert_equal 'a; b; c; or, d', ['a', 'b', 'c', 'd'].join_as_series(@options)
     end
   end
 
-  context "acting as a straight join without any padding" do
+  context "using a ',' final delimiter" do
     setup do
-      @options = {:delimiter => '/', :conjunction => '/', :padding => ''}
+      @options = {:final_delimiter => ','}
     end
     
     should "join an array of one item" do
       assert_equal 'a', ['a'].join_as_series(@options)
     end
     should "join an array of two items" do
-      assert_equal 'a/b', ['a', 'b'].join_as_series(@options)
+      assert_equal 'a and b', ['a', 'b'].join_as_series(@options)
     end
     should "join an array of three items" do
-      assert_equal 'a/b/c', ['a', 'b', 'c'].join_as_series(@options)
+      assert_equal 'a, b, and c', ['a', 'b', 'c'].join_as_series(@options)
     end
     should "join an array of four items" do
-      assert_equal 'a/b/c/d', ['a', 'b', 'c', 'd'].join_as_series(@options)
+      assert_equal 'a, b, c, and d', ['a', 'b', 'c', 'd'].join_as_series(@options)
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: series_joiner
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Dan Gebhardt