rom 2.0.2 → 4.2.1

data/lib/rom/lint/gateway.rb

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

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

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

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

@@ -1,35 +0,0 @@
-require 'rom/support/registry'
-
-module ROM
-  # @private
-  class MapperRegistry < Registry
-    # @api private
-    def []=(name, mapper)
-      elements[name] = mapper
-    end
-
-    # @api private
-    def [](name)
-      elements.fetch(name) { raise(MapperMissingError, name) }
-    end
-
-    # @api private
-    def key?(name)
-      elements.key?(name)
-    end
-
-    # @api private
-    def by_path(path)
-      elements.fetch(paths(path).detect { |name| elements.key?(name) }) {
-        raise(MapperMissingError, path)
-      }
-    end
-
-    private
-
-    # @api private
-    def paths(path)
-      path.split('.').map(&:to_sym).reverse
-    end
-  end
-end

data/lib/rom/memory/commands.rb

@@ -1,58 +0,0 @@
-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]
-            validator.call(attributes)
-            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]
-          validator.call(attributes)
-          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

data/lib/rom/memory/dataset.rb

@@ -1,98 +0,0 @@
-require 'rom/support/options' # FIXME: this shouldn't be required, fix needed in rom-support
-require 'rom/support/array_dataset'
-
-module ROM
-  module Memory
-    # In-memory dataset
-    #
-    # @api public
-    class Dataset
-      include ArrayDataset
-
-      # Join two datasets
-      #
-      # @api public
-      def join(*args)
-        left, right = args.size > 1 ? args : [self, args.first]
-
-        join_map = left.each_with_object({}) { |tuple, h|
-          others = right.to_a.find_all { |t| (tuple.to_a & t.to_a).any? }
-          (h[tuple] ||= []).concat(others)
-        }
-
-        tuples = left.flat_map { |tuple|
-          join_map[tuple].map { |other| tuple.merge(other) }
-        }
-
-        self.class.new(tuples, options)
-      end
-
-      # Restrict a dataset
-      #
-      # @api public
-      def restrict(criteria = nil)
-        return find_all { |tuple| yield(tuple) } unless criteria
-        find_all do |tuple|
-          criteria.all? do |k, v|
-            case v
-            when Array then v.include?(tuple[k])
-            when Regexp then tuple[k].match(v)
-            else tuple[k].eql?(v)
-            end
-          end
-        end
-      end
-
-      # Project a dataset
-      #
-      # @api public
-      def project(*names)
-        map { |tuple| tuple.reject { |key| !names.include?(key) } }
-      end
-
-      # Sort a dataset
-      #
-      # @param [Array<Symbol>] names
-      #   Names of fields to order tuples by
-      #
-      # @option [Boolean] :nils_first (false)
-      #   Whether `nil` values should be placed before others
-      #
-      # @api public
-      def order(*fields)
-        nils_first = fields.pop[:nils_first] if fields.last.is_a?(Hash)
-
-        sort do |a, b|
-          fields # finds the first difference between selected fields of tuples
-            .map { |n| __compare__ a[n], b[n], nils_first }
-            .detect(-> { 0 }) { |r| r != 0 }
-        end
-      end
-
-      # Insert tuple into a dataset
-      #
-      # @api public
-      def insert(tuple)
-        data << tuple
-        self
-      end
-      alias_method :<<, :insert
-
-      # Delete tuples from a dataset
-      #
-      # @api public
-      def delete(tuple)
-        data.delete(tuple)
-        self
-      end
-
-      private
-
-      # Compares two values, that are either comparable, or can be nils
-      def __compare__(a, b, nils_first)
-        return a <=> b unless a.nil? ^ b.nil?
-        (nils_first ^ b.nil?) ? -1 : 1
-      end
-    end
-  end
-end

data/lib/rom/memory/gateway.rb

