rom-repository 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ddf58d5430fe24bfd9afa8622196cfab93cfa51
-  data.tar.gz: a6c276d87c6c791b32b7337ce40c0c7f0be968ba
+  metadata.gz: bac31b2dc1dafd64ec8a3852d1cb9e595c49ded5
+  data.tar.gz: 9110fc0e2f6d1b742ed89c4f7afb5c9b61ad0cdc
 SHA512:
-  metadata.gz: b13a6f310a5e5b6ec18889327580a37de2d3ed105a68a26ce890b7114d4180f7f76e8e025b398d659a75bfcba1cb1807673133478dc8bbae3c9b217296d0f890
-  data.tar.gz: cd06c75ae5edcbab75c366cdb045aeda5645fe8c0f7bc62639ec270d427f1918f282061293d74799ffcdb3c52df3ecc2d6778067df3075a698e1c89fa0ff686e
+  metadata.gz: 77b81f8ab9040eeaa5059dee76046f2330ebaddc75c1dad792e1b7e911d42bd4056d364d5b59194208c55d366d3d3e3358376292abfa2580f4e96a86b3ab1e83
+  data.tar.gz: c6b9d0809edd8b5b8742ff9de4a1761c287f502706416bf698453a1153cea2f122972d0dcbfdc6d06ead0acc55100b9a1f4d230fd13d24bb536e0969b301d4ac

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+log/*.log

data/.travis.yml

@@ -6,13 +6,11 @@ before_script:
   - psql -c 'create database rom_repository' -U postgres
 script: "bundle exec rake ci"
 rvm:
-  - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3.1
   - rbx-2
-  - jruby-9000
-  - jruby-head
+  - jruby-9.0.5.0
   - ruby-head
 env:
   global:
@@ -22,7 +20,9 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-2
+  include:
+    - rvm: jruby-head
+      before_install: gem install bundler --no-ri --no-rdoc
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v0.3.0 2016-07-27
+
+### Added
+
+* `Repository#command` for inferring commands automatically from relations (solnic)
+* `Repository.commands` macro which generates command methods (solnic)
+* `Repository[rel_name]` for setting up a repository with a root relation (solnic)
+* `Repository#aggregate` as a shortcut for composing relation graphs from root (solnic)
+* `Repository#changeset` API for building specialized objects for handling changes in relations (solnic)
+
+### Fixed
+
+* Auto-mapping includes default custom mapper for a given relation (AMHOL)
+* When custom mapper is set, default struct mapper won't be used (AMHOL)
+
+### Changed
+
+* `Relation#combine` supports passing name of configured associations for automatic relation composition (solnic)
+* `Repository` constructor simply expects a rom container, which makes it work with DI libs like `dry-auto_inject` (solnic)
+* Depends on `rom 2.0.0` now (solnic)
+* Replace anima with `ROM::Repository::StructAttributes` (flash-gordon)
+
+[Compare v0.2.0...v0.3.0](https://github.com/rom-rb/rom-repository/compare/v0.2.0...v0.3.0)
+
 # v0.2.0 2016-01-06
 
 ### Added

data/Gemfile

@@ -4,14 +4,30 @@ gemspec
 
 gem 'inflecto'
 
+group :development, :test do
+  gem 'rom-sql', '~> 0.8'
+end
+
+group :development do
+  gem 'dry-equalizer', '~> 0.2'
+  gem 'sqlite3', platforms: [:mri, :rbx]
+  gem 'jdbc-sqlite3', platforms: :jruby
+end
+
 group :test do
-  gem 'anima', '~> 0.2.0'
-  gem 'rom-sql', '~> 0.7.0'
   gem 'rspec'
   gem 'byebug', platforms: :mri
   gem 'pg', platforms: [:mri, :rbx]
-  gem 'pg_jruby', platforms: :jruby
-  gem "codeclimate-test-reporter", require: nil
+  gem 'jdbc-postgres', platforms: :jruby
+  gem 'codeclimate-test-reporter', require: nil
 end
 
-gem 'benchmark-ips'
+group :benchmarks do
+  gem 'hotch', platforms: :mri
+  gem 'benchmark-ips'
+  gem 'activerecord', '~> 4.2'
+end
+
+group :tools do
+  gem 'pry'
+end

data/README.md

@@ -4,125 +4,21 @@
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom-repository
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-repository
 
-# ROM::Repository
+# rom-repository
 
 [![Gem Version](https://badge.fury.io/rb/rom-repository.svg)][gem]
 [![Build Status](https://travis-ci.org/rom-rb/rom-repository.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-repository.png)][gemnasium]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-repository.svg)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/rom-rb/rom-repository/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/rom-rb/rom-repository/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-repository.svg?branch=master)][inchpages]
 
-Repository for [ROM](https://github.com/rom-rb/rom) with auto-mapping and relation
-extensions.
+Repository for [rom-rb](https://github.com/rom-rb/rom) with auto-mapping and commands.
 
-## Conventions & Definitions
+Resources:
 
-Repositories in ROM are simple objects that allow you to compose rich relation
-views specific to your application layer. Every repository can access multiple
-relations that you define and use them to build more complex views.
-
-Repository relations are enhanced with a couple of extra features on top of ROM
-relations:
-
-- Every relation has an auto-generated mapper which turns raw data into simple, immutable structs
-- `Relation#combine` can accept a simple hash defining what other relations should be joined
-- `Relation#combine_parents` automatically joins parents using eager-loading
-- `Relation#combine_children` automatically joins children using eager-loading
-- `Relation#wrap_parent` automatically joins a parent using inner join
-
-### Relation Views
-
-A relation view is a result of some query which returns results specific to your
-application. You can define them using a simple DSL where you specify a name, what
-attributes resulting tuples will have and of course the query itself:
-
-``` ruby
-class Users < ROM::Relation[:sql]
-  view(:by_id, [:id, :name]) do |id|
-    where(id: id).select(:id, :name)
-  end
-
-  view(:listing, [:id, :name, :email, :created_at]) do
-    select(:id, :name, :email, :created_at).order(:name)
-  end
-end
-```
-
-This way we can explicitly define all our relation view that our application will
-depend on. It encapsulates access to application-specific data structures and allows
-you to easily test individual views in isolation.
-
-Thanks to explicit definition of attributes mappers are derived automatically.
-
-### Auto-combine & Auto-wrap
-
-Repository relations support automatic `combine` and `wrap` by using a simple
-convention that every relation defines `for_combine(keys, other)` and `for_wrap(keys, other)`.
-
-You can override the default behavior for combine by defining `for_other_rel_name`
-in example, if you combine tasks with users you can define `Tasks#for_users` and
-this will be used instead of the generic `for_combine`.
-
-### Mapping & Structs
-
-Currently repositories map to `ROM::Struct` by default. In the near future this
-will be configurable.
-
-ROM structs are simple and don't expose an interface to mutate them; however, they
-are not being frozen (at least not yet, we could add a feature for freezing them).
-
-They are coercible to `Hash` so it should be possible to map them further in some
-special cases using ROM mappers.
-
-``` ruby
-class Users < ROM::Relation[:sql]
-  view(:by_id, [:id, :name]) do |id|
-    where(id: id).select(:id, :name)
-  end
-
-  view(:listing, [:id, :name, :email, :created_at]) do
-    select(:id, :name, :email, :created_at).order(:name)
-  end
-end
-
-class UserRepository < ROM::Repository::Base
-  relations :users, :tasks
-
-  def by_id(id)
-    users.by_id(id)
-  end
-
-  def with_tasks(id)
-    users.by_id(id).combine_children(many: tasks)
-  end
-end
-
-rom = ROM.finalize.env
-
-user_repo = UserRepository.new(rom)
-
-puts user_repo.by_id(1).to_a.inspect
-# [#<ROM::Struct[User] id=1 name="Jane">]
-
-puts user_repo.with_tasks.to_a.inspect
-# [#<ROM::Struct[User] id=1 name="Jane" tasks=[#<ROM::Struct[Task] id=2 user_id=1 title="Jane Task">]>, #<ROM::Struct[User] id=2 name="Joe" tasks=[#<ROM::Struct[Task] id=1 user_id=2 title="Joe Task">]>]
-```
-
-### Using Custom Model Types
-
-To use a custom model type you simply use the standard `Relation#as` inteface
-but you can pass a constant:
-
-``` ruby
-class UserRepository < ROM::Repository::Base
-  relations :users, :tasks
-
-  def by_id(id)
-    users.by_id(id).as(User)
-  end
-end
-```
+* [User documentation](http://rom-rb.org/learn/repositories)
+* [API documentation](http://rubydoc.info/gems/rom-repository)
 
 ## License
 

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

@@ -0,0 +1,26 @@
+module ROM
+  class Changeset
+    # Changeset specialization for create commands
+    #
+    # @api public
+    class Create < Changeset
+      # Return false
+      #
+      # @return [FalseClass]
+      #
+      # @api public
+      def update?
+        false
+      end
+
+      # Return true
+      #
+      # @return [TrueClass]
+      #
+      # @api public
+      def create?
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'transproc/registry'
+
+module ROM
+  class Changeset
+    class Pipe
+      extend Transproc::Registry
+
+      attr_reader :processor
+
+      def self.add_timestamps(data)
+        now = Time.now
+        data.merge(created_at: now, updated_at: now)
+      end
+
+      def self.touch(data)
+        data.merge(updated_at: Time.now)
+      end
+
+      def initialize(processor = nil)
+        @processor = processor
+      end
+
+      def >>(other)
+        if processor
+          self.class.new(processor >> other)
+        else
+          self.class.new(other)
+        end
+      end
+
+      def call(data)
+        if processor
+          processor.call(data)
+        else
+          data
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module ROM
+  class Changeset
+    # Changeset specialization for update commands
+    #
+    # @api public
+    class Update < Changeset
+      # @!attribute [r] primary_key
+      #   @return [Symbol] The name of the relation's primary key attribute
+      option :primary_key, reader: true
+
+      # Return true
+      #
+      # @return [TrueClass]
+      #
+      # @api public
+      def update?
+        true
+      end
+
+      # Return false
+      #
+      # @return [FalseClass]
+      #
+      # @api public
+      def create?
+        false
+      end
+
+      # Return original tuple that this changeset may update
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def original
+        @original ||= relation.fetch(primary_key)
+      end
+
+      # Return diff hash sent through the pipe
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def to_h
+        pipe.call(diff)
+      end
+      alias_method :to_hash, :to_h
+
+      # Return true if there's a diff between original and changeset data
+      #
+      # @return [TrueClass, FalseClass]
+      #
+      # @api public
+      def diff?
+        ! diff.empty?
+      end
+
+      # Return if there's no diff between the original and changeset data
+      #
+      # @return [TrueClass, FalseClass]
+      #
+      # @api public
+      def clean?
+        diff.empty?
+      end
+
+      # Calculate the diff between the original and changeset data
+      #
+      # @return [Hash[
+      #
+      # @api public
+      def diff
+        @diff ||=
+          begin
+            new_tuple = data.to_a
+            ori_tuple = original.to_a
+
+            Hash[new_tuple - (new_tuple & ori_tuple)]
+          end
+      end
+    end
+  end
+end

data/lib/rom/repository/changeset.rb

@@ -0,0 +1,99 @@
+require 'rom/support/constants'
+require 'rom/support/options'
+
+require 'rom/repository/changeset/pipe'
+
+module ROM
+  class Changeset
+    include Options
+
+    # @!attribute [r] pipe
+    #   @return [Changeset::Pipe] data transformation pipe
+    option :pipe, reader: true, accept: [Proc, Pipe], default: -> changeset {
+      changeset.class.default_pipe
+    }
+
+    # @!attribute [r] relation
+    #   @return [Relation] The changeset relation
+    attr_reader :relation
+
+    # @!attribute [r] data
+    #   @return [Hash] The relation data
+    attr_reader :data
+
+    # Build default pipe object
+    #
+    # This can be overridden in a custom changeset subclass
+    #
+    # @return [Pipe]
+    def self.default_pipe
+      Pipe.new
+    end
+
+    # @api private
+    def initialize(relation, data, options = EMPTY_HASH)
+      @relation = relation
+      @data = data
+      super
+    end
+
+    # Pipe changeset's data using custom steps define on the pipe
+    #
+    # @param *steps [Array<Symbol>] A list of mapping steps
+    #
+    # @return [Changeset]
+    #
+    # @api public
+    def map(*steps)
+      with(pipe: steps.reduce(pipe) { |a, e| a >> pipe.class[e] })
+    end
+
+    # Coerce changeset to a hash
+    #
+    # This will send the data through the pipe
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def to_h
+      pipe.call(data)
+    end
+    alias_method :to_hash, :to_h
+
+    # Return a new changeset with updated options
+    #
+    # @param [Hash] new_options The new options
+    #
+    # @return [Changeset]
+    #
+    # @api private
+    def with(new_options)
+      self.class.new(relation, data, options.merge(new_options))
+    end
+
+    private
+
+    # @api private
+    def respond_to_missing?(meth, include_private = false)
+      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 response.is_a?(Hash)
+          self.class.new(relation, response, options)
+        else
+          response
+        end
+      else
+        super
+      end
+    end
+  end
+end
+
+require 'rom/repository/changeset/create'
+require 'rom/repository/changeset/update'

data/lib/rom/repository/class_interface.rb

@@ -0,0 +1,142 @@
+module ROM
+  class Repository
+    # Class-level APIs for repositories
+    #
+    # @api public
+    module ClassInterface
+      # Create a root-repository class and set its root relation
+      #
+      # @example
+      #   # where :users is the relation name in your rom container
+      #   class UserRepo < ROM::Repository[:users]
+      #   end
+      #
+      # @param name [Symbol] The relation `register_as` value
+      #
+      # @return [Class] descendant of ROM::Repository::Root
+      #
+      # @api public
+      def [](name)
+        klass = Class.new(self < Repository::Root ? self : Repository::Root)
+        klass.relations(name)
+        klass.root(name)
+        klass
+      end
+
+      # Inherits configured relations and commands
+      #
+      # @api private
+      def inherited(klass)
+        super
+
+        return if self === Repository
+
+        klass.relations(*relations)
+        klass.commands(*commands)
+      end
+
+      # Define which relations your repository is going to use
+      #
+      # @example
+      #   class MyRepo < ROM::Repository::Base
+      #     relations :users, :tasks
+      #   end
+      #
+      #   my_repo = MyRepo.new(rom)
+      #
+      #   my_repo.users
+      #   my_repo.tasks
+      #
+      # @return [Array<Symbol>]
+      #
+      # @api public
+      def relations(*names)
+        if names.any?
+          attr_reader(*names)
+
+          if defined?(@relations)
+            @relations.concat(names).uniq!
+          else
+            @relations = names
+          end
+
+          @relations
+        else
+          @relations
+        end
+      end
+
+      # Defines command methods on a root repository
+      #
+      # @example
+      #   class UserRepo < ROM::Repository[:users]
+      #     commands :create, update: :by_pk, delete: :by_pk
+      #   end
+      #
+      #   # with custom command plugin
+      #   class UserRepo < ROM::Repository[:users]
+      #     commands :create, plugin: :my_command_plugin
+      #   end
+      #
+      #   # with custom mapper
+      #   class UserRepo < ROM::Repository[:users]
+      #     commands :create, mapper: :my_custom_mapper
+      #   end
+      #
+      # @param *names [Array<Symbol>] A list of command names
+      # @option :mapper [Symbol] An optional mapper identifier
+      # @option :use [Symbol] An optional command plugin identifier
+      #
+      # @return [Array<Symbol>] A list of defined command names
+      #
+      # @api public
+      def commands(*names, mapper: nil, use: nil, **opts)
+        if names.any? || opts.any?
+          @commands = names + opts.to_a
+
+          @commands.each do |spec|
+            type, *view = Array(spec).flatten
+
+            if view.size > 0
+              define_restricted_command_method(type, view, mapper: mapper, use: use)
+            else
+              define_command_method(type, mapper: mapper, use: use)
+            end
+          end
+        else
+          @commands || []
+        end
+      end
+
+      private
+
+      # @api private
+      def define_command_method(type, **opts)
+        define_method(type) do |*args|
+          command(type => self.class.root, **opts).call(*args)
+        end
+      end
+
+      # @api private
+      def define_restricted_command_method(type, views, **opts)
+        views.each do |view_name|
+          meth_name = views.size > 1 ? :"#{type}_#{view_name}" : type
+
+          define_method(meth_name) do |*args|
+            view_args, *input = args
+
+            changeset = input.first
+
+            if changeset.is_a?(Changeset) && changeset.clean?
+              map_tuple(changeset.relation, changeset.original)
+            else
+              command(type => self.class.root, **opts)
+                .public_send(view_name, *view_args)
+                .call(*input)
+            end
+          end
+        end
+      end
+    end
+  end
+end