passive_record 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd4210b6d42edbbc3b345887b2a15918d452fdd2
-  data.tar.gz: c5c73ddb836c84ceaaf9290e829f7b7d31ae6e20
+  metadata.gz: ab5ed84f9328d3e424d8a8d15a29c00f080b78b3
+  data.tar.gz: 2f35779eacb19dc155d895b4a526d988f3eafc7f
 SHA512:
-  metadata.gz: c56f0f03af33458ed3a8d0e0d8b8d4795187df9197a71c95625a688f47636b1898c4ce03450142bc4baaedf615c70b34ca075e018e038cdb2731a05e94254f07
-  data.tar.gz: 18e488e25f0ad1a0ca791920160bd0fc7f4c3fb49987f1801fa5f1485aa93dd8463ca5cf8be723ae966a5b43544c69c15aa7ea640335aba4342f4dc6780c1f07
+  metadata.gz: bf7b97feb259d40a4bf9599854c5bbb297aba5cd7c9534547e0d45ee32a4ca80df652667d026786dd12cfad84545745ebd819aa0e9364c5bb59239a44ac07b5d
+  data.tar.gz: 7150fe4460f64351692f83e163b785d36df33eedbcbedb7e0e3c114f43c6c7a836a4ae2f7dbe6c7d818f970d3a8cabfbaaabc957bd4704e3b7e449823c807138

data/README.md

@@ -82,19 +82,6 @@ PassiveRecord may be right for you!
     => [Dog (id: 1)]
 ````
 
-## Requirements
-
-## Install
-
-    $ gem install passive_record
-
-
-## Synopsis
-
-    $ passive_record
-
 ## Copyright
 
 Copyright (c) 2016 Joseph Weissman
-
-See {file:LICENSE.txt} for details.

data/lib/passive_record.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 require 'active_support'
 require 'active_support/core_ext/string/inflections'
 
@@ -36,4 +38,18 @@ module PassiveRecord
   def self.drop_all
     (model_classes + model_classes.flat_map(&:descendants)).each(&:destroy_all)
   end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @config ||= default_configuration
+  end
+
+  def self.default_configuration
+    OpenStruct.new(
+      :identify_using => Identifier
+    )
+  end
 end

data/lib/passive_record/associations.rb

@@ -10,6 +10,16 @@ module PassiveRecord
       @associations += [assn]
     end
 
+    def associations_id_syms
+      @associations&.map do |assn|
+        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
+        end
+      end || []
+    end
+
     def belongs_to(parent_name_sym, opts={})
       target_class_name = opts.delete(:class_name) { (parent_name_sym.to_s).split('_').map(&:capitalize).join }
       association = BelongsToAssociation.new(self, target_class_name, parent_name_sym)

data/lib/passive_record/class_methods.rb

@@ -30,12 +30,13 @@ module PassiveRecord
     end
 
     def find_by(conditions)
-      if conditions.is_a?(Identifier)
-        find_by_id(conditions)
-      elsif conditions.is_a?(Array) && conditions.all? { |c| c.is_a?(Identifier) }
-        find_by_ids(conditions)
-      else
+      #if conditions.is_a?(Array)
+      #  find_by_ids(conditions)
+      if conditions.is_a?(Hash)
         where(conditions).first
+      else # assume we have an identifier/identifiers
+        find(conditions)
+        # find_by_id(conditions)
       end
     end
 
@@ -55,7 +56,7 @@ module PassiveRecord
       instance = new
 
       instance.singleton_class.class_eval { attr_accessor :id }
-      instance.send(:"id=", Identifier.generate(self))
+      instance.send(:"id=", id_factory.generate(self))
 
       register(instance)
 
@@ -75,9 +76,8 @@ module PassiveRecord
     end
 
     protected
-    def find_by_id(_id)
-      key = instances_by_id.keys.detect { |id,_| id == _id }
-      instances_by_id[key] if key
+    def find_by_id(id_to_find)
+      find_by(id: id_to_find)
     end
 
     def find_by_ids(ids)
@@ -93,6 +93,9 @@ module PassiveRecord
       instances_by_id[model.id] = model
       self
     end
-  end
 
+    def id_factory
+      PassiveRecord.configuration.identify_using
+    end
+  end
 end

data/lib/passive_record/core/identifier.rb

@@ -1,8 +1,11 @@
 module PassiveRecord
   class Identifier < Struct.new(:value)
     def self.generate(klass)
-      new(klass.count+1)
-      # TODO maybe config to activate SecureRandom.uuid?
+      new(generate_id_value_for(klass))
+    end
+
+    def self.generate_id_value_for(klass)
+      klass.count+1
     end
 
     def ==(other_id)
@@ -13,4 +16,10 @@ module PassiveRecord
       value
     end
   end
+
+  class SecureRandomIdentifier < Identifier
+    def self.generate_id_value_for(*)
+      SecureRandom.uuid
+    end
+  end
 end

data/lib/passive_record/instance_methods.rb

@@ -2,6 +2,31 @@ module PassiveRecord
   module InstanceMethods
     include PrettyPrinting
 
+    def attribute_names
+      attr_names = instance_variables
+      attr_names += self.class.associations_id_syms
+      attr_names += members rescue []
+      attr_names.reject! { |name| name.to_s.start_with?("@_") }
+      attr_names - blacklisted_attribute_names
+    end
+
+    def blacklisted_attribute_names
+      []
+    end
+
+    # from http://stackoverflow.com/a/8417341/90042
+    def to_h
+      Hash[
+        attribute_names.
+        map do |name| [ 
+          name.to_s.gsub("@","").to_sym,  # key
+          (instance_variable_get(name) rescue send(name))] # val
+        end
+      ]
+    end
+
+    ###
+
     def respond_to?(meth,*args,&blk)
       if find_relation_by_target_name_symbol(meth)
         true
@@ -12,7 +37,7 @@ module PassiveRecord
 
     def method_missing(meth, *args, &blk)
       if (matching_relation = find_relation_by_target_name_symbol(meth))
-        send_relation(matching_relation, meth, *args, &blk)
+        send_relation(matching_relation, meth, *args)
       else
         super(meth,*args,&blk)
       end
@@ -20,7 +45,7 @@ module PassiveRecord
 
     protected
 
-    def send_relation(matching_relation, meth, *args, &blk)
+    def send_relation(matching_relation, meth, *args)
       target_name = matching_relation.association.target_name_symbol.to_s
 
       case meth.to_s
@@ -40,9 +65,9 @@ module PassiveRecord
     end
 
     def relata
-      @_relata ||= self.class.associations.map do |assn|
+      @_relata ||= self.class.associations&.map do |assn|
         assn.to_relation(self)
-      end
+      end || []
     end
 
     private

data/lib/passive_record/pretty_printing.rb

@@ -1,33 +1,11 @@
 module PassiveRecord
   module PrettyPrinting
     def inspect
-      pretty_vars = instance_variables_hash.map do |k,v|
+      pretty_vars = to_h.map do |k,v|
         "#{k.to_s.gsub(/^\@/,'')}: #{v.inspect}"
       end.join(', ')
-      "#{self.class.name} (#{pretty_vars})"
-    end
-
-    protected
-
-    def uninspectable_instance_variables
-      []
-    end
 
-    private
-
-    def inspectable_instance_variables
-      vars = instance_variables
-      vars += members rescue []
-      vars - uninspectable_instance_variables
-    end
-
-    # from http://stackoverflow.com/a/8417341/90042
-    def instance_variables_hash
-      Hash[
-        inspectable_instance_variables.
-        reject { |sym| sym.to_s.start_with?("@_") }.
-        map { |name| [name, (instance_variable_get(name) rescue send(name))] }
-      ]
+      "#{self.class.name} (#{pretty_vars})"
     end
   end
 end

data/lib/passive_record/version.rb

@@ -1,4 +1,4 @@
 module PassiveRecord
   # passive_record version
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/passive_record.gemspec

@@ -7,12 +7,12 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+    lib_dir = File.join(File.dirname(__FILE__),'lib')
+    $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-                  require 'passive_record/version'
-                  PassiveRecord::VERSION
-                end
+    require 'passive_record/version'
+    PassiveRecord::VERSION
+  end
 
   gem.summary     = gemspec['summary']
   gem.description = gemspec['description']

data/spec/passive_record_spec.rb

@@ -16,82 +16,95 @@ describe PassiveRecord do
   end
 end
 
-describe Model do
-  describe "with a simple model including PR" do
+describe "passive record models" do
+  context "with a simple model including PR" do
     let!(:model) { SimpleModel.create(foo: value) }
     let(:value) { 'foo_value' }
 
-    describe "#inspect" do
-      it 'should report attribute details' do
-        expect(model.inspect).to eq("SimpleModel (id: 1, foo: \"foo_value\")")
+    describe "instance methods" do
+      describe "#inspect" do
+        it 'should report attribute details' do
+          expect(model.inspect).to eq("SimpleModel (id: #{model.id.inspect}, foo: \"foo_value\")")
+        end
+
+        it 'should report relations' do
+          dog = Dog.create
+          expect(dog.inspect).to eq("Dog (id: #{dog.id.inspect}, created_at: #{dog.created_at}, sound: \"bark\", child_id: nil)")
+        end
       end
-    end
 
-    describe "#id" do
-      it 'should be retrievable by id' do
-        expect(SimpleModel.find_by(model.id)).to eq(model)
+      describe "#id" do
+        it 'should be retrievable by id' do
+          expect(SimpleModel.find_by(model.id)).to eq(model)
+        end
       end
     end
 
