summarize 1.0.0 → 1.0.1

data/.gitignore

@@ -1,6 +1,7 @@
 Makefile
-lib/ots/ots.bundle
+lib/**/*.bundle
 tmp/*
+doc/*
 *.DS_Store
 coverage/*
 *.swp

data/README.markdown

@@ -1,14 +1,16 @@
-# Summarize
+## Summarize - A Ruby C wrapper for Open Text Summarizer
 
-## A Ruby C wrapper for Open Text Summarizer
+## Installation
 
-## Install
+### Easy
 
-### Manual install
+    gem install summarize
+
+### Manual
 
     git clone https://github.com/ssoper/summarize.git
     cd summarize
-    rake build # install the rake-compiler gem if you dont already have it
+    rake build
     gem build summarize.gemspec
     gem install summarize-1.0.gem
 

data/lib/summarize.rb

@@ -1,6 +1,6 @@
 require 'summarize/summarize'
 
-class Hash
+class Hash #:nodoc:
   def symbolize_keys
     inject({}) do |options, (key, value)|
       options[(key.to_sym rescue key) || key] = value
@@ -10,7 +10,7 @@ class Hash
 end unless {}.respond_to? 'symbolize_keys'
 
 module Summarize
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 
   LANGUAGES = [
     'bg', # Bulgarian
@@ -52,7 +52,7 @@ module Summarize
     'yi'  # Yiddish
   ]
 
-  def self.parse_options(options = {})
+  def self.parse_options(options = {}) #:nodoc:
     default_options = {
       :ratio => 25,     # percentage
       :language => 'en' # ISO 639-1 code
@@ -75,6 +75,18 @@ end
 class String
   extend Summarize
 
+  # Summarizes a string
+  #
+  # == Options:
+  # ratio::
+  #   A Fixnum from 0 to 100
+  #
+  # language::
+  #   An ISO 639-1 language code. See Summarize::LANGUAGES for the supported list.
+  #
+  # == Returns:
+  # A string summary
+  #
   def summarize(options = {})
     dict_file, ratio = Summarize.parse_options(options)
     String.send(:summarize, self, dict_file, ratio)
@@ -84,6 +96,18 @@ end
 
 class File
 
+  # Summarizes the contents of a file
+  #
+  # == Options:
+  # ratio::
+  #   A Fixnum from 0 to 100
+  #
+  # language::
+  #   An ISO 639-1 language code. See Summarize::LANGUAGES for the supported list.
+  #
+  # == Returns:
+  # A string summary
+  #
   def summarize(options = {})
     self.read.summarize(options)
   end

data/summarize.gemspec

@@ -5,17 +5,18 @@ Gem::Specification.new do |s|
   s.name             = %q{summarize}
   s.summary          = %q{Open Text Summarizer}
   s.description      = %q{Ruby C Extension for Open Text Summarizer}
-  s.homepage         = %q{http://github.com/intridea}
+  s.homepage         = %q{http://github.com/ssoper/summarize}
   s.version          = Summarize::VERSION
   s.authors          = ["Sean Soper"]
   s.email            = %q{sean.soper@gmail.com}
 
-  s.rubygems_version = %q{1.3.7}
-  s.date             = %q{2010-11-08}
+  s.rubygems_version  = %q{1.3.7}
+  s.date              = %q{2010-11-30}
+  s.rubyforge_project = "summarize"
 
   s.require_paths = ["lib"]
-  s.extensions = ["ext/summarize/extconf.rb"]
-  s.files      = %x{git ls-files}.split("\n").reject {|file| file =~ /^(features|cucumber)/ }
+  s.extensions    = ["ext/summarize/extconf.rb"]
+  s.files         = %x{git ls-files}.split("\n").reject {|file| file =~ /^(features|cucumber)/ }
 
   s.add_dependency 'rake-compiler'
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: summarize
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Sean Soper
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 -05:00
+date: 2010-11-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -99,11 +97,10 @@ files:
 - ext/summarize/text.c
 - ext/summarize/wordlist.c
 - lib/summarize.rb
-- lib/summarize/summarize.bundle
 - sample_data/jupiter.txt
 - summarize.gemspec
 has_rdoc: true
-homepage: http://github.com/intridea
+homepage: http://github.com/ssoper/summarize
 licenses: []
 
 post_install_message: 
@@ -116,7 +113,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -125,13 +121,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: summarize
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3