terrestrial 0.3.0 → 0.5.0

data/spec/terrestrial/inspection_string_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+require "terrestrial/inspection_string"
+
+RSpec.describe Terrestrial::InspectionString do
+  class SomeClass
+  end
+
+  describe "#inspect" do
+    let(:test_class) { Class.new }
+    let(:object) { test_class.new }
+
+    context "when #inspectable_properties is not implemented or returns `[]`" do
+      it "returns the regular inspection string" do
+        original_inspection_string = object.inspect
+
+        object.extend(Terrestrial::InspectionString)
+
+        expect(object.inspect).to eq(original_inspection_string)
+      end
+
+      context "when class is not anonymous" do
+        class TestClass; end
+        let(:object) { TestClass.new }
+
+        it "returns the regular inspection string" do
+          original_inspection_string = object.inspect
+
+          object.extend(Terrestrial::InspectionString)
+
+          expect(object.inspect).to eq(original_inspection_string)
+        end
+      end
+    end
+
+    context "when #inspectable_properties returns an array of present instance variables" do
+      class TestClass2
+        include Terrestrial::InspectionString
+
+        def initialize
+          @one = "one value"
+          @two = "two value"
+          @three = "three value"
+        end
+
+        def inspectable_properties
+          [:one, :two]
+        end
+      end
+      let(:object) { TestClass2.new }
+
+      it "contains the specified instance variable names and values" do
+        expect(object.inspect).to include('one="one value" two="two value"')
+      end
+
+      it "does not contain other instance variable values" do
+        expect(object.inspect).not_to include("three")
+      end
+    end
+  end
+end

data/spec/terrestrial/upsert_record_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+require "terrestrial/upsert_record"
+
+RSpec.describe "Terrestrial::UpsertRecord" do
+  subject(:record) { Terrestrial::UpsertRecord.new(mapping, object, attributes, depth) }
+
+  let(:mapping) { double(:mapping) }
+
+  let(:object) { double(:object) }
+  let(:depth) { 1 }
+  let(:attributes) {
+    {
+      id: id,
+      name: name,
+    }
+  }
+
+  let(:id) { double(:id) }
+  let(:name) { double(:name) }
+
+  describe "#if_upsert" do
+    it "invokes the callback" do
+      expect { |callback|
+        record.if_upsert(&callback)
+      }.to yield_with_args(record)
+    end
+  end
+end

data/terrestrial.gemspec

@@ -18,14 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry", "~> 0.10.1"
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "cucumber", "~> 2.4"
-  spec.add_development_dependency "pg", "~> 0.17.1"
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "pry", "~> 0.13"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "cucumber", "~> 3.1"
+  spec.add_development_dependency "pg", "~> 1.0"
 
-  spec.add_dependency "sequel", "~> 4.16"
-  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "sequel", "~> 5.0"
   spec.add_dependency "fetchable", "~> 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terrestrial
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stephen Best
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,112 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.16'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: fetchable
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +138,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- MissingFeatures.md
 - README.md
 - Rakefile
 - TODO.md
@@ -162,16 +147,18 @@ files:
 - features/example.feature
 - features/step_definitions/example_steps.rb
 - lib/terrestrial.rb
-- lib/terrestrial/abstract_record.rb
+- lib/terrestrial/adapters/abstract_adapter.rb
 - lib/terrestrial/adapters/memory_adapter.rb
-- lib/terrestrial/association_loaders.rb
+- lib/terrestrial/adapters/sequel_postgres_adapter.rb
 - lib/terrestrial/collection_mutability_proxy.rb
 - lib/terrestrial/configurations/conventional_association_configuration.rb
 - lib/terrestrial/configurations/conventional_configuration.rb
+- lib/terrestrial/configurations/mapping_config_options_proxy.rb
 - lib/terrestrial/dataset.rb
 - lib/terrestrial/deleted_record.rb
 - lib/terrestrial/dirty_map.rb
 - lib/terrestrial/error.rb
+- lib/terrestrial/functional_pipeline.rb
 - lib/terrestrial/graph_loader.rb
 - lib/terrestrial/graph_serializer.rb
 - lib/terrestrial/identity_map.rb
@@ -183,15 +170,21 @@ files:
 - lib/terrestrial/one_to_many_association.rb
 - lib/terrestrial/public_conveniencies.rb
 - lib/terrestrial/query_order.rb
+- lib/terrestrial/record.rb
 - lib/terrestrial/relation_mapping.rb
 - lib/terrestrial/relational_store.rb
 - lib/terrestrial/serializer.rb
 - lib/terrestrial/struct_factory.rb
 - lib/terrestrial/subset_queries_proxy.rb
-- lib/terrestrial/upserted_record.rb
+- lib/terrestrial/upsert_record.rb
 - lib/terrestrial/version.rb
+- spec/automatic_timestamps_spec.rb
+- spec/changes_api_spec.rb
 - spec/config_override_spec.rb
 - spec/custom_serializers_spec.rb
+- spec/database_default_fields_spec.rb
+- spec/database_generated_id_spec.rb
+- spec/database_owned_fields_and_timestamps_spec.rb
 - spec/deletion_spec.rb
 - spec/error_handling/factory_error_handling_spec.rb
 - spec/error_handling/serialization_error_spec.rb
@@ -212,15 +205,18 @@ files:
 - spec/support/object_graph_setup.rb
 - spec/support/object_store_setup.rb
 - spec/support/seed_data_setup.rb
+- spec/support/seed_records.rb
 - spec/support/sequel_test_support.rb
 - spec/terrestrial/abstract_record_spec.rb
+- spec/terrestrial/adapters/sequel_postgres_adapter_spec.rb
 - spec/terrestrial/collection_mutability_proxy_spec.rb
 - spec/terrestrial/deleted_record_spec.rb
 - spec/terrestrial/dirty_map_spec.rb
+- spec/terrestrial/functional_pipeline_spec.rb
+- spec/terrestrial/inspection_string_spec.rb
 - spec/terrestrial/lazy_collection_spec.rb
 - spec/terrestrial/lazy_object_proxy_spec.rb
-- spec/terrestrial/public_conveniencies_spec.rb
-- spec/terrestrial/upserted_record_spec.rb
+- spec/terrestrial/upsert_record_spec.rb
 - terrestrial.gemspec
 homepage: https://github.com/bestie/terrestrial
 licenses:
@@ -241,8 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A data mapper ORM for Ruby
@@ -250,8 +245,13 @@ test_files:
 - features/env.rb
 - features/example.feature
 - features/step_definitions/example_steps.rb
+- spec/automatic_timestamps_spec.rb
+- spec/changes_api_spec.rb
 - spec/config_override_spec.rb
 - spec/custom_serializers_spec.rb
+- spec/database_default_fields_spec.rb
+- spec/database_generated_id_spec.rb
+- spec/database_owned_fields_and_timestamps_spec.rb
 - spec/deletion_spec.rb
 - spec/error_handling/factory_error_handling_spec.rb
 - spec/error_handling/serialization_error_spec.rb
@@ -272,12 +272,15 @@ test_files:
 - spec/support/object_graph_setup.rb
 - spec/support/object_store_setup.rb
 - spec/support/seed_data_setup.rb
+- spec/support/seed_records.rb
 - spec/support/sequel_test_support.rb
 - spec/terrestrial/abstract_record_spec.rb
+- spec/terrestrial/adapters/sequel_postgres_adapter_spec.rb
 - spec/terrestrial/collection_mutability_proxy_spec.rb
 - spec/terrestrial/deleted_record_spec.rb
 - spec/terrestrial/dirty_map_spec.rb
+- spec/terrestrial/functional_pipeline_spec.rb
+- spec/terrestrial/inspection_string_spec.rb
 - spec/terrestrial/lazy_collection_spec.rb
 - spec/terrestrial/lazy_object_proxy_spec.rb
-- spec/terrestrial/public_conveniencies_spec.rb
-- spec/terrestrial/upserted_record_spec.rb
+- spec/terrestrial/upsert_record_spec.rb

data/MissingFeatures.md

