trans_forms 0.1.0

data/lib/trans_forms/main_model.rb

@@ -0,0 +1,115 @@
+module TransForms
+  module MainModel
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # This method will extend the BaseForm functionality with the
+      # TransForms::MainModel::Active module.
+      def set_main_model(model, options = {})
+        include TransForms::MainModel::Active
+
+        # Stores the main_model record in a class_attribute
+        class_attribute :main_model
+        self.main_model = model
+
+        # Defines an instance accessor for the main_model
+        attr_accessor model
+
+        # Implements proxy module that overwrites model_name method
+        # to instead return an ActiveModel::Mame class for the
+        # main_model class
+        include TransForms::MainModel::Proxy if options[:proxy]
+      end
+
+    end
+
+    module Active
+      extend ActiveSupport::Concern
+
+      included do
+        # Since the after_save_on_error is not part of this module, we make sure
+        # that the methods exist before calling it. It should not be necessary since
+        # the Callbacks module is included by default in the FormBase, but added
+        # anyway. If this module is included manually (like in one of the specs) then
+        # it prevents any error to occur.
+        after_save_on_error :assert_record_on_error if respond_to?(:after_save_on_error)
+      end
+
+      # Called from FormError to collect error messages from all possible
+      # models involved in the form transation.
+      def main_instance
+        send main_model
+      end
+
+      # Combines the errors from the FormModel as well as the main model instances
+      def errors
+        @errors ||= FormErrors.new(self, super)
+      end
+
+      # In it's default implementation, this method will look at the class name
+      # and try to match it to an attribute defined in the form model. If a match
+      # is found, then it will assign the model to that attribute.
+      #
+      # This method is encouraged to overwrite when there is custom conditions
+      # for how to handle the assignments.
+      #
+      # For example:
+      #
+      #   class UserUpdater < ApplicationTransForm
+      #     attr_accessor :admin
+      #     set_main_model :user
+      #
+      #     def model=(model)
+      #       if model.role == :admin
+      #         self.admin = model
+      #       else
+      #         self.user = model
+      #       end
+      #     end
+      #
+      #     # ...
+      #   end
+      #
+      def model=(model)
+        element = to_element(model)
+        if respond_to?("#{element}=")
+          send("#{element}=", model)
+        else
+          raise TransForms::NotImplementedError
+        end
+      end
+
+    protected
+
+      # This method is assigned to the after_save_on_error callback
+      #
+      # If an error was raised in a create! statement then the variable might not
+      # have been assigned and would prevent error messages to be displayed. This
+      # makes sure that the instance that raised the error will be assigned if it
+      # would have been the main model.
+      def assert_record_on_error(e)
+        if e.respond_to?(:record) && e.record.present?
+          element = to_element(e.record)
+          if main_model == element.to_sym && send(element).nil?
+            send("#{element}=", e.record)
+          end
+        end
+      end
+
+      # A method to retrieve the underscored version of a record's class name.
+      # The procedure is slightly different in Rails 3 and Rails 4, that's what
+      # this method takes into consideration.
+      def to_element(record)
+        if record.class.model_name.is_a?(ActiveModel::Name)
+          record.class.model_name.element
+        else
+          record.class.model_name.underscore
+        end
+      end
+
+    end
+  end
+end
+
+TransForms::FormBase.send(:include, TransForms::MainModel)

data/lib/trans_forms/main_model/proxy.rb

@@ -0,0 +1,38 @@
+module TransForms
+  module MainModel
+    module Proxy
+      extend ActiveSupport::Concern
+      # A module that adds functionality to delegate certain
+      # methods to the main model. This is done to make forms
+      # and controllers handle the form model as if it were
+      # the main model itself
+
+      module ClassMethods
+
+        # Returns an ActiveModel::Name object for module. It can be
+        # used to retrieve all kinds of naming-related information
+        # (See ActiveModel::Name for more information).
+        #
+        #   class PostForm < TransForms::FormBase
+        #     set_main_model :post, proxy: true
+        #   end
+        #
+        #   PostForm.model_name          # => Post
+        #   PostForm.model_name.class    # => ActiveModel::Name
+        #   PostForm.model_name.singular # => "post"
+        #   PostForm.model_name.plural   # => "posts"
+        def model_name
+          @_model_name ||= begin
+            klass = respond_to?(:main_model) ? main_model.to_s.classify.constantize : self
+
+            namespace = klass.parents.detect do |n|
+              n.respond_to?(:use_relative_model_naming?) && n.use_relative_model_naming?
+            end
+            ActiveModel::Name.new(klass, namespace)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/trans_forms/nested_forms.rb

@@ -0,0 +1,69 @@
+module TransForms
+  module NestedForms
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Call this method from any Form class that uses a Hash attribute to
+      # process nested form models. It will include a number of methods
+      # to more efficiently go through params and records.
+      def has_nested_forms
+        include TransForms::NestedForms::Active
+      end
+
+    end
+
+    module Active
+      extend ActiveSupport::Concern
+
+    protected
+
+      # A method that can be used to iterate through a Hash value that is
+      # structured the way Rails form helper +fields_for+ will create.
+      #
+      # Example:
+      #
+      #   # Given the following Hash:
+      #   attr = { '0' => { name: 'John' }, '0' => { name: 'Peter' } }
+      #
+      #   # It can be processed like this:
+      #   each_nested_hash_for attr do |nested_hash|
+      #     name = nested_hash['name']
+      #     # Do something with the name, like create multiple Contact
+      #     # records
+      #   end
+      #
+      def each_nested_hash_for(attr, &block)
+        if attr.is_a?(Hash)
+          attr.values.each do |v|
+            if v.is_a?(Hash)
+              block.call(v.stringify_keys)
+            end
+          end
+        end
+      end
+
+      # A method that can be used to make sure that there are at least
+      # one nested hash that has a present value. Useful for validating
+      # an attribute when there needs to be at least one association
+      # created together with a main record.
+      def any_nested_hash_for?(attr)
+        attr.is_a?(Hash) && attr.values.detect { |v|
+          v.is_a?(Hash) && v.values.detect(&:present?).present?
+        }.present?
+      end
+
+      def find_from!(collection, identifier, find_by = :id)
+        if identifier.present?
+          collection.detect { |instance| instance.send(find_by) == identifier.to_i } || (raise NotFoundFromError)
+        else
+          raise NotFoundFromError
+        end
+      end
+
+    end
+
+  end
+end
+
+TransForms::FormBase.send(:include, TransForms::NestedForms)

