prim 0.0.3 → 0.0.4

data/LICENSE

@@ -0,0 +1,23 @@
+LICENSE
+
+The MIT License
+
+Copyright (c) 2012 Piers Mainwaring and Orca Health, Inc.
+
+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

@@ -32,9 +32,13 @@ end
 
 Great! Now let's say we've added a specific set of Languages. Our Users can now have new Language associations by simply creating a record in the `user_languages` mapping table, relating a User and a Language. But what if we want to know which of a User's Languages is their most important? Well, we could add a `sort_order` or `primary` column to the `user_languages` table, but then we'll need to write code to manage it all.
 
-Enter __Prim__.
+Enter __Prim__. Add
 
-With __Prim__ we can just add a line of code to the User model...
+```ruby
+gem 'prim'
+```
+
+to your Gemfile. With __Prim__ we can just add a line of code to the User model...
 
 ```ruby
 class User < ActiveRecord::Base

data/lib/prim.rb

@@ -27,11 +27,11 @@ module Prim
       Prim.configured_primaries << self.prim_relationships[ singular_name ]
 
       define_method "primary_#{ singular_name }" do
-        get_primary(singular_name)
+        prim_collection_for(singular_name).primary
       end
 
-      define_method "primary_#{ singular_name }=" do |record|
-        assign_primary(singular_name, record)
+      define_method "primary_#{ singular_name }=" do |instance|
+        prim_collection_for(singular_name).primary = instance
       end
     end
   end

data/lib/prim/collection.rb

@@ -1,7 +1,7 @@
 module Prim
   # Collection largely wraps an association collection (like a Relation) but adds
   # the concept of a primary member. Collections can only exist in the context of
-  # a Relationship (see Prim::Relationship for more info) and an `owner` instance,
+  # a Relationship (see Prim::Relationship for more info) and an "owning" `instance`,
   # and contain mapping records.
   class Collection
 
@@ -14,14 +14,20 @@ module Prim
       @instance     = instance
       @relationship = relationship
 
-      # Attach this collection to the mapping class so it has access to static methods.
-      relationship.reflected_class.prim_collection = self
+      # Attach the relationship to the mapping class.
+      relationship.reflected_class.prim_relationship = relationship
     end
 
+    # Loads the primary member of this collection.
     def primary
-      sources.where( relationship.through_reflection.name => { primary: true } ).first
+      sources.where( relationship.collection_label => { primary: true } ).first.try do |record|
+        record.primary = true
+        record
+      end
     end
 
+    # Sets the primary member of this collection. Requires a `source_record` to
+    # be passed (i.e. a Tag if Post `has_many :tags, through: :taggings`).
     def primary= source_record
       mapping = mapping_for(source_record)
 
@@ -40,18 +46,6 @@ module Prim
       true
     end
 
-    def siblings_for mapping
-      foreign_key   = relationship.mapping_reflection.foreign_key
-      mapping_type  = relationship.mapping_reflection.type
-      mapping_class = relationship.reflected_class
-      primary_key   = mapping_class.primary_key
-
-      query = relationship.reflected_class.where( foreign_key => mapping[ foreign_key ] )
-      query = query.where( mapping_type => mapping[ mapping_type ] ) unless mapping_type.nil?
-
-      query.where( mapping_class.arel_table[ primary_key ].not_eq( mapping[ primary_key ] ) )
-    end
-
     private
 
     # Creates a new source record and a mapping between it and the owner instance.
@@ -68,7 +62,7 @@ module Prim
     end
 
     def mappings force_reload = false
-      instance.send( relationship.collection_method, force_reload )
+      instance.send( relationship.collection_label, force_reload )
     end
 
     def sources force_reload = false

data/lib/prim/instance_methods.rb

@@ -5,15 +5,7 @@ module Prim
   module InstanceMethods
 
     module Owner
-      def get_primary singular_name
-        collection_for(singular_name).primary
-      end
-
-      def assign_primary singular_name, instance
-        collection_for(singular_name).primary = instance
-      end
-
-      def collection_for singular_name
+      def prim_collection_for singular_name
         @_prim_collections ||= {}
         @_prim_collections[ singular_name ] ||= Prim::Collection.new(self.class.prim_relationships[ singular_name ], self)
       end
@@ -24,6 +16,10 @@ module Prim
 
       included do
         validate :only_one_primary
+
+        def self.primary
+          where( primary: true ).first
+        end
       end
 
       def only_one_primary
@@ -32,8 +28,42 @@ module Prim
         end
       end
 
+      # Builds a query selecting all siblings for a given mapping record. A record's
+      # siblings are any records in the table of the `reflected_class` that match
+      # the given record's foreign key and, if the association is polymorphic,
+      # its foreign type. The set of siblings *excludes* `self` (this record).
       def siblings
-        prim_collection.siblings_for self
+        foreign_key  = prim_relationship.mapping_reflection.foreign_key
+        mapping_type = prim_relationship.mapping_reflection.type
+        primary_key  = prim_relationship.reflected_class.primary_key
+
+        # Select all by foreign key first, to handle all cases.
+        query = self.class.where( foreign_key => self[ foreign_key ] )
+
+        # Only select by a foreign "type" column if one is used on the `reflected_class`,
+        # making it a polymorphic association.
+        unless mapping_type.nil?
+          query = query.where( mapping_type => self[ mapping_type ] )
+        end
+
+        # Exclude this record from the query.
+        query.where( self.class.arel_table[ primary_key ].not_eq( self[ primary_key ] ) )
+      end
+    end
+
+    module Source
+      extend ActiveSupport::Concern
+
+      included do
+        attr_writer :primary
+
+        def primary
+          @primary || false
+        end
+
+        def primary?
+          primary
+        end
       end
     end
 

data/lib/prim/relationship.rb

@@ -34,17 +34,19 @@ module Prim
       # TODO: ensure the association isn't nested?
 
       reflected_class.send :include, InstanceMethods::Reflected
-      reflected_class.class_attribute :prim_collection
+      reflected_class.class_attribute :prim_relationship
+
+      source_class.send :include, InstanceMethods::Source if mapping_table?
     end
 
     # The association method to call on the owning class to retrieve a record's collection.
-    def collection_method
+    def collection_label
       options[:through] || mapping_reflection.plural_name
     end
 
     # The class of the reflection source: i.e. Post if the owning class `has_many :posts`.
     def source_class
-      source_reflection.klass
+      reflection.klass
     end
 
     # The class of the `mapping_reflection`.
@@ -55,7 +57,7 @@ module Prim
     # The association reflection representing the link between the owning class and the
     # mapping class, whether or not the mapping class represents a join-table.
     def mapping_reflection
-      through_reflection || source_reflection
+      through_reflection || reflection
     end
 
     # True if this relationship relies on a mapping table for `primary` records.

data/prim.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = "prim"
-  s.version     = "0.0.3"
-  s.date        = "2012-12-19"
+  s.version     = "0.0.4"
+  s.date        = "2013-01-02"
   s.summary     = "Easily manage Rails associations that need a primary member."
   s.description = "With Prim it's easy to add a primary member to any one-to-many or many-to-many association. " +
                   "Just add a short configuration to a model, generate and run a migration, and you're all set."
@@ -10,7 +10,8 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split("\n")
   s.homepage    = "https://github.com/orcahealth/prim"
 
-  s.add_dependency "activerecord", "~> 3.2.0"
+  s.add_dependency "activerecord",  "~> 3.2.0"
+  s.add_dependency "activesupport", "~> 3.2.0"
 
   s.require_paths = [ "lib" ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prim
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -27,6 +27,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
     none: false
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    none: false
 description: With Prim it's easy to add a primary member to any one-to-many or many-to-many
   association. Just add a short configuration to a model, generate and run a migration,
   and you're all set.
@@ -35,6 +51,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/prim.rb
 - lib/prim/collection.rb