rom-repository 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d225169d8e6601c42a19f9e8504363fb766b49b
-  data.tar.gz: 2277ca38edb2706b648fabbd30da68cbbb9adb3c
+  metadata.gz: 14c56e0b7faccfcb4ed7d1b7b8506e3f5adc6384
+  data.tar.gz: 2c9e669ae2e2e863a033c9bc9169589d98200d87
 SHA512:
-  metadata.gz: fb36f1ef4cd751ddb8de93a54018b6c057db268c00f66131a5911f7b3f632e1db159952fc6be2043a486ed6c31dedb6aced2933df57a3b9cb74768d2fa09f346
-  data.tar.gz: 73ce2e1fbcedc63495fd7b6bcd959a938427d9b16774396450dd04b26a64585a4f4f56033cf7763c29f9ca0e94cdb72517e01b2aa24920f0c7894bb60a1bfa4b
+  metadata.gz: ac27d7fd92fe6385817f18063573da18f98f710d391d2dcf369cfc0fd07b4540582d6190aadd2d7cfd39b89a073541c7aa2defcb2d5c03e896238a405c6f8d27
+  data.tar.gz: 6e6af0a5a553888023c7d1164ab9e864572a9c3ac659f76b9220e484e8e9db06dae704c7fda3e244c8cef87fe050722891307fcc6379f26fecd0ac1936b2c105

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v1.1.0 2017-02-16
+
+### Added
+
+* Mapping to `ROM::Struct` can be disabled via `auto_struct` option (solnic)
+* You can now use custom mappers along with auto-mapping via `map_with(:my_mapper, auto_map: true)` (solnic)
+* `wrap` can be used along with association names ie `users.wrap(:address)` (solnic)
+* `#node` relation method that can be used to adjust graph nodes produced by `aggregate` or `combine` (solnic)
+
+## Fixed
+
+* Structs raise nicer `NoMethodError` (flash-gordon)
+* Custom model set on a node relation is respected when loading aggregates (solnic)
+
+[Compare v1.0.2...v1.1.0](https://github.com/rom-rb/rom-repository/compare/v1.0.2...v1.1.0)
+
 # v1.0.2 2017-02-13
 
 ### Fixed

data/Gemfile

@@ -11,7 +11,7 @@ group :development do
 end
 
 group :test do
-  gem 'rom-sql'
+  gem 'rom-sql', git: 'https://github.com/rom-rb/rom-sql.git', branch: 'master'
   gem 'rspec'
   gem 'dry-struct'
   gem 'byebug', platforms: :mri

data/lib/rom/repository.rb

@@ -1,11 +1,11 @@
 require 'dry/core/deprecations'
 
+require 'rom/initializer'
 require 'rom/repository/class_interface'
 require 'rom/repository/mapper_builder'
 require 'rom/repository/relation_proxy'
 require 'rom/repository/command_compiler'
 
-require 'rom/repository/root'
 require 'rom/repository/changeset'
 require 'rom/repository/session'
 
@@ -63,10 +63,32 @@ module ROM
     }.freeze
 
     extend ClassInterface
+    extend Initializer
+    extend Dry::Core::ClassAttributes
+
+    # @!method self.auto_struct
+    #   Get or set auto_struct setting
+    #
+    #   When disabled, rom structs won't be created
+    #
+    #   @overload auto_struct
+    #     Return auto_struct setting value
+    #     @return [TrueClass,FalseClass]
+    #
+    #   @overload auto_struct(value)
+    #     Set auto_struct value
+    #     @return [Class]
+    defines :auto_struct
+
+    auto_struct true
+
+    # @!attribute [r] container
+    #   @return [ROM::Container] The container used to set up a repo
+    param :container, allow: ROM::Container
 
     # @!attribute [r] container
     #   @return [ROM::Container] The container used to set up a repo
-    attr_reader :container
+    option :auto_struct, optional: true, default: -> repo { repo.class.auto_struct }
 
     # @!attribute [r] relations
     #   @return [RelationRegistry] The relation proxy registry used by a repo