data/lib/trans_forms/version.rb

@@ -0,0 +1,3 @@
+module TransForms
+  VERSION = '0.1.0'
+end

data/spec/generators/trans_form/trans_form_generator_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'rails'
+require 'rails/generators'
+require 'generators/rails/trans_form_generator'
+
+describe Rails::Generators::TransFormGenerator do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'bundler/setup'
+require 'trans_forms'
+require 'rails/version'
+require 'support/schema'
+require 'support/models'
+require 'database_cleaner'
+
+Dir[File.expand_path('../support/trans_forms/*.rb', __FILE__)].each { |f| require f }
+
+I18n.enforce_available_locales = false
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+class User < ActiveRecord::Base
+  has_many :phone_numbers, dependent: :destroy
+
+  validates :name, presence: true, uniqueness: true
+end
+
+class PhoneNumber < ActiveRecord::Base
+  belongs_to :user
+
+  validates :user_id, presence: true
+  validates :number,  presence: true, uniqueness: { scope: :user_id }
+end

data/spec/support/schema.rb

@@ -0,0 +1,23 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+    adapter: 'sqlite3',
+    database: ':memory:'
+})
+
+# prepare test data
+class CreateTestSchema < ActiveRecord::Migration
+  def change
+    create_table "users", :force => true do |t|
+      t.string "name"
+      t.integer "age"
+    end
+
+    create_table "phone_numbers", :force => true do |t|
+      t.integer "user_id"
+      t.string "number"
+    end
+  end
+end
+
+CreateTestSchema.migrate(:up)

data/spec/support/trans_forms/callback_forms.rb

@@ -0,0 +1,22 @@
+class CallbackForm < TransForms::FormBase
+  attr_reader :user1, :user2, :i_was_called
+
+  attribute :name1,      String
+  attribute :name2,      String
+
+  validates :name1, presence: true
+  validates :name2, presence: true
+
+  after_save_on_error :call_me
+
+  transaction do
+    @user1 = User.create!(name: name1)
+    @user2 = User.create!(name: name2)
+  end
+
+protected
+  def call_me(error)
+    @i_was_called = true
+  end
+
+end

data/spec/support/trans_forms/main_model_forms.rb

@@ -0,0 +1,27 @@
+class MainModelModel
+  include TransForms::MainModel
+end
+
+class ProxyModel
+  class_attribute :main_model
+  self.main_model = :user
+  include TransForms::MainModel::Proxy
+end
+
+class UserUpdater < TransForms::FormBase
+  set_main_model :user
+
+  attribute :name,  String
+
+  validates :name, presence: true
+
+  transaction do
+    user.attributes = { name: name }
+    user.save!
+  end
+
+end
+
+class UserProxyModel < TransForms::FormBase
+  set_main_model :user, proxy: true
+end

data/spec/support/trans_forms/multiple_records_forms.rb

@@ -0,0 +1,31 @@
+class MultipleRecordsCreator < TransForms::FormBase
+  attr_reader :user1, :user2
+
+  attribute :name1,      String
+  attribute :name2,      String
+
+  validates :name1, presence: true
+  validates :name2, presence: true
+
+  transaction do
+    @user1 = User.create!(name: name1)
+    @user2 = User.create!(name: name2)
+  end
+
+end
+
+class MultipleRecordsCreatorNoBang < TransForms::FormBase
+  attr_reader :user1, :user2
+
+  attribute :name1,      String
+  attribute :name2,      String
+
+  validates :name1, presence: true
+  validates :name2, presence: true
+
+  transaction do
+    @user1 = User.create(name: name1)
+    @user2 = User.create(name: name2)
+  end
+
+end

data/spec/support/trans_forms/nested_forms.rb

@@ -0,0 +1,26 @@
+class NestedFormsModel
+  include TransForms::NestedForms::Active
+
+  # Makes the methods public for easier Unit testing
+  public :each_nested_hash_for, :any_nested_hash_for?, :find_from!
+end
+
+class UserAndPoneNumbersCreator < TransForms::FormBase
+  has_nested_forms
+
+  attr_reader :user
+
+  attribute :name,                      String
+  attribute :phone_numbers_attributes,  Hash
+
+  validates :name, presence: true
+
+  transaction do
+    @user = User.create!(name: name)
+
+    each_nested_hash_for phone_numbers_attributes do |attr|
+      @user.phone_numbers.create!(attr)
+    end
+  end
+
+end

data/spec/support/trans_forms/simple_forms.rb

@@ -0,0 +1,13 @@
+class NoErrorInTransactionForm < TransForms::FormBase
+  transaction do
+    # Bunch of actions
+    1 + 1; 'No errors'; [1,2,3].map(&:to_s)
+    false # Can return false, save will be success anyway
+  end
+end
+
+class ErrorInTransactionForm < TransForms::FormBase
+  transaction do
+    raise ActiveRecord::ActiveRecordError
+  end
+end