string_stubber 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1,2 @@
+-cfs
+

data/Gemfile

@@ -2,6 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in string_stubber.gemspec
 gemspec
-
-gem 'lorem'
-

data/Gemfile.lock

@@ -1,16 +1,27 @@
 PATH
   remote: .
   specs:
-    string_stubber (0.0.1)
+    string_stubber (0.0.3)
+      yard (~> 0.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    lorem (0.1.2)
+    diff-lcs (1.1.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    yard (0.6.4)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  lorem
+  rspec (~> 2.4)
   string_stubber!

data/README.md

@@ -35,3 +35,5 @@ So far, so good!  Suggestions are welcome.
 # TODO
 
 stubbing from the right direction is simple to do and will be the next addition.
+  *^* done, needs specs
+left and right indexes

data/lib/string_stubber/base.rb

@@ -1,41 +1,44 @@
 module StringStubber
   module Base
-    WORD = /\b(\w+)\b/
-    SNIP = /\s*?\W+$/
+    WORD = /[\w[:punct:]]+/
+    SNIP = /\s+$/
 
+    # Stubs a given text string, up to a given number of words
+    #   @param [String] text      Any piece of text
+    #   @param [Fixnum] max_words The desired number of words
+    #   @return [String] The text, stubbed at max_words number of words
     def stub_words(text, max_words)
       scanner = StringScanner.new(text.to_s)
 
       return scan_words(scanner, max_words)
     end
 
+    # Stubs the given text string a number of whole-words, not to go beyond the given text position
+    #   @param [String] text      Any piece of text
+    #   @param [Fixnum] max_text  Text position that delimits the desired number of whole words
+    #   @return [String] The text, stubbed at the max_text position
     def stub_text(text, max_text)
-      string  = text.to_s
-      scanner = StringScanner.new(string)
+      scanner = StringScanner.new(text.to_s)
 
       return scan_text(scanner, max_text)
     end
 
     def scan_word(scanner)
-      (str = scanner.scan_until(WORD)).gsub!(SNIP, '')
-
-      return str
+      scanner.scan_until(WORD)
     end
 
     def scan_words(scanner, max_words)
       max_words.times.map {
         scanner.scan_until(WORD)
-      }.flatten.join
+      }.compact.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, '')
+      until scanner.pos >= max_text || scanner.scan_until(WORD).nil?; end
 
-      return str
+      (str = scanner.pre_match || scanner.string[start, max_text]).gsub!(SNIP, '')
     end
   end # module Base
 end # module StringStubber

data/lib/string_stubber/core_ext.rb

@@ -68,7 +68,3 @@ module StringStubber
     end
   end
 end
-
-class String
-  include StringStubber::CoreExt
-end

data/lib/string_stubber/version.rb

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

data/lib/string_stubber.rb

@@ -14,3 +14,7 @@ require 'string_stubber/core_ext'
 module StringStubber
   extend StringStubber::Base
 end
+
+class String
+  include StringStubber::CoreExt
+end

data/spec/quality_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+IGNORE = /\.(gitmodules|png$|tar$|gz$|rbc$|gem$|pdf$)/
+
+describe "The application itself" do
+  it "has no malformed whitespace" do
+    files = `git ls-files`.split("\n").select {|fn| fn !~ IGNORE}
+
+    files.should be_well_formed
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler'
+
+Bundler.require :default
+Bundler.require :development
+
+Dir[ Bundler.root.join("spec/support/**/*.rb") ].each{|f| require f}
+
+RSpec.configure do |c|
+  c.include CustomMatchers
+end

