indefinite_article 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Rossmeissl
+
+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,18 @@
+= indefinite_article
+
+Adds indefinite article methods to String and Symbol so that you can do:
+
+  >> 'apple'.indefinite_article
+  => 'an'
+  >> 'banana'.with_indefinite_article
+  => 'a banana'
+  
+== Installation
+
+The gem is hosted at http://gemcutter.org/gems/indefinite_article
+
+  gem install indefinite_article
+  
+== Copyright
+
+Copyright (c) 2010 Andy Rossmeissl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "indefinite_article"
+    gem.summary = %Q{Indefinite articles for stringlike classes in Ruby}
+    gem.description = %Q{Adds indefinite article ('a' vs. 'an') methods to String and Symbol}
+    gem.email = "andy@rossmeissl.net"
+    gem.homepage = "http://github.com/rossmeissl/indefinite_article"
+    gem.authors = ["Andy Rossmeissl"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "indefinite_article #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/indefinite_article.rb

@@ -0,0 +1,8 @@
+require 'indefinite_article/articulated'
+require 'activesupport'
+
+module IndefiniteArticle
+  WORDS_WITH_INITIAL_VOWELS_THAT_ACT_LIKE_WORDS_WITH_INITIAL_CONSONANTS = %w(one united)
+  INDEFINITE_ARTICLES = { :vowel => 'an', :consonant => 'a'}
+  VOWELS = %w(a e i o u)
+end

data/lib/indefinite_article/articulated.rb

@@ -0,0 +1,33 @@
+module IndefiniteArticle
+  module Articulated
+    def indefinite_article
+      if ::IndefiniteArticle::WORDS_WITH_INITIAL_VOWELS_THAT_ACT_LIKE_WORDS_WITH_INITIAL_CONSONANTS.include? to_s._first_word_for_indefinite_article._first_term_for_indefinite_article.downcase
+        ::IndefiniteArticle::INDEFINITE_ARTICLES[:consonant]
+      elsif VOWELS.include? to_s.first.downcase
+        ::IndefiniteArticle::INDEFINITE_ARTICLES[:vowel]
+      else
+        ::IndefiniteArticle::INDEFINITE_ARTICLES[:consonant]
+      end
+    end
+  
+    def with_indefinite_article(upcase = false)
+      "#{upcase ? indefinite_article.humanize : indefinite_article}#{ ' ' unless self.blank? }#{self}"
+    end
+
+    def _first_word_for_indefinite_article
+      split(' ').first
+    end
+    
+    def _first_term_for_indefinite_article
+      split('-').first
+    end
+  end
+end
+
+class String
+  include ::IndefiniteArticle::Articulated
+end
+
+class Symbol
+  include ::IndefiniteArticle::Articulated
+end

data/test/helper.rb

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

data/test/test_indefinite_article.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class TestIndefiniteArticle < Test::Unit::TestCase
+  def setup
+  end
+  
+  def test_indefinite_article_selection
+    assert_equal 'a', 'banana'.indefinite_article
+    assert_equal 'an', 'apple'.indefinite_article
+  end
+  
+  def test_unusual_article_selection
+    assert_equal 'a', 'one'.indefinite_article
+  end
+  
+  def test_functionality_on_symbol
+    assert_equal 'a', :banana.indefinite_article
+  end
+  
+  def test_indefinite_article_prefix
+    assert_equal 'a banana', 'banana'.with_indefinite_article
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: indefinite_article
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andy Rossmeissl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-05 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Adds indefinite article ('a' vs. 'an') methods to String and Symbol
+email: andy@rossmeissl.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/indefinite_article.rb
+- lib/indefinite_article/articulated.rb
+- test/helper.rb
+- test/test_indefinite_article.rb
+has_rdoc: true
+homepage: http://github.com/rossmeissl/indefinite_article
+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: 3
+summary: Indefinite articles for stringlike classes in Ruby
+test_files: 
+- test/helper.rb
+- test/test_indefinite_article.rb