rom 0.9.1 → 1.0.0.beta1

data/lib/rom/gateway.rb

@@ -3,6 +3,10 @@ module ROM
   #
   # @api public
   class Gateway
+    extend ClassMacros
+
+    defines :adapter
+
     # Return connection object
     #
     # @return [Object] type varies depending on the gateway
@@ -74,7 +78,7 @@ module ROM
     #
     # @api private
     def self.class_from_symbol(type)
-      adapter = ROM.adapters.fetch(type) do
+      adapter = ROM.adapters.fetch(type) {
         begin
           require "rom/#{type}"
         rescue LoadError
@@ -82,7 +86,7 @@ module ROM
         end
 
         ROM.adapters.fetch(type)
-      end
+      }
 
       if adapter.const_defined?(:Gateway)
         adapter.const_get(:Gateway)
@@ -91,6 +95,18 @@ module ROM
       end
     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
     #
     # @api public

data/lib/rom/global.rb

@@ -1,5 +1,6 @@
 require 'rom/plugin_registry'
 require 'rom/global/plugin_dsl'
+require 'rom/support/deprecations'
 
 module ROM
   # Globally accessible public interface exposed via ROM module
@@ -12,6 +13,7 @@ module ROM
     def self.extended(rom)
       super
 
+      rom.instance_variable_set('@env', nil)
       rom.instance_variable_set('@adapters', {})
       rom.instance_variable_set('@plugin_registry', PluginRegistry.new)
     end
@@ -54,5 +56,27 @@ module ROM
       adapters[identifier] = adapter
       self
     end
+
+    def env=(container)
+      @env = container
+    end
+
+    def env
+      if @env.nil?
+        ROM::Deprecations.announce(:env, %q{
+ROM.env is no longer automatically populated with your container.
+If possible, refactor your code to remove the dependency on global ROM state. If it is not
+possible—or as a temporary solution—you can assign your container to `ROM.env` upon
+creation:
+
+  ROM.env = ROM.container(:memory) do |rom|
+    ...
+  end
+        })
+        nil
+      else
+        @env
+      end
+    end
   end
 end

data/lib/rom/global/plugin_dsl.rb

@@ -1,3 +1,5 @@
+require 'rom/support/constants'
+
 module ROM
   module Global
     # plugin registration DSL

data/lib/rom/lint/spec.rb

@@ -1,18 +1,6 @@
 require 'rom/lint/gateway'
 require 'rom/lint/enumerable_dataset'
 
-RSpec.shared_examples "a rom repository" do
-  before(:all) do
-    ROM::Deprecations.announce "[Adapter]::Repository is", <<-MSG
-      Please use [Adapter]::Gateway instead.
-    MSG
-  end
-
-  let(:gateway) { repository }
-
-  include_examples "a rom gateway"
-end
-
 RSpec.shared_examples "a rom gateway" do
   ROM::Lint::Gateway.each_lint do |name, linter|
     it name do

data/lib/rom/lint/test.rb

@@ -61,37 +61,6 @@ module ROM
       end
     end
 
-    # This is a transitional lint-test loader for repository class
-    # to ensure that the basic interfaces are in place
-    #
-    #   class MyRepositoryTest < Minitest::Test
-    #     include ROM::Lint::TestRepository
-    #
-    #     def setup
-    #       @repository = MyRepository
-    #       @uri = "super_db://something"
-    #     end
-    #   end
-    #
-    # @see [ROM::Lint::TestGateway]
-    #
-    # @api public
-    module TestRepository
-      extend TestGateway
-
-      # Returns the reposiotry class
-      #
-      # @api public
-      attr_reader :repository
-
-      def setup
-        ROM::Deprecations.announce "[Adapter]::Repository is", <<-MSG
-          Please use [Adapter]::Gateway instead.
-        MSG
-        @gateway = repository
-      end
-    end
-
     # This is a simple lint-test for a gateway dataset class to ensure the
     # basic behavior is correct
     #

data/lib/rom/memory/commands.rb

@@ -14,12 +14,12 @@ module ROM
 
         # @see ROM::Commands::Create#execute
         def execute(tuples)
-          Array([tuples]).flatten.map do |tuple|
+          Array([tuples]).flatten.map { |tuple|
             attributes = input[tuple]
             validator.call(attributes)
             relation.insert(attributes.to_h)
             attributes
-          end.to_a
+          }.to_a
         end
       end
 

data/lib/rom/memory/gateway.rb

@@ -13,6 +13,8 @@ module ROM
     #
     # @api public
     class Gateway < ROM::Gateway
+      adapter :memory
+
       # @return [Object] default logger
       #
       # @api public

data/lib/rom/pipeline.rb

@@ -68,7 +68,7 @@ module ROM
     #
     # @api private
     class Composite
-      include Equalizer.new(:left, :right)
+      include Dry::Equalizer(:left, :right)
       include Proxy
 
       # @api private

data/lib/rom/plugin_base.rb

@@ -24,7 +24,7 @@ module ROM
     # @param [Mixed] base
     #
     # @api private
-    def apply_to(base)
+    def apply_to(_base)
       raise NotImplementedError, "#{self.class}#apply_to not implemented"
     end
   end

data/lib/rom/plugin_registry.rb

@@ -5,12 +5,13 @@ module ROM
   #
   # @api private
   class PluginRegistry
-    # Internal registry for environment plugins
+    # Internal registry for configuration plugins
     #
-    # @return [EnvironmentPluginRegistry]
+    # @return [ConfigurationPluginRegistry]
     #
     # @api private
-    attr_reader :environment
+    attr_reader :configuration
+    
     # Internal registry for command plugins
     #
     # @return [InternalPluginRegistry]
@@ -34,7 +35,7 @@ module ROM
 
     # @api private
     def initialize
-      @environment = EnvironmentPluginRegistry.new
+      @configuration = ConfigurationPluginRegistry.new
       @mappers = InternalPluginRegistry.new
       @commands = InternalPluginRegistry.new
       @relations = InternalPluginRegistry.new
@@ -63,10 +64,10 @@ module ROM
     # @api private
     def plugins_for(type, adapter)
       case type
-      when :environment then environment
-      when :command     then commands.adapter(adapter)
-      when :mapper      then mappers.adapter(adapter)
-      when :relation    then relations.adapter(adapter)
+      when :configuration then configuration
+      when :command       then commands.adapter(adapter)
+      when :mapper        then mappers.adapter(adapter)
+      when :relation      then relations.adapter(adapter)
       end
     end
   end
@@ -88,7 +89,7 @@ module ROM
   # A registry storing environment specific plugins
   #
   # @api private
-  class EnvironmentPluginRegistry < PluginRegistryBase
+  class ConfigurationPluginRegistry < PluginRegistryBase
     # Assign a plugin to this environment registry
     #
     # @param [Symbol] name The registered plugin name
@@ -97,8 +98,9 @@ module ROM
     #
     # @api private
     def register(name, mod, options)
-      elements[name] = EnvironmentPlugin.new(mod, options)
+      elements[name] = ConfigurationPlugin.new(mod, options)
     end
+
     # Return an environment plugin
     #
     # @param [Symbol] name The name of the environment plugin

data/lib/rom/plugins/configuration/configuration_dsl.rb

@@ -0,0 +1,16 @@
+require 'rom/configuration_dsl'
+
+module ROM
+  module ConfigurationPlugins
+    # Provides macros for defining relations, mappers and commands
+    #
+    # @api public
+    module ConfigurationDSL
+
+      # @api private
+      def self.apply(configuration, options = {})
+        configuration.extend(ROM::ConfigurationDSL)
+      end
+    end
+  end
+end

data/lib/rom/plugins/relation/key_inference.rb

