common_name 0.1.4

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 Seamus Abshere
+
+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,171 @@
+=common_name
+
+Stop needing to use humanize/downcase/underscore/pluralize/to_sym/etc to derive a common name.
+
+==Why this is useful
+
+In our app, we have lots of classes that share something (a name) in common:
+
+* <tt>class Automobile < Emitter</tt>
+* <tt>class AutomobilesController < EmittersController</tt>
+* <tt>class AutomobilesComponent < Component</tt>
+* <tt>class AutomobileVersion < EmitterVersion</tt>
+* <tt>Boat</tt> et al., <tt>Flight</tt> et al., etc.
+
+Of course, there are a million ways to derive the word "automobile" from any of these class names. We could fill up our app with humanize/downcase/underscore/pluralize, but we think that's sloppy.
+
+So we use <tt>common_name</tt>:
+
+  >> Automobile.common_name
+  => "automobile"
+  >> Automobile.new.common_name
+  => "automobile"
+  >> AutomobilesController.common_name
+  => "automobile"
+  >> AutomobilesController.new.common_name
+  => "automobile"
+  >> AutomobilesComponent.common_name
+  => "automobile"
+  >> AutomobilesComponent.new.common_name
+  => "automobile"
+  >> AutomobileVersion.common_name
+  => "automobile"
+  >> AutomobileVersion.new.common_name
+  => "automobile"
+
+And when metaprogramming:
+
+  module EmitterVersionExtensions
+    def self.included(klass)
+      klass.class_eval do
+        set_table_name "#{common_name}_versions"        # set_table_name "automobile_versions"
+        belongs_to common_symbol                        # belongs_to :automobile
+        has_one :profile, :through => common_symbol     # has_one :profile, :through => :automobile
+      end
+    end
+  end
+
+We also end up using this constantly in views.
+
+==Quick reference
+
+Here are all the methods it gives you:
+
+  common_name             => "bus_company"
+  common_symbol           => :bus_company
+  common_instance         => "@bus_company"
+  common_title            => "Bus company"
+  common_human            => "bus company"
+  common_camel            => "BusCompany"
+
+  common_plural           => "bus_companies"
+  common_plural_symbol    => :bus_companies
+  common_plural_instance  => "@bus_companies"
+  common_plural_title     => "Bus companies"
+  common_plural_human     => "bus companies"
+  common_plural_camel     => "BusCompanies"
+
+  common_model            => BusCompany [the class]
+
+==Quick start
+
+Put this in <tt>config/environment.rb</tt>
+
+  config.gem 'common_name'
+
+Put this in <tt>config/initializers/common_name.rb</tt>... (it will let you say <tt>BusCompany.common_name</tt> and get the string "bus_company")
+
+  ActiveRecord::Base.class_eval do
+    class << self; def _common_name; name.underscore; end; end
+    include CommonName
+  end
+
+Put this in <tt>app/controllers/application_controller.rb</tt>... (in the CareersController, it will let you say <tt>common_model</tt> and get the class Career)
+
+  class ApplicationController < ActionController::Base
+    class << self; def _common_name; controller_name.singularize; end; end
+    include CommonName
+  end
+
+Put this in <tt>app/helpers/application_helper.rb</tt>... (in careers/show, it will let you say <tt><%= common_plural_title %></tt> and see "Careers")
+
+  module ApplicationHelper
+    CommonName::METHODS.each do |m|
+      eval %{ def common_#{m}; controller.common_#{m}; end }
+    end
+  end
+
+==What it's not
+
+It's <em>not</em> a replacement for <tt>humanize</tt>, <tt>pluralize</tt>, etc.
+
+  >> "bus_company".common_title
+  NoMethodError: undefined method 'common_title' for "bus company":String
+
+The point is to cover common names of classes and their instances.
+
+==Advanced usage
+
+The <tt>_common_name</tt> method should provide an <em>underscored</em> form that will be used to derive other common forms like <tt>common_human</tt> and <tt>common_plural_symbol</tt>.
+
+Note that calling <tt>common_<i>X</i></tt> on a class and on its instances will return the same value.
+
+I also use it on non-ActiveRecord classes:
+
+  class FooBar
+    class << self; def _common_name; name.underscore; end; end
+    include CommonName
+  end
+
+  >> FooBar.common_name
+  => "foo_bar"
+  >> f.common_name         # f = FooBar.new
+  => "foo_bar"
+
+If you define <tt>_common_plural</tt>, it will be the basis for the plural forms:
+
+  class Government
+    class << self
+      def _common_name
+        'government'
+      end
+      def _common_plural
+        'government'
+      end
+    end
+    include CommonName
+  end
+
+That way you can enforce uncountability
+
+  Government.common_name == Government.common_plural
+
+without setting a general rule in the Inflector that the word "government" is uncountable.
+
+==Rationale
+
+I don't like chains of humanize/downcase/underscore/pluralize/to_sym, for example:
+
+  >> BusCompany.name.underscore.humanize.downcase.pluralize
+  => "bus companies"
+
+So I replaced them with easy-to-remember methods like:
+
+  >> BusCompany.common_plural_human
+  => "bus companies"
+
+I also didn't like worrying about .name versus .class.name:
+
+  >> @bus_company.class.name      # @bus_company = BusCompany.new
+  => "BusCompany"
+  >> @bus_company.name
+  => ""
+
+So, the <tt>common_name</tt> of a class (<tt>BusCompany</tt>) is always equivalent to the <tt>common_name</tt> of its instances (<tt>@bus_company</tt>):
+
+  >> BusCompany.common_plural_human == @bus_company.common_plural_human
+  => true
+
+==Copyright
+
+Copyright (c) 2009 Seamus Abshere. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "common_name"
+    gem.summary = %Q{DRY up humanize/downcase/underscore/pluralize/to_sym/etc for names that we use all the time.}
+    gem.description = %Q{Provides methods like User.common_name (#=> "user") and User.common_plural_symbol (#=> :users) so that you don't have to chain humanize/downcase/etc. etc.'}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/common_name"
+    gem.authors = ["Seamus Abshere"]
+    gem.add_dependency 'activesupport'
+    gem.rubyforge_project = "commonname"
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  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')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "common_name #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/common_name.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{common_name}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Seamus Abshere"]
+  s.date = %q{2009-10-30}
+  s.description = %q{Provides methods like User.common_name (#=> "user") and User.common_plural_symbol (#=> :users) so that you don't have to chain humanize/downcase/etc. etc.'}
+  s.email = %q{seamus@abshere.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "common_name.gemspec",
+     "lib/common_name.rb",
+     "test/common_name_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/seamusabshere/common_name}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{commonname}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{DRY up humanize/downcase/underscore/pluralize/to_sym/etc for names that we use all the time.}
+  s.test_files = [
+    "test/common_name_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/lib/common_name.rb

@@ -0,0 +1,86 @@
+# This library comes out of my frustration with seeing lines like
+# 
+#   BusCompany.name.underscore.humanize.downcase.pluralize #=> "bus companies"
+# 
+# all over my application.
+# 
+# See <tt>README</tt> for more information.
+# 
+# Copyright (c) 2009 Seamus Abshere. See LICENSE for details.
+
+require 'rubygems'
+require 'activesupport'
+
+module CommonName
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+  
+  METHODS = %w{
+    name   symbol        instance        title        human        camel
+    plural plural_symbol plural_instance plural_title plural_human plural_camel
+    model
+  }
+  
+  # delegate instance methods to class methods
+  METHODS.each do |m|
+    eval %{ def common_#{m}; self.class.common_#{m}; end }
+  end
+  
+  module ClassMethods
+    # "bus_company"
+    #
+    # Identical to <tt>_common_name</tt>, which you have to provide.
+    def common_name;              _COMMON_NAME            ||= _common_name;                                                             end
+
+    # :bus_company
+    def common_symbol;            _COMMON_SYMBOL          ||= common_name.to_sym;                                                       end
+    
+    # "@bus_company"
+    #
+    # For use with <tt>instance_variable_get</tt>, etc.
+    def common_instance;          _COMMON_INSTANCE        ||= '@' << common_name;                                                       end
+    
+    # "Bus company"
+    #
+    # Microsoft titlecase.
+    def common_title;             _COMMON_TITLE           ||= common_name.humanize;                                                     end
+    
+    # "bus company"
+    #
+    # Unlike <tt>humanize</tt>, this is lowercase.
+    def common_human;             _COMMON_HUMAN           ||= common_title.downcase;                                                    end
+    
+    # "BusCompany"
+    def common_camel;             _COMMON_CAMEL           ||= common_name.camelcase;                                                    end
+    
+    # BusCompany
+    #
+    # Already constantized.
+    def common_model;             _COMMON_MODEL           ||= common_camel.constantize;                                                 end
+
+    # "bus_companies"
+    #
+    # Derived from _common_name, unless you provide _common_plural.
+    def common_plural;            _COMMON_PLURAL          ||= (respond_to?(:_common_plural) ? _common_plural : common_name.pluralize);  end
+    
+    # :bus_companies
+    def common_plural_symbol;     _COMMON_PLURAL_SYMBOL   ||= common_plural.to_sym;                                                     end
+    
+    # "@bus_companies"
+    def common_plural_instance;   _COMMON_PLURAL_INSTANCE ||= '@' << common_plural;                                                     end
+    
+    # "Bus companies"
+    #
+    # See +common_title+ for notes on capitalization.
+    def common_plural_title;      _COMMON_PLURAL_TITLE    ||= common_plural.humanize;                                                   end
+    
+    # "bus companies"
+    #
+    # See +common_human+ for notes on capitalization.
+    def common_plural_human;      _COMMON_PLURAL_HUMAN    ||= common_plural_title.downcase;                                             end
+    
+    # "BusCompanies"
+    def common_plural_camel;      _COMMON_PLURAL_CAMEL    ||= common_plural.camelcase;                                                  end
+  end
+end

data/test/common_name_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+# a pretty normal class
+class BusCompany
+  def self._common_name
+    name.underscore
+  end
+  include CommonName
+end
+
+# a class where you always want to chop off the _component part and singularize
+class Component
+  def self._common_name
+    name.underscore.gsub('_component', '').singularize
+  end
+  include CommonName
+end
+class AutomobilesComponent < Component; end
+class GovernmentComponent < Component
+  def self._common_plural
+    'government'
+  end
+end
+
+class CommonNameTest < Test::Unit::TestCase
+  should "have required API method" do
+    assert BusCompany.respond_to?(:_common_name)
+    assert Component.respond_to?(:_common_name)
+  end
+  
+  should "have optional API method" do
+    assert !Component.respond_to?(:_common_plural)
+    assert GovernmentComponent.respond_to?(:_common_plural)
+  end
+  
+  should "have underscored common name" do
+    assert !BusCompany._common_name.include?(' ')
+    assert !Component._common_name.include?(' ')
+  end
+  
+  {
+    :common_name             => "bus_company",
+    :common_symbol           => :bus_company,
+    :common_instance         => "@bus_company",
+    :common_title            => "Bus company",
+    :common_human            => "bus company",
+    :common_camel            => "BusCompany",
+    :common_plural           => "bus_companies",
+    :common_plural_symbol    => :bus_companies,
+    :common_plural_instance  => "@bus_companies",
+    :common_plural_title     => "Bus companies",
+    :common_plural_human     => "bus companies",
+    :common_plural_camel     => "BusCompanies",
+    :common_model            => BusCompany
+  }.each do |method, result|
+    should "have #{method} at the class level" do
+      assert_equal result, BusCompany.send(method)
+    end
+    
+    should "have #{method} at the instance level" do
+      assert_equal result, BusCompany.send(method)
+    end
+  end
+  
+  should "have common name at the class level" do
+    assert_equal "component",   Component.common_name
+    assert_equal "automobile",  AutomobilesComponent.common_name
+    assert_equal "government",  GovernmentComponent.common_name
+  end
+  
+  should "have common name at the instance level" do
+    assert_equal "component",   Component.new.common_name
+    assert_equal "automobile",  AutomobilesComponent.new.common_name
+    assert_equal "government",  GovernmentComponent.new.common_name
+  end
+  
+  should "have common plural at the class level" do
+    assert_equal "components",  Component.common_plural
+    assert_equal "automobiles", AutomobilesComponent.common_plural
+    assert_equal "government",  GovernmentComponent.common_plural # uncountable
+  end
+  
+  should "have common plural at the instance level" do
+    assert_equal "components",  Component.new.common_plural
+    assert_equal "automobiles", AutomobilesComponent.new.common_plural
+    assert_equal "government",  GovernmentComponent.new.common_plural # uncountable
+  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 'common_name'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: common_name
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides methods like User.common_name (#=> "user") and User.common_plural_symbol (#=> :users) so that you don't have to chain humanize/downcase/etc. etc.'
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- common_name.gemspec
+- lib/common_name.rb
+- test/common_name_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/common_name
+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: commonname
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: DRY up humanize/downcase/underscore/pluralize/to_sym/etc for names that we use all the time.
+test_files: 
+- test/common_name_test.rb
+- test/test_helper.rb