praxis-mapper 4.1.2 → 4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a54434e8e0f9299b8ae645f800e93ebbc1b0fae
-  data.tar.gz: 78806cff2fdeda7b7375f8ccc1a68f26addddbfb
+  metadata.gz: 3ff56d63e3412602d1542aefa5a0ddeb2c6f053d
+  data.tar.gz: e55ac6835ca3be6495ccb699e72197502812664f
 SHA512:
-  metadata.gz: 668be9af356c5099402fdcfb46533004c5a3cc629085235417e73bdd8688ca061c1c440686aabd515fbe05f82a7acb879770f43037fb6ee9955caf7620d8ed11
-  data.tar.gz: 96effa292125c2d3f3ce5d20eba3f338cf7ef0c4d8c7486c62054626e4840162080a9975942d8fef5989fd19065c4a060c97397b7bcaaf404c606a3f50f65601
+  metadata.gz: 54bb23566ca0385a869114087e2fd91420f3e1b7e5ce890672dbbdb649d4d0fe7f63bf5b947e4d7c2af781996363d185e3ee0de160836e70d265bdd4b6a8673e
+  data.tar.gz: 088259294b44ba826033c1a39e279899be35f0c482827f0cc6deac8aa3282dd6323160ff0877b68d15b2a7ebe92e3df8c38ffc985ad050de775daee9b4388ba4

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 ## next
 
+## 4.2
+
+* Added `Resource.property` to specify the fields and associations from the
+  underlying model that are needed by methods added to the `Resource`.
+    * For example:
+      * `property :full_name, dependencies: [:first, :last]` specifies that the `full_name` method on the resource depends upon the values of the `first`
+      and `last` fields from the model.
+      * `property :owner_name, dependencies: ['owner.first', 'owner.last']`
+      defines a dependency on the `first` and `last` fields from the associated
+      `owner`.
+    * Dependencies must always be an array. Symbol values should be used for
+    fields or associations from the same resource, and strings can be used
+    for fields from associated resources.
+    * `:*` or `'association.*'` may be used to specify a
+    dependency on all of the fields of the resource (analagous to 'SELECT *').
+    * Additionally, property dependencies may specify other properties on the
+    same or related resources.
+* Added `IdentityMap#add_selectors(resource, field_selector)` to define fields to
+  `select` and associations to `track` given `resource` and `field_selectors`.
+    * For example:
+      * `identity_map#add_selectors(PersonResource, full_name: true)` would
+      ensure any loads done for the model the `PersonResource` describes will
+      select any fields required by the `full_name` property (`first` and `last`
+      in the example above).
+      * `identity_map#add_selectors(PersonResource, id: true, address: true)`
+      could result in selecting the `id` and `address_id` fields of `PersonModel`,
+      as well as tracking the `address` association, for any queries involving
+      `PersonModel`.
+* Added the ability to explicitly perform a "SELECT *" by specifying `select :*`
+  or `select '*'` in a query.
+* Added `:through` option to many_to_many associations to define the series of
+  associations necessary to resolve it. This is unused by Sequel, but is required
+  by the SelectorGenerator to handle such associations. Specify it as an array
+  of symbols.
+  * For example: `many_to_many :commented_posts, through: [:comments, :post], ...`
+
 ## 4.1.2
 
 * Remove finalizer from IdentityMap to fix memory leak that was preventing them from being GC'd properly.

data/README.md

@@ -1,7 +1,11 @@
-# Praxis::Mapper [![TravisCI][travis-img-url]][travis-ci-url] 
+# Praxis::Mapper [![TravisCI][travis-img-url]][travis-ci-url] [![Coverage Status][coveralls-img-url]][coveralls-url] [![Dependency Status][gemnasium-img-url]][gemnasium-url]
 
 [travis-img-url]:https://travis-ci.org/rightscale/praxis-mapper.svg?branch=master
 [travis-ci-url]:https://travis-ci.org/rightscale/praxis-mapper
+[coveralls-img-url]:https://coveralls.io/repos/rightscale/praxis-mapper/badge.svg?branch=master&service=github
+[coveralls-url]:https://coveralls.io/github/rightscale/praxis-mapper?branch=master
+[gemnasium-img-url]:https://gemnasium.com/rightscale/praxis-mapper.svg
+[gemnasium-url]:https://gemnasium.com/rightscale/praxis-mapper
 
 
 Praxis::Mapper is a library that allows for large amounts of data to be loaded for a tree of associated models,
@@ -20,4 +24,4 @@ To run unit tests:
 
 This software is released under the [MIT License](http://www.opensource.org/licenses/MIT). Please see  [LICENSE](LICENSE) for further details.
 
-Copyright (c) 2014 RightScale
+Copyright (c) 2014 RightScale

data/lib/praxis-mapper.rb

@@ -51,7 +51,7 @@ require 'praxis-mapper/identity_map'
 require 'praxis-mapper/model'
 require 'praxis-mapper/query_statistics'
 
-require 'praxis-mapper/sequel_compat' 
+require 'praxis-mapper/sequel_compat'
 
 require 'praxis-mapper/connection_manager'
 
@@ -64,5 +64,6 @@ require 'praxis-mapper/query/base'
 require 'praxis-mapper/query/sql'
 require 'praxis-mapper/query/sequel'
 
-
 require 'praxis-mapper/config_hash'
+
+require 'praxis-mapper/selector_generator'

data/lib/praxis-mapper/identity_map.rb

@@ -10,7 +10,10 @@ module Praxis::Mapper
     class UnsupportedModel < StandardError; end;
     class UnknownIdentity < StandardError; end;
 
-    attr_reader :unloaded, :queries, :blueprint_cache
+    attr_reader :unloaded
+    attr_reader :queries
+    attr_reader :blueprint_cache
+
     attr_accessor :scope
 
     class << self
@@ -69,9 +72,14 @@ module Praxis::Mapper
     def initialize(scope={})
       @connection_manager = ConnectionManager.new
       @scope = scope
+      @selector_generator = Praxis::Mapper::SelectorGenerator.new
       clear!
     end
 
+    def selectors
+      @selector_generator.selectors
+    end
+
     def clear!
       @rows = Hash.new { |h,k| h[k] = Array.new }
 
@@ -315,7 +323,6 @@ module Praxis::Mapper
       @row_keys[model][key].fetch(value) do
         raise UnloadedRecordException, "Did not load #{model} with #{key} = #{value.inspect}."
       end
-
     end
 
 
@@ -368,12 +375,12 @@ module Praxis::Mapper
         end
       else
         if @row_keys[model].has_key?(key)
-          values.collect do |value|
-            @row_keys[model][key][value]
+          values.collect do |v|
+            @row_keys[model][key][v]
           end.compact
         else
-          values.each_with_object(Array.new) do |value, results|
-            results.push *index(model, key, value)
+          values.each_with_object(Array.new) do |v, results|
+            results.push(*index(model, key, v))
           end
         end
       end
@@ -477,8 +484,6 @@ module Praxis::Mapper
         end
       end
 
-      model = records.first.class
-
       tracked_associations = if (query = records.first._query)
         query.tracked_associations.each do |tracked_association|
           associated_model = tracked_association[:model]
@@ -490,7 +495,6 @@ module Praxis::Mapper
 
       tracked_associations.each do |tracked_association|
         associated_model = tracked_association[:model]
-        association_type = tracked_association[:type]
 
         association_key, row_keys = stage_for!(tracked_association, records)
         row_keys.each do |row_key|
@@ -549,5 +553,9 @@ module Praxis::Mapper
       QueryStatistics.new(queries)
     end
 
+    def add_selectors(resource, fields)
+      @selector_generator.add(resource, fields)
+    end
+
   end
 end

data/lib/praxis-mapper/query/base.rb

@@ -18,6 +18,7 @@ module Praxis::Mapper
       # @param model [Praxis::Mapper::Model] handle to a Praxis::Mapper model
       # @param &block [Block] will be instance_eval'ed here
       def initialize(identity_map, model, &block)
+
         @identity_map = identity_map
         @model = model
 
@@ -32,9 +33,24 @@ module Praxis::Mapper
 
         @statistics = Hash.new(0) # general-purpose hash
 
+        if (selector = identity_map.selectors[model])
+          self.apply_selector(selector)
+        end
+
         if block_given?
           self.instance_eval(&block)
         end
+
+      end
+
+      def apply_selector(selector)
+        if selector[:select]
+          self.select(*selector[:select])
+        end
+
+        if selector[:track]
+          self.track(*selector[:track])
+        end
       end
 
       # @return handle to configured data store
@@ -51,11 +67,20 @@ module Praxis::Mapper
       # @example select(:account_id, "user_id", {"create_time" => :created_at})
       def select(*fields)
         if fields.any?
-          @select = {} if @select.nil?
+          return @select if @select == true
+
+          if @select.nil?
+            @select = default_select
+          end
           fields.each do |field|
             case field
             when Symbol, String
-              @select[field] = nil
+              if field == :* || field == "*"
+                @select = true
+                break
+              else
+                @select[field] = nil
+              end
             when Hash
               field.each do |alias_name, column_name|
                 @select[alias_name] = column_name
@@ -69,6 +94,11 @@ module Praxis::Mapper
         end
       end
 
+      def default_select
+        model.identities.each_with_object({}).each do |identity, hash|
+          hash[identity] = nil
+        end
+      end
 
       # Gets or sets an SQL-like 'WHERE' clause to this query.
       #
@@ -130,8 +160,8 @@ module Praxis::Mapper
           raise "context #{name.inspect} not found for #{model}"
         end
 
-        select *spec[:select]
-        track *spec[:track]
+        select(*spec[:select])
+        track(*spec[:track])
       end
 
 
@@ -161,7 +191,7 @@ module Praxis::Mapper
         rows = []
 
         original_select = @select
-        self.select *select.flatten.uniq if select
+        self.select(*select.flatten.uniq) if select
 
         values.each_slice(MULTI_GET_BATCH_SIZE) do |batch|
           rows += _multi_get(identity, batch)

data/lib/praxis-mapper/query/sequel.rb

@@ -15,7 +15,7 @@ module Praxis::Mapper
         ds = connection[model.table_name.to_sym]
 
         # TODO: support column aliases
-        if @select
+        if @select && @select != true
           ds = ds.select(*@select.keys)
         end
 

data/lib/praxis-mapper/query/sql.rb

@@ -110,7 +110,7 @@ module Praxis::Mapper
       # @return [String] SQL 'SELECT' clause
       def select_clause
         columns = []
-        if select
+        if select && select != true
           select.each do |alias_name, column_name|
             if column_name
               # alias_name is always a String, not a Symbol

data/lib/praxis-mapper/resource.rb

@@ -29,9 +29,12 @@ module Praxis::Mapper
 
     attr_accessor :record
 
+    @properties = {}
+
     class << self
       attr_reader :model_map
       attr_reader :decorations
+      attr_reader :properties
     end
 
     # TODO: also support an attribute of sorts on the versioned resource module. ie, V1::Resources.api_version.
@@ -46,10 +49,11 @@ module Praxis::Mapper
         if self.superclass == Praxis::Mapper::Resource
           @model_map = Hash.new
         else
-          @model_map = self.superclass.model_map 
+          @model_map = self.superclass.model_map
         end
 
         @decorations = {}
+        @properties = self.superclass.properties.clone
       end
 
     end
@@ -69,6 +73,10 @@ module Praxis::Mapper
       self.decorations[name] = Class.new(ResourceDecorator, &block)
     end
 
+    def self.property(name, **options)
+      self.properties[name] = options
+    end
+
     def self._finalize!
       finalize_resource_delegates
       define_model_accessors
@@ -108,10 +116,10 @@ module Praxis::Mapper
 
     def self.define_decorator(name, block)
       unless self.instance_methods.include?(name)
-        # assume it'll be a regular accessor and create it 
+        # assume it'll be a regular accessor and create it
         self.define_accessor(name)
       end
-      # alias original method and wrap it 
+      # alias original method and wrap it
       raw_name = "_raw_#{name}"
       alias_method(raw_name.to_sym, name)
 
@@ -137,17 +145,16 @@ module Praxis::Mapper
     end
 
 
-  def self.wrap(records)
-    case records
-    when nil
-      return []
-    when Enumerable
-      return records.compact.collect { |record| self.for_record(record) }
-    else
-      return self.for_record(records)
+    def self.wrap(records)
+      case records
+      when nil
+        return []
+      when Enumerable
+        return records.compact.collect { |record| self.for_record(record) }
+      else
+        return self.for_record(records)
+      end
     end
-  end
-
 
 
     def self.get(condition)

data/lib/praxis-mapper/selector_generator.rb

@@ -0,0 +1,98 @@
+module Praxis::Mapper
+  # Generates a set of selectors given a resource and
+  # list of resource attributes.
+  class SelectorGenerator
+    attr_reader :selectors
+
+    def initialize
+      @selectors = Hash.new do |hash, key|
+        hash[key] = {select: Set.new, track: Set.new}
+      end
+    end
+
+    def add(resource, fields)
+      fields.each do |name, field|
+        map_property(resource, name, field)
+      end
+    end
+
+    def select_all(resource)
+      selectors[resource.model][:select] = true
+    end
+
+    def map_property(resource, name, field)
+      if resource.properties.key?(name)
+        add_property(resource, name)
+      elsif resource.model.associations.key?(name)
+        add_association(resource, name, field)
+      else
+        add_select(resource, name)
+      end
+    end
+
+    def add_select(resource, name)
+      return select_all(resource) if name == :*
+      return if selectors[resource.model][:select] == true
+
+      selectors[resource.model][:select] << name
+    end
+
+    def add_track(resource, name)
+      selectors[resource.model][:track] << name
+    end
+
+    def add_association(resource, name, fields)
+      association = resource.model.associations.fetch(name) do
+        raise "missing association for #{resource} with name #{name}"
+      end
+      associated_resource = resource.model_map[association[:model]]
+
+      case association[:type]
+      when :many_to_one
+        add_track(resource, name)
+        add_select(resource, association[:key])
+      when :one_to_many
+        add_track(resource, name)
+        add_select(associated_resource, association[:key])
+      when :many_to_many
+        head, *tail = association.fetch(:through) do
+          raise "Association #{name} on #{resource.model} must specify the " +
+            "':through' option. "
+        end
+        new_fields = tail.reverse.inject(fields) do |thing, step|
+          {step => thing}
+        end
+        return add_association(resource, head, new_fields)
+      else
+        raise "no select applicable for #{association[:type].inspect}"
+      end
+
+      unless fields == true
+        # recurse into the field
+        add(associated_resource,fields)
+      end
+    end
+
+    def add_property(resource, name)
+      dependencies = resource.properties[name][:dependencies]
+      return if dependencies.nil?
+
+      dependencies.each do |dependency|
+        apply_dependency(resource, dependency)
+      end
+    end
+
+    def apply_dependency(resource, dependency)
+      case dependency
+      when Symbol
+        map_property(resource, dependency, {})
+      when String
+        head, tail = dependency.split('.').collect(&:to_sym)
+        raise "String dependencies can not be singular" if tail.nil?
+
+        add_association(resource, head, {tail => true})
+      end
+    end
+
+  end
+end

data/lib/praxis-mapper/version.rb

@@ -1,5 +1,5 @@
 module Praxis
   module Mapper
-    VERSION = "4.1.2"
+    VERSION = "4.2"
   end
 end

data/praxis-mapper.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency(%q<fuubar>, ["~> 1"])
   spec.add_development_dependency('sqlite3')
   spec.add_development_dependency('factory_girl')
+  spec.add_development_dependency('coveralls')
 end

data/spec/factories/all.rb

@@ -2,8 +2,14 @@ FactoryGirl.define do
 
   to_create { |i| i.save }
 
-  factory :user, class: UserModel, aliases: [:author] do
-    name { /[:name:]/.gen }
+  factory :blog, class: BlogModel do
+    name { /\w+/.gen }
+    owner
+  end
+
+  factory :user, class: UserModel, aliases: [:author, :owner] do
+    first_name { /[:first_name:]/.gen }
+    last_name { /[:last_name]/.gen }
     email { /[:email:]/.gen }
   end
 

data/spec/praxis-mapper/query/base_spec.rb

@@ -3,15 +3,16 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 describe Praxis::Mapper::Query::Base do
   let(:scope) { {} }
   let(:unloaded_ids) { [1, 2, 3] }
+  let(:selectors) { {} }
+
   let(:connection) { double("connection") }
-  let(:identity_map) { double("identity_map", :scope => scope, :get_unloaded => unloaded_ids) }
+  let(:identity_map) { double("identity_map", scope: scope, get_unloaded: unloaded_ids, selectors: selectors) }
 
   let(:model) { SimpleModel }
 
   let(:expected_ids_condition) { "id IN (#{unloaded_ids.join(", ")})" }
 
-  let(:query) { Praxis::Mapper::Query::Base.new(identity_map, model) }
-  subject { query }
+  subject(:query) { Praxis::Mapper::Query::Base.new(identity_map, model) }
 
   let(:rows) { [
                  {:id => 1, :name => "george jr", :parent_id => 1, :description => "one"},
@@ -110,6 +111,11 @@ describe Praxis::Mapper::Query::Base do
         subject.select.should include(:id => nil, :name => nil)
       end
 
+      it 'adds model identities if necessary' do
+        subject.select :id
+        subject.select.should eq(id: nil, name: nil)
+      end
+
       it "accepts an array of strings" do
         subject.select "id", "name"
         subject.select.should include("id" => nil, "name" => nil)
@@ -135,7 +141,6 @@ describe Praxis::Mapper::Query::Base do
 
         context "with symbols for the field definitions" do
           it "and symbols to specify the field aliases" do
-            definition = {:my_id => :id, :name => :name}
             subject.select :my_id => :id, :name => :name
             subject.select.should include :my_id => :id, :name => :name
           end
@@ -163,6 +168,27 @@ describe Praxis::Mapper::Query::Base do
         subject.select.should include(definition)
       end
 
+      context 'selecting all fields' do
+        it 'maps select :* to true' do
+          subject.select :*
+          subject.select.should be(true)
+        end
+
+        it 'preserves * when selecting specific fields' do
+          subject.select :*
+          subject.select :id
+          subject.select.should be(true)
+        end
+
+        it 'overrides any selected fields when * is passed' do
+          subject.select :id
+          subject.select :*
+          subject.select.should be(true)
+        end
+
+      end
+
+
     end
 
     context "with no query body" do
@@ -310,9 +336,11 @@ describe Praxis::Mapper::Query::Base do
     end
   end
 
-  context "#raw" do
-    let(:model) { PersonModel }
+  context 'with a selectors from the identity map' do
+    let(:selectors) { {model => {select: [:name, :state], track: [:address]}} }
 
+    its(:select) { should eq(id: nil, name: nil, state: nil) }
+    its(:track) { should eq Set[:address] }
   end
 
 end

data/spec/praxis-mapper/query/sequel_spec.rb

@@ -41,6 +41,17 @@ describe Praxis::Mapper::Query::Sequel do
       query.execute
       connection.sqls.should eq(["SELECT id, name FROM items WHERE (name = 'something') LIMIT 10"])
     end
+
+    context 'with select :* in query' do
+      it 'runs the correct sql with "SELECT *"' do
+        query.select :*
+        connection.sqls.should be_empty
+        query.execute
+        connection.sqls.should eq(["SELECT * FROM items WHERE (name = 'something') LIMIT 10"])
+      end
+
+    end
+
   end
 
 

data/spec/praxis-mapper/query/sql_spec.rb

@@ -91,6 +91,21 @@ describe Praxis::Mapper::Query::Sql do
 
   end
 
+  context 'selecting all fields' do
+    subject(:query) do
+      Praxis::Mapper::Query::Sql.new(identity_map, SimpleModel) do
+        select :id, :name
+        where "deployment_id=2"
+        track :parent
+      end
+    end
+
+    it 'generates proper select clause if select is true' do
+      query.select :*
+      query.select_clause.should eq 'SELECT *'
+    end
+
+  end
   context '#_multi_get' do
 
     let(:ids) { [1, 2, 3] }

data/spec/praxis-mapper/resource_spec.rb

@@ -1,7 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Praxis::Mapper::Resource do
-
   let(:parent_record) { ParentModel.new(id: 100, name: 'george sr') }
   let(:parent_records) { [ParentModel.new(id: 101, name: "georgia"),ParentModel.new(id: 102, name: 'georgina')] }
   let(:record) { SimpleModel.new(id: 103, name: 'george xvi') }
@@ -15,8 +14,24 @@ describe Praxis::Mapper::Resource do
   end
 
   context 'configuration' do
-    subject { SimpleResource }
+    subject(:resource) { SimpleResource }
     its(:model) { should == model }
+
+    context 'properties' do
+      subject(:properties) { resource.properties }
+
+      it 'includes directly-set properties' do
+        properties[:other_resource].should eq(dependencies: [:other_model])
+      end
+
+      it 'inherits from a superclass' do
+        properties[:href].should eq(dependencies: [:id])
+      end
+
+      it 'properly overrides a property from the parent' do
+        properties[:name].should eq(dependencies: [:simple_name])
+      end
+    end
   end
 
   context 'retrieving resources' do

data/spec/praxis-mapper/selector_generator_spec.rb

@@ -0,0 +1,221 @@
+require 'spec_helper'
+
+describe Praxis::Mapper::SelectorGenerator do
+  let(:properties) { {} }
+  let(:resource) { BlogResource }
+  subject(:generator) {Praxis::Mapper::SelectorGenerator.new }
+
+  before do
+    generator.add(resource,properties)
+  end
+
+  let(:expected_selectors) { {} }
+
+  context 'for a simple field' do
+    let(:properties) { {id: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:id]),
+          track: Set.new()
+        }
+      }
+    end
+
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'for a simple property' do
+    let(:properties) { {display_name: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:name]),
+          track: Set.new()
+        }
+      }
+    end
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'for an association' do
+    let(:properties) { {owner: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:owner_id]),
+          track: Set.new([:owner])
+        }
+      }
+    end
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+
+    context 'that is many_to_many' do
+      let(:properties) { {commented_posts: true} }
+      let(:resource) { UserResource }
+      let(:expected_selectors) do
+        {
+          CommentModel => {
+            select: Set.new([:author_id, :post_id]),
+            track: Set.new([:post])
+          },
+          UserModel => {
+            select: Set.new([]),
+            track: Set.new([:comments])
+          }
+        }
+      end
+      it 'generates the correct set of selectors' do
+        generator.selectors.should eq expected_selectors
+      end
+    end
+  end
+
+  context 'for a property that specifies a field from an association' do
+    let(:properties) { {owner_email: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:owner_id]),
+          track: Set.new([:owner])
+        },
+        UserModel => {
+          select: Set.new([:email]),
+          track: Set.new()
+        }
+      }
+    end
+
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'for a simple property that requires all fields' do
+    let(:properties) { {everything: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: true,
+          track: Set.new()
+        }
+      }
+    end
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'for property that uses an associated property' do
+    let(:properties) { {owner_full_name: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:owner_id]),
+          track: Set.new([:owner])
+        },
+        UserModel => {
+          select: Set.new([:first_name, :last_name]),
+          track: Set.new()
+        }
+      }
+    end
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+
+  context 'for a property that requires all fields from an association' do
+    let(:properties) { {everything_from_owner: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:owner_id]),
+          track: Set.new([:owner])
+        },
+        UserModel => {
+          select: true,
+          track: Set.new()
+        }
+      }
+    end
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'with a property that groups multiple fields' do
+    let(:properties) { {owner_full_name: {first: true}} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:owner_id]),
+          track: Set.new([:owner])
+        },
+        UserModel => {
+          select: Set.new([:first_name, :last_name]),
+          track: Set.new()
+        }
+      }
+    end
+    it 'generates selectors that ignore any unapplicable subrefinements' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'for a property with no dependencies' do
+    let(:properties) { {id: true, kind: true} }
+    let(:expected_selectors) do
+      {
+        BlogModel => {
+          select: Set.new([:id]),
+          track: Set.new()
+        }
+      }
+    end
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq expected_selectors
+    end
+  end
+
+  context 'with large set of properties' do
+
+    let(:properties) do
+      {
+        display_name: true,
+        owner: {
+          id: true,
+          full_name: true,
+          blogs_summary: {href: true, size: true},
+          main_blog: {id: true},
+        },
+        administrator: {id: true, full_name: true}
+      }
+    end
+
+    let(:expected_selectors) do
+      {
+        BlogModel=> {
+          select: Set.new([:id, :name, :owner_id, :administrator_id]),
+          track: Set.new([:owner, :administrator])
+        },
+        UserModel=> {
+          select: Set.new([:id, :first_name, :last_name, :main_blog_id]),
+          track: Set.new([:blogs, :main_blog])
+        }
+      }
+    end
+
+    it 'generates the correct set of selectors' do
+      generator.selectors.should eq(expected_selectors)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 Encoding.default_external = Encoding::UTF_8
 
 require 'rubygems'
@@ -19,9 +22,11 @@ require 'praxis-mapper'
 require 'active_support/core_ext/kernel'
 
 
-require_relative 'support/spec_sequel_models'
 require_relative 'support/spec_models'
+require_relative 'support/spec_sequel_models'
 require_relative 'support/spec_resources'
+require_relative 'support/spec_sequel_resources'
+
 require_relative 'spec_fixtures'
 
 require 'praxis-mapper/support'
@@ -43,7 +48,7 @@ RSpec.configure do |config|
   ]
 
   config.include FactoryGirl::Syntax::Methods
-  
+
   config.before(:suite) do
     FactoryGirl.find_definitions
     Sequel::Model.db.transaction do

data/spec/support/spec_resources.rb

@@ -5,6 +5,7 @@ class BaseResource < Praxis::Mapper::Resource
     base_href + "/#{self.class.collection_name}/#{self.id}"
   end
 
+  property :href, dependencies: [:id]
 end
 
 class CompositeIdResource < BaseResource
@@ -28,6 +29,9 @@ class SimpleResource < BaseResource
     self.other_model
   end
 
+  property :other_resource, dependencies: [:other_model]
+
+  property :name, dependencies: [:simple_name]
 end
 
 class SimplerResource < BaseResource
@@ -63,8 +67,20 @@ end
 class AddressResource < BaseResource
   model AddressModel
 
