rom 3.3.3 → 4.0.0.beta1

data/lib/rom/enumerable_dataset.rb

@@ -1,68 +0,0 @@
-require 'rom/initializer'
-require 'rom/data_proxy'
-
-module ROM
-  # A helper module that adds data-proxy behavior to an enumerable object
-  #
-  # This module is intended to be used by gateways
-  #
-  # Class that includes this module can define `row_proc` class method which
-  # must return a proc-like object which will be used to process each element
-  # in the enumerable
-  #
-  # @example
-  #   class MyDataset
-  #     include ROM::EnumerableDataset
-  #
-  #     def self.row_proc
-  #       -> tuple { tuple.each_with_object({}) { |(k,v), h| h[k.to_sym] = v } }
-  #     end
-  #   end
-  #
-  #   ds = MyDataset.new([{ 'name' => 'Jane' }, [:name])
-  #   ds.to_a # => { :name => 'Jane' }
-  #
-  # @api public
-  module EnumerableDataset
-    extend DataProxy::ClassMethods
-    include Enumerable
-
-    # Coerce a dataset to an array
-    #
-    # @return [Array]
-    #
-    # @api public
-    alias_method :to_ary, :to_a
-
-    # Included hook which extends a class with DataProxy behavior
-    #
-    # This module can also be included into other modules so we apply the
-    # extension only for classes
-    #
-    # @api private
-    def self.included(klass)
-      return unless klass.is_a?(Class)
-
-      klass.class_eval do
-        extend Initializer
-        include DataProxy
-
-        param :data
-      end
-    end
-
-    forward :take
-
-    [
-      :chunk, :collect, :collect_concat, :drop_while, :find_all, :flat_map,
-      :grep, :map, :reject, :select, :sort, :sort_by, :take_while
-    ].each do |method|
-      class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{method}(*args, &block)
-          return to_enum unless block
-          self.class.new(super(*args, &block), options)
-        end
-      RUBY
-    end
-  end
-end

data/lib/rom/environment.rb

@@ -1,70 +0,0 @@
-require 'rom/support/configurable'
-require 'rom/gateway'
-
-module ROM
-  # Core gateway configuration interface
-  #
-  # @api public
-  class Environment
-    include Configurable
-
-    attr_reader :gateways, :gateways_map
-
-    # @api public
-    def initialize(*args)
-      @gateways = {}
-      @gateways_map = {}
-
-      configure_gateways(*args) unless args.empty?
-    end
-
-    private
-
-    def configure_gateways(*args)
-      normalized_gateway_args = normalize_gateway_args(*args)
-      normalized_gateways = normalize_gateways(normalized_gateway_args)
-
-      @gateways, @gateways_map = normalized_gateways.values_at(:gateways, :map)
-
-      normalized_gateway_args.each_with_object(config) do |(name, gateway_config), config|
-        options = gateway_config.is_a?(Array) && gateway_config.last
-        load_config(config.gateways[name], options) if options.is_a?(Hash)
-      end
-    end
-
-
-    # @api private
-    def normalize_gateway_args(*args)
-      args.first.is_a?(Hash) ? args.first : {default: args}
-    end
-
-    # Build gateways using the setup interface
-    #
-    # @api private
-    def normalize_gateways(gateways_config)
-      gateways_config.each_with_object({map: {}, gateways: {}}) do |(name, spec), hash|
-        identifier, *args = Array(spec)
-
-        if identifier.is_a?(Gateway)
-          gateway = identifier
-        else
-          gateway = Gateway.setup(identifier, *(args.flatten))
-          hash[:map][gateway] = identifier
-        end
-
-        hash[:gateways][name] = gateway
-      end
-    end
-
-    # @api private
-    def load_config(config, hash)
-      hash.each do |key, value|
-        if value.is_a?(Hash)
-          load_config(config[key], value)
-        else
-          config.send("#{key}=", value)
-        end
-      end
-    end
-  end
-end

data/lib/rom/gateway.rb

@@ -1,196 +0,0 @@
-require 'dry/core/class_attributes'
-
-require 'rom/transaction'
-
-module ROM
-  # Abstract gateway class
-  #
-  # Every adapter needs to inherit from this class and implement
-  # required interface
-  #
-  # @abstract
-  #
-  # @api public
-  class Gateway
-    extend Dry::Core::ClassAttributes
-
-    defines :adapter
-
-    # @!attribute [r] connection
-    #   @return [Object] The gateway's connection object (type varies across adapters)
-    attr_reader :connection
-
-    # Set up a gateway
-    #
-    # @overload setup(type, *args)
-    #   Sets up a single-gateway given a gateway type.
-    #   For custom gateways, create an instance and pass it directly.
-    #
-    #   @example
-    #     module SuperDB
-    #       class Gateway < ROM::Gateway
-    #         def initialize(options)
-    #         end
-    #       end
-    #     end
-    #
-    #     ROM.register_adapter(:super_db, SuperDB)
-    #
-    #     Gateway.setup(:super_db, some: 'options')
-    #     # SuperDB::Gateway.new(some: 'options') is called
-    #
-    #   @param [Symbol] type Registered gateway identifier
-    #   @param [Array] args Additional gateway options
-    #
-    # @overload setup(gateway)
-    #   Set up a gateway instance
-    #
-    #   @example
-    #     module SuperDB
-    #       class Gateway < ROM::Gateway
-    #         def initialize(options)
-    #         end
-    #       end
-    #     end
-    #
-    #     ROM.register_adapter(:super_db, SuperDB)
-    #
-    #     Gateway.setup(SuperDB::Gateway.new(some: 'options'))
-    #
-    #   @param [Gateway] gateway
-    #
-    # @return [Gateway] a specific gateway subclass
-    #
-    # @api public
-    def self.setup(gateway_or_scheme, *args)
-      case gateway_or_scheme
-      when String
-        raise ArgumentError, <<-STRING.gsub(/^ {10}/, '')
-          URIs without an explicit scheme are not supported anymore.
-          See https://github.com/rom-rb/rom/blob/master/CHANGELOG.md
-        STRING
-      when Symbol
-        klass = class_from_symbol(gateway_or_scheme)
-
-        if klass.instance_method(:initialize).arity == 0
-          klass.new
-        else
-          klass.new(*args)
-        end
-      else
-        if args.empty?
-          gateway_or_scheme
-        else
-          raise ArgumentError, "Can't accept arguments when passing an instance"
-        end
-      end
-    end
-
-    # Get gateway subclass for a specific adapter
-    #
-    # @param [Symbol] type Adapter identifier
-    #
-    # @return [Class]
-    #
-    # @api private
-    def self.class_from_symbol(type)
-      adapter = ROM.adapters.fetch(type) {
-        begin
-          require "rom/#{type}"
-        rescue LoadError
-          raise AdapterLoadError, "Failed to load adapter rom/#{type}"
-        end
-
-        ROM.adapters.fetch(type)
-      }
-
-      adapter.const_get(:Gateway)
-    end
-
-    # Returns the adapter, defined for the class
-    #
-    # @return [Symbol]
-    #
-    # @api public
-    def adapter
-      self.class.adapter || raise(
-        MissingAdapterIdentifierError,
-        "gateway class +#{self}+ is missing the adapter identifier"
-      )
-    end
-
-    # A generic interface for setting up a logger
-    #
-    # This is not a required interface, it's a no-op by default
-    #
-    # @abstract
-    #
-    # @api public
-    def use_logger(*)
-      # noop
-    end
-
-    # A generic interface for returning default logger
-    #
-    # Adapters should implement this method as handling loggers is different
-    # across adapters. This is a no-op by default and returns nil.
-    #
-    # @return [NilClass]
-    #
-    # @api public
-    def logger
-      # noop
-    end
-
-    # Extension hook for adding gateway-specific behavior to a command class
-    #
-    # This simply returns back the class by default
-    #
-    # @param [Class] klass The command class
-    # @param [Object] _dataset The dataset that will be used with this command class
-    #
-    # @return [Class]
-    #
-    # @api public
-    def extend_command_class(klass, _dataset)
-      klass
-    end
-
-    # Schema inference hook
-    #
-    # Every gateway that supports schema inference should implement this method
-    #
-    # @return [Array] An array with dataset names
-    #
-    # @api private
-    def schema
-      []
-    end
-
-    # Disconnect is optional and it's a no-op by default
-    #
-    # @api public
-    def disconnect
-      # noop
-    end
-
-    # Runs a block inside a transaction. The underlying transaction engine
-    # is adapter-specific
-    #
-    # @param [Hash] Transaction options
-    # @return The result of yielding the block or +nil+ if
-    #         the transaction was rolled back
-    #
-    # @api public
-    def transaction(opts = EMPTY_HASH, &block)
-      transaction_runner(opts).run(opts, &block)
-    end
-
-    private
-
-    # @api private
-    def transaction_runner(_)
-      Transaction::NoOp
-    end
-  end
-end

data/lib/rom/global/plugin_dsl.rb

@@ -1,47 +0,0 @@
-module ROM
-  module Global
-    # plugin registration DSL
-    #
-    # @private
-    class PluginDSL
-      # Default options passed to plugin registration
-      #
-      # @return [Hash]
-      #
-      # @api private
-      attr_reader :defaults
-
-      # Plugin registry
-      #
-      # @return [PluginRegistry]
-      #
-      # @api private
-      attr_reader :registry
-
-      # @api private
-      def initialize(registry, defaults = EMPTY_HASH, &block)
-        @registry = registry
-        @defaults = defaults
-        instance_exec(&block)
-      end
-
-      # Register a plugin
-      #
-      # @param [Symbol] name of the plugin
-      # @param [Module] mod to include
-      # @param [Hash] options
-      #
-      # @api public
-      def register(name, mod, options = EMPTY_HASH)
-        registry.register(name, mod, defaults.merge(options))
-      end
-
-      # Register plugins for a specific adapter
-      #
-      # @param [Symbol] adapter type
-      def adapter(type, &block)
-        self.class.new(registry, adapter: type, &block)
-      end
-    end
-  end
-end

data/lib/rom/global.rb

@@ -1,58 +0,0 @@
-require 'rom/plugin_registry'
-require 'rom/global/plugin_dsl'
-
-module ROM
-  # Globally accessible public interface exposed via ROM module
-  #
-  # @api public
-  module Global
-    # Set base global registries in ROM constant
-    #
-    # @api private
-    def self.extended(rom)
-      super
-
-      rom.instance_variable_set('@adapters', {})
-      rom.instance_variable_set('@plugin_registry', PluginRegistry.new)
-    end
-
-    # An internal adapter identifier => adapter module map used by setup
-    #
-    # @return [Hash<Symbol=>Module>]
-    #
-    # @api private
-    attr_reader :adapters
-
-    # An internal identifier => plugin map used by the setup
-    #
-    # @return [Hash]
-    #
-    # @api private
-    attr_reader :plugin_registry
-
-    # Global plugin setup DSL
-    #
-    # @example
-    #   ROM.plugins do
-    #     register :publisher, Plugin::Publisher, type: :command
-    #   end
-    #
-    # @example
-    def plugins(*args, &block)
-      PluginDSL.new(plugin_registry, *args, &block)
-    end
-
-    # Register adapter namespace under a specified identifier
-    #
-    # @param [Symbol] identifier
-    # @param [Class,Module] adapter
-    #
-    # @return [self]
-    #
-    # @api private
-    def register_adapter(identifier, adapter)
-      adapters[identifier] = adapter
-      self
-    end
-  end
-end

data/lib/rom/initializer.rb

@@ -1,26 +0,0 @@
-require 'dry-initializer'
-
-module ROM
-
-  # @api private
-  module Initializer
-
-    # @api private
-    def self.extended(base)
-      base.extend(Dry::Initializer[undefined: false])
-      base.include(InstanceMethods)
-    end
-
-    # @api private
-    module InstanceMethods
-      # Instance options
-      #
-      # @return [Hash]
-      #
-      # @api public
-      def options
-        @__options__
-      end
-    end
-  end
-end

data/lib/rom/lint/enumerable_dataset.rb

@@ -1,54 +0,0 @@
-require 'rom/lint/linter'
-
-module ROM
-  module Lint
-    # Ensures that a [ROM::EnumerableDataset] extension correctly yields
-    # arrays and tuples
-    #
-    # @api public
-    class EnumerableDataset < ROM::Lint::Linter
-      # The linted subject
-      #
-      # @api public
-      attr_reader :dataset
-
-      # The expected data
-      #
-      # @api public
-      attr_reader :data
-
-      # Create a linter for EnumerableDataset
-      #
-      # @param [EnumerableDataset] dataset the linted subject
-      # @param [Object] data the expected data
-      #
-      # @api public
-      def initialize(dataset, data)
-        @dataset = dataset
-        @data = data
-      end
-
-      # Lint: Ensure that +dataset+ yield tuples via +each+
-      #
-      # @api public
-      def lint_each
-        result = []
-        dataset.each do |tuple|
-          result << tuple
-        end
-        return if result == data
-
-        complain "#{dataset.class}#each must yield tuples"
-      end
-
-      # Lint: Ensure that +dataset+'s array equals to expected +data+
-      #
-      # @api public
-      def lint_to_a
-        return if dataset.to_a == data
-
-        complain "#{dataset.class}#to_a must cast dataset to an array"
-      end
-    end
-  end
-end

data/lib/rom/lint/gateway.rb

@@ -1,120 +0,0 @@
-require 'rom/lint/linter'
-
-module ROM
-  module Lint
-    # Ensures that a [ROM::Gateway] extension provides datasets through the
-    # expected methods
-    #
-    # @api public
-    class Gateway < ROM::Lint::Linter
-      # The gateway identifier e.g. +:memory+
-      #
-      # @api public
-      attr_reader :identifier
-
-      # The gateway class
-      #
-      # @api public
-      attr_reader :gateway
-
-      # The optional URI
-      #
-      # @api public
-      attr_reader :uri
-
-      # Gateway instance used in lint tests
-      #
-      # @api private
-      attr_reader :gateway_instance
-
-      # Create a gateway linter
-      #
-      # @param [Symbol] identifier
-      # @param [Class] gateway
-      # @param [String] uri optional
-      def initialize(identifier, gateway, uri = nil)
-        @identifier = identifier
-        @gateway = gateway
-        @uri = uri
-        @gateway_instance = setup_gateway_instance
-      end
-
-      # Lint: Ensure that +gateway+ setups up its instance
-      #
-      # @api public
-      def lint_gateway_setup
-        return if gateway_instance.instance_of? gateway
-
-        complain <<-STRING
-          #{gateway}.setup must return a gateway instance but
-          returned #{gateway_instance.inspect}
-        STRING
-      end
-
-      # Lint: Ensure that +gateway_instance+ responds to +[]+
-      #
-      # @api public
-      def lint_dataset_reader
-        return if gateway_instance.respond_to? :[]
-
-        complain "#{gateway_instance} must respond to []"
-      end
-
-      # Lint: Ensure that +gateway_instance+ responds to +dataset?+
-      #
-      # @api public
-      def lint_dataset_predicate
-        return if gateway_instance.respond_to? :dataset?
-
-        complain "#{gateway_instance} must respond to dataset?"
-      end
-
-      # Lint: Ensure +gateway_instance+ supports +transaction+ interface
-      #
-      # @api public
-      def lint_transaction_support
-        result = gateway_instance.transaction { 1 }
-
-        if result != 1
-          complain "#{gateway_instance} must return the result of a transaction block"
-        end
-
-        gateway_instance.transaction do |t|
-          t.rollback!
-
-          complain "#{gateway_instance} must interrupt a transaction on rollback"
-        end
-      end
-
-      # Lint: Ensure +gateway_instance+ returns adapter name
-      def lint_adapter_reader
-        if gateway_instance.adapter != identifier
-          complain "#{gateway_instance} must have the adapter identifier set to #{identifier.inspect}"
-        end
-      rescue MissingAdapterIdentifierError
-        complain "#{gateway_instance} is missing the adapter identifier"
-      end
-
-      private
-
-      # Setup gateway instance
-      #
-      # @api private
-      def setup_gateway_instance
-        if uri
-          ROM::Gateway.setup(identifier, uri)
-        else
-          ROM::Gateway.setup(identifier)
-        end
-      end
-
-      # Run Gateway#disconnect
-      #
-      # @api private
-      def after_lint
-        super
-        gateway_instance.disconnect
-      end
-    end
-  end
-end