prim 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,74 @@
+Overview
+--------
+
+__Prim__ gives you the power to assign and manage the primary member of any Rails one–to–many or many–to–many assocation. And it's really simple to get started! Let's say we needed to model a User who could have several Languages:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :user_languages
+  has_many :languages, through: :user_languages
+
+  ...
+end
+```
+
+```ruby
+class UserLanguage < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :language
+
+  ...
+end
+```
+
+```ruby
+class Language < ActiveRecord::Base
+  has_many :user_languages
+  has_many :users, through: :user_languages
+
+  ...
+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__.
+
+With __Prim__ we can just add a line of code to the User model...
+
+```ruby
+class User < ActiveRecord::Base
+  ...
+
+  has_primary :language
+end
+```
+
+...and run a migration:
+
+```ruby
+class AddPrimaryToUserLanguages < ActiveRecord::Migration
+  def change
+    add_column :user_languages, :primary, :boolean, { default: false }
+  end
+end
+```
+
+And we're done! Now we can set any User's primary language...
+
+```ruby
+User.first.primary_language = Language.where( name: "English" )
+```
+
+...and retrieve it:
+
+```ruby
+User.first.primary_language
+=> #<Language id: 5, name: "English" ... >
+```
+
+Contributing
+------------
+
+Want to contribute? Find a TODO or [Github issue](https://github.com/OrcaHealth/prim/issues) and take care of it! Or suggest a feature or file a bug on the [issues page](https://github.com/OrcaHealth/prim/issues). Just pack up your commits by rebasing them, then submit a pull request!
+

data/lib/prim.rb

@@ -15,6 +15,7 @@ module Prim
   module ClassMethods
     include Prim::Helpers
 
+    # TODO: allow multiple singular names in one call.
     def has_primary name, options = {}
       singular_name    = name.to_sym
       association_name = plural_sym(singular_name)
@@ -36,5 +37,5 @@ module Prim
   end
 
   class SingularAssociationError < StandardError; end
-  class MissingColumnError < StandardError; end
+  class InvalidPrimaryColumnError < StandardError; end
 end

data/lib/prim/collection.rb

@@ -13,6 +13,9 @@ module Prim
     def initialize relationship, instance
       @instance     = instance
       @relationship = relationship
+
+      # Attach this collection to the mapping class so it has access to static methods.
+      relationship.reflected_class.prim_collection = self
     end
 
     def primary
@@ -37,6 +40,18 @@ 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.

data/lib/prim/instance_methods.rb

@@ -23,15 +23,17 @@ module Prim
       extend ActiveSupport::Concern
 
       included do
-
         validate :only_one_primary
+      end
 
-        def only_one_primary
-          if self[:primary]
-            siblings.update_all('"primary" = false')
-          end
+      def only_one_primary
+        if self[:primary]
+          siblings.update_all('"primary" = false')
         end
+      end
 
+      def siblings
+        prim_collection.siblings_for self
       end
     end
 

data/lib/prim/relationship.rb

@@ -9,52 +9,32 @@ module Prim
     delegate :source_reflection, :through_reflection, :foreign_key, to: :reflection
 
     def initialize association_name, owning_class, options = {}
-      @options = extract_options options
+      @options = options
       @association_name = association_name
       @owning_class = owning_class
       @reflection   = owning_class.reflect_on_association( association_name )
 
+      # TODO: remove these exceptions and replace with logged errors? hmm.
       if reflection.nil?
-        raise ArgumentError.new("Prim: Association '#{ association_name }' not found " +
+        raise ArgumentError.new("Association '#{ association_name }' not found " +
           "on #{ owning_class.name }. Perhaps you misspelled it?")
       
       elsif !reflection.collection?
-        raise SingularAssociationError.new("Prim: Association '#{ association_name }' " +
+        raise SingularAssociationError.new("Association '#{ association_name }' " +
           "is not a one-to-many or many-to-many relationship, so it can't have a primary.")
 
-      elsif !reflected_column_names.include? "primary"
-        raise MissingColumnError.new("Prim: #{ owning_class.name } needs table " +
-          "`#{ mapping_reflection.table_name }` to have a boolean 'primary' column in " +
-          "order to have a primary #{ source_class.name }.")
+      elsif !primary_column
+        # TODO: add a generator to automatically create a migration, then change this
+        # message to give users the exact instruction needed.
+        raise InvalidPrimaryColumnError.new("#{ owning_class.name } needs table " +
+          "`#{ mapping_reflection.table_name }` to have a boolean 'primary' column " +
+          "in order to have a primary #{ source_class.name }.")
       end
 
       # TODO: ensure the association isn't nested?
 
-      configure_reflected_class!
-
-      true
-    end
-
-    def configure_reflected_class!
-      foreign_key  = mapping_reflection.foreign_key
-      mapping_type = mapping_reflection.type
-
-      load_siblings = lambda do
-        primary_key = self.class.primary_key
-        query = self.class.where( foreign_key => self[ foreign_key ] )
-
-        if mapping_type
-          query = query.where( mapping_type => self[ mapping_type ] )
-        end
-
-        query.where( self.class.arel_table[ primary_key ].not_eq(self[ primary_key ]) )
-      end
-
-      reflected_class.class_eval do
-        define_method :siblings, &load_siblings
-      end
-
       reflected_class.send :include, InstanceMethods::Reflected
+      reflected_class.class_attribute :prim_collection
     end
 
     # The association method to call on the owning class to retrieve a record's collection.
@@ -78,22 +58,6 @@ module Prim
       through_reflection || source_reflection
     end
 
-    # True if the `mapping_reflection` class has an "inverse" mapping back to the owning
-    # class with a matching name. Verifies that a polymorphic mapping exists.
-    # def polymorphic_mapping?
-    #   if polymorphic_as.present?
-    #     !!reflected_class.reflect_on_all_associations.detect do |refl|
-    #       refl.name == polymorphic_as and refl.association_class == ActiveRecord::Associations::BelongsToPolymorphicAssociation
-    #     end
-    #   end
-    # end
-
-    # The name the owning class uses to create mappings in the reflected class; i.e. the
-    # `:as` option set on the `has_many` association in the owner.
-    # def reflection_polymorphic_as
-    #   mapping_reflection.options[:as].to_sym
-    # end
-
     # True if this relationship relies on a mapping table for `primary` records.
     def mapping_table?
       !!through_reflection
@@ -101,13 +65,8 @@ module Prim
 
     private
 
-    # The columns of the reflected class (where `primary` needs to be).
-    def reflected_column_names
-      reflected_class.column_names
-    end
-
-    def extract_options options
-      options
+    def primary_column
+      reflected_class.columns.find { |col| col.name == "primary" }
     end
   end
 end

data/prim.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "prim"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.date        = "2012-12-19"
   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. " +
@@ -10,5 +10,7 @@ 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.require_paths = [ "lib" ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prim
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-12-19 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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.
@@ -19,15 +35,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/prim.rb
 - lib/prim/collection.rb
 - lib/prim/connector.rb
 - lib/prim/helpers.rb
 - lib/prim/instance_methods.rb
-- lib/prim/primary.rb
 - lib/prim/railtie.rb
 - lib/prim/relationship.rb
-- lib/tasks/prim.rake
 - prim.gemspec
 homepage: https://github.com/orcahealth/prim
 licenses: []

data/lib/prim/primary.rb

@@ -1,11 +0,0 @@
-module Prim
-  class Primary
-    attr_reader :relationship, :record
-
-    def initialize relationship, record
-      @relationship = relationship
-      @record = record
-      
-    end
-  end
-end