encore 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6425ceec678f308c80da211bf16946506b2c704
-  data.tar.gz: 481ae8d7b56757c499fa9cebae51f6eb635052e5
+  metadata.gz: c05497c6b6640c47a20eafba79c3eb344cc523a6
+  data.tar.gz: 1e727f1662fdf0927f940e0a4d46fa5054073d88
 SHA512:
-  metadata.gz: e7c056d64a6c7d8341fa8728255b1c37da9156e9f3800245911069c345a6a2250fbf91aa3a531417c4c7f7e668e08b4579448e393582f980d9e04434ae148bc0
-  data.tar.gz: 717a8560dee3c08e3bf6cbf3e05b5239dcd5273e16c2df82b99eb93ab36d2357f1a80a61bc155c14b7473f6302d0ddb99d2bfe87fc75dcfa682cdade62ce9fe6
+  metadata.gz: 2b0c3d9175e9665cb709d725cf48873f2c16a4b9fb4100af1dafc07f087a9a9a075fbb8492822624a186386f4b5a0e7f25c560fdfd3b02dee4efd43e89820157
+  data.tar.gz: 46d9c310cdaed3ea98051dea98f3a463137468f512abadfd62019553e74dd4c35e0c88d9531f14d47c289b358b516d82ed2e208b6f1059ba87fb3d1a5796c7f2

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/Gemfile.activerecord-4.0
+  - gemfiles/Gemfile.activerecord-3.2.x
+
+script: "echo 'DO IT' && bundle exec rake spec"

data/README.md

@@ -1,6 +1,16 @@
-# Encore
-
-Encore is a framework built on top of ActiveRecord to manage entities.
+<p align="center">
+  <a href="https://github.com/mirego/encore">
+    <img src="http://i.imgur.com/erXBozp.png" alt="Encore" />
+  </a>
+  <br />
+  Encore is a Ruby framework to help dealing with entities.
+  <br /><br />
+  <a href="https://rubygems.org/gems/encore"><img src="https://badge.fury.io/rb/encore.png" /></a>
+  <a href="https://codeclimate.com/github/mirego/encore"><img src="https://codeclimate.com/github/mirego/encore.png" /></a>
+  <a href="https://travis-ci.org/mirego/encore"><img src="https://travis-ci.org/mirego/encore.png?branch=master" /></a>
+</p>
+
+---
 
 ## Installation
 
@@ -24,6 +34,109 @@ $ gem install encore
 
 ## Usage
 
+Let’s say we have the `UserEntity` entity class bound to the `User` model:
+
+```ruby
+class User < ActiveRecord::Base
+end
+
+class UserEntity
+  include Encore::Entity
+
+  expose :name
+  expose :email
+  expose :created_at, readonly: true
+  expose :updated_at, readonly: true
+end
+```
+
+We can create a new `User` resource with attributes:
+
+```ruby
+@entity = UserEntity.new
+@entity.assign_attributes email: 'remi@example.com', name: 'Rémi Prévost'
+@entity.save
+```
+
+When assigning attributes to an entity, we can pass either an `:update` or a `:partial_update` context.
+
+With the (default) `:partial_update` context, Encore will assign new attributes and ignore the other exposed attributes. This makes sense in a `PATCH` HTTP request context.
+
+```ruby
+new_attributes = { email: 'remi+new@example.com' }
+@entity.assign_attributes new_attributes
+@entity.object.email # => "remi+new@example.com"
+@entity.object.name # => "Rémi Prévost"
+```
+
+However, with the `:update` context, Encore will assign new attributes and set all non-provided exposed attributes to `nil`. This
+makes sense in a `PUT` HTTP request context.
+
+```ruby
+new_attributes = { email: 'remi+new-again@example.com' }
+@entity.assign_attributes new_attributes, context: :update
+@entity.object.email # => "remi+new-again@example.com"
+@entity.object.name # => nil
+```
+
+If we try to assign a value to a non-exposed or readonly attribute, Encore will raise an error.
+
+```ruby
+@entity.assign_attributes email: 'remi+new@example.com', created_at: Time.now
+# => raises #<Encore::Entity::Input::InvalidAttributeError: The #<Encore::Attribute UserEntity@created_at> attribute is not exposed.>
+```
+
+### Associations
+
+You can also expose associations.
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :organization
+end
+
+class Organization < ActiveRecord::Base
+  has_many :users
+end
+
+class UserEntity
+  include Encore::Entity
+
+  expose :name
+  expose_one :organization
+end
+```
+
+Assigning new value for associations doesn’t save them right away.
+
+```ruby
+@user = User.first # => #<User id=1 organization_id=1>
+@entity = UserEntity.new(@user)
+@entity.assign_attributes organization: 2
+@entity.object.organization_id # => 1
+```
+
+Calling `save` on the entity saves them.
+
+```ruby
+@entity.save
+@entity.object.organization_id # => 2
+```
+
+## Typical setup with Ruby on Rails
+
+_This is work-in-progress. There’s still missing stuff._
+
+### Model
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+end
+```
+
+### Entity
+
 ```ruby
 # app/entities/user_entity.rb
 class UserEntity
@@ -34,43 +147,81 @@ class UserEntity
   expose :created_at, readonly: true
   expose :updated_at, readonly: true
 end
+```
+
+### Routes
+
+```ruby
+# config/routes.rb
+Rails::Application.routes.draw do
+  resources :users do
+    # This makes Rails route PUT and PATCH requests to two separate actions
+    patch on: :member, action: :partial_update
+  end
+end
+```
+
+### Controller
 
+```ruby
 # app/controllers/users_controller.rb
 class UsersController < ApplicationController
+  before_action :fetch_user, only: [:update, :partial_update]
+
   # POST /users
   def create
-    @user = UserEntity.new
-    @user.assign_attributes(params[:user], context: :create)
-
-    if @user.save
-      render json: @user, status: 201
-    else
-      render json: { errors: @user.errors }, status: 422
-    end
+    @entity = UserEntity.new
+    @entity.assign_attributes(params[:user], context: :create)
+
+    process! @entity
+
+    # Here, `process!` is a shortcut for:
+    #
+    # if @entity.save
+    #   render json: @entity, status: 201
+    # else
+    #   render json: { errors: @entity.errors }, status: 422
+    # end
   end
 
   # PUT /users/:id
   def update
-    @user = UserEntity.new User.find(params[:id])
-    @user.assign_attributes(params[:user], context: :update)
-
-    if @user.save
-      render json: @user
-    else
-      render json: { errors: @user.errors }, status: 422
-    end
+    @entity = UserEntity.new(@user)
+    @entity.assign_attributes(params[:user], context: :update)
+
+    process! @entity
   end
 
   # PATCH /users/:id
   def partial_update
-    @user = UserEntity.find User.find(params[:id])
-    @user.assign_attributes(params[:user], context: :partial_update)
-
-    if @user.save
-      render json: @user
-    else
-      render json: { errors: @user.errors }, status: 422
-    end
+    @entity = UserEntity.new(@user)
+    @entity.assign_attributes(params[:user], context: :partial_update)
+
+    process! @entity
+  end
+
+protected
+
+  def fetch_user
+    @user = User.find(params[:id])
   end
 end
 ```
+
+## Todo
+
+Please keep in mind that this gem is far from finished and totally not ready to use in production.
+This is something we’ve been wanting to build for a long time and now we’re finally taking the time
+do it right.
+
+## License
+
+`Encore` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/encore/blob/master/LICENSE.md) file.
+
+The nut logo is based on [this lovely icon](http://thenounproject.com/noun/hazelnuts/#icon-No3618) by [Alessandro Suraci](http://thenounproject.com/alessandro.suraci/), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.
+
+## About Mirego
+
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly build mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development") in beautiful Quebec City.
+
+We also love [open-source software](http://open.mirego.com/) and we try to extract as much code as possible from our projects to give back to the community.

data/encore.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Encore::VERSION
   spec.authors       = ['Rémi Prévost']
   spec.email         = ['rprevost@mirego.com']
-  spec.description   = 'Encore is a framework built on top of ActiveRecord to manage entities.'
+  spec.description   = 'Encore is a Ruby framework to help dealing with entities.'
   spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/remiprev/encore'
+  spec.homepage      = 'https://github.com/mirego/encore'
   spec.license       = "BSD 3-Clause"
 
   spec.files         = `git ls-files`.split($/)
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rails', '>= 3.0.0'
 
-  spec.add_dependency 'activerecord', '>= 3.0.0'
   spec.add_dependency 'activesupport', '>= 3.0.0'
 end

data/gemfiles/Gemfile.activerecord-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 3.2.0'

data/gemfiles/Gemfile.activerecord-4.0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'

data/lib/encore/association/has_many_association.rb

@@ -0,0 +1,12 @@
+module Encore
+  class Association
+    class HasManyAssociation < Association
+
+    protected
+
+      def column_accessor
+        :"#{self.column.to_s.singularize}_ids"
+      end
+    end
+  end
+end

data/lib/encore/association/has_one_association.rb

@@ -0,0 +1,12 @@
+module Encore
+  class Association
+    class HasOneAssociation < Association
+
+    protected
+
+      def column_accessor
+        :"#{self.column}_id"
+      end
+    end
+  end
+end

data/lib/encore/association.rb

@@ -0,0 +1,39 @@
+module Encore
+  class Association < Attribute
+    def initialize(*args)
+      super
+
+      # Create a temporary accessor to store new values
+      @klass.send :attr_accessor, self.tmp_column_accessor
+
+      # Add callback on `before_save` to apply new values
+      association = self
+      @klass.before_save lambda { association.apply(self) }
+    end
+
+    # Store the value in a temporary accessor used by the `before_save` callback
+    def assign(object, value)
+      object.send :"#{tmp_column_accessor}=", value
+    end
+
+    # Apply the new value to the column and reset the temporary accessor
+    def apply(object)
+      object.send :"#{column_accessor}=", object.send(tmp_column_accessor)
+      object.send :"#{tmp_column_accessor}=", nil
+    end
+
+    # Return the value of the association
+    def fetch(object)
+      object.send :"#{column_accessor}"
+    end
+
+  protected
+
+    def tmp_column_accessor
+      :"encore_tmp_#{column_accessor}"
+    end
+  end
+end
+
+require 'encore/association/has_one_association'
+require 'encore/association/has_many_association'

data/lib/encore/attribute.rb

@@ -1,17 +1,20 @@
 module Encore
   class Attribute
-    attr_reader :attribute, :klass
+    attr_reader :attribute, :klass, :column, :opts
 
-    def initialize(klass, attribute, opts = {})
+    def initialize(klass, column, opts = {})
       @klass = klass
-      @attribute = attribute
+      @column = column
+      @attribute = opts[:as].try(:to_sym) || @column
       @opts = opts
     end
 
-    def self.map_attributes(klass, params)
-      params.inject({}) do |memo, (attribute, value)|
-        memo.merge Attribute.new(klass, attribute.to_sym) => value
-      end
+    def assign(object, value)
+      object.send :"#{self.column}=", value
+    end
+
+    def fetch(object)
+      object.send :"#{self.column}"
     end
 
     def ==(other_attribute)

data/lib/encore/entity/input/associations.rb

@@ -0,0 +1,27 @@
+module Encore
+  module Entity
+    module Input
+      module Associations
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def expose_one(column, opts = {})
+            expose_association(:one, column, opts)
+          end
+
+          def expose_many(column, opts = {})
+            expose_association(:many, column, opts)
+          end
+
+        protected
+
+          def expose_association(type, column, opts)
+            @exposed_attributes ||= []
+            association_class = Encore::Association.const_get("Has#{type.to_s.capitalize}Association")
+            @exposed_attributes << association_class.new(self, column.to_sym, opts)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/encore/entity/input/errors.rb

@@ -1,7 +1,7 @@
 module Encore
   module Entity
     module Input
-      class ProtectedAttributeError < StandardError
+      class InvalidAttributeError < StandardError
       end
     end
   end

data/lib/encore/entity/input/exposed_attributes.rb

@@ -6,14 +6,9 @@ module Encore
 
         module ClassMethods
           # Declare a new exposed attribute
-          def expose(attribute, opts = {})
+          def expose(column, opts = {})
             @exposed_attributes ||= []
-            @exposed_attributes << Encore::Attribute.new(self, attribute.to_sym, opts)
-          end
-
-          # Return only the attribute keys for each exposed attribute
-          def exposed_attributes_list
-            @exposed_attributes.map(&:attribute)
+            @exposed_attributes << Encore::Attribute.new(self, column.to_sym, opts)
           end
 
           # Return whether an attribute is exposed by the entity
@@ -26,6 +21,11 @@ module Encore
             modifiable_attributes.include?(attribute)
           end
 
+          # Return a list of all exposed attributes
+          def exposed_attributes
+            @exposed_attributes
+          end
+
           # Return a list of all attributes that can be modified
           def modifiable_attributes
             @exposed_attributes.reject(&:readonly?)

data/lib/encore/entity/input.rb

@@ -1,5 +1,6 @@
 require 'encore/entity/input/errors'
 require 'encore/entity/input/exposed_attributes'
+require 'encore/entity/input/associations'
 
 module Encore
   module Entity
@@ -7,48 +8,66 @@ module Encore
       extend ActiveSupport::Concern
 
       included do
+        extend ActiveModel::Callbacks
         include Encore::Entity::Input::ExposedAttributes
+        include Encore::Entity::Input::Associations
+        define_model_callbacks :save
 
         # Expose ID as a readonly attribute
         expose :id, readonly: true
+
+        # Make the context accessible
+        attr_reader :context
       end
 
       # Assign specific attribute to the object
       def assign_attributes(attributes = {}, opts = nil)
         # Find the right context
-        unless context = opts.try(:delete, :context)
-          context = @object.persisted? ? :create : :partial_update
+        unless @context = opts.try(:delete, :context)
+          @context = @object.persisted? ? :partial_update : :create
         end
 
         # Convert attribute keys to Attribute objects
-        attributes = Encore::Attribute.map_attributes(self.class, attributes)
+        attributes = self.class.map_attributes(self.class, attributes)
 
         # Loop through every passed attribute and set it
-        assign_provided_attributes(attributes, context)
+        assign_provided_attributes(attributes)
 
         # If we're doing an update, for any exposed attribute that wasn't passed, set it to nil
-        reset_forgotten_attributes(attributes, context)
+        reset_forgotten_attributes(attributes)
       end
 
     protected
 
-      def assign_provided_attributes(attributes, context)
+      def assign_provided_attributes(attributes)
         attributes.each_pair do |attribute, value|
           if self.class.modifiable_attribute?(attribute)
-            send :"#{attribute.attribute}=", value
+            attribute.assign(self, value)
           else
-            raise Encore::Entity::Input::ProtectedAttributeError.new("The #{attribute} attribute is not exposed.")
+            raise Encore::Entity::Input::InvalidAttributeError.new("The #{attribute} attribute is not exposed.")
           end
         end
       end
 
-      def reset_forgotten_attributes(attributes, context)
-        if context == :update
+      def reset_forgotten_attributes(attributes)
+        if @context == :update
           (self.class.modifiable_attributes - attributes.keys).each do |attribute|
-            send :"#{attribute.attribute}=", nil
+            attribute.assign(self, nil)
           end
         end
       end
+
+      module ClassMethods
+        def map_attributes(klass, params)
+          params.inject({}) do |memo, (attribute, value)|
+            exposed_attribute = klass.exposed_attributes.detect { |a| a.attribute == attribute }
+            key = exposed_attribute || Attribute.new(klass, attribute.to_sym)
+
+            memo.merge key => value
+          end
+        end
+
+      end
     end
   end
 end

data/lib/encore/entity/output/json.rb

@@ -0,0 +1,14 @@
+module Encore
+  module Entity
+    module Output
+      module JSON
+        # Return each exposed attribute as a JSON value
+        def as_json(args = {})
+          self.class.exposed_attributes.inject({}) do |memo, item|
+            memo.merge item.attribute => item.fetch(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/encore/entity/output.rb

@@ -1,7 +1,13 @@
+require 'encore/entity/output/json'
+
 module Encore
   module Entity
     module Output
       extend ActiveSupport::Concern
+
+      included do
+        include Encore::Entity::Output::JSON
+      end
     end
   end
 end

data/lib/encore/entity.rb

@@ -19,9 +19,18 @@ module Encore
       @object = object || self.class.linked_class.new
     end
 
+    # Save the object
+    def save
+      run_callbacks(:save) { @object.save }
+    end
+
     # Delegate everything to the object
     def method_missing(method, *args, &blk)
-      @object.send(method, *args, &blk)
+      if @object.respond_to?(method)
+        @object.send(method, *args, &blk)
+      else
+        super
+      end
     end
 
     module ClassMethods

data/lib/encore/helpers/controller_helper.rb

@@ -0,0 +1,37 @@
+module Encore
+  module Helpers
+    module ControllerHelper
+      HTTP_ERROR_STATUS_CODE = 422
+      HTTP_SUCCESS_CODE = 200
+      HTTP_SUCCESS_CREATED_CODE = 201
+
+      # Inject itself into the ActionController::Base class
+      def self.inject_into_action_controller
+        ::ActionController::Base.send :include, self
+      end
+
+      # Save the entity and return a JSON response
+      def process!(entity)
+        error_status = HTTP_ERROR_STATUS_CODE
+        success_status = success_status_code_from_entity(entity)
+
+        if entity.save
+          render json: entity, status: success_status
+        else
+          render json: { errors: entity.errors }, status: error_status
+        end
+      end
+
+    protected
+
+      # Return the status code to send after a successful processing
+      # of an entity, depending on its context
+      def success_status_code_from_entity(entity)
+        case entity.context
+          when :create then HTTP_SUCCESS_CREATED_CODE
+          else              HTTP_SUCCESS_CODE
+        end
+      end
+    end
+  end
+end

data/lib/encore/helpers.rb

@@ -0,0 +1 @@
+require 'encore/helpers/controller_helper'

data/lib/encore/railtie.rb

@@ -0,0 +1,11 @@
+require 'encore'
+require 'rails'
+require 'action_controller'
+
+module Encore
+  class Railtie < Rails::Railtie
+    initializer 'encore.action_controller' do |app|
+      ActiveSupport.on_load :action_controller, {}, &Encore::Helpers::ControllerHelper.inject_into_action_controller
+    end
+  end
+end

data/lib/encore/version.rb

@@ -1,3 +1,3 @@
 module Encore
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/encore.rb

@@ -3,9 +3,11 @@ require 'encore/version'
 # ActiveSupport
 require 'active_support'
 
-# ActiveRecord
-require 'active_record'
-
 # Encore
 require 'encore/entity'
 require 'encore/attribute'
+require 'encore/association'
+require 'encore/helpers'
+
+# Railtie
+require 'encore/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/spec/encore/entity/input/associations_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Encore::Entity::Input::Associations do
+  describe :ClassMethods do
+    describe :has_one do
+      before do
+        spawn_model(:User) { belongs_to :organization }
+        spawn_model(:Organization) { has_many :users }
+
+        spawn_entity :UserEntity do
+          expose :name
+          expose_one :organization
+        end
+
+        run_migration do
+          create_table(:users, force: true) do |t|
+            t.string :name
+            t.integer :organization_id
+            t.timestamps
+          end
+
+          create_table(:organizations, force: true)
+        end
+      end
+
+      let(:organization) { Organization.create }
+      let(:other_organization) { Organization.create }
+      let(:user) { organization.users.create(name: 'Art Vandelay') }
+      let(:entity) { UserEntity.new(user) }
+
+      context 'when assigning attributes' do
+        before { entity.assign_attributes organization: other_organization.id }
+        it { expect(entity.object.organization_id).to eql organization.id }
+        it { expect(entity.encore_tmp_organization_id).to eql other_organization.id }
+      end
+
+      context 'when saving the entity' do
+        before do
+          entity.assign_attributes organization: other_organization.id
+          entity.save
+        end
+
+        it { expect(entity.object.organization_id).to eql other_organization.id }
+        it { expect(entity.encore_tmp_organization_id).to be_nil }
+      end
+    end
+  end
+end

data/spec/encore/entity/input/exposed_attributes_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Encore::Entity::Input::ExposedAttributes do
+  shared_examples 'exposability' do
+    before do
+      spawn_object_class!
+    end
+
+    context 'with attribute name' do
+      it { expect{ entity.assign_attributes(name: 'Art Vandelay') }.to raise_error(Encore::Entity::Input::InvalidAttributeError) }
+    end
+
+    context 'with column name' do
+      before { entity.assign_attributes fullname: 'Art Vandelay' }
+      it { expect(entity.object.name).to eql 'Art Vandelay' }
+    end
+  end
+
+  let(:entity) { UserEntity.new }
+
+  before do
+    spawn_entity :UserEntity do
+      expose :name, as: :fullname
+    end
+  end
+
+  context 'with ActiveRecord model' do
+    let(:spawn_object_class!) do
+      spawn_model :User
+
+      run_migration do
+        create_table(:users, force: true) do |t|
+          t.string :name
+          t.timestamps
+        end
+      end
+    end
+
+    it_has_behavior 'exposability'
+  end
+
+  context 'with OpenStruct structure' do
+    let(:spawn_object_class!) { spawn_struct :User }
+    it_has_behavior 'exposability'
+  end
+end

data/spec/{poutine/entity_spec.rb → encore/entity/input_spec.rb}

@@ -1,79 +1,79 @@
 require 'spec_helper'
 
-describe Encore::Entity do
-  before do
-    spawn_model :User
-
-    spawn_entity :UserEntity do
-      expose :name
-      expose :email
-      expose :created_at, readonly: true
-      expose :updated_at, readonly: true
-    end
+describe Encore::Entity::Input do
+  describe :InstanceMethods do
+    describe :assign_attributes do
+      before do
+        spawn_model :User
+
+        spawn_entity :UserEntity do
+          expose :name
+          expose :email
+          expose :created_at, readonly: true
+          expose :updated_at, readonly: true
+        end
 
-    run_migration do
-      create_table(:users, force: true) do |t|
-        t.string :email
-        t.string :name
-        t.timestamps
+        run_migration do
+          create_table(:users, force: true) do |t|
+            t.string :email
+            t.string :name
+            t.timestamps
+          end
+        end
       end
-    end
-  end
 
-  describe :InstanceMethods do
-    describe :assign_attributes do
       let(:assign_attributes!) { entity.assign_attributes attributes, context: context }
 
       context 'with :create context' do
         let(:entity) { UserEntity.new }
-        let(:attributes) { { email: 'remi@example.com' } }
+        let(:attributes) { { email: 'art@vandelay.com' } }
         let(:context) { :create }
 
         before { assign_attributes! }
 
-        it { expect(entity.object.email).to eql 'remi@example.com' }
+        it { expect(entity.object.email).to eql 'art@vandelay.com' }
         it { expect(entity.object.name).to be_blank }
         it { expect(entity.object.created_at).to be_blank }
         it { expect(entity.object.updated_at).to be_blank }
       end
 
-      context 'with :update context', focus: true do
+      context 'with :update context' do
         let(:entity) { UserEntity.new(User.first) }
         let(:context) { :update }
-        let(:create_user!) { User.create(email: 'remi@example.com', name: 'Rémi Prévost') }
+        let(:create_user!) { User.create(email: 'art@vandelay.com', name: 'Art Vandelay') }
 
         before { create_user! }
 
         context 'when updating valid attributes' do
-          let(:attributes) { { email: 'remi+test@example.com' } }
+          let(:attributes) { { email: 'art+test@vandelay.com' } }
           before { assign_attributes! }
 
-          it { expect(entity.object.email).to eql 'remi+test@example.com' }
+          it { expect(entity.object.email).to eql 'art+test@vandelay.com' }
           it { expect(entity.object.name).to be_blank }
           it { expect(entity.object.created_at).to_not be_blank }
           it { expect(entity.object.updated_at).to_not be_blank }
         end
 
         context 'when updating a protected attribute' do
-          let(:attributes) { { email: 'remi+test@example.com', created_at: '2013-08-29 21:22:44' } }
+          let(:attributes) { { email: 'art+test@vandelay.com', created_at: '2013-08-29 21:22:44' } }
 
-          it { expect { assign_attributes! }.to raise_error(Encore::Entity::Input::ProtectedAttributeError) }
+          it { expect { assign_attributes! }.to raise_error(Encore::Entity::Input::InvalidAttributeError) }
         end
       end
 
       context 'with :partial_update context' do
         let(:entity) { UserEntity.new(User.first) }
-        let(:attributes) { { email: 'remi+test@example.com' } }
+        let(:attributes) { { email: 'art+test@vandelay.com' } }
         let(:context) { :partial_update }
-        let(:create_user!) { User.create(email: 'remi@example.com', name: 'Rémi Prévost') }
+        let(:create_user!) { User.create(email: 'art@vandelay.com', name: 'Art Vandelay') }
 
         before do
           create_user!
           assign_attributes!
         end
 
-        it { expect(entity.object.email).to eql 'remi+test@example.com' }
-        it { expect(entity.object.name).to eql 'Rémi Prévost' }
+        it { expect(entity.object.email).to eql 'art+test@vandelay.com' }
+        it { expect(entity.object.name).to eql 'Art Vandelay' }
         it { expect(entity.object.created_at).to_not be_blank }
         it { expect(entity.object.updated_at).to_not be_blank }
       end

data/spec/encore/entity/output/json_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Encore::Entity::Output::JSON do
+  describe :InstanceMethods do
+    describe :as_json do
+      context 'for simple entity' do
+        before do
+          # Create a model
+          spawn_model :User
+
+          # Create an entity
+          spawn_entity :UserEntity do
+            expose :name
+          end
+
+          run_migration do
+            create_table(:users, force: true) do |t|
+              t.string :name
+            end
+          end
+        end
+
+        let(:user) { User.create(name: 'Art Vandelay') }
+        let(:entity) { UserEntity.new(user) }
+        let(:json) { entity.as_json }
+
+        it { expect(json.keys).to include :id, :name }
+        it { expect(json[:id]).to eql user.id }
+        it { expect(json[:name]).to eql 'Art Vandelay' }
+      end
+
+      context 'for entity with associations' do
+        before do
+          # Create a model
+          spawn_model :User do
+            has_many :comments
+          end
+
+          # Create a model
+          spawn_model :Comment
+
+          # Create an entity
+          spawn_entity :UserEntity do
+            expose :name
+            expose_many :comments
+          end
+
+          run_migration do
+            create_table(:users, force: true) do |t|
+              t.string :name
+            end
+
+            create_table(:comments, force: true) do |t|
+              t.text :body
+              t.integer :user_id
+            end
+          end
+        end
+
+        let(:user) do
+          User.create(name: 'Art Vandelay').tap do |user|
+            user.comments << Comment.create(body: 'Test 1')
+            user.comments << Comment.create(body: 'Test 2')
+          end
+        end
+
+        let(:entity) { UserEntity.new(user) }
+        let(:json) { entity.as_json }
+
+        it { expect(json.keys).to include :id, :name, :comments }
+        it { expect(json[:comments]).to be_instance_of Array }
+        it { expect(json[:comments]).to include *Comment.pluck(:id) }
+      end
+    end
+  end
+end

data/spec/encore/entity/output_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Encore::Entity::Output do
+  # Nothing to test here
+end

data/spec/encore/entity_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Encore::Entity do
+  describe :InstanceMethods do
+    describe :method_missing do
+      before do
+        spawn_model :User
+        spawn_entity(:UserEntity) { expose :name }
+
+        run_migration do
+          create_table(:users, force: true) do |t|
+            t.string :name
+          end
+        end
+      end
+
+      let(:user) { User.create }
+      let(:entity) { UserEntity.new(user) }
+
+      context 'for delegated method' do
+        before { expect(user).to receive(:save) }
+        specify { entity.save }
+      end
+
+      context 'for setter method' do
+        before { expect(user).to receive(:name=).with('Art Vandelay') }
+        specify { entity.name = "Art Vandelay" }
+      end
+    end
+  end
+end

data/spec/encore/helpers/controller_helper_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Encore::Helpers::ControllerHelper do
+  describe :process! do
+    before do
+      # Create a model
+      spawn_model :User
+
+      # Create a controller
+      spawn_controller :UsersController do
+        before_filter :fetch_user, only: [:update]
+
+        define_method :create do
+          @entity = UserEntity.new
+          @entity.assign_attributes(params[:user], context: :create)
+          process! @entity
+        end
+
+        define_method :update do
+          @entity = UserEntity.new(@user)
+          @entity.assign_attributes(params[:user], context: :update0)
+          process! @entity
+        end
+
+        define_method :fetch_user do
+          @user = User.find(params[:id])
+        end
+      end
+
+      # Create an entity
+      spawn_entity :UserEntity do
+        expose :name
+      end
+
+      run_migration do
+        create_table(:users, force: true) do |t|
+          t.string :name
+        end
+      end
+    end
+
+    let(:request) { ActionDispatch::TestRequest.new }
+    let(:env) { request.env.tap { |e| e['action_dispatch.request.parameters'] = params } }
+
+    context 'for create context' do
+      let(:params) { { user: { name: 'H.E. Pennypacker' } } }
+      let(:response) { UsersController.action(:create).call(env) }
+      it { expect(response.first).to eql 201 }
+    end
+
+    context 'for update context' do
+      before { User.create(name: 'Art Vandelay') }
+
+      let(:params) { { id: 1, user: { name: 'H.E. Pennypacker' } } }
+      let(:response) { UsersController.action(:update).call(env) }
+      it { expect(response.first).to eql 200 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,18 +1,31 @@
 $:.unshift File.expand_path('../lib', __FILE__)
 
+# Test dependencies
 require 'rspec'
 require 'sqlite3'
 
+# Data structure
+require 'active_record'
+require 'ostruct'
+
+# Encore
 require 'encore'
 
 # Require our macros and extensions
 Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
 
+# Emulate our railtie's behavior
+require 'encore/railtie'
+Encore::Helpers::ControllerHelper.inject_into_action_controller
+
 RSpec.configure do |config|
   # Include our macros
   config.include DatabaseMacros
   config.include ModelMacros
 
+  # Shared examples aliases
+  config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+
   config.before(:each) do
     # Create the SQLite database
     setup_database

data/spec/support/macros/model_macros.rb

@@ -14,6 +14,20 @@ module ModelMacros
     end
   end
 
+  # Create a new OpenStruct struct
+  def spawn_struct(klass_name, &block)
+    spawn_klass klass_name, OpenStruct do
+      instance_exec(&block) if block
+    end
+  end
+
+  # Create a new ActionPack controller
+  def spawn_controller(klass_name, &block)
+    spawn_klass klass_name, ActionController::Base do
+      instance_exec(&block) if block
+    end
+  end
+
   protected
 
   # Create a new class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encore
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -94,7 +94,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Encore is a framework built on top of ActiveRecord to manage entities.
+description: Encore is a Ruby framework to help dealing with entities.
 email:
 - rprevost@mirego.com
 executables: []
@@ -103,24 +103,41 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - encore.gemspec
+- gemfiles/Gemfile.activerecord-3.2.x
+- gemfiles/Gemfile.activerecord-4.0
 - lib/encore.rb
+- lib/encore/association.rb
+- lib/encore/association/has_many_association.rb
+- lib/encore/association/has_one_association.rb
 - lib/encore/attribute.rb
 - lib/encore/entity.rb
 - lib/encore/entity/input.rb
+- lib/encore/entity/input/associations.rb
 - lib/encore/entity/input/errors.rb
 - lib/encore/entity/input/exposed_attributes.rb
 - lib/encore/entity/output.rb
+- lib/encore/entity/output/json.rb
+- lib/encore/helpers.rb
+- lib/encore/helpers/controller_helper.rb
+- lib/encore/railtie.rb
 - lib/encore/version.rb
-- spec/poutine/entity_spec.rb
+- spec/encore/entity/input/associations_spec.rb
+- spec/encore/entity/input/exposed_attributes_spec.rb
+- spec/encore/entity/input_spec.rb
+- spec/encore/entity/output/json_spec.rb
+- spec/encore/entity/output_spec.rb
+- spec/encore/entity_spec.rb
+- spec/encore/helpers/controller_helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb
-homepage: https://github.com/remiprev/encore
+homepage: https://github.com/mirego/encore
 licenses:
 - BSD 3-Clause
 metadata: {}
@@ -143,9 +160,15 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Encore is a framework built on top of ActiveRecord to manage entities.
+summary: Encore is a Ruby framework to help dealing with entities.
 test_files:
-- spec/poutine/entity_spec.rb
+- spec/encore/entity/input/associations_spec.rb
+- spec/encore/entity/input/exposed_attributes_spec.rb
+- spec/encore/entity/input_spec.rb
+- spec/encore/entity/output/json_spec.rb
+- spec/encore/entity/output_spec.rb
+- spec/encore/entity_spec.rb
+- spec/encore/helpers/controller_helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb