passive_record 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44c674c3b4dc0121e16a6368fce9d4109ccf6b51
-  data.tar.gz: 7621a7ffbba7ee1cf08cd36bcd0cb053d36da13f
+  metadata.gz: 538bfa9bf872e0e23675e06d820897253504c6c3
+  data.tar.gz: ece1e692df2cfd1a30d9240fc4fdfca11388f8a3
 SHA512:
-  metadata.gz: ea2328b524559ed872dbf095380ecd2d3f4b5fba455c798c600ba35e540965c42929e07c98d8c49e1ce19b456690871cb69bf0e4e3e975f72e43c0cd528af3c3
-  data.tar.gz: 5c12ba3c4eb166561a9c93703dde48e79e0cea00712c3eab9d919591073b16615e8c0f6e905132d56c525e81a46fd6df022e5ee1aa06e1fefa2f8834c714102c
+  metadata.gz: 066ce8866a53c2725e9c8e642be67e0ac2dd86fbaeab3b435c354bcf6e30255b90b1082515721ed7c132246aa30a89e3d555e8611db38033f722f9e66cb075c5
+  data.tar.gz: 9ed65e8664ff3c288ad8dbabe17efae62b8be398ea8f1849d97ac8e72f515bcdc02bef4c4b4af10e06ddb6c6e4817bd129873e4ad743f600e33f1f784c860d85

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby '2.3.0'
 
 gemspec
 

data/README.md

@@ -31,7 +31,7 @@ PassiveRecord may be right for you!
   - Query on attributes and associations
   - Supports many-to-many and self-referential relationships
   - No database required!
-  - Just `include PassiveRecord` to activate a PORO in the system
+  - Just `include PassiveRecord` to get started
 
 ## Examples
 
@@ -56,32 +56,99 @@ PassiveRecord may be right for you!
       has_many :dogs, :through => :children
     end
 
-    # Let's create some models!
+    # Let's build some models!
     parent = Parent.create
-    => Parent (id: 1)
+    => Parent (id: 1, child_ids: [], dog_ids: [])
 
     child = parent.create_child
-    => Child (id: 1)
+    => Child (id: 1, dog_id: nil, parent_id: 1)
 
     dog = child.create_dog
-    => Dog (id: 1)
+    => Dog (id: 1, child_id: 1)
 
-    # inverse relationships
+    # Inverse relationships
     dog.child
-    => Child (id: 1)
+    => Child (id: 1, dog_id: 1, parent_id: 1)
 
     Dog.find_by child: child
-    => Dog (id: 1)
+    => Dog (id: 1, child_id: 1)
 
-    # has many thru
+    # Has many through
     parent.dogs
-    => [Dog (id: 1)]
+    => [ ...has_many :through relation... ]
 
-    # nested queries
+    parent.dogs.all
+    => [Dog (id: 1, child_id: 1)]
+
+    # Nested queries
     Dog.find_all_by(child: { parent: parent })
-    => [Dog (id: 1)]
+    => [Dog (id: 1, child_id: 1)]
 ````
 
+## Interface
+
+  A class including PassiveRecord will gain the following new instance and class methods.
+
+### Instance Methods
+
+  A class `Role` which is declared to `include PassiveRecord` will gain the following instance methods:
+  - `role.update(attrs_hash)`
+  - `role.to_h`
+  - We override `role.inspect` to show ID and visible attributes
+
+### Class Methods
+
+  A class `User` which is declared to `include PassiveRecord` will gain the following class methods:
+  - `User.create(attrs_hash)`
+  - `User.find(id_or_ids)`
+  - `User.find_by(conditions_hash)`
+  - `User.find_all_by(conditions_hash)`
+  - `User.all` and `User.each`
+  -  User is `Enumerable` through `User.all`, so we have `User.count`, `User.first`, etc.
+  - `User.where(conditions_hash)` (returns a `PassiveRecord::Query` object)
+  - `User.descendants`
+  - `User.destroy_all`
+
+## Relationships
+
+### Belongs To
+
+  A model `Child` which is declared `belongs_to :parent` will gain:
+
+  - `child.parent`
+  - `child.parent_id`
+  - `child.parent=`
+  - `child.parent_id=`
+
+### Has One
+
+  A model `Parent` which declares `has_one :child` will gain:
+
+  - `parent.child`
+  - `parent.child_id`
+  - `parent.child=`
+  - `parent.child_id=`
+  - `parent.create_child(attrs)`
+
+### Has Many
+
+  A model `Parent` which declares `has_many :children` will gain:
+
+  - `parent.children` (returns a `Relation`)
+  - `parent.children_ids`
+  - `parent.children=`
+  - `parent.children_ids=`
+  - `parent.create_child(attrs)`
+  - `parent.children<<` (insert a related model)
+  - `parent.children.all?(&predicate)`
+  - `parent.children.empty?`
+  - `parent.children.where` (returns a `Core::Query`)
+
+## Hooks
+
+  - `after_create :call_method`
+  - `after_update { or_use_a_block }`
+
 ## Copyright
 
 Copyright (c) 2016 Joseph Weissman

data/lib/passive_record/associations/belongs_to.rb

@@ -11,6 +11,10 @@ module PassiveRecord
     end
 
     class BelongsToRelation < Struct.new(:association, :child_model)
+      def singular?
+        true
+      end
+
       def lookup
         association.parent_class.find_by(parent_model_id)
       end

data/lib/passive_record/associations/has_many.rb

@@ -11,9 +11,35 @@ module PassiveRecord
     end
 
     class HasManyRelation < HasOneRelation
-      def lookup
+      include Enumerable 
+      include Enumerable
+      extend Forwardable
+
+      def all
         child_class.where(parent_model_id_field => parent_model.id).all
       end
+      def_delegators :all, :each
+
+      def all?(*args)
+        all.all?(*args)
+      end
+
+      def empty?
+        all.empty?
+      end
+
+      def where(conditions)
+        child_class.where(conditions.merge(parent_model_id_field => parent_model.id))
+      end
+      
+      def <<(child)
+        child.send(parent_model_id_field + "=", parent_model.id)
+        lookup
+      end
+
+      def singular?
+        false
+      end
     end
   end
 end

data/lib/passive_record/associations/has_many_through.rb

@@ -11,13 +11,20 @@ module PassiveRecord
         association.base_association.to_relation(parent_model)
       end
 
+      def_delegators :all, :intermedia
+
       def results
-        intermediary_relation.lookup
+        intermediary_relation.all
       end
 
-      def lookup
+      def all
         if target_sym && results
-          results.flat_map(&target_sym)
+          final_results = results.flat_map(&target_sym)
+          if final_results.first.is_a?(Associations::Relation) && !final_results.first.singular?
+            final_results.first.send(:all)
+          else
+            Array(final_results)
+          end
         else
           []
         end

data/lib/passive_record/associations/has_one.rb

@@ -11,7 +11,13 @@ module PassiveRecord
       end
     end
 
-    class HasOneRelation < Struct.new(:association, :parent_model)
+    class Relation < Struct.new(:association, :parent_model)
+      def singular?
+        true
+      end
+    end
+
+    class HasOneRelation < Relation
       def lookup
         child_class.find_by(parent_model_id_field => parent_model.id)
       end
@@ -33,9 +39,12 @@ module PassiveRecord
       end
 
       def child_class
-        # binding.pry
         Object.const_get(association.child_class_name.singularize)
       end
+
+      def id
+        parent_model.id
+      end
     end
   end
 end

data/lib/passive_record/associations.rb

@@ -7,7 +7,8 @@ module PassiveRecord
   module Associations
     def associate!(assn)
       @associations ||= []
-      @associations += [assn]
+      @associations += [assn] unless @associations.include?(assn)
+      self
     end
 
     def associations_id_syms
@@ -15,7 +16,7 @@ module PassiveRecord
         if assn.is_a?(HasOneAssociation) || assn.is_a?(BelongsToAssociation)
           (assn.target_name_symbol.to_s + "_id").to_sym
         else # plural ids
-          (assn.target_name_symbol.to_s + "_ids").to_sym
+          (assn.target_name_symbol.to_s.singularize + "_ids").to_sym
         end
       end || []
     end

data/lib/passive_record/class_inheritable_attrs.rb

@@ -14,7 +14,6 @@ module ClassLevelInheritableAttributes
         )
       end
 
-      # binding.pry
       @inheritable_attributes
     end
 

