rails-patterns 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2318f3f2a2753ab5159fa535d0245110eca7133c
-  data.tar.gz: 6031c700f903e0a62ef3a9951f83932d590a887c
+  metadata.gz: af39ea7538e043642610c2ea2ff35a9fa5c8a0e7
+  data.tar.gz: ff3231a21b94a92280acf664497a40b3039f7140
 SHA512:
-  metadata.gz: 4eabca7c85d89675918642a3f07c72effce0fccb4d709cc4d13c986cb549b9216dc7913cf2303ca464efa69c157b168f3d71301dd0422af13c738fce639e47e4
-  data.tar.gz: b3d706d159d0abedab70f3aadb818c1b977463aa37e683f8a5bd2b3d139a187e3ac72d4b18b98def990ff739ce5d5b224b9de2f03c27e5585283f4213d4479df
+  metadata.gz: c3653e8ce337a6225ad14162600f8b2a462321fcca8595f8f1463920935749e17b48d3f7359530dff528bc7ff3f7175ddaa23b7ac1203903ff42b296bfb8c51d
+  data.tar.gz: 37f4e6cb0fc581140dfee9372386b9d37b77a092d63d798fb98d8617475ac249d2e8f49aa9d8092ae5630e3de5e48a0aa6677ed7d62e89429a788c9fb51e44f2

data/Gemfile

@@ -1,7 +1,8 @@
 source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-  gem "activerecord", ">= 4.2.6"
+
+gem "activerecord", ">= 4.2.6"
+gem "actionpack", ">= 4.2.6"
+gem "virtus"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -1,6 +1,19 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
     activemodel (5.0.2)
       activesupport (= 5.0.2)
     activerecord (5.0.2)
@@ -14,12 +27,20 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.4.0)
     arel (7.1.4)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.3)
     coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.0.5)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
