herd 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Herd Changelog
 
+## v0.0.2
+
+Removes `Herd.load_collections` in favor of using `herded_by Collection`
+in ActiveRecord model
+
 ## v0.0.1
 
 Initial Release

data/README.md

@@ -42,6 +42,8 @@ Using Herd, you can define a separate class to declare collection concerns:
 
 ```ruby
 class Movie < ActiveRecord::Base
+  herded_by Movies
+
   def release_year
     released_at.year
   end
@@ -52,6 +54,8 @@ class Movie < ActiveRecord::Base
 end
 
 class Movies < Herd::Base
+  model Movie # optional
+
   scope :recent, where('released_at > ?', 6.months.ago)
   scope :profitable, where('gross > budget')
 
@@ -75,15 +79,6 @@ 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
@@ -92,13 +87,14 @@ name.
 
 ```ruby
 class Movie < ActiveRecord::Base
+  herded_by Movies
+
   has_and_belongs_to_many :directors
   has_many :characters, :dependent => :destroy
 end
 
 class Movies < Herd::Base
-  # Optional
-  model Movie
+  model Movie # optional
 
   scope :failures, where("revenue < '10000000'")
 
@@ -108,6 +104,21 @@ class Movies < Herd::Base
 end
 ```
 
+Then you can use the collection methods as if they were defined in the
+model class:
+
+```ruby
+Movie.where('released_at < 2012-06-01').failures
+
+Director.first.movies.failures
+```
+
+You can also use the Herd classes directly:
+
+```ruby
+Movies.failures
+```
+
 ## Contributing
 
 1. Fork it

data/lib/herd.rb

@@ -2,12 +2,6 @@ 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
 
@@ -15,10 +9,6 @@ module Herd
     # @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
@@ -56,4 +46,22 @@ module Herd
       end
     end
   end
+
+  module ActiveRecord
+    # Specify the Herd collection class that the model is a member of
+    # @param [Class] herd_collection the Herd class that the model is a member of
+    #
+    # @example
+    #  # ActiveRecord model
+    #  class Movie < ActiveRecord::Base
+    #    herded_by Movies
+    #  end
+    def herded_by(herd_collection)
+      raise ArgumentError, 'collection must inherit from Herd::Base' unless herd_collection.ancestors.include? Herd::Base
+
+      herd_collection
+    end
+  end
 end
+
+ActiveRecord::Base.extend Herd::ActiveRecord

data/lib/herd/version.rb

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

data/spec/herd_spec.rb

@@ -4,7 +4,6 @@ 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
@@ -48,3 +47,9 @@ describe Directors do
     -> { Directors.no_method }.should raise_error(NoMethodError)
   end
 end
+
+describe 'associating model to collection' do
+  it 'should raise an error if the collection is not Herd::Base' do
+    -> { Director.herded_by Director}.should raise_error(ArgumentError)
+  end
+end

data/spec/spec_helper.rb

@@ -34,34 +34,9 @@ ActiveRecord::Schema.define(:version => 1) do
   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
+autoload :Movie, 'support/movie'
+autoload :Movies, 'support/movies'
+autoload :Character, 'support/character'
+autoload :Characters, 'support/characters'
+autoload :Director, 'support/director'
+autoload :Directors, 'support/directors'

data/spec/support/character.rb

@@ -0,0 +1,4 @@
+class Character < ActiveRecord::Base
+  herded_by Characters
+  belongs_to :movie
+end

data/spec/support/characters.rb

@@ -0,0 +1,5 @@
+class Characters < Herd::Base
+  model Character
+
+  scope :fat, where(name: 'chunk')
+end

data/spec/support/director.rb

@@ -0,0 +1,4 @@
+class Director < ActiveRecord::Base
+  herded_by Directors
+  has_and_belongs_to_many :movies
+end

data/spec/support/directors.rb

@@ -0,0 +1,3 @@
+class Directors < Herd::Base
+  model Director
+end

data/spec/support/movie.rb

@@ -0,0 +1,6 @@
+class Movie < ActiveRecord::Base
+  herded_by Movies
+
+  has_and_belongs_to_many :directors
+  has_many :characters, :dependent => :destroy
+end

data/spec/support/movies.rb

@@ -0,0 +1,9 @@
+class Movies < Herd::Base
+  model Movie
+
+  scope :failures, where("revenue < '10000000'")
+
+  def self.directed_by(director)
+    where(directors: {name: director}).joins(:directors)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: herd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,12 @@ files:
 - lib/herd/version.rb
 - spec/herd_spec.rb
 - spec/spec_helper.rb
+- spec/support/character.rb
+- spec/support/characters.rb
+- spec/support/director.rb
+- spec/support/directors.rb
+- spec/support/movie.rb
+- spec/support/movies.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -108,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4311655531898936104
+      hash: 3970260330302346971
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,13 +123,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4311655531898936104
+      hash: 3970260330302346971
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Organize ActiveRecord collection functionality into separate classes
 test_files:
 - spec/herd_spec.rb
 - spec/spec_helper.rb
+- spec/support/character.rb
+- spec/support/characters.rb
+- spec/support/director.rb
+- spec/support/directors.rb
+- spec/support/movie.rb
+- spec/support/movies.rb