activeform-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e402d99e242dc5307a6bb925ec3d258ad6387b1
-  data.tar.gz: bb2dd6443819e4363f684c26f8446266af5a655e
+  metadata.gz: 7f7688613c8527572ecc8edd552c918e6a45173a
+  data.tar.gz: 665ea65f9060f5b89b57dfdc65db238ea5c0cf08
 SHA512:
-  metadata.gz: 28d4f5d2a1ea1431b1ea54202c6cb517d75b385291031809e43437ddf3ba783b46d66c5b022f5c74fe8d70281006f70bf4559e2858a97d07480b1d4ef0e785b3
-  data.tar.gz: 13e22403ac71929269072c6914105bfbd29cb0173ee553bda95760c27d60269f47ef040ead1b855f531d0846eed897c6367e705514869f02a5ea8d75d961e7f2
+  metadata.gz: 190cf9b820a0ba65639caf4d71af7881ed907a51283c102f55899f94e0d27061979e9ea82c6f3c9b405a2ed121a77335c0bdd312f19b3a769f3bf5c48e60ce19
+  data.tar.gz: 02d4beba8aba2475ee300fb8c2547a428dddcb1fbc6d48010abd87418b3d231ac2a76558ae3663f31764b34a9ea25409dc4d213305b54ccb818f813fe1743c47

data/lib/activeform-rails.rb

@@ -1,6 +1,9 @@
 module ActiveForm
+  class CannotBePersisted < Exception; end
 end
 
+require 'active_support/core_ext/module/delegation'
 require 'active_record'
 require 'activeform-rails/form'
+require 'activeform-rails/mock_model'
 require 'activeform-rails/validate_uniqueness'

data/lib/activeform-rails/form.rb

@@ -8,15 +8,16 @@ module ActiveForm::Form
     base.extend ClassMethods
   end
 
-
   module ClassMethods
     delegate :model_name, :reflect_on_association, to: :main_class
     attr_accessor :main_class, :reflected_class, :main_model
 
-    def properties(*attributes, prefix: false, on:)
-      assign_delegators(attributes, on, prefix)
-      add_model_on_list(on)
-      add_accessor(on)
+    def properties(*attributes, prefix: false, on: nil)
+      if on.nil?
+        attr_accessor *attributes
+      else
+        delegate_to_model(attributes, on, prefix)
+      end
     end
 
     def i18n_scope
@@ -27,8 +28,21 @@ module ActiveForm::Form
       @models ||= []
     end
 
+    def main_model
+      @main_model ||= UnpersistentModel.new(self)
+    end
+
     def main_class
-      @main_class ||= @main_model.to_s.camelize.constantize
+      @main_class ||= if main_model.kind_of?(Symbol)
+        main_model.to_s.camelize.constantize
+      else
+        @main_model
+      end
+    end
+
+    def alias_property(new_method, old_method)
+      alias_method new_method.to_sym, old_method.to_sym
+      alias_method "#{new_method}=".to_sym, "#{old_method}=".to_sym
     end
 
     private
@@ -47,11 +61,17 @@ module ActiveForm::Form
         delegate "#{attribute}=", to: model_name, prefix: prefix
       end
     end
+
+    def delegate_to_model(attributes, on, prefix)
+      assign_delegators(attributes, on, prefix)
+      add_model_on_list(on)
+      add_accessor(on)
+    end
   end
 
   delegate :to_key, :to_param, :id, :persisted?, to: :main_model
 
-  def initialize(attributes)
+  def initialize(attributes = {})
     assign_from_hash(attributes)
   end
 
@@ -60,23 +80,40 @@ module ActiveForm::Form
   end
 
   def save(&block)
+    ensure_persistable
     valid?.tap do
       call_action_or_block(:save, &block)
     end
   end
 
   def save!(&block)
+    ensure_persistable
     ActiveRecord::Base.transaction do
       call_action_or_block(:save!, &block)
     end
   end
 
   def main_model
-    send(self.class.main_model)
+    if self.class.main_model.kind_of?(Symbol)
+      send(self.class.main_model)
+    else
+      self.class.main_model
+    end
+  end
+
+  def new_record?
+    !persisted?
   end
 
   private
 
+  def ensure_persistable
+    message = 'The Form object is not backed by models so cannot be saved'
+    if self.class.models.empty?
+      raise ActiveForm::CannotBePersisted.new(message)
+    end
+  end
+
   def each_models
     self.class.models.each do |model_name|
       yield(send(model_name))

data/lib/activeform-rails/unpersistent_model.rb