@@ -1,64 +0,0 @@
-require 'rom/gateway'
-require 'rom/memory/storage'
-require 'rom/memory/commands'
-
-module ROM
-  module Memory
-    # In-memory gateway interface
-    #
-    # @example
-    #   gateway = ROM::Memory::Gateway.new
-    #   gateway.dataset(:users)
-    #   gateway[:users].insert(name: 'Jane')
-    #
-    # @api public
-    class Gateway < ROM::Gateway
-      adapter :memory
-
-      # @return [Object] default logger
-      #
-      # @api public
-      attr_reader :logger
-
-      # @api private
-      def initialize
-        @connection = Storage.new
-      end
-
-      # Set default logger for the gateway
-      #
-      # @param [Object] logger object
-      #
-      # @api public
-      def use_logger(logger)
-        @logger = logger
-      end
-
-      # Register a dataset in the gateway
-      #
-      # If dataset already exists it will be returned
-      #
-      # @return [Dataset]
-      #
-      # @api public
-      def dataset(name)
-        self[name] || connection.create_dataset(name)
-      end
-
-      # @see ROM::Gateway#dataset?
-      def dataset?(name)
-        connection.key?(name)
-      end
-
-      # Return dataset with the given name
-      #
-      # @param (see ROM::Gateway#[])
-      # @return [Memory::Dataset]
-      #
-      # @api public
-      def [](name)
-        connection[name]
-      end
-    end
-  end
-end

data/lib/rom/memory/relation.rb

@@ -1,49 +0,0 @@
-require 'rom/memory/types'
-
-module ROM
-  module Memory
-    # Relation subclass for memory adapter
-    #
-    # @example
-    #   class Users < ROM::Relation[:memory]
-    #   end
-    #
-    # @api public
-    class Relation < ROM::Relation
-      include Enumerable
-      include Memory
-
-      adapter :memory
-
-      forward :take, :join, :project, :restrict, :order
-
-      # Insert tuples into the relation
-      #
-      # @example
-      #   users.insert(name: 'Jane')
-      #
-      # @return [Relation]
-      #
-      # @api public
-      def insert(*args)
-        dataset.insert(*args)
-        self
-      end
-      alias_method :<<, :insert
-
-      # Delete tuples from the relation
-      #
-      # @example
-      #   users.insert(name: 'Jane')
-      #   users.delete(name: 'Jane')
-      #
-      # @return [Relation]
-      #
-      # @api public
-      def delete(*args)
-        dataset.delete(*args)
-        self
-      end
-    end
-  end
-end

data/lib/rom/memory/storage.rb

@@ -1,59 +0,0 @@
-require 'concurrent/hash'
-require 'concurrent/array'
-
-require 'rom/memory/dataset'
-
-module ROM
-  module Memory
-    # In-memory thread-safe data storage
-    #
-    # @private
-    class Storage
-      # Dataset registry
-      #
-      # @return [ThreadSafe::Hash]
-      #
-      # @api private
-      attr_reader :data
-
-      # @api private
-      def initialize
-        @data = Concurrent::Hash.new
-      end
-
-      # @return [Dataset]
-      #
-      # @api private
-      def [](name)
-        data[name]
-      end
-
-      # Register a new dataset
-      #
-      # @return [Dataset]
-      #
-      # @api private
-      def create_dataset(name)
-        data[name] = Dataset.new(Concurrent::Array.new)
-      end
-
-      # Check if there's dataset under specified key
-      #
-      # @return [Boolean]
-      #
-      # @api private
-      def key?(name)
-        data.key?(name)
-      end
-
-      # Return registered datasets count
-      #
-      # @return [Integer]
-      #
-      # @api private
-      def size
-        data.size
-      end
-    end
-  end
-end

data/lib/rom/memory/types.rb

@@ -1,9 +0,0 @@
-require 'rom/types'
-
-module ROM
-  module Memory
-    module Types
-      include ROM::Types
-    end
-  end
-end

data/lib/rom/memory.rb

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