summarise 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a17eca01a7ed32cd9f137b142cab4fee60ced64e
-  data.tar.gz: 655fdb30e18235bc103f1497bf87f508c369b983
+  metadata.gz: e6bdc7096f1b34e24a113899bc64c1ba97105154
+  data.tar.gz: 62a9a0c6a55bd88a2f92ca723fd209da364e8aa1
 SHA512:
-  metadata.gz: 77b91fcfa1a2bc27830fa5278d2ea1e73bce820e97ae68f1aaf6197a32fcafc951168432049c7a55d1fa415e4603eb6a8e42c2ef136a111a098fd7b04755d208
-  data.tar.gz: 51990392dbd351d07412316b4f086d66fe335c9e66391e196f9419fe972e42e806a2e3b9f97f8f5a48385592bcf07522ed080aaed84b04a5c4672a80fda1d53e
+  metadata.gz: 2196edf399c99a41371d0b0783915762f45b4b69b0b147b0d17ae4c386be606b2b990663595def20b13010db8382eb0b27cd986663278430bd2a4eb9d44de7e7
+  data.tar.gz: bdb9aeb4e3d93c806ade5800dd9ac73b4d7235bca32d509004b86478ea903844767f806053bdefb5fbe8d4b207fac6965239a9fecb169c52e0abee852f6a3d88

data/README.md

@@ -1,9 +1,13 @@
 # Summarise
 
-Summarise is a small gem which extends String, allowing you to create summaries of strings while respecting word boundaries.
+Summarise is a small gem which extends String, allowing you to create summaries of strings while respecting word boundaries, something I need to do a lot.
 
 ## Usage
 
+The length of the returned string is not guaranteed as it depends on the location of spaces. Simply call summarise on your string to get a version shortened to around 200 characters, or pass in a value to limit to that length instead.
+
+Pass a suffix and shortened strings will have it appended to the end of them.
+
     str = "Summarise is a small gem which extends String, allowing you to create summaries."
 
     str.summarise 25
@@ -15,6 +19,18 @@ Summarise is a small gem which extends String, allowing you to create summaries
     str.summarise 5000, :suffix => "..."
     => "Summarise is a small gem which extends String, allowing you to create summaries."
 
+You can also check if a string is summarisable like so:
+
+    # Default is 200 chars
+    str.summarisable?
+    => false
+
+    str.summarisable? 5000
+    => false
+
+    str.summarisable 30
+    => true
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/summarise/string_extensions.rb

@@ -1,14 +1,14 @@
 
 module Summarise
   module StringExtensions
-  def summarize(l=200, args={})
-    i = 0
-    summary = self.split.map{ |word| word if (i += word.length) < l}.compact.join(' ')
-    if args[:suffix] && self != summary
-      summary << args[:suffix]
+    def summarize(l=200, args={})
+      i = 0
+      summary = self.split.map{ |word| word if (i += word.length) < l}.compact.join(' ')
+      if args[:suffix] && self != summary
+        summary << args[:suffix]
+      end
+      summary
     end
-    summary
-  end
 
     def summarisable?(length=200)
       return self.summarise(length) != self

data/lib/summarise/version.rb

@@ -1,3 +1,3 @@
 module Summarise
-  VERSION = "1.0.1"
-end
+  VERSION = "1.0.2"
+end

data/summarise.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nicholas@forwardadvance.com"]
   spec.description   = %q{Adds a methods to allow you to summarise strings}
   spec.summary       = %q{include the gem and call "abc".summarise}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/forwardadvance/summarise"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: summarise
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Nicholas Johnson
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Adds a methods to allow you to summarise strings
 email:
 - nicholas@forwardadvance.com
@@ -55,7 +69,7 @@ files:
 - lib/summarise/string_extensions.rb
 - lib/summarise/version.rb
 - summarise.gemspec
-homepage: ''
+homepage: https://github.com/forwardadvance/summarise
 licenses:
 - MIT
 metadata: {}