yaml_b_sides 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe6d60416f8f0b980e021475bc8bec4d22816232
-  data.tar.gz: c0eb789a44fb284ed36afc977490fe2e097c6915
+  metadata.gz: f9c1e5106acd3094fc9410a28732fa9133834ba8
+  data.tar.gz: 2b3d6b50d7d4531c0e6d30f5539ba442fd607c8d
 SHA512:
-  metadata.gz: 5966c40826854c511bc4a3108139de921bbf32f61e5bc26f474957103dc6b47fd36718e50198267c3b9bd1fa6b5c3a604b17bf62f26ceb29a321606f9c66f2e3
-  data.tar.gz: 7d6101f9afc46dfc442ad78dc61ebe614a62770148b41777ebef9a35e5370e8ad82f37f2f2cf2c70528935dcb671ae67a90d8880649549f477a4e1eb2b7c6387
+  metadata.gz: 356d4ff801988430a58ccb281009b914b868edcd44f9f0a83d9ecb926c56973c89fe3827dbf6fc9c00655d38978a4e266798af7ac5a0bcc1d2b463b6a742b143
+  data.tar.gz: e11f162cf0e71a2f63142a584c7a534954986a28874b6a0b780a4cbb37282cfd2b4d67d44f7e9adea46e5b544a94f9a8046f8375e9bb6d1e5c6cd5c4b5604156

data/README.md

@@ -98,7 +98,7 @@ Associations have some of the standard ActiveRecord options. Namely:
 
 * `through`: many to may association helper. 
   
-    ```ruby
+  ```ruby
     class Person < YamlBSides::Base
       has_many :person_foods
       has_many :favorite_foods, through: :person_foods, class_name: "Food"
@@ -115,6 +115,44 @@ Associations have some of the standard ActiveRecord options. Namely:
   
   __NOTE__: only works for `has_one` and `has_many`
 
+* `as`: specifies what the associated object calls the caller
+  ```ruby
+    class Person
+      has_many :images, as: :target
+    end
+
+    class Image
+      belongs_to :target, class: Person
+    end
+  ```
+  __NOTE__: only works for `has_one` and `has_many`
+
+* `polymorphic`: specifies a polymorphic `belongs_to` association. Better explanation [here, on the ActiveRecord page](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations)
+  ```ruby
+    class Person
+      has_many :images, as: :target
+    end
+
+    class Party
+      has_many :images, as: :target
+    end
+
+    class Image
+      belongs_to :target, polymorphic: true
+    end
+  ```
+  And then the `images.yml` looks something like
+  ```yml
+    image-1:
+      thing_id: a
+      thing_class: Person
+      # ...
+    image-2:
+      thing_id: a
+      thing_class: PArty
+      #...
+  ```
+
 ### Example
 
 To use the `People` class from earlier, a fully fleshed out model would look something like:

data/lib/yaml_b_sides/associatable.rb

@@ -11,7 +11,9 @@ module YamlBSides
       class << self
 
         def belongs_to( name, opts = {} )
-          process Associations::BelongsTo.new( self, name, opts )
+          association = Associations::BelongsTo.new( self, name, opts )
+          process association
+          index association.key
         end
 
         def has_one( name, opts = {} )
@@ -38,7 +40,7 @@ module YamlBSides
             self._cached_associations ||= {}
 
             unless self._cached_associations.has_key? association.name
-              result = association.klass.send( association.action, association.query( self ) )
+              result = association.klass( self ).send( association.action, association.query( self ) )
               
               self._cached_associations[association.name] = result
             end

data/lib/yaml_b_sides/associations.rb

@@ -2,8 +2,8 @@ module YamlBSides
   module Associations
     autoload :Base,       'yaml_b_sides/associations/base'
     autoload :BelongsTo,  'yaml_b_sides/associations/belongs_to'
+    autoload :Hasable,    'yaml_b_sides/associations/hasable'
     autoload :HasMany,    'yaml_b_sides/associations/has_many'
     autoload :HasOne,     'yaml_b_sides/associations/has_one'
-    autoload :Through,    'yaml_b_sides/associations/through'
   end
 end

data/lib/yaml_b_sides/associations/base.rb

@@ -8,9 +8,11 @@ module YamlBSides
         self.name = name
         self.opts = opts
         self.key  = idify base_class
+
+        sanitize_opts( base_class )
       end
 
-      def klass
+      def klass( instance = nil )
         @klass ||= association_class name, opts
       end
 
@@ -30,6 +32,22 @@ module YamlBSides
       def idify( class_name )
         "#{class_name.to_s.demodulize.underscore}_id"
       end
