rom-core 4.2.1 → 5.0.0

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/constants'
 require 'rom/relation_registry'
 require 'rom/mapper_registry'

data/lib/rom/struct.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+
+module ROM
+  # Simple data-struct class
+  #
+  # ROM structs are plain data structures loaded by repositories.
+  # They implement Hash protocol which means that they can be used
+  # in places where Hash-like objects are supported.
+  #
+  # Repositories define subclasses of ROM::Struct automatically, they are
+  # defined in the ROM::Struct namespace by default, but you set it up
+  # to use your namespace/module as well.
+  #
+  # Structs are based on dry-struct gem, they include `schema` with detailed information
+  # about attribute types returned from relations, thus can be introspected to build
+  # additional functionality when desired.
+  #
+  # There is a caveat you should know about when working with structs. Struct classes
+  # have names but at the same time they're anonymous, i.e. you can't get the User struct class
+  # with ROM::Struct::User. ROM will create as many struct classes for User as needed,
+  # they all will have the same name and ROM::Struct::User will be the common parent class for
+  # them. Combined with the ability to provide your own namespace for structs this enables to
+  # pre-define the parent class.
+  #
+  # @example accessing relation struct model
+  #   rom = ROM.container(:sql, 'sqlite::memory') do |conf|
+  #     conf.default.create_table(:users) do
+  #       primary_key :id
+  #       column :name, String
+  #     end
+  #   end
+  #
+  #   class UserRepo < ROM::Repository[:users]
+  #   end
+  #
+  #   user_repo = UserRepo.new(rom)
+  #
+  #   # get auto-generated User struct
+  #   model = user_repo.users.mapper.model
+  #   # => ROM::Struct::User
+  #
+  #   # see struct's schema attributes
+  #
+  #   # model.schema.key(:id)
+  #   # => #<Dry::Types[id: Nominal<Integer meta={primary_key: true, source: :users}>]>
+  #
+  #   model.schema[:name]
+  #   # => #<Dry::Types[name: Sum<Nominal<NilClass> | Nominal<String> meta={source: :users}>]>
+  #
+  # @example passing a namespace with an existing parent class
+  #   module Entities
+  #     class User < ROM::Struct
+  #       def upcased_name
+  #         name.upcase
+  #       end
+  #     end
+  #   end
+  #
+  #   class UserRepo < ROM::Repository[:users]
+  #     struct_namespace Entities
+  #   end
+  #
+  #   user_repo = UserRepo.new(rom)
+  #   user = user_repo.users.by_pk(1).one!
+  #   user.name # => "Jane"
+  #   user.upcased_name # => "JANE"
+  #
+  # @see http://dry-rb.org/gems/dry-struct dry-struct
+  # @see http://dry-rb.org/gems/dry-types dry-types
+  #
+  # @api public
+  class Struct < Dry::Struct
+    MissingAttribute = Class.new(NameError) do
+      def initialize(&block)
+        super
+        @message_proc = block
+      end
+
+      def message
+        @message_proc.call
+      end
+    end
+
+    # Return attribute value
+    #
+    # @param [Symbol] name The attribute name
+    #
+    # @api public
+    def fetch(name)
+      __send__(name)
+    end
+
+    # @api private
+    def respond_to_missing?(*)
+      super
+    end
+
+    private
+
+    def method_missing(*)
+      super
+    rescue NameError => error
+      raise MissingAttribute.new { "#{ error.message } (attribute not loaded?)" }
+    end
+  end
+end

data/lib/rom/struct_compiler.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'rom/support/inflector'
+require 'dry/core/class_builder'
+require 'dry/types/compiler'
+
+require 'rom/initializer'
+require 'rom/types'
+require 'rom/cache'
+require 'rom/struct'
+require 'rom/open_struct'
+require 'rom/attribute'
+
+module ROM
+  # @api private
+  class StructCompiler < Dry::Types::Compiler
+    extend Initializer
+
+    param :registry, default: -> { Dry::Types }
+    option :cache, default: -> { Cache.new }
+
+    # @api private
+    def initialize(*args)
+      super
+      @cache = cache.namespaced(:structs)
+    end
+
+    # Build a struct class based on relation header ast
+    #
+    # @api private
+    def call(*args)
+      cache.fetch_or_store(args) do
+        name, header, ns = args
+        attributes = header.map(&method(:visit)).compact
+
+        if attributes.empty?
+          ROM::OpenStruct
+        else
+          build_class(name, ROM::Struct, ns) do |klass|
+            klass.attributes(attributes.to_h)
+          end
+        end
+      end
+    end
+    alias_method :[], :call
+
+    private
+
+    # @api private
+    def visit_relation(node)
+      _, header, meta = node
+      name = meta[:combine_name] || meta[:alias]
+      namespace = meta.fetch(:struct_namespace)
+
+      model = meta[:model] || call(name, header, namespace)
+
+      member =
+        if model < Dry::Struct
+          model
+        else
+          Dry::Types::Nominal.new(model).constructor(&model.method(:new))
+        end
+
+      if meta[:combine_type] == :many
+        [name, Types::Array.of(member)]
+      else
+        [name, member.optional]
+      end
+    end
+
+    # @api private
+    def visit_attribute(node)
+      name, type, meta = node
+
+      [meta[:alias] && !meta[:wrapped] ? meta[:alias] : name, visit(type).meta(meta)]
+    end
+
+    # @api private
+    def visit_constructor(node)
+      definition, * = node
+
+      visit(definition)
+    end
+
+    # @api private
+    def visit_constrained(node)
+      definition, _ = node
+
+      visit(definition)
+    end
+
+    # @api private
+    def visit_enum(node)
+      type_node, * = node
+      visit(type_node)
+    end
+
+    # @api private
+    def build_class(name, parent, ns, &block)
+      Dry::Core::ClassBuilder.
+        new(name: class_name(name), parent: parent, namespace: ns).
+        call(&block)
+    end
+
+    # @api private
+    def class_name(name)
+      Inflector.classify(Inflector.singularize(name))
+    end
+  end
+end

data/lib/rom/support/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   # This extension is only used for environment objects to configure arbitrary options, each
   # adapter can use them according to what they need.

data/lib/rom/support/inflector.rb

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

data/lib/rom/support/memoizable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   # @api private
   module Memoizable

data/lib/rom/support/notifications.rb

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

data/lib/rom/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   # @api private
   class Transaction

data/lib/rom/transformer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'dry/core/class_attributes'
+require 'transproc/transformer'
+
+require 'rom/processor/transproc'
+
+module ROM
+  # Transformer is a data mapper which uses Transproc's transformer DSL to define
+  # transformations.
+  #
+  # @api public
+  class Transformer < Transproc::Transformer[ROM::Processor::Transproc::Functions]
+    extend Dry::Core::ClassAttributes
+
+    defines :relation, :register_as
+
+    # This is needed to make transformers compatible with rom setup
+    #
+    # @api private
+    def self.base_relation
+      relation
+    end
+
+    # Build a mapper instance
+    #
+    # @return [Transformer]
+    #
+    # @api public
+    def self.build
+      new
+    end
+  end
+end

data/lib/rom/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-types'
 require 'json'
 
@@ -5,8 +7,10 @@ module ROM
   # Default namespace with built-in attribute types
   #
   # @api public
+  #
+  # rubocop:disable Naming/MethodName
   module Types
-    include Dry::Types.module
+    include Dry::Types(default: :nominal)
 
     # @api private
     def self.included(other)
@@ -23,14 +27,16 @@ module ROM
       # @param [Symbol] relation The name of the target relation
       # @param [Object] type The type of an attribute
       #
-      # @return [Dry::Types::Definition]
+      # @return [Dry::Types::Nominal]
       #
       # @api public
-      def ForeignKey(relation, type = Types::Int)
+      def ForeignKey(relation, type = Types::Integer)
         type.meta(foreign_key: true, target: relation)
       end
     end
 
+    # @!parse module Coercible;end
+
     # Define a json-to-hash attribute type
     #
     # @return [Dry::Types::Constructor]
@@ -68,4 +74,5 @@ module ROM
     Coercible::JSONHash = Coercible.JSONHash
     Coercible::HashJSON = Coercible.HashJSON
   end
+  # rubocop:enable Naming/MethodName
 end

data/lib/rom/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ROM
   module Core
-    VERSION = '4.2.1'.freeze
+    VERSION = '5.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-core
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -86,48 +86,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: dry-initializer
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rom-mapper
+  name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -218,12 +218,22 @@ files:
 - lib/rom/gateway.rb
 - lib/rom/global.rb
 - lib/rom/global/plugin_dsl.rb
+- lib/rom/header.rb
+- lib/rom/header/attribute.rb
 - lib/rom/initializer.rb
 - lib/rom/lint/enumerable_dataset.rb
 - lib/rom/lint/gateway.rb
 - lib/rom/lint/linter.rb
 - lib/rom/lint/spec.rb
 - lib/rom/lint/test.rb
+- lib/rom/mapper.rb
+- lib/rom/mapper/attribute_dsl.rb
+- lib/rom/mapper/builder.rb
+- lib/rom/mapper/configuration_plugin.rb
+- lib/rom/mapper/dsl.rb
+- lib/rom/mapper/mapper_dsl.rb
+- lib/rom/mapper/model_dsl.rb
+- lib/rom/mapper_compiler.rb
 - lib/rom/mapper_registry.rb
 - lib/rom/memory.rb
 - lib/rom/memory/associations.rb
@@ -239,6 +249,8 @@ files:
 - lib/rom/memory/schema.rb
 - lib/rom/memory/storage.rb
 - lib/rom/memory/types.rb
+- lib/rom/model_builder.rb
+- lib/rom/open_struct.rb
 - lib/rom/pipeline.rb
 - lib/rom/plugin.rb
 - lib/rom/plugin_base.rb
@@ -248,6 +260,8 @@ files:
 - lib/rom/plugins/relation/instrumentation.rb
 - lib/rom/plugins/relation/registry_reader.rb
 - lib/rom/plugins/schema/timestamps.rb
+- lib/rom/processor.rb
+- lib/rom/processor/transproc.rb
 - lib/rom/registry.rb
 - lib/rom/relation.rb
 - lib/rom/relation/class_interface.rb
@@ -277,11 +291,14 @@ files:
 - lib/rom/setup/finalize/finalize_commands.rb
 - lib/rom/setup/finalize/finalize_mappers.rb
 - lib/rom/setup/finalize/finalize_relations.rb
+- lib/rom/struct.rb
+- lib/rom/struct_compiler.rb
 - lib/rom/support/configurable.rb
 - lib/rom/support/inflector.rb
 - lib/rom/support/memoizable.rb
 - lib/rom/support/notifications.rb
 - lib/rom/transaction.rb
+- lib/rom/transformer.rb
 - lib/rom/types.rb
 - lib/rom/version.rb
 homepage: http://rom-rb.org
@@ -296,15 +313,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby Object Mapper