rom 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f727af1309d22c607fa43b3c26345749233dbef
-  data.tar.gz: 7a1d5142394e77da212457c8d656ca2d9d632759
+  metadata.gz: 1a76e7a694c3096111424b115fe238285183a2e8
+  data.tar.gz: 27559d733a9470cbdc93878625b5c0157ec56964
 SHA512:
-  metadata.gz: 2b915a97368fd38abcaab1160d28bbc4aa5b218415fc58605fc8517d6149ca21f7ae749b383a5733e00d937b362dde5a0e61e3acfe65d98e0c847a6632982682
-  data.tar.gz: ca3d98f9a4446d108bc029aa6ee8da32a0185b52a6a2dd4ed007abf702fb7cf1a8d742b300db5d796ba2e141b3f90bc0608182198f7d64c3e4cfb90265d5c4a4
+  metadata.gz: 27fcabc336dde4cee458d52311b3f2eed5934bc5a12055f339a0e7051e14526d14a17fc4aa2d581aa4ccf58ae4fc83357ae87689a328e4b4c2b9c530a5ffa2f6
+  data.tar.gz: bf6a440ce37fe9953752c8781737361b1cae014afd78d808db2468a71de68c9e0af7bb7d6920227ce4317a25e5bba86ae64b0f1150d20eccf05416f94089108f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v3.3.0 2017-07-05
+
+This release only adds deprecation warnings in preparation for rom 4.0 release.
+
+[Compare v3.2.3...v3.3.0](https://github.com/rom-rb/rom/compare/v3.2.3...v3.3.0)
+
 # v3.2.3 2017-05-31
 
 ## Added

data/lib/rom/association_set.rb

@@ -1,4 +1,6 @@
+require 'dry/core/deprecations'
 require 'dry/core/inflector'
+
 require 'rom/registry'
 
 module ROM
@@ -10,6 +12,14 @@ module ROM
       if key?(key) || key?(singularize(key))
         yield(self[key])
       else
+        msg = <<-STR
+          Key inference will be removed in rom 4.0. You need to define :#{key} association.
+            => Called at:
+               #{caller.join("\n")}
+          STR
+
+        Dry::Core::Deprecations.warn(msg)
+
         false
       end
     end

data/lib/rom/command.rb

@@ -29,6 +29,7 @@ module ROM
     include Pipeline::Operator
 
     extend Dry::Core::ClassAttributes
+    extend Dry::Core::Deprecations[:rom]
     extend ClassInterface
 
     # @!method self.adapter
@@ -316,7 +317,12 @@ module ROM
         self.class.build(relation, **options, curry_args: args)
       end
     end
-    alias_method :with, :curry
+
+    # @api public
+    def with(*args)
+      self.class.warn "Command#with will change its behavior in rom 4.0. Use Command#curry instead.\n\n#{caller[0..5].join("\n")}"
+      curry(*args)
+    end
 
     # Compose this command with other commands
     #

data/lib/rom/command_registry.rb

@@ -1,3 +1,5 @@
+require 'dry/core/deprecations'
+
 require 'rom/types'
 require 'rom/commands/result'
 
@@ -7,6 +9,8 @@ module ROM
   # @api public
   class CommandRegistry
     extend Initializer
+    extend Dry::Core::Deprecations[:rom]
+
     include Commands
 
     CommandNotFoundError = Class.new(KeyError)
@@ -43,6 +47,8 @@ module ROM
     #
     # @api public
     def try(&block)
+      self.class.warn "CommandRegistry#try will be removed in rom 4.0"
+
       response = block.call
 
       if response.is_a?(Command) || response.is_a?(Composite)

data/lib/rom/commands/graph/class_interface.rb

@@ -44,7 +44,7 @@ module ROM
           tuple_path = Array[*path] << key
           input_proc = InputEvaluator.build(tuple_path, nodes)
 
-          command = command.with(input_proc, opts)
+          command = command.curry(input_proc, opts)
 
           if nodes
             if nodes.all? { |node| node.is_a?(Array) }

data/lib/rom/configuration_dsl.rb

@@ -21,7 +21,7 @@ module ROM
     def relation(name, options = EMPTY_HASH, &block)
       klass_opts = { adapter: default_adapter }.merge(options)
       klass = Relation.build_class(name, klass_opts)
-      klass.register_as(name)
+      klass.register_as(name, deprecation: false)
       klass.class_eval(&block) if block
       register_relation(klass)
       klass

data/lib/rom/configuration_dsl/relation.rb

@@ -18,7 +18,7 @@ module ROM
 
         Dry::Core::ClassBuilder.new(name: class_name, parent: ROM::Relation[adapter]).call do |klass|
           klass.gateway(options.fetch(:gateway, :default))
-          klass.dataset(name)
+          klass.dataset(name, deprecation: false)
         end
       end
     end

data/lib/rom/container.rb

@@ -1,3 +1,5 @@
+require 'dry/core/deprecations'
+
 require 'rom/relation/loaded'
 require 'rom/commands/graph'
 require 'rom/commands/graph/builder'
@@ -97,6 +99,8 @@ module ROM
   #
   # @api public
   class Container
+    extend Dry::Core::Deprecations[:rom]
+
     include Dry::Equalizer(:gateways, :relations, :mappers, :commands)
 
     # @!attribute [r] gateways
@@ -150,6 +154,8 @@ module ROM
     #
     # @api public
     def relation(name, &block)
+      Dry::Core::Deprecations.warn("#{self.class}#relation is deprecated and will be removed in 4.0\n\n#{caller[0..5].join("\n")}")
+
       relation =
         if block
           yield(relations[name])
@@ -184,6 +190,8 @@ module ROM
     #
     # @api public
     def command(options = nil)
+      Dry::Core::Deprecations.warn("#{self.class}#command is deprecated and will be removed in 4.0\n\n#{caller[0..5].join("\n")}")
+
       case options
       when Symbol
         name = options

data/lib/rom/pipeline.rb

@@ -40,7 +40,21 @@ module ROM
       [self, *names.map { |name| mappers[name] }]
         .reduce { |a, e| composite_class.new(a, e) }
     end
-    alias_method :as, :map_with
+
+    # @api public
+    def as(*names)
+      new_meth = names[0].is_a?(Class) ? 'map_to' : 'map_with'
+
+      msg = <<-STR
+          Relation#as will change behavior in 4.0. Use `#{new_meth}` instead
+            => Called at:
+               #{caller.join("\n")}
+          STR
+
+      Dry::Core::Deprecations.warn(msg)
+
+      map_with(*names)
+    end
 
     # Forwards messages to the left side of a pipeline
     #

data/lib/rom/relation/class_interface.rb

@@ -1,6 +1,7 @@
 require 'set'
 
 require 'dry/core/inflector'
+require 'dry/core/deprecations'
 require 'dry/core/constants'
 
 require 'rom/auto_curry'
@@ -13,6 +14,8 @@ module ROM
   class Relation
     # @api public
     module ClassInterface
+      extend Dry::Core::Deprecations[:rom]
+
       include Dry::Core::Constants
 
       # Register adapter relation subclasses during setup phase
@@ -76,9 +79,15 @@ module ROM
           # @param [Symbol] value The name of the dataset
           #
           # @api public
-          def self.dataset(value = Undefined, &block)
-            dataset_proc(block) if block
-            super
+          def self.dataset(*args, deprecation: true, &block)
+            if block
+              dataset_proc(block)
+            elsif args.size > 0
+              if deprecation
+                warn("Relation.dataset is deprecated in favor of schema settings\n\n#{caller[0..5].join("\n")}")
+              end
+            end
+            super(*args)
           end
 
           # Set or get name under which a relation will be registered
@@ -88,8 +97,12 @@ module ROM
           # @return [Symbol]
           #
           # @api public
-          def self.register_as(value = Undefined)
-            if value == Undefined
+          def self.register_as(*args, deprecation: true)
+            if deprecation && args.size > 0
+              warn("Relation.register_as is deprecated in favor of schema settings\n\n#{caller[0..5].join("\n")}")
+            end
+
+            if args.empty?
               return @register_as if defined?(@register_as)
 
               super_val = super()
@@ -100,7 +113,7 @@ module ROM
                 super_val == dataset ? default_name : super_val
               end
             else
-              super
+              super(*args)
             end
           end
 
@@ -158,12 +171,12 @@ module ROM
         if defined?(@schema)
           @schema
         elsif block || infer
-          self.dataset(dataset) if dataset
+          self.dataset(dataset, deprecation: false) if dataset
 
           if as
-            self.register_as(as)
+            self.register_as(as, deprecation: false)
           else
-            self.register_as(self.dataset) unless register_as
+            self.register_as(self.dataset, deprecation: false) unless register_as
           end
 
           name = Name[register_as, self.dataset]

data/lib/rom/setup/finalize.rb

@@ -120,7 +120,7 @@ module ROM
           if infer_relation?(gateway, name)
             klass = ROM::ConfigurationDSL::Relation.build_class(name, adapter: adapter_for(gateway))
             klass.gateway(gateway)
-            klass.dataset(name)
+            klass.dataset(name, deprecation: false)
             @relation_classes << klass
           else
             next

data/lib/rom/setup/finalize/finalize_relations.rb

@@ -58,7 +58,7 @@ module ROM
           plugin.apply_to(klass)
         end
 
-        dataset = gateway.dataset(klass.dataset).instance_exec(klass, &ds_proc)
+        dataset = gateway.dataset(klass.schema.name.dataset).instance_exec(klass, &ds_proc)
 
         options = { __registry__: registry, schema: schema.with(relations: registry), **plugin_options }
 

data/lib/rom/version.rb

@@ -1,3 +1,3 @@
 module ROM
-  VERSION = '3.2.3'.freeze
+  VERSION = '3.3.0'.freeze
 end

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

@@ -79,27 +79,28 @@ RSpec.describe ROM::Relation::Graph do
 
   describe '#call' do
     it 'materializes relations' do
-      expect(graph.call).to match_array([
-        users_relation,
-        [tasks_relation]
-      ])
+      root, nodes = graph.call.to_a
+
+      expect(root.to_a).to eql(users_relation.to_a)
+      expect(nodes.flatten).to eql(tasks_relation.to_a)
     end
   end
 
   describe '#to_a' do
     it 'coerces to an array' do
-      expect(graph).to match_array([
-        users_relation.to_a,
-        [tasks_relation.for_users(users_relation).to_a]
-      ])
+      root, nodes = graph.to_a
+
+      expect(root.to_a).to eql(users_relation.to_a)
+      expect(nodes.flatten).to eql(tasks_relation.for_users(users_relation).to_a)
     end
 
     it 'returns empty arrays when left was empty' do
       graph = ROM::Relation::Graph.new(users_relation.by_name('Not here'), [tasks_relation.for_users])
 
-      expect(graph).to match_array([
-        [], [ROM::Relation::Loaded.new(tasks_relation.for_users, [])]
-      ])
+      root, nodes = graph.to_a
+
+      expect(root).to be_empty
+      expect(nodes.flatten).to be_empty
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -401,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby Object Mapper