-  def href 
+
+  def href
     "/addresses/#{self.id}"
   end
-end
+  property :href, dependencies: [:id]
 
+  def owner_name
+    self.owner.name
+  end
+  property :owner_name, dependencies: ['owner.name']
+
+  def resident_count
+    self.residents.size
+  end
+  property :resident_count, dependencies: [:residents]
+
+end

data/spec/support/spec_sequel_models.rb

@@ -4,10 +4,20 @@
 
 DB = Sequel.sqlite
 
-DB.create_table! :users do
+DB.create_table! :blogs do
   primary_key :id
+  Integer :owner_id
+  Integer :administrator_id
 
   String :name
+end
+
+DB.create_table! :users do
+  primary_key :id
+  Integer :main_blog_id
+
+  String :first_name
+  String :last_name
   String :email
 end
 
@@ -54,16 +64,29 @@ Praxis::Mapper::ConnectionManager.setup do
   end
 end
 
+class BlogModel < Sequel::Model(:blogs)
+  include Praxis::Mapper::SequelCompat
+  many_to_one :owner, class: 'UserModel', key: :owner_id
+  many_to_one :administrator, class: 'UserModel', key: :administrator_id
+
+end
+
 class UserModel < Sequel::Model(:users)
   include Praxis::Mapper::SequelCompat
 
   repository_name :sequel
 