@@ -86,15 +108,17 @@ module ROM
     # @param container [ROM::Container] The rom container with relations and optional commands
     #
     # @api public
-    def initialize(container)
-      @container = container
+    def initialize(container, opts = EMPTY_HASH)
+      super
+
       @mappers = MapperBuilder.new
+
       @relations = RelationRegistry.new do |registry, relations|
         self.class.relations.each do |name|
           relation = container.relation(name)
 
           proxy = RelationProxy.new(
-            relation, name: name, mappers: mappers, registry: registry
+            relation, name: name, mappers: mappers, registry: registry, auto_struct: auto_struct
           )
 
           instance_variable_set("@#{name}", proxy)
@@ -102,6 +126,7 @@ module ROM
           relations[name] = proxy
         end
       end
+
       @command_compiler = method(:command)
     end
 
@@ -327,3 +352,5 @@ module ROM
     end
   end
 end
+
+require 'rom/repository/root'

data/lib/rom/repository/header_builder.rb

@@ -7,7 +7,7 @@ module ROM
     class HeaderBuilder
       attr_reader :struct_builder
 
-      def initialize
+      def initialize(options = EMPTY_HASH)
         @struct_builder = StructBuilder.new
       end
 
@@ -18,12 +18,12 @@ module ROM
 
       private
 
-      def visit(node, *args)
+      def visit(node)
         name, node = node
-        __send__("visit_#{name}", node, *args)
+        __send__("visit_#{name}", node)
       end
 
-      def visit_relation(node, meta = {})
+      def visit_relation(node)
         relation_name, meta, header = node
         name = meta[:combine_name] || relation_name
 
@@ -31,7 +31,7 @@ module ROM
           struct_builder[meta.fetch(:dataset), header]
         end
 
-        options = [visit(header, meta), model: model]
+        options = [visit(header), model: model]
 
         if meta[:combine_type]
           type = meta[:combine_type] == :many ? :array : :hash
@@ -45,12 +45,12 @@ module ROM
         end
       end
 
-      def visit_header(node, meta = {})
-        node.map { |attribute| visit(attribute, meta) }
+      def visit_header(node)
+        node.map { |attribute| visit(attribute) }
       end
 
-      def visit_attribute(attr, meta = {})
-        if meta[:wrap]
+      def visit_attribute(attr)
+        if attr.wrapped?
           [attr.name, from: attr.alias]
         else
           [attr.name]

data/lib/rom/repository/relation_proxy.rb

@@ -30,6 +30,7 @@ module ROM
       option :mappers, reader: true, default: proc { MapperBuilder.new }
       option :meta, reader: true, default: proc { EMPTY_HASH }
       option :registry, type: RelationRegistryType, default: proc { RelationRegistry.new }, reader: true
+      option :auto_struct, optional: true
 
       # Relation name
       #
@@ -68,20 +69,78 @@ module ROM
       #
       #   @param [Array<Symbol>] mappers A list of mapper identifiers
       #
+      # @overload map_with(*mappers, auto_map: true)
+      #   Map tuples using auto-mapping and custom registered mappers
+      #
+      #   If `auto_map` is enabled, your mappers will be applied after performing
+      #   default auto-mapping. This means that you can compose complex relations
+      #   and have them auto-mapped, and use much simpler custom mappers to adjust
+      #   resulting data according to your requirements.
+      #
+      #   @example
+      #     users.map_with(:my_mapper, :my_other_mapper, auto_map: true)
+      #
+      #   @param [Array<Symbol>] mappers A list of mapper identifiers
+      #
       # @return [RelationProxy] A new relation proxy with pipelined relation
       #
       # @api public
-      def map_with(*names)
+      def map_with(*names, **opts)
         if names.size == 1 && names[0].is_a?(Class)
           with(meta: meta.merge(model: names[0]))
         elsif names.size > 1 && names.any? { |name| name.is_a?(Class) }
           raise ArgumentError, 'using custom mappers and a model is not supported'
         else