@@ -0,0 +1,24 @@
+# UnpersistentModel allows the ActiveForm::Form object to delegate methods to
+# this object with expected results
+#
+# - #model_name is used by Form helpers & Rails frequently to define the form namespace
+# - #to_key, #to_param, #id should aways return nil as the Form cannot be persisted unless backed by ActiveModel
+# - #persisted? should aways return false as the Form cannot be persisted unless backed by ActiveModel
+#
+module ActiveForm::Form
+  class UnpersistentModel
+    attr_reader :to_key, :to_param, :id
+
+    def initialize(base_klass)
+      @base_class = base_klass
+    end
+
+    def model_name
+      ActiveModel::Name.new(@base_class)
+    end
+
+    def persisted?
+      false
+    end
+  end
+end

data/lib/activeform-rails/validate_uniqueness.rb

@@ -7,9 +7,9 @@ module ActiveForm
     end
 
     module ClassMethods
-      def validates_uniqueness_of(attribute, model_name)
+      def validates_uniqueness_of(attribute, model_name, options = {})
         @attribute = attribute
-        validates_each attribute do |form, attr, value|
+        validates_each attribute, options do |form, attr, value|
           @form = form
           @model = form.send(model_name)
           @klass = @model.class

data/lib/activeform-rails/version.rb

@@ -1,3 +1,3 @@
 module Activeform
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/activeform-rails/form_spec.rb

@@ -1,66 +1,106 @@
 require 'spec_helper'
 
 describe ActiveForm do
-  class Form
-    include ActiveForm::Form
-    properties :name, on: :user
-    properties :title, on: :category
+  context 'backed by models' do
+    class Form
+      include ActiveForm::Form
+      properties :name, on: :user
+      properties :title, on: :category
 
-    attr_accessor :user, :category
+      attr_accessor :user, :category
 
-    self.main_model = :user
-  end
-
-  describe ".main_class" do
-    it "reflect assoctions of the main model" do
-      user = User.new
-      category = Category.new
-      user.categories = [category]
-      expect(Form.reflect_on_association(:has_many)).to eq \
-        User.reflect_on_association(:has_many)
+      self.main_model = :user
     end
 
-    context "when a main class is specified" do
-      it "take the specified class" do
-        Form.main_class = Category
-        expect(Form.main_class).to eq Category
+    describe ".main_class" do
+      it "reflect assoctions of the main model" do
+        user = User.new
+        category = Category.new
+        user.categories = [category]
+        expect(Form.reflect_on_association(:has_many)).to eq \
+          User.reflect_on_association(:has_many)
+      end
+
+      context "when a main class is specified" do
+        it "take the specified class" do
+          Form.main_class = Category
+          expect(Form.main_class).to eq Category
+        end
+      end
+
+      context "when there is only a main model specified" do
+        it "build the main class from the main model" do
+          Form.main_model = :category
+          expect(Form.main_class).to eq Category
+        end
       end
     end
 
-    context "when there is only a main model specified" do
-      it "build the main class from the main model" do
-        Form.main_model = :category
-        expect(Form.main_class).to eq Category
+    describe "#fill_attributes" do
+      it "assign variable to models" do
+        user = User.new
+        category = Category.new
+        form = Form.new(user: user, category: category)
+        form.fill_attributes(name: "Martin")
+        expect(user.name).to eq "Martin"
       end
     end
-  end
 
-  describe "#fill_attributes" do
-    it "assign variable to models" do
-      user = User.new
-      category = Category.new
-      form = Form.new(user: user, category: category)
-      form.fill_attributes(name: "Martin")
-      expect(user.name).to eq "Martin"
+    describe "#save" do
+      context "when the form is valid" do
+        context "when no block is given" do
+          it "save all models" do
+            user = User.new
+            category = Category.new
+            form = Form.new(user: user, category: category)
+            expect(user).to receive(:save)
+            expect(category).to receive(:save)
+            form.save
+          end
+
+          it "return true" do
+            form = Form.new(user: User.new, category: Category.new)
+            allow(form).to receive(:valid?).and_return(true)
+            expect(form.save).to eq true
+          end
+        end
+
+        context "when a block is given" do
+          it "use the block" do
+            user = User.new
+            form = Form.new(user: user, category: Category.new)
+            allow(form).to receive(:valid?).and_return(true)
+            expect(user).to receive(:process)
+            form.save { |f| f.user.process }
+          end
+        end
+      end
+
+      context "when the form is invalid" do
+        it "return false" do
+          form = Form.new(user: User.new, category: Category.new)
+          allow(form).to receive(:valid?).and_return(false)
+          expect(form.save).to eq false
+        end
+      end
     end
-  end
 
-  describe "#save" do
-    context "when the form is valid" do
+    describe "#save!" do
       context "when no block is given" do
         it "save all models" do
           user = User.new
           category = Category.new
           form = Form.new(user: user, category: category)
-          expect(user).to receive(:save)
-          expect(category).to receive(:save)
-          form.save
+          expect(user).to receive(:save!)
+          expect(category).to receive(:save!)
+          form.save!
         end
 
-        it "return true" do
+        it "is surrounded by a transaction" do
+          expect(ActiveRecord::Base).to receive(:transaction).at_least(:once).
+            and_yield
           form = Form.new(user: User.new, category: Category.new)
-          allow(form).to receive(:valid?).and_return(true)
-          expect(form.save).to eq true
+          form.save!
         end
       end
 
@@ -68,57 +108,119 @@ describe ActiveForm do
         it "use the block" do
           user = User.new
           form = Form.new(user: user, category: Category.new)
-          allow(form).to receive(:valid?).and_return(true)
           expect(user).to receive(:process)
-          form.save { |f| f.user.process }
+          form.save! { |f| f.user.process }
         end
       end
     end
 
-    context "when the form is invalid" do
-      it "return false" do
-        form = Form.new(user: User.new, category: Category.new)
-        allow(form).to receive(:valid?).and_return(false)
-        expect(form.save).to eq false
+    describe "#main_model" do
+      it "give the main model" do
+        Form.main_model = :category
+        category = Category.new
+        form = Form.new(user: User.new, category: category)
+        expect(form.main_model).to eq category
       end
     end
-  end
 
-  describe "#save!" do
-    context "when no block is given" do
-      it "save all models" do
-        user = User.new
-        category = Category.new
-        form = Form.new(user: user, category: category)
-        expect(user).to receive(:save!)
-        expect(category).to receive(:save!)
+    describe "#persisted?" do
+      it "should be false when not saved" do
+        form = Form.new(user: User.new, category: Category.new)
+        expect(form.persisted?).to eq false
+      end
+
+      it "should be true when not saved" do
+        form = Form.new(user: User.new, category: Category.new)
         form.save!
+        expect(form.persisted?).to eq true
+      end
+    end
+
+    describe "#new_record?" do
+      it "should be true when not saved" do
+        form = Form.new(user: User.new, category: Category.new)
+        expect(form.new_record?).to eq true
       end
 
-      it "is surrounded by a transaction" do
-        expect(ActiveRecord::Base).to receive(:transaction).at_least(:once).
-          and_yield
+      it "should be false when not saved" do
         form = Form.new(user: User.new, category: Category.new)
         form.save!
+        expect(form.new_record?).to eq false
       end
     end
 
-    context "when a block is given" do
-      it "use the block" do
-        user = User.new
-        form = Form.new(user: user, category: Category.new)
-        expect(user).to receive(:process)
-        form.save! { |f| f.user.process }
+    describe "class method #alias_method" do
+      class AliasForm
+        include ActiveForm::Form
+        properties :name, on: :user
+        alias_property :full_name, :name
+        self.main_model = :user
+      end
+
+      subject do
+        user = User.new(name: 'John')
+        AliasForm.new(user: user)
+      end
+
+      it "should allow alias name to be used for read operations" do
+        expect(subject.full_name).to eq 'John'
+      end
+
+      it "should allow alias name to be used for write operations" do
+        subject.full_name = 'Mike'
+        expect(subject.full_name).to eq 'Mike'
       end
     end
   end
 
-  describe "#main_model" do
-    it "give the main model" do
-      Form.main_model = :category
-      category = Category.new
-      form = Form.new(user: User.new, category: category)
-      expect(form.main_model).to eq category
+  context 'without any underlying models' do
+    class FormNoModels
+      include ActiveForm::Form
+      properties :name, :title
+    end
+
+    it 'it should allow initialization without any arg' do
+      form = FormNoModels.new
+      expect(form.name).to eq nil
+      expect(form.title).to eq nil
+    end
+
+    it 'it should args to be set on initialize' do
+      form = FormNoModels.new(name: 'John', title: 'CEO')
+      expect(form.name).to eq 'John'
+      expect(form.title).to eq 'CEO'
+    end
+
+    it 'should raise an exception on save' do
+      expect do
+        FormNoModels.new.save
+      end.to raise_exception(ActiveForm::CannotBePersisted)
+    end
+
+    it 'should raise an exception on save!' do
+      expect do
+        FormNoModels.new.save!
+      end.to raise_exception(ActiveForm::CannotBePersisted)
+    end
+
+    it 'should delegate class method #model_name' do
+      expect(FormNoModels.model_name.to_s).to eq 'FormNoModels'
+    end
+
+    it 'should delegate #to_key' do
+      expect(FormNoModels.new.to_key).to eq nil
+    end
+
+    it 'should delegate #to_param' do
+      expect(FormNoModels.new.to_param).to eq nil
+    end
+
+    it 'should delegate #id' do
+      expect(FormNoModels.new.id).to eq nil
+    end
+
+    it 'should always return false to #persisted?' do
+      expect(FormNoModels.new.persisted?).to be_false
     end
   end
 end

data/spec/activeform-rails/validate_uniqueness_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 describe ActiveForm::ValidateUniqueness do
-  class Form
+  class ValidateUniquenessForm
     include ActiveForm::Form
     include ActiveForm::ValidateUniqueness
     properties :name, on: :user
-    validates_uniqueness_of :name, :user
+    validates_uniqueness_of :name, :user, allow_nil: true
   end
 
   context "when there is no user" do
     it "is valid" do
       user = User.new
-      form = Form.new(user: user)
+      form = ValidateUniquenessForm.new(user: user)
       expect(form).to be_valid
     end
   end
@@ -20,7 +20,7 @@ describe ActiveForm::ValidateUniqueness do
     context "when the user is saved" do
       it "is valid" do
         user = User.create(name: 'name')
-        form = Form.new(user: user)
+        form = ValidateUniquenessForm.new(user: user)
         expect(form).to be_valid
       end
     end
@@ -29,7 +29,7 @@ describe ActiveForm::ValidateUniqueness do
       it "is not valid" do
         User.create(name: 'name')
         user = User.new(name: 'name')
-        form = Form.new(user: user)
+        form = ValidateUniquenessForm.new(user: user)
         expect(form).to_not be_valid
       end
     end

data/spec/activeform-rails/validation_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'ActiveForm ActiveRecord validators' do
+  context 'backed by models' do
+    class ValidationForm
+      include ActiveForm::Form
+      properties :name, on: :user
+      validates_presence_of :name
+    end
+
+    context "when name is empty" do
+      it "is not valid" do
+        user = User.new
+        form = ValidationForm.new(user: user)
+        expect(form).to_not be_valid
+      end
+    end
+
+    context "when name is filled in" do
+      it "is valid" do
+        user = User.new
+        user.name = 'John'
+        form = ValidationForm.new(user: user)
+        expect(form).to be_valid
+      end
+    end
+  end
+
+  context 'without any underlying models' do
+    class ValidationFormNoModels
+      include ActiveForm::Form
+      properties :name
+      validates_presence_of :name
+    end
+
+    context "when name is empty" do
+      it "is not valid" do
+        form = ValidationFormNoModels.new
+        expect(form).to_not be_valid
+      end
+    end
+
+    context "when name is filled in" do
+      it "is valid" do
+        form = ValidationFormNoModels.new(name: 'John')
+        expect(form).to be_valid
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,9 +4,14 @@ require 'database_cleaner'
 
 ActiveRecord::Base.establish_connection(
   :adapter => "sqlite3",
-  :database => "#{Dir.pwd}/database.sqlite3"
+  :database => ':memory:'
 )
 
+['CREATE TABLE categories(id INTEGER PRIMARY KEY, title, user_id)',
+ 'CREATE TABLE users(id INTEGER PRIMARY KEY, name)'].each do |sql|
+  ActiveRecord::Base.connection.execute sql
+end
+
 class User < ActiveRecord::Base
   has_many :categories
 end
@@ -30,3 +35,6 @@ RSpec.configure do |config|
   end
 end
 
+# hide deprecation warnings, see http://stackoverflow.com/questions/20361428/rails-i18n-validation-deprecation-warning
+I18n.config.enforce_available_locales = true
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeform-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Guirec Corbel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-23 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Enable to use the concept of form objects with ActiveModel
 email:
 - guirec.corbel@gmail.com
@@ -63,11 +105,13 @@ files:
 - Rakefile
 - lib/activeform-rails.rb
 - lib/activeform-rails/form.rb
+- lib/activeform-rails/unpersistent_model.rb
 - lib/activeform-rails/validate_uniqueness.rb
 - lib/activeform-rails/version.rb
 - lib/tasks/activeform_tasks.rake
 - spec/activeform-rails/form_spec.rb
 - spec/activeform-rails/validate_uniqueness_spec.rb
+- spec/activeform-rails/validation_spec.rb
 - spec/dummy/Gemfile
 - spec/dummy/Gemfile.lock
 - spec/dummy/README.rdoc
@@ -157,6 +201,7 @@ specification_version: 4
 summary: Form Objects for ActiveModel
 test_files:
 - spec/activeform-rails/validate_uniqueness_spec.rb
+- spec/activeform-rails/validation_spec.rb
 - spec/activeform-rails/form_spec.rb
 - spec/spec_helper.rb
 - spec/dummy/config.ru