sequel_mapper 0.0.1

data/lib/sequel_mapper/queryable_association_proxy.rb

@@ -0,0 +1,23 @@
+class QueryableAssociationProxy
+  def initialize(database_enum, loader)
+    @database_enum = database_enum
+    @loader = loader
+  end
+
+  attr_reader :database_enum, :loader
+  private     :database_enum, :loader
+
+  extend Forwardable
+  def_delegators :database_enum, :where
+
+  def where(criteria)
+    @database_enum = database_enum.where(criteria)
+    self
+  end
+
+  def each(&block)
+    database_enum
+      .map(&loader)
+      .each(&block)
+  end
+end

data/lib/sequel_mapper/struct_factory.rb

@@ -0,0 +1,17 @@
+module SequelMapper
+  class StructFactory
+    def initialize(struct_class)
+      @constructor = struct_class.method(:new)
+      @members = struct_class.members
+    end
+
+    attr_reader :constructor, :members
+    private     :constructor, :members
+
+    def call(data)
+      constructor.call(
+        *members.map { |m| data.fetch(m, nil) }
+      )
+    end
+  end
+end

data/lib/sequel_mapper/version.rb

@@ -0,0 +1,3 @@
+module SequelMapper
+  VERSION = "0.0.1"
+end

data/sequel_mapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel_mapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel_mapper"
+  spec.version       = SequelMapper::VERSION
+  spec.authors       = ["Stephen Best"]
+  spec.email         = ["bestie@gmail.com"]
+  spec.summary       = %q{A data mapper built on top of the Sequel database toolkit}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/bestie/sequel_mapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "pg", "~> 0.17.1"
+
+  spec.add_dependency "sequel", "~> 4.16"
+end

data/spec/graph_persistence_spec.rb

@@ -0,0 +1,287 @@
+require "spec_helper"
+
+require "sequel_mapper"
+require "support/graph_fixture"
+
+RSpec.describe "Graph persistence" do
+  include SequelMapper::GraphFixture
+
+  subject(:graph) {
+    SequelMapper::Graph.new(
+      top_level_namespace: :users,
+      datastore: datastore,
+      relation_mappings: relation_mappings,
+    )
+  }
+
+  let(:user) {
+    graph.where(id: "user/1").fetch(0)
+  }
+
+  context "without accessing associations" do
+    let(:modified_email) { "bestie+modified@gmail.com" }
+
+    it "saves the root object" do
+      user.email = modified_email
+      graph.save(user)
+
+      expect(datastore).to have_persisted(
+        :users,
+        hash_including(
+          id: "user/1",
+          email: modified_email,
+        )
+      )
+    end
+
+    it "doesn't send associated objects to the database as columns" do
+      user.email = modified_email
+      graph.save(user)
+
+      expect(datastore).not_to have_persisted(
+        :users,
+        hash_including(
+          posts: anything,
+        )
+      )
+    end
+  end
+
+  context "modify shallow has many associated object" do
+    let(:post) { user.posts.first }
+    let(:modified_post_body) { "modified ur body" }
+
+    it "saves the associated object" do
+      post.body = modified_post_body
+      graph.save(user)
+
+      expect(datastore).to have_persisted(
+        :posts,
+        hash_including(
+          id: post.id,
+          subject: post.subject,
+          author_id: post.author.id,
+          body: modified_post_body,
+        )
+      )
+    end
+  end
+
+  context "modify deeply nested has many associated object" do
+    let(:comment) {
+      user.posts.first.comments.to_a.last
+    }
+
+    let(:modified_comment_body) { "body moving, body moving" }
+
+    it "saves the associated object" do
+      comment.body = modified_comment_body
+      graph.save(user)
+
+      expect(datastore).to have_persisted(
+        :comments,
+        hash_including(
+          {
+            id: "comment/2",
+            post_id: "post/1",
+            commenter_id: "user/1",
+            body: modified_comment_body,
+          }
+        )
+      )
+    end
+  end
+
+  context "modify the foreign_key of an object" do
+    let(:original_author) { user }
+    let(:new_author)      { graph.where(id: "user/2").first }
+    let(:post)            { original_author.posts.first }
+
+    it "persists the change in ownership" do
+      post.author = new_author
+      graph.save(user)
+
+      expect(datastore).to have_persisted(
+        :posts,
+        hash_including(
+          id: post.id,
+          author_id: new_author.id,
+        )
+      )
+    end
+
+    it "removes the object form the original graph" do
+      post.author = new_author
+      graph.save(user)
+
+      expect(original_author.posts.to_a.map(&:id))
+        .not_to include("posts/1")
+    end
+
+    it "adds the object to the appropriate graph" do
+      post.author = new_author
+      graph.save(user)
+
+      expect(new_author.posts.to_a.map(&:id))
+        .to include("post/1")
+    end
+  end
+
+  context "add a node to a has many assocation" do
+    let(:new_post_attrs) {
+      {
+        id: "posts/neu",
+        author: user,
+        subject: "I am new",
+        body: "new body",
+        comments: [],
+        categories: [],
+      }
+    }
+
+    let(:new_post) {
+      SequelMapper::StructFactory.new(
+        SequelMapper::GraphFixture::Post
+      ).call(new_post_attrs)
+    }
+
+    it "adds the object to the graph" do
+      user.posts.push(new_post)
+
+      expect(user.posts).to include(new_post)
+    end
+
+    it "persists the object" do
+      user.posts.push(new_post)
+      graph.save(user)
+
+      expect(datastore).to have_persisted(
+        :posts,
+        hash_including(
+          id: "posts/neu",
+          author_id: user.id,
+          subject: "I am new",
+        )
+      )
+    end
+  end
+
+  context "remove an object from a has many association" do
+    let(:post) { user.posts.first }
+
+    it "removes the object from the graph" do
+      user.posts.remove(post)
+
+      expect(user.posts.map(&:id)).not_to include(post.id)
+    end
+
+    it "removes the object from the datastore on save" do
+      user.posts.remove(post)
+      graph.save(user)
+
+      expect(datastore).not_to have_persisted(
+        :posts,
+        hash_including(
+          id: post.id,
+        )
+      )
+    end
+  end
+
+  context "modify a many to many relationhip" do
+    let(:post)     { user.posts.first }
+
+    context "remove a node" do
+      it "mutates the graph" do
+        category = post.categories.first
+        post.categories.remove(category)
+
+        expect(post.categories.map(&:id)).not_to include(category.id)
+      end
+
+      it "persists the change" do
+        category = post.categories.first
+        post.categories.remove(category)
+        graph.save(user)
+
+        expect(datastore).not_to have_persisted(
+          :categories_to_posts,
+          {
+            post_id: post.id,
+            category_id: category.id,
+          }
+        )
+      end
+    end
+
+    context "add a node" do
+      let(:post_with_one_category) { user.posts.to_a.last }
+      let(:new_category) { user.posts.first.categories.to_a.first }
+
+      it "mutates the graph" do
+        post_with_one_category.categories.push(new_category)
+
+        expect(post_with_one_category.categories.map(&:id))
+          .to match_array(["category/1", "category/2"])
+      end
+
+      it "persists the change" do
+        post_with_one_category.categories.push(new_category)
+        graph.save(user)
+
+        expect(datastore).to have_persisted(
+          :categories_to_posts,
+          {
+            post_id: post_with_one_category.id,
+            category_id: new_category.id,
+          }
+        )
+      end
+    end
+
+    context "modify a node" do
+      let(:category) { user.posts.first.categories.first }
+      let(:modified_category_name) { "modified category" }
+
+      it "mutates the graph" do
+        category.name = modified_category_name
+
+        expect(post.categories.first.name)
+          .to eq(modified_category_name)
+      end
+
+      it "persists the change" do
+        category.name = modified_category_name
+        graph.save(user)
+
+        expect(datastore).to have_persisted(
+          :categories,
+          {
+            id: category.id,
+            name: modified_category_name,
+          }
+        )
+      end
+    end
+  end
+
+  RSpec::Matchers.define :have_persisted do |relation_name, data|
+    match do |datastore|
+      datastore[relation_name].find { |record|
+        if data.respond_to?(:===)
+          data === record
+        else
+          data == record
+        end
+      }
+    end
+
+    failure_message do |datastore|
+      "expected #{datastore[relation_name]} to have persisted #{data.inspect} in #{relation_name}"
+    end
+
+    failure_message_when_negated do |datastore|
+      failure_message.gsub("to have", "not to have")
+    end
+  end
+end