+    equalizer (0.0.11)
+    erubis (2.7.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     git (1.3.0)
@@ -33,6 +54,7 @@ GEM
     hashie (3.5.5)
     highline (1.7.8)
     i18n (0.8.1)
+    ice_nine (0.11.2)
     juwelier (2.1.3)
       builder
       bundler (>= 1.13)
@@ -44,6 +66,8 @@ GEM
       rdoc
       semver
     jwt (1.5.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
     method_source (0.8.2)
     mime-types (2.99.3)
     mini_portile2 (2.1.0)
@@ -66,6 +90,13 @@ GEM
     pry-rails (0.3.6)
       pry (>= 0.10.4)
     rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
     rake (12.0.0)
     rdoc (5.1.0)
     rspec (3.5.0)
@@ -86,16 +117,23 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionpack (>= 4.2.6)
   activerecord (>= 4.2.6)
   bundler (~> 1.0)
   juwelier (~> 2.1.0)
   pry-rails
   rspec
+  virtus
 
 BUNDLED WITH
    1.14.6

data/README.md

@@ -2,6 +2,11 @@
 
 A collection of lightweight, standardized, rails-oriented patterns.
 
+- [Query - complex querying on active record relation](#query)
+- [Service - useful for handling processes involving multiple steps](#service)
+- [Collection - when in need to add a method that relates to the collection a whole](#collection)
+- [Form - when you need a place for callbacks, want to replace strong parameters or handle virtual/composite resources](#form)
+
 ## Installation
 
 ```ruby
@@ -166,8 +171,102 @@ end
 
 ```ruby
 ColorsCollection.new
-CustomerEventsCollection.for(customer)
-CustomerEventsCollection.for(customer, label_method: "name")
+CustomerEventsByTypeCollection.for(customer)
+CustomerEventsByTypeCollection.for(customer, label_method: "name")
+```
+
+## Form
+
+### When to use it
+
+Form objects, just like service objects, are commonly used to mitigate problems with model callbacks that interact with external classes ([read more...](http://samuelmullen.com/2013/05/the-problem-with-rails-callbacks/)).
+Form objects can also be used as replacement for `ActionController::StrongParameters` strategy, as all writable attributes are re-defined within each form.
+Finally form objects can be used as wrappers for virtual (with no model representation) or composite (saving multiple models at once) resources.
+In the latter case this may act as replacement for `ActiveRecord::NestedAttributes`.
+
+### Assumptions and rules
+
+* Forms include `ActiveModel::Validations` to support validation.
+* Forms include `Virtus.model` to support `attribute` static method with all [corresponding capabilities](https://github.com/solnic/virtus).
+* Forms can be initialized using `.new`.
+* Forms accept optional resource object as first constructor argument.
+* Forms accept optional attributes hash as latter constructor argument.
+* forms have to implement `#persist` method that returns falsey (if failed) or truthy (if succeeded) value.
+* Forms provide access to first constructor argument using `#resource`.
+* Forms are saved using their `#save` or `#save!` methods.
+* Forms will attempt to pre-populate their fields using `resource#attributes` and public getters for `resource`
+* Form's fields are populated with passed-in attributes hash reverse-merged with pre-populated attributes if possible.
+* Forms provide `#as` builder method that populates internal `@form_owner` variable (can be used to store current user).
+* Forms allow defining/overriding their `#param_key` method result by using `.param_key` static method. This defaults to `#resource#model_name#param_key`.
+* Forms delegate `#persisted?` method to `#resource` if possible.
+* Forms do handle `ActionController::Parameters` as attributes hash (using `to_unsafe_h`)
+* It is recommended to wrap `#persist` method in transaction if possible and if multiple model are affected.
+
+### Examples
+
+#### Declaration
+
+```ruby
+class UserForm < Patterns::Form
+  param_key "person"
+
+  attribute :first_name, String
+  attribute :last_name, String
+  attribute :age, Integer
+  attribute :full_address, String
+  attribute :skip_notification, Boolean
+
+  validate :first_name, :last_name, presence: true
+
+  private
+
+  def persist
+    update_user and
+      update_address and
+      deliver_notification
+  end
+
+  def update_user
+    resource.update_attributes(attributes.except(:full_address, :skip_notification))
+  end
+
+  def update_address
+    resource.address.update_attributes(full_address: full_address)
+  end
+
+  def deliver_notification
+    skip_notification || UserNotifier.user_update_notification(user, form_owner).deliver
+  end
+end
+
+class ReportConfigurationForm < Patterns::Form
+  param_key "report"
+
+  attribute :include_extra_data, Boolean
+  attribute :dump_as_csv, Boolean
+  attribute :comma_separated_column_names, String
+  attribute :date_start, Date
+  attribute :date_end, Date
+
+  private
+
+  def persist
+    SendReport.call(attributes)
+  end
+end
+```
+
+#### Usage
+
+```ruby
+form = UserForm.new(User.find(1), params[:person])
+form.save
+
+form = UserForm.new(User.new, params[:person]).as(current_user)
+form.save!
+
+ReportConfigurationForm.new
+ReportConfigurationForm.new({ include_extra_data: true, dump_as_csv: true })
 ```
 
 ## Further reading

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/patterns/form.rb

@@ -0,0 +1,100 @@
+require "virtus"
+require "action_controller/metal/strong_parameters"
+
+module Patterns
+  class Form
+    include Virtus.model
+    include ActiveModel::Validations
+
+    Error = Class.new(StandardError)
+    Invalid = Class.new(Error)
+    NoParamKey = Class.new(Error)
+
+    def initialize(*args)
+      attributes = args.extract_options!
+
+      if attributes.blank? && args.last.is_a?(ActionController::Parameters)
+        attributes = args.pop.to_unsafe_h
+      end
+
+      @resource = args.first
+
+      super(build_original_attributes.merge(attributes))
+    end
+
+    def save
+      valid? ? persist : false
+    end
+
+    def save!
+      save.tap do |saved|
+        raise Invalid unless saved
+      end
+    end
+
+    def as(form_owner)
+      @form_owner = form_owner
+      self
+    end
+
+    def to_key
+      nil
+    end
+
+    def to_partial_path
+      nil
+    end
+
+    def to_model
+      self
+    end
+
+    def persisted?
+      if resource&.respond_to?(:persisted?)
+        resource.persisted?
+      else
+        false
+      end
+    end
+
+    def model_name
+      @model_name ||= Struct.
+        new(:param_key).
+        new(param_key)
+    end
+
+    def self.param_key(key = nil)
+      if key.nil?
+        @param_key
+      else
+        @param_key = key
+      end
+    end
+
+    private
+
+    attr_reader :resource, :form_owner
+
+    def param_key
+      param_key = self.class.param_key
+      param_key ||= resource&.respond_to?(:model_name) && resource.model_name.param_key
+      raise NoParamKey if param_key.blank?
+      param_key
+    end
+
+    def build_original_attributes
+      return {} if resource.nil?
+      base_attributes = resource.respond_to?(:attributes) && resource.attributes.symbolize_keys
+
+      self.class.attribute_set.each_with_object(base_attributes || {}) do |attribute, result|
+        if result[attribute.name].blank? && resource.respond_to?(attribute.name)
+          result[attribute.name] = resource.public_send(attribute.name)
+        end
+      end
+    end
+
+    def persist
+      raise NotImplementedError, "#persist has to be implemented"
+    end
+  end
+end

data/lib/rails-patterns.rb

@@ -2,3 +2,4 @@ require "patterns"
 require "patterns/query"
 require "patterns/service"
 require "patterns/collection"
+require "patterns/form"

data/rails-patterns.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rails-patterns 0.3.0 ruby lib
+# stub: rails-patterns 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails-patterns".freeze
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Stevo".freeze]
-  s.date = "2017-04-19"
+  s.date = "2017-04-21"
   s.description = "A collection of lightweight, standardized, rails-oriented patterns.".freeze
   s.email = "b.kosmowski@selleo.com".freeze
   s.extra_rdoc_files = [
@@ -29,11 +29,13 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/patterns.rb",
     "lib/patterns/collection.rb",
+    "lib/patterns/form.rb",
     "lib/patterns/query.rb",
     "lib/patterns/service.rb",
     "lib/rails-patterns.rb",
     "rails-patterns.gemspec",
     "spec/patterns/collection_spec.rb",
+    "spec/patterns/form_spec.rb",
     "spec/patterns/query_spec.rb",
     "spec/patterns/service_spec.rb",
     "spec/spec_helper.rb"
@@ -48,17 +50,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
+      s.add_runtime_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
+      s.add_runtime_dependency(%q<virtus>.freeze, [">= 0"])
       s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
       s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     else
       s.add_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
+      s.add_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
+      s.add_dependency(%q<virtus>.freeze, [">= 0"])
       s.add_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
       s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
     end
   else
     s.add_dependency(%q<activerecord>.freeze, [">= 4.2.6"])
+    s.add_dependency(%q<actionpack>.freeze, [">= 4.2.6"])
+    s.add_dependency(%q<virtus>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
     s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])

data/spec/patterns/form_spec.rb

@@ -0,0 +1,432 @@
+RSpec.describe Patterns::Form do
+  after { Object.send(:remove_const, :CustomForm) if defined?(CustomForm) }
+
+  it "includes Virtus.model" do
+    CustomForm = Class.new(Patterns::Form)
+
+    expect(CustomForm.attribute_set).to be_kind_of(Virtus::AttributeSet)
+  end
+
+  it "includes ActiveModel::Validations" do
+    CustomForm = Class.new(Patterns::Form)
+
+    expect(CustomForm).to be < ActiveModel::Validations
+  end
+
+  describe ".new" do
+    it "returns form instance" do
+      CustomForm = Class.new(Patterns::Form)
+
+      form = CustomForm.new(double)
+
+      expect(form).to be_a_kind_of(CustomForm)
+    end
+
+    it "assigns form attributes with values passed as second argument" do
+      CustomForm = Class.new(Patterns::Form) do
+        attribute :first_name, String
+        attribute :last_name, String
+      end
+
+      form = CustomForm.new({ first_name: "Tony", last_name: "Stark" })
+
+      expect(form.first_name).to eq "Tony"
+      expect(form.last_name).to eq "Stark"
+    end
+
+    it "handles both symbols and strings as attribute keys" do
+      CustomForm = Class.new(Patterns::Form) do
+        attribute :first_name, String
+        attribute :last_name, String
+        attribute :email, String
+        attribute :age, Integer
+      end
+      resource = double(
+        attributes: {
+          "first_name" => "Bat",
+          last_name: "Man",
+          "email" => "bat@man.dev"
+        }
+      )
+
+      form = CustomForm.new(
+        resource, { first_name: "Christian", "last_name" => "Bale", "age" => 40 }
+      )
+
+      expect(form.first_name).to eq "Christian"
+      expect(form.last_name).to eq "Bale"
+      expect(form.email).to eq "bat@man.dev"
+      expect(form.age).to eq 40
+    end
+
+    context "if second parameter is ActionController::Parameters object" do
+      it "treats ActionController::Parameters as regular hash" do
+        CustomForm = Class.new(Patterns::Form) do
+          attribute :first_name, String
+          attribute :last_name, String
+        end
+
+        strong_parameters = ActionController::Parameters.new(
+          { "first_name" => "Kobe", "last_name" => "Bryant" }
+        )
+
+        form = CustomForm.new(double, strong_parameters)
+
+        expect(form.first_name).to eq "Kobe"
+        expect(form.last_name).to eq "Bryant"
+      end
+    end
+
+    context "if only parameter is ActionController::Parameters object" do
+      it "treats ActionController::Parameters as regular hash" do
+        CustomForm = Class.new(Patterns::Form) do
+          attribute :first_name, String
+          attribute :last_name, String
+        end
+
+        strong_parameters = ActionController::Parameters.new(
+          { "first_name" => "Saul", "last_name" => "Goodman" }
+        )
+
+        form = CustomForm.new(strong_parameters)
+
+        expect(form.first_name).to eq "Saul"
+        expect(form.last_name).to eq "Goodman"
+      end
+    end
+
+    it "can be initialized without providing resource" do
+      CustomForm = Class.new(Patterns::Form)
+
+      form = CustomForm.new
+
+      expect(form).to be_a_kind_of(CustomForm)
+    end
+
+    context "when resource exists" do
+      context "when resource responds to #attributes" do
+        it "assigns merged attributes from resource and passed as argument" do
+          CustomForm = Class.new(Patterns::Form) do
+            attribute :first_name, String
+            attribute :last_name, String
+          end
+          resource = double(attributes: { first_name: "Jack", last_name: "Black" })
+
+          form = CustomForm.new(resource, { first_name: "Tony" })
+
+          expect(form.first_name).to eq "Tony"
+          expect(form.last_name).to eq "Black"
+        end
+
+        it "attempts to use public getters to populate missing attributes" do
+          CustomForm = Class.new(Patterns::Form) do
+            attribute :first_name, String
+            attribute :last_name, String
+            attribute :age, Integer
+            attribute :email, String
+          end
+          resource = double(attributes: { first_name: "Jack", last_name: "Black" }, age: 27)
+
+          form = CustomForm.new(resource, { first_name: "Tony" })
+
+          expect(form.first_name).to eq "Tony"
+          expect(form.last_name).to eq "Black"
+          expect(form.age).to eq 27
+          expect(form.email).to eq nil
+        end
+      end
+
+      context "when resource does not respond to #attributes" do
+        it "assigns attributes passed as arguments" do
+          CustomForm = Class.new(Patterns::Form) do
+            attribute :first_name, String
+            attribute :last_name, String
+          end
+
+          form = CustomForm.new(double, { first_name: "Tony" })
+
+          expect(form.first_name).to eq "Tony"
+          expect(form.last_name).to eq nil
+        end
+
+        it "attempts to use public getters to populate missing attributes" do
+          CustomForm = Class.new(Patterns::Form) do
+            attribute :first_name, String
+            attribute :last_name, String
+            attribute :age, Integer
+            attribute :email, String
+          end
+          resource = double(last_name: "Black", age: 27)
+
+          form = CustomForm.new(resource, { first_name: "Tony" })
+
+          expect(form.first_name).to eq "Tony"
+          expect(form.last_name).to eq "Black"
+          expect(form.age).to eq 27
+          expect(form.email).to eq nil
+        end
+      end
+    end
+  end
+
+  describe "#save" do
+    context "when form is valid" do
+      it "requires #persist method to be implemented" do
+        CustomForm = Class.new(Patterns::Form)
+
+        form = CustomForm.new(double)
+
+        expect { form.save }.to raise_error NotImplementedError, "#persist has to be implemented"
+      end
+
+      it "returns result of #persist method" do
+        CustomForm = Class.new(Patterns::Form) do
+          private
+
+          def persist
+            10
+          end
+        end
+
+        form = CustomForm.new(double)
+        result = form.save
+
+        expect(result).to eq 10
+      end
+    end
+
+    context "when form is invalid" do
+      it "does not call #persist method" do
+        CustomForm = Class.new(Patterns::Form) do
+          private
+
+          def persist
+            raise StandardError, "Should not be raised!"
+          end
+        end
+        form = CustomForm.new(double)
+        allow(form).to receive(:valid?) { false }
+
+        expect { form.save }.to_not raise_error
+      end
+
+      it "returns false" do
+        CustomForm = Class.new(Patterns::Form) do
+          private
+
+          def persist
+            10
+          end
+        end
+        form = CustomForm.new(double)
+        allow(form).to receive(:valid?) { false }
+
+        expect(form.save).to eq false
+      end
+    end
+  end
+
+  describe "#save!" do
+    context "#save returned falsey value" do
+      it "returns Pattern::Form::Invalid exception" do
+        CustomForm = Class.new(Patterns::Form) do
+          private
+
+          def persist
+            10
+          end
+        end
+        form = CustomForm.new(double)
+        allow(form).to receive(:save) { false }
+
+        expect { form.save! }.to raise_error Patterns::Form::Invalid
+      end
+    end
+
+    context "#save returned truthy value" do
+      it "returns value returned from #save" do
+        CustomForm = Class.new(Patterns::Form) do
+          private
+
+          def persist
+            10
+          end
+        end
+        form = CustomForm.new(double)
+
+        expect(form.save!).to eq 10
+      end
+    end
+  end
+
+  describe "#as" do
+    it "saves argument in @form_owner" do
+      CustomForm = Class.new(Patterns::Form)
+      form_owner = double("Form owner")
+
+      form = CustomForm.new(double).as(form_owner)
+
+      expect(form.instance_variable_get("@form_owner")).to eq form_owner
+    end
+
+    it "returns itself" do
+      CustomForm = Class.new(Patterns::Form)
+
+      form = CustomForm.new(double)
+      result = form.as(double)
+
+      expect(result).to eq form
+    end
+  end
+
+  describe "#persisted?" do
+    context "when resource is nil" do
+      it "returns false" do
+        CustomForm = Class.new(Patterns::Form)
+
+        form = CustomForm.new
+
+        expect(form.persisted?).to eq false
+      end
+    end
+
+    context "when resource is not nil" do
+      context "when resource responds to #persisted?" do
+        it "returns resource#persisted?" do
+          CustomForm = Class.new(Patterns::Form)
+
+          form_1 = CustomForm.new(double(persisted?: true))
+          form_2 = CustomForm.new(double(persisted?: false))
+
+          expect(form_1.persisted?).to eq true
+          expect(form_2.persisted?).to eq false
+        end
+      end
+
+      context "when resource does not respond to #persisted?" do
+        it "returns false" do
+          CustomForm = Class.new(Patterns::Form)
+
+          form = CustomForm.new(double)
+
+          expect(form.persisted?).to eq false
+        end
+      end
+    end
+  end
+
+  describe "#to_model" do
+    it "retruns itself" do
+      CustomForm = Class.new(Patterns::Form)
+
+      form = CustomForm.new(double)
+
+      expect(form.to_model).to eq form
+    end
+  end
+
+  describe "#to_partial_path" do
+    it "returns nil" do
+      CustomForm = Class.new(Patterns::Form)
+
+      form = CustomForm.new(double)
+
+      expect(form.to_partial_path).to eq nil
+    end
+  end
+
+  describe "#to_key" do
+    it "returns nil" do
+      CustomForm = Class.new(Patterns::Form)
+
+      form = CustomForm.new(double)
+
+      expect(form.to_key).to eq nil
+    end
+  end
+
+  describe "#model_name" do
+    describe "#param_key" do
+      context "resource exists" do
+        context "resource responds to #model_name" do
+          context "param_key is not defined" do
+            it "returns object responding to #param_key returning resource#param_key" do
+              CustomForm = Class.new(Patterns::Form)
+              resource = double(model_name: double(param_key: "resource_key"))
+
+              form = CustomForm.new(resource)
+              result = form.model_name
+
+              expect(result).to respond_to(:param_key)
+              expect(result.param_key).to eq "resource_key"
+            end
+          end
+
+          context "param_key is defined" do
+            it "returns param_key" do
+              CustomForm = Class.new(Patterns::Form) do
+                param_key "test_key"
+              end
+              resource = double(model_name: double(param_key: "resource_key"))
+
+              form = CustomForm.new(resource)
+              result = form.model_name
+
+              expect(result.param_key).to eq "test_key"
+            end
+          end
+        end
+
+        context "resource does not respond to #model_name" do
+          context "param_key is not defined" do
+            it "raises NoParamKey" do
+              CustomForm = Class.new(Patterns::Form)
+
+              form = CustomForm.new(double)
+
+              expect { form.model_name }.to raise_error(Patterns::Form::NoParamKey)
+            end
+          end
+
+          context "param_key is defined" do
+            it "returns param_key" do
+              CustomForm = Class.new(Patterns::Form) do
+                param_key "test_key"
+              end
+
+              form = CustomForm.new(double)
+              result = form.model_name
+
+              expect(result.param_key).to eq "test_key"
+            end
+          end
+        end
+      end
+
+      context "resource does not exist" do
+        context "param_key is not defined" do
+          it "raises NoParamKey" do
+            CustomForm = Class.new(Patterns::Form)
+
+            form = CustomForm.new
+
+            expect { form.model_name }.to raise_error(Patterns::Form::NoParamKey)
+          end
+        end
+
+        context "param_key is defined" do
+          it "returns param_key" do
+            CustomForm = Class.new(Patterns::Form) do
+              param_key "test_key"
+            end
+
+            form = CustomForm.new
+            result = form.model_name
+
+            expect(result.param_key).to eq "test_key"
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-patterns
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stevo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,11 +112,13 @@ files:
 - VERSION
 - lib/patterns.rb
 - lib/patterns/collection.rb
+- lib/patterns/form.rb
 - lib/patterns/query.rb
 - lib/patterns/service.rb
 - lib/rails-patterns.rb
 - rails-patterns.gemspec
 - spec/patterns/collection_spec.rb
+- spec/patterns/form_spec.rb
 - spec/patterns/query_spec.rb
 - spec/patterns/service_spec.rb
 - spec/spec_helper.rb