trans_forms 0.1.0

data/spec/support/trans_forms/user_creator_1.rb

@@ -0,0 +1,13 @@
+class UserCreator1 < TransForms::FormBase
+  attr_reader :user
+
+  attribute :name,      String
+  attribute :age,       Numeric
+
+  validates :name, presence: true
+
+  transaction do
+    @user = User.create!(name: name, age: age)
+  end
+
+end

data/spec/trans_forms/callbacks_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module TransForms
+  describe Callbacks do
+
+    describe 'after_save_on_error' do
+      it 'registers a method to be called when a transaction is rolled back' do
+        attr = { name1: 'John', name2: 'John' }
+        form = CallbackForm.new(attr)
+
+        expect(form).to be_valid
+        expect(form.save).to be false
+        expect(form.i_was_called).to be true
+      end
+
+      it 'will not call registered method if form model was invalid' do
+        attr = { name1: '', name2: '' }
+        form = CallbackForm.new(attr)
+
+        expect(form).not_to be_valid
+        expect(form.save).to be false
+        expect(form.i_was_called).not_to be true
+      end
+    end
+  end
+
+end

data/spec/trans_forms/form_base_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+module TransForms
+  describe FormBase do
+
+    describe '#initialize' do
+      it 'assigns attributes defined by +attribute+' do
+        attr = { name: 'John Doe', age: 30, foo: 'bar' }
+        form = UserCreator1.new(attr)
+
+        expect(form.name).to    eq(attr[:name])
+        expect(form.age).to     eq(attr[:age])
+        expect { form.foo }.to  raise_error
+      end
+    end
+
+    describe 'validations' do
+      it 'is considered valid when validations pass' do
+        attr = { name: 'John Doe', age: 30 }
+        form = UserCreator1.new(attr)
+        expect(form).to     be_valid
+
+        form.name = ''
+        expect(form).not_to be_valid
+      end
+    end
+
+    describe '#save' do
+      it 'returns true when no errors occur inside the +transaction+ block' do
+        form = NoErrorInTransactionForm.new
+        expect(form.save).to be true
+      end
+
+      it 'returns false when errors do occur inside the +transaction+ block' do
+        form = ErrorInTransactionForm.new
+        expect(form.save).to be false
+      end
+    end
+
+    describe 'transaction' do
+      it 'saves multiple records to db when nothing raises errors' do
+        attr = { name1: 'John', name2: 'Peter' }
+        count = User.count
+
+        expect(MultipleRecordsCreator.new(attr).save).to be true
+        expect(User.count).to eq(count+2)
+      end
+
+      it 'rollbacks both saves even if the first is successful and the last one raises an error' do
+        # First User is saved successfully, but last one will raise an
+        # error because of User class uniqueness validation on +name+
+        attr = { name1: 'John', name2: 'John' }
+        count = User.count
+
+        expect(MultipleRecordsCreator.new(attr).save).to be false
+        expect(User.count).to eq(count)
+      end
+
+      it 'does not cause rollback when save is not raising error (no !), even though it was not saved' do
+        attr = { name1: 'John', name2: 'John' }
+        count = User.count
+
+        expect(MultipleRecordsCreatorNoBang.new(attr).save).to be true
+        expect(User.count).to eq(count+1) # Only one record saved
+      end
+    end
+
+  end
+
+end

data/spec/trans_forms/form_errors_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+module TransForms
+  describe FormErrors do
+    describe '#error_models' do
+      it 'does not raise an error when called on a form model without a main_instance' do
+        form = UserUpdater.new
+        expect(form.main_model).to eq(:user)
+        expect(form.main_instance).to be nil
+        expect { form.errors.error_models }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/trans_forms/main_model/proxy_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module TransForms
+  module MainModel
+    describe Proxy do
+      describe 'model_name' do
+        it 'returns an ActiveModel::Name instance for the main_model instead of form model' do
+          expect(ProxyModel.main_model).to eq :user
+          expect(ProxyModel.name).to eq 'ProxyModel'
+          expect(ProxyModel.model_name.name).to eq 'User'
+        end
+      end
+    end
+  end
+end

data/spec/trans_forms/main_model_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module TransForms
+  describe MainModel do
+    let(:user) { User.create(name: 'John') }
+    let(:phone_number) { PhoneNumber.create(user_id: user.id, number: '+1-555-MY-NUMBER') }
+
+    describe 'set_main_model' do
+      it 'defines accessor attributes for main model and stores them in a class attribute' do
+        form = MainModelModel.new
+        expect{ form.user }.to raise_error
+        expect{ form.user = User.new }.to raise_error
+
+        MainModelModel.set_main_model :user
+        form = MainModelModel.new
+        expect{ form.user }.not_to raise_error
+        expect{ form.user = User.new }.not_to raise_error
+
+        expect(MainModelModel.main_model).to eq :user
+      end
+      it 'proxies +model_name+ method to the main_model when proxy: true is set' do
+        expect(UserProxyModel.main_model).to eq :user
+        expect(UserProxyModel.name).to eq 'UserProxyModel'
+        expect(UserProxyModel.model_name.name).to eq 'User'
+      end
+    end
+
+    describe 'model accessor' do
+      it 'can initialize a form model and automatically set the accessor defined by main_model' do
+        expect(UserUpdater.main_model).to eq :user
+        form = UserUpdater.new(model: user)
+        expect(form.user).to eq user
+      end
+
+      it 'raises an error if the model supplied is not the type of main model' do
+        expect(UserUpdater.main_model).to eq :user
+        expect { UserUpdater.new(model: phone_number) }.to raise_error
+      end
+    end
+
+    describe 'model_name' do
+      it 'does not raise an error when raised' do
+        #TODO: Improve this spec
+        expect { UserUpdater.model_name }.not_to raise_error
+      end
+    end
+  end
+
+end

