rom 1.0.0 → 2.0.0

data/spec/unit/rom/plugins/relation/key_inference_spec.rb

@@ -3,25 +3,83 @@ require 'rom/memory'
 require 'rom/plugins/relation/key_inference'
 
 RSpec.describe ROM::Plugins::Relation::KeyInference do
-  subject(:relation) { relation_class.new([]) }
+  subject(:relation) do
+    relation_class.new(
+      [],
+      __registry__: ROM::RelationRegistry.new(posts: posts, users: users, tags: tags)
+    )
+  end
+
+  let(:posts) { double(foreign_key: :post_id) }
+  let(:tags_name) { ROM::Relation::Name[:tags] }
+  let(:tags) { double(foreign_key: :tag_id) }
+  let(:users_name) { ROM::Relation::Name[:users] }
+  let(:users) { double(base_name: users_name) }
 
-  let(:relation_class) do
-    Class.new(ROM::Memory::Relation) do
-      use :key_inference
+  describe 'without a schema' do
+    let(:relation_class) do
+      Class.new(ROM::Memory::Relation) do
+        use :key_inference
 
-      dataset :users
+        dataset :users
+      end
     end
-  end
 
-  describe '#base_name' do
-    it 'returns dataset name by default' do
-      expect(relation.base_name).to be(:users)
+    describe '#base_name' do
+      it 'returns dataset name by default' do
+        expect(relation.base_name).to eql(ROM::Relation::Name[:users])
+      end
+    end
+
+    describe '#foreign_key' do
+      it 'returns default value' do
+        expect(relation.foreign_key).to be(:user_id)
+      end
+
+      it 'returns default value for another relation' do
+        expect(relation.foreign_key(:posts)).to be(:post_id)
+        expect(relation.foreign_key(posts)).to be(:post_id)
+      end
+
+      it 'returns default value for Relation::Name' do
+        expect(relation.foreign_key(ROM::Relation::Name[:posts])).to be(:post_id)
+      end
+
+      it 'supports objects responding to to_sym' do
+        external_name = double(to_sym: :tags)
+        expect(relation.foreign_key(external_name)).to be(:tag_id)
+      end
     end
   end
 
-  describe '#foreign_key' do
-    it 'returns default value' do
-      expect(relation.foreign_key).to be(:user_id)
+  describe 'with a schema' do
+    let(:relation_class) do
+      Class.new(ROM::Memory::Relation) do
+        use :key_inference
+
+        schema :posts do
+          attribute :author_id, ROM::Types::Int.meta(foreign_key: true, relation: :users)
+        end
+      end
+    end
+
+    describe '#foreign_key' do
+      it 'returns configured value' do
+        expect(relation.foreign_key(ROM::Relation::Name[:users])).to be(:author_id)
+        expect(relation.foreign_key(:users)).to be(:author_id)
+        expect(relation.foreign_key(users)).to be(:author_id)
+        expect(relation.foreign_key(users_name)).to be(:author_id)
+      end
+
+      it 'falls back to default when schema has no fk specified' do
+        expect(relation.foreign_key(:tags)).to be(:tag_id)
+        expect(relation.foreign_key(tags_name)).to be(:tag_id)
+      end
+
+      it 'supports objects responding to to_sym' do
+        external_name = double(to_sym: :tags)
+        expect(relation.foreign_key(external_name)).to be(:tag_id)
+      end
     end
   end
 end

data/spec/unit/rom/plugins/relation/view_spec.rb

@@ -43,5 +43,9 @@ RSpec.describe ROM::Plugins::Relation::View do
     it 'returns correct arity for a curried view' do
       expect(relation.names.arity).to be(1)
     end
+
+    it 'returns explicitly set attributes' do
+      expect(relation.with(attributes: [:foo, :bar]).attributes).to eql([:foo, :bar])
+    end
   end
 end

data/spec/unit/rom/relation/graph_spec.rb

@@ -22,6 +22,16 @@ describe ROM::Relation::Graph do
 
   subject(:graph) { ROM::Relation::Graph.new(users_relation, [tasks_relation.for_users]) }
 
+  describe '#graph?' do
+    it 'returns true' do
+      expect(graph.graph?).to be(true)
+    end
+
+    it 'returns true when curried' do
+      expect(graph.by_name.graph?).to be(true)
+    end
+  end
+
   it_behaves_like 'materializable relation' do
     let(:mapper) do
       T(:combine, [[:tasks, name: :name]])

data/spec/unit/rom/relation/lazy_spec.rb

@@ -61,12 +61,12 @@ describe ROM::Relation do
     it 'forwards to relation and auto-curries' do
       relation = users_relation.by_name_and_email_sorted('Jane')
 
-      expect(relation.name).to eql(:by_name_and_email_sorted)
+      expect(relation.name).to eql(ROM::Relation::Name[:by_name_and_email_sorted])
       expect(relation.curry_args).to eql(['Jane'])
 
       relation = relation['jane@doe.org']
 
-      expect(relation.name).to eql(:by_name_and_email_sorted)
+      expect(relation.name).to eql(ROM::Relation::Name[:by_name_and_email_sorted])
       expect(relation.curry_args).to eql(['Jane', 'jane@doe.org'])
 
       expect(relation[:email]).to match_array(
@@ -100,7 +100,7 @@ describe ROM::Relation do
     it 'auto-curries' do
       relation = users_relation.by_name
 
-      expect(relation.name).to eql(:by_name)
+      expect(relation.name).to eql(ROM::Relation::Name[:by_name])
       expect(relation['Jane'].to_a).to eql(users_relation.by_name('Jane').to_a)
     end
 

data/spec/unit/rom/relation/loaded_spec.rb

@@ -9,9 +9,11 @@ describe ROM::Relation::Loaded do
   describe '#each' do
     it 'yields tuples from relation' do
       result = []
+
       users.each do |tuple|
         result << tuple
       end
+
       expect(result).to match_array([
         { name: 'Jane', email: 'jane@doe.org' },
         { name: 'Joe', email: 'joe@doe.org' }
@@ -32,6 +34,19 @@ describe ROM::Relation::Loaded do
     end
   end
 
+  describe '#pluck' do
+    it 'returns a list of values under provided key' do
+      expect(users.pluck(:email)).to eql(%w(joe@doe.org jane@doe.org))
+    end
+  end
+
+  describe '#primary_keys' do
+    it 'returns a list of primary key values' do
+      expect(users.source).to receive(:primary_key).and_return(:name)
+      expect(users.primary_keys).to eql(%w(Joe Jane))
+    end
+  end
+
   it_behaves_like 'a relation that returns one tuple' do
     let(:relation) { users }
   end

data/spec/unit/rom/relation/name_spec.rb

@@ -0,0 +1,51 @@
+require 'rom/relation/name'
+
+RSpec.describe ROM::Relation::Name do
+  describe '.[]' do
+    it 'returns a new name from args' do
+      expect(ROM::Relation::Name[:users]).to eql(
+        ROM::Relation::Name.new(:users)
+      )
+
+      expect(ROM::Relation::Name[:authors, :users]).to eql(
+        ROM::Relation::Name.new(:authors, :users)
+      )
+    end
+
+    it 'returns name object when it was passed in as arg' do
+      name = ROM::Relation::Name[:users]
+      expect(ROM::Relation::Name[name]).to be(name)
+    end
+
+    it 'caches name instances' do
+      name = ROM::Relation::Name[:users]
+      expect(ROM::Relation::Name[:users]).to be(name)
+    end
+  end
+
+  describe '#inspect' do
+    it 'provides relation name' do
+      name = ROM::Relation::Name.new(:users)
+      expect(name.inspect).to eql("ROM::Relation::Name(users)")
+    end
+
+    it 'provides dataset and relation names' do
+      name = ROM::Relation::Name.new(:authors, :users)
+      expect(name.inspect).to eql("ROM::Relation::Name(authors on users)")
+    end
+  end
+
+  describe '#with' do
+    it 'returns a new name with the same dataset but for a different relation name' do
+      name = ROM::Relation::Name[:users]
+      expect(name.with(:people)).to be(ROM::Relation::Name[:people, :users])
+    end
+  end
+
+  describe '#to_sym' do
+    it 'returns relation name' do
+      expect(ROM::Relation::Name.new(:users).to_sym).to be(:users)
+      expect(ROM::Relation::Name.new(:authors, :users).to_sym).to be(:authors)
+    end
+  end
+end

data/spec/unit/rom/relation/schema_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'rom/memory'
+
+describe ROM::Relation, '.schema' do
+  it 'defines a canonical schema for a relation' do
+    class Test::Users < ROM::Relation[:memory]
+      schema do
+        attribute :id, Types::Int.meta(primary_key: true)
+        attribute :name, Types::String
+        attribute :admin, Types::Bool
+      end
+    end
+
+    Test::Users.schema.finalize!
+
+    schema = ROM::Schema.new(
+      ROM::Relation::Name.new(:test_users),
+      id: ROM::Memory::Types::Int.meta(primary_key: true, name: :id),
+      name: ROM::Memory::Types::String.meta(name: :name),
+      admin: ROM::Memory::Types::Bool.meta(name: :admin)
+    ).finalize!
+
+    expect(Test::Users.schema.primary_key).to eql([Test::Users.schema[:id]])
+
+    expect(Test::Users.schema).to eql(schema)
+  end
+
+  it 'allows setting composite primary key' do
+    class Test::Users < ROM::Relation[:memory]
+      schema do
+        attribute :name, Types::String
+        attribute :email, Types::String
+
+        primary_key :name, :email
+      end
+    end
+
+    schema = Test::Users.schema.finalize!
+
+    expect(schema.primary_key).to eql([schema[:name], schema[:email]])
+  end
+
+  it 'allows setting foreign keys' do
+    class Test::Posts < ROM::Relation[:memory]
+      schema do
+        attribute :author_id, Types::ForeignKey(:users)
+        attribute :title, Types::String
+      end
+    end
+
+    schema = Test::Posts.schema
+
+    expect(schema[:author_id].primitive).to be(Integer)
+
+    expect(schema.foreign_key(:users)).to be(schema[:author_id])
+  end
+
+  it 'sets register_as and dataset' do
+    class Test::Users < ROM::Relation[:memory]
+      schema(:users) do
+        attribute :id, Types::Int
+        attribute :name, Types::String
+      end
+    end
+
+    expect(Test::Users.dataset).to be(:users)
+    expect(Test::Users.register_as).to be(:users)
+  end
+
+  it 'sets dataset and respects custom register_as' do
+    class Test::Users < ROM::Relation[:memory]
+      register_as :test_users
+
+      schema(:users) do
+        attribute :id, Types::Int
+        attribute :name, Types::String
+      end
+    end
+
+    expect(Test::Users.dataset).to be(:users)
+    expect(Test::Users.register_as).to be(:test_users)
+  end
+
+  describe '#schema' do
+    it 'returns defined schema' do
+      class Test::Users < ROM::Relation[:memory]
+        schema do
+          attribute :id, Types::Int.meta(primary_key: true)
+          attribute :name, Types::String
+          attribute :admin, Types::Bool
+        end
+      end
+
+      users = Test::Users.new([])
+
+      expect(users.schema).to be(Test::Users.schema)
+    end
+
+    it 'uses custom schema dsl' do
+      class Test::SchemaDSL < ROM::Schema::DSL
+        def bool(name)
+          attribute(name, ::ROM::Types::Bool)
+        end
+      end
+
+      class Test::Users < ROM::Relation[:memory]
+        schema_dsl Test::SchemaDSL
+
+        schema do
+          bool :admin
+        end
+      end
+
+      expect(Test::Users.schema[:admin]).to eql(ROM::Types::Bool.meta(name: :admin))
+    end
+  end
+end

data/spec/unit/rom/relation_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'rom/memory'
 
 describe ROM::Relation do
@@ -126,7 +125,7 @@ describe ROM::Relation do
         it 'returns name based on module and class' do
           relation = Test::Test::SuperRelation.new([])
 
-          expect(relation.name).to eq(:test_test_super_relation)
+          expect(relation.name).to eql(ROM::Relation::Name.new(:test_test_super_relation))
         end
       end
 
@@ -138,7 +137,7 @@ describe ROM::Relation do
         it 'returns name based only on class' do
           relation = Test::SuperRelation.new([])
 
-          expect(relation.name).to eq(:test_super_relation)
+          expect(relation.name).to eql(ROM::Relation::Name.new(:test_super_relation))
         end
       end
 
@@ -151,7 +150,7 @@ describe ROM::Relation do
         it 'inherits :name from the super relation' do
           relation = Test::DescendantRelation.new([])
 
-          expect(relation.name).to eql(:test_super_relation)
+          expect(relation.name).to eql(ROM::Relation::Name.new(:test_super_relation))
         end
       end
     end
@@ -168,7 +167,7 @@ describe ROM::Relation do
       it 'returns name based on dataset' do
         relation = Test::TestAdapter::Relation.new([])
 
-        expect(relation.name).to eq(:foo_bar)
+        expect(relation.name).to eql(ROM::Relation::Name.new(:foo_bar))
       end
     end
   end
@@ -197,11 +196,42 @@ describe ROM::Relation do
 
   describe "#with" do
     it "returns a new instance with the original dataset and given custom options" do
+      relation = Class.new(ROM::Relation) { option :custom }.new([])
+
       custom_opts = { mappers: "Custom Mapper Registry" }
-      new_relation = relation.with(custom_opts)
+      new_relation = relation.with(custom_opts).with(custom: true)
 
       expect(new_relation.dataset).to be(relation.dataset)
-      expect(new_relation.options).to include(custom_opts)
+      expect(new_relation.options).to include(custom_opts.merge(custom: true))
+    end
+  end
+
+  describe '#graph?' do
+    it 'returns false' do
+      expect(relation.graph?).to be(false)
+    end
+
+    it 'returns false when curried' do
+      relation = Class.new(ROM::Relation[:memory]) { def by_name(_); self; end }.new([])
+      expect(relation.by_name.graph?).to be(false)
+    end
+  end
+
+  describe '#schema_hash' do
+    it 'returns a schema hash type' do
+      relation = Class.new(ROM::Relation[:memory]) do
+        schema { attribute :id, ROM::Types::Coercible::Int }
+      end.new([])
+
+      expect(relation.schema_hash[id: '1']).to eql(id: 1)
+    end
+
+    it 'returns a plain Hash coercer when there is no schema' do
+      relation = Class.new(ROM::Relation[:memory]).new([])
+
+      tuple = [[:id, '1']]
+
+      expect(relation.schema_hash[tuple]).to eql(id: '1')
     end
   end
 end

data/spec/unit/rom/schema_spec.rb

@@ -0,0 +1,10 @@
+RSpec.describe ROM::Schema do
+  describe '#to_h' do
+    it 'returns hash with attributes' do
+      attrs = { id: ROM::Types::Int, name: ROM::Types::String }
+      schema = ROM::Schema.new(:name, attrs)
+
+      expect(schema.to_h).to eql(attrs)
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rom
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -24,34 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rom-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rom-mapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +128,7 @@ files:
 - README.md
 - Rakefile
 - lib/rom.rb
+- lib/rom/association_set.rb
 - lib/rom/command.rb
 - lib/rom/command_registry.rb
 - lib/rom/commands.rb
@@ -144,10 +173,12 @@ files:
 - lib/rom/memory/gateway.rb
 - lib/rom/memory/relation.rb
 - lib/rom/memory/storage.rb
+- lib/rom/memory/types.rb
 - lib/rom/pipeline.rb
 - lib/rom/plugin.rb
 - lib/rom/plugin_base.rb
 - lib/rom/plugin_registry.rb
+- lib/rom/plugins/command/schema.rb
 - lib/rom/plugins/configuration/configuration_dsl.rb
 - lib/rom/plugins/relation/key_inference.rb
 - lib/rom/plugins/relation/registry_reader.rb
@@ -160,15 +191,20 @@ files:
 - lib/rom/relation/graph.rb
 - lib/rom/relation/loaded.rb
 - lib/rom/relation/materializable.rb
+- lib/rom/relation/name.rb
 - lib/rom/relation_registry.rb
+- lib/rom/schema.rb
+- lib/rom/schema/dsl.rb
 - lib/rom/setup.rb
 - lib/rom/setup/auto_registration.rb
 - lib/rom/setup/finalize.rb
-- lib/rom/setup/finalize/commands.rb
-- lib/rom/setup/finalize/mappers.rb
-- lib/rom/setup/finalize/relations.rb
+- lib/rom/setup/finalize/finalize_commands.rb
+- lib/rom/setup/finalize/finalize_mappers.rb
+- lib/rom/setup/finalize/finalize_relations.rb
 - lib/rom/support/configurable.rb
+- lib/rom/types.rb
 - lib/rom/version.rb
+- log/.gitkeep
 - rakelib/benchmark.rake
 - rakelib/mutant.rake
 - rakelib/rubocop.rake
@@ -233,6 +269,7 @@ files:
 - spec/support/constant_leak_finder.rb
 - spec/support/mutant.rb
 - spec/test/memory_repository_lint_test.rb
+- spec/unit/rom/association_set_spec.rb
 - spec/unit/rom/auto_registration_spec.rb
 - spec/unit/rom/commands/graph_spec.rb
 - spec/unit/rom/commands/lazy_spec.rb
@@ -244,8 +281,8 @@ files:
 - spec/unit/rom/create_container_spec.rb
 - spec/unit/rom/environment_spec.rb
 - spec/unit/rom/gateway_spec.rb
-- spec/unit/rom/global_spec.rb
 - spec/unit/rom/mapper_registry_spec.rb
+- spec/unit/rom/memory/commands_spec.rb
 - spec/unit/rom/memory/dataset_spec.rb
 - spec/unit/rom/memory/relation_spec.rb
 - spec/unit/rom/memory/repository_spec.rb
@@ -253,14 +290,16 @@ files:
 - spec/unit/rom/plugin_spec.rb
 - spec/unit/rom/plugins/relation/key_inference_spec.rb
 - spec/unit/rom/plugins/relation/view_spec.rb
-- spec/unit/rom/registry_spec.rb
 - spec/unit/rom/relation/composite_spec.rb
 - spec/unit/rom/relation/curried_spec.rb
 - spec/unit/rom/relation/graph_spec.rb
 - spec/unit/rom/relation/lazy/combine_spec.rb
 - spec/unit/rom/relation/lazy_spec.rb
 - spec/unit/rom/relation/loaded_spec.rb
+- spec/unit/rom/relation/name_spec.rb
+- spec/unit/rom/relation/schema_spec.rb
 - spec/unit/rom/relation_spec.rb
+- spec/unit/rom/schema_spec.rb
 homepage: http://rom-rb.org
 licenses:
 - MIT
@@ -281,7 +320,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: Ruby Object Mapper