collection_extensions 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in collection_extensions.gemspec
+gemspec
+
+group :test do
+  gem "rake", "~> 0.9.2"
+  gem 'rspec', '~> 2.11.0'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Doyle
+
+MIT License
+
+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,57 @@
+# CollectionExtensions
+
+Sometimes an operation just doesn't fit well into a scope, but you don't want to lose your declarative code style
+by operating on all the objects individually. This gem adds a few lines of code to make it easier to add methods to collections of objects.
+
+<img src="https://secure.travis-ci.org/arches/collection_extensions.png" />
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'collection_extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collection_extensions
+
+## Usage
+
+Include the module in your model and specify what collections you want to extend:
+
+    class User < ActiveRecord::Base
+        include CollectionExtensions
+        has_many :orders, :preferences
+        extend_collections :orders, :preferences
+        
+        # the original unextended collection is still available, aliased as orig_* (eg, orig_orders or orig_preferences)
+    end
+
+This will use the modules OrdersCollectionExtensions and PreferencesCollectionExtensions to extend those associations
+whenever you use them. For example:
+
+    module OrdersCollectionExtensions
+      def for_product_id(product_id)
+        # 'self' is the array of orders
+        select {|o| o.line_items.collect(&:product_id).include? product_id}
+      end
+    end
+    
+    > User.find(1).orders.for_product_id(2)
+
+If you want a different naming convention, set the config variable using `%s` string substitution:
+
+    CollectionExtensions::Config.naming_convention = "MethodsForCollectionsOf%s"
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+end
+
+
+task :default => :spec

data/collection_extensions.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/collection_extensions/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Doyle"]
+  gem.email         = ["archslide@gmail.com"]
+  gem.description   = %q{Lightweight framework for adding methods to groups of ActiveRecord objects}
+  gem.summary       = %q{Light-weight framework for adding methods to groups of ActiveRecord objects}
+  gem.homepage      = "http://github.com/arches/collection_extensions"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "collection_extensions"
+  gem.require_paths = ["lib"]
+  gem.version       = CollectionExtensions::VERSION
+end

data/lib/collection_extensions.rb

@@ -0,0 +1,25 @@
+require "collection_extensions/version"
+require "collection_extensions/cattr"
+require "collection_extensions/config"
+
+module CollectionExtensions
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def extend_collections(*associations)
+      Array(associations).each do |association|
+        alias_method "orig_#{association}", association
+
+        define_method association do
+          upper_camel = association.to_s.split("_").collect{|piece| piece.capitalize}.join
+          extender = Object.const_get(CollectionExtensions::Config.naming_convention % upper_camel)
+          send("orig_#{association}").extend(extender)
+        end
+      end
+    end
+  end
+
+end

data/lib/collection_extensions/cattr.rb

@@ -0,0 +1,46 @@
+class Class
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+
+  def cattr_writer(*syms)
+    options = syms.last.is_a?(Hash) ? syms.pop : {}
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        #{"
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+        " unless options[:instance_writer] == false }
+      EOS
+    end
+  end
+
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end

data/lib/collection_extensions/config.rb

@@ -0,0 +1,9 @@
+module CollectionExtensions
+  class Config
+    cattr_accessor :naming_convention
+
+    DEFAULT_NAMING_CONVENTION = "%sCollectionExtensions"
+
+    @@naming_convention = DEFAULT_NAMING_CONVENTION
+  end
+end

data/lib/collection_extensions/version.rb

@@ -0,0 +1,3 @@
+module CollectionExtensions
+  VERSION = "0.0.1"
+end

data/spec/collection_extensions_spec.rb

@@ -0,0 +1,69 @@
+require 'collection_extensions'
+
+module ExamplesCollectionExtensions
+  def operate_on_all_examples
+    "operate_on_all_examples"
+  end
+end
+
+module FoobarsCollectionExtensions
+  def operate_on_all_foobars
+    "operate_on_all_foobars"
+  end
+end
+
+module MethodsForCollectionsOfExamples
+  def operate_on_all_examples
+    "from a module with a different naming convention"
+  end
+end
+
+class CollectionTester
+  include CollectionExtensions
+
+  def examples
+    "original examples method"
+  end
+
+  def foobars
+    "original foobars method"
+  end
+
+  extend_collections :examples, :foobars
+end
+
+describe CollectionExtensions do
+  let(:ct) { CollectionTester.new }
+
+  describe "#extend_collections" do
+    it "aliases the examples" do
+      ct.orig_examples.should == "original examples method"
+      ct.examples.should be_a ExamplesCollectionExtensions
+      ct.examples.operate_on_all_examples.should == "operate_on_all_examples"
+    end
+
+    it "aliases the foobars" do
+      ct.orig_foobars.should == "original foobars method"
+      ct.foobars.should be_a FoobarsCollectionExtensions
+      ct.foobars.operate_on_all_foobars.should == "operate_on_all_foobars"
+    end
+  end
+end
+
+describe "changing the naming convention" do
+  let(:ct) { CollectionTester.new }
+
+  before do
+    CollectionTester::Config.naming_convention = "MethodsForCollectionsOf%s"
+  end
+
+  it "extends the association with the proper module" do
+    ct.orig_examples.should == "original examples method"
+    ct.examples.should be_a MethodsForCollectionsOfExamples
+    ct.examples.operate_on_all_examples.should == "from a module with a different naming convention"
+  end
+end
+
+describe "" do
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: collection_extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies: []
+description: Lightweight framework for adding methods to groups of ActiveRecord objects
+email:
+- archslide@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- collection_extensions.gemspec
+- lib/collection_extensions.rb
+- lib/collection_extensions/cattr.rb
+- lib/collection_extensions/config.rb
+- lib/collection_extensions/version.rb
+- spec/collection_extensions_spec.rb
+homepage: http://github.com/arches/collection_extensions
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Light-weight framework for adding methods to groups of ActiveRecord objects
+test_files:
+- spec/collection_extensions_spec.rb