-          names.reduce(self) { |a, e| a >> relation.mappers[e] }
+          if opts[:auto_map]
+            mappers = [mapper, *names.map { |name| relation.mappers[name] }]
+            mappers.reduce(self) { |a, e| a >> e }
+          else
+            names.reduce(self) { |a, e| a >> relation.mappers[e] }
+          end
         end
       end
       alias_method :as, :map_with
 
+      # Return a new graph with adjusted node returned from a block
+      #
+      # @example with a node identifier
+      #   aggregate(:tasks).node(:tasks) { |tasks| tasks.prioritized }
+      #
+      # @example with a nested path
+      #   aggregate(tasks: :tags).node(tasks: :tags) { |tags| tags.where(name: 'red') }
+      #
+      # @param [Symbol] name The node relation name
+      #
+      # @yieldparam [RelationProxy] The relation node
+      # @yieldreturn [RelationProxy] The new relation node
+      #
+      # @return [RelationProxy]
+      #
+      # @api public
+      def node(name, &block)
+        if name.is_a?(Symbol) && !nodes.map { |n| n.name.relation }.include?(name)
+          raise ArgumentError, "#{name.inspect} is not a valid aggregate node name"
+        end
+
+        new_nodes = nodes.map { |node|
+          case name
+          when Symbol
+            name == node.name.relation ? yield(node) : node
+          when Hash
+            other, *rest = name.flatten(1)
+            if other == node.name.relation
+              nodes.detect { |n| n.name.relation == other }.node(*rest, &block)
+            else
+              node
+            end
+          else
+            node
+          end
+        }
+
+        with_nodes(new_nodes)
+      end
+
       # Return a string representation of this relation proxy
       #
       # @return [String]
@@ -147,6 +206,7 @@ module ROM
             attr_ast = schema.map { |attr| [:attribute, attr] }
 
             meta = self.meta.merge(dataset: base_name.dataset)
+            meta.update(model: false) unless meta[:model] || auto_struct
             meta.delete(:wraps)
 
             header = attr_ast + nodes_ast + wraps_ast
@@ -155,6 +215,17 @@ module ROM
           end
       end
 
+      # TODO: add a proper interface to `Relation::Graph` and `Relation::Curried` to rom core
+      #
+      # @api private
+      def with_nodes(nodes)
+        if relation.curried?
+          __new__(relation.send(:__new__, relation.relation.class.new(relation.root, nodes)))
+        else
+          __new__(relation.class.new(relation.root, nodes))
+        end
+      end
+
       # @api private
       def respond_to_missing?(meth, _include_private = false)
         relation.respond_to?(meth) || super
@@ -164,7 +235,11 @@ module ROM
 
       # @api private
       def schema
-        meta[:wrap] ? relation.schema.wrap.qualified : relation.schema.reject(&:wrapped?)
+        if meta[:wrap]
+          relation.schema.wrap
+        else
+          relation.schema.reject(&:wrapped?)
+        end
       end
 
       # @api private

data/lib/rom/repository/relation_proxy/wrap.rb

@@ -15,16 +15,15 @@ module ROM
         # @return [RelationProxy]
         #
         # @api public
-        def wrap(options)
-          wraps = options.map { |(name, (relation, keys))|
-            relation.wrapped(name, keys)
-          }
+        def wrap(*names, **options)
+          new_wraps = wraps_from_names(names) + wraps_from_options(options)
 
