perpetuity 0.6.2 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8013375d75e8b9cdc7a171ff15c51624709b3ba
+  data.tar.gz: 5f2a8546b037800548e2ec5588302552ba09323d
+SHA512:
+  metadata.gz: fbdf6dc761c95fffa557e4a430f0b711cd52bbedf1aecf8e85200d9287bd385f27620c7c61606597dc51044312929d4576ac063a9ecde7c223c087e6b2438851
+  data.tar.gz: 101f30e6be3207d717dc3e0d2cfbbf27b20793fc6550c2bdd2c998cd34175444eb68a3acc54443c35535950709f3a25b28c256bb201809237cd98fa97067c70f

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - 1.9.3
   - rbx-19mode
   - jruby-19mode
-  - ruby-head
   - 2.0.0
 services:
   - mongodb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Version 0.7.0
+
+- Add `Perpetuity::RailsModel`, an ActiveModel-compliant mixin
+- Check Rails app directory for mappers dynamically if the mapper registry is missing a particular model class
+
 ## Version 0.6.2
 
 - Make sure `Retrieval#first` limits the query to a single item

data/README.md

@@ -27,7 +27,10 @@ Perpetuity.data_source :mongodb, 'my_database'
 If your database is on another server or you need authentication, you can specify those as options:
 
 ```ruby
-Perpetuity.data_source :mongodb, 'my_database', host: 'mongo.example.com', port: 27017, username: 'mongo', password: 'password'
+Perpetuity.data_source :mongodb, 'my_database', host: 'mongo.example.com',
+                                                port: 27017,
+                                                username: 'mongo',
+                                                password: 'password'
 ```
 
 ## Setting up object mappers
@@ -210,6 +213,30 @@ Perpetuity[Article].reindex!
 
 You could put this in a rake task to be executed when you deploy your app.
 
+## Rails Integration
+
+Let's face it, most Ruby apps run on Rails, so we need to be able to support it. Beginning with 0.7.0, Perpetuity automatically detects Rails when you configure it and will load Rails support at that point.
+
+### Dynamic mapper reloading
+
+Previous versions of Perpetuity would break when Rails reloaded your models in development mode due to class objects being different. It now reloads mappers dynamically based on whether the class has been reloaded.
+
+In order for this to work, your mapper files need to be named `*_mapper.rb` and be stored anywhere inside your project's `app` directory.
+
+### ActiveModel-compliant API
+
+Perpetuity deals with POROs just fine but Rails does not. This is why you have to include `ActiveModel::Model` in your objects that you want to pass to various Rails methods (such as `redirect_to`, `form_for` and `render`).
+
+In your models, including `ActiveModel::Model` in Rails 4 (or the underlying modules in Rails 3) will give you the API that Rails expects but that won't work with Perpetuity. For example, ActiveModel assumes an `id` method but your model may not provide it, so instead of including ActiveModel we provide a `RailsModel` mixin.
+
+```ruby
+class Person
+  include Perpetuity::RailsModel
+end
+```
+
+This will let Rails know how to talk to your models in the way that Perpetuity handles them.
+
 ## Contributing
 
 There are plenty of opportunities to improve what's here and possibly some design decisions that need some more refinement. You can help. If you have ideas to build on this, send some love in the form of pull requests, issues or [tweets](http://twitter.com/jamie_gaskins) and I'll do what I can for them.

data/lib/perpetuity/mapper_registry.rb

@@ -1,7 +1,9 @@
 module Perpetuity
   class MapperRegistry
+    include Enumerable
+
     def initialize
-      @mappers = Hash.new { |_, klass| raise KeyError, "No mapper for #{klass}" }
+      @mappers = Hash.new
     end
 
     def has_mapper? klass
@@ -9,11 +11,30 @@ module Perpetuity
     end
 
     def [] klass
