rom-rails 0.3.0.beta1 → 0.3.0.rc1

data/lib/rom/rails/model/validator.rb

@@ -7,8 +7,8 @@ module ROM
     # @example
     #
     #
-    #   class UserParams
-    #     include ROM::Model::Params
+    #   class UserAttributes
+    #     include ROM::Model::Attributes
     #
     #     attribute :name
     #
@@ -19,53 +19,100 @@ module ROM
     #     include ROM::Model::Validator
     #   end
     #
-    #   params = UserParams.new(name: '')
-    #   UserValidator.call(params) # raises ValidationError
+    #   attrs = UserAttributes.new(name: '')
+    #   UserValidator.call(attrs) # raises ValidationError
     #
     # @api public
     module Validator
+      # Inclusion hook that extends a class with required interfaces
+      #
+      # @api private
       def self.included(base)
         base.class_eval do
           extend ClassMethods
           include ActiveModel::Validations
-          include Equalizer.new(:params, :errors)
+          include Equalizer.new(:attributes, :errors)
         end
       end
 
-      attr_reader :params
-      delegate :model_name, to: :params
+      # @return [Model::Attributes]
+      #
+      # @api private
+      attr_reader :attributes
 
-      def initialize(params)
-        @params = params
+      delegate :model_name, to: :attributes
+
+      # @api private
+      def initialize(attributes)
+        @attributes = attributes
       end
 
+      # @return [Model::Attributes]
+      #
+      # @api public
       def to_model
-        params
+        attributes
       end
 
+      # Trigger validations and return attributes on success
+      #
+      # @raises ValidationError
+      #
+      # @return [Model::Attributes]
+      #
+      # @api public
       def call
         raise ValidationError, errors unless valid?
-        params
+        attributes
       end
 
       private
 
+      # This is needed for ActiveModel::Validations to work properly
+      # as it expects the object to provide attribute values. Meh.
+      #
+      # @api private
       def method_missing(name)
-        params[name]
+        attributes[name]
       end
 
       module ClassMethods
+        # Set relation name for a validator
+        #
+        # This is needed for validators that require database access
+        #
+        # @example
+        #
+        #   class UserValidator
+        #     include ROM::Model::Validator
+        #
+        #     relation :users
+        #
+        #     validates :name, uniqueness: true
+        #   end
+        #
+        # @return [Symbol]
+        #
+        # @api public
         def relation(name = nil)
           @relation = name if name
           @relation
         end
 
+        # FIXME: this looks like not needed
         def model_name
-          params.model_name
+          attributes.model_name
         end
 
-        def call(params)
-          validator = new(params)
+        # Trigger validation for specific attributes
+        #
+        # @param [Model::Attributes] attributes The attributes for validation
+        #
+        # @raises [ValidationError]
+        #
+        # @return [Model::Attributes]
+        def call(attributes)
+          validator = new(attributes)
           validator.call
         end
       end

data/lib/rom/rails/model/validator/uniqueness_validator.rb

@@ -3,33 +3,69 @@ require 'active_model/validator'
 module ROM
   module Model
     module Validator
+      # Uniqueness validation
+      #
+      # @api public
       class UniquenessValidator < ActiveModel::EachValidator
-        attr_reader :klass, :message
+        # Relation validator class
+        #
+        # @api private
+        attr_reader :klass
 
+        # error message
+        #
+        # @return [String, Symbol]
+        #
+        # @api private
+        attr_reader :message
+
+        # @api private
         def initialize(options)
           super
           @klass = options.fetch(:class)
           @message = options.fetch(:message) { :taken }
         end
 
+        # Hook called by ActiveModel internally
+        #
+        # @api private
         def validate_each(validator, name, value)
           validator.errors.add(name, message) unless unique?(name, value)
         end
 
         private
 
+        # Get relation object from the rom env
+        #
+        # @api private
         def relation
           rom.relations[relation_name]
         end
 
+        # Relation name defined on the validator class
+        #
+        # @api private
         def relation_name
           klass.relation
         end
 
+        # Shortcut to access global rom env
+        #
+        # @return [ROM::Env]
+        #
+        # @api private
         def rom
           ROM.env
         end
 
+        # Ask relation if a given attribute value is unique
+        #
+        # This uses `Relation#unique?` interface that not all adapters can
+        # implement.
+        #
+        # @return [TrueClass,FalseClass]
+        #
+        # @api private
         def unique?(name, value)
           relation.unique?(name => value)
         end

data/lib/rom/rails/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Rails
-    VERSION = "0.3.0.beta1".freeze
+    VERSION = "0.3.0.rc1".freeze
   end
 end

data/rom-rails.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rom', '~> 0.6.0.beta1'
+  spec.add_runtime_dependency 'rom', '~> 0.6.0.rc1'
   spec.add_runtime_dependency 'addressable', '~> 2.3'
   spec.add_runtime_dependency 'charlatan', '~> 0.1'
-  spec.add_runtime_dependency 'virtus', '~> 1.0', '>= 1.0.4'
+  spec.add_runtime_dependency 'virtus', '~> 1.0', '>= 1.0.5'
   spec.add_runtime_dependency 'railties', ['>= 3.0', '< 5.0']
 
   spec.add_development_dependency "bundler"

data/spec/dummy/app/controllers/users_controller.rb

@@ -3,11 +3,14 @@ class UsersController < ApplicationController
     head :bad_request
   end
 
-  relation 'users.index', only: :index
-  relation 'users.by_name', only: :search, requires: :name
-
   def index
-    render
+    render :index, locals: { users: rom.relation(:users).as(:users) }
+  end
+
+  def search
+    render :index, locals: {
+      users: rom.relation(:users).as(:users).by_name(params[:name])
+    }
   end
 
   def new
@@ -40,10 +43,6 @@ class UsersController < ApplicationController
     end
   end
 
-  def search
-    render :index
-  end
-
   def ping
     head :ok
   end

data/spec/dummy/app/forms/new_user_form.rb

@@ -1,9 +1,9 @@
 class NewUserForm < UserForm
   commands users: :create
 
-  params.timestamps(:created_at)
+  attributes.timestamps(:created_at)
 
   def commit!
-    users.try { users.create.call(params) }
+    users.try { users.create.call(attributes) }
   end
 end

data/spec/dummy/app/forms/update_user_form.rb

@@ -1,9 +1,9 @@
 class UpdateUserForm < UserForm
   commands users: :update
 
-  params.timestamps(:updated_at)
+  attributes.timestamps(:updated_at)
 
   def commit!
-    users.try { users.update.by_id(id).set(params) }
+    users.try { users.update.by_id(id).set(attributes) }
   end
 end

