rom-repository 0.3.1 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db1338c97747a9adc2b9f00febe402d61ac1a6fd
-  data.tar.gz: bd6ca3140fe897a0d6b9cccc3082e0fdaf63ed9a
+  metadata.gz: a5e3e3120dbe44e4f2f116cfe7aaaba6b2ef0a7e
+  data.tar.gz: 1e29da4f4c4c2c8c6cf7d9a70c794365419bc18d
 SHA512:
-  metadata.gz: 04f9d30b32805886118b5eb36451aeba065cc510d1a92d091c1e99a41585eb821cf69b68fa56b1f049610b390d1403316a662dacfe4ba32b7f65ba6ac60b8e84
-  data.tar.gz: 48a3b4136e064e00a562a584555765e8fb47a05388457b3cb31ab3b762dda4dd221299a1b621dfaf3705167412af644c8244c7ebbde22da285a8985f3afb712b
+  metadata.gz: b40d4d1a1c984998a0f58287cf586dd151251f9e9cabddcf22fff0a23e944f7113a1ffef5be76e6c44560d99d9c4d7bcecbb78f074f5079057ac71f7da0708a8
+  data.tar.gz: 8ec19211a0103e67f33578166bb781c1d42271d04e5561451e023aaccc4722d90b9e2fa3061cc1a021efca5c5f13fad00b105f9d72cfb66c1a4f86a679422c13

data/.travis.yml

@@ -1,28 +1,26 @@
 language: ruby
-sudo: false
+dist: trusty
+sudo: required
 cache: bundler
 bundler_args: --without yard guard benchmarks tools
 before_script:
   - psql -c 'create database rom_repository' -U postgres
 script: "bundle exec rake ci"
+after_success:
+  - '[ "${TRAVIS_JOB_NUMBER#*.}" = "1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - rbx-2
-  - jruby-9.0.5.0
-  - ruby-head
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+  - rbx-3
+  - jruby-9.1.6.0
 env:
   global:
-    - CODECLIMATE_REPO_TOKEN=173b95dae5c6ac281bc36a4b212291a89fed9b520b39a86bafdf603692250e60
     - JRUBY_OPTS='--dev -J-Xmx1024M'
+    - COVERAGE='true'
 matrix:
   allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-  include:
-    - rvm: jruby-head
-      before_install: gem install bundler --no-ri --no-rdoc
+    - rvm: rbx-3
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# v1.0.0 to-be-released
+
+### Added
+
+* New `Repository#session` API for building transactions using changesets (solnic)
+* Support for inferring typed structs based on relation schemas (solnic)
+* `aggregate` and `combine` support nested association specs, ie `combine(users: [tasks: :tags])` (beauby)
+* Changesets support data as arrays too (solnic)
+* Changesets support custom command types via `Changeset#with(command_type: :my_command)` (solnic)
+* `Changeset::Delete` was added and is accessible via `repo.changeset(delete: some_relation.by_pk(1))` (solnic)
+* Ability to define custom changeset classes that can be instantiated via `repo.changeset(MyChangesetClass[:rel_name]).data(some_data)` where `MyChangesetClass` inherits from a core changeset class (solnic)
+* `Changeset.map` which accepts a block and exposes a DSL for data transformations (all [transproc hash methods](https://github.com/solnic/transproc)) are available (solnic)
+* `Changeset#associate` method that accepts another changeset or parent data and an association identifier, ie `post_changeset.associate(user, :author)` (solnic)
+
+### Changed
+
+* `ROM::Struct` is now based on `Dry::Struct` (solnic)
+* rom-support dependency was removed (flash-gordon)
+
+### Fixed
+
+* Auto-mapping to structs ignores FK attributes consistently (solnic)
+
+[Compare v0.3.1...v1.0.0](https://github.com/rom-rb/rom-repository/compare/v0.3.1...v1.0.0)
+
 # v0.3.1 2016-07-27
 
 Fixed gemspec so that we don't exclude all files with 'bin' in their name, geez (solnic)

data/Gemfile

@@ -4,8 +4,11 @@ gemspec
 
 gem 'inflecto'
 
+gem 'rom', git: 'https://github.com/rom-rb/rom.git', branch: 'master'
+gem 'rom-mapper', git: 'https://github.com/rom-rb/rom-mapper.git', branch: 'master'
+
 group :development, :test do
-  gem 'rom-sql', '~> 0.8'
+  gem 'rom-sql', git: 'https://github.com/rom-rb/rom-sql.git', branch: 'master'
 end
 
 group :development do
@@ -16,18 +19,25 @@ end
 
 group :test do
   gem 'rspec'
+  gem 'dry-struct'
   gem 'byebug', platforms: :mri
   gem 'pg', platforms: [:mri, :rbx]
   gem 'jdbc-postgres', platforms: :jruby
-  gem 'codeclimate-test-reporter', require: nil
+
+  platform :mri do
+    gem 'codeclimate-test-reporter', require: false
+    gem 'simplecov'
+  end
 end
 
 group :benchmarks do
   gem 'hotch', platforms: :mri
   gem 'benchmark-ips'
-  gem 'activerecord', '~> 4.2'
+  gem 'activerecord', '~> 5.0'
 end
 
 group :tools do
   gem 'pry'
+  gem 'mutant'
+  gem 'mutant-rspec'
 end

data/lib/rom/repository.rb

@@ -1,5 +1,4 @@
-require 'rom/support/deprecations'
-require 'rom/support/options'
+require 'dry/core/deprecations'
 
 require 'rom/repository/class_interface'
 require 'rom/repository/mapper_builder'
@@ -8,6 +7,7 @@ require 'rom/repository/command_compiler'
 
 require 'rom/repository/root'
 require 'rom/repository/changeset'
+require 'rom/repository/session'
 
 module ROM
   # Abstract repository class to inherit from
@@ -49,14 +49,6 @@ module ROM
   #
   # @api public
   class Repository
-    # @deprecated
-    class Base < Repository
-      def self.inherited(klass)
-        super
-        Deprecations.announce(self, 'inherit from Repository instead')
-      end
-    end
-
     extend ClassInterface
 
     # @!attribute [r] container
@@ -71,6 +63,9 @@ module ROM
     #   @return [MapperBuilder] The auto-generated mappers for repo relations
     attr_reader :mappers
 
+    # @api private
+    attr_reader :command_compiler
+
     # Initializes a new repo by establishing configured relation proxies from
     # the passed container
     #
@@ -93,6 +88,7 @@ module ROM
           relations[name] = proxy
         end
       end
+      @command_compiler = method(:command)
     end
 
     # @overload command(type, relation)
@@ -166,23 +162,60 @@ module ROM
     #
     # @api public
     def changeset(*args)
+      opts = { command_compiler: command_compiler }
+
       if args.size == 2
         name, data = args
       elsif args.size == 3
         name, pk, data = args
+      elsif args.size == 1
+        type = args[0]
+
+        if type.is_a?(Class) && type < Changeset
+          return type.new(relations[type.relation], opts)
+        else
+          type, relation = args[0].to_a[0]
+        end
       else
-        raise ArgumentError, 'Repository#changeset accepts 2 or 3 arguments'
+        raise ArgumentError, 'Repository#changeset accepts 1-3 arguments'
       end
 
-      relation = relations[name]
-
-      if pk
-        Changeset::Update.new(relation, data, primary_key: pk)
+      if type
+        if type.equal?(:delete)
+          Changeset::Delete.new(relation, opts)
+        end
       else
-        Changeset::Create.new(relation, data)
+        relation = relations[name]
+
+        if pk
+          Changeset::Update.new(relation, opts.merge(__data__: data, primary_key: pk))
+        else
+          Changeset::Create.new(relation, opts.merge(__data__: data))
+        end
       end
     end
 
+    # TODO: document me, please
+    #
+    # @api public
+    def session(&block)
+      session = Session.new(self)
+      yield(session)
+      transaction { session.commit! }
+    end
+
+    # TODO: document me, please
+    #
+    # @api public
+    def transaction(&block)
+      container.gateways[:default].transaction(&block)
+    end
+
+    # @api public
+    def inspect
+      %(#<#{self.class} relations=[#{self.class.relations.map(&:inspect).join(' ')}]>)
+    end
+
     private
 
     # Local command cache
@@ -205,12 +238,17 @@ module ROM
 
       if mapper
         mapper_instance = container.mappers[relation.name.relation][mapper]
-      else
+      elsif mapper.nil?
         mapper_instance = mappers[ast]
       end
 
-      command = CommandCompiler[container, type, adapter, ast, use]
-      command >> mapper_instance
+      command = CommandCompiler[container, type, adapter, ast, use, opts]
+
+      if mapper_instance
+        command >> mapper_instance
+      else
+        command.new(relation)
+      end
     end
 
     # @api private

data/lib/rom/repository/changeset.rb

@@ -1,11 +1,24 @@
-require 'rom/support/constants'
-require 'rom/support/options'
+require 'dry/core/class_attributes'
+require 'dry/core/cache'
 
+require 'rom/initializer'
 require 'rom/repository/changeset/pipe'
 
 module ROM
   class Changeset
-    include Options
+    extend Initializer
+    extend Dry::Core::Cache
+    extend Dry::Core::ClassAttributes
+
+    defines :relation
+
+    # @!attribute [r] relation
+    #   @return [Relation] The changeset relation
+    param :relation
+
+    # @!attribute [r] __data__
+    #   @return [Hash] The relation data
+    option :__data__, reader: true, optional: true, default: proc { nil }
 
     # @!attribute [r] pipe
     #   @return [Changeset::Pipe] data transformation pipe
@@ -13,13 +26,33 @@ module ROM
       changeset.class.default_pipe
     }
 
-    # @!attribute [r] relation
-    #   @return [Relation] The changeset relation
-    attr_reader :relation
+    # @!attribute [r] command_compiler
+    #   @return [Proc] a proc that can compile a command (typically provided by a repo)
+    option :command_compiler, reader: true, optional: true
 
-    # @!attribute [r] data
-    #   @return [Hash] The relation data
-    attr_reader :data
+    # @!attribute [r] command_type
+    #   @return [Symbol] a custom command identifier
+    option :command_type, reader: true, optional: true, default: -> changeset { changeset.default_command_type }
+
+    # Create a changeset class preconfigured for a specific relation
+    #
+    # @example
+    #   class NewUserChangeset < ROM::Changeset::Create[:users]
+    #   end
+    #
+    #   user_repo.changeset(NewUserChangeset).data(name: 'Jane')
+    #
+    # @api public
+    def self.[](relation_name)
+      fetch_or_store(relation_name) {
+        Class.new(self) { relation(relation_name) }
+      }
+    end
+
+    # @api public
+    def self.map(&block)
+      @pipe = Class.new(Pipe, &block).new
+    end
 
     # Build default pipe object
     #
@@ -27,14 +60,7 @@ module ROM
     #
     # @return [Pipe]
     def self.default_pipe
-      Pipe.new
-    end
-
-    # @api private
-    def initialize(relation, data, options = EMPTY_HASH)
-      @relation = relation
-      @data = data
-      super
+      @pipe || Pipe.new
     end
 
     # Pipe changeset's data using custom steps define on the pipe
@@ -44,8 +70,12 @@ module ROM
     # @return [Changeset]
     #
     # @api public
-    def map(*steps)
-      with(pipe: steps.reduce(pipe) { |a, e| a >> pipe.class[e] })
+    def map(*steps, &block)
+      if block
+        __data__.map { |*args| yield(*args) }
+      else
+        with(pipe: steps.reduce(pipe) { |a, e| a >> pipe[e] })
+      end
     end
 
     # Coerce changeset to a hash
@@ -56,10 +86,22 @@ module ROM
     #
     # @api public
     def to_h
-      pipe.call(data)
+      pipe.call(__data__)
     end
     alias_method :to_hash, :to_h
 
+    # Coerce changeset to an array
+    #
+    # This will send the data through the pipe
+    #
+    # @return [Array]
+    #
+    # @api public
+    def to_a
+      result == :one ? [to_h] : __data__.map { |element| pipe.call(element) }
+    end
+    alias_method :to_ary, :to_a
+
     # Return a new changeset with updated options
     #
     # @param [Hash] new_options The new options
@@ -68,23 +110,43 @@ module ROM
     #
     # @api private
     def with(new_options)
-      self.class.new(relation, data, options.merge(new_options))
+      self.class.new(relation, options.merge(new_options))
+    end
+
+    # Return changeset with data
+    #
+    # @param [Hash] data
+    #
+    # @return [Changeset]
+    #
+    # @api public
+    def data(data)
+      with(__data__: data)
+    end
+
+    # Return command result type
+    #
+    # @return [Symbol]
+    #
+    # @api private
+    def result
+      __data__.is_a?(Hash) ? :one : :many
     end
 
     private
 
     # @api private
     def respond_to_missing?(meth, include_private = false)
-      super || data.respond_to?(meth)
+      super || __data__.respond_to?(meth)
     end
 
     # @api private
     def method_missing(meth, *args, &block)
-      if data.respond_to?(meth)
-        response = data.__send__(meth, *args, &block)
+      if __data__.respond_to?(meth)
+        response = __data__.__send__(meth, *args, &block)
 
-        if response.is_a?(Hash)
-          self.class.new(relation, response, options)
+        if response.is_a?(__data__.class)
+          with(__data__: response)
         else
           response
         end
@@ -97,3 +159,4 @@ end
 
 require 'rom/repository/changeset/create'
 require 'rom/repository/changeset/update'
+require 'rom/repository/changeset/delete'

data/lib/rom/repository/changeset/create.rb

@@ -4,6 +4,15 @@ module ROM
     #
     # @api public
     class Create < Changeset
+      # @!attribute [r] association
+      #   @return [Array] Associated changesets with its association name
+      option :association, reader: true, optional: true
+
+      # @api public
+      def associate(other, assoc)
+        with(association: [other, assoc])
+      end
+
       # Return false
       #
       # @return [FalseClass]
@@ -21,6 +30,31 @@ module ROM
       def create?
         true
       end
+
+      # @api private
+      def command
+        if options[:association]
+          other, assoc = options[:association]
+
+          if other.is_a?(Changeset)
+            create_command.curry(self) >> other.command.with_association(assoc)
+          else
+            create_command.with_association(assoc).curry(self, other)
+          end
+        else
+          create_command.curry(self)
+        end
+      end
+
+      # @api private
+      def create_command
+        command_compiler.(command_type, relation, mapper: false, result: result)
+      end
+
+      # @api private
+      def default_command_type
+        :create
+      end
     end
   end
 end