+      mapper_class = @mappers.fetch(klass) do
+        load_mappers
+        unless @mappers.has_key? klass
+          raise KeyError, "No mapper for #{klass}"
+        end
+      end
+
       @mappers[klass].new(self)
     end
 
     def []= klass, mapper
       @mappers[klass] = mapper
     end
+
+    def each &block
+      @mappers.each &block
+    end
+
+    def load_mappers
+      check_rails_app_for_mappers.each(&method(:load))
+    end
+
+    def check_rails_app_for_mappers
+      Dir['app/**/*_mapper.rb']
+    end
   end
 end

data/lib/perpetuity/rails.rb

@@ -0,0 +1 @@
+require 'perpetuity/rails_model'

data/lib/perpetuity/rails_model.rb

@@ -0,0 +1,41 @@
+module Perpetuity
+  module RailsModel
+    def self.included klass
+      klass.extend ActiveModelish
+    end
+
+    def persisted?
+      defined? @id
+    end
+
+    def to_param
+      @id if persisted?
+    end
+
+    def to_key
+      [to_param] if persisted?
+    end
+
+    module ActiveModelish
+      def model_name
+        self
+      end
+
+      def param_key
+        self.to_s.downcase.gsub('::', '_')
+      end
+
+      def route_key
+        if defined? ActiveSupport::Inflector
+          ActiveSupport::Inflector.pluralize(param_key)
+        else
+          param_key + 's'
+        end
+      end
+
+      def singular_route_key
+        param_key
+      end
+    end
+  end
+end

data/lib/perpetuity/version.rb

@@ -1,3 +1,3 @@
 module Perpetuity
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/perpetuity.rb

@@ -6,6 +6,7 @@ require "perpetuity/mapper_registry"
 
 module Perpetuity
   def self.configure &block
+    detect_rails
     configuration.instance_exec(&block)
   end
   
@@ -32,4 +33,9 @@ module Perpetuity
 
     configure { data_source adapters[adapter].new(options.merge(db: db_name)) }
   end
+
+  # Necessary to be able to check whether Rails is loaded and initialized
+  def self.detect_rails
+    require File.expand_path('../perpetuity/rails.rb', __FILE__) if defined? Rails
+  end
 end

data/perpetuity.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.8.0"
+  s.add_development_dependency "rspec", "~> 2.13"
   s.add_runtime_dependency "moped"
 end

data/spec/perpetuity/mapper_registry_spec.rb

@@ -12,5 +12,23 @@ module Perpetuity
     it 'maps classes to instances of their mappers' do
       registry[Object].should be_a mapper
     end
+
+    it 'raises a KeyError when trying to find a mapper for a missing class' do
+      expect { registry[Class] }.to raise_error KeyError, 'No mapper for Class'
+    end
+
+    describe 'searching for specified mapper when it is not in the registry' do
+      let(:mapper_file) { 'app/mappers/status_mapper.rb' }
+
+      before do
+        stub_const 'Status', Class.new
+      end
+
+      it 'loads the definition for the specified mapper class' do
+        Dir.should_receive(:[]).with('app/**/*_mapper.rb') { [mapper_file] }
+        registry.should_receive(:load).with(mapper_file)
+        registry.load_mappers
+      end
+    end
   end
 end

data/spec/perpetuity/rails_model_spec.rb

