encore 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6425ceec678f308c80da211bf16946506b2c704
+  data.tar.gz: 481ae8d7b56757c499fa9cebae51f6eb635052e5
+SHA512:
+  metadata.gz: e7c056d64a6c7d8341fa8728255b1c37da9156e9f3800245911069c345a6a2250fbf91aa3a531417c4c7f7e668e08b4579448e393582f980d9e04434ae148bc0
+  data.tar.gz: 717a8560dee3c08e3bf6cbf3e05b5239dcd5273e16c2df82b99eb93ab36d2357f1a80a61bc155c14b7473f6302d0ddb99d2bfe87fc75dcfa682cdade62ce9fe6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2013, Mirego
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the Mirego nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,76 @@
+# Encore
+
+Encore is a framework built on top of ActiveRecord to manage entities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'encore'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install encore
+```
+
+## Usage
+
+```ruby
+# app/entities/user_entity.rb
+class UserEntity
+  include Encore::Entity
+
+  expose :name
+  expose :email
+  expose :created_at, readonly: true
+  expose :updated_at, readonly: true
+end
+
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  # 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
+  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
+  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
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/encore.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'encore'
+  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.summary       = spec.description
+  spec.homepage      = 'https://github.com/remiprev/encore'
+  spec.license       = "BSD 3-Clause"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_dependency 'activerecord', '>= 3.0.0'
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+end

data/lib/encore/attribute.rb

@@ -0,0 +1,39 @@
+module Encore
+  class Attribute
+    attr_reader :attribute, :klass
+
+    def initialize(klass, attribute, opts = {})
+      @klass = klass
+      @attribute = attribute
+      @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
+    end
+
+    def ==(other_attribute)
+      hash == other_attribute.hash
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    # Generate a hash for comparisons
+    def hash
+      [@attribute, @klass].hash
+    end
+
+    # Return whether the attribute is read-only
+    def readonly?
+      !!@opts[:readonly]
+    end
+
+    def to_s
+      "#<Encore::Attribute #{@klass}@#{@attribute}>"
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Encore
+  module Entity
+    module Input
+      class ProtectedAttributeError < StandardError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Encore
+  module Entity
+    module Input
+      module ExposedAttributes
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          # Declare a new exposed attribute
+          def expose(attribute, 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)
+          end
+
+          # Return whether an attribute is exposed by the entity
+          def exposed_attribute?(attribute)
+            @exposed_attributes.detect { |a| attribute == a }
+          end
+
+          # Return whether an attribute is exposed by the entity
+          def modifiable_attribute?(attribute)
+            modifiable_attributes.include?(attribute)
+          end
+
+          # Return a list of all attributes that can be modified
+          def modifiable_attributes
+            @exposed_attributes.reject(&:readonly?)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/encore/entity/input.rb

@@ -0,0 +1,54 @@
+require 'encore/entity/input/errors'
+require 'encore/entity/input/exposed_attributes'
+
+module Encore
+  module Entity
+    module Input
+      extend ActiveSupport::Concern
+
+      included do
+        include Encore::Entity::Input::ExposedAttributes
+
+        # Expose ID as a readonly attribute
+        expose :id, readonly: true
+      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
+        end
+
+        # Convert attribute keys to Attribute objects
+        attributes = Encore::Attribute.map_attributes(self.class, attributes)
+
+        # Loop through every passed attribute and set it
+        assign_provided_attributes(attributes, context)
+
+        # If we're doing an update, for any exposed attribute that wasn't passed, set it to nil
+        reset_forgotten_attributes(attributes, context)
+      end
+
+    protected
+
+      def assign_provided_attributes(attributes, context)
+        attributes.each_pair do |attribute, value|
+          if self.class.modifiable_attribute?(attribute)
+            send :"#{attribute.attribute}=", value
+          else
+            raise Encore::Entity::Input::ProtectedAttributeError.new("The #{attribute} attribute is not exposed.")
+          end
+        end
+      end
+
+      def reset_forgotten_attributes(attributes, context)
+        if context == :update
+          (self.class.modifiable_attributes - attributes.keys).each do |attribute|
+            send :"#{attribute.attribute}=", nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/encore/entity/output.rb

@@ -0,0 +1,7 @@
+module Encore
+  module Entity
+    module Output
+      extend ActiveSupport::Concern
+    end
+  end
+end

data/lib/encore/entity.rb

