rom 0.6.0.beta3 → 0.6.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3860ac36d7e9d938342e022c7fb0e227fc6273e1
-  data.tar.gz: 1a650f4573310fd5d543839c258338344827989b
+  metadata.gz: 0ea7e1a611937b1db33e9bb5f6495c116ff163bd
+  data.tar.gz: 98243b1e80fc05db0038fdeea7465a7b913990f8
 SHA512:
-  metadata.gz: b1239e346a1626da09367e8d4c37a222a43d9a7f70dd248d427dc2046fc1272033913859b38c9e5183d316bd31296c72bdbff4d0a55be590ab9f94f9c907d669
-  data.tar.gz: 4a711b1a776e137d1e953acc7eb8230f5c7c1695d5e8a812b9a7ef23f2673f3fe91619c83b9a93e317dc72e66f2a39b6ce37d082a19ab03110c84abbea8be7e8
+  metadata.gz: fde6f6d9efc44fe43c2bffefdfcf809e6f7d3991a4059185ac58909c3455c3e821dda71843503c3a4c31f36178eaff0454ef48c2d71c4ae1106beb30f95623c0
+  data.tar.gz: 1fa7191e19578e32cfc72c71db3eeebb7a28a7410dd98db8064af3f19f85bfa19e7397f22d46c86eaf42013943a91cc7f754f89fd2f62e96f6de12737fc7e7c9

data/.gitignore

@@ -12,6 +12,7 @@ test/tmp
 test/version_tmp
 tmp
 Gemfile.lock
+vendor/
 
 .idea/
 
@@ -19,5 +20,3 @@ Gemfile.lock
 .yardoc
 _yardoc
 doc/
-
-Gemfile.lock

data/CHANGELOG.md

@@ -20,8 +20,9 @@
 
 ### Changed
 
-* [BREAKING] Command API was simplified - commands should be accessed directly in `.try` block (solnic)
 * [BREAKING] Schema DSL was **removed** - attributes can be specified only in mapper DSL
+* [BREAKING] Reader was **removed** in favor of relation interface with explicit mapping (solnic)
+* [BREAKING] Command API was simplified - commands should be accessed directly in `.try` block (solnic)
   and default repository can be changed when defining a relation (solnic)
 * `.setup` interface requires either an adapter identifier or can accept a repository
   instance (aflatter)

data/Gemfile

@@ -29,7 +29,7 @@ end
 
 group :benchmarks do
   gem 'activerecord', '4.2.0'
-  gem 'benchmark-ips'
+  gem 'benchmark-ips', git: 'https://github.com/evanphx/benchmark-ips.git', branch: 'master'
 end
 
 group :tools do

data/lib/rom.rb

@@ -13,7 +13,6 @@ require 'rom/support/class_builder'
 # core parts
 require 'rom/relation'
 require 'rom/mapper'
-require 'rom/reader'
 require 'rom/command'
 
 # default mapper processor using Transproc gem
@@ -33,5 +32,4 @@ module ROM
   extend Global
 
   RelationRegistry = Class.new(Registry)
-  ReaderRegistry = Class.new(Registry)
 end

data/lib/rom/commands/abstract.rb

@@ -21,7 +21,7 @@ module ROM
       option :target
       option :validator, reader: true
       option :input, reader: true
-      option :curry_args, type: Array, reader: true, default: []
+      option :curry_args, type: Array, reader: true, default: EMPTY_ARRAY
 
       attr_reader :relation
 

data/lib/rom/env.rb

@@ -88,15 +88,17 @@ module ROM
     #
     # @param [Symbol] name of the registered reader
     #
+    # @deprecated
+    #
     # @api public
     def read(name, &block)
-      reader = readers[name]
-
-      if block
-        yield(reader)
-      else
-        reader
-      end
+      warn <<-MSG
+        #{self.class}#read is deprecated.
+        Please use `#{self.class}#relation(#{name.inspect})` instead.
+        For mapping append `.map_with(:your_mapper_name)`
+        [#{caller[0]}]
+      MSG
+      relation(name, &block)
     end
 
     # Returns commands registry for the given relation

data/lib/rom/memory/storage.rb

@@ -1,4 +1,9 @@
-require 'thread_safe'
+begin
+  require 'thread_safe'
+rescue LoadError
+  raise LoadError, 'Please install the `thread_safe` gem.'
+end
+
 require 'rom/memory/dataset'
 
 module ROM

data/lib/rom/relation.rb

@@ -1,5 +1,5 @@
-require 'set'
-require 'rom/relation/registry_reader'
+require 'rom/relation/class_interface'
+
 require 'rom/relation/lazy'
 require 'rom/relation/curried'
 
@@ -19,147 +19,26 @@ module ROM
   #
   # @api public
   class Relation
-    extend ClassMacros
+    extend ClassInterface
 
     include Options
     include Equalizer.new(:dataset)
 
-    defines :repository, :dataset, :register_as, :exposed_relations
-
-    repository :default
-
-    attr_reader :name, :dataset, :exposed_relations
-
-    # Register adapter relation subclasses during setup phase
-    #
-    # In adition those subclasses are extended with an interface for accessing
-    # relation registry and to define `register_as` setting
-    #
-    # @api private
-    def self.inherited(klass)
-      super
-
-      return if self == ROM::Relation
-
-      klass.class_eval do
-        include ROM::Relation::RegistryReader
-
-        dataset(default_name)
-        exposed_relations Set.new
-
-        def self.register_as(value = Undefined)
-          if value == Undefined
-            @register_as || dataset
-          else
-            super
-          end
-        end
-
-        def self.method_added(name)
-          super
-          exposed_relations << name if public_instance_methods.include?(name)
-        end
-      end
-
-      ROM.register_relation(klass)
-    end
-
-    # Return adapter-specific relation subclass
-    #
-    # @example
-    #   ROM::Relation[:memory]
-    #   # => ROM::Memory::Relation
+    # Dataset used by the relation
     #
-    # @return [Class]
-    #
-    # @api public
-    def self.[](type)
-      ROM.adapters.fetch(type).const_get(:Relation)
-    end
-
-    # Dynamically define a method that will forward to the dataset and wrap
-    # response in the relation itself
-    #
-    # @example
-    #   class SomeAdapterRelation < ROM::Relation
-    #     forward :super_query
-    #   end
-    #
-    # @api public
-    def self.forward(*methods)
-      methods.each do |method|
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            __new__(dataset.__send__(:#{method}, *args, &block))
-          end
-        RUBY
-      end
-    end
-
-    # Return default relation name used for `register_as` setting
+    # This object is provided by the repository during the setup
     #
-    # @return [Symbol]
+    # @return [Object]
     #
     # @api private
-    def self.default_name
-      return unless name
-      Inflector.underscore(name).gsub('/', '_').to_sym
-    end
-
-    # Build relation registry of specified descendant classes
-    #
-    # This is used by the setup
-    #
-    # @param [Hash] repositories
-    # @param [Array] descendants a list of relation descendants
-    #
-    # @return [Hash]
-    #
-    # @api private
-    def self.registry(repositories, descendants)
-      registry = {}
-
-      descendants.each do |klass|
-        # TODO: raise a meaningful error here and add spec covering the case
-        #       where klass' repository points to non-existant repo
-        repository = repositories.fetch(klass.repository)
-        dataset = repository.dataset(klass.dataset)
-
-        relation = klass.new(dataset, __registry__: registry)
-
-        name = klass.register_as
-
-        if registry.key?(name)
-          raise RelationAlreadyDefinedError,
-            "Relation with `register_as #{name.inspect}` registered more " \
-            "than once"
-        end
-
-        registry[name] = relation
-      end
-
-      registry.each_value do |relation|
-        relation.class.finalize(registry, relation)
-      end
-
-      registry
-    end
+    attr_reader :dataset
 
     # @api private
     def initialize(dataset, options = {})
       @dataset = dataset
-      @name = self.class.dataset
-      @exposed_relations = self.class.exposed_relations
       super
     end
 
-    # Hook to finalize a relation after its instance was created
-    #
-    # @api private
-    def self.finalize(_env, _relation)
-      # noop
-    end
-
     # Yield dataset tuples
     #
     # @yield [Hash]
@@ -170,7 +49,7 @@ module ROM
       dataset.each { |tuple| yield(tuple) }
     end
 
-    # Materialize relation into an array
+    # Materialize a relation into an array
     #
     # @return [Array<Hash>]
     #
@@ -179,11 +58,12 @@ module ROM
       to_enum.to_a
     end
 
-    # @api private
-    def repository
-      self.class.repository
-    end
-
+    # Turn relation into a lazy-loadable and composable relation
+    #
+    # @see Lazy
+    #
+    # @return [Lazy]
+    #
     # @api public
     def to_lazy(*args)
       Lazy.new(self, *args)

data/lib/rom/relation/class_interface.rb

@@ -0,0 +1,180 @@
+require 'set'
+require 'rom/relation/registry_reader'
+
+module ROM
+  class Relation
+    module ClassInterface
+      # Register adapter relation subclasses during setup phase
+      #
+      # In adition those subclasses are extended with an interface for accessing
+      # relation registry and to define `register_as` setting
+      #
+      # @api private
+      def inherited(klass)
+        super
+
+        return if klass.superclass == ROM::Relation
+
+        klass.class_eval do
+          extend ClassMacros
+          include RegistryReader
+
+          defines :repository, :dataset, :register_as, :exposed_relations
+
+          repository :default
+
+          dataset(default_name)
+          exposed_relations Set.new
+
+          # Relation's dataset name
+          #
+          # In example a table name in an SQL database
+          #
+          # @return [Symbol]
+          #
+          # @api public
+          attr_reader :name
+
+          # A set with public method names that return "virtual" relations
+          #
+          # Only those methods are exposed directly on relations return by
+          # Env#relation interface
+          #
+          # @return [Set]
+          #
+          # @api private
+          attr_reader :exposed_relations
+
+          # Set or get name under which a relation will be registered
+          #
+          # This defaults to `dataset` name
+          #
+          # @return [Symbol]
+          #
+          # @api public
+          def self.register_as(value = Undefined)
+            if value == Undefined
+              super() || dataset
+            else
+              super
+            end
+          end
+
+          # Hook used to collect public method names
+          #
+          # @api private
+          def self.method_added(name)
+            super
+            exposed_relations << name if public_instance_methods.include?(name)
+          end
+
+          # @api private
+          def initialize(dataset, options = {})
+            @name = self.class.dataset
+            @exposed_relations = self.class.exposed_relations
+            super
+          end
+
+          # Return name of the source repository of this relation
+          #
+          # @return [Symbol]
+          #
+          # @api private
+          def repository
+            self.class.repository
+          end
+        end
+
+        ROM.register_relation(klass)
+      end
+
+      # Return adapter-specific relation subclass
+      #
+      # @example
+      #   ROM::Relation[:memory]
+      #   # => ROM::Memory::Relation
+      #
+      # @return [Class]
+      #
+      # @api public
+      def [](type)
+        ROM.adapters.fetch(type).const_get(:Relation)
+      end
+
+      # Dynamically define a method that will forward to the dataset and wrap
+      # response in the relation itself
+      #
+      # @example
+      #   class SomeAdapterRelation < ROM::Relation
+      #     forward :super_query
+      #   end
+      #
+      # @api public
+      def forward(*methods)
+        methods.each do |method|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{method}(*args, &block)
+              __new__(dataset.__send__(:#{method}, *args, &block))
+            end
+          RUBY
+        end
+      end
+
+      # Return default relation name used for `register_as` setting
+      #
+      # @return [Symbol]
+      #
+      # @api private
+      def default_name
+        return unless name
+        Inflector.underscore(name).gsub('/', '_').to_sym
+      end
+
+      # Build relation registry of specified descendant classes
+      #
+      # This is used by the setup
+      #
+      # @param [Hash] repositories
+      # @param [Array] descendants a list of relation descendants
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def registry(repositories, descendants)
+        registry = {}
+
+        descendants.each do |klass|
+          # TODO: raise a meaningful error here and add spec covering the case
+          #       where klass' repository points to non-existant repo
+          repository = repositories.fetch(klass.repository)
+          dataset = repository.dataset(klass.dataset)
+
+          relation = klass.new(dataset, __registry__: registry)
+
+          name = klass.register_as
+
+          if registry.key?(name)
+            raise RelationAlreadyDefinedError,
+              "Relation with `register_as #{name.inspect}` registered more " \
+              "than once"
+          end
+
+          registry[name] = relation
+        end
+
+        registry.each_value do |relation|
+          relation.class.finalize(registry, relation)
+        end
+
+        registry
+      end
+
+      # Hook to finalize a relation after its instance was created
+      #
+      # @api private
+      def finalize(_env, _relation)
+        # noop
+      end
+    end
+  end
+end