@@ -1,64 +0,0 @@
-# Missing features
-
-The following features not included in Terrestrial are omitted purposefully to
-keep the library simple and encourage good practices in application code.
-
-Please open an issue if you feel like any of these features are essential or if
-you think you can contribute to a solution please open an issue to discuss.
-
-## Coercion
-
-Database supported types will be returned as expected, `Fixnum`, `DateTime`, `nil` etc.
-Should you wish to enhance this data, every row is passed into the mapping's
-factory function where you have the opportunity to do arbitrary transformations
-before instantiating the domain object.
-
-\*see note on transforming row data
-
-## Validation
-
-This is the concern of your domain model and/or application boundaries.
-Terrestrial allows you to persist any object you wish assuming schema
-compatibility.
-
-## Database column name aliasing
-
-While at first glance this is a simple feature, the abstraction starts to leak
-when the using the query interface and guaranteeing all queries are substituted
-perfectly is beyond the scope of the current version.
-
-Should you wish to simply pass a column's key with a different parameter name
-then you can again lean on the factory function to transform the row's data
-before the domain object receives it.
-
-\*see note on transforming row data
-
-## Cascade deletion
-
-This is chiefly a data concern and is handled by a good database more
-efficiently and effectively than any ORM could hope.
-
-## Database generated IDs and timestamps
-
-While database generated values may work, available only after an object is
-retrieved, they are not currently supported.
-
-Data important to your domain should be generated in your application layer.
-UUIDs make much more flexible identifiers for domain objects and further enable
-decoupling and fast tests.
-
-Timestamps are useful and important to most applications however if they are
-used in your domain they should be pushed from explicitly from application
-layer. You should again find this affords you more flexibility and decoupling.
-
-There is absolutely nothing wrong with data added at time of persistence for
-auditing purposes but Terrestrial will make you actively decide whether this
-data should be available to the domain and what should be explicitly added.
-
-\* Transforming row data
-
-Adding a custom factory method to transform row data before passing it to the
-domain layer is highly encouraged. However, ensure that for each custom factory
-a serializer function is also supplied that Terrestrial can use to reverse the
-operation for persistence.
-

data/lib/terrestrial/abstract_record.rb

@@ -1,99 +0,0 @@
-require "forwardable"
-require "set"
-
-module Terrestrial
-  class AbstractRecord
-    extend Forwardable
-    include Comparable
-    include Enumerable
-
-    def initialize(namespace, identity_fields, attributes = {}, depth = NoDepth)
-      @namespace = namespace
-      @identity_fields = identity_fields
-      @attributes = attributes
-      @depth = depth
-    end
-
-    attr_reader :namespace, :identity_fields, :attributes, :depth
-    private :attributes
-
-    def_delegators :to_h, :fetch
-
-    def if_upsert(&block)
-      self
-    end
-
-    def if_delete(&block)
-      self
-    end
-
-    def each(&block)
-      to_h.each(&block)
-    end
-
-    def keys
-      attributes.keys
-    end
-
-    def identity
-      attributes.select { |k,_v| identity_fields.include?(k) }
-    end
-
-    def non_identity_attributes
-      attributes.reject { |k| identity.include?(k) }
-    end
-
-    def merge(more_data)
-      new_with_raw_data(attributes.merge(more_data))
-    end
-
-    def merge!(more_data)
-      attributes.merge!(more_data)
-    end
-
-    def reject(&block)
-      new_with_raw_data(non_identity_attributes.reject(&block).merge(identity))
-    end
-
-    def to_h
-      attributes.to_h
-    end
-
-    def empty?
-      non_identity_attributes.empty?
-    end
-
-    def ==(other)
-      self.class === other &&
-        [operation, to_h] == [other.operation, other.to_h]
-    end
-
-    def <=>(other)
-      depth <=> other.depth
-    end
-
-    def subset?(other_record)
-      namespace == other_record.namespace &&
-        to_set.subset?(other_record.to_set)
-    end
-
-    protected
-
-    def operation
-      NoOp
-    end
-
-    def to_set
-      Set.new(attributes.to_a)
-    end
-
-    private
-
-    NoOp = Module.new
-    NoDepth = Module.new
-
-    def new_with_raw_data(new_raw_data)
-      self.class.new(namespace, identity_fields, new_raw_data, depth)
-    end
-  end
-end