rom 2.0.2 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6dd420bd1787efc67261de110b316f6b5c92ae8
-  data.tar.gz: e9f8fb3dbc40528ac46f6427d7b7238c162980bd
+  metadata.gz: 58d0cbbb31e4ac734e6b569dcd7c0a1bd679bd89
+  data.tar.gz: d6f72e2b130a21ba81cc66400be6da7ea179aa6c
 SHA512:
-  metadata.gz: 6a48171fa2e771fec4e68e14b99e4f78cfd31f6d5162ff5f14546f41d6970b44c8522304cfa9546cff203967696853002e3524f714023d7ac0fd5ea086d7ea9f
-  data.tar.gz: 34e9a0f63fabaf30897d767db9b8d26e1ac92cd0661cff7bdb5b1f27979fe56feb9f6b0c12ae7305f514c623322e270009ecd3ce35e51867bfdac5a199393408
+  metadata.gz: 3ae3f83681a32b2f51629a49ab3ecde5c66d2ce2ce59e6dfdb36475343a73ff4515bda9e5aa5b7ab59fb7fd81777296ee7b98b221af621f1f37bd4ae42159442
+  data.tar.gz: b688b6b8430a4f9bbe4dd43dbe066813aa354adc5d0e519107be7c3c8e226abb8498c06c2bbbd4042d6498a2ea0c63e63a73396ad1fddf342740a1c438c14045

data/.travis.yml

@@ -5,11 +5,11 @@ cache: bundler
 bundler_args: --without sql benchmarks console tools
 script: "bundle exec rake ci"
 after_success:
