zermelo 1.1.0 → 1.2.0

data/spec/lib/zermelo/records/instance_methods_spec.rb

@@ -0,0 +1,206 @@
+require 'spec_helper'
+require 'zermelo/records/redis'
+require 'zermelo/records/influxdb'
+
+describe Zermelo::Records::InstMethods do
+
+  shared_examples "it supports ActiveModel instance methods", :instance_methods => true do
+
+    it "is invalid without a name" do
+      example = example_class.new(:id => '1')
+      expect(example).not_to be_valid
+
+      errs = example.errors
+      expect(errs).not_to be_nil
+      expect(errs[:name]).to eq(["can't be blank"])
+    end
+
+    it 'saves a record' do
+      example = example_class.new(:id => '1', :name => 'John Smith')
+      expect(example).to be_valid
+      expect(example_class.count).to eq(0)
+      expect(example.save).to be true
+      expect(example_class.count).to eq(1)
+    end
+
+    it "updates a value" do
+      create_example(:id => '1', :name => 'Jane Doe')
+
+      example = example_class.find_by_id('1')
+      expect(example).not_to be_nil
+
+      example.name = 'John Smith'
+      example.save
+
+      other_example = example_class.find_by_id('1')
+      expect(other_example).not_to be_nil
+      expect(other_example.name).to eq('John Smith')
+    end
+
+    it 'raises an RecordInvalid exception if validation fails while saving' do
+      example = example_class.new(:id => '1')
+
+      expect {
+        example.save!
+      }.to raise_error(Zermelo::Records::Errors::RecordInvalid)
+    end
+
+    it 'raises a RecordNotSaved exception if a callback blocks saving' do
+      example = example_class.new(:id => '1', :name => 'not_saving')
+
+      expect {
+        example.save!
+      }.to raise_error(Zermelo::Records::Errors::RecordNotSaved)
+    end
+
+    it "resets changed state on refresh" do
+      create_example(:id => '8', :name => 'John Jones')
+      example = example_class.find_by_id('8')
+
+      example.name = "King Henry VIII"
+      expect(example.changed).to include('name')
+      expect(example.changes).to eq({'name' => ['John Jones', 'King Henry VIII']})
+
+      example.refresh
+      expect(example.changed).to be_empty
+      expect(example.changes).to be_empty
+    end
+
+    it "stores a string as an attribute value"
+    it "stores an integer as an attribute value"
+    it "stores a timestamp as an attribute value"
+    it "stores a boolean as an attribute value"
+
+    it "stores a list as an attribute value"
+    it "stores a set as an attribute value"
+    it "stores a hash as an attribute value"
+
+    it 'destroys a record' do
+      create_example(:id => '1', :name => 'Jane Doe')
+
+      example = example_class.find_by_id('1')
+      example.destroy
+      example_chk = example_class.find_by_id('1')
+      expect(example_chk).to be_nil
+    end
+  end
+
+  context 'redis', :redis => true, :instance_methods => true do
+
+    module ZermeloExamples
+      class InstanceMethodsRedis
+        include Zermelo::Records::Redis
+
+        define_attributes :name => :string
+        validates :name, :presence => true
+
+        before_create :fail_if_not_saving
+        def fail_if_not_saving; !('not_saving'.eql?(self.name)); end
+      end
+    end
+
+    let(:redis) { Zermelo.redis }
+
+    let(:example_class) { ZermeloExamples::InstanceMethodsRedis }
+
+    let(:ek) { 'instance_methods_redis' }
+
+    def create_example(attrs = {})
+      redis.hmset("#{ek}:#{attrs[:id]}:attrs", {'name' => attrs[:name]}.to_a.flatten)
+      redis.sadd("#{ek}::attrs:ids", attrs[:id])
+    end
+
+    it 'creates data on record save' do
+      example = example_class.new(:id => '1', :name => 'John Smith')
+      expect(example).to be_valid
+      expect(example.save).to be true
+
+      expect(redis.keys('*')).to match_array([
+        "#{ek}::attrs:ids",
+        "#{ek}:1:attrs"
+      ])
+      expect(redis.smembers("#{ek}::attrs:ids")).to eq(['1'])
+      expect(redis.hgetall("#{ek}:1:attrs")).to eq(
+        'name' => 'John Smith'
+      )
+    end
+
+    it "updates a record's attributes" do
+      create_example(:id => '8', :name => 'John Jones')
+
+      example = example_class.find_by_id('8')
+      example.name = 'Jane Janes'
+      expect(example.save).to be true
+
+      expect(redis.keys('*')).to match_array([
+        "#{ek}::attrs:ids",
+        "#{ek}:8:attrs"
+      ])
+      expect(redis.smembers("#{ek}::attrs:ids")).to eq(['8'])
+      expect(redis.hgetall("#{ek}:8:attrs")).to eq(
+        'name' => 'Jane Janes'
+      )
+    end
+
+    it "deletes a record's attributes" do
+      create_example(:id => '8', :name => 'John Jones')
+
+      expect(redis.keys('*')).to match_array([
+        "#{ek}::attrs:ids",
+        "#{ek}:8:attrs",
+      ])
+
+      example = example_class.find_by_id('8')
+      example.destroy
+
+      expect(redis.keys('*')).to eq([])
+    end
+
+  end
+
+  context 'influxdb', :influxdb => true, :instance_methods => true do
+
+    module ZermeloExamples
+      class InstanceMethodsInfluxDB
+        include Zermelo::Records::InfluxDB
+
+        define_attributes :name   => :string
+        validates :name, :presence => true
+
+        before_create :fail_if_not_saving
+        def fail_if_not_saving; !('not_saving'.eql?(self.name)); end
+      end
+    end
+
+    let(:influxdb) { Zermelo.influxdb }
+
+    let(:example_class) { ZermeloExamples::InstanceMethodsInfluxDB }
+
+    let(:ek) { 'instance_methods_influx_db' }
+
+    def create_example(attrs = {})
+      Zermelo.influxdb.write_point("#{ek}/#{attrs[:id]}", attrs)
+    end
+
+    it 'creates data on record save' do
+      begin
+        data = Zermelo.influxdb.query("select * from /#{ek}\\/1/")["#{ek}/1"]
+        expect(data).to be_nil
+      rescue InfluxDB::Error => ide
+        # only happens occasionally, with an empty time series by that name
+        raise unless /^Couldn't look up columns$/ === ide.message
+      end
+
+      example = example_class.new(:id => '1', :name => 'John Smith')
+      expect(example).to be_valid
+      expect(example.save).to be true
+
+      data = Zermelo.influxdb.query("select * from /#{ek}\\/1/")["#{ek}/1"]
+      expect(data).to be_an(Array)
+      expect(data.size).to eql(1)
+      record = data.first
+      expect(record).to be_a(Hash)
+      expect(record).to include("name"=>"John Smith", "id"=>"1")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -36,7 +36,15 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
+  # config.order = 'random'
+
+  config.around(:each, :logger => true) do |example|
+    MockLogger.configure_log('zermelo')
+    Zermelo.logger = MockLogger.new
+    example.run
+    puts Zermelo.logger.messages.compact.join("\n")
+    Zermelo.logger.clear
+  end
 
   config.before(:all, :redis => true) do
     Zermelo.redis = ::Redis.new(:db => 14)

