mini_form 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d427b889425b8c2acd15827c88bc61430a70652
-  data.tar.gz: 582b6cf7164ab75b6f4df2f306eeb5580d9a0f3c
+  metadata.gz: 6d0c0c470b74ebc5e81006fa9f4f226de8d821d6
+  data.tar.gz: 38393dfb6c142a1f85dca47a2aa16072a63f657f
 SHA512:
-  metadata.gz: 9e0f762fd07558b4c30386d9cd2a9a51b8855efb0279bb70b7f842d0e3748d7a413a0f449a31eb1d448e8b93c649930b3b90dbbb9ece8a4151ae013dd0f4d096
-  data.tar.gz: d23461cd996d47cbbdfe7efd5219aed986a72e83c5693e6d1e413927fa947786c200bd1e6bb1cd227573af8f4b1a8c9be7d89926111b4fc3bbd8fbd5efeec448
+  metadata.gz: 1f8c4900a91ceedd1b9f7c12b73e5b2fc30f033fd47783ae792a4c9e8dbb3f0bae93c65953da6ddebf1bbc75e3bb8c4484e863e33925b67672f11246e4b094b6
+  data.tar.gz: 5a3a73ad3547ba949a1900918a1cdcfefc73c8bf77d0764d89fa0858c6fe8ae075a0493066f80b65d62429160e5a93d2734303d75fcc66d8b8746596d3455730

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## Version 0.2.0
+
+* Don't expose model name on `model`. _(security fix)_
+
+* Included `ActiveModel::Validations::Callbacks` to `MiniForm::Model`
+
+* Added read option to `model`:
+
+```ruby
+class EditProfile
+  include MiniForm::Model
+
+  model :user, attributes: %i(email name), read:%(id)
+end
+
+profile = EditProfile.new(user: user)
+profile.id
+profile.id = 1 # raises NoMethodError
+```
+
+
+* MiniForm::Model can be inherited
+* Added `assigment` callbacks, called when attributes are assigned
+* Added `assign_attributes` alias to `attributes=`
+* Exposed `errors` on MiniForm::InvalidForm
+* Added descriptive message MiniForm::InvalidForm
+* Made `.attribute_names` public
+
 ## Version 0.1.0
 
 * Initial release

data/README.md

@@ -46,7 +46,7 @@ class ProductsController < ApplicationController
     @product = ProductForm.new
 
     if @product.update(product_params)
-      redirect_to product_path(product.id)
+      redirect_to product_path(@product.id)
     else
       render :edit
     end
@@ -130,7 +130,7 @@ Combines delegated attributes and nested validation into a single call.
 class SignUpForm
   include MiniForm::Model
 
-  modal :user, attributes: %i(name email)
+  model :user, attributes: %i(name email)
   model :account, attributes: %i(company_name plan)
 
   def initialize
@@ -147,13 +147,13 @@ end
 
 ### Auto saving nested models
 
-In most of the time `perform` is just calling `save!`.
+Most of the time `perform` is just calling `save!`. We can avoid this by using `model`'s `save` option.
 
 ```ruby
 class SignUpForm
   include MiniForm::Model
 
-  modal :user, attributes: %i(name email), save: true
+  model :user, attributes: %i(name email), save: true
   model :account, attributes: %i(company_name plan), save: true
 
   def initialize
@@ -194,6 +194,27 @@ class SignUpForm
 end
 ```
 
+### Delegating model attributes
+
+```ruby
+class SignUpForm
+  include MiniForm::Model
+
+  model :user, attributes: %i(name email), read: %i(id)
+
+  def initialize
+    @user    = User.new account: @account
+  end
+end
+```
+
+```
+form = SignUpForm.new
+form.update! form_params
+form.id        # => delegates to `user.id`
+form.id = 42   # => raises `NoMethodError`
+```
+
 ### Methods
 
 <table>
@@ -209,6 +230,10 @@ end
     <td>.attributes</td>
     <td>Defines an attribute, it can delegate to sub object</td>
   </tr>
+  <tr>
+    <td>.attribute_names</td>
+    <td>Returns list of attribute names</td>
+  </tr>
   <tr>
     <td>#initialize</td>
     <td>Meant to be overwritten. By defaults calls `attributes=`</td>
@@ -241,6 +266,14 @@ end
     <td>#after_update</td>
     <td>Meant to be overwritten.</td>
   </tr>
+  <tr>
+    <td>#before_assigment</td>
+    <td>Meant to be overwritten.</td>
+  </tr>
+  <tr>
+    <td>#after_assigment</td>
+    <td>Meant to be overwritten.</td>
+  </tr>
   <tr>
     <td>#transaction</td>
     <td>If ActiveRecord is available, wraps `perform` in transaction.</td>

data/lib/mini_form/errors.rb

@@ -1,4 +1,11 @@
 module MiniForm
   class InvalidForm < StandardError
+    attr_reader :errors
+
+    def initialize(object)
+      @errors = object.errors
+
+      super "Form validation failed for: #{errors.keys.join(', ')}"
+    end
   end
 end

data/lib/mini_form/model.rb

@@ -3,9 +3,10 @@ require 'active_model'
 
 module MiniForm
   module Model
-    def self.included(base)
+    def self.included(base) # rubocop:disable MethodLength
       base.class_eval do
         include ActiveModel::Validations
+        include ActiveModel::Validations::Callbacks
         include ActiveModel::Conversion
 
         extend ActiveModel::Naming
@@ -14,9 +15,13 @@ module MiniForm
         extend ClassMethods
 
         define_model_callbacks :update
+        define_model_callbacks :assigment
 
         before_update :before_update
         after_update :after_update
+
+        before_assigment :before_assigment
+        after_assigment :after_assigment
       end
     end
 
@@ -29,11 +34,15 @@ module MiniForm
     end
 
     def attributes=(attributes)
-      attributes.slice(*self.class.attribute_names).each do |name, value|
-        public_send "#{name}=", value
+      run_callbacks :assigment do
+        attributes.slice(*self.class.attribute_names).each do |name, value|
+          public_send "#{name}=", value
+        end
       end
     end
 
+    alias_method :assign_attributes, :attributes=
+
     def attributes
       Hash[self.class.attribute_names.map { |name| [name, public_send(name)] }]
     end
@@ -54,7 +63,7 @@ module MiniForm
     end
 
     def update!(attributes = {})
-      fail InvalidForm unless update attributes
+      fail InvalidForm, self unless update attributes
       self
     end
 
@@ -85,8 +94,25 @@ module MiniForm
       # noop
     end
 
+    def before_assigment
+      # noop
+    end
+
+    def after_assigment
+      # noop
+    end
+
     module ClassMethods
-      # :api: private
+      def inherited(base)
+        new_attribute_names = attribute_names.dup
+        new_models_to_save  = models_to_save.dup
+
+        base.instance_eval do
+          @attribute_names = new_attribute_names
+          @models_to_save  = new_models_to_save
+        end
+      end
+
       def attribute_names
         @attribute_names ||= []
       end
@@ -102,15 +128,18 @@ module MiniForm
         if delegate.nil?
           attr_accessor(*attributes)
         else
-          self.delegate(*attributes, to: delegate, prefix: prefix, allow_nil: allow_nil)
-          self.delegate(*attributes.map { |attr| "#{attr}=" }, to: delegate, prefix: prefix, allow_nil: allow_nil)
+          delegate(*attributes, to: delegate, prefix: prefix, allow_nil: allow_nil)
+          delegate(*attributes.map { |attr| "#{attr}=" }, to: delegate, prefix: prefix, allow_nil: allow_nil)
         end
       end
 
-      def model(name, attributes: [], prefix: nil, allow_nil: nil, save: false)
-        attributes(name)
+      def model(name, attributes: [], read: [], prefix: nil, allow_nil: nil, save: false) # rubocop:disable ParameterLists
+        attr_accessor name
+
         attributes(*attributes, delegate: name, prefix: prefix, allow_nil: allow_nil) unless attributes.empty?
 
+        delegate(*read, to: name, prefix: prefix, allow_nil: nil)
+
         validates name, 'mini_form/nested' => true
 
         models_to_save << name if save

data/lib/mini_form/version.rb

@@ -1,3 +1,3 @@
 module MiniForm
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/mini_form_spec.rb

@@ -2,18 +2,19 @@ require 'spec_helper'
 
 module MiniForm
   describe Model do
-    let(:user) { User.new name: 'Name' }
+    let(:user) { User.new id: 1, name: 'name', age: 28 }
 
     class User
       include ActiveModel::Model
 
-      attr_accessor :name
+      attr_accessor :id, :name, :age
 
       validates :name, presence: true
     end
 
     Example = Class.new do
       include Model
+
       attributes :name, :price
     end
 
@@ -29,12 +30,6 @@ module MiniForm
       end
     end
 
-    ExampleWithModel = Class.new do
-      include Model
-
-      model :user, attributes: %i(name)
-    end
-
     describe 'acts as ActiveModel' do
       include ActiveModel::Lint::Tests
 
@@ -59,6 +54,23 @@ module MiniForm
       end
     end
 
+    describe 'inheritance' do
+      it 'can be inherited' do
+        parent_class = Class.new do
+          include Model
+
+          attributes :name
+        end
+
+        child_class = Class.new(parent_class) do
+          attributes :age
+        end
+
+        expect(parent_class.attribute_names).to eq %i(name)
+        expect(child_class.attribute_names).to eq %i(name age)
+      end
+    end
+
     describe '.attributes' do
       it 'generates getters' do
         object = Example.new name: 'value'
@@ -88,19 +100,36 @@ module MiniForm
     end
 
     describe '.model' do
+      ExampleWithModel = Class.new do
+        include Model
+
+        model :user, attributes: %i(name), read: %i(id)
+
+        def initialize(user)
+          self.user = user
+        end
+      end
+
       it 'generates model accessors' do
-        object = ExampleWithModel.new user: user
+        object = ExampleWithModel.new user
         expect(object.user).to eq user
       end
 
+      it 'can delegate only a reader' do
+        object = ExampleWithModel.new user
+
+        expect(object).not_to respond_to :id=
+        expect(object.id).to eq user.id
+      end
+
       it 'can delegate model attributes' do
-        object = ExampleWithModel.new user: user
+        object = ExampleWithModel.new user
         expect(object.name).to eq user.name
       end
 
       it 'performs nested validation for model' do
         user   = User.new
-        object = ExampleWithModel.new user: user
+        object = ExampleWithModel.new user
 
         expect(object).not_to be_valid
         expect(object.errors[:name]).to be_present
@@ -143,6 +172,24 @@ module MiniForm
       end
     end
 
+    ['attributes=', 'assign_attributes'].each do |method_name|
+      describe "##{method_name}" do
+        it 'sets attributes' do
+          object = Example.new
+          object.public_send method_name, name: 'iPhone', price: '$5'
+
+          expect(object.attributes).to eq name: 'iPhone', price: '$5'
+        end
+
+        it 'ignores not listed attributes' do
+          object = Example.new
+          object.public_send method_name, invalid: 'value'
+
+          expect(object.attributes).to eq name: nil, price: nil
+        end
+      end
+    end
+
     describe '#update' do
       ExampleForUpdate = Class.new do
         include Model
@@ -156,6 +203,10 @@ module MiniForm
         include Model
 
         model :user, attributes: %i(name), save: true
+
+        def initialize(user: user)
+          self.user = user
+        end
       end
 
       it 'updates attributes' do
@@ -197,6 +248,15 @@ module MiniForm
         object.update
       end
 
+      it 'supports assign callbacks' do
+        object = ExampleForUpdate.new
+
+        expect(object).to receive(:before_assigment)
+        expect(object).to receive(:after_assigment)
+
+        object.update name: 'value'
+      end
+
       it 'returns false when validations fail' do
         object = ExampleForUpdate.new name: nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel