elipsa 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 6601d104f56f3358b82a1c5b5065bebbb26d64c7
+  data.tar.gz: f87478c90746393a7ac5db65e0107afbf1eee2bc
+SHA512: 
+  metadata.gz: c2b58bd5d80a23fc94f17109e123dc258f249b4b15d730b14e94f7bdb54da8ddf951502d625408b283ef8bd57557b0ef234ec27c26cf73ade09c5d43fd83a2b6
+  data.tar.gz: 3fb2bd550af5215f251da8496f40faa92c38fcd3de31c08729dbec43612730bb7cd8fd16a1faad25be6e62135341ce20f4765e89636c07f696c3e2d75ce7ead5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+script: "bundle exec rake spec"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx

data/Gemfile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+platforms :rbx do
+  # These are the transitive
+  # ruby standard library dependencies
+  gem 'rubysl-singleton'
+
+  # This gem has no direct rubysl dependencies
+end
+
+# Specify your gem's dependencies in elipsa.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Biesemeyer
+
+MIT License
+
+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.md

@@ -0,0 +1,99 @@
+# Elipsa
+
+Elipsa is a tool for conditionally and smartly truncating a string to a
+specific length. It pays attention to word-boundaries, and tries to give
+you as much of the string as it can, while still fitting your parameters.
+
+The name of this gem is derived from the Serbo-Croatian [`елипса`][elipsa],
+which can be translated directly to English `ellipsis`.
+
+[elipsa]: http://en.wiktionary.org/wiki/elipsa
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elipsa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elipsa
+
+## Usage
+
+~~~ ruby
+require 'elipsa'
+extend Elipsa # (note: `self` is `main`)
+
+# it leaves short strings alone
+elipsa("a short string", length: 20)
+# => "a short string"
+
+# and breaks at word-boundaries when it can
+elipsa("a longer string that goes over the limit", length: 20)
+# => "a longer string..."
+
+# but never truncates too much
+elipsa("supercalifragilisticexpialidocious", length: 20)
+# => "supercalifragilis..."
+
+# and it never chops when it doesn't need to.
+elipsa("nineteen characters", length: 20)
+# => "nineteen characters"
+~~~
+
+## Advanced Usage
+
+### Length
+
+The `:length` parameter is optional and defaults to 80 characters.
+
+~~~ ruby
+elipsa(lorem_ipsum)
+# => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis mattis semper..."
+
+elipsa(lorem_ipsum, length: 25)
+# => "Lorem ipsum dolor sit..."
+~~~
+
+### Symbol
+
+The `:symbol` parameter is optional and defaults to the three-character
+sequence `...`.
+
+~~~ ruby
+elipsa(lorem_ipsum, length: 20)
+# => "Lorem ipsum..."
+
+elipsa(lorem_ipsum, symbol: '…', length: 20)
+# => "Lorem ipsum dolor…"
+~~~
+
+### Ratio
+
+The `:ratio` parameter is option and defaults to the rational `7/8`. This
+parameter helps elipsa know when to abandon word-boundary splitting and just
+show as much as possible. If `word-split-length`:`desired-length` ratio
+falls below the `:ratio`, word-split is not used.
+
+~~~ ruby
+# without ratio support, too much could get truncated when there is no
+# word boundary near the desired length.
+elipsa("the word is supercalifragilisticexpialidocious", length: 40, ratio: 0)
+# => "the word is..."
+
+elipsa("merge branch feature/ISSUE-12345/fix-important-issue", length: 40)
+# => "the word is supercalifragilisticexpia..."
+~~~
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.verbose = true
+end