-  one_to_many :posts, class: 'PostModel'
-  one_to_many :comments, class: 'CommentModel'
+  one_to_many :posts, class: 'PostModel', key: :post_id
+  one_to_many :comments, class: 'CommentModel', key: :author_id
+  one_to_many :blogs, class: 'BlogModel', key: :owner_id
+
+  one_to_many :administered_blogs, class: 'BlogModel', key: :administrator_id
 
   many_to_many :commented_posts, class: 'PostModel',
-    join_table: 'comments', join_model: 'CommentModel'
+    join_table: 'comments', join_model: 'CommentModel',
+    through: [:comments, :post]
+
+  many_to_one :main_blog, class: 'BlogModel', key: :main_blog_id
 end
 
 class PostModel < Sequel::Model(:posts)
@@ -89,7 +112,7 @@ end
 
 class CompositeIdSequelModel < Sequel::Model(:composite_ids)
   include Praxis::Mapper::SequelCompat
-  
+
   repository_name :sequel
 
   set_primary_key [:id, :type]
@@ -101,9 +124,9 @@ end
 
 class OtherSequelModel < Sequel::Model(:others)
   include Praxis::Mapper::SequelCompat
-  
+
   repository_name :sequel
-  
+
   many_to_one :composite,
     class: 'CompositeIdSequelModel',
     key: [:composite_id, :composite_type]