data/spec/support/mock_logger.rb

@@ -0,0 +1,48 @@
+class MockLogger
+  attr_accessor :messages, :errors
+
+  def self.configure_log(name, config = {})
+    @name = name
+  end
+
+  def initialize
+    @messages = []
+    @errors   = []
+  end
+
+  def clear
+    @messages.clear
+    @errors.clear
+  end
+
+  %w(debug info warn).each do |level|
+    class_eval <<-RUBY
+      def #{level}(msg = nil, &block)
+        msg = yield if msg.nil? && block_given?
+        @messages << '[#{level.upcase}] :: ' +
+          (self.class.instance_variable_get('@name') || 'flapjack') + ' :: ' + msg
+      end
+    RUBY
+  end
+
+  %w(error fatal).each do |level|
+    class_eval <<-ERRORS
+      def #{level}(msg = nil, &block)
+        msg = yield if msg.nil? && block_given?
+        @messages << '[#{level.upcase}] :: ' +
+          (self.class.instance_variable_get('@name') || 'flapjack') + ' :: ' + msg
+        @errors << '[#{level.upcase}] :: ' +
+          (self.class.instance_variable_get('@name') || 'flapjack') + ' :: ' + msg
+      end
+    ERRORS
+  end
+
+  %w(debug info warn error fatal).each do |level|
+    class_eval <<-LEVELS
+      def #{level}?
+        true
+      end
+    LEVELS
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zermelo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ali Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -69,55 +69,48 @@ files:
 - Rakefile
 - lib/zermelo.rb
 - lib/zermelo/associations/association_data.rb
-- lib/zermelo/associations/belongs_to.rb
 - lib/zermelo/associations/class_methods.rb
-- lib/zermelo/associations/has_and_belongs_to_many.rb
-- lib/zermelo/associations/has_many.rb
-- lib/zermelo/associations/has_one.rb
-- lib/zermelo/associations/has_sorted_set.rb
 - lib/zermelo/associations/index.rb
 - lib/zermelo/associations/index_data.rb
+- lib/zermelo/associations/multiple.rb
+- lib/zermelo/associations/range_index.rb
+- lib/zermelo/associations/singular.rb
 - lib/zermelo/associations/unique_index.rb
-- lib/zermelo/backends/base.rb
-- lib/zermelo/backends/influxdb_backend.rb
-- lib/zermelo/backends/redis_backend.rb
-- lib/zermelo/filters/base.rb
-- lib/zermelo/filters/influxdb_filter.rb
-- lib/zermelo/filters/redis_filter.rb
+- lib/zermelo/backend.rb
+- lib/zermelo/backends/influxdb.rb
+- lib/zermelo/backends/redis.rb
+- lib/zermelo/backends/stub.rb
+- lib/zermelo/filter.rb
+- lib/zermelo/filters/index_range.rb
+- lib/zermelo/filters/influxdb.rb
+- lib/zermelo/filters/redis.rb
 - lib/zermelo/filters/steps/base_step.rb
 - lib/zermelo/filters/steps/list_step.rb
 - lib/zermelo/filters/steps/set_step.rb
 - lib/zermelo/filters/steps/sort_step.rb
-- lib/zermelo/filters/steps/sorted_set_step.rb
 - lib/zermelo/locks/no_lock.rb
 - lib/zermelo/locks/redis_lock.rb
-- lib/zermelo/records/base.rb
+- lib/zermelo/record.rb
+- lib/zermelo/records/attributes.rb
 - lib/zermelo/records/class_methods.rb
 - lib/zermelo/records/errors.rb
-- lib/zermelo/records/influxdb_record.rb
+- lib/zermelo/records/influxdb.rb
 - lib/zermelo/records/instance_methods.rb
 - lib/zermelo/records/key.rb
-- lib/zermelo/records/redis_record.rb
+- lib/zermelo/records/redis.rb
+- lib/zermelo/records/stub.rb
 - lib/zermelo/records/type_validator.rb
 - lib/zermelo/version.rb
-- spec/lib/zermelo/associations/belongs_to_spec.rb
-- spec/lib/zermelo/associations/has_many_spec.rb
-- spec/lib/zermelo/associations/has_one_spec.rb
-- spec/lib/zermelo/associations/has_sorted_set.spec.rb
 - spec/lib/zermelo/associations/index_spec.rb
+- spec/lib/zermelo/associations/multiple_spec.rb
+- spec/lib/zermelo/associations/range_index_spec.rb
+- spec/lib/zermelo/associations/singular_spec.rb
 - spec/lib/zermelo/associations/unique_index_spec.rb
-- spec/lib/zermelo/backends/influxdb_backend_spec.rb
-- spec/lib/zermelo/backends/moneta_backend_spec.rb
-- spec/lib/zermelo/filters/influxdb_filter_spec.rb
-- spec/lib/zermelo/filters/redis_filter_spec.rb
+- spec/lib/zermelo/filter_spec.rb
 - spec/lib/zermelo/locks/redis_lock_spec.rb
-- spec/lib/zermelo/records/influxdb_record_spec.rb
-- spec/lib/zermelo/records/key_spec.rb
-- spec/lib/zermelo/records/redis_record_spec.rb
-- spec/lib/zermelo/records/type_validator_spec.rb
-- spec/lib/zermelo/version_spec.rb
-- spec/lib/zermelo_spec.rb
+- spec/lib/zermelo/records/instance_methods_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_logger.rb
 - spec/support/profile_all_formatter.rb
 - spec/support/uncolored_doc_formatter.rb
 - zermelo.gemspec
@@ -142,28 +135,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Redis and/or InfluxDB, and the related gems
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: ActiveModel-based set-theoretic ORM for Redis/InfluxDB
 test_files:
-- spec/lib/zermelo/associations/belongs_to_spec.rb
-- spec/lib/zermelo/associations/has_many_spec.rb
-- spec/lib/zermelo/associations/has_one_spec.rb
-- spec/lib/zermelo/associations/has_sorted_set.spec.rb
 - spec/lib/zermelo/associations/index_spec.rb
+- spec/lib/zermelo/associations/multiple_spec.rb
+- spec/lib/zermelo/associations/range_index_spec.rb
+- spec/lib/zermelo/associations/singular_spec.rb
 - spec/lib/zermelo/associations/unique_index_spec.rb
-- spec/lib/zermelo/backends/influxdb_backend_spec.rb
-- spec/lib/zermelo/backends/moneta_backend_spec.rb
-- spec/lib/zermelo/filters/influxdb_filter_spec.rb
-- spec/lib/zermelo/filters/redis_filter_spec.rb
+- spec/lib/zermelo/filter_spec.rb
 - spec/lib/zermelo/locks/redis_lock_spec.rb
-- spec/lib/zermelo/records/influxdb_record_spec.rb
-- spec/lib/zermelo/records/key_spec.rb
-- spec/lib/zermelo/records/redis_record_spec.rb
-- spec/lib/zermelo/records/type_validator_spec.rb
-- spec/lib/zermelo/version_spec.rb
-- spec/lib/zermelo_spec.rb
+- spec/lib/zermelo/records/instance_methods_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_logger.rb
 - spec/support/profile_all_formatter.rb
 - spec/support/uncolored_doc_formatter.rb

data/lib/zermelo/associations/belongs_to.rb

@@ -1,115 +0,0 @@
-# The other side of a has_one, has_many, or has_sorted_set association
-
-module Zermelo
-  module Associations
-    class BelongsTo
-
-      # NB a single instance of this class doesn't need to care about the hash
-      # used for storage, that should be done in the save method of the parent
-
-      def initialize(parent, name)
-        @parent = parent
-        @name   = name
-
-        @backend = parent.send(:backend)
-
-        @record_ids_key = Zermelo::Records::Key.new(
-          :klass  => parent.class,
-          :id     => parent.id,
-          :name   => 'belongs_to',
-          :type   => :hash,
-          :object => :association
-        )
-
-        parent.class.send(:with_association_data, name.to_sym) do |data|
-          @associated_class = data.data_klass
-          @lock_klasses     = [data.data_klass] + data.related_klasses
-          @inverse          = data.inverse
-          @callbacks        = data.callbacks
-        end
-
-        raise ':inverse_of must be set' if @inverse.nil?
-        @inverse_key = "#{name}_id"
-      end
-
-      def value=(record)
-        if record.nil?
-          @parent.class.lock(*@lock_klasses) do
-            r = @associated_class.send(:load, @backend.get(@record_ids_key)[@inverse_key.to_s])
-            bc = @callbacks[:before_clear]
-            if bc.nil? || !@parent.respond_to?(bc) || !@parent.send(bc, r).is_a?(FalseClass)
-              new_txn = @backend.begin_transaction
-              @backend.delete(@record_ids_key, @inverse_key)
-              @backend.commit_transaction if new_txn
-              ac = @callbacks[:after_clear]
-              @parent.send(ac, r) if !ac.nil? && @parent.respond_to?(ac)
-            end
-          end
-        else
-          raise 'Invalid record class' unless record.is_a?(@associated_class)
-          raise 'Record must have been saved' unless record.persisted?
-          @parent.class.lock(*@lock_klasses) do
-            bs = @callbacks[:before_set]
-            if bs.nil? || !@parent.respond_to?(bs) || !@parent.send(bs, r).is_a?(FalseClass)
-              new_txn = @backend.begin_transaction
-              @backend.add(@record_ids_key, @inverse_key => record.id)
-              @backend.commit_transaction if new_txn
-              as = @callbacks[:after_set]
-              @parent.send(as, record) if !as.nil? && @parent.respond_to?(as)
-            end
-          end
-        end
-      end
-
-      def value
-        @parent.class.lock(*@lock_klasses) do
-          # FIXME uses hgetall, need separate getter for hash/list/set
-          if id = @backend.get(@record_ids_key)[@inverse_key.to_s]
-          # if id = @backend.get_hash_value(@record_ids_key, @inverse_key.to_s)
-            @associated_class.send(:load, id)
-          else
-            nil
-          end
-        end
-      end
-
-      private
-
-      # on_remove already runs inside a lock & transaction
-      def on_remove
-        unless value.nil?
-          assoc = value.send("#{@inverse}_proxy".to_sym)
-          if assoc.respond_to?(:delete)
-            assoc.send(:delete, @parent)
-          elsif assoc.respond_to?(:value=)
-            assoc.send(:value=, nil)
-          end
-        end
-        @backend.clear(@record_ids_key)
-      end
-
-      def self.associated_ids_for(backend, klass, name, inversed, *these_ids)
-        these_ids.each_with_object({}) do |this_id, memo|
-          key = Zermelo::Records::Key.new(
-            :klass  => klass,
-            :id     => this_id,
-            :name   => 'belongs_to',
-            :type   => :hash,
-            :object => :association
-          )
-
-          assoc_id = backend.get(key)["#{name}_id"]
-          # assoc_id = backend.get_hash_value(key, "#{name}_id")
-
-          if inversed
-            memo[assoc_id] ||= []
-            memo[assoc_id] << this_id
-          else
-            memo[this_id] = assoc_id
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/zermelo/associations/has_and_belongs_to_many.rb

@@ -1,128 +0,0 @@
-require 'forwardable'
-
-# much like a has_many, but with different add/remove behaviour, as it's paired
-# with another has_and_belongs_to_many association. both sides must set the
-# inverse association name.
-
-module Zermelo
-  module Associations
-    class HasAndBelongsToMany
-
-      extend Forwardable
-
-      def_delegators :filter, :intersect, :union, :diff, :sort,
-                       :find_by_id, :find_by_ids, :find_by_id!, :find_by_ids!,
-                       :page, :all, :each, :collect, :map,
-                       :select, :find_all, :reject, :destroy_all,
-                       :ids, :count, :empty?, :exists?,
-                       :associated_ids_for
-
-      def initialize(parent, name)
-        @parent = parent
-
-        @backend = parent.send(:backend)
-
-        @record_ids_key = Zermelo::Records::Key.new(
-          :klass  => parent.class,
-          :id     => parent.id,
-          :name   => "#{name}_ids",
-          :type   => :set,
-          :object => :association
-        )
-
-        parent.class.send(:with_association_data, name.to_sym) do |data|
-          @associated_class = data.data_klass
-          @lock_klasses     = [data.data_klass] + data.related_klasses
-          @inverse          = data.inverse
-          @callbacks        = data.callbacks
-        end
-      end
-
-      def <<(record)
-        add(record)
-        self  # for << 'a' << 'b'
-      end
-
-      def add(*records)
-        raise 'No records to add' if records.empty?
-        raise 'Invalid record class' unless records.all? {|r| r.is_a?(@associated_class)}
-        raise "Record(s) must have been saved" unless records.all? {|r| r.persisted?}
-        @parent.class.lock(*@lock_klasses) do
-          ba = @callbacks[:before_add]
-          if ba.nil? || !@parent.respond_to?(ba) || !@parent.send(ba, *records).is_a?(FalseClass)
-            records.each do |record|
-              @associated_class.send(:load, record.id).send(@inverse.to_sym).
-                send(:add_without_inverse, @parent)
-            end
-            add_without_inverse(*records)
-            aa = @callbacks[:after_add]
-            @parent.send(aa, *records) if !aa.nil? && @parent.respond_to?(aa)
-          end
-        end
-      end
-
-      # TODO support dependent delete, for now just deletes the association
-      def delete(*records)
-        raise 'No records to delete' if records.empty?
-        raise 'Invalid record class' unless records.all? {|r| r.is_a?(@associated_class)}
-        raise "Record(s) must have been saved" unless records.all? {|r| r.persisted?}
-        @parent.class.lock(*@lock_klasses) do
-          br = @callbacks[:before_remove]
-          if br.nil? || !@parent.respond_to?(br) || !@parent.send(br, *records).is_a?(FalseClass)
-            records.each do |record|
-              @associated_class.send(:load, record.id).send(@inverse.to_sym).
-                send(:delete_without_inverse, @parent)
-            end
-            delete_without_inverse(*records)
-            ar = @callbacks[:after_remove]
-            @parent.send(ar, *records) if !ar.nil? && @parent.respond_to?(ar)
-          end
-        end
-      end
-
-      private
-
-      def add_without_inverse(*records)
-        new_txn = @backend.begin_transaction
-        @backend.add(@record_ids_key, records.map(&:id))
-        @backend.commit_transaction if new_txn
-      end
-
-      def delete_without_inverse(*records)
-        new_txn = @backend.begin_transaction
-        @backend.delete(@record_ids_key, records.map(&:id))
-        @backend.commit_transaction if new_txn
-      end
-
-      # associated will be the other side of the HaBTM; on_remove is always
-      # called inside a lock
-      def on_remove
-        ids.each do |record_id|
-          @associated_class.send(:load, record_id).send(@inverse.to_sym).
-            send(:delete_without_inverse, @parent)
-        end
-        @backend.purge(@record_ids_key)
-      end
-
-      # creates a new filter class each time it's called, to store the
-      # state for this particular filter chain
-      def filter
-        @backend.filter(@record_ids_key, @associated_class)
-      end
-
-      def self.associated_ids_for(backend, klass, name, *these_ids)
-        these_ids.each_with_object({}) do |this_id, memo|
-          key = Zermelo::Records::Key.new(
-            :klass  => klass,
-            :id     => this_id,
-            :name   => "#{name}_ids",
-            :type   => :set,
-            :object => :association
-          )
-          memo[this_id] = backend.get(key)
-        end
-      end
-
-    end
-  end
-end