string_stubber 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+*.rbc
+*.tmproj
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    string_stubber (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    lorem (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lorem
+  string_stubber!

data/README.md

@@ -0,0 +1,37 @@
+# StringStubber
+
+String Stubber is a simple gem that lets you stub strings, using "words" as the unit of measure.  For example:
+
+        require 'string_stubber'
+        require 'lorem' # Or just add your own text
+
+        str = Lorem::Base.new('paragraphs', 1).output
+        # => "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Vivamus vitae risus ..."
+
+        # Get the first 5 words
+        str.stub_words(5)
+        # => "Lorem ipsum dolor sit amet"
+
+        # Get the NEXT 5 words
+        str.stub_words(5, true)
+        # => ", consectetuer adipiscing elit. Vivamus vitae"
+
+        # Grab the _complete_ words, appearing _up to_ position 20
+        str.stub_to(70)
+        # => "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Vivamus "
+
+        str.stub_to(70).size
+        # => 66
+
+        # Grab the _complete_ words, appearing _through_ position 20
+        str.stub_thru(70)
+        # => "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Vivamus  risus"
+
+        str.stub_thru(70).size
+        # => 72
+
+So far, so good!  Suggestions are welcome.
+
+# TODO
+
+stubbing from the right direction is simple to do and will be the next addition.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :release => :spec
+
+desc "Run Specs"
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = "spec/**/*_spec.rb"
+  spec.verbose    = true
+  spec.rspec_opts = ['--color']
+end
+
+require 'yard'
+
+desc "Generate YARD docs"
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.files += ['lib/**/*.rb']
+end

data/lib/string_stubber/base.rb

@@ -0,0 +1,41 @@
+module StringStubber
+  module Base
+    WORD = /\b(\w+)\b/
+    SNIP = /\s*?\W+$/
+
+    def stub_words(text, max_words)
+      scanner = StringScanner.new(text.to_s)
+
+      return scan_words(scanner, max_words)
+    end
+
+    def stub_text(text, max_text)
+      string  = text.to_s
+      scanner = StringScanner.new(string)
+
+      return scan_text(scanner, max_text)
+    end
+
+    def scan_word(scanner)
+      (str = scanner.scan_until(WORD)).gsub!(SNIP, '')
+
+      return str
+    end
+
+    def scan_words(scanner, max_words)
+      max_words.times.map {
+        scanner.scan_until(WORD)
+      }.flatten.join
+    end
+
+    def scan_text(scanner, max_text)
+      start = scanner.pos
+
+      until scanner.pos > max_text || scanner.scan_until(WORD).nil?; end
+      
+      (str = scanner.pre_match || scanner.string[start, max_text]).gsub!(SNIP, '')
+
+      return str
+    end
+  end # module Base
+end # module StringStubber

data/lib/string_stubber/core_ext.rb

@@ -0,0 +1,74 @@
+module StringStubber
+  module CoreExt
+    include StringStubber::Base
+
+    def scanner
+      @scanner ||= StringScanner.new(self)
+    end
+
+    def stub_words(max_words, save_pos=false)
+      scanner.reset unless save_pos
+
+      if max_words < 0
+        rev_stub_words(max_words.abs, save_pos)
+      else
+        scan_words(scanner, max_words)
+      end
+    end
+    alias :stub   :stub_words
+    alias :words  :stub_words
+
+    def stub_at_most(max_chars, save_pos=true)
+      scanner.reset unless save_pos
+
+      if max_chars < 0
+        rev_stub_at_most(max_chars.abs, save_pos)
+      else
+        scan_text(scanner, max_chars)
+      end
+    end
+    alias :stub_text  :stub_at_most
+    alias :stub_chars :stub_at_most
+    alias :stub_pos   :stub_at_most
+    alias :stub_to    :stub_at_most
+
+    def stub_at_least(min_chars, save_pos=true)
+      scanner.reset unless save_pos
+
+      if min_chars < 0
+        rev_stub_at_least(min_chars.abs, save_pos)
+      else
+        scan_text(scanner, min_chars) << scan_word(scanner).to_s
+      end
+    end
+    alias :stub_thru    :stub_at_least
+    alias :stub_through :stub_at_least
+
+
+  private
+    def rev_stub_words(max_words, save_pos=false)
+      str = self.reverse
+      str.scanner.pos = 0 - scanner.pos if save_pos
+
+      return str.stub_words(max_words, save_pos).reverse!
+    end
+
+    def rev_stub_at_most(max_chars, save_pos=true)
+      str = self.reverse
+      str.scanner.pos = 0 - scanner.pos if save_pos
+
+      return str.stub_at_most(max_chars, save_pos).reverse!
+    end
+
+    def rev_stub_at_least(min_chars, save_pos=true)
+      str = self.reverse
+      str.scanner.pos = 0 - scanner.pos if save_pos
+
+      return str.stub_at_least(min_chars, save_pos).reverse!
+    end
+  end
+end
+
+class String
+  include StringStubber::CoreExt
+end

data/lib/string_stubber/version.rb

@@ -0,0 +1,3 @@
+module StringStubber
+  VERSION = "0.0.2"
+end

data/lib/string_stubber.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'bundler'
+
+Bundler.require
+
+require 'strscan'
+
+require 'string_stubber/base'
+require 'string_stubber/core_ext'
+
+module StringStubber
+  extend StringStubber::Base
+end

data/string_stubber.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "string_stubber/version"
+
+Gem::Specification.new do |s|
+  s.name        = "string_stubber"
+  s.version     = StringStubber::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Gonyea"]
+  s.email       = ["me@sgonyea.com"]
+  s.homepage    = ""
+  s.summary     = %q{Allows you to truncate Strings, while preserving whole-words.}
+  s.description = %q{StringStubber allows you to truncate Strings, while preserving whole-words.}
+
+  s.rubyforge_project = "string_stubber"
+
+  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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: string_stubber
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Scott Gonyea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-19 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: StringStubber allows you to truncate Strings, while preserving whole-words.
+email: 
+- me@sgonyea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/string_stubber.rb
+- lib/string_stubber/base.rb
+- lib/string_stubber/core_ext.rb
+- lib/string_stubber/version.rb
+- string_stubber.gemspec
+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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: string_stubber
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Allows you to truncate Strings, while preserving whole-words.
+test_files: []
+