data/spec/support/spec_sequel_resources.rb

@@ -0,0 +1,57 @@
+class BlogResource < BaseResource
+  property :display_name, dependencies: [:name]
+  property :owner_email, dependencies: ['owner.email']
+  property :owner_full_name, dependencies: ['owner.full_name']
+  property :everything, dependencies: [:*]
+  property :everything_from_owner, dependencies: ['owner.*']
+  property :kind, dependencies: nil
+
+  model BlogModel
+
+  def kind
+    self.class.name.demodulize
+  end
+
+  def display_name
+    self.name
+  end
+
+  def owner_email
+    self.owner.email
+  end
+
+  def owner_full_name
+    self.owner.full_name
+  end
+
+  def everything
+    'everything'
+  end
+
+  def everything_from_owner
+    'everything_from_owner'
+  end
+
+end
+
+class UserResource < BaseResource
+  model UserModel
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+  property :full_name, dependencies: [:first_name, :last_name]
+
+  def blogs_summary
+    {
+      href: "www.foo.com/#{self.id}",
+      size: blogs.size
+    }
+  end
+
+  property :blogs_summary, dependencies: [:id, :blogs]
+end
+
+class CommentResource < BaseResource
+  model CommentModel
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-mapper
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: '4.2'
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -235,6 +235,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - blanquer@gmail.com
@@ -267,6 +281,7 @@ files:
 - lib/praxis-mapper/query/sql.rb
 - lib/praxis-mapper/query_statistics.rb
 - lib/praxis-mapper/resource.rb
