rom 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6771ee9f6bab9f361d07a23f01fac0dddcf72ee6
-  data.tar.gz: c88e61d11bab08abeb09c1650a4cec39f89c47e1
+  metadata.gz: 865d4e2694bbdadfd473db6464100f268393559d
+  data.tar.gz: b676c75f27251e94c18c654213f27129a6be0651
 SHA512:
-  metadata.gz: f543134ad51fbfeb9d8c9b6abb2de2eb9ecf492398240056df3db3e3ed2679f3a909d106fdbd72bd5d200d8ce5f21e049250109e679d8c385b60165eab71bf73
-  data.tar.gz: e758461e01f25ba9cfde075a5b0a36fa3f74a1a114f0c24c21029c4a4b0cca9cbf8a3716c2a32bc2d58d1dd5b455fd42cdd8c678275077d2136c30372df36825
+  metadata.gz: e89088463acbd0e5f6f90d599e9d6c8ab2fbc6ef35f9c6f5a12f41c68e5f2a2a471a710ccbc7172568faf750f0cd124abb79a0907b9d4bb9c9d12e3addbd72fa
+  data.tar.gz: f4a6d18309f9874329f7d3ec927ec10ea46bfb19e90d2c73fd5c09009c2735294a01eede5f858531fdeae52748ccc3e2b47c25880ddebae619e41862c02b3837

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v0.6.1 2015-04-04
+
+### Added
+
+* Ability to auto-map command result via `rom.command(:rel_name).as(:mapper_name)` (solnic)
+
+### Changed
+
+* gemspec no longer specifies required_ruby_version so that rom can be installed on jruby (solnic)
+* Obsolete `Env#readers` was removed (splattael)
+
+[Compare v0.6.0...v0.6.1](https://github.com/rom-rb/rom/compare/v0.6.0...v0.6.1)
+
 ## v0.6.0 2015-03-22
 
 ### Added

data/Gemfile

@@ -9,6 +9,7 @@ end
 
 group :test do
   gem 'virtus'
+  gem 'anima'
   gem 'minitest'
   gem 'thread_safe'
   gem 'activesupport'

data/README.md

@@ -21,7 +21,7 @@ your datastore.
 Learn more:
 
 * [Introduction](http://rom-rb.org/introduction/)
-* [Rails tutorial](http://rom-rb.org/tutorials/rails/)
+* [Rails tutorial](http://rom-rb.org/tutorials/todo-app-with-rails/)
 
 ## Adapters
 

data/lib/rom/command_registry.rb

@@ -1,11 +1,33 @@
 require 'rom/commands/result'
 
 module ROM
-  # Command registry exposes "try" interface for executing commands
+  # Specialized registry class for commands
   #
   # @api public
-  class CommandRegistry < Registry
+  class CommandRegistry
     include Commands
+    include Options
+
+    # Internal command registry
+    #
+    # @return [Registry]
+    #
+    # @api private
+    attr_reader :registry
+
+    option :mappers, reader: true
+    option :mapper, reader: true
+
+    # @api private
+    def initialize(elements, options = {})
+      super
+      @registry =
+        if elements.is_a?(Registry)
+          elements
+        else
+          Registry.new(elements, self.class.name)
+        end
+    end
 
     # Try to execute a command in a block
     #
@@ -31,5 +53,71 @@ module ROM
     rescue CommandError => e
       Result::Failure.new(e)
     end
+
+    # Return a command from the registry
+    #
+    # If mapper is set command will be turned into a composite command with
+    # auto-mapping
+    #
+    # @example
+    #   create_user = rom.command(:users)[:create]
+    #   create_user[name: 'Jane']
+    #
+    #   # with mapping, assuming :entity mapper is registered for :users relation
+    #   create_user = rom.command(:users).as(:entity)[:create]
+    #   create_user[name: 'Jane'] # => result is send through :entity mapper
+    #
+    # @param [Symbol] name The name of a registered command
+    #
+    # @return [Command,Command::Composite]
+    #
+    # @api public
+    def [](name)
+      command = registry[name]
+      mapper = options[:mapper]
+
+      if mapper
+        command.curry >> mapper
+      else
+        command
+      end
+    end
+
+    # Specify a mapper that should be used for commands from this registry
+    #
+    # @example
+    #   entity_commands = rom.command(:users).as(:entity)
+    #
+    #
+    # @param [Symbol] mapper_name The name of a registered mapper
+    #
+    # @return [CommandRegistry]
+    #
+    # @api public
+    def as(mapper_name)
+      with(mapper: mappers[mapper_name])
+    end
+
+    # Return new instance of this registry with updated options
+    #
+    # @return [CommandRegistry]
+    #
+    # @api private
+    def with(new_options)
+      self.class.new(registry, options.merge(new_options))
+    end
+
+    private
+
+    # Allow retrieving commands using dot-notation
+    #
+    # @api private
+    def method_missing(name, *)
+      if registry.key?(name)
+        self[name]
+      else
+        super
+      end
+    end
   end
 end

data/lib/rom/commands/abstract.rb

@@ -57,6 +57,7 @@ module ROM
           tuples
         end
       end
+      alias_method :[], :call
 
       # Curry this command with provided args
       #

data/lib/rom/commands/composite.rb

@@ -29,8 +29,19 @@ module ROM
       #
       # @api public
       def call(*args)
-        right.call(left.call(*args))
+        response = left.call(*args)
+
+        if result == :one
+          if right.is_a?(Command) || right.is_a?(Commands::Composite)
+            right.call([response].first)
+          else
+            right.call([response]).first
+          end
+        else
+          right.call(response)
+        end
       end
+      alias_method :[], :call
 
       # Compose another composite command from self and other
       #
@@ -42,6 +53,34 @@ module ROM
       def >>(other)
         self.class.new(self, other)
       end
+
+      # @api private
+      def result
+        left.result
+      end
+
+      # @api private
+      def respond_to_missing?(name, include_private = false)
+        left.respond_to?(name) || super
+      end
+
+      private
+
+      # Allow calling methods on the left side object
+      #
+      # @api private
+      def method_missing(name, *args, &block)
+        if left.respond_to?(name)
+          response = left.__send__(name, *args, &block)
+          if response.is_a?(left.class)
+            self.class.new(response, right)
+          else
+            response
+          end
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/rom/env.rb

@@ -17,11 +17,6 @@ module ROM
     # @api public
     attr_reader :relations
 
-    # @return [ReaderRegistry] reader registry
-    #
-    # @api public
-    attr_reader :readers
-
     # @return [Registry] command registry
     #
     # @api public
@@ -33,12 +28,11 @@ module ROM
     attr_reader :mappers
 
     # @api private
-    def initialize(repositories, relations, mappers, commands, readers = nil)
+    def initialize(repositories, relations, mappers, commands)
       @repositories = repositories
       @relations = relations
       @mappers = mappers
       @commands = commands
-      @readers = readers
       freeze
     end
 
@@ -69,7 +63,7 @@ module ROM
           relations[name]
         end
 
-      if mappers.elements.key?(name)
+      if mappers.key?(name)
         relation.to_lazy(mappers: mappers[name])
       else
         relation.to_lazy
@@ -92,7 +86,7 @@ module ROM
     #
     # @api public
     def read(name, &block)
-      warn <<-MSG
+      warn <<-MSG.gsub(/^\s+/, '')
         #{self.class}#read is deprecated.
         Please use `#{self.class}#relation(#{name.inspect})` instead.
         For mapping append `.map_with(:your_mapper_name)`
@@ -105,11 +99,19 @@ module ROM
     #
     # @example
     #
+    #   # plain command returning tuples
     #   rom.command(:users).create
     #
+    #   # allow auto-mapping using registered mappers
+    #   rom.command(:users).as(:entity)
+    #
     # @api public
     def command(name)
-      commands[name]
+      if mappers.key?(name)
+        commands[name].with(mappers: mappers[name])
+      else
+        commands[name]
+      end
     end
   end
 end

data/lib/rom/support/options.rb

@@ -106,6 +106,10 @@ module ROM
         end
       end
 
+      def names
+        @options.keys
+      end
+
       private
 
       def each(&block)

data/lib/rom/support/registry.rb

@@ -12,9 +12,9 @@ module ROM
 
     attr_reader :elements, :name
 
-    def initialize(elements = {})
+    def initialize(elements = {}, name = self.class.name)
       @elements = elements
-      @name = self.class.name
+      @name = name
     end
 
     def each(&block)
@@ -22,6 +22,10 @@ module ROM
       elements.each { |element| yield(element) }
     end
 
+    def key?(name)
+      elements.key?(name)
+    end
+
     def [](key)
       elements.fetch(key) { raise ElementNotFoundError.new(key, name) }
     end

data/lib/rom/version.rb

@@ -1,3 +1,3 @@
 module ROM
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.6.1'.freeze
 end

data/rom.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split("\n").reject { |name| name.include?('benchmarks') }
   gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
   gem.license       = 'MIT'
-  gem.required_ruby_version = '~> 2.0'
 
   gem.add_runtime_dependency 'transproc', '~> 0.1', '>= 0.1.2'
   gem.add_runtime_dependency 'equalizer', '~> 0.0', '>= 0.0.9'

data/spec/integration/commands/create_spec.rb

@@ -35,9 +35,33 @@ describe 'Commands / Create' do
       result :one
 
       def execute(user, task)
-        super(task.merge(name: user[:name]))
+        super(task.merge(name: user.to_h[:name]))
       end
     end
+
+    Test::User = Class.new do
+      include Anima.new(:name, :email)
+    end
+
+    Test::Task = Class.new do
+      include Anima.new(:name, :title)
+    end
+
+    class Test::UserMapper < ROM::Mapper
+      relation :users
+      register_as :entity
+      model Test::User
+      attribute :name
+      attribute :email
+    end
+
+    class Test::TaskMapper < ROM::Mapper
+      relation :tasks
+      register_as :entity
+      model Test::Task
+      attribute :name
+      attribute :title
+    end
   end
 
   it 'inserts user on successful validation' do
@@ -94,4 +118,53 @@ describe 'Commands / Create' do
       }.to raise_error(ROM::InvalidOptionValueError)
     end
   end
+
+  describe 'sending result through a mapper' do
+    let(:attributes) do
+      { name: 'Jane', email: 'jane@doe.org' }
+    end
+
+    it 'uses registered mapper to process the result for :one result' do
+      command = rom.command(:users).as(:entity).create
+      result = command[attributes]
+
+      expect(result).to eql(Test::User.new(attributes))
+    end
+
+    it 'with two composed commands respects the :result option' do
+      mapper_input = nil
+
+      mapper = proc do |tuples|
+        mapper_input = tuples
+      end
+
+      left = rom.command(:users).as(:entity).create.with(
+        name: 'Jane', email: 'jane@doe.org'
+      )
+
+      right = rom.command(:tasks).as(:entity).create.with(
+        title: 'Jane task'
+      )
+
+      command = left >> right >> mapper
+
+      result = command.call
+
+      task = Test::Task.new(name: 'Jane', title: 'Jane task')
+
+      expect(mapper_input).to eql([task])
+      expect(result).to eql(task)
+    end
+
+    it 'uses registered mapper to process the result for :many results' do
+      setup.commands(:users) do
+        define(:create_many, type: :create)
+      end
+
+      command = rom.command(:users).as(:entity).create_many
+      result = command[attributes]
+
+      expect(result).to eql([Test::User.new(attributes)])
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ if RUBY_ENGINE == "rbx"
 end
 
 require 'rom'
+require 'anima'
 
 begin
   require 'byebug'

data/spec/unit/rom/commands_spec.rb

@@ -160,6 +160,23 @@ describe 'Commands' do
       expect(result).to eql(task_tuple)
       expect(logs).to include(task_tuple)
     end
+
+    it 'forwards methods to the left' do
+      user_input = { name: 'Jane' }
+      user_tuple = { user_id: 1, name: 'Jane' }
+
+      create_user = Class.new(ROM::Commands::Create) {
+        def execute(user_input)
+          relation.insert(user_input)
+        end
+      }.build(users)
+
+      command = create_user >> proc {}
+
+      expect(users).to receive(:insert).with(user_input).and_return(user_tuple)
+
+      command.with(user_input).call
+    end
   end
 
   describe 'access to exposed relations' do

data/spec/unit/rom/env_spec.rb

@@ -44,6 +44,15 @@ describe ROM::Env do
     end
   end
 
+  describe '#read' do
+    it 'returns loaded relation and display a deprecation warning' do
+      expect {
+        result = rom.read(:users) { |r| r.by_name('Jane') }.as(:name_list)
+        expect(result.call).to match_array([{ name: 'Jane' }])
+      }.to output(/^ROM::Env#read is deprecated/).to_stderr
+    end
+  end
+
   describe '#mappers' do
     it 'returns mappers for all relations' do
       expect(rom.mappers.users[:name_list]).to_not be(nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: transproc
@@ -248,9 +248,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="