syrup_form_object 0.0.4 → 0.0.5

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -1,9 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-group :development do
-  gem 'rake',  '~> 10.1.0'
-  gem 'rspec', '~> 2.14.1'
-  gem 'yard',  '~> 0.8.7'
-end

data/README.md

@@ -1,76 +1,91 @@
 #Syrup::FormObject
 
+[![Gem Version](https://badge.fury.io/rb/syrup_form_object.png)][gem]
+[![Build Status](https://travis-ci.org/alexsiri7/syrup_form_object.png?branch=master)][travis]
+
+[gem]: http://badge.fury.io/rb/syrup_form_object
+[travis]: https://travis-ci.org/alexsiri7/syrup_form_object
+
+
 This is a simple implementation of the FormObject... pattern?
 
 ##Installation
-
-    gem install syrup_form_object
+``` terminal
+$ gem install syrup_form_object
+```
 
 or in the *Gemfile*
-
-    gem 'syrup_form_object'
+``` ruby
+gem 'syrup_form_object'
+```
 
 ##Examples
 
 To update the ```Event``` class in your model
-
-    class Event < ActiveRecord::Base
-      validates :start_date, presence: true
-      validates :end_date, presence: true
-    end
+``` ruby
+class Event < ActiveRecord::Base
+  validates :start_date, presence: true
+  validates :end_date, presence: true
+end
+```
 
 You create the follwing form
 
-    class EventCreateForm < Syrup::FormObject
-      has_one :event
-      accepts_nested_attributes_for :event
-
-      attribute :length_of_the_event, Integer
-      validates :length_of_the_event, numericality:{greater_than: 0}
-
-      def save
-        if self.valid?
-          end_date = event.start_date + length_of_the_event.hours
-          event.end_date = end_date
-          event.save
-        else
-          false
-        end
-      end
+``` ruby
+class EventCreateForm < Syrup::FormObject
+  has_one :event
+  accepts_nested_attributes_for :event
+
+  attribute :length_of_the_event, Integer
+  validates :length_of_the_event, numericality:{greater_than: 0}
+
+  def save
+    if self.valid?
+      end_date = event.start_date + length_of_the_event.hours
+      event.end_date = end_date
+      event.save
+    else
+      false
     end
+  end
+end
+```
 
 Create a controller similar to this one
 
-    class EventController < ApplicationController
-      def new
-        @event_form = EventCreateForm.new
-      end
-
-      def create
-        @event_form = EventCreateForm.new(create_params)
-        if @event_form.save
-          redirect_to @event_form.event
-        else
-          render :new
-        end
-      end
-
-      def create_params
-        params.require(:event_create_form)
-          .permit(:length_of_the_event)
-          .permit(event_attributes: [:start_date])
-      end
+``` ruby
+class EventController < ApplicationController
+  def new
+    @event_form = EventCreateForm.new
+  end
+
+  def create
+    @event_form = EventCreateForm.new(create_params)
+    if @event_form.save
+      redirect_to @event_form.event
+    else
+      render :new
     end
+  end
 
+  def create_params
+    params.require(:event_create_form)
+      .permit(:length_of_the_event)
+      .permit(event_attributes: [:start_date])
+  end
+end
+```
 
 And in the template:
 
-    <%= form_for @event_form do %>
-      <%= fields_for :event do %>
-        <%= input_tag :start_date  %>
-      <% end %>
-      <%= input_tag :length_of_the_event  %>
-    <% end %>
+``` erb
+<%= form_for @event_form do %>
+  <%= fields_for :event do %>
+    <%= input_tag :start_date  %>
+  <% end %>
+  <%= input_tag :length_of_the_event  %>
+<% end %>
+```
 
 
 ##Some sources for Form Objects

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/syrup/form_object.rb

@@ -37,12 +37,36 @@ class Syrup::FormObject
       attr_accessor klass
     end
 
+    attr_accessor :wrapped_class
 
+    def wraps(klass)
+      wrapped_class = klass
+      has_one(klass)
+      alias_method :wrapped, klass
+      alias_method :wrapped=, "#{klass}="
+
+    end
+
+    def find(params)
+      form = self.new
+      form.find_relations(params)
+      form.after_find(params)
+      form
+    end
+
+  end
+
+  def method_missing(*params)
+    wrapped.send *params
+  end
+
+  def responds_to?(*params)
+    super || wrapped.responds_to?(*params)
   end
 
   def initialize(params={})
     build_relations
-    build
+    build(params)
     assign_parameters(params)
   end
 
@@ -52,6 +76,18 @@ class Syrup::FormObject
     end
   end
 
+  def find_relations(params)
+    if params.is_a?(Hash)
+      self.class.relations.each do |klass|
+        if params[klass]
+          self.send "#{klass}=", klass.to_s.camelize.constantize.find(params[klass])
+        end
+      end
+    else
+      self.wrapped= self.wrapped.class.find(params)
+    end
+  end
+
   def assign_parameters(params)
     @params = params
     params.each do |key, value|
@@ -59,7 +95,8 @@ class Syrup::FormObject
     end
   end
 
-  def build; end
+  def build(params); end
+  def after_find(params); end
 
   def persisted?
     false

data/lib/syrup/version.rb

@@ -1,3 +1,3 @@
 module Syrup
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/lib/syrup/form_object_spec.rb

@@ -3,14 +3,13 @@ require 'spec_helper'
 class TestItem
   include Virtus.model
   attribute :test_item_value, Integer
+
+  def self.find(id)
+  end
 end
 
 class TestSubclass < Syrup::FormObject
-  attribute :test_value, String
-  has_one :test_item
-  accepts_nested_attributes_for :test_item
-
-  def build
+  def build(params)
     @built = true
   end
 
@@ -18,37 +17,155 @@ class TestSubclass < Syrup::FormObject
     @built
   end
 
+  def after_find(params)
+    @after_find = true
+  end
+
+  def has_called_after_find?
+    @after_find
+  end
+end
+
+shared_examples 'successful create' do
+  it 'creates a new object' do
+    expect(subject).to be_a(Syrup::FormObject)
+  end
+  it 'calls the build method' do
+    expect(subject).to have_called_build
+  end
 end
 
 describe Syrup::FormObject do
-  subject { TestSubclass.new(params) }
-  let(:params) { {} }
-  context '#new' do
-    context 'with no attributes' do
-      it 'creates a new object' do
-        expect(subject).to be_a(Syrup::FormObject)
+  context 'when using simple attributes' do
+    let(:test_subclass) {
+      Class.new(TestSubclass) do
+        attribute :test_value, String
+      end
+    }
+    describe '#new' do
+      subject { test_subclass.new(params) }
+      let(:params) { {} }
+      include_examples 'successful create'
+      context 'with a params hash' do
+        let(:params) { {test_value: 'a Test'} }
+
+        include_examples 'successful create'
+
+        it 'assigns the parameters in the right places' do
+          expect(subject.test_value).to eq 'a Test'
+        end
+      end
+    end
+    pending '#save'
+    describe '::find' do
+      subject { test_subclass.find(params) }
+      let(:params) { {} }
+      it 'calls the after_find method' do
+        expect(subject).to have_called_after_find
+      end
+    end
+
+  end
+  context 'when using nested attributes' do
+    let(:test_subclass) {
+      Class.new(TestSubclass) do
+        has_one :test_item
+        accepts_nested_attributes_for :test_item
+      end
+    }
+    describe '#new' do
+      subject { test_subclass.new(params) }
+      let(:params) { {} }
+      include_examples 'successful create' do
+        it 'creates the nested object' do
+          expect(subject.test_item).to be_a(TestItem)
+        end
+      end
+
+      context 'with a params hash' do
+        let(:params) {{ test_item_attributes: {
+                           test_item_value: '2'}}}
+
+        include_examples 'successful create'
+
+        it 'assigns the parameters in the nested attributes' do
+          expect(subject.test_item.test_item_value).to eq 2
+        end
       end
-      it 'calls the build method' do
-        expect(subject).to have_called_build
+    end
+
+    pending '#save'
+    describe '::find' do
+      subject { test_subclass.find(params) }
+      let(:params) { {test_item: 2} }
+
+      it 'loads the test_item from the attributes sent' do
+        TestItem.should_receive(:find).once { TestItem.new }
+
+        expect(subject.test_item).to be_a(TestItem)
+      end
+      it 'calls the after_find method' do
+        expect(subject).to have_called_after_find
       end
     end
-    context 'with a params hash' do
-      let(:params) {{ test_value: 'a Test',
-                       test_item_attributes: {
-                         test_item_value: '2'}}}
-      it 'creates a new object' do
-        expect(subject).to be_a(Syrup::FormObject)
+
+  end
+
+  context 'when using a wrapped object' do
+    let(:test_subclass) {
+      Class.new(TestSubclass) do
+        wraps :test_item
+      end
+    }
+    describe '#new' do
+      subject { test_subclass.new(params) }
+      let(:params) { {} }
+      include_examples 'successful create' do
+        it 'creates the wrapped object' do
+          expect(subject.test_item).to be_a(TestItem)
+        end
+
+        it 'creates the wrapped object' do
+          expect(subject.wrapped).to be_a(TestItem)
+        end
       end
-      it 'assigns the parameters in the right places' do
-        expect(subject.test_value).to eq 'a Test'
+
+      context 'with a params hash' do
+        let(:params) {{ test_item_value: '2' }}
+
+        include_examples 'successful create' do
+          it 'creates the wrapped object' do
+            expect(subject.test_item).to be_a(TestItem)
+          end
+
+          it 'creates the wrapped object' do
+            expect(subject.wrapped).to be_a(TestItem)
+          end
+        end
+
+        it 'assigns the parameters to the object' do
+          expect(subject.test_item.test_item_value).to eq 2
+        end
+
+        it 'has an accesor to the parameter' do
+          expect(subject.test_item_value).to eq 2
+        end
       end
-      it 'assigns the parameters in the nested attributes' do
-        expect(subject.test_item.test_item_value).to eq 2
+    end
+
+    pending '#save'
+    describe '::find' do
+      subject { test_subclass.find(params) }
+      let(:params) { 2 }
+
+      it 'loads the test_item from the id sent' do
+      end
+      it 'calls the after_find method' do
+        expect(subject).to have_called_after_find
       end
     end
+
   end
 
-  pending '#save'
-  pending '::find'
 
 end

data/syrup_form_object.gemspec

@@ -16,5 +16,7 @@ Gem::Specification.new do |gem|
   gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
   gem.extra_rdoc_files = %w[LICENSE README.md]
 
-  gem.add_dependency('virtus', '~> 1.0.0')
+  gem.add_dependency('virtus', '~> 1.0')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syrup_form_object
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-10 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,39 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Form Objects for ActiveRecord
 email:
 - alexsiri7@gmail.com
@@ -38,9 +70,11 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - lib/syrup.rb
 - lib/syrup/form_object.rb
 - lib/syrup/version.rb