@@ -0,0 +1,51 @@
+require 'perpetuity/rails_model'
+
+module Perpetuity
+  describe RailsModel do
+    let(:klass) do
+      Class.new do
+        include Perpetuity::RailsModel
+        attr_accessor :id
+      end
+    end
+    let(:object) { klass.new }
+    let(:wrapper) { object.to_model }
+
+    it 'determines whether it is persisted based on @id ivar' do
+      object.should_not be_persisted
+      object.id = 'lol'
+      object.should be_persisted
+    end
+
+    it 'returns the id as to_param' do
+      object.to_param.should == nil
+      object.id = 'foo'
+      object.to_param.should == 'foo'
+    end
+
+    it 'returns the keys on the object' do
+      object.to_key.should == nil
+      object.id = 'bar'
+      object.to_key.should == ['bar']
+    end
+
+    it 'returns the model name' do
+      klass.model_name.should == klass
+    end
+
+    it 'returns the param_key' do
+      stub_const 'Foo::Bar', klass
+      Foo::Bar.param_key.should == 'foo_bar'
+    end
+
+    it 'returns the route_key' do
+      stub_const 'Foo::Bar', klass
+      Foo::Bar.route_key.should == 'foo_bars'
+    end
+
+    it 'returns the singular_route_key' do
+      stub_const 'Foo::Bar', klass
+      Foo::Bar.singular_route_key.should == 'foo_bar'
+    end
+  end
+end

data/spec/support/stubbed_rails.rb

@@ -0,0 +1,33 @@
+module Rails
+  def self.application
+    @application ||= Application.new
+  end
+
+  class Application
+    def config
+      @config ||= Configuration.new
+    end
+  end
+
+  class Configuration
+    def middleware
+      @middleware ||= MiddlewareStack.new
+    end
+  end
+
+  class MiddlewareStack
+    include Enumerable
+
+    def initialize
+      @stack = []
+    end
+
+    def use klass
+      @stack << klass
+    end
+
+    def each &block
+      @stack.each &block
+    end
+  end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: perpetuity
 version: !ruby/object:Gem::Version
-  version: 0.6.2
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Jamie Gaskins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !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
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: moped
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Persistence layer for Ruby objects
@@ -92,6 +85,8 @@ files:
 - lib/perpetuity/mongodb/query_intersection.rb
 - lib/perpetuity/mongodb/query_union.rb
 - lib/perpetuity/mongodb/serializer.rb
+- lib/perpetuity/rails.rb
+- lib/perpetuity/rails_model.rb
 - lib/perpetuity/reference.rb
 - lib/perpetuity/retrieval.rb
 - lib/perpetuity/validations.rb
@@ -126,6 +121,7 @@ files:
 - spec/perpetuity/mongodb/query_spec.rb
 - spec/perpetuity/mongodb/query_union_spec.rb
 - spec/perpetuity/mongodb/serializer_spec.rb
+- spec/perpetuity/rails_model_spec.rb
 - spec/perpetuity/reference_spec.rb
 - spec/perpetuity/retrieval_spec.rb
 - spec/perpetuity/validations/length_spec.rb
@@ -133,6 +129,7 @@ files:
 - spec/perpetuity/validations_spec.rb
 - spec/perpetuity_spec.rb
 - spec/spec_helper.rb
+- spec/support/stubbed_rails.rb
 - spec/support/test_classes.rb
 - spec/support/test_classes/article.rb
 - spec/support/test_classes/book.rb
@@ -145,27 +142,26 @@ files:
 - spec/support/test_classes/user.rb
 homepage: https://github.com/jgaskins/perpetuity.git
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Persistence library allowing serialization of Ruby objects
 test_files:
 - spec/integration/associations_spec.rb
@@ -194,6 +190,7 @@ test_files:
 - spec/perpetuity/mongodb/query_spec.rb
 - spec/perpetuity/mongodb/query_union_spec.rb
 - spec/perpetuity/mongodb/serializer_spec.rb
+- spec/perpetuity/rails_model_spec.rb
 - spec/perpetuity/reference_spec.rb
 - spec/perpetuity/retrieval_spec.rb
 - spec/perpetuity/validations/length_spec.rb
@@ -201,6 +198,7 @@ test_files:
 - spec/perpetuity/validations_spec.rb
 - spec/perpetuity_spec.rb
 - spec/spec_helper.rb
+- spec/support/stubbed_rails.rb
 - spec/support/test_classes.rb
 - spec/support/test_classes/article.rb
 - spec/support/test_classes/book.rb