herd 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/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Herd Changelog
+
+## v0.0.1
+
+Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 beerlington
+
+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,117 @@
+# Herd
+
+Organize ActiveRecord collection functionality into manageable classes.
+
+## Requirements
+
+* Ruby >= 1.9.2
+* Rails >= 3.0.0
+
+## What is Herd?
+
+As models grow in size and complexity, it can be challenging to keep
+track of which class methods are for collections and which are not.
+Throw validations, associations, and scopes into the mix, and the model
+can become unwieldy to manage.
+
+Herd provides a way to organize collection related functionality into
+separate, manageable classes.
+
+Take the following ActiveRecord class for example:
+
+```ruby
+class Movie < ActiveRecord::Base
+  scope :recent, where('released_at > ?', 6.months.ago)
+  scope :profitable, where('gross > budget')
+
+  def self.filter_by_title(title)
+    where('title LIKE ?', "%#{title}%")
+  end
+
+  def release_year
+    released_at.year
+  end
+
+  def profitable?
+    gross > budget
+  end
+end
+```
+
+Using Herd, you can define a separate class to declare collection concerns:
+
+```ruby
+class Movie < ActiveRecord::Base
+  def release_year
+    released_at.year
+  end
+
+  def profitable?
+    gross > budget
+  end
+end
+
+class Movies < Herd::Base
+  scope :recent, where('released_at > ?', 6.months.ago)
+  scope :profitable, where('gross > budget')
+
+  def self.filter_by_title(title)
+    where('title LIKE ?', "%#{title}%")
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'herd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install herd
+
+You also need to preload all the Herd collections. The simplest way to
+do this is to add a Rails initializer with the following:
+
+config/initializers/herd.rb
+
+```ruby
+Herd.load_collections
+```
+
+## Usage Example
+
+Using Herd is as easy as inheriting from `Herd::Base`. Declaring the
+model is optional if it can be inferred by the ActiveRecord class
+name.
+
+```ruby
+class Movie < ActiveRecord::Base
+  has_and_belongs_to_many :directors
+  has_many :characters, :dependent => :destroy
+end
+
+class Movies < Herd::Base
+  # Optional
+  model Movie
+
+  scope :failures, where("revenue < '10000000'")
+
+  def self.directed_by(director)
+    where(directors: {name: director}).joins(:directors)
+  end
+end
+```
+
+## 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/herd.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/herd/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Brown"]
+  gem.email         = ["github@lette.us"]
+  gem.description   = %q{Inspired by Backbone.js, this utility lets you define collections for better separation of concerns}
+  gem.summary       = %q{Organize ActiveRecord collection functionality into separate classes}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "herd"
+  gem.require_paths = ["lib"]
+  gem.version       = Herd::VERSION
+
+  gem.add_dependency('rails', '>= 3.0')
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec-rails', '~> 2.10.0')
+  gem.add_development_dependency('sqlite3', '~> 1.3.6')
+
+end

data/lib/herd/version.rb

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

data/lib/herd.rb

@@ -0,0 +1,59 @@
+require "herd/version"
+
+module Herd
+
+  # Load collection classes from a Rails initializer
+  # @param [String] path
+  def self.load_collections(path=Rails.root.join('app/collections'))
+    Dir.glob(File.join(path, '*.rb')).each {|f| require f }
+  end
+
+  class Base
+    class_attribute :model_class
+
+    # Specify the model class that the collection contains
+    # @param [Class] model the class that the collection contains
+    #
+    # @example
+    #  # ActiveRecord model
+    #  class Movie < ActiveRecord::Base
+    #  end
+    #
+    #  # Herd collection
+    #  class Movies < Herd::Base
+    #    model Movie
+    #  end
+    def self.model(model)
+      self.model_class = model
+    end
+
+    # Add all class methods to the model class so that these methods are
+    # available to ActiveRecord::Relation etc
+    def self.inherited(klass)
+      klass.class_eval do
+        def self.singleton_method_added(method_name)
+          return if model_class.nil? || method_name == :model_class
+
+          method = self.method(method_name).to_proc
+          model_class.define_singleton_method(method_name, method)
+        end
+
+        # Set the model class name
+        begin
+          self.model_class = name.singularize.constantize
+        rescue NameError
+        end
+      end
+    end
+
+    # Delegate all methods to the model class if you want to do something like:
+    # Collection.find_by_name('blah')
+    def self.method_missing(method, *args, &block)
+      if model_class.respond_to?(method)
+        model_class.send(method, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/spec/herd_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Movies do
+  let!(:movie1) { Movie.create!(:name => 'The Goonies', :revenue => 100_000_000) }
+  let!(:movie2) { Movie.create!(:name => 'Gigli', :revenue => 0) }
+
+
+  after do
+    Movie.destroy_all
+    Director.destroy_all
+    Character.destroy_all
+  end
+
+  it 'should delegate class methods to model' do
+    Movies.find_by_name('The Goonies').should == movie1
+  end
+
+  it 'should delegate scope method to model' do
+    Movies.failures.should == [movie2]
+  end
+
+  it 'should delegate class methods to active relation class' do
+    chunk = Character.create!(name: 'chunk')
+    movie1.characters << chunk
+
+    movie1.characters.fat.should == [chunk]
+  end
+
+  it 'chain a bunch of stuff together and still work' do
+    chunk = Character.create!(name: 'chunk')
+    rdonner = Director.create!(:name => 'Richard Donner')
+    movie1.characters << chunk
+    movie1.directors << rdonner
+
+    Movies.directed_by('Richard Donner').first.characters.fat.should == [chunk]
+  end
+
+end
+
+describe Directors do
+  it 'should set the model name implicitly from the collection name' do
+    Directors.create!(:name => 'Richard Donner')
+
+    Directors.all.should have(1).director
+  end
+
+  it 'should raise an error if method cannot be found' do
+    -> { Directors.no_method }.should raise_error(NoMethodError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rails/all'
+require 'rspec/rails'
+require 'herd'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.use_transactional_fixtures = true
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :directors, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :directors_movies, :force => true do |t|
+    t.integer :director_id
+    t.integer :movie_id
+  end
+
+  create_table :movies, :force => true do |t|
+    t.string :name
+    t.integer :revenue
+  end
+
+  create_table :characters, :force => true do |t|
+    t.string :name
+    t.integer :movie_id
+  end
+end
+
+class Movie < ActiveRecord::Base
+  has_and_belongs_to_many :directors
+  has_many :characters, :dependent => :destroy
+end
+
+class Movies < Herd::Base
+  model Movie
+
+  scope :failures, where("revenue < '10000000'")
+
+  def self.directed_by(director)
+    where(directors: {name: director}).joins(:directors)
+  end
+end
+
+class Character < ActiveRecord::Base
+  belongs_to :movie
+end
+
+class Characters < Herd::Base
+  model Character
+
+  scope :fat, where(name: 'chunk')
+end
+
+class Director < ActiveRecord::Base
+  has_and_belongs_to_many :movies
+end
+
+class Directors < Herd::Base
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: herd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Inspired by Backbone.js, this utility lets you define collections for
+  better separation of concerns
+email:
+- github@lette.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- herd.gemspec
+- lib/herd.rb
+- lib/herd/version.rb
+- spec/herd_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -4311655531898936104
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4311655531898936104
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Organize ActiveRecord collection functionality into separate classes
+test_files:
+- spec/herd_spec.rb
+- spec/spec_helper.rb