-          relation = wraps.reduce(self) { |a, e|
-            a.relation.for_wrap(e.meta.fetch(:keys), e.base_name.relation)
+          relation = new_wraps.reduce(self) { |a, e|
+            name = e.meta[:wrap_from_assoc] ? e.meta[:combine_name] : e.base_name.relation
+            a.relation.for_wrap(e.meta.fetch(:keys), name)
           }
 
-          __new__(relation, meta: { wraps: wraps })
+          __new__(relation, meta: { wraps: wraps + new_wraps })
         end
 
         # Shortcut to wrap parents
@@ -52,8 +51,26 @@ module ROM
         # @return [RelationProxy]
         #
         # @api private
-        def wrapped(name, keys)
-          with(name: name, meta: { keys: keys, wrap: true, combine_name: name })
+        def wrapped(name, keys, wrap_from_assoc = false)
+          with(
+            name: name,
+            meta: {
+              keys: keys, wrap_from_assoc: wrap_from_assoc, wrap: true, combine_name: name
+            }
+          )
+        end
+
+        # @api private
+        def wraps_from_options(options)
+          options.map { |(name, (relation, keys))| relation.wrapped(name, keys) }
+        end
+
+        # @api private
+        def wraps_from_names(names)
+          names.map { |name|
+            assoc = associations[name]
+            registry[assoc.target].wrapped(name, assoc.combine_keys(__registry__), true)
+          }
         end
       end
     end

data/lib/rom/repository/root.rb

@@ -29,8 +29,6 @@ module ROM
     #
     # @api public
     class Root < Repository
-      extend Dry::Core::ClassAttributes
-
       # @!method self.root
       #   Get or set repository root relation identifier
       #
@@ -59,7 +57,7 @@ module ROM
       end
 
       # @see Repository#initialize
-      def initialize(container)
+      def initialize(container, opts = EMPTY_HASH)
         super
         @root = relations[self.class.root]
       end

data/lib/rom/repository/struct_builder.rb

@@ -40,12 +40,19 @@ module ROM
         relation_name, meta, header = node
         name = meta[:combine_name] || relation_name.relation
 
-        model = call(name, header)
+        model = meta.fetch(:model) { call(name, header) }
+
+        member =
+          if model < Dry::Struct
+            model
+          else
+            Dry::Types::Definition.new(model).constructor(&model.method(:new))
+          end
 
         if meta[:combine_type] == :many
-          [name, Types::Array.member(model)]
+          [name, Types::Array.member(member)]
         else
-          [name, model.optional]
+          [name, member.optional]
         end
       end
 

data/lib/rom/repository/version.rb

@@ -1,5 +1,5 @@
 module ROM
   class Repository
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/lib/rom/struct.rb

@@ -62,5 +62,18 @@ module ROM
     def fetch(name)
       __send__(name)
     end
+
+    private
+
+    def method_missing(m, *args)
+      inspected = inspect
+      trace = caller
+
+      # This is how MRI currently works
+      # see func name_err_mesg_to_str in error.c
+      name = inspected.size > 65 ? to_s : inspected
+
+      raise NoMethodError.new("undefined method `#{ m }' for #{ name }", m, args).tap { |e| e.set_backtrace(trace) }
+    end
   end
 end

data/spec/integration/repository/aggregate_spec.rb

@@ -0,0 +1,49 @@
+RSpec.describe ROM::Repository::Root, '#aggregate' do
+  subject(:repo) do
+    Class.new(ROM::Repository[:users]) do
+      relations :tasks, :posts, :labels
+    end.new(rom)
+  end
+
+  include_context 'database'
+  include_context 'relations'
+  include_context 'seeds'
+
+  it 'exposes nodes via `node` method' do
+    jane = repo.
+             aggregate(:posts).
+             node(:posts) { |posts| posts.where(title: 'Another one') }.
+             where(name: 'Jane').one
+
+    expect(jane.name).to eql('Jane')
+    expect(jane.posts).to be_empty
+
+    repo.posts.insert author_id: 1, title: 'Another one'
+
+    jane = repo.
+             aggregate(:posts).
+             node(:posts) { |posts| posts.where(title: 'Another one') }.
+             where(name: 'Jane').one
+
+    expect(jane.name).to eql('Jane')
+    expect(jane.posts.size).to be(1)
+    expect(jane.posts[0].title).to eql('Another one')
+  end
+
+  it 'exposes nested nodes via `node` method' do
+    jane = repo.
+             aggregate(posts: :labels).
+             node(posts: :labels) { |labels| labels.where(name: 'red') }.
+             where(name: 'Jane').one
+
+    expect(jane.name).to eql('Jane')
+    expect(jane.posts.size).to be(1)
+    expect(jane.posts[0].labels.size).to be(1)
+    expect(jane.posts[0].labels[0].name).to eql('red')
+  end
+
+  it 'raises arg error when invalid relation name was passed to `node` method' do
+    expect { repo.aggregate(:posts).node(:poztz) {} }.
+      to raise_error(ArgumentError, ':poztz is not a valid aggregate node name')
+  end
+end

data/spec/integration/repository_spec.rb

@@ -70,6 +70,13 @@ RSpec.describe 'ROM repository' do
     expect(repo.tag_with_wrapped_task.first).to eql(tag_with_task)
   end
 
+  it 'loads multiple wraps' do
+    post_label = repo.posts_labels.wrap(:post).wrap(:label).to_a.first
+
+    expect(post_label.label_id).to be(post_label.label.id)
+    expect(post_label.post_id).to be(post_label.post.id)
+  end
+
   it 'loads an aggregate via custom fks' do
     jane = repo.aggregate(many: repo.posts).where(name: 'Jane').one
 
@@ -135,7 +142,7 @@ RSpec.describe 'ROM repository' do
     expect(jane.labels[1].name).to eql('blue')
   end
 
-  it 'loads children and its parents via wrap' do
+  it 'loads children and its parents via wrap_parent' do
     posts = repo.posts.wrap_parent(author: repo.users)
 
     label = repo.labels.combine(many: { posts: posts }).first
@@ -146,6 +153,15 @@ RSpec.describe 'ROM repository' do
     expect(label.posts[0].author.name).to eql('Jane')
   end
 
+  it 'loads children and its parents via wrap and association name' do
+    label = repo.labels.combine(many: { posts: repo.posts.wrap(:author) }).first
+
+    expect(label.name).to eql('red')
+    expect(label.posts.size).to be(1)
+    expect(label.posts[0].title).to eql('Hello From Jane')
+    expect(label.posts[0].author.name).to eql('Jane')
+  end
+
   it 'loads a parent via custom fks' do
     post = repo.posts.combine(:author).where(title: 'Hello From Jane').one
 
@@ -243,4 +259,81 @@ RSpec.describe 'ROM repository' do
       expect(repo.dummy.to_a).to eql([])
     end
   end
+
+  describe 'mapping without structs' do
+    shared_context 'plain hash mapping' do
+      describe '#one' do
+        it 'returns a hash' do
+          expect(repo.users.limit(1).one).to eql(id: 1, name: 'Jane')
+        end
+
+        it 'returns a nested hash for an aggregate' do
+          expect(repo.aggregate(:posts).limit(1).one).
+            to eql(id: 1, name: 'Jane', posts: [{ id: 1, author_id: 1, title: 'Hello From Jane', body: 'Jane Post'}])
+        end
+      end
+    end
+
+    context 'with auto_struct disabled upon initialization' do
+      subject(:repo) do
+        repo_class.new(rom, auto_struct: false)
+      end
+
+      include_context 'plain hash mapping'
+    end
+
+    context 'with auto_struct disabled at the class level' do
+      before do
+        repo_class.auto_struct(false)
+      end
+
+      include_context 'plain hash mapping'
+    end
+  end
+
+  describe 'using custom mappers along with auto-mapping' do
+    before do
+      configuration.mappers do
+        define(:users) do
+          register_as :embed_address
+
+          def call(rel)
+            rel.map { |tuple| Hash(tuple).merge(mapped: true) }
+          end
+        end
+      end
+    end
+
+    it 'auto-maps and applies a custom mapper' do
+      jane = repo.users.combine(:posts).map_with(:embed_address, auto_map: true).to_a.first
+
+      expect(jane).
+        to eql(id:1, name: 'Jane', mapped: true, posts: [{ id: 1, author_id: 1, title: 'Hello From Jane', body: 'Jane Post' }])
+    end
+  end
+
+  describe 'using a custom model for a node' do
+    before do
+      class Test::Post < OpenStruct; end
+    end
+
+    it 'uses provided model for the member type' do
+      jane = repo.users.combine(many: repo.posts.as(Test::Post)).where(name: 'Jane').one
+
+      expect(jane.name).to eql('Jane')
+      expect(jane.posts.size).to be(1)
+      expect(jane.posts[0]).to be_instance_of(Test::Post)
+      expect(jane.posts[0].title).to eql('Hello From Jane')
+      expect(jane.posts[0].body).to eql('Jane Post')
+    end
+
+    it 'uses provided model for the attribute type' do
+      jane = repo.users.combine(one: repo.posts.as(Test::Post)).where(name: 'Jane').one
+
+      expect(jane.name).to eql('Jane')
+      expect(jane.post).to be_instance_of(Test::Post)
+      expect(jane.post.title).to eql('Hello From Jane')
+      expect(jane.post.body).to eql('Jane Post')
+    end
+  end
 end

data/spec/unit/relation_proxy_spec.rb

@@ -134,7 +134,8 @@ RSpec.describe 'loading proxy' do
             [:attribute, users.schema[:name]],
             [:relation, [
               :tasks,
-              { dataset: :tasks, keys: { id: :user_id }, combine_type: :many, combine_name: :user_tasks },
+              { dataset: :tasks, keys: { id: :user_id },
+                combine_type: :many, combine_name: :user_tasks },
               [:header, [
                  [:attribute, tasks.schema[:id]],
                  [:attribute, tasks.schema[:user_id]],
@@ -149,7 +150,7 @@ RSpec.describe 'loading proxy' do
       relation = tags.wrap_parent(task: tasks)
 
       tags_schema = tags.schema.qualified
-      tasks_schema = tasks.schema.wrap.qualified
+      tasks_schema = tasks.schema.wrap
 
       expect(relation.to_ast).to eql(
         [:relation, [
@@ -161,7 +162,8 @@ RSpec.describe 'loading proxy' do
             [:attribute, tags_schema[:name]],
             [:relation, [
               :tasks,
-              { dataset: :tasks, keys: { id: :task_id }, wrap: true, combine_name: :task },
+              { dataset: :tasks, keys: { id: :task_id },
+                wrap_from_assoc: false, wrap: true, combine_name: :task },
               [:header, [
                  [:attribute, tasks_schema[:id]],
                  [:attribute, tasks_schema[:user_id]],

data/spec/unit/struct_builder_spec.rb

@@ -69,4 +69,30 @@ RSpec.describe 'struct builder', '#call' do
       Dry::Struct::Error, /:name is missing/
     )
   end
+
+  context 'name errors' do
+    let(:struct) { builder.class.cache[input.hash] }
+
+    context 'missing method on instance' do
+      it 'uses inspect and class name for small structs' do
+        user = struct.new(id: 1, name: 'Jane')
+
+        expect { user.missing }.
+          to raise_error(
+               NoMethodError,
+               %r{undefined method `missing' for #<ROM::Struct\[User\] id=1 name="Jane">}
+             )
+      end
+
+      it 'uses class name in name errors' do
+        user = struct.new(id: 1, name: 'J' * 50)
+
+        expect { user.missing }.
+          to raise_error(
+               NoMethodError,
+               %r{undefined method `missing' for #<ROM::Struct\[User\]:0x\h+>}
+             )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-repository
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -145,6 +145,7 @@ files:
 - spec/integration/command_macros_spec.rb
 - spec/integration/command_spec.rb
 - spec/integration/multi_adapter_spec.rb
+- spec/integration/repository/aggregate_spec.rb
 - spec/integration/repository_spec.rb
 - spec/integration/root_repository_spec.rb
 - spec/integration/typed_structs_spec.rb
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: Repository abstraction for rom-rb