@@ -0,0 +1,35 @@
+require 'encore/entity/input'
+require 'encore/entity/output'
+
+module Encore
+  module Entity
+    extend ActiveSupport::Concern
+
+    included do
+      include Input
+      include Output
+
+      # Make `object` accessible for others
+      attr_accessor :object
+    end
+
+    # Initialize a new entity, linked to an ActiveRecord object
+    # If no object is passed, let's try to build a new one
+    def initialize(object = nil)
+      @object = object || self.class.linked_class.new
+    end
+
+    # Delegate everything to the object
+    def method_missing(method, *args, &blk)
+      @object.send(method, *args, &blk)
+    end
+
+    module ClassMethods
+      # Return the object class. If no object is present, try to
+      # guess the class with our own class name (`UserEntity` would be `User`)
+      def linked_class
+        @object ? @object.class : self.name.split(/Entity$/).first.constantize
+      end
+    end
+  end
+end

data/lib/encore/version.rb

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

data/lib/encore.rb

@@ -0,0 +1,11 @@
+require 'encore/version'
+
+# ActiveSupport
+require 'active_support'
+
+# ActiveRecord
+require 'active_record'
+
+# Encore
+require 'encore/entity'
+require 'encore/attribute'

data/spec/poutine/entity_spec.rb

@@ -0,0 +1,104 @@
+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
+
+    run_migration do
+      create_table(:users, force: true) do |t|
+        t.string :email
+        t.string :name
+        t.timestamps
+      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(:context) { :create }
+
+        before { assign_attributes! }
+
+        it { expect(entity.object.email).to eql 'remi@example.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
+        let(:entity) { UserEntity.new(User.first) }
+        let(:context) { :update }
+        let(:create_user!) { User.create(email: 'remi@example.com', name: 'Rémi Prévost') }
+
+        before { create_user! }
+
+        context 'when updating valid attributes' do
+          let(:attributes) { { email: 'remi+test@example.com' } }
+          before { assign_attributes! }
+
+          it { expect(entity.object.email).to eql 'remi+test@example.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' } }
+
+          it { expect { assign_attributes! }.to raise_error(Encore::Entity::Input::ProtectedAttributeError) }
+        end
+      end
+
+      context 'with :partial_update context' do
+        let(:entity) { UserEntity.new(User.first) }
+        let(:attributes) { { email: 'remi+test@example.com' } }
+        let(:context) { :partial_update }
+        let(:create_user!) { User.create(email: 'remi@example.com', name: 'Rémi Prévost') }
+
+        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.created_at).to_not be_blank }
+        it { expect(entity.object.updated_at).to_not be_blank }
+      end
+
+      context 'with overriden setter method' do
+        before do
+          class UserEntity
+            def name=(name)
+              object.name = name.upcase
+            end
+          end
+        end
+
+        let(:entity) { UserEntity.new(User.first) }
+        let(:attributes) { { name: 'Art Vandelay' } }
+        let(:context) { :partial_update }
+        let(:create_user!) { User.create }
+
+        before do
+          create_user!
+          assign_attributes!
+        end
+
+        it { expect(entity.object.name).to eql 'ART VANDELAY' }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'sqlite3'
+
+require 'encore'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+
+  config.before(:each) do
+    # Create the SQLite database
+    setup_database
+  end
+
+  config.after(:each) do
+    # Make sure we remove our test database file
+    cleanup_database
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,33 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def self.database_file
+    @database_file || File.expand_path('../test.db', __FILE__)
+  end
+
+  def setup_database
+    # Make sure the test database file is gone
+    cleanup_database
+
+    # Establish the connection
+    SQLite3::Database.new FileUtils.touch(DatabaseMacros.database_file).first
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: DatabaseMacros.database_file)
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+
+  def cleanup_database
+    FileUtils.rm(DatabaseMacros.database_file) if File.exists?(DatabaseMacros.database_file)
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,25 @@
+module ModelMacros
+  # Create a new Encore entity
+  def spawn_entity(klass_name, &block)
+    spawn_klass klass_name, Object do
+      include Encore::Entity
+      instance_exec(&block) if block
+    end
+  end
+
+  # Create a new ActiveRecord model
+  def spawn_model(klass_name, &block)
+    spawn_klass klass_name, ActiveRecord::Base  do
+      instance_exec(&block) if block
+    end
+  end
+
+  protected
+
+  # Create a new class
+  def spawn_klass(klass_name, parent_klass, &block)
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: encore
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Rémi Prévost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Encore is a framework built on top of ActiveRecord to manage entities.
+email:
+- rprevost@mirego.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- encore.gemspec
+- lib/encore.rb
+- lib/encore/attribute.rb
+- lib/encore/entity.rb
+- lib/encore/entity/input.rb
+- lib/encore/entity/input/errors.rb
+- lib/encore/entity/input/exposed_attributes.rb
+- lib/encore/entity/output.rb
+- lib/encore/version.rb
+- spec/poutine/entity_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
+homepage: https://github.com/remiprev/encore
+licenses:
+- BSD 3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files:
+- spec/poutine/entity_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb