rom-core 4.2.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 044b27bb2f62959a8104b8cedfb544d984cf9305ebb6686202ee188289ce25f9
-  data.tar.gz: 6a6df536dd70a9cd558854d253cebeaef5b92630795fe459315d9719bd463e68
+  metadata.gz: b3f8bcda8c133820affac0b652c40ad16434c3c5ceaa3d8ceb34195562f8c4a9
+  data.tar.gz: 48611a1d36d140df12fd1ef93860f7349f95e81dc2b4d539da5dad979bf94565
 SHA512:
-  metadata.gz: c6bbfd8fb2eb40a8a5797d19fba7c0b168d537ee2fabedcf3b5b1c7cd0d1796ea8a29eb76c591fc29e478fe552da0a0ba6ace9fe6a695641e7f2783f8737abd4
-  data.tar.gz: 0f9c3e60b6d485ffec63a03e1fbb374ee46c55c3e7325e7c3f963a2dfe7fd05da4b1def89e92aa75387a927c57aa6eaf09dd7279792412471999471d424e582d
+  metadata.gz: a97ea813e0ed8ede39740911f2ee45a3679cdc8b50c5461ac0e07f171567f52f6ea77e18e424fb408e82ac67f289ccc98a89b142ade78ae66cc62f3baf4deb83
+  data.tar.gz: 06ba213179501490959c77c929fe399dda690baa915b105def02a4179b20e6e819fb5d84dfacb685792ff8605cc8ab407021bc75342dcd92ed8ade1d7cb8473a

data/README.md

@@ -1,10 +1,8 @@
 [gem]: https://rubygems.org/gems/rom-core
-[gemnasium]: https://gemnasium.com/rom-rb/rom-core
 
 # rom-core [![Gitter chat](https://badges.gitter.im/rom-rb/chat.svg)](https://gitter.im/rom-rb/chat)
 
 [![Gem Version](https://badge.fury.io/rb/rom-core.svg)][gem]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-core.svg)][gemnasium]
 
 Core API for rom-rb and its adapters and extensions.
 

data/lib/rom-core.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rom/core'

data/lib/rom/array_dataset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/initializer'
 require 'rom/enumerable_dataset'
 

data/lib/rom/association_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/registry'
 
 module ROM

data/lib/rom/associations/abstract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/constants'
 require 'dry/core/class_attributes'
 

data/lib/rom/associations/definitions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/definitions/many_to_many'
 require 'rom/associations/definitions/many_to_one'
 require 'rom/associations/definitions/one_to_many'

data/lib/rom/associations/definitions/abstract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_attributes'
 
 require 'rom/constants'

data/lib/rom/associations/definitions/many_to_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/types'
 require 'rom/associations/definitions/abstract'
 

data/lib/rom/associations/definitions/many_to_one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/definitions/abstract'
 
 module ROM

data/lib/rom/associations/definitions/one_to_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/definitions/abstract'
 
 module ROM

data/lib/rom/associations/definitions/one_to_one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/definitions/abstract'
 
 module ROM

data/lib/rom/associations/definitions/one_to_one_through.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/definitions/abstract'
 
 module ROM

data/lib/rom/associations/many_to_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/types'
 require 'rom/associations/abstract'
 

data/lib/rom/associations/many_to_one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/abstract'
 
 module ROM

data/lib/rom/associations/one_to_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/abstract'
 
 module ROM

data/lib/rom/associations/one_to_one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/one_to_many'
 
 module ROM

data/lib/rom/associations/one_to_one_through.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/associations/many_to_many'
 
 module ROM

data/lib/rom/associations/through_identifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 
 module ROM

data/lib/rom/attribute.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'dry/equalizer'
 
 require 'rom/initializer'
 require 'rom/support/memoizable'
+require 'rom/types'
 
 module ROM
   # Schema attributes provide meta information about types and an API
@@ -20,12 +23,42 @@ module ROM
     extend Initializer
 
     # @!attribute [r] type
-    #   @return [Dry::Types::Definition, Dry::Types::Sum, Dry::Types::Constrained] The attribute's type object
+    #   @return [Dry::Types::Nominal, Dry::Types::Sum, Dry::Types::Constrained] The attribute's type object
     param :type
 
+    # @!attribute [r] name
+    #
+    # Return the canonical name of this attribute name
+    #
+    # This *always* returns the name that is used in the datastore, even when
+    # an attribute is aliased
+    #
+    # @example
+    #   class Users < ROM::Relation[:memory]
+    #     schema do
+    #       attribute :user_id, Types::Integer, alias: :id
+    #       attribute :email, Types::String
+    #     end
+    #   end
+    #
+    #   users[:user_id].name
+    #   # => :user_id
+    #
+    #   users[:email].name
+    #   # => :email
+    #
+    # @return [Symbol]
+    #
+    # @api public
+    option :name, optional: true, type: Types::Strict::Symbol
+
+    # @!attribute [r] type
+    #   @return [Symbol, nil] Alias to use instead of attribute name
+    option :alias, optional: true, type: Types::Strict::Symbol.optional
+
     # @api private
-    def [](input)
-      type[input]
+    def [](value = Undefined)
+      type[value]
     end
 
     # Return true if this attribute type is a primary key
@@ -33,7 +66,7 @@ module ROM
     # @example
     #   class Users < ROM::Relation[:memory]
     #     schema do
-    #       attribute :id, Types::Int
+    #       attribute :id, Types::Integer
     #       attribute :name, Types::String
     #
     #       primary_key :id
@@ -58,7 +91,7 @@ module ROM
     # @example
     #   class Tasks < ROM::Relation[:memory]
     #     schema do
-    #       attribute :id, Types::Int
+    #       attribute :id, Types::Integer
     #       attribute :user_id, Types.ForeignKey(:users)
     #     end
     #   end
@@ -76,12 +109,12 @@ module ROM
       meta[:foreign_key].equal?(true)
     end
 
-    # Return true if this attribute type is a foreign key
+    # Return true if this attribute has a configured alias
     #
     # @example
     #   class Tasks < ROM::Relation[:memory]
     #     schema do
-    #       attribute :user_id, Types::Int.meta(alias: :id)
+    #       attribute :user_id, Types::Integer, alias: :id
     #       attribute :name, Types::String
     #     end
     #   end
@@ -96,7 +129,7 @@ module ROM
     #
     # @api public
     def aliased?
-      !meta[:alias].nil?
+      !self.alias.nil?
     end
 
     # Return source relation of this attribute type
@@ -104,7 +137,7 @@ module ROM
     # @example
     #   class Tasks < ROM::Relation[:memory]
     #     schema do
-    #       attribute :id, Types::Int
+    #       attribute :id, Types::Integer
     #       attribute :user_id, Types.ForeignKey(:users)
     #     end
     #   end
@@ -127,7 +160,7 @@ module ROM
     # @example
     #   class Tasks < ROM::Relation[:memory]
     #     schema do
-    #       attribute :id, Types::Int
+    #       attribute :id, Types::Integer
     #       attribute :user_id, Types.ForeignKey(:users)
     #     end
     #   end
@@ -145,32 +178,6 @@ module ROM
       meta[:target]
     end
 
-    # Return the canonical name of this attribute name
-    #
-    # This *always* returns the name that is used in the datastore, even when
-    # an attribute is aliased
-    #
-    # @example
-    #   class Tasks < ROM::Relation[:memory]
-    #     schema do
-    #       attribute :user_id, Types::Int.meta(alias: :id)
-    #       attribute :name, Types::String
-    #     end
-    #   end
-    #
-    #   Users.schema[:id].name
-    #   # => :id
-    #
-    #   Users.schema[:user_id].name
-    #   # => :user_id
-    #
-    # @return [Symbol]
-    #
-    # @api public
-    def name
-      meta[:name]
-    end
-
     # Return tuple key
     #
     # When schemas are projected with aliased attributes, we need a simple access to tuple keys
@@ -178,7 +185,7 @@ module ROM
     # @example
     #   class Tasks < ROM::Relation[:memory]
     #     schema do
-    #       attribute :user_id, Types::Int.meta(alias: :id)
+    #       attribute :user_id, Types::Integer, alias: :id
     #       attribute :name, Types::String
     #     end
     #   end
@@ -193,30 +200,7 @@ module ROM
     #
     # @api public
     def key
-      meta[:alias] || name
-    end
-
-    # Return attribute's alias
-    #
-    # @example
-    #   class Tasks < ROM::Relation[:memory]
-    #     schema do
-    #       attribute :user_id, Types::Int.meta(alias: :id)
-    #       attribute :name, Types::String
-    #     end
-    #   end
-    #
-    #   Users.schema[:user_id].alias
-    #   # => :user_id
-    #
-    #   Users.schema[:name].alias
-    #   # => nil
-    #
-    # @return [NilClass,Symbol]
-    #
-    # @api public
-    def alias
-      meta[:alias]
+      self.alias || name
     end
 
     # Return new attribute type with provided alias
@@ -224,7 +208,7 @@ module ROM
     # @example
     #   class Tasks < ROM::Relation[:memory]
     #     schema do
-    #       attribute :user_id, Types::Int
+    #       attribute :user_id, Types::Integer
     #       attribute :name, Types::String
     #     end
     #   end
@@ -246,7 +230,7 @@ module ROM
     #
     # @api public
     def aliased(name)
-      meta(alias: name)
+      with(alias: name)
     end
     alias_method :as, :aliased
 
@@ -255,7 +239,7 @@ module ROM
     # @example
     #   class Users < ROM::Relation[:memory]
     #     schema do
-    #       attribute :id, Types::Int
+    #       attribute :id, Types::Integer
     #       attribute :name, Types::String
     #     end
     #   end
@@ -318,7 +302,7 @@ module ROM
     # @api public
     def meta(opts = nil)
       if opts
-        self.class.new(type.meta(opts))
+        self.class.new(type.meta(opts), options)
       else
         type.meta
       end
@@ -330,7 +314,9 @@ module ROM
     #
     # @api public
     def inspect
-      %(#<#{self.class}[#{type.name}] #{meta.map { |k, v| "#{k}=#{v.inspect}" }.join(' ')}>)
+      opts = options.reject { |k| %i[type name].include?(k) }
+      meta_and_opts = meta.merge(opts).map { |k, v| "#{k}=#{v.inspect}" }
+      %(#<#{self.class}[#{type.name}] name=#{name.inspect} #{meta_and_opts.join(' ')}>)
     end
     alias_method :pretty_inspect, :inspect
 
@@ -394,7 +380,7 @@ module ROM
     #
     # @api public
     def to_ast
-      [:attribute, [name, type.to_ast(meta: false), meta_ast]]
+      [:attribute, [name, type.to_ast(meta: false), meta_options_ast]]
     end
 
     # Return AST for the read type
@@ -403,18 +389,18 @@ module ROM
     #
     # @api public
     def to_read_ast
-      [:attribute, [name, to_read_type.to_ast(meta: false), meta_ast]]
+      [:attribute, [name, to_read_type.to_ast(meta: false), meta_options_ast]]
     end
 
     # @api private
-    def meta_ast
-      meta_keys = %i(wrapped alias primary_key)
-      ast = meta.select { |k, _| meta_keys.include?(k) }
+    def meta_options_ast
+      keys = %i[wrapped primary_key alias]
+      ast = meta.merge(options).select { |k, _| keys.include?(k) }
       ast[:source] = source.to_sym if source
       ast
     end
 
-    memoize :to_ast, :to_read_ast, :meta_ast
+    memoize :to_ast, :to_read_ast, :meta_options_ast
 
     private
 

data/lib/rom/auto_curry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   # Relation extension which provides auto-currying of relation view methods
   #

data/lib/rom/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'concurrent/map'
 
 module ROM

data/lib/rom/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/deprecations'
 require 'dry/core/class_attributes'
 
@@ -85,7 +87,7 @@ module ROM
     # @api public
     defines :relation
 
-    # @!method self.relation
+    # @!method self.result
     #   Get or set result type
     #
     #   @overload result
@@ -101,7 +103,7 @@ module ROM
     #
     #     @return [Symbol]
     #
-    #   @overload relation(identifier)
+    #   @overload result(identifier)
     #     Set result type
     #
     #     @example
@@ -112,7 +114,7 @@ module ROM
     # @api public
     defines :result
 
-    # @!method self.relation
+    # @!method self.input
     #   Get or set input processing function. This is typically set during setup
     #   to relation's input_schema
     #
@@ -314,7 +316,7 @@ module ROM
       if curry_args.empty? && args.first.is_a?(Graph::InputEvaluator)
         Lazy[self].new(self, *args)
       else
-        self.class.build(relation, **options, curry_args: args)
+        self.class.build(relation, { **options, curry_args: args })
       end
     end
 
@@ -386,7 +388,7 @@ module ROM
     #
     # @api public
     def new(new_relation)
-      self.class.build(new_relation, **options, source: relation)
+      self.class.build(new_relation, {**options, source: relation})
     end
 
     # Check if this command has any hooks