+- lib/praxis-mapper/selector_generator.rb
 - lib/praxis-mapper/sequel_compat.rb
 - lib/praxis-mapper/support.rb
 - lib/praxis-mapper/support/factory_girl.rb
@@ -289,6 +304,7 @@ files:
 - spec/praxis-mapper/query/sequel_spec.rb
 - spec/praxis-mapper/query/sql_spec.rb
 - spec/praxis-mapper/resource_spec.rb
+- spec/praxis-mapper/selector_generator_spec.rb
 - spec/praxis-mapper/sequel_compat_spec.rb
 - spec/praxis_mapper_spec.rb
 - spec/spec_fixtures.rb
@@ -296,6 +312,7 @@ files:
 - spec/support/spec_models.rb
 - spec/support/spec_resources.rb
 - spec/support/spec_sequel_models.rb
+- spec/support/spec_sequel_resources.rb
 homepage: https://github.com/rightscale/praxis-mapper
 licenses:
 - MIT
@@ -334,6 +351,7 @@ test_files:
 - spec/praxis-mapper/query/sequel_spec.rb
 - spec/praxis-mapper/query/sql_spec.rb
 - spec/praxis-mapper/resource_spec.rb
+- spec/praxis-mapper/selector_generator_spec.rb
 - spec/praxis-mapper/sequel_compat_spec.rb
 - spec/praxis_mapper_spec.rb
 - spec/spec_fixtures.rb
@@ -341,4 +359,5 @@ test_files:
 - spec/support/spec_models.rb
 - spec/support/spec_resources.rb
 - spec/support/spec_sequel_models.rb
+- spec/support/spec_sequel_resources.rb
 has_rdoc: