ellipsis 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ellipsis.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,56 @@
+
+= Ellipsis
+
+By making use of an ellipsis or similar symbols the representation of a list of
+elements can be abbreviated. This can be helpful in situtations where character
+space is limited, and at the same time may be more aesthetically pleasing.
+
+
+== Installation
+
+Installation as usual:
+
+    gem install ellipsis
+
+== Usage and Examples
+
+After you require the gem with
+
+    require 'ellipsis'
+
+The array class is extended with the following two methods that are similar 
+to the +to_sentence+ method in Rails.
+
+=== to_abbr_series
+
+This method assumes that the elements represent a sorted list; 
+Using the method displays an ellipsis. For example:
+
+    [1,2,3,4,5].to_abbr_series    # => "1, 2, ..., 5"
+
+
+=== to_abbr_set
+
+This method summarizes consecutive subsets in with dash. See the following
+example:
+
+    [1,2,3, 5,6].to_abbr_set      # => "1-3, 5, 6"
+
+So far the notion of consecutive refers to integer successors. Thus the array
+needs to be an integer array. If you don't want integers in the actual string
+representation you can pass an additional block that will convert an integer 
+to a custom string representation:
+
+    WEEKDAYS = ['mon', 'tue', 'wed','thu', 'fri', 'sat', 'sun']
+    days = [1,2,3,5,6]
+
+    days.to_abbr_set {|e| WEEKDAYS[e] }    # =>  'mon-wed, fri, sat'
+
+
+
+== Outlook 
+
+* refactor unit tests
+* Implement options similar to the +to_sentence+ method in Rails.  
+
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run all tests'
+task :default => :test
+
+desc 'Run unit tests'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc 'Generate Documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Ellipsis'
+  rdoc.options << '--line-numbers' << '--inline_source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+

data/ellipsis.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ellipsis/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ellipsis"
+  s.version     = Ellipsis::VERSION
+  s.authors     = ["Kai Rubarth"]
+  s.email       = ["kai@doxter.de"]
+  s.homepage    = ""
+  s.summary     = %q{Converts arrays into abbreviated String representations.}
+  s.description = %q{The gem provides various methods for turning a list of elements into an abbreviated string representation.}
+
+  s.rubyforge_project = "ellipsis"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end
+
+

data/lib/ellipsis.rb

@@ -0,0 +1,7 @@
+require "ellipsis/version"
+
+module Ellipsis
+  require 'ellipsis/core_ext/array/conversions'
+end
+
+

data/lib/ellipsis/core_ext/array/conversions.rb

@@ -0,0 +1,35 @@
+class Array
+
+  def to_abbr_series(options={})
+    case length
+    when 0
+      ""
+    when 1
+      self[0].to_s
+    when 2, 3
+      self.join(', ')
+    else
+      self[0..1].join(', ').to_s + ', ..., ' + self[-1].to_s
+    end
+  end
+
+  def to_abbr_set(options={}, &to_s)
+    return '' if self.empty?
+    to_s ||= lambda{|e| e}
+    ci = 0
+    consecutive_sets = [[self.shift]]
+
+    self.each_with_index do |e,i|
+      if e <= consecutive_sets[ci].last + 1
+        consecutive_sets[ci] << e
+      else
+        ci+=1
+        consecutive_sets[ci] = [e]
+      end
+    end
+
+    consecutive_sets.map{|s| s.map{|e| to_s.call(e)}}.map{|s| s.size > 2 ? "#{s[0]}-#{s[-1]}" : s.join(', ') }.join(', ')
+
+  end
+
+end

data/lib/ellipsis/version.rb

@@ -0,0 +1,3 @@
+module Ellipsis
+  VERSION = "0.0.1"
+end

data/test/core_ext/array_ext_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class ArrayExtToAbbrSeries < Test::Unit::TestCase
+
+  def test_empty
+    assert_equal '', [].to_abbr_series
+  end
+
+  def test_one_element
+    assert_equal '1', [1].to_abbr_series
+  end
+
+  def test_two_elements
+    assert_equal '1, 2', [1, 2].to_abbr_series
+  end
+
+  def test_three_elements
+    assert_equal '1, 2, 3', [1, 2, 3].to_abbr_series
+  end
+
+  def test_more_than_three_elements
+    assert_equal '1, 2, ..., 4', [1, 2, 3, 4].to_abbr_series
+  end
+
+
+end
+
+
+class ArrayExtToConsolidatedSeries < Test::Unit::TestCase
+
+  def test_empty
+    assert_equal '', [].to_abbr_set
+  end
+
+  def test_single_element 
+    assert_equal '1', [1].to_abbr_set
+  end
+
+  def test_two_elements
+    assert_equal '1, 2', [1,2].to_abbr_set
+  end
+
+  def test_non_consecutive_three_elements
+    assert_equal '1, 3, 5', [1,3,5].to_abbr_set
+  end
+
+  def test_consecutive_three_elements
+    assert_equal '1-3', [1,2,3].to_abbr_set
+  end
+
+  def test_consecutive_non_consecutive
+    assert_equal '1-3, 5, 6', [1,2,3, 5,6].to_abbr_set
+  end
+
+  def test_consecutive_non_and_consecutive
+    assert_equal '1-3, 5, 7-9', [1,2,3, 5,7,8,9].to_abbr_set
+  end
+
+  def test_block
+    assert_equal '1-9', [1,2,3].to_abbr_set {|e| "#{e*e}" }
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+
+require 'test/unit'
+require 'ellipsis'
+
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: ellipsis
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kai Rubarth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: The gem provides various methods for turning a list of elements into an abbreviated string representation.
+email: 
+- kai@doxter.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- ellipsis.gemspec
+- lib/ellipsis.rb
+- lib/ellipsis/core_ext/array/conversions.rb
+- lib/ellipsis/version.rb
+- test/core_ext/array_ext_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+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: ellipsis
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Converts arrays into abbreviated String representations.
+test_files: 
+- test/core_ext/array_ext_test.rb
+- test/test_helper.rb