data/spec/graph_traversal_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+require "sequel_mapper"
+require "support/graph_fixture"
+
+RSpec.describe "Graph traversal" do
+  include SequelMapper::GraphFixture
+
+  describe "assocaitions" do
+    subject(:graph) {
+      SequelMapper::Graph.new(
+        top_level_namespace: :users,
+        datastore: datastore,
+        relation_mappings: relation_mappings,
+      )
+    }
+
+    let(:user_query) {
+      graph.where(id: "user/1")
+    }
+
+    it "finds data via the storage adapter" do
+      expect(user_query.count).to be 1
+    end
+
+    it "maps the raw data from the store into domain objects" do
+      expect(user_query.first.id).to eq("user/1")
+      expect(user_query.first.first_name).to eq("Stephen")
+    end
+
+    it "handles has_many associations" do
+      expect(user_query.first.posts.first.subject)
+        .to eq("Object mapping")
+    end
+
+    it "handles nested has_many associations" do
+      expect(
+        user_query.first
+          .posts.first
+          .comments.first
+          .body
+      ).to eq("Trololol")
+    end
+
+    describe "lazy loading" do
+      let(:post_factory) { double(:post_factory, call: nil) }
+
+      it "loads has many associations lazily" do
+        posts = user_query.first.posts
+
+        expect(post_factory).not_to have_received(:call)
+      end
+    end
+
+    it "maps belongs to assocations" do
+      expect(user_query.first.posts.first.author.id)
+        .to eq("user/1")
+    end
+
+    describe "identity map" do
+      it "always returns (a proxy of) the same object for a given id" do
+        expect(user_query.first.posts.first.author.__getobj__)
+          .to be(user_query.first)
+      end
+    end
+
+    it "maps deeply nested belongs to assocations" do
+      expect(user_query.first.posts.first.comments.first.commenter.id)
+        .to eq("user/2")
+    end
+
+    it "maps has many to many associations as has many through" do
+      expect(user_query.first.posts.first.categories.map(&:id))
+        .to match_array(["category/1", "category/2"])
+
+      expect(user_query.first.posts.first.categories.to_a.last.posts.map(&:id))
+        .to match_array(["post/1", "post/2"])
+    end
+
+    xit "combines has many through associations" do
+      expect(user_query.first.categories_posted_in.map(&:id))
+        .to match_array(["category/1", "category/2"])
+    end
+  end
+end