rom-core 4.0.0.beta1

data/lib/rom/lint/gateway.rb

@@ -0,0 +1,120 @@
+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

data/lib/rom/lint/linter.rb

@@ -0,0 +1,78 @@
+module ROM
+  module Lint
+    # Base class for building linters that check source code
+    #
+    # Linters are used by authors of ROM adapters to verify that their
+    # integration complies with the ROM api.
+    #
+    # Most of the time, authors won't need to construct linters directly
+    # because the provided test helpers will automatically run when required
+    # in tests and specs.
+    #
+    # @example
+    #   require 'rom/lint/spec'
+    #
+    #
+    # @api public
+    class Linter
+      # A failure raised by +complain+
+      Failure = Class.new(StandardError)
+
+      # Iterate over all lint methods
+      #
+      # @yield [String, ROM::Lint]
+      #
+      # @api public
+      def self.each_lint
+        return to_enum unless block_given?
+        lints.each { |lint| yield lint, self }
+      end
+
+      # Run a lint method
+      #
+      # @param [String] name
+      #
+      # @raise [ROM::Lint::Linter::Failure] if linting fails
+      #
+      # @api public
+      def lint(name)
+        before_lint
+        public_send name
+        after_lint
+        true # for assertions
+      end
+
+      private
+
+      # Return a list a lint methods
+      #
+      # @return [String]
+      #
+      # @api private
+      def self.lints
+        public_instance_methods(true).grep(/^lint_/).map(&:to_s)
+      end
+
+      # Raise a failure if a lint verification fails
+      #
+      # @raise [ROM::Lint::Linter::Failure]
+      #
+      # @api private
+      def complain(*args)
+        raise Failure, *args
+      end
+
+      # Hook method executed before each lint method run
+      #
+      # @api private
+      def before_lint
+      end
+
+      # Hook method executed after each lint method run
+      #
+      # @api private
+      def after_lint
+      end
+    end
+  end
+end

data/lib/rom/lint/spec.rb

@@ -0,0 +1,20 @@
+require 'rom/lint/gateway'
+require 'rom/lint/enumerable_dataset'
+
+RSpec.shared_examples "a rom gateway" do
+  ROM::Lint::Gateway.each_lint do |name, linter|
+    it name do
+      result = linter.new(identifier, gateway, uri).lint(name)
+      expect(result).to be_truthy
+    end
+  end
+end
+
+RSpec.shared_examples "a rom enumerable dataset" do
+  ROM::Lint::EnumerableDataset.each_lint do |name, linter|
+    it name do
+      result = linter.new(dataset, data).lint(name)
+      expect(result).to be_truthy
+    end
+  end
+end

data/lib/rom/lint/test.rb

@@ -0,0 +1,98 @@
+require 'rom/lint/gateway'
+require 'rom/lint/enumerable_dataset'
+
+module ROM
+  module Lint
+    # A module that helps to define test methods
+    module Test
+      # Defines a test method converting lint failures to assertions
+      #
+      # @param [String] name
+      #
+      # @api private
+      def define_test_method(name, &block)
+        define_method "test_#{name}" do
+          begin
+            instance_eval(&block)
+          rescue ROM::Lint::Linter::Failure => f
+            raise Minitest::Assertion, f.message
+          end
+        end
+      end
+    end
+
+    # This is a simple lint-test for gateway class to ensure the
+    # basic interfaces are in place
+    #
+    # @example
+    #
+    #   class MyGatewayTest < Minitest::Test
+    #     include ROM::Lint::TestGateway
+    #
+    #     def setup
+    #       @gateway = MyGateway
+    #       @uri = "super_db://something"
+    #     end
+    #   end
+    #
+    # @api public
+    module TestGateway
+      extend ROM::Lint::Test
+
+      # Returns the gateway identifier e.g. +:memory+
+      #
+      # @api public
+      attr_reader :identifier
+
+      # Returns the gateway class
+      #
+      # @api public
+      attr_reader :gateway
+
+      # Returns gateway's URI e.g. "super_db://something"
+      #
+      # @api public
+      attr_reader :uri
+
+      ROM::Lint::Gateway.each_lint do |name, linter|
+        define_test_method name do
+          assert linter.new(identifier, gateway, uri).lint(name)
+        end
+      end
+    end
+
+    # This is a simple lint-test for a gateway dataset class to ensure the
+    # basic behavior is correct
+    #
+    # @example
+    #
+    #  class MyDatasetLintTest < Minitest::Test
+    #    include ROM::Lint::TestEnumerableDataset
+    #
+    #     def setup
+    #       @data  = [{ name: 'Jane', age: 24 }, { name: 'Joe', age: 25 }]
+    #       @dataset = MyDataset.new(@data, [:name, :age])
+    #     end
+    #   end
+    # @api public
+    module TestEnumerableDataset
+      extend ROM::Lint::Test
+
+      # Returns the dataset instance
+      #
+      # @api public
+      attr_reader :dataset
+
+      # Returns the expected data
+      #
+      # @api public
+      attr_reader :data
+
+      ROM::Lint::EnumerableDataset.each_lint do |name, linter|
+        define_test_method name do
+          assert linter.new(dataset, data).lint(name)
+        end
+      end
+    end
+  end
+end

