series_joiner 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Cerebris Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,58 @@
+= SeriesJoiner
+
+A gem for joining items in arrays together into grammatically correct series. 
+
+SeriesJoiner extends the <tt>Array</tt> class with a <tt>join_as_series()</tt> method which is similar to the built-in <tt>join()</tt> method. However, <tt>join_as_series()</tt> allows for custom delimiters and conjunctions. 
+
+== Installation
+
+Run the following (perhaps as sudo):
+
+  gem install series_joiner
+  
+== Bundler Configuration
+
+Add the following to your Gemfile:
+
+  gem 'series_joiner'
+
+== Usage
+
+join_as_series() accepts the following options:
+
+  :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 => ' ')
+
+By default, items are joined as follows:
+
+  ['a'].join_as_series #=> 'a'
+  
+  ['a', 'b'].join_as_series #=> 'a and b'
+  
+  ['a', 'b', 'c'].join_as_series #=> 'a, b and c'
+  
+  ['a', 'b', 'c', 'd'].join_as_series #=> 'a, b, c and d'
+
+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(: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:
+
+  ['a', 'b', 'c'].join_as_series(:final_delimiter => ',') #=> 'a, b, and c'
+
+== Implementation
+
+This gem is generated with jeweler and uses shoulda for testing. To run tests:
+
+  rake test
+
+== License
+
+MIT License. Copyright (c) 2011 Cerebris Corporation. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "series_joiner"
+  gem.homepage = "http://github.com/cerebris/series_joiner"
+  gem.license = "MIT"
+  gem.summary = "Join items in arrays together into grammatically correct series."
+  gem.description = "Extends Array with a join_as_series() method for joining arrays of items together into grammatically correct series. Useful for joining series like 'a, b and c'. Custom delimiters and conjunctions can be specified."
+  gem.email = "contact@cerebris.com"
+  gem.authors = ["Dan Gebhardt"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "series_joiner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/series_joiner.rb

@@ -0,0 +1,35 @@
+module SeriesJoiner
+  # join_as_series - join items in an array together in a grammatically correct manner
+  #
+  # options:
+  #   :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] || ','
+    final_delimiter = options[:final_delimiter] || ''
+    conjunction = options[:conjunction] || 'and'
+
+    sz = self.size
+    if sz > 0
+      r = self[0]
+      if sz > 1
+        if sz > 2
+          for i in 1..(sz - 2)
+            r += delimiter + padding + self[i]
+          end
+          r += final_delimiter
+        end
+        r += padding + conjunction + padding + self[sz - 1]
+      end
+    end
+    return r
+  end
+end
+
+class Array
+  include SeriesJoiner
+end

data/series_joiner.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{series_joiner}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Gebhardt"]
+  s.date = %q{2011-01-05}
+  s.description = %q{Extends Array with a join_as_series() method for joining arrays of items together into grammatically correct series. Useful for joining series like 'a, b and c'. Custom delimiters and conjunctions can be specified.}
+  s.email = %q{contact@cerebris.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/series_joiner.rb",
+    "series_joiner.gemspec",
+    "test/helper.rb",
+    "test/test_series_joiner.rb"
+  ]
+  s.homepage = %q{http://github.com/cerebris/series_joiner}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.1}
+  s.summary = %q{Join items in arrays together into grammatically correct series.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_series_joiner.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'series_joiner'
+
+class Test::Unit::TestCase
+end

data/test/test_series_joiner.rb

@@ -0,0 +1,97 @@
+require 'helper'
+
+class TestSeriesJoiner < Test::Unit::TestCase
+  context "using default options" do
+    should "join an empty array as nil" do
+      assert_equal nil, [].join_as_series
+    end
+    should "join an array of one item" do
+      assert_equal 'a', ['a'].join_as_series
+    end
+    should "join an array of two items" do
+      assert_equal 'a and b', ['a', 'b'].join_as_series
+    end
+    should "join an array of three items" do
+      assert_equal 'a, b and c', ['a', 'b', 'c'].join_as_series
+    end
+    should "join an array of four items" do
+      assert_equal 'a, b, c and d', ['a', 'b', 'c', 'd'].join_as_series
+    end
+  end
+  
+  context "using an 'or' conjunction" do
+    setup do
+      @options = {: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 or b', ['a', 'b'].join_as_series(@options)
+    end
+    should "join an array of three items" do
+      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 or d', ['a', 'b', 'c', 'd'].join_as_series(@options)
+    end
+  end
+
+  context "using a ';' delimiter" do
+    setup do
+      @options = {: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 and 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)
+    end
+    should "join an array of four items" do
+      assert_equal 'a; b; c and d', ['a', 'b', 'c', 'd'].join_as_series(@options)
+    end
+  end
+
+  context "using a ',' final delimiter" do
+    setup do
+      @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 and 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)
+    end
+    should "join an array of four items" do
+      assert_equal 'a, b, c, and d', ['a', 'b', 'c', 'd'].join_as_series(@options)
+    end
+  end
+
+  context "acting as a straight join without any padding" do
+    setup do
+      @options = {:delimiter => '/', :conjunction => '/', :padding => ''}
+    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)
+    end
+    should "join an array of three items" do
+      assert_equal 'a/b/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)
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: series_joiner
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dan Gebhardt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: Extends Array with a join_as_series() method for joining arrays of items together into grammatically correct series. Useful for joining series like 'a, b and c'. Custom delimiters and conjunctions can be specified.
+email: contact@cerebris.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/series_joiner.rb
+- series_joiner.gemspec
+- test/helper.rb
+- test/test_series_joiner.rb
+has_rdoc: true
+homepage: http://github.com/cerebris/series_joiner
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Join items in arrays together into grammatically correct series.
+test_files: 
+- test/helper.rb
+- test/test_series_joiner.rb