+
+      def supported_options
+        [ :class, :class_name ] + additional_options
+      end
+
+      def sanitize_opts( base_class )
+        if name.to_s == "object"
+          raise YamlBSides::Errors::AssociationError, "#{base_class}: 'object_id' is a reserved keyword in ruby and cannot be overridden"
+        end
+        invalid_options = (opts.keys - supported_options)
+        if invalid_options.present?
+          list = invalid_options.map{|o|"'#{o}'"}.to_sentence
+          plural = invalid_options.count > 1
+          raise YamlBSides::Errors::AssociationError, "#{base_class}: #{list} #{plural ? "are" : "is"} not supported. Please see README for ful details: http://www.github.com/gaorlov/yaml_b_sides"
+        end
+      end
     end
   end
 end

data/lib/yaml_b_sides/associations/belongs_to.rb

@@ -5,8 +5,31 @@ module YamlBSides
         :find
       end
 
+      def key
+        "#{name}_id"
+      end
+
       def query( instance )
-        instance.send "#{name}_id"
+        instance.send key
+      end
+
+      def klass( instance )
+        if polymorphic?
+          class_name = instance.send "#{name}_class"
+          class_name.constantize
+        else
+          super
+        end
+      end
+
+      protected
+
+      def additional_options
+        [ :polymorphic ]
+      end
+
+      def polymorphic?
+        opts[:polymorphic]
       end
     end
   end

data/lib/yaml_b_sides/associations/has_many.rb

@@ -1,7 +1,7 @@
 module YamlBSides
   module Associations
     class HasMany < Base
-      include Through
+      include Hasable
 
       def action
         :where

data/lib/yaml_b_sides/associations/has_one.rb

@@ -1,7 +1,7 @@
 module YamlBSides
   module Associations
     class HasOne < Base
-      include Through 
+      include Hasable 
 
       def action
         :find_by

data/lib/yaml_b_sides/associations/{through.rb → hasable.rb}

@@ -1,24 +1,42 @@
 module YamlBSides
   module Associations
-    module Through
+    module Hasable
       extend ActiveSupport::Concern
 
       included do
 
         def query( instance )
-          unless opts.has_key? :through
-            { key => instance.id }
-          else
+          if through?
             { id: target_ids( instance ) }
+          elsif as?
+            { "#{as}_id" => instance.id }
+          else
+            { key => instance.id }
           end
         end
 
+        def additional_options
+          [ :as, :through ]
+        end
+
         protected
 
         def through
           opts[:through]
         end
 
+        def through?
+          opts.has_key? :through
+        end
+
+        def as
+          opts[:as]
+        end
+
+        def as?
+          opts.has_key? :as
+        end
+
         def target_ids( instance )
           intermadiates = Array(instance.send( through ) )
           

data/lib/yaml_b_sides/base.rb

@@ -19,6 +19,7 @@ module YamlBSides
         logger.info "#{self} successfully loaded data"
         # let's preemptively index by id so that when we do a find_by id:, or a where id: it won't table scan
         index :id
+        init_indices!
       rescue => e
         logger.error "#{self} failed to load data: #{e}"
       end

data/lib/yaml_b_sides/errors.rb

@@ -2,5 +2,8 @@ module YamlBSides
   module Errors
     class RecordNotFound < StandardError
     end
+
+    class AssociationError < StandardError
+    end
   end
 end

data/lib/yaml_b_sides/queriable.rb

@@ -6,13 +6,13 @@ module YamlBSides
       class << self
         def find(id)
           record = @data[id]
-          raise Errors::RecordNotFound, "Record not found: #{id}" unless record
+          raise Errors::RecordNotFound, "#{self}: Record not found: #{id}" unless record
           new record
         end
 
         def find_by(params = {})
           results = where params
-          raise Errors::RecordNotFound, "Could not find record that matches: #{params.inspect}" if results.empty?
+          raise Errors::RecordNotFound, "#{self}: Could not find record that matches: #{params.inspect}" if results.empty?
           results.first
         end
 

data/lib/yaml_b_sides/version.rb

@@ -1,3 +1,3 @@
 module YamlBSides
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_b_sides
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Greg Orlov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -117,7 +117,7 @@ files:
 - lib/yaml_b_sides/associations/belongs_to.rb
 - lib/yaml_b_sides/associations/has_many.rb
 - lib/yaml_b_sides/associations/has_one.rb
-- lib/yaml_b_sides/associations/through.rb
+- lib/yaml_b_sides/associations/hasable.rb
 - lib/yaml_b_sides/base.rb
 - lib/yaml_b_sides/cacheable.rb
 - lib/yaml_b_sides/errors.rb