-  - '[ "$TRAVIS_RUBY_VERSION" = "2.3.1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
+  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
   - rbx-3
   - jruby-9.1.5.0
 env:

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## v3.0.0 to-be-released
+
+## Added
+
+* Support for schemas in view definitions via `schema do ... end` block (evaluated in the context of the canonical schema) (solnic)
+* Schemas have their own types with adapter-specific APIs (solnic)
+* Schema attributes include meta properties `source` and `target` (for FKs) (solnic)
+* Inferred schemas can have explicit attribute definitions for cases where inference didn't work (solnic)
+* New schema APIs: `#project`, `#rename`, `#exclude`, `#prefix`, `#wrap` and `#merge` (solnic)
+* New schema attribute APIs: `#name`, `#aliased`, `#aliased?`, `#prefixed`, `#prefixed?`, `#wrapped`, `#wrapped?`, `#source`, `#target`, `#primary_key?`, `#foreign_key?` (solnic)
+* Schemas are coercible to arrays that include all attribute types (solnic)
+* Automatic relation view projection via `Schema#call` (abstract method for adapters) (solnic)
+* `Relation#new(dataset, new_opts)` interface (solnic)
+* `Relation#[]` interface for convenient access to schema attributes (solnic)
+* `Command` has now support for `before` and `after` hooks (solnic)
+* New `Command#before` method for creating a command with before hook(s) at run-time (solnic)
+* New `Command#after` method for creating a command with after hook(s) at run-time (solnic)
+* New `Gateway#transaction` method runs code inside a transaction (flash-gordon)
+
+## Changed
+
+* [BREAKING] All relations have schemas now, empty by default (solnic)
+* [BREAKING] `view` DSL is now part of the core relation API (solnic)
+* [BREAKING] `view` DSL is based on schemas now, `header` was replaced with `schema` (solnic)
+* [BREAKING] Deprecated `Command.validator` was removed (solnic)
+* [internal] Renamed `relation` => `target` meta property in FK types (solnic)
+* [internal] Use deprecations API from dry-core (flash-gordon)
+* [internal] Use common constants from dry-core (EMPTY_HASH, EMPTY_ARRAY etc.) (flash-gordon)
+* [internal] Internal ROM modules (array_dataset, enumerable_dataset, auto_curry, and data_proxy) were moved from rom-support to ROM itself (flash-gordon)
+* [internal] rom-support dependency was removed (flash-gordon)
+
+[Compare v2.0.2...v3.0.0](https://github.com/rom-rb/rom/compare/v2.0.2...v3.0.0)
+
 ## v2.0.2 2016-11-11
 
 ## Added
@@ -9,7 +42,7 @@
 * Custom command input function is no longer overridden by schema hash (solnic)
 * `Relation::Name#to_s` returns a string properly when there is no alias (solnic)
 
-[Compare v2.0.1...v2.0.2](https://github.com/rom-rb/rom/compare/v2.0.0...v2.0.2)
+[Compare v2.0.1...v2.0.2](https://github.com/rom-rb/rom/compare/v2.0.1...v2.0.2)
 
 ## v2.0.1 2016-09-30
 

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rom-mapper', git: 'https://github.com/rom-rb/rom-mapper.git', branch: 'master'
+
 group :console do
   gem 'pry'
   gem 'pg', platforms: [:mri]
@@ -24,18 +26,30 @@ group :test do
 end
 
 group :sql do
-  gem 'rom-sql', github: 'rom-rb/rom-sql', branch: 'master'
+  gem 'rom-sql', git: 'https://github.com/rom-rb/rom-sql.git', branch: 'master'
   gem 'sequel'
   gem 'jdbc-sqlite3', platforms: :jruby
+  gem 'jdbc-postgres', platforms: :jruby
   gem 'sqlite3', platforms: [:mri, :rbx]
+
+  git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+  platform :jruby do
+    github 'jruby/activerecord-jdbc-adapter', branch: 'rails-5' do
+      gem 'activerecord-jdbc-adapter'
+      gem 'activerecord-jdbcpostgresql-adapter'
+    end
+  end
 end
 
 group :benchmarks do
   gem 'activerecord', '~> 5.0'
   gem 'benchmark-ips', '~> 2.2.0'
-  gem 'rom-repository', github: 'rom-rb/rom-repository', branch: 'master'
+  gem 'rom-repository', git: 'https://github.com/rom-rb/rom-repository.git', branch: 'master'
 end
 
 group :tools do
   gem 'byebug', platform: :mri
+  gem 'mutant'
+  gem 'mutant-rspec'
 end

data/Rakefile

@@ -11,8 +11,13 @@ task :"spec:isolation" do
   end
 end
 
-desc "Run CI tasks"
-task ci: [:spec, :lint, :"spec:isolation"]
+if RUBY_ENGINE == 'jruby'
+  desc "Run CI tasks"
+  task ci: [:spec, :lint]
+else
+  desc "Run CI tasks"
+  task ci: [:spec, :lint, :"spec:isolation"]
+end
 
 Rake::TestTask.new(:lint) do |test|
   test.description = "Run adapter lint tests against memory adapter"

data/lib/rom/array_dataset.rb

@@ -0,0 +1,44 @@
+require 'rom/initializer'
+require 'rom/enumerable_dataset'
+
+module ROM
+  # A helper module that adds data-proxy behavior to an array-like object
+  #
+  # @see EnumerableDataset
+  #
+  # @api public
+  module ArrayDataset
+    extend DataProxy::ClassMethods
+    include EnumerableDataset
+
+    # Extends the class with data-proxy behavior
+    #
+    # @api private
+    def self.included(klass)
+      klass.class_eval do
+        extend Initializer
+        include DataProxy
+
+        param :data
+      end
+    end
+
+    forward(
+      :*, :+, :-, :compact, :compact!, :flatten, :flatten!, :length, :pop,
+      :reverse, :reverse!, :sample, :size, :shift, :shuffle, :shuffle!,
+      :slice, :slice!, :sort!, :uniq, :uniq!, :unshift, :values_at
+    )
+
+    [
+      :map!, :combination, :cycle, :delete_if, :keep_if, :permutation, :reject!,
+      :select!, :sort_by!
+    ].each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args, &block)
+          return to_enum unless block
+          self.class.new(data.send(:#{method}, *args, &block), options)
+        end
+      RUBY
+    end
+  end
+end

data/lib/rom/association_set.rb

@@ -1,12 +1,14 @@
-require 'rom/support/registry'
-require 'rom/support/inflector'
+require 'dry/core/inflector'
+require 'rom/registry'
 
 module ROM
   class AssociationSet < ROM::Registry
     # @api private
     def try(name, &block)
-      if key?(name)
-        yield(self[name])
+      key = name.to_sym
+
+      if key?(key) || key?(singularize(key))
+        yield(self[key])
       else
         false
       end
@@ -19,8 +21,12 @@ module ROM
       if key?(key)
         super
       else
-        super(Inflector.singularize(key))
+        super(singularize(key))
       end
     end
+
+    def singularize(key)
+      Dry::Core::Inflector.singularize(key).to_sym
+    end
   end
 end

data/lib/rom/auto_curry.rb

@@ -0,0 +1,55 @@
+module ROM
+  module AutoCurry
+    def self.extended(klass)
+      klass.define_singleton_method(:method_added) do |name|
+        return if auto_curry_busy?
+        auto_curry_guard { auto_curry(name) }
+        super(name)
+      end
+    end
+
+    def auto_curry_guard
+      @__auto_curry_busy__ = true
+      yield
+    ensure
+      @__auto_curry_busy__ = false
+    end
+
+    def auto_curry_busy?
+      @__auto_curry_busy__ ||= false
+    end
+
+    def auto_curried_methods
+      @__auto_curried_methods__ ||= []
+    end
+
+    def auto_curry(name, &block)
+      arity = instance_method(name).arity
+
+      return unless public_instance_methods.include?(name) && arity != 0
+
+      mod = Module.new
+
+      mod.module_eval do
+        define_method(name) do |*args|
+          response =
+            if arity < 0 || arity == args.size
+              super(*args)
+            else
+              self.class.curried.new(self, name: name, curry_args: args, arity: arity)
+            end
+
+          if block
+            response.instance_exec(&block)
+          else
+            response
+          end
+        end
+      end
+
+      auto_curried_methods << name
+
+      prepend(mod)
+    end
+  end
+end

data/lib/rom/command.rb

@@ -1,5 +1,8 @@
-require 'rom/support/deprecations'
-require 'rom/support/options'
+require 'dry/core/deprecations'
+require 'dry/core/class_attributes'
+
+require 'rom/types'
+require 'rom/initializer'
 require 'rom/pipeline'
 
 require 'rom/commands/class_interface'
@@ -20,57 +23,33 @@ module ROM
   #
   # @private
   class Command
-    DEFAULT_VALIDATOR = proc {}
-
+    extend Initializer
     include Dry::Equalizer(:relation, :options)
     include Commands
     include Pipeline::Operator
 
-    extend ClassMacros
+    extend Dry::Core::ClassAttributes
     extend ClassInterface
 
-    include Options
+    defines :adapter, :relation, :result, :input, :register_as, :restrictable, :before, :after
 
-    defines :adapter, :relation, :result, :input, :validator, :register_as, :restrictable
+    # @attr_reader [Relation] relation The command's relation
+    param :relation
 
-    option :type, allow: [:create, :update, :delete]
-    option :source, reader: true
-    option :result, reader: true, allow: [:one, :many]
-    option :validator, reader: true
+    CommandType = Types::Strict::Symbol.enum(:create, :update, :delete)
+    Result = Types::Strict::Symbol.enum(:one, :many)
+
+    option :type, type: CommandType, optional: true
+    option :source, reader: true, optional: true, default: -> c { c.relation }
+    option :result, reader: true, type: Result
     option :input, reader: true
-    option :curry_args, type: Array, reader: true, default: EMPTY_ARRAY
+    option :curry_args, reader: true, default: -> _ { EMPTY_ARRAY }
+    option :before, Types::Coercible::Array, reader: true, as: :before_hooks, default: proc { EMPTY_ARRAY }
+    option :after, Types::Coercible::Array, reader: true, as: :after_hooks, default: proc { EMPTY_ARRAY }
 
     input Hash
-    validator DEFAULT_VALIDATOR
     result :many
 
-    # @deprecated
-    #
-    # @api public
-    def self.validator(vp = nil)
-      if defined?(@validator) && vp.nil?
-        @validator
-      else
-        unless vp.equal?(DEFAULT_VALIDATOR)
-          Deprecations.announce(
-            "#{name}.validator",
-            'Please handle validation before calling commands'
-          )
-        end
-        super
-      end
-    end
-
-    # @attr_reader [Relation] relation The command's relation
-    attr_reader :relation
-
-    # @api private
-    def initialize(relation, options = EMPTY_HASH)
-      super
-      @relation = relation
-      @source = options[:source] || relation
-    end
-
     # Return name of this command's relation
     #
     # @return [ROM::Relation::Name]
@@ -107,7 +86,25 @@ module ROM
     #
     # @api public
     def call(*args, &block)
-      tuples = execute(*(curry_args + args), &block)
+      tuples =
+        if hooks?
+          prepared =
+            if curried?
+              apply_hooks(before_hooks, *(curry_args + args))
+            else
+              apply_hooks(before_hooks, *args)
+            end
+
+          result = prepared ? execute(prepared, &block) : execute(&block)
+
+          if curried?
+            apply_hooks(after_hooks, result, *args)
+          else
+            apply_hooks(after_hooks, result, *args[1..args.size-1])
+          end
+        else
+          execute(*(curry_args + args), &block)
+        end
 
       if one?
         tuples.first
@@ -133,6 +130,16 @@ module ROM
     end
     alias_method :with, :curry
 
+    # @api public
+    def curried?
+      curry_args.size > 0
+    end
+
+    # @api private
+    def hooks?
+      before_hooks.size > 0 || after_hooks.size > 0
+    end
+
     # @api public
     def combine(*others)
       Graph.new(self, others)
@@ -163,11 +170,33 @@ module ROM
       self.class.build(new_relation, options.merge(source: relation))
     end
 
+    # @api public
+    def before(*hooks)
+      self.class.new(relation, options.merge(before: hooks))
+    end
+
+    # @api public
+    def after(*hooks)
+      self.class.new(relation, options.merge(after: hooks))
+    end
+
     private
 
     # @api private
     def composite_class
       Command::Composite
     end
+
+    # @api private
+    def apply_hooks(hooks, tuples, *args)
+      hooks.reduce(tuples) do |a, e|
+        if e.is_a?(Hash)
+          hook_meth, hook_args = e.to_a.flatten(1)
+          __send__(hook_meth, a, *args, **hook_args)
+        else
+          __send__(e, a, *args)
+        end
+      end
+    end
   end
 end

data/lib/rom/command_registry.rb

@@ -1,3 +1,4 @@
+require 'rom/types'
 require 'rom/commands/result'
 
 module ROM
@@ -5,40 +6,28 @@ module ROM
   #
   # @api public
   class CommandRegistry
+    extend Initializer
     include Commands
-    include Options
 
     CommandNotFoundError = Class.new(KeyError)
+    RegistryType = Types.Definition(Registry) | Types.Constructor(Registry) { |r| Registry.new(r, self.class.name) }
 
     # Name of the relation from which commands are under
     #
     # @return [String]
     #
     # @api private
-    attr_reader :relation_name
+    param :relation_name
 
     # Internal command registry
     #
     # @return [Registry]
     #
     # @api private
-    attr_reader :registry
+    param :registry, type: RegistryType
 
-    option :mappers, reader: true
-    option :mapper, reader: true
-
-    # @api private
-    def initialize(relation_name, elements, options = EMPTY_HASH)
-      super
-
-      @relation_name = relation_name
-      @registry =
-        if elements.is_a?(Registry)
-          elements
-        else
-          Registry.new(elements, self.class.name)
-        end
-    end
+    option :mappers, reader: true, optional: true
+    option :mapper, reader: true, optional: true
 
     # Try to execute a command in a block
     #

data/lib/rom/commands/class_interface.rb

@@ -1,4 +1,5 @@
-require 'rom/support/class_builder'
+require 'dry/core/class_builder'
+require 'dry/core/inflector'
 
 module ROM
   # Base command class with factory class-level interface and setup-related logic
@@ -20,7 +21,7 @@ module ROM
       #
       # @api public
       def [](adapter)
-        adapter_namespace(adapter).const_get(Inflector.demodulize(name))
+        adapter_namespace(adapter).const_get(Dry::Core::Inflector.demodulize(name))
       end
 
       # Return namespaces that contains command subclasses of a specific adapter
@@ -65,8 +66,8 @@ module ROM
       #
       # @api public
       def create_class(name, type, &block)
-        klass = ClassBuilder
-          .new(name: "#{Inflector.classify(type)}[:#{name}]", parent: type)
+        klass = Dry::Core::ClassBuilder
+          .new(name: "#{Dry::Core::Inflector.classify(type)}[:#{name}]", parent: type)
           .call
 
         if block
@@ -113,7 +114,7 @@ module ROM
       #
       # @api private
       def default_name
-        Inflector.underscore(Inflector.demodulize(name)).to_sym
+        Dry::Core::Inflector.underscore(Dry::Core::Inflector.demodulize(name)).to_sym
       end
 
       # Return default options based on class macros
@@ -122,7 +123,7 @@ module ROM
       #
       # @api private
       def options
-        { input: input, validator: validator, result: result }
+        { input: input, result: result, before: before, after: after }
       end
 
       # @api private

data/lib/rom/commands/composite.rb

@@ -1,5 +1,4 @@
 require 'rom/pipeline'
-require 'rom/support/constants'
 
 module ROM
   module Commands

data/lib/rom/commands/graph.rb

@@ -1,5 +1,5 @@
+require 'rom/initializer'
 require 'rom/pipeline'
-require 'rom/support/options'
 require 'rom/commands/graph/class_interface'
 
 module ROM
@@ -8,35 +8,27 @@ module ROM
     #
     # @api private
     class Graph
+      extend Initializer
       include Dry::Equalizer(:root, :nodes)
 
       extend ClassInterface
 
-      include Options
       include Pipeline
       include Pipeline::Proxy
 
       # @attr_reader [Command] root The root command
-      attr_reader :root
+      param :root
 
       # @attr_reader [Array<Command>] nodes The child commands
-      attr_reader :nodes
-
-      # @attr_reader [Symbol] root's relation name
-      attr_reader :name
+      param :nodes
 
       alias_method :left, :root
       alias_method :right, :nodes
 
-      option :mappers, reader: true, default: proc { MapperRegistry.new }
+      # @attr_reader [Symbol] root's relation name
+      option :name, reader: true, default: -> g { g.root.name }
 
-      # @api private
-      def initialize(root, nodes, options = EMPTY_HASH)
-        super
-        @root = root
-        @nodes = nodes
-        @name = root.name
-      end
+      option :mappers, reader: true, default: proc { MapperRegistry.new }
 
       # Calls root and all nodes with the result from root
       #

data/lib/rom/commands/lazy/update.rb

@@ -20,7 +20,7 @@ module ROM
 
             if input.is_a?(Array)
               input.map.with_index do |item, index|
-                command_proc[command, last, item].call(item, *args[1..size-1])
+                command_proc[command, last, item].call(item,  *args[1..size-1])
               end
             else
               command_proc[command, *(size > 1 ? [last, input] : [input])]

data/lib/rom/configuration_dsl/command.rb

@@ -1,7 +1,5 @@
-require 'rom/support/constants'
-
-require 'rom/support/inflector'
-require 'rom/support/class_builder'
+require 'dry/core/inflector'
+require 'dry/core/class_builder'
 
 module ROM
   module ConfigurationDSL
@@ -16,12 +14,12 @@ module ROM
       # @api private
       def self.build_class(name, relation, options = EMPTY_HASH, &block)
         type = options.fetch(:type) { name }
-        command_type = Inflector.classify(type)
+        command_type = Dry::Core::Inflector.classify(type)
         adapter = options.fetch(:adapter)
         parent = ROM::Command.adapter_namespace(adapter).const_get(command_type)
         class_name = generate_class_name(adapter, command_type, relation)
 
-        ClassBuilder.new(name: class_name, parent: parent).call do |klass|
+        Dry::Core::ClassBuilder.new(name: class_name, parent: parent).call do |klass|
           klass.register_as(name)
           klass.relation(relation)
           klass.class_eval(&block) if block
@@ -33,9 +31,9 @@ module ROM
       # @api private
       def self.generate_class_name(adapter, command_type, relation)
         pieces = ['ROM']
-        pieces << Inflector.classify(adapter)
+        pieces << Dry::Core::Inflector.classify(adapter)
         pieces << 'Commands'
-        pieces << "#{command_type}[#{Inflector.classify(relation)}s]"
+        pieces << "#{command_type}[#{Dry::Core::Inflector.classify(relation)}s]"
         pieces.join('::')
       end
     end

data/lib/rom/configuration_dsl/mapper.rb

@@ -1,5 +1,4 @@
-require 'rom/support/constants'
-require 'rom/support/class_builder'
+require 'dry/core/class_builder'
 
 module ROM
   module ConfigurationDSL
@@ -25,7 +24,7 @@ module ROM
             ROM::Mapper
           end
 
-        ClassBuilder.new(name: class_name, parent: parent_class).call do |klass|
+        Dry::Core::ClassBuilder.new(name: class_name, parent: parent_class).call do |klass|
           klass.relation(name)
           klass.inherit_header(inherit_header)
 

data/lib/rom/configuration_dsl/mapper_dsl.rb

@@ -1,4 +1,3 @@
-require 'rom/support/constants'
 require 'rom/configuration_dsl/mapper'
 
 module ROM

data/lib/rom/configuration_dsl/relation.rb

@@ -1,5 +1,5 @@
-require 'rom/support/constants'
-require 'rom/support/class_builder'
+require 'dry/core/class_builder'
+require 'dry/core/inflector'
 
 module ROM
   module ConfigurationDSL
@@ -13,10 +13,10 @@ module ROM
       #
       # @api private
       def self.build_class(name, options = EMPTY_HASH)
-        class_name = "ROM::Relation[#{Inflector.camelize(name)}]"
+        class_name = "ROM::Relation[#{Dry::Core::Inflector.camelize(name)}]"
         adapter = options.fetch(:adapter)
 
-        ClassBuilder.new(name: class_name, parent: ROM::Relation[adapter]).call do |klass|
+        Dry::Core::ClassBuilder.new(name: class_name, parent: ROM::Relation[adapter]).call do |klass|
           klass.gateway(options.fetch(:gateway, :default))
           klass.dataset(name)
         end