rom-core 4.0.0.beta3 → 4.0.0.rc1

data/lib/rom/setup/auto_registration_strategies/no_namespace.rb

@@ -6,10 +6,21 @@ require 'rom/setup/auto_registration_strategies/base'
 
 module ROM
   module AutoRegistrationStrategies
+    # NoNamespace strategy assumes components are not defined within a namespace
+    #
+    # @api private
     class NoNamespace < Base
+      # @!attribute [r] directory
+      #   @return [Pathname] The path to dir with components
       option :directory, type: PathnameType
+
+      # @!attribute [r] entity
+      #   @return [Symbol] Component identifier
       option :entity, type: Types::Strict::Symbol
 
+      # Load components
+      #
+      # @api private
       def call
         Dry::Core::Inflector.camelize(
           file.sub(/^#{directory}\/#{entity}\//, '').sub(EXTENSION_REGEX, '')

data/lib/rom/setup/auto_registration_strategies/with_namespace.rb

@@ -5,9 +5,18 @@ require 'rom/setup/auto_registration_strategies/base'
 
 module ROM
   module AutoRegistrationStrategies
+    # WithNamespace strategy assumes components are defined within a namespace
+    # that matches top-level directory name.
+    #
+    # @api private
     class WithNamespace < Base
+      # @!attribute [r] directory
+      #   @return [Pathname] The path to dir with components
       option :directory, type: PathnameType
 
+      # Load components
+      #
+      # @api private
       def call
         Dry::Core::Inflector.camelize(
           file.sub(/^#{directory.dirname}\//, '').sub(EXTENSION_REGEX, '')

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

@@ -20,6 +20,8 @@ module ROM
 
       # @api private
       def run!
+        cache = Cache.new
+
         mappers = registry_hash.each_with_object({}) do |(relation_name, relation_mappers), h|
           relation_mappers.update(build_mappers(relation_name))
 
@@ -27,10 +29,10 @@ module ROM
             relation_mappers.update(mapper_objects[relation_name])
           end
 
-          h[relation_name] = MapperRegistry.new(relation_mappers)
+          h[relation_name] = MapperRegistry.new(relation_mappers, cache: cache)
         end
 
-        Registry.new(mappers)
+        Registry.new(mappers, cache: cache)
       end
 
       private

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

@@ -101,7 +101,7 @@ module ROM
           dataset: dataset, relation: klass, adapter: klass.adapter
         )
 
-        mappers = @mappers.key?(rel_key) ? @mappers[rel_key] : MapperRegistry.new
+        mappers = @mappers.key?(rel_key) ? @mappers[rel_key] : MapperRegistry.new({}, cache: @mappers.cache)
 
         options = { __registry__: registry, mappers: mappers, schema: schema, **plugin_options }
 

data/lib/rom/support/configurable.rb

@@ -1,9 +1,14 @@
 module ROM
+  # This extension is only used for environment objects to configure arbitrary options, each
+  # adapter can use them according to what they need.
+  #
   # @api private
   module Configurable
     class Config
       WRITER_REGEXP = /=$/.freeze
 
+      # @!attribute [r] settings
+      #   @return [Hash] A hash with defined settings
       attr_reader :settings
 
       # @api private
@@ -11,6 +16,10 @@ module ROM
         @settings = settings
       end
 
+      # Return a setting
+      #
+      # @return [Mixed]
+      #
       # @api public
       def [](name)
         public_send(name)
@@ -36,6 +45,7 @@ module ROM
         true
       end
 
+      # @api private
       def dup
         self.class.new(dup_settings(settings))
       end
@@ -72,10 +82,19 @@ module ROM
       end
     end
 
+    # Return config instance
+    #
+    # @return [Config]
+    #
+    # @api private
     def config
       @config ||= Config.new
     end
 
+    # Yield config instance
+    #
+    # @return [self]
+    #
     # @api public
     def configure
       yield(config)

data/lib/rom/support/notifications.rb

@@ -38,6 +38,9 @@ module ROM
   module Notifications
     LISTENERS_HASH = Hash.new { |h, k| h[k] = [] }
 
+    # Extension used for classes that can trigger events
+    #
+    # @api public
     module Publisher
       # Subscribe to events.
       # If the query parameter is provided, filters events by payload.
@@ -74,10 +77,18 @@ module ROM
     class Event
       include Dry::Equalizer(:id, :payload)
 
-      # @attr_reader [String] id Event ID
+      # @!attribute [r] id
+      #   @return [Symbol] The event identifier
       attr_reader :id
 
-      # @api public
+      # Initialize a new event
+      #
+      # @param [Symbol] id The event identifier
+      # @param [Hash] payload Optional payload
+      #
+      # @return [Event]
+      #
+      # @api private
       def initialize(id, payload = EMPTY_HASH)
         @id = id
         @payload = payload
@@ -158,6 +169,8 @@ module ROM
       EventBus.new(id, events: events.dup, listeners: listeners.dup)
     end
 
+    # Extension for objects that can listen to events
+    #
     # @api public
     module Listener
       # Subscribe to events
@@ -180,10 +193,24 @@ module ROM
     class EventBus
       include Publisher
 
+      # @!attribute [r] id
+      #   @return [Symbol] The bus identifier
       attr_reader :id
+
+      # @!attribute [r] events
+      #   @return [Hash] A hash with events registered within a bus
       attr_reader :events
+
+      # @!attribute [r] listeners
+      #   @return [Hash] A hash with event listeners registered within a bus
       attr_reader :listeners
 
+      # Initialize a new event bus
+      #
+      # @param [Symbol] id The bus identifier
+      # @param [Hash] events A hash with events
+      # @param [Hash] listeners A hash with listeners
+      #
       # @api public
       def initialize(id, events: EMPTY_HASH, listeners: LISTENERS_HASH.dup)
         @id = id

data/lib/rom/types.rb

@@ -1,26 +1,71 @@
 require 'dry-types'
+require 'json'
 
 module ROM
+  # Default namespace with built-in attribute types
+  #
+  # @api public
   module Types
     include Dry::Types.module
 
+    # @api private
     def self.included(other)
       other.extend(Methods)
       super
     end
 
-    def self.Definition(primitive)
-      Dry::Types::Definition.new(primitive)
-    end
-
-    def self.Constructor(primitive, &block)
-      Types.Definition(primitive).constructor(&block)
-    end
-
+    # Type extensions
+    #
+    # @api public
     module Methods
+      # Shortcut for defining a foreign key attribute type
+      #
+      # @param [Symbol] relation The name of the target relation
+      # @param [Object] type The type of an attribute
+      #
+      # @return [Dry::Types::Definition]
+      #
+      # @api public
       def ForeignKey(relation, type = Types::Int)
         type.meta(foreign_key: true, target: relation)
       end
     end
+
+    # Define a json-to-hash attribute type
+    #
+    # @return [Dry::Types::Constructor]
+    #
+    # @api public
+    def Coercible.JSONHash(symbol_keys: false, type: Types::Hash)
+      Types.Constructor(type) do |value|
+        begin
+          ::JSON.parse(value.to_s, symbolize_names: symbol_keys)
+        rescue ::JSON::ParserError
+          value
+        end
+      end
+    end
+
+    # Define a hash-to-json attribute type
+    #
+    # @return [Dry::Types::Constructor]
+    #
+    # @api public
+    def Coercible.HashJSON(type: Types::String)
+      Types.Constructor(type) { |value| ::JSON.dump(value) }
+    end
+
+    # Define a json type with json-to-hash read type
+    #
+    # @return [Dry::Types::Constructor]
+    #
+    # @api public
+    def Coercible.JSON(symbol_keys: false)
+      self.HashJSON.meta(read: self.JSONHash(symbol_keys: symbol_keys))
+    end
+
+    Coercible::JSON = Coercible.JSON
+    Coercible::JSONHash = Coercible.JSONHash
+    Coercible::HashJSON = Coercible.HashJSON
   end
 end

data/lib/rom/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Core
-    VERSION = '4.0.0.beta3'.freeze
+    VERSION = '4.0.0.rc1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-core
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta3
+  version: 4.0.0.rc1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -58,20 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rom-mapper
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +273,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"