data/elipsa.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elipsa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'elipsa'
+  spec.version       = Elipsa::VERSION
+  spec.authors       = ['Ryan Biesemeyer']
+  spec.email         = ['ryan@yaauie.com']
+  spec.summary       = 'Smart string truncation'
+  spec.description   = <<-EODESC
+    Elipsa is a tool for conditionally and smartly truncating a string to a
+    specific length. It pays attention to word-boundaries, and tries to give
+    you as much of the string as it can, while still fitting your parameters.
+  EODESC
+  spec.homepage      = 'https://github.com/yaauie/elipsa'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/lib/elipsa.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'elipsa/version'
+
+module Elipsa
+  extend self
+
+  # @param str [String]
+  # @param options [Hash{Symbol=>Object}]
+  # @option options [Integer] :length (80)
+  #   The maximum length of the result string,
+  #   including an ellipsis if present.
+  # @option options [String] :symbol ('...')
+  #   The string to use as an ellipsis symbol
+  # @option options [Numeric] :ratio (7/8)
+  #   The ratio of available space that the
+  #   resulting string must fill, if truncated.
+  #   This ensures that if a word-boundary is
+  #   not found close enough to your length
+  #   to make the result meaningful, the string
+  #   is broken mid-word instead. 
+  def elipsa(str, options = {})
+    max_length = options.fetch(:length) { 80 }
+    return str if str.length <= max_length
+
+    symbol = options.fetch(:symbol) { '...' }
+    available = max_length - symbol.length
+    ratio = options.fetch(:ratio) { Rational(7, 8) }
+
+    substr = str[/\A(.{0,#{available}})(?=\b\W+)/mu] || ''
+
+    if Rational(substr.length, available) < ratio
+      substr = str[0...available]
+    end
+
+    "#{substr}#{symbol}"
+  end
+
+  # Extend into a String, or
+  # if you're feeling ambitious,
+  # include globally into String
+  module String
+    # Passes self as first argument to Elipsa::elipsa
+    # @see Elipsa::elipsa
+    def elipsa(options = {})
+      Elipsa::elipsa(self, options)
+    end
+  end
+end

data/lib/elipsa/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Elipsa
+  VERSION = '1.0.0'
+end

data/spec/elipsa_spec.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+require 'elipsa'
+
+shared_examples_for :elipsa do
+  subject { return_value }
+  its(:length) { should be <= length }
+  it { should eq expected }
+end
+
+describe Elipsa do
+  context '#elipsa' do
+    let(:length) { 20 }
+    let(:params) { {length: length} }
+    let(:return_value) { Elipsa::elipsa(input, params)}
+
+    context 'a short string' do
+      let(:input) { 'a short string' }
+      let(:expected) { input }
+
+      it_should_behave_like :elipsa
+    end
+
+    context 'word-boundary' do
+      let(:input) { 'a longer string that goes over the limit' }
+      let(:expected) { 'a longer string...' }
+
+      it_should_behave_like :elipsa
+    end
+
+    context 'mid-large-word' do
+      let(:input) { 'supercalifragilisticexpialidocious' }
+      let(:expected) { 'supercalifragilis...' }
+
+      it_should_behave_like :elipsa
+    end
+
+    context 'exact length' do
+      let(:input) { 'at twenty characters' }
+      let(:expected) { input }
+
+      it_should_behave_like :elipsa
+    end
+
+    context 'one less' do
+      let(:input) { 'nineteen characters' }
+      let(:expected) { input }
+
+      it_should_behave_like :elipsa
+    end
+
+    context 'trim punctuation' do
+      let(:input) { 'Let\'s go fly a kite, up to the highest height'  }
+      #                                  ^ this comma should not be included
+      let(:length) { 24 }
+      let(:expected) { 'Let\'s go fly a kite...' }
+
+      it_should_behave_like :elipsa
+    end
+
+    context 'alternate symbol' do
+      before(:each) { params.merge!(symbol: '…') }
+
+      let(:input) { 'lorem ipsum dolor sit' }
+      # with default symbol '...', this would be 'lorem ipsum...'
+      let(:expected) { 'lorem ipsum dolor…' }
+
+      it_should_behave_like :elipsa
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: elipsa
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Biesemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-12-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id004 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.14"
+  type: :development
+  version_requirements: *id003
+description: "    Elipsa is a tool for conditionally and smartly truncating a string to a\n    specific length. It pays attention to word-boundaries, and tries to give\n    you as much of the string as it can, while still fitting your parameters.\n"
+email: 
+- ryan@yaauie.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- elipsa.gemspec
+- lib/elipsa.rb
+- lib/elipsa/version.rb
+- spec/elipsa_spec.rb
+homepage: https://github.com/yaauie/elipsa
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Smart string truncation
+test_files: 
+- spec/elipsa_spec.rb