data/lib/rom/mapper_registry.rb

@@ -0,0 +1,24 @@
+require 'rom/struct'
+require 'rom/registry'
+require 'rom/mapper_compiler'
+
+module ROM
+  # @private
+  class MapperRegistry < Registry
+    def self.element_not_found_error
+      MapperMissingError
+    end
+
+    option :compiler, default: -> { MapperCompiler.new }
+
+    # @see Registry
+    # @api public
+    def [](*args)
+      if args[0].is_a?(Symbol)
+        super
+      else
+        cache.fetch_or_store(args.hash) { compiler.(*args) }
+      end
+    end
+  end
+end

data/lib/rom/memory.rb

@@ -0,0 +1,4 @@
+require 'rom/memory/gateway'
+require 'rom/memory/relation'
+
+ROM.register_adapter(:memory, ROM::Memory)

data/lib/rom/memory/associations.rb

@@ -0,0 +1,4 @@
+require 'rom/memory/associations/many_to_many'
+require 'rom/memory/associations/many_to_one'
+require 'rom/memory/associations/one_to_many'
+require 'rom/memory/associations/one_to_one'

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

@@ -0,0 +1,10 @@
+require 'rom/associations/many_to_many'
+
+module ROM
+  module Memory
+    module Associations
+      class ManyToMany < ROM::Associations::ManyToMany
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'rom/associations/many_to_one'
+
+module ROM
+  module Memory
+    module Associations
+      class ManyToOne < ROM::Associations::ManyToOne
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'rom/associations/one_to_many'
+
+module ROM
+  module Memory
+    module Associations
+      class OneToMany < ROM::Associations::OneToMany
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'rom/memory/associations/one_to_many'
+
+module ROM
+  module Memory
+    module Associations
+      class OneToOne < OneToMany
+      end
+    end
+  end
+end

data/lib/rom/memory/commands.rb

@@ -0,0 +1,56 @@
+require 'rom/commands'
+
+module ROM
+  module Memory
+    # Memory adapter commands namespace
+    #
+    # @api public
+    module Commands
+      # In-memory create command
+      #
+      # @api public
+      class Create < ROM::Commands::Create
+        adapter :memory
+        use :schema
+
+        # @see ROM::Commands::Create#execute
+        def execute(tuples)
+          Array([tuples]).flatten.map { |tuple|
+            attributes = input[tuple]
+            relation.insert(attributes.to_h)
+            attributes
+          }.to_a
+        end
+      end
+
+      # In-memory update command
+      #
+      # @api public
+      class Update < ROM::Commands::Update
+        adapter :memory
+        use :schema
+
+        # @see ROM::Commands::Update#execute
+        def execute(params)
+          attributes = input[params]
+          relation.map { |tuple| tuple.update(attributes.to_h) }
+        end
+      end
+
+      # In-memory delete command
+      #
+      # @api public
+      class Delete < ROM::Commands::Delete
+        adapter :memory
+
+        # @see ROM::Commands::Delete#execute
+        def execute
+          relation.to_a.map do |tuple|
+            source.delete(tuple)
+            tuple
+          end
+        end
+      end
+    end
+  end
+end