getter_for 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Martin Linkhorst
+ 
+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.textile

@@ -0,0 +1,61 @@
+h1. Getter For
+
+<pre>
+  gem install getter_for
+</pre>
+
+h2. Setup
+
+image you have a ticket model that belongs to a user. you can add convenience methods for any user attribute like that:
+
+<pre>
+  class Ticket < ActiveRecord::Base
+    belongs_to :user
+    
+    getter_for :user => :name
+  end
+  
+  @ticket = Ticket.new
+  @ticket.user_name      # => @ticket.user.name if @ticket.user
+</pre>
+
+That method returns nil if user is nil, so it can safely used in your views
+
+You can pass multiple key/value pairs separated by comma and provide arrays for both model name and method name. let me show you:
+
+<pre>
+  class Project < ActiveRecord::Base
+    belongs_to :category
+    belongs_to :user
+    belongs_to :assignee, :class_name => 'User'
+    
+    getter_for [:category, :user] =>  :name,
+                :assignee         => [:email, :phone]
+  end
+  
+  @project = Project.new
+  @project.category_name     # => @project.category.name  if @project.category
+  @project.user_name         # => @project.user.name      if @project.user
+  @project.assignee_email    # => @project.assignee.email if @project.assignee
+  @project.assignee_phone    # => @project.assignee.phone if @project.assignee    
+</pre>
+
+you can also make fancy stuff like:
+
+<pre>
+  class User < ActiveRecord::Base
+    belongs_to :department
+    getter_for :department => :name        # => user.department_name
+  end
+  
+  class Comment < ActiveRecord::Base
+    belongs_to :user
+    getter_for :user => :department_name   # => comment.user_department_name
+  end
+  
+  @comment = Comment.new
+  @comment.user_department_name    # => @comment.user.department.name if @comment.user && @comment.user.department
+</pre>
+
+
+Copyright (c) 2009 Martin Linkhorst, released under the MIT license.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec)
+task :default => :spec
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "getter_for"
+    gemspec.summary = "Adds getter methods for attributes that the object belongs to"
+    gemspec.description = "Generates convenience methods especially for use in views like [ticket.user_name] instead of [ticket.user.name if ticket.user]"
+    gemspec.email = "m.linkhorst@googlemail.com"
+    gemspec.homepage = "http://github.com/linki/getter_for"
+    gemspec.authors = ["Martin Linkhorst"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/TODO.textile

@@ -0,0 +1,5 @@
+* Better Nesting
+* Add Setter
+* Setter callback
+* Customized Setter Method (find_by_name!, find_or_initialize_by_name)
+* Setter & Getter generator

data/VERSION

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

data/getter_for.gemspec

@@ -0,0 +1,53 @@
+# 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{getter_for}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Linkhorst"]
+  s.date = %q{2009-12-12}
+  s.description = %q{Generates convenience methods especially for use in views like [ticket.user_name] instead of [ticket.user.name if ticket.user]}
+  s.email = %q{m.linkhorst@googlemail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "TODO.textile",
+     "VERSION",
+     "getter_for.gemspec",
+     "lib/getter_for.rb",
+     "rails/init.rb",
+     "spec/getter_for_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/linki/getter_for}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Adds getter methods for attributes that the object belongs to}
+  s.test_files = [
+    "spec/getter_for_spec.rb",
+     "spec/spec_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
+    else
+    end
+  else
+  end
+end
+

data/lib/getter_for.rb

@@ -0,0 +1,31 @@
+module GetterFor
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def getter_for(arguments)
+      raise ArgumentError unless arguments.kind_of?(Hash)
+      
+      arguments.each do |models, methods|
+        [models, methods].each do |attributes|
+          raise ArgumentError unless [Array, Symbol, String].inject(false) { |bool, klass| bool || attributes.kind_of?(klass) }
+          attributes.kind_of?(Array) && attributes.each do |attribute|
+            raise ArgumentError unless [Symbol, String].inject(false) { |bool, klass| bool || attribute.kind_of?(klass) }
+          end
+        end
+        
+        models  = [models]  unless models.kind_of?(Array)
+        methods = [methods] unless methods.kind_of?(Array)
+        
+        models.each do |model|          
+          methods.each do |method|
+            define_method "#{model}_#{method}" do
+              send(model).send(method) if send(model)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "publishable")
+ActiveRecord::Base.send :include, GetterFor

data/spec/getter_for_spec.rb

@@ -0,0 +1,142 @@
+require File.join(File.dirname(__FILE__), "/spec_helper")
+
+describe GetterFor do
+  describe "getter" do
+    class Ticket
+      include GetterFor
+      getter_for :user => :name
+    end
+
+    it "should respond to :user_name" do
+      ticket = Ticket.new      
+      ticket.should respond_to(:user_name)
+    end
+    
+    it "should return the user's name" do
+      ticket, user = [Ticket, Object].map(&:new)
+      user.expects(:name).returns('Han Solo')
+      ticket.expects(:user).twice.returns(user)
+      ticket.user_name.should == 'Han Solo'      
+    end
+    
+    it "should return nil if user is nil" do
+      ticket = Ticket.new
+      ticket.expects(:user).returns(nil)
+      ticket.user_name.should == nil
+    end
+    
+    it "should raise an error if user does not respond to :name" do
+      ticket, user = [Ticket, Object].map(&:new)
+      ticket.expects(:user).twice.returns(user)
+      lambda {
+        ticket.user_name
+      }.should raise_error(NoMethodError)
+    end
+
+    class Product
+      include GetterFor
+      getter_for 'manufactory' => 'name'
+    end
+
+    it "should accept strings" do
+      product, manufactory = [Product, Object].map(&:new)
+      manufactory.expects(:name).returns('Death Star')
+      product.expects(:manufactory).twice.returns(manufactory)
+      product.manufactory_name.should == 'Death Star'      
+    end
+
+    class Issue
+      include GetterFor
+      getter_for :user => :name, :assignee => :email
+    end
+    
+    it "should take multiple arguments" do
+      issue = Issue.new
+      issue.should respond_to(:user_name)
+      issue.should respond_to(:assignee_email)      
+    end
+
+    class Package
+      include GetterFor
+      getter_for :carrier => [:name, :email]
+      getter_for [:category, :sender] => :name
+      getter_for [:location, :destination] => [:name, :description]
+    end
+
+    it "should accept collection of keys and values" do
+      package = Package.new
+      [:carrier_name, :carrier_email, :category_name, :sender_name,
+       :location_name, :location_description, :destination_name, :destination_description].each do |attribute|
+         package.should respond_to(attribute)
+      end
+    end
+    
+    class Fancy
+      include GetterFor
+      getter_for :user => :name, :user_name => :downcase
+    end
+    
+    it "should work fancy" do
+      fancy, name = [Fancy, Object].map(&:new)
+      name.expects(:downcase).returns('han solo')
+      fancy.expects(:user_name).twice.returns(name)
+      fancy.user_name_downcase.should == 'han solo'      
+    end
+    
+    class User
+      include GetterFor
+      getter_for :department => :name
+    end
+
+    class Comment
+      include GetterFor
+      getter_for :user => :department_name
+    end
+    
+    it "should work nested" do
+      comment, user, department = [Comment, User, Object].map(&:new)
+      department.expects(:name).returns('Development')
+      user.expects(:department).twice.returns(department)
+      comment.expects(:user).twice.returns(user)
+      comment.user_department_name.should == 'Development'      
+    end    
+
+    class Model
+      include GetterFor
+    end
+    
+    it "should respond to :getter_for" do
+      Model.should respond_to(:getter_for)
+    end
+    
+    it "should require a parameter" do
+      lambda { Model.send :getter_for }.should raise_error(ArgumentError)
+    end
+
+    it "should require a hash" do
+      lambda { Model.send :getter_for, [] }.should raise_error(ArgumentError)
+    end
+    
+    it "should have either a symbol or string or an array of symbols or strings as key" do
+      lambda { Model.send :getter_for, {  :attr  => :attr             } }.should_not raise_error(ArgumentError)      
+      lambda { Model.send :getter_for, {  'attr' => :attr             } }.should_not raise_error(ArgumentError)      
+      lambda { Model.send :getter_for, { [:user, 'category'] => :attr } }.should_not raise_error(ArgumentError)      
+    end
+    
+    it "should raise an error if key is not a symbol, string or array of symbols or strings" do
+      lambda { Model.send :getter_for, {         1  => :attr } }.should raise_error(ArgumentError)
+      lambda { Model.send :getter_for, { [:attr, 2] => :attr } }.should raise_error(ArgumentError)
+    end
+    
+    it "should have either a symbol or string or an array of symbols or strings as value" do
+      lambda { Model.send :getter_for, { :attr => 'attr'             } }.should_not raise_error(ArgumentError)      
+      lambda { Model.send :getter_for, { :attr => :attr              } }.should_not raise_error(ArgumentError)      
+      lambda { Model.send :getter_for, { :attr => [:name, 'synomym'] } }.should_not raise_error(ArgumentError)      
+    end
+    
+    it "should raise an error if value is not a symbol, string or array of symbols or strings" do
+      lambda { Model.send :getter_for, { :attr => 1          } }.should raise_error(ArgumentError)
+      lambda { Model.send :getter_for, { :attr => [:attr, 2] } }.should raise_error(ArgumentError)      
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format nested
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'rubygems'
+require 'spec'
+
+# require 'active_record'
+# require 'active_support'
+
+require 'getter_for'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: getter_for
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Martin Linkhorst
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-12 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Generates convenience methods especially for use in views like [ticket.user_name] instead of [ticket.user.name if ticket.user]
+email: m.linkhorst@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- TODO.textile
+- VERSION
+- getter_for.gemspec
+- lib/getter_for.rb
+- rails/init.rb
+- spec/getter_for_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/linki/getter_for
+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: Adds getter methods for attributes that the object belongs to
+test_files: 
+- spec/getter_for_spec.rb
+- spec/spec_helper.rb