scrutiny 0.0.1

data/README.textile

@@ -0,0 +1,64 @@
+h2. Introduction
+
+Given a string of text, scrutiny adds the ability to ask questions about the format of the string in a more readable way.
+To get started,
+
+bq. @gem install scrutiny@
+
+Then require the gem:
+
+bq. @require 'scrutiny'@
+
+This will make several methods available on the String class:
+* @words@
+* @sentences@
+* @has_at_least@
+* @has_at_most@
+* @has_something@
+* @each_word@
+* @each_sentence@
+
+Perhaps the simplest example is something like:
+
+bq. @"How many words are here?".words => ["How", "many", "words", "are", "here"]@
+
+Similarly, you can parse the sentences as well:
+
+bq. @"Hello. How are you?".sentences => ["Hello.", "How are you?"]@
+
+
+You can also use the @has_at_least@ and @has_at_most@ methods to check if a string fits within some constraints.
+
+bq. @"This sentence is too short.".has_at_least(8.words) => false@
+
+bq. @"This sentence is much too long.".has_at_most(1.word) => false@
+
+bq. @"Perhaps I need to write more here.".has_at_least(5.sentences) => false@
+
+bq. @"This sentence is just right.".has_at_least(1.sentence) => true@
+
+
+h2. LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011
+
+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/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+ 
+GEM = "scrutiny"
+GEM_VERSION = "0.0.1"
+SUMMARY = "Adds methods to String and Integer to check constraints on written text."
+AUTHOR = "Jared Stilwell"
+EMAIL = "jared.k.stilwell@gmail.com"
+HOMEPAGE = "http://uprightnetizen.com/scrutiny-gem"
+ 
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['lib']
+  s.files = FileList['app_generators/**/*', 'bin/*', 'lib/**/*.rb', '[A-Z]*'].to_a
+  
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(-fs --color)
+end
+  
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+ 
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+ 
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/scrutiny.rb

@@ -0,0 +1,63 @@
+class String
+  def words
+    self.scan(/[\w\'\"\-\_\$\#\@\^\&\*\(\)\~\[\]\{\}\<\>\/]+/)
+  end
+  
+  def sentences
+    self.scan(/[\w\'\"\-\_\$\#\@\^\&\*\(\)\~\[\]\{\}\<\>\/][^\.\?\!]*[\.\?\!]/)
+  end
+  
+  def has_at_least(matcher)
+    constraint = matcher.call(self)
+    constraint[:matches].count >= constraint[:limit]
+  end
+  
+  def has_at_most(matcher)
+    constraint = matcher.call(self)
+    constraint[:matches].count <= constraint[:limit]
+  end
+  
+  def has_something_like(regexp)
+    self.scan(regexp).count > 0
+  end
+  
+  def each_word(action, regexp)
+    result = true
+    self.words.each do |word|
+     result = word.method(action).call(regexp) && result 
+    end
+    
+    result
+  end
+  
+  def each_sentence(action, matcher)
+    result = true
+    self.sentences.each do |sentence|
+      result = sentence.method(action).call(matcher) && result
+    end
+    
+    result
+  end
+end
+
+class Integer
+  def word
+    self.words
+  end
+  
+  def words
+    Proc.new do |string|
+      {:limit => self, :matches => string.words}
+    end
+  end
+  
+  def sentence
+    self.sentences
+  end
+  
+  def sentences
+    Proc.new do |string|
+      {:limit => self, :matches => string.sentences}
+    end  
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: scrutiny
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jared Stilwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-14 00:00:00 Z
+dependencies: []
+
+description: 
+email: jared.k.stilwell@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/scrutiny.rb
+- README.textile
+- Rakefile
+homepage: http://uprightnetizen.com/scrutiny-gem
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Adds methods to String and Integer to check constraints on written text.
+test_files: []
+