collector 0.0.5 → 0.0.6

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/Gemfile

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 
 group :test do
+  gem "rake",     "~> 0.9.2.2"
   gem "turn",     "~> 0.9.6"
   gem "minitest", "~> 4.1.0"
   gem "mocha",    "~> 0.12.7", require: false

data/README.md

@@ -1,8 +1,9 @@
 # Collector
 
+[![Build Status](https://travis-ci.org/brandonweiss/collector.png)](https://travis-ci.org/brandonweiss/collector)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/brandonweiss/collector)
 
-_Collector isn't ready for use just yet. When it has a basic feature set and is stable I will bump the minor version (to 0.1.0). Until then it's still effectively pre-release._
+_Collector isn't ready for use just yet. And I don't mean it's unstable or alpha, I mean literally it doesn't do anything yet. When the basic feature set is ready I will bump the minor version (to 0.1.0)._
 
 Collector is an implementation of the Repository Pattern for MongoDB. For those new to the Repository Pattern, it is a Facade that isolates the persistence layer from your application. If you're familiar with Rails, or more specifically ActiveRecord or most other ORMs, you'll know that the models and persistence layer are tightly coupled—literally they are the same object. That pattern is a great way to cut your teeth, but ultimately it's a terrible design. Your application does not and should not care about how its data is persisted. Collector will help with that.
 
@@ -22,12 +23,55 @@ Or install it yourself as:
 
 ## Usage
 
-### Configure a connection
+### Configuration
+
+Set up a connection.
 
 ```ruby
 Collector.connection = Mongo::Connection.new
 ```
 
+### Models
+
+Include `Collector::Model` in your domain objects to turn them into models. Create accessors for any attributes.
+
+```ruby
+class Pickle
+
+  include Collector::Model
+
+  attr_accessor :brine, :started_at
+
+end
+```
+
+Models can be instantiated with a hash of attributes.
+
+```ruby
+Pickle.new(brine: "vinegar", started_at: Time.now)
+```
+
+Models automatically create and update timestamps for `created_at` and `updated_at`.
+
+### Repositories
+
+Include `Collector::Repository` in your repository objects to turn them into repositories. Use the same inflection as your model's name (singular).
+
+```ruby
+class PickleRepository
+
+  include Collector::Repository
+
+end
+```
+
+Repositories can save models.
+
+```ruby
+pickle = Pickle.new(brine: "vinegar", started_at: Time.now)
+PickleRepository.save(pickle)
+```
+
 ## Contributing
 
 1. Fork it

data/lib/collector/model.rb

@@ -23,5 +23,11 @@ module Collector
       @updated_at   = Time.now.utc
     end
 
+    def attributes
+      instance_variables.each_with_object({}) do |instance_variable, hash|
+        hash[instance_variable.to_s[1..-1]] = instance_variable_get(instance_variable)
+      end
+    end
+
   end
 end

data/lib/collector/repository.rb

@@ -21,6 +21,20 @@ module Collector
         name.to_s.gsub("Repository", "").constantize
       end
 
+      def save(model)
+        model.touch
+        save_without_updating_timestamps(model)
+      end
+
+      def save_without_updating_timestamps(model)
+        attributes = serialize(model)
+        collection.insert(attributes)
+      end
+
+      def serialize(model)
+        model.attributes.reject { |key, val| val.nil? }
+      end
+
     end
 
   end

data/lib/collector/version.rb

@@ -1,3 +1,3 @@
 module Collector
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/collector/model_spec.rb

@@ -34,8 +34,7 @@ describe Collector::Model do
     test_model.updated_at.must_equal now
   end
 
-  describe "touch" do
-
+  describe "#touch" do
     it "sets the timestamps" do
       Timecop.freeze
 
@@ -60,7 +59,14 @@ describe Collector::Model do
 
       test_model.created_at.must_equal now.utc
     end
+  end
 
+  describe "#attributes" do
+    it "returns a hash of instance variable names and their values" do
+      TestModel.send(:attr_writer, :name)
+      test_model = TestModel.new(name: "Foobar", created_at: 123)
+      test_model.attributes.must_equal({ "name" => "Foobar", "created_at" => 123 })
+    end
   end
 
 end

data/test/collector/repository_spec.rb

@@ -29,4 +29,31 @@ describe Collector::Repository do
     end
   end
 
+  describe "#save" do
+    it "touches the model and then saves it" do
+      model = mock(:touch)
+      TestRepository.expects(:save_without_updating_timestamps).with(model)
+      TestRepository.save(model)
+    end
+  end
+
+  describe "#save_without_updating_timestamps" do
+    it "serializes the model and then inserts it into the collection" do
+      model = stub()
+      TestRepository.expects(:serialize).with(model).returns({ foo: "bar" })
+
+      collection = mock(insert: { foo: "bar" })
+      TestRepository.stubs(:collection).returns(collection)
+
+      TestRepository.save_without_updating_timestamps(model)
+    end
+  end
+
+  describe "#serialize" do
+    it "returns a models attributes without nil values" do
+      model = mock(attributes: { foo: "bar", nothing: nil })
+      TestRepository.serialize(model).must_equal({ foo: "bar" })
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collector
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -35,6 +35,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md