-    context 'should be enumerable over models' do
+    describe "class methods" do
+      describe "#first" do
+        it 'should find the first model' do
+          expect(Model.first).to eq(Model.find(1))
+        end
+      end
+
       describe "#count" do
         it 'should indicate the size of the models list' do
           expect { SimpleModel.create }.to change { SimpleModel.count }.by(1)
         end
       end
-    end
 
-    describe "#create" do
-      it 'should assign attributes' do
-        expect(model.foo).to eq('foo_value')
+      describe "#create" do
+        it 'should assign attributes' do
+          expect(model.foo).to eq('foo_value')
+        end
       end
-    end
 
-    describe "#destroy_all" do
-      before {
-        SimpleModel.create(foo: 'val1')
-        SimpleModel.create(foo: 'val2')
-      }
-
-      it 'should remove all models' do
-        expect { SimpleModel.destroy_all }.to change { SimpleModel.count }.by(-SimpleModel.count)
-      end
-    end
+      describe "#destroy_all" do
+        before {
+          SimpleModel.create(foo: 'val1')
+          SimpleModel.create(foo: 'val2')
+        }
 
-    context 'querying by id' do
-      describe "#find" do
-        subject(:model) {  SimpleModel.create }
-        it 'should lookup a record based on an identifier' do
-          expect(SimpleModel.find(-1)).to eq(nil)
-          expect(SimpleModel.find(model.id)).to eq(model)
+        it 'should remove all models' do
+          expect { SimpleModel.destroy_all }.to change { SimpleModel.count }.by(-SimpleModel.count)
         end
+      end
 
-        it 'should lookup records based on primary key value' do
-          expect(SimpleModel.find(model.id.value)).to eq(model)
-        end
+      context 'querying by id' do
+        describe "#find" do
+          subject(:model) {  SimpleModel.create }
+          it 'should lookup a record based on an identifier' do
+            expect(SimpleModel.find(-1)).to eq(nil)
+            expect(SimpleModel.find(model.id)).to eq(model)
+          end
 
-        it 'should lookup records based on ids' do
-          model_b = SimpleModel.create
-          expect(SimpleModel.find([model.id, model_b.id])).to eq([model, model_b])
-        end
-      end
+          it 'should lookup records based on primary key value' do
+            expect(SimpleModel.find(model.id.value)).to eq(model)
+          end
 
-      describe "#where" do
-        it 'should return a query obj' do
-          expect(SimpleModel.where(id: 'fake_id')).to be_a(PassiveRecord::Core::Query)
+          it 'should lookup records based on ids' do
+            model_b = SimpleModel.create
+            expect(SimpleModel.find([model.id, model_b.id])).to eq([model, model_b])
+          end
         end
 
-        context "queries" do
-          describe "#create" do
-          it 'should create objects' do
-            expect{SimpleModel.where(id: 'new_id').create }.to change{SimpleModel.count}.by(1)
-          end
+        describe "#where" do
+          it 'should return a query obj' do
+            expect(SimpleModel.where(id: 'fake_id')).to be_a(PassiveRecord::Core::Query)
           end
 
-          describe "#first_or_create" do
-            it 'should create the object or return matching' do
-              expect{SimpleModel.where(id: 'another_id').first_or_create }.to change{SimpleModel.count}.by(1)
-              expect{SimpleModel.where(id: 'another_id').first_or_create }.not_to change{SimpleModel.count}
+          context "queries" do
+            describe "#create" do
+              it 'should create objects' do
+                expect{SimpleModel.where(id: 'new_id').create }.to change{SimpleModel.count}.by(1)
+              end
+            end
+
+            describe "#first_or_create" do
+              it 'should create the object or return matching' do
+                expect{SimpleModel.where(id: 'another_id').first_or_create }.to change{SimpleModel.count}.by(1)
+                expect{SimpleModel.where(id: 'another_id').first_or_create }.not_to change{SimpleModel.count}
+              end
             end
           end
         end
@@ -257,5 +270,26 @@ describe Model do
       end
     end
   end
+end
 
+describe "configuration" do
+  describe 'configuring id factory' do
+    context 'with default config' do
+      it 'should generate simple identifiers' do
+        expect(Model.create.id).to be_a(PassiveRecord::Identifier)
+      end
+    end
+
+    context 'with a new id factory configured' do
+      before do
+        PassiveRecord.configure do |passive_records|
+          passive_records.identify_using = PassiveRecord::SecureRandomIdentifier
+        end
+      end
+
+      it 'should generate uuids' do
+        expect(Model.create.id).to be_a(PassiveRecord::SecureRandomIdentifier)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passive_record
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Joseph Weissman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: no-persistence relational algebra