@@ -0,0 +1,31 @@
+module ROM
+  module Plugins
+    module Relation
+      module KeyInference
+        # Infer foreign_key name for this relation
+        #
+        # TODO: this should be configurable and handled by an injected policy
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        def foreign_key
+          :"#{Inflector.singularize(name)}_id"
+        end
+
+        # Return base name which defaults to name attribute
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        def base_name
+          name
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  register :key_inference, ROM::Plugins::Relation::KeyInference, type: :relation
+end

data/lib/rom/plugins/relation/view.rb

@@ -0,0 +1,90 @@
+require 'rom/plugins/relation/view/dsl'
+
+module ROM
+  module Plugins
+    module Relation
+      module View
+        def self.included(klass)
+          super
+
+          klass.class_eval do
+            extend ClassInterface
+
+            option :view, reader: true
+
+            def self.attributes
+              @__attributes__ ||= {}
+            end
+          end
+        end
+
+        # Return column names that will be selected for this relation
+        #
+        # By default we use dataset columns but first we look at configured
+        # attributes by `view` DSL
+        #
+        # @return [Array<Symbol>]
+        #
+        # @api private
+        def attributes(view_name = view)
+          header = self.class.attributes
+            .fetch(view_name, self.class.attributes.fetch(:base))
+
+          if header.is_a?(Proc)
+            instance_exec(&header)
+          else
+            header
+          end
+        end
+
+        module ClassInterface
+          # Define a relation view with a specific header
+          #
+          # With headers defined all the mappers will be inferred automatically
+          #
+          # @example
+          #   class Users < ROM::Relation[:sql]
+          #     view(:by_name, [:id, :name]) do |name|
+          #       where(name: name)
+          #     end
+          #
+          #     view(:listing, [:id, :name, :email]) do
+          #       select(:id, :name, :email).order(:name)
+          #     end
+          #   end
+          #
+          # @api public
+          def view(*args, &block)
+            if args.size == 1 && block.arity > 0
+              raise ArgumentError, "header must be set as second argument"
+            end
+
+            name, names, relation_block =
+              if args.size == 1
+                DSL.new(*args, &block).call
+              else
+                [*args, block]
+              end
+
+            attributes[name] = names
+
+            if relation_block.arity > 0
+              auto_curry_guard do
+                define_method(name, &relation_block)
+                auto_curry(name) { with(view: name) }
+              end
+            else
+              define_method(name) do
+                instance_exec(&relation_block).with(view: name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  register :view, ROM::Plugins::Relation::View, type: :relation
+end

data/lib/rom/plugins/relation/view/dsl.rb

@@ -0,0 +1,32 @@
+module ROM
+  module Plugins
+    module Relation
+      module View
+        class DSL
+          attr_reader :name
+
+          attr_reader :attributes
+
+          attr_reader :relation_block
+
+          def initialize(name, &block)
+            @name = name
+            instance_eval(&block)
+          end
+
+          def header(*args, &block)
+            @attributes = args.size > 0 ? args.first : block
+          end
+
+          def relation(&block)
+            @relation_block = lambda(&block)
+          end
+
+          def call
+            [name, attributes, relation_block]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/relation.rb

@@ -1,4 +1,3 @@
-require 'rom/support/deprecations'
 require 'rom/relation/class_interface'
 
 require 'rom/pipeline'
@@ -26,12 +25,10 @@ module ROM
   #
   # @api public
   class Relation
-    extend Deprecations
     extend ClassInterface
-    extend ROM::Support::GuardedInheritanceHook
 
     include Options
-    include Equalizer.new(:dataset)
+    include Dry::Equalizer(:dataset)
     include Materializable
     include Pipeline
 
@@ -104,13 +101,6 @@ module ROM
     def with(options)
       __new__(dataset, options)
     end
-    deprecate :to_lazy, :with, "to_lazy is no longer needed"
-
-    # @api public
-    def relation
-      Deprecations.announce("#relation", 'all relations are now lazy')
-      self
-    end
 
     private