data/spec/string_stubber/base_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe StringStubber::Base do
+  describe 'The Base module should behave like a proper mix-in ;)' do
+    before :each do
+      @methods = [ :stub_words, :stub_text, :scan_word, :scan_words, :scan_text ]
+    end
+
+    it 'should have class methods available' do
+      class TestMixin
+        extend StringStubber::Base
+      end
+
+      @methods.each {|method|
+        TestMixin.respond_to?(method).should  be_true
+      }
+    end
+  end # Should be a Mix-In
+
+  describe 'The stubbing methods should behave as expected (Docs check)' do
+    before :each do
+      @text =  "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Vivamus vitae risus vitae lorem iaculis placerat. "
+      @text << "Aliquam sit amet felis. Etiam congue. Donec risus risus, pretium ac, tincidunt eu, tempor eu, quam. Morbi "
+      @text << "blandit mollis magna. Suspendisse eu tortor. Donec vitae felis nec ligula blandit rhoncus. Ut a pede ac neque "
+      @text << "mattis facilisis. Nulla nunc ipsum, sodales vitae, hendrerit non, imperdiet ac, ante. Morbi sit amet mi. Ut "
+      @text << "magna. Curabitur id est. Nulla velit. Sed consectetuer sodales justo. Aliquam dictum gravida libero. Sed eu "
+      @text << "turpis. Nunc id lorem. Aenean consequat tempor mi. Phasellus in neque. Nunc fermentum convallis ligula."
+
+      @count = @text.split(/\W+/).count
+    end
+
+    describe 'Method: stub_words' do
+      it 'should return the expected number of words' do
+        StringStubber.stub_words(@text, 10).split(/\W+/).count.should  be(10)
+      end
+
+      it 'should always return a string' do
+        stubs = [
+          StringStubber.stub_words(@text,  -100),
+          StringStubber.stub_words(@text,    -1),
+          StringStubber.stub_words(@text,     0),
+          StringStubber.stub_words(@text,    10),
+          StringStubber.stub_words(@text,   100)
+        ]
+
+        stubs.each {|stub|
+          stub.is_a?(String).should be_true
+        }
+      end
+
+      it 'should never have trailing spaces' do
+        @count.times {|x|
+          (StringStubber.stub_words(@text, x) !~ /\s+[\s\W]+$/).should be_true
+        }
+      end
+
+      it 'Should only have trailing non-words if they immediately follow words' do
+        # regex   = /[^\w\s]/
+        # scanner = StringScanner.new(@text)
+        # count   = @text.split(/[^\w\s]/).count
+        # puncts  = Hash[ count.times.map {
+        #                   scanner.scan_until(regex)
+        #                   [scanner.pre_match.split.count, scanner.pos - 1]
+        #                 }
+        #           ]
+        # 
+        # @count.times {|x|
+        #   (StringStubber.stub_words(@text, x) !~ /\s+$/).should be_true
+        # }
+      end
+
+      #
+    end # describe 'Method: stub_words'
+
+    describe 'Method: stub_text' do
+      it 'should return less than the number of chars specified, if the offset is in the middle of a word' do
+        StringStubber.stub_text(@text, 33).size.should be(27)
+      end
+
+      it 'should return less than the number of chars specified, if the offset is in the middle of a word\'s punctuation' do
+        StringStubber.stub_text(@text, 33).size.should be(27)
+      end
+
+      it 'should return exactly the number of chars specified, if the position lands on white-space' do
+      end
+    end # describe 'Method: stub_text'
+  end
+end

data/spec/string_stubber/core_ext_spec.rb

@@ -0,0 +1,2 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+

data/spec/support/custom_matchers.rb

@@ -0,0 +1,44 @@
+module CustomMatchers
+  class BeWellFormed
+    def matches?(files)
+      @errors = files.map {|filename|
+                  [
+                    check_for_tabs(filename),
+                    excessive_spacing(filename),
+                    newline_precedes_eof(filename)
+                  ]
+                }.flatten.compact
+
+      @errors.empty?
+    end
+
+    def failure_message_for_should
+      @errors.join("\n")
+    end
+
+  private
+    def check_for_tabs(filename)
+      bad_lines = File.readlines(filename).each_with_index.map do |line, line_no|
+                    line_no + 1 if line["\t"] and line !~ /^\s+#.*\s+\n$/
+                  end.flatten.compact
+
+      "#{filename} has tab characters on lines #{bad_lines.join(', ')}" if bad_lines.any?
+    end
+
+    def excessive_spacing(filename)
+      bad_lines = File.readlines(filename).each_with_index.map do |line, line_no|
+                    line_no + 1 if line =~ /\s+\n$/ and line !~ /^\s+#.*\s+\n$/
+                  end.flatten.compact
+
+      "#{filename} has spaces on the EOL on lines #{bad_lines.join(', ')}" if bad_lines.any?
+    end
+
+    def newline_precedes_eof(filename)
+      "#{filename} does not have a newline (\\n) before EOF" if File.read(filename) !~ /\n$/
+    end
+  end
+
+  def be_well_formed
+    BeWellFormed.new
+  end
+end

data/string_stubber.gemspec

@@ -14,6 +14,10 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "string_stubber"
 
+  s.add_dependency 'yard', '~>0.6'
+
+  s.add_development_dependency 'rspec', '~>2.4'
+
   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) }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Scott Gonyea
@@ -14,10 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 -08:00
+date: 2011-01-20 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
+  type: :development
+  version_requirements: *id002
 description: StringStubber allows you to truncate Strings, while preserving whole-words.
 email: 
 - me@sgonyea.com
@@ -29,6 +56,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -37,6 +65,11 @@ files:
 - lib/string_stubber/base.rb
 - lib/string_stubber/core_ext.rb
 - lib/string_stubber/version.rb
+- spec/quality_spec.rb
+- spec/spec_helper.rb
+- spec/string_stubber/base_spec.rb
+- spec/string_stubber/core_ext_spec.rb
+- spec/support/custom_matchers.rb
 - string_stubber.gemspec
 has_rdoc: true
 homepage: ""
@@ -70,5 +103,9 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Allows you to truncate Strings, while preserving whole-words.
-test_files: []
-
+test_files: 
+- spec/quality_spec.rb
+- spec/spec_helper.rb
+- spec/string_stubber/base_spec.rb
+- spec/string_stubber/core_ext_spec.rb
+- spec/support/custom_matchers.rb