activerecord_plurals 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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.md

@@ -0,0 +1,36 @@
+# Activerecord Plurals
+A simple rails plugin for batch-retrieving specific fields of activerecord models.
+
+## Installation
+`rails plugin install git://github.com/gurdotan/activerecord_plurals.git`
+
+## Usage
+For example, assume we have a table of animals, assocsiated to the `Animal` ActiveRecord model.  We can do the following:
+
+    >> Animal.names
+    => ["Horse", "Cat", "Dog", "Chimpanzee", "Snake"]
+
+    >> Animal.ids
+    => [1, 2, 3, 4, 5]
+
+    >> Animal.where(:type => "domestic").names
+    => ["Cat", "Dog"]
+
+So in fact this plugin supplies you with plural methods for all activerecord fields.  That includes all of the model's fields, along with `ids`, `created_ats` and `updated_ats`.
+
+### Known Issues
+ * If you have an activerecord model with a field who's plural form collides with an already exsiting method (say 'entry' collides with `Object#entries`), you won't be able to invoke a plural method, the original method will be called.
+
+These issues will be fixed in the next release.
+
+
+### Testing Notes
+ * To run the tests:
+    cd <RAILS_ROOT>/vendor/plugins/activerecord_plurals
+    rake
+ * The tests are written in rspec and make use of a private SQLite3 DB file.  This is why you will need to run `bundle install` in order to run the tests.  Bundler will install the sqlite3-ruby gem which is a dependency of the tests.
+ * Tested only on Rails 3.
+
+Knock yourselves out!
+
+Copyright (c) 2011 Gur Dotan, released under the MIT license.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rake/gempackagetask'
+
+
+desc 'Default: run specs.'
+task :default => :spec
+
+
+desc 'Test the activerecord_plurals plugin.'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-fn", "-c"]
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+ 
+spec = Gem::Specification.new do |s|
+  s.name = "activerecord_plurals"
+  s.version = "0.0.1"
+  s.author = "Gur Dotan"
+  s.email = "gurdotan@gmail.com"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Plural attribute methods: Account.ids, Account.names ..."
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.md"]
+end
+ 
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+

data/activerecord_plurals.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'rake/gempackagetask' 
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+ 
+Gem::Specification.new do |s|
+  s.name        = "activerecord_plurals"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = "Gur Dotan"
+  s.email       = "gurdotan@gmail.com"
+  s.homepage    = "http://github.com/gurdotan/activerecord_plurals"
+  s.summary     = "Plural attribute methods for ActiveRecord"
+  s.description = "Want all the IDs, or names, or whatever field of your ActiveRecord model?  Account.ids, Account.names ..."
+ 
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_development_dependency "rspec"
+ 
+  s.files 	= PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.has_rdoc 	= false
+  s.extra_rdoc_files = ["README.md"]
+end
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/activerecord_plurals.rb

@@ -0,0 +1,59 @@
+class << ActiveRecord::Base
+
+  alias_method :singular_method_missing, :method_missing
+
+  # Define an around alias for method_missing: if the given method call is a plural,
+  # return an array of attribute values for that method in singular form
+  # Otherwise, fallback to the original method missing
+  def method_missing(method_id, *args, &block)
+    singular_method_id = method_id.to_s.singularize.to_sym
+
+    if method_id == singular_method_id
+      singular_method_missing(method_id, *args, &block)
+    else
+      self.select(singular_method_id).map(&singular_method_id)
+    end
+  end
+
+
+  alias_method :singular_respond_to?, :respond_to?
+
+  # Respond to all plurals methods as well
+  def respond_to?(*args)
+    return true if singular_respond_to?(*args)
+    singular_method_id = args[0].to_s.singularize.to_sym
+    instance_methods.include?(singular_method_id)
+  end
+
+end
+
+
+# This monkey-patches the array class to catch plural method calls.
+# It assumes we're running in a rails environment that provides us with
+# String#singularize.
+# The limitation that this method imposes on rails applications is
+# that you cannot have a column with a name that collides with methods
+# defined on Array (or on its ancestor).
+# i.e. if you have a model named "Diary" with the column "entry", calling 
+# Diary.entries will invoke the underlying Object#entries method.  This is 
+# undesired behavior and it is up to the developer to wisely avoid these cases. 
+class Array
+  
+  def method_missing(method_id, *args, &block)
+    singular_method_id = method_id.to_s.singularize.to_sym
+    if method_id != singular_method_id
+      return self.map(&singular_method_id) 
+    end
+    super
+  end
+
+  # Respond also to methods on arrays of ActiveRecord instances.
+  # Note: There is intentionally no restriction on the uniformity of instances in the array,
+  # i.e. they don't have to all be of the same class.  This is useful when you have a mixed array
+  # with objects that share the same attributes (Dog, Labrador < Dog for example) and follows ruby's
+  # duck-typing conventions.
+  def respond_to?(symbol, include_private=false)
+    super or all?{|e| e.is_a?(ActiveRecord::Base) && e.class.respond_to?(symbol)}
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'activerecord_plurals'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord_plurals
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gur Dotan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-11 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Want all the IDs, or names, or whatever field of your ActiveRecord model?  Account.ids, Account.names ...
+email: gurdotan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- uninstall.rb
+- Rakefile
+- README.md
+- activerecord_plurals.gemspec
+- MIT-LICENSE
+- install.rb
+- lib/activerecord_plurals.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/gurdotan/activerecord_plurals
+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: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Plural attribute methods for ActiveRecord
+test_files: []
+