data/spec/dummy/spec/integration/{user_params_spec.rb → user_attributes_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe ROM::Model::Params do
-  let(:params) do
+describe ROM::Model::Attributes do
+  let(:attributes) do
     Class.new do
-      include ROM::Model::Params
+      include ROM::Model::Attributes
 
       attribute :name, String
 
@@ -13,32 +13,32 @@ describe ROM::Model::Params do
 
   describe '.timestamps' do
     it 'provides a way to specify timestamps with default values' do
-      expect(params.new.created_at).to be_a(DateTime)
-      expect(params.new.updated_at).to be_a(DateTime)
+      expect(attributes.new.created_at).to be_a(DateTime)
+      expect(attributes.new.updated_at).to be_a(DateTime)
     end
 
     context 'passing in arbritrary names' do
       it 'excludes :created_at when passing in :updated_at' do
-        params = Class.new {
-          include ROM::Model::Params
+        attributes = Class.new {
+          include ROM::Model::Attributes
 
           timestamps(:updated_at)
         }
 
-        model = params.new
+        model = attributes.new
 
         expect(model).not_to respond_to(:created_at)
         expect(model).to respond_to(:updated_at)
       end
 
       it 'accepts multiple timestamp attribute names' do
-        params = Class.new {
-          include ROM::Model::Params
+        attributes = Class.new {
+          include ROM::Model::Attributes
 
           timestamps(:published_at, :revised_at)
         }
 
-        model = params.new
+        model = attributes.new
 
         expect(model).to respond_to(:published_at)
         expect(model).to respond_to(:revised_at)

data/spec/dummy/spec/integration/user_model_mapping_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'User model mapping' do
   let(:rom) { ROM.env }
 
-  let(:users) { rom.read(:users) }
+  let(:users) { rom.relation(:users).as(:users) }
 
   before do
     rom.relations.users.insert(name: 'Piotr', email: 'piotr@test.com')

data/spec/lib/generators/form_generator_spec.rb

@@ -37,7 +37,7 @@ describe ROM::Generators::FormGenerator do
                 end
 
                 def commit!
-                  users.try { users.create.call(params) }
+                  users.try { users.create.call(attributes) }
                 end
 
               end
@@ -76,7 +76,7 @@ describe ROM::Generators::FormGenerator do
                 end
 
                 def commit!
-                  users.try { users.update.by_id(id).set(params) }
+                  users.try { users.update.by_id(id).set(attributes) }
                 end
 
               end

data/spec/lib/generators/mapper_generator_spec.rb

@@ -17,8 +17,8 @@ describe ROM::Generators::MapperGenerator do
           file 'user_mapper.rb' do
             contains <<-CONTENT.strip_heredoc
               class UserMapper < ROM::Mapper
-                # relation :users
-                #
+                relation :users
+              
                 # specify model and attributes ie
                 #
                 # model User

data/spec/unit/form_spec.rb

@@ -25,17 +25,21 @@ describe 'Form' do
 
   describe '.build' do
     it 'rejects blank strings from params' do
-      input = {
-        'name'  => 'Jane',
-        'hash'  => { 'one' => '', 'two' => 2 },
-        'array' => [{ 'three' => '', 'four' => 4 }, 5]
-      }
+      input = { 'name'  => '' }
 
       form_object = form.build(input)
 
-      expect(form_object.params).to eql(
-        name: 'Jane', hash: { two: 2 }, array: [{ four: 4 }, 5]
-      )
+      expect(form_object.attributes.to_h).to eql(email: nil)
+    end
+
+    it 'exposes param values' do
+      params = { 'email' => 'jane@doe.org' }
+      form_object = form.build(params)
+      expect(form_object.email).to eql('jane@doe.org')
+
+      params = { email: 'jane@doe.org' }
+      form_object = form.build(params)
+      expect(form_object.email).to eql('jane@doe.org')
     end
   end
 
@@ -48,7 +52,7 @@ describe 'Form' do
         validations { validates :name, presence: true }
 
         def commit!
-          users.try { users.create.call(params) }
+          users.try { users.create.call(attributes) }
         end
       }
 
@@ -94,16 +98,16 @@ describe 'Form' do
   end
 
   describe '.model_name' do
-    it 'delegates to Params.model_name' do
-      expect(form.model_name).to be(form.params.model_name)
+    it 'delegates to Attributes.model_name' do
+      expect(form.model_name).to be(form.attributes.model_name)
     end
   end
 
   describe 'input DSL' do
     it 'defines params handler' do
-      expect(form.const_defined?(:Params)).to be(true)
-      expect(form.params.attribute_set.map(&:name)).to eql([:email])
-      expect(form.params.model_name).to eql('User')
+      expect(form.const_defined?(:Attributes)).to be(true)
+      expect(form.attributes.attribute_set.map(&:name)).to eql([:email])
+      expect(form.attributes.model_name).to eql('User')
     end
 
     it 'defines a model' do
@@ -278,8 +282,8 @@ describe 'Form' do
     end
 
     it 'copies input' do
-      expect(child_form.params.attribute_set[:email]).to_not be(nil)
-      expect(child_form.params).to_not be(form.params)
+      expect(child_form.attributes.attribute_set[:email]).to_not be(nil)
+      expect(child_form.attributes).to_not be(form.attributes)
     end
 
     it 'copies model' do

data/spec/unit/validator_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe 'Validation' do
-  subject(:validator) { user_validator.new(params) }
+  subject(:validator) { user_validator.new(attributes) }
 
-  let(:user_params) do
+  let(:user_attrs) do
     Class.new {
-      include ROM::Model::Params
+      include ROM::Model::Attributes
 
       attribute :name, String
       attribute :email, String
@@ -28,24 +28,24 @@ describe 'Validation' do
   end
 
   describe '#call' do
-    let(:params) { {} }
+    let(:attributes) { {} }
 
-    it 'raises validation error when params are not valid' do
+    it 'raises validation error when attributes are not valid' do
       expect { validator.call }.to raise_error(ROM::Model::ValidationError)
     end
   end
 
   describe "#validate" do
-    let(:params) { {} }
+    let(:attributes) { {} }
 
-    it "sets errors when params are not valid" do
+    it "sets errors when attributes are not valid" do
       validator.validate
       expect(validator.errors[:name]).to eql(["can't be blank"])
     end
   end
 
   describe ':presence' do
-    let(:params) { user_params.new(name: '') }
+    let(:attributes) { user_attrs.new(name: '') }
 
     it 'sets error messages' do
       expect(validator).to_not be_valid
@@ -54,7 +54,7 @@ describe 'Validation' do
   end
 
   describe ':uniqueness' do
-    let(:params) { user_params.new(name: 'Jane', email: 'jane@doe.org') }
+    let(:attributes) { user_attrs.new(name: 'Jane', email: 'jane@doe.org') }
 
     before do
       rom.relations.users.insert(name: 'Jane', email: 'jane@doe.org')