data/spec/trans_forms/nested_forms_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module TransForms
+  describe NestedForms do
+
+    describe '#each_nested_hash_for' do
+      it 'iterates through nested hash values and turns all hash keys into string values' do
+        attr = { 0 => { id: 1 }, 1 => { id: 2 } }
+
+        iterations = 0
+        NestedFormsModel.new.each_nested_hash_for attr do |nested_hash|
+          expect(nested_hash).to eq attr[iterations].stringify_keys
+          iterations += 1
+        end
+        expect(iterations).to eq 2
+      end
+
+      it 'skips iterating over values that are not hashes' do
+        attr = { 0 => { name: 'John' }, 1 => 'Not a Hash' }
+
+        iterations = 0
+        NestedFormsModel.new.each_nested_hash_for attr do |nested_hash|
+          expect(nested_hash).to eq attr[iterations].stringify_keys
+          iterations += 1
+        end
+        expect(iterations).to eq 1
+      end
+
+      it 'creates two nested PhoneNumber records for a User record' do
+        attr = { name: 'John', phone_numbers_attributes: {
+            '0' => { number: '+1-555-CALL-JOHN' },
+            '1' => { number: '+1-555-FOO-BAR' }
+        } }
+        count = PhoneNumber.count
+        expect(UserAndPoneNumbersCreator.new(attr).save).to be true
+        expect(PhoneNumber.count).to eq(count+2)
+      end
+    end
+
+    describe '#any_nested_hash_for?' do
+      it 'returns false unless there is at least one nested Hash value with at least one non-blank value' do
+        form = NestedFormsModel.new
+
+        expect(form.any_nested_hash_for?({  })).to be false
+        expect(form.any_nested_hash_for?({ '0' => 'Not a Hash' })).to be false
+        expect(form.any_nested_hash_for?({ '0' => {  } })).to be false
+        expect(form.any_nested_hash_for?({ '0' => { name: '' } })).to be false
+        expect(form.any_nested_hash_for?({ '0' => { name: 'Not a blank value' } })).to be true
+      end
+    end
+  end
+
+end

data/trans_forms.gemspec

@@ -0,0 +1,29 @@
+require File.expand_path('../lib/trans_forms/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors     = ['Daniel Viklund']
+  s.email       = ['dannemanne@gmail.com']
+  s.summary     = 'Gem to create Form records that handles multiple changes wrapped in a transaction'
+  s.description = 'Gem to create Form records that handles multiple changes wrapped in a transaction'
+  s.homepage    = 'https://github.com/dannemanne/trans_forms'
+  s.license     = 'MIT'
+
+  s.name        = 'trans_forms'
+  s.version     = TransForms::VERSION
+  s.date        = '2014-07-08'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '>= 2'
+  s.add_development_dependency 'rspec-rails', '>= 2'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'database_cleaner'
+
+  s.add_dependency 'virtus'
+  s.add_dependency 'rails', '>= 3'
+  s.add_dependency 'activemodel', '>= 3'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: trans_forms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Viklund
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: activemodel
+  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'
+description: Gem to create Form records that handles multiple changes wrapped in a
+  transaction
+email:
+- dannemanne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/rails/setup_generator.rb
+- lib/generators/rails/templates/application_trans_form.rb
+- lib/generators/rails/templates/trans_form.rb
+- lib/generators/rails/trans_form_generator.rb
+- lib/generators/rspec/setup_generator.rb
+- lib/generators/rspec/templates/application_trans_form_spec.rb
+- lib/generators/rspec/templates/trans_form_spec.rb
+- lib/generators/rspec/trans_form_generator.rb
+- lib/trans_forms.rb
+- lib/trans_forms/callbacks.rb
+- lib/trans_forms/errors.rb
+- lib/trans_forms/form_base.rb
+- lib/trans_forms/form_errors.rb
+- lib/trans_forms/main_model.rb
+- lib/trans_forms/main_model/proxy.rb
+- lib/trans_forms/nested_forms.rb
+- lib/trans_forms/version.rb
+- spec/generators/trans_form/trans_form_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/support/trans_forms/callback_forms.rb
+- spec/support/trans_forms/main_model_forms.rb
+- spec/support/trans_forms/multiple_records_forms.rb
+- spec/support/trans_forms/nested_forms.rb
+- spec/support/trans_forms/simple_forms.rb
+- spec/support/trans_forms/user_creator_1.rb
+- spec/trans_forms/callbacks_spec.rb
+- spec/trans_forms/form_base_spec.rb
+- spec/trans_forms/form_errors_spec.rb
+- spec/trans_forms/main_model/proxy_spec.rb
+- spec/trans_forms/main_model_spec.rb
+- spec/trans_forms/nested_forms_spec.rb
+- trans_forms.gemspec
+homepage: https://github.com/dannemanne/trans_forms
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem to create Form records that handles multiple changes wrapped in a transaction
+test_files:
+- spec/generators/trans_form/trans_form_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/support/trans_forms/callback_forms.rb
+- spec/support/trans_forms/main_model_forms.rb
+- spec/support/trans_forms/multiple_records_forms.rb
+- spec/support/trans_forms/nested_forms.rb
+- spec/support/trans_forms/simple_forms.rb
+- spec/support/trans_forms/user_creator_1.rb
+- spec/trans_forms/callbacks_spec.rb
+- spec/trans_forms/form_base_spec.rb
+- spec/trans_forms/form_errors_spec.rb
+- spec/trans_forms/main_model/proxy_spec.rb
+- spec/trans_forms/main_model_spec.rb
+- spec/trans_forms/nested_forms_spec.rb