rom 0.1.2 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (139) hide show
  1. data/.rspec +2 -0
  2. data/.travis.yml +22 -0
  3. data/Changelog.md +16 -0
  4. data/Gemfile +13 -6
  5. data/Gemfile.devtools +71 -0
  6. data/Guardfile +19 -0
  7. data/LICENSE +1 -1
  8. data/README.md +52 -30
  9. data/Rakefile +3 -0
  10. data/config/devtools.yml +4 -0
  11. data/config/flay.yml +3 -0
  12. data/config/flog.yml +2 -0
  13. data/config/mutant.yml +5 -0
  14. data/config/reek.yml +103 -0
  15. data/config/rubocop.yml +62 -0
  16. data/config/yardstick.yml +2 -0
  17. data/lib/rom.rb +13 -5
  18. data/lib/rom/constants.rb +16 -0
  19. data/lib/rom/environment.rb +105 -0
  20. data/lib/rom/environment/builder.rb +71 -0
  21. data/lib/rom/mapper.rb +176 -0
  22. data/lib/rom/mapper/attribute.rb +108 -0
  23. data/lib/rom/mapper/builder.rb +58 -0
  24. data/lib/rom/mapper/builder/definition.rb +162 -0
  25. data/lib/rom/mapper/header.rb +103 -0
  26. data/lib/rom/mapper/loader_builder.rb +26 -0
  27. data/lib/rom/relation.rb +375 -0
  28. data/lib/rom/repository.rb +71 -0
  29. data/lib/rom/schema.rb +21 -0
  30. data/lib/rom/schema/builder.rb +59 -0
  31. data/lib/rom/schema/definition.rb +84 -0
  32. data/lib/rom/schema/definition/relation.rb +80 -0
  33. data/lib/rom/schema/definition/relation/base.rb +27 -0
  34. data/lib/rom/session.rb +111 -0
  35. data/lib/rom/session/environment.rb +67 -0
  36. data/lib/rom/session/identity_map.rb +43 -0
  37. data/lib/rom/session/mapper.rb +62 -0
  38. data/lib/rom/session/relation.rb +140 -0
  39. data/lib/rom/session/state.rb +59 -0
  40. data/lib/rom/session/state/created.rb +22 -0
  41. data/lib/rom/session/state/deleted.rb +25 -0
  42. data/lib/rom/session/state/persisted.rb +34 -0
  43. data/lib/rom/session/state/transient.rb +20 -0
  44. data/lib/rom/session/state/updated.rb +29 -0
  45. data/lib/rom/session/tracker.rb +62 -0
  46. data/lib/rom/support/axiom/adapter.rb +111 -0
  47. data/lib/rom/support/axiom/adapter/data_objects.rb +38 -0
  48. data/lib/rom/support/axiom/adapter/memory.rb +25 -0
  49. data/lib/rom/support/axiom/adapter/postgres.rb +19 -0
  50. data/lib/rom/support/axiom/adapter/sqlite3.rb +20 -0
  51. data/lib/version.rb +1 -1
  52. data/rom.gemspec +7 -3
  53. data/spec/integration/environment_setup_spec.rb +24 -0
  54. data/spec/integration/grouped_mappers_spec.rb +87 -0
  55. data/spec/integration/join_and_group_spec.rb +76 -0
  56. data/spec/integration/join_and_wrap_spec.rb +68 -0
  57. data/spec/integration/mapping_embedded_relations_spec.rb +73 -0
  58. data/spec/integration/mapping_relations_spec.rb +120 -0
  59. data/spec/integration/schema_definition_spec.rb +152 -0
  60. data/spec/integration/session_spec.rb +87 -0
  61. data/spec/integration/wrapped_mappers_spec.rb +73 -0
  62. data/spec/shared/unit/environment_context.rb +6 -0
  63. data/spec/shared/unit/loader.rb +11 -0
  64. data/spec/shared/unit/loader_identity.rb +13 -0
  65. data/spec/shared/unit/mapper_context.rb +11 -0
  66. data/spec/shared/unit/relation_context.rb +82 -0
  67. data/spec/shared/unit/session_environment_context.rb +11 -0
  68. data/spec/shared/unit/session_relation_context.rb +18 -0
  69. data/spec/spec_helper.rb +49 -0
  70. data/spec/support/helper.rb +34 -0
  71. data/spec/support/ice_nine_config.rb +10 -0
  72. data/spec/support/test_mapper.rb +110 -0
  73. data/spec/unit/rom/environment/builder/mapping_spec.rb +24 -0
  74. data/spec/unit/rom/environment/builder/schema_spec.rb +33 -0
  75. data/spec/unit/rom/environment/class_methods/setup_spec.rb +18 -0
  76. data/spec/unit/rom/environment/repository_spec.rb +21 -0
  77. data/spec/unit/rom/mapper/attribute/embedded_collection/to_ast_spec.rb +18 -0
  78. data/spec/unit/rom/mapper/attribute/embedded_value/to_ast_spec.rb +16 -0
  79. data/spec/unit/rom/mapper/attribute/rename_spec.rb +9 -0
  80. data/spec/unit/rom/mapper/attribute/to_ast_spec.rb +9 -0
  81. data/spec/unit/rom/mapper/builder/class_methods/call_spec.rb +61 -0
  82. data/spec/unit/rom/mapper/class_methods/build_spec.rb +55 -0
  83. data/spec/unit/rom/mapper/dump_spec.rb +11 -0
  84. data/spec/unit/rom/mapper/group_spec.rb +35 -0
  85. data/spec/unit/rom/mapper/header/each_spec.rb +26 -0
  86. data/spec/unit/rom/mapper/header/element_reader_spec.rb +21 -0
  87. data/spec/unit/rom/mapper/header/group_spec.rb +18 -0
  88. data/spec/unit/rom/mapper/header/join_spec.rb +14 -0
  89. data/spec/unit/rom/mapper/header/keys_spec.rb +29 -0
  90. data/spec/unit/rom/mapper/header/project_spec.rb +13 -0
  91. data/spec/unit/rom/mapper/header/rename_spec.rb +11 -0
  92. data/spec/unit/rom/mapper/header/to_ast_spec.rb +11 -0
  93. data/spec/unit/rom/mapper/header/wrap_spec.rb +18 -0
  94. data/spec/unit/rom/mapper/identity_from_tuple_spec.rb +11 -0
  95. data/spec/unit/rom/mapper/identity_spec.rb +11 -0
  96. data/spec/unit/rom/mapper/join_spec.rb +15 -0
  97. data/spec/unit/rom/mapper/load_spec.rb +11 -0
  98. data/spec/unit/rom/mapper/new_object_spec.rb +14 -0
  99. data/spec/unit/rom/mapper/project_spec.rb +11 -0
  100. data/spec/unit/rom/mapper/rename_spec.rb +16 -0
  101. data/spec/unit/rom/mapper/wrap_spec.rb +35 -0
  102. data/spec/unit/rom/relation/delete_spec.rb +15 -0
  103. data/spec/unit/rom/relation/drop_spec.rb +11 -0
  104. data/spec/unit/rom/relation/each_spec.rb +23 -0
  105. data/spec/unit/rom/relation/first_spec.rb +19 -0
  106. data/spec/unit/rom/relation/group_spec.rb +29 -0
  107. data/spec/unit/rom/relation/inject_mapper_spec.rb +17 -0
  108. data/spec/unit/rom/relation/insert_spec.rb +13 -0
  109. data/spec/unit/rom/relation/last_spec.rb +19 -0
  110. data/spec/unit/rom/relation/one_spec.rb +49 -0
  111. data/spec/unit/rom/relation/rename_spec.rb +21 -0
  112. data/spec/unit/rom/relation/replace_spec.rb +13 -0
  113. data/spec/unit/rom/relation/restrict_spec.rb +25 -0
  114. data/spec/unit/rom/relation/sort_by_spec.rb +25 -0
  115. data/spec/unit/rom/relation/take_spec.rb +11 -0
  116. data/spec/unit/rom/relation/to_a_spec.rb +20 -0
  117. data/spec/unit/rom/relation/update_spec.rb +25 -0
  118. data/spec/unit/rom/relation/wrap_spec.rb +29 -0
  119. data/spec/unit/rom/repository/class_methods/build_spec.rb +27 -0
  120. data/spec/unit/rom/repository/element_reader_spec.rb +21 -0
  121. data/spec/unit/rom/repository/element_writer_spec.rb +18 -0
  122. data/spec/unit/rom/schema/builder/class_methods/build_spec.rb +103 -0
  123. data/spec/unit/rom/schema/element_reader_spec.rb +15 -0
  124. data/spec/unit/rom/session/class_methods/start_spec.rb +23 -0
  125. data/spec/unit/rom/session/clean_predicate_spec.rb +21 -0
  126. data/spec/unit/rom/session/environment/element_reader_spec.rb +13 -0
  127. data/spec/unit/rom/session/flush_spec.rb +58 -0
  128. data/spec/unit/rom/session/mapper/load_spec.rb +47 -0
  129. data/spec/unit/rom/session/relation/delete_spec.rb +28 -0
  130. data/spec/unit/rom/session/relation/dirty_predicate_spec.rb +35 -0
  131. data/spec/unit/rom/session/relation/identity_spec.rb +11 -0
  132. data/spec/unit/rom/session/relation/new_spec.rb +50 -0
  133. data/spec/unit/rom/session/relation/save_spec.rb +50 -0
  134. data/spec/unit/rom/session/relation/state_spec.rb +23 -0
  135. data/spec/unit/rom/session/relation/track_spec.rb +23 -0
  136. data/spec/unit/rom/session/relation/tracking_predicate_spec.rb +23 -0
  137. data/spec/unit/rom/session/relation/update_attributes_spec.rb +45 -0
  138. data/spec/unit/rom/session/state_spec.rb +79 -0
  139. metadata +212 -11
@@ -0,0 +1,20 @@
1
+ # encoding: utf-8
2
+
3
+ module ROM
4
+ class Session
5
+ class State
6
+
7
+ # @api private
8
+ class Transient < self
9
+ include Concord::Public.new(:object, :mapper)
10
+
11
+ # @api private
12
+ def save(relation)
13
+ Created.new(object, mapper, relation)
14
+ end
15
+
16
+ end # Transient
17
+
18
+ end # State
19
+ end # Session
20
+ end # ROM
@@ -0,0 +1,29 @@
1
+ # encoding: utf-8
2
+
3
+ module ROM
4
+ class Session
5
+ class State
6
+
7
+ # @api private
8
+ class Updated < self
9
+ include Adamantium::Flat
10
+ include Concord::Public.new(:object, :mapper, :relation)
11
+
12
+ # @api private
13
+ def commit
14
+ relation.update(object, original_tuple)
15
+ Persisted.new(object, mapper)
16
+ end
17
+
18
+ private
19
+
20
+ # @api private
21
+ def original_tuple
22
+ mapper.identity_map.fetch_tuple(mapper.identity(object))
23
+ end
24
+
25
+ end # Updated
26
+
27
+ end # State
28
+ end # Session
29
+ end # ROM
@@ -0,0 +1,62 @@
1
+ # encoding: utf-8
2
+
3
+ module ROM
4
+ class Session
5
+
6
+ # @api private
7
+ class Tracker
8
+ attr_reader :objects, :changelog
9
+ private :objects, :changelog
10
+
11
+ # @api private
12
+ def initialize
13
+ @objects = {}
14
+ @changelog = []
15
+ end
16
+
17
+ # @api private
18
+ def commit
19
+ @changelog.each { |state| update(state.commit) }
20
+ @changelog = []
21
+ end
22
+
23
+ # @api private
24
+ def fetch(identity)
25
+ @objects.fetch(identity) { raise ObjectNotTrackedError, identity }
26
+ end
27
+
28
+ # @api private
29
+ def include?(identity)
30
+ @objects.key?(identity)
31
+ end
32
+
33
+ # @api private
34
+ def clean?
35
+ changelog.empty?
36
+ end
37
+
38
+ # @api private
39
+ def queue(state)
40
+ @changelog << state
41
+ update(state)
42
+ end
43
+
44
+ # @api private
45
+ def update(state)
46
+ @objects[state.identity] = state
47
+ end
48
+
49
+ # @api private
50
+ def store_transient(object, mapper)
51
+ update(State::Transient.new(object, mapper))
52
+ end
53
+
54
+ # @api private
55
+ def store_persisted(object, mapper)
56
+ update(State::Persisted.new(object, mapper))
57
+ end
58
+
59
+ end # Tracker
60
+
61
+ end # Session
62
+ end # ROM
@@ -0,0 +1,111 @@
1
+ # encoding: utf-8
2
+
3
+ module Axiom
4
+
5
+ # Raised when passing an +uri+ with an unregistered scheme to {Adapter.new}
6
+ UnknownAdapterError = Class.new(StandardError)
7
+
8
+ # Provides base functionality for every axiom adapter
9
+ #
10
+ # @todo think about making this a (base) class
11
+ #
12
+ # @example
13
+ #
14
+ # class MyAdapter
15
+ # extend Axiom::Adapter
16
+ # uri_scheme :foo
17
+ # end
18
+ #
19
+ module Adapter
20
+
21
+ # The registry of adapters
22
+ #
23
+ # @return [Hash<String, Object>]
24
+ # a hash of adapters, keyed by uri scheme
25
+ #
26
+ # @api private
27
+ REGISTRY = {}
28
+
29
+ # Return the adapter to use for the given +uri+
30
+ #
31
+ # @param [Addressable::URI] uri
32
+ # the uri to initialize the adapter with
33
+ #
34
+ # @return [Object]
35
+ # a axiom adapter
36
+ #
37
+ # @raise [UnknownAdapterError]
38
+ # when the given +uri+'s scheme is not registered
39
+ #
40
+ # @api private
41
+ def self.build(uri)
42
+ require_adapter(uri)
43
+
44
+ klass = get(uri)
45
+
46
+ if klass.name == 'Axiom::Adapter::Memory'
47
+ klass.new
48
+ else
49
+ klass.new(uri)
50
+ end
51
+ end
52
+
53
+ # Return the adapter class registered for +uri+
54
+ #
55
+ # @param [Addressable::URI] uri
56
+ # the uri that identifies the adapter class
57
+ #
58
+ # @return [Class]
59
+ # a axiom adapter class
60
+ #
61
+ # @raise [UnknownAdapterError]
62
+ # when the given +uri+'s scheme is not registered
63
+ #
64
+ # @api private
65
+ def self.get(uri)
66
+ uri_scheme = uri.scheme
67
+
68
+ REGISTRY.fetch(uri_scheme) {
69
+ raise(
70
+ UnknownAdapterError,
71
+ "#{uri_scheme.inspect} is no registered uri scheme"
72
+ )
73
+ }
74
+ end
75
+
76
+ # Try to load an adapter using a standard path
77
+ #
78
+ # @api private
79
+ def self.require_adapter(uri)
80
+ require "rom/support/axiom/adapter/#{uri.scheme}"
81
+ rescue LoadError
82
+ end
83
+ private_class_method :require_adapter
84
+
85
+ # Set the uri scheme for an adapter class
86
+ #
87
+ # @example for a DataObjects adapter
88
+ #
89
+ # class Postgres < Axiom::Adapter::DataObjects
90
+ # uri_scheme :postgres
91
+ # end
92
+ #
93
+ # @example for an arbitrary adapter
94
+ #
95
+ # class InMemory
96
+ # extend Axiom::Adapter
97
+ # uri_scheme :in_memory
98
+ # end
99
+ #
100
+ # @param [#to_s] name
101
+ # the name of the uri scheme
102
+ #
103
+ # @return [self]
104
+ #
105
+ # @api public
106
+ def uri_scheme(name)
107
+ REGISTRY[name.to_s] = self
108
+ end
109
+
110
+ end # module Adapter
111
+ end # module Axiom
@@ -0,0 +1,38 @@
1
+ # encoding: utf-8
2
+
3
+ require 'axiom-do-adapter'
4
+
5
+ module Axiom
6
+ module Adapter
7
+
8
+ # Reopenend to add functionality that should eventually
9
+ # be puhsed down to Adapter::DataObjects proper, or whatever
10
+ # will be the base class.
11
+ #
12
+ class DataObjects
13
+ extend Adapter
14
+
15
+ include Equalizer.new(:uri)
16
+
17
+ # The URI this adapter uses for establishing a connection
18
+ #
19
+ # @return [Addressable::URI]
20
+ #
21
+ # @api private
22
+ attr_reader :uri
23
+
24
+ # Wrap the given +relation+ with a gateway
25
+ #
26
+ # @param [Axiom::Relation] relation
27
+ # the relation to wrap with a gateway
28
+ #
29
+ # @return [Axiom::Relation::Gateway]
30
+ #
31
+ # @api private
32
+ def gateway(relation)
33
+ Axiom::Relation::Gateway.new(self, relation)
34
+ end
35
+
36
+ end # DataObjects
37
+ end # Adapter
38
+ end # Axiom
@@ -0,0 +1,25 @@
1
+ # encoding: utf-8
2
+
3
+ require 'axiom-memory-adapter'
4
+ require 'rom/support/axiom/adapter'
5
+
6
+ module Axiom
7
+ module Adapter
8
+
9
+ # A axiom in memory adapter
10
+ #
11
+ # This is basically a "null adapter"
12
+ # as it doesn't make use of it's uri
13
+ # and only passes through the given
14
+ # +relation+ in {#gateway}
15
+ #
16
+ class Memory
17
+ extend Adapter
18
+
19
+ include Equalizer.new(:schema)
20
+
21
+ uri_scheme :memory
22
+
23
+ end # class Memory
24
+ end # module Adapter
25
+ end # module Axiom
@@ -0,0 +1,19 @@
1
+ # encoding: utf-8
2
+
3
+ require 'do_postgres'
4
+
5
+ require 'rom/support/axiom/adapter'
6
+ require 'rom/support/axiom/adapter/data_objects'
7
+
8
+ module Axiom
9
+ module Adapter
10
+
11
+ # A Axiom adapter for postgres
12
+ #
13
+ class Postgres < DataObjects
14
+
15
+ uri_scheme :postgres
16
+
17
+ end # class Postgres
18
+ end # module Adapter
19
+ end # module Axiom
@@ -0,0 +1,20 @@
1
+ # encoding: utf-8
2
+
3
+ require 'do_sqlite3'
4
+
5
+ require 'rom/support/axiom/adapter'
6
+ require 'rom/support/axiom/adapter/data_objects'
7
+
8
+ module Axiom
9
+ module Adapter
10
+
11
+ # A axiom adapter for sqlite3
12
+ #
13
+ class Sqlite3 < DataObjects
14
+
15
+ uri_scheme :sqlite3
16
+
17
+ end # Sqlite3
18
+
19
+ end # Adapter
20
+ end # Axiom
@@ -1,3 +1,3 @@
1
1
  module ROM
2
- VERSION = '0.1.2'.freeze
2
+ VERSION = '0.2.0'.freeze
3
3
  end
@@ -15,7 +15,11 @@ Gem::Specification.new do |gem|
15
15
  gem.test_files = `git ls-files -- {spec}/*`.split("\n")
16
16
  gem.license = 'MIT'
17
17
 
18
- gem.add_dependency 'rom-relation', '~> 0.1.2'
19
- gem.add_dependency 'rom-mapper', '~> 0.1.1'
20
- gem.add_dependency 'rom-session', '~> 0.1.1'
18
+ gem.add_dependency 'addressable', '~> 2.3', '>= 2.3.3'
19
+ gem.add_dependency 'concord', '~> 0.1'
20
+ gem.add_dependency 'adamantium', '~> 0.2'
21
+ gem.add_dependency 'axiom', '~> 0.2'
22
+ gem.add_dependency 'axiom-optimizer', '~> 0.2'
23
+ gem.add_dependency 'charlatan', '~> 0.1'
24
+ gem.add_dependency 'morpher', '~> 0.2'
21
25
  end
@@ -0,0 +1,24 @@
1
+ # encoding: utf-8
2
+
3
+ require 'spec_helper'
4
+
5
+ describe 'Setting up environment' do
6
+ let(:env) do
7
+ ROM::Environment.setup(memory: 'memory://test') do
8
+ schema do
9
+ base_relation :users do
10
+ repository :memory
11
+
12
+ attribute :id, Integer
13
+ attribute :name, String
14
+
15
+ key :id
16
+ end
17
+ end
18
+ end
19
+ end
20
+
21
+ it 'registers relations within repositories' do
22
+ expect(env.schema[:users]).to be_instance_of(Axiom::Relation::Variable::Materialized)
23
+ end
24
+ end
@@ -0,0 +1,87 @@
1
+ # encoding: utf-8
2
+
3
+ require 'spec_helper'
4
+
5
+ describe 'Grouped mappers' do
6
+ let(:env) do
7
+ Environment.setup(test: 'memory://test') do
8
+ schema do
9
+ base_relation :users do
10
+ repository :test
11
+
12
+ attribute :id, Integer
13
+ attribute :name, String
14
+
15
+ key :id
16
+ end
17
+
18
+ base_relation :tasks do
19
+ repository :test
20
+
21
+ attribute :id, Integer
22
+ attribute :title, String
23
+
24
+ key :id
25
+ end
26
+ end
27
+
28
+ mapping do
29
+ relation(:users) do
30
+ model User
31
+ map :id, :name
32
+ end
33
+
34
+ relation(:tasks) do
35
+ model Task
36
+ map :id, :title
37
+ end
38
+ end
39
+ end
40
+ end
41
+
42
+ before do
43
+ User = mock_model(:id, :name, :tasks)
44
+ Task = mock_model(:id, :title)
45
+ end
46
+
47
+ after do
48
+ Object.send(:remove_const, :User) if defined?(User)
49
+ Object.send(:remove_const, :Task) if defined?(Task)
50
+ end
51
+
52
+ subject(:mapper) { env[:users].mapper.group(:tasks => env[:tasks].mapper) }
53
+
54
+ specify 'loading grouped tuples' do
55
+ tuple = {
56
+ :id => 1,
57
+ :name => 'Jane',
58
+ :tasks => [
59
+ { :id => 2, :title => 'Task 1' },
60
+ { :id => 3, :title => 'Task 2' }
61
+ ]
62
+ }
63
+
64
+ task1 = Task.new(tuple[:tasks].first)
65
+ task2 = Task.new(tuple[:tasks].last)
66
+ user = User.new(:id => tuple[:id], :name => tuple[:name], :tasks => [task1, task2])
67
+
68
+ expect(mapper.load(tuple)).to eql(user)
69
+ end
70
+
71
+ specify 'dumping grouped tuples' do
72
+ tuple = {
73
+ :id => 1,
74
+ :name => 'Jane',
75
+ :tasks => [
76
+ { :id => 2, :title => 'Task 1' },
77
+ { :id => 3, :title => 'Task 2' }
78
+ ]
79
+ }
80
+
81
+ task1 = Task.new(tuple[:tasks].first)
82
+ task2 = Task.new(tuple[:tasks].last)
83
+ user = User.new(:id => tuple[:id], :name => tuple[:name], :tasks => [task1, task2])
84
+
85
+ expect(mapper.dump(user)).to eql([1, 'Jane', [[2, 'Task 1'], [3, 'Task 2']]])
86
+ end
87
+ end