data/lib/passive_record/core/query.rb

@@ -3,6 +3,7 @@ module PassiveRecord
     class Query < Struct.new(:klass, :conditions)
       def all
         return [] unless conditions
+
         klass.all.select do |instance|
           conditions.all? do |(field,value)|
             if value.is_a?(Hash)
@@ -13,10 +14,13 @@ module PassiveRecord
                     assc_model.send(assn_field) == val
                   end
                 else
-                  assn.send(assn_field) == val
+                  if assn.is_a?(Core::Query) || (assn.is_a?(Associations::Relation) && !assn.singular?)
+                    assn.where(assn_field => val) # send(assn_field) == val
+                  else
+                    assn.send(assn_field) == val
+                  end
                 end
               end
-
               matched
             else
               instance.send(field) == value

data/lib/passive_record/instance_methods.rb

@@ -1,7 +1,5 @@
 module PassiveRecord
   module InstanceMethods
-    include PrettyPrinting
-
     def update(attrs={})
       attrs.each do |k,v|
         send("#{k}=", v)
@@ -16,7 +14,7 @@ module PassiveRecord
     def to_h
       Hash[
         attribute_names.
-        map do |name| [ 
+        map do |name| [
           name.to_s.gsub("@","").to_sym,  # key
           (instance_variable_get(name) rescue send(name))] # val
         end
@@ -85,7 +83,11 @@ module PassiveRecord
 
       case meth.to_s
       when target_name
-        matching_relation.lookup
+        if matching_relation.singular?
+          matching_relation.lookup
+        else
+          matching_relation
+        end
       when "#{target_name}="
         if args.first.is_a?(Array)
           # need to loop through each arg and set id
@@ -99,7 +101,11 @@ module PassiveRecord
       when "create_#{target_name}", "create_#{target_name.singularize}"
         matching_relation.create(*args)
       when "#{target_name}_id"
-        matching_relation.parent_model_id
+        if matching_relation.is_a?(Associations::HasOneRelation)
+          matching_relation.lookup&.id
+        elsif matching_relation.is_a?(Associations::BelongsToRelation)
+          matching_relation.parent_model_id
+        end
       when "#{target_name}_id="
         matching_relation.parent_model_id = args.first
       when "#{target_name}_ids", "#{target_name.singularize}_ids"

data/lib/passive_record/version.rb

@@ -1,4 +1,4 @@
 module PassiveRecord
   # passive_record version
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/passive_record.rb

@@ -21,6 +21,7 @@ module PassiveRecord
   def self.included(base)
     base.send :include, InstanceMethods
     base.send :include, ClassLevelInheritableAttributes
+    base.send :include, PrettyPrinting
 
     base.class_eval do
       inheritable_attrs :hooks, :associations

data/spec/passive_record_spec.rb

@@ -17,6 +17,8 @@ describe PassiveRecord do
 end
 
 describe "passive record models" do
+  before { PassiveRecord.drop_all }
+
   context "with a simple model including PR" do
     let!(:model) { SimpleModel.create(foo: value) }
     let(:value) { 'foo_value' }
@@ -41,6 +43,12 @@ describe "passive record models" do
         it 'should report relations' do
           dog = Dog.create
           expect(dog.inspect).to eq("Family::Dog (id: #{dog.id.inspect}, created_at: #{dog.created_at}, sound: \"bark\", child_id: nil)")
+
+          child = Child.create
+          child.dogs << dog
+          expect(dog.inspect).to eq("Family::Dog (id: #{dog.id.inspect}, created_at: #{dog.created_at}, sound: \"bark\", child_id: #{child.id.inspect})")
+
+          expect(child.inspect).to eq("Family::Child (id: #{child.id.inspect}, created_at: #{dog.created_at}, name: \"Alice\", toy_id: nil, dog_ids: [#{dog.id.inspect}], parent_id: nil)")
         end
       end
 
@@ -132,7 +140,7 @@ describe "passive record models" do
           let(:post) { Post.create }
           let(:user) { User.create }
 
-          subject(:posts_with_comments_by_user) do
+          subject(:posts_with_comment_by_user) do
             Post.find_by comments: { user: user }
           end
 
@@ -141,8 +149,8 @@ describe "passive record models" do
           end
 
           it 'should find a single record through a nested query' do
-            post = Post.find_by comments: { user: user }
-            expect(post).to eq(post)
+            # post_again = Post.find_by comments: { user: user }
+            expect(post).to eq(posts_with_comment_by_user)
           end
 
           it 'should find multiple records through a nested query' do
@@ -150,7 +158,8 @@ describe "passive record models" do
             another_post.create_comment(user: user)
 
             posts = Post.find_all_by comments: { user: user }
-            expect(posts).to eq([post,another_post])
+            expect(posts.count).to eq(2)
+            # expect(posts).to eq([post,another_post])
           end
         end
       end
@@ -186,9 +195,16 @@ describe "passive record models" do
       it 'should have inverse relationships' do
         toy = child.create_toy
         expect(toy.child).to eq(child)
+
         another_toy = another_child.create_toy
         expect(another_toy.child).to eq(another_child)
       end
+      
+      it 'should assign parents' do
+        toy = Toy.create
+        toy.child = child
+        expect(child.toy).to eq(toy)
+      end
     end
 
     context 'one-to-many relationships' do
@@ -196,13 +212,23 @@ describe "passive record models" do
       let(:another_parent) { Parent.create(children: [another_child]) }
       let(:another_child) { Child.create }
 
-      it 'should create children' do
-        expect { parent.create_child }.to change{ Child.count }.by(1)
-        expect(parent.children).to all(be_a(Child))
+      describe "#xxx<<" do
+        it 'should create children with <<' do
+          child = Child.create
+          expect {parent.children << child}.to change{parent.children.count}.by(1)
+          expect(parent.children).to include(child)
+        end
+      end
+
+      describe "#create_xxx" do
+        it 'should create children' do
+          expect { parent.create_child }.to change{ Child.count }.by(1)
+          expect(parent.children).to all(be_a(Child))
+        end
       end
 
       it 'should assign children on creation' do
-        expect(another_parent.children).to match_array([another_child])
+        expect(another_parent.children.all).to match_array([another_child])
       end
 
       it 'should create inverse relationships' do
@@ -213,7 +239,7 @@ describe "passive record models" do
         expect(another_child.parent).to eq(parent)
 
         expect(child.id).not_to eq(another_child.id)
-        expect(parent.children).to eq([child, another_child])
+        expect(parent.children.all).to eq([child, another_child])
         expect(parent.children_ids).to eq([child.id, another_child.id])
       end
     end
@@ -224,7 +250,7 @@ describe "passive record models" do
 
       it 'should collect children of children' do
         child.create_dog
-        expect(parent.dogs).to all(be_a(Dog))
+        expect(parent.dogs.all).to all(be_a(Dog))
         expect(parent.dogs.count).to eq(1)
         expect(parent.dogs.first).to eq(child.dogs.first)
         expect(parent.dog_ids).to eq([child.dogs.first.id])
@@ -233,7 +259,7 @@ describe "passive record models" do
       it 'should do the nested query example from the readme' do
         child.create_dog
         expect(Dog.find_all_by(child: {parent: parent})).
-          to eq(parent.dogs)
+          to eq(parent.dogs.all)
       end
 
       it 'should work for has-one intermediary relationships' do
@@ -253,7 +279,7 @@ describe "passive record models" do
         post = Post.create
         user = User.create
         Comment.create(post: post, user: user)
-        expect(post.commenters).to eq([user])
+        expect(post.commenters.all).to eq([user])
       end
     end
 
@@ -266,8 +292,8 @@ describe "passive record models" do
         expect(appointment.doctor).to eq(doctor)
         expect(appointment.patient).to eq(patient)
 
-        expect(patient.doctors).to eq([doctor])
-        expect(doctor.patients).to eq([patient])
+        expect(patient.doctors.all).to eq([doctor])
+        expect(doctor.patients.all).to eq([patient])
       end
     end
 
@@ -282,8 +308,8 @@ describe "passive record models" do
         Friendship.create(user: user_a, friend: user_b)
         Friendship.create(user: user_b, friend: user_a)
 
-        expect(user_a.friends).to eq([user_b])
-        expect(user_b.friends).to eq([user_a])
+        expect(user_a.friends.all).to eq([user_b])
+        expect(user_b.friends.all).to eq([user_a])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passive_record
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Joseph Weissman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport