display_name 0.1.1

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 Javier Martín
+
+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,25 @@
+= display_name
+
+Easily specify which method to use to display an object. It was created to work in Rails models, though it works with any Ruby class.
+
+== Install
+
+    gem install display_name
+
+== Usage
+
+    class Person < ActiveRecord::Base
+      display_name :full_name
+    end
+
+This will generate a method "display_name" for the record, which will return the full name. It will also override the "to_s" method, so in the view you could use:
+
+    <%= person %>
+
+That would automatically display the full name of the person. It also helps populating selects for lists of records.
+
+Note that the display_name can be any method, and not necessary a database column.
+
+== Copyright
+
+Copyright (c) 2010 Javier Martín. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "display_name"
+    gem.summary = %Q{Specify which method to use to display an object}
+    gem.description = %Q{The automatic "to_s" and (for some form builders, for example)
+                       "display_name" methods display useful information about the record,
+                        but not the prettiest one when you want to show it to the end user.
+                        This gem allows you to easily display the object in a pretty way}
+    gem.email = "elretirao@elretirao.net"
+    gem.homepage = "http://github.com/javierv/display_name"
+    gem.authors = ["Javier Martín"]
+    # 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 = "display_name #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/display_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{display_name}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Javier Martín"]
+  s.date = %q{2010-08-09}
+  s.description = %q{The automatic "to_s" and (for some form builders, for example)
+                       "display_name" methods display useful information about the record,
+                        but not the prettiest one when you want to show it to the end user.
+                        This gem allows you to easily display the object in a pretty way}
+  s.email = %q{elretirao@elretirao.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "display_name.gemspec",
+     "lib/display_name.rb",
+     "lib/display_name/active_record.rb",
+     "test/helper.rb",
+     "test/test_display_name.rb"
+  ]
+  s.homepage = %q{http://github.com/javierv/display_name}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Specify which method to use to display an object}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_display_name.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/display_name.rb

@@ -0,0 +1,19 @@
+module DisplayName
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def display_name(method)
+      define_method :display_name do
+        send(method)
+      end
+
+      define_method :to_s do
+        send(method)
+      end
+    end
+  end
+end
+
+require 'display_name/active_record'

data/lib/display_name/active_record.rb

@@ -0,0 +1,2 @@
+require 'active_record'
+ActiveRecord::Base.send :include, DisplayName

data/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 'display_name'
+
+class Test::Unit::TestCase
+end

data/test/test_display_name.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class Person
+  include DisplayName
+  
+  display_name :full_name
+
+  def initialize(name, last_name)
+    @name = name
+    @last_name = last_name
+  end
+
+  def full_name
+    "#{@name} #{@last_name}"
+  end
+end
+
+class DisplayNameTest < Test::Unit::TestCase
+  test 'using display_name method returns the result of the specified method' do
+    @person = Person.new('Juan', 'Olvido')
+    assert_equal @person.display_name, "Juan Olvido"
+  end
+
+  test 'using to_s retuns the result of the specified method' do
+    @person = Person.new('Juan', 'Olvido')
+    assert_equal "Juan Olvido", @person.to_s
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: display_name
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Javier Mart\xC3\xADn"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |-
+  The automatic "to_s" and (for some form builders, for example)
+                         "display_name" methods display useful information about the record,
+                          but not the prettiest one when you want to show it to the end user.
+                          This gem allows you to easily display the object in a pretty way
+email: elretirao@elretirao.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- display_name.gemspec
+- lib/display_name.rb
+- lib/display_name/active_record.rb
+- test/helper.rb
+- test/test_display_name.rb
+has_rdoc: true
+homepage: http://github.com/javierv/display_name
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Specify which method to use to display an object
+test_files: 
+- test/helper.rb
+- test/test_display_name.rb