trans_forms 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2Y0YmRmMDIyZjI0Y2MxYmEwNmY1YTI1Nzk2NjVhN2U0YWFmOGRhMg==
+  data.tar.gz: !binary |-
+    MDQxZWY0NTJkNWQ5NWIyNTkyOTBjYjhlNmViMjUwZDI5NzkwOTcwZA==
+SHA512:
+  metadata.gz: !binary |-
+    OTVhYjk0ZTMyZDgyZjMyOTIzMGI3YzU4MTAwNGFmYTI3ZTFjM2FmMWQzYzYw
+    ZWE3MjgwNTA3Y2Q3OTM5OGExMmU3Y2Q1Yzk2NzNiODI0MTg1YTY3ODUzOTVj
+    NTBhYjQ2YmRkNWFkNWFjNWVmMGFlMWZjYTMxYWRmMjkzMTk4YWQ=
+  data.tar.gz: !binary |-
+    NDE0NzQ4YTY2MmVkZmZjZWUwNGU2NzE3ZGJiY2M0ZTdmMmRhZWM5NDFhMWI4
+    NDM1ODUxZTFmY2VjNGU0YWJlODQ0MjQ5ZThiOGNlZmZhODA0MGMwNmM5ZjVl
+    Mzc5MTBmNWQzNWNmNjQ4ODY3MTk4YmU2YTFjYzlkMDAyNTNlYzY=

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle
+.idea
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in test-gem.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Viklund
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+[![Build Status](https://travis-ci.org/dannemanne/trans_forms.svg?branch=master)](https://travis-ci.org/dannemanne/trans_forms)
+[![Code Climate](https://codeclimate.com/github/dannemanne/trans_forms.png)](https://codeclimate.com/github/dannemanne/trans_forms)
+
+# TransForms
+
+TransForms is short for Transactional Forms. I created it mainly because I felt that
+the ActiveRecord Models all to often get cluttered with a lot of conditional validations
+and processing. As some of my models grew, I noticed that most of the mess was caused
+by complex validations and callbacks that were sometimes needed, and other times they
+were out of scope and had to be skipped, just to allow the record to be saved. I felt
+that there was another layer missing.
+
+By placing some of the logic and validations, that only needs to be processed in certain
+scenarios, into dedicated Form Models, the ActiveRecord Models got a lot cleaner. And
+in the process I gained more control of the save transaction. And the greatest benefit of
+this setup is the ability to easily update multiple records without having to rely on
+messy callbacks and exceptions in association validations.
+
+This is the first extract of what I have been using in one of my projects. So far it
+is still missing some of the functionality I have in the original (like confirmation
+handling when conflicts occur) but the core is there. And more will come as I manage
+to detach it from the more specific business logic.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trans_forms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trans_forms
+
+## Writing Form Models
+
+Form Models inherit from `TransForms::FormBase` and live in the `app/trans_forms`
+directory of your application.
+
+    # app/trans_forms/post_form.rb
+    class PostForm < TransForms::FormBase
+      # ...
+    end
+
+### Generators
+
+To manually generate a Form Model, you can run...
+
+    rails g trans_form PostForm
+
+... to create a `PostForm` Form Model.
+
+### Shared Form Model Methods
+
+You might want to add some default functionality to all your Form Models. The common
+practice to accomplish this is to have an application specific model that inherits
+from the FormBase. Then you have all of your FormModels inherit from this model instead.
+
+You can generate a default model like this by running:
+
+TODO: Add generator
+
+This will add an `ApplicationTransForm` model...
+
+    # app/trans_forms/application_trans_form.rb
+    class ApplicationTransForm < TransForms::FormBase
+      # ...
+    end
+
+... that you can use in you Form Models:
+
+    class PostForm < ApplicationTransForm
+      # ...
+    end
+
+Note that by having a model with the exact name `ApplicationTransForm`, the generator
+for new Form Models will by default inherit from that model instead of the `TransForm::FormBase`
+
+## Contributing
+
+1. Fork it ( https://github.com/dannemanne/trans_forms/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task 'default' => 'ci'
+
+desc 'Run all tests for CI'
+task 'ci' => 'spec'
+
+desc 'Run all specs'
+task 'spec' => 'spec:all'
+
+namespace 'spec' do
+  task 'all' => ['trans_forms', 'generators']
+
+  def spec_task(name)
+    desc "Run #{name} specs"
+    RSpec::Core::RakeTask.new(name) do |t|
+      t.pattern = "spec/#{name}/**/*_spec.rb"
+    end
+  end
+
+  spec_task 'trans_forms'
+  spec_task 'generators'
+
+end
+

data/lib/generators/rails/setup_generator.rb

@@ -0,0 +1,14 @@
+module Rails
+  module Generators
+    class SetupGenerator < Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_form_file
+        template 'application_trans_form.rb', File.join('app/trans_forms', 'application_trans_form.rb')
+      end
+
+      hook_for :test_framework
+
+    end
+  end
+end

data/lib/generators/rails/templates/application_trans_form.rb

@@ -0,0 +1,13 @@
+class ApplicationTransForm < TransForms::FormBase
+  # Here you can place application specific code to customize the
+  # default behavior of TransForms.
+  #
+  # Here is an example of a custom instantiator that works to set
+  # a model and current_user attributes in addition to the params
+  # which might come directly from the controller.
+  #
+  #   def self.new_in_model(model, params = {}, current_user = nil)
+  #     new(params.merge(model: model, current_user: current_user))
+  #   end
+
+end

data/lib/generators/rails/templates/trans_form.rb

@@ -0,0 +1,31 @@
+<%- module_namespacing do -%>
+  <%- if parent_class_name.present? -%>
+class <%= class_name %> < <%= parent_class_name %>
+  <%- else -%>
+class <%= class_name %>
+  <%- end -%>
+
+  # Define the attributes available for this specific form model. The attributes
+  # are declared according to the Virtus standard
+  #
+  #   attribute :name,      String
+  #   attribute :age,       Numeric
+  #   attribute :phone_no,  Array
+
+
+  # Define validations according to the ActiveModel conventions
+  #
+  #   validates :name,  presence: true
+  #   validates :age,   numericality: { greater_than_or_equal_to: 18 }
+
+  transaction do
+    # Perform all actions inside this block. If anything goes wrong, i.e. an
+    # an error is raised because of validation errors, then everything that
+    # has already been done inside this block is rolled back.
+    #
+    #   self.user = User.create!(name: name, age: age, phone_no: phone_no)
+
+  end
+
+end
+<% end -%>

data/lib/generators/rails/trans_form_generator.rb

@@ -0,0 +1,36 @@
+module Rails
+  module Generators
+    class TransFormGenerator < NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      check_class_collision
+
+      class_option :parent, type: :string, desc: 'The parent class for the generated form model'
+
+      def create_form_file
+        template 'trans_form.rb', File.join('app/trans_forms', class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+
+    private
+
+      def parent_class_name
+        options.fetch('parent') do
+          begin
+            require 'application_trans_form'
+            ApplicationTransForm
+          rescue LoadError
+            'TransForms::FormBase'
+          end
+        end
+      end
+
+      # Rails 3.0.X compatibility, copied from https://github.com/jnunemaker/mongomapper/pull/385/files#L1R32
+      unless methods.include?(:module_namespacing)
+        def module_namespacing
+          yield if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/generators/rspec/setup_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class SetupGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_spec_file
+      template 'application_trans_form_spec.rb', File.join('spec/trans_forms', 'application_trans_form_spec.rb')
+    end
+  end
+end

data/lib/generators/rspec/templates/application_trans_form_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe ApplicationTransForm do
+end

data/lib/generators/rspec/templates/trans_form_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe <%= class_name %> do
+end

data/lib/generators/rspec/trans_form_generator.rb

@@ -0,0 +1,9 @@
+module Rspec
+  class TransFormGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_spec_file
+      template 'trans_form_spec.rb', File.join('spec/trans_forms', class_path, "#{file_name}_spec.rb")
+    end
+  end
+end

data/lib/trans_forms.rb

@@ -0,0 +1,9 @@
+require 'trans_forms/callbacks'
+require 'trans_forms/form_base'
+
+require 'trans_forms/errors'
+require 'trans_forms/form_errors'
+require 'trans_forms/version'
+require 'trans_forms/nested_forms'
+require 'trans_forms/main_model'
+require 'trans_forms/main_model/proxy'

data/lib/trans_forms/callbacks.rb

@@ -0,0 +1,30 @@
+require 'active_support/concern'
+
+module TransForms
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_tf_cb
+    end
+
+    def after_save_on_error_callback(active_record_error)
+      if _tf_cb && _tf_cb[:after_save_on_error].is_a?(Array)
+        _tf_cb[:after_save_on_error].each do |method|
+          send method, active_record_error
+        end
+      end
+    end
+
+    module ClassMethods
+
+      def after_save_on_error(*args)
+        self._tf_cb ||= {}
+        _tf_cb[:after_save_on_error] ||= []
+        _tf_cb[:after_save_on_error] += args
+      end
+
+    end
+
+  end
+end

data/lib/trans_forms/errors.rb

@@ -0,0 +1,13 @@
+
+require 'active_record/errors'
+module TransForms
+
+  class NotImplementedError < StandardError
+  end
+
+  # Custom error class to distinguish from regular ActiveRecord not found errors, but
+  # will trigger the same effect when raised within a transaction.
+  class NotFoundFromError < ActiveRecord::RecordNotFound
+  end
+
+end

data/lib/trans_forms/form_base.rb

@@ -0,0 +1,47 @@
+require 'virtus'
+
+# TODO: Determine the specific modules that needs to be loaded instead of rails/all
+require 'rails/all'
+
+module TransForms
+  class FormBase
+    include Virtus.model
+
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
+
+    include TransForms::Callbacks
+
+    def save
+      valid? && run_transaction
+    end
+
+    def save!
+      save || (raise ActiveRecord::RecordInvalid)
+    end
+
+    # ActiveModel support
+    def persisted?; false end
+    def to_key; nil end
+
+  protected
+    def self.transaction(&block)
+      class_attribute :_transaction
+      self._transaction = block
+    end
+
+    def run_transaction
+      ActiveRecord::Base.transaction do
+        instance_eval &_transaction
+        true
+      end
+    rescue ActiveRecord::ActiveRecordError => e
+      # Triggers callback
+      after_save_on_error_callback e
+      false
+    end
+
+  end
+end

data/lib/trans_forms/form_errors.rb

@@ -0,0 +1,38 @@
+module TransForms
+  class FormErrors
+    attr_accessor :form_model, :original
+
+    def initialize(form_model, original)
+      self.form_model, self.original = form_model, original
+    end
+
+    def error_models
+      [original, form_model.main_instance.try(:errors)].compact
+    end
+
+    def full_messages
+      original.full_messages
+    end
+
+    def clear
+      error_models.each do |em|
+        em.clear
+      end
+    end
+
+    def [](key)
+      error_models.inject([]) { |acc, error_model|
+        acc += (error_model[key])
+      }
+    end
+
+    def empty?
+      error_models.all?(&:empty?)
+    end
+
+    def method_missing(m, *args, &block)
+      original.send(m, *args, &block)
+    end
+
+  end
+end