mscharkow-textstats 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Scharkow
+
+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.rdoc

@@ -0,0 +1,7 @@
+= textstats
+
+Extends Ruby's String class with some basic text statistics like average word or sentence length, word frequencies and readability indices.
+
+== Copyright
+
+Copyright (c) 2009 Michael Scharkow <michael@underused.org>. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "textstats"
+    gem.summary = %Q{TODO}
+    gem.email = "michael@underused.org"
+    gem.homepage = "http://github.com/underused/textstats"
+    gem.authors = ["Michael Scharkow"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "textstats #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/textstats.rb

@@ -0,0 +1,58 @@
+class String
+  def words
+    scan(/\w[\w\'\-]*/)
+  end
+  
+  def avg_word_length
+    Float(words.collect{|w|w.size}.inject(nil){|sum,x|sum ? sum + x : x})/words.size
+  end
+  
+  def sentences
+    out = scan(/(\.|\?|\!|:)(\s+[A-Z]|$)/).size
+    (out > 0) ? out : 1
+  end
+  
+  def avg_sentence_length
+    Float(words.size/sentences)
+  end
+  
+  def puncts
+    scan(/(\s-\s|,|;|\(|\)|\")/)
+  end
+  
+  def punct_ratio
+    Float(puncts.size)/size
+  end
+  
+  def type_token_ratio(downcase=false)
+    if downcase
+      w = words.map{|w|w.downcase}
+    else
+      w = words
+    end
+    Float(w.uniq.size)/w.size
+  end
+  
+  def word_freqs
+    wl = Hash.new(0)
+    words.each{|w|wl[w] +=1}
+    wl.sort{|a,b| a[1]<=>b[1]}.reverse
+  end
+  
+
+  def long_words(size=6)
+    wl = []
+    words.each{|w|wl << w if w.size >= size}
+    wl
+  end
+  
+  def ari
+    (4.71 * avg_word_length) + (0.5 * avg_sentence_length) - 21.43
+  end
+  
+  def clf
+    (5.89 * avg_word_length) - (0.4 * 100.0/avg_sentence_length) - 15.8
+  end
+  
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'textstats'
+
+class Test::Unit::TestCase
+end

data/test/textstats_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class TextstatsTest < Test::Unit::TestCase
+  def setup
+    @simple = "This is a test text."
+    @apos = "It's meant for testing the github-textstats gem."
+    @punct= "It contains commas, full stops, exclamation; marks and other (special) chars. 
+             Does it? It really does: not!"
+  end
+  
+  should "count words correctly" do
+    assert_equal @simple.words.size, 5
+    assert_equal @apos.words.size, 7 
+  end
+   
+  should "count sentences correctly" do
+    assert_equal @punct.sentences, 3 
+  end
+  
+  should "count special chars correctly" do
+    assert_equal @punct.puncts.size, 5 
+  end
+  
+  should "compute type-token ratio correctly" do
+    assert_equal @simple.type_token_ratio, 1
+    assert_equal @apos.type_token_ratio, @apos.type_token_ratio(true)
+    assert @punct.type_token_ratio > @punct.type_token_ratio(true)
+  end
+  
+  should "count long words correctly" do
+    assert_equal @punct.long_words(6).size, 5 
+  end
+  
+end

data/textstats.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{textstats}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Scharkow"]
+  s.date = %q{2009-07-01}
+  s.email = %q{michael@underused.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/textstats.rb",
+     "test/test_helper.rb",
+     "test/textstats_test.rb",
+     "textstats.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/underused/textstats}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/textstats_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: mscharkow-textstats
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Scharkow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michael@underused.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/textstats.rb
+- test/test_helper.rb
+- test/textstats_test.rb
+- textstats.gemspec
+has_rdoc: true
+homepage: http://github.com/underused/textstats
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/test_helper.rb
+- test/textstats_test.rb