encore 0.0.3 → 0.1

metadata

@@ -1,140 +1,220 @@
 --- !ruby/object:Gem::Specification
 name: encore
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: '0.1'
 platform: ruby
 authors:
-- Rémi Prévost
+- Simon Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0beta2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0beta2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: phare
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-description: Encore is a Ruby framework to help dealing with entities.
+        version: '0'
+description: Encore provides serializers and persisters to build JSON API-compliant
+  Web services with Ruby on Rails.
 email:
-- rprevost@mirego.com
+- sprevost@mirego.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - encore.gemspec
-- gemfiles/Gemfile.activerecord-3.2.x
 - gemfiles/Gemfile.activerecord-4.0
+- gemfiles/Gemfile.activerecord-4.1
 - 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/config.rb
+- lib/encore/persister/errors_parser.rb
+- lib/encore/persister/instance.rb
+- lib/encore/persister/key_mapping.rb
+- lib/encore/persister/links_parser.rb
+- lib/encore/persister/param_injection.rb
+- lib/encore/serializer/base.rb
+- lib/encore/serializer/eager_loading_manager.rb
+- lib/encore/serializer/instance.rb
+- lib/encore/serializer/linked_resource_manager.rb
+- lib/encore/serializer/links_reflection_includer.rb
+- lib/encore/serializer/main_resource_links_manager.rb
+- lib/encore/serializer/main_resource_links_manager/reflection_belongs_to.rb
+- lib/encore/serializer/main_resource_links_manager/reflection_has_many.rb
+- lib/encore/serializer/main_resource_links_manager/reflection_has_one.rb
+- lib/encore/serializer/main_resource_manager.rb
+- lib/encore/serializer/meta_manager.rb
+- lib/encore/serializer/options_parser.rb
+- lib/encore/serializer/utils.rb
 - lib/encore/version.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/encore/persister/belongs_to_links_spec.rb
+- spec/encore/persister/create_resources_spec.rb
+- spec/encore/persister/errors_resources_spec.rb
+- spec/encore/persister/has_many_links_spec.rb
+- spec/encore/persister/has_one_links_spec.rb
+- spec/encore/persister/key_mappings_spec.rb
+- spec/encore/persister/param_injection_spec.rb
+- spec/encore/persister/update_resources_spec.rb
+- spec/encore/serializer/linked/always_include_resources_spec.rb
+- spec/encore/serializer/linked/can_include_resources_spec.rb
+- spec/encore/serializer/linked/linked_resources_spec.rb
+- spec/encore/serializer/links_resource_spec.rb
+- spec/encore/serializer/main_meta_spec.rb
+- spec/encore/serializer/main_resource_spec.rb
+- spec/encore/serializer/no_paging_spec.rb
+- spec/encore_spec.rb
 - spec/spec_helper.rb
+- spec/support/macros/database/database_adapter.rb
+- spec/support/macros/database/sqlite3_adapter.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb
 homepage: https://github.com/mirego/encore
@@ -147,28 +227,19 @@ 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
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Encore is a Ruby framework to help dealing with entities.
-test_files:
-- 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
+summary: Encore provides serializers and persisters to build JSON API-compliant Web
+  services with Ruby on Rails.
+test_files: []

data/lib/encore/association/has_many_association.rb

@@ -1,12 +0,0 @@
-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

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

data/lib/encore/association.rb

@@ -1,39 +0,0 @@
-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,42 +0,0 @@
-module Encore
-  class Attribute
-    attr_reader :attribute, :klass, :column, :opts
-
-    def initialize(klass, column, opts = {})
-      @klass = klass
-      @column = column
-      @attribute = opts[:as].try(:to_sym) || @column
-      @opts = opts
-    end
-
-    def assign(object, value)
-      object.send :"#{self.column}=", value
-    end
-
-    def fetch(object)
-      object.send :"#{self.column}"
-    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/associations.rb

@@ -1,27 +0,0 @@
-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,8 +0,0 @@
-module Encore
-  module Entity
-    module Input
-      class InvalidAttributeError < StandardError
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-module Encore
-  module Entity
-    module Input
-      module ExposedAttributes
-        extend ActiveSupport::Concern
-
-        module ClassMethods
-          # Declare a new exposed attribute
-          def expose(column, opts = {})
-            @exposed_attributes ||= []
-            @exposed_attributes << Encore::Attribute.new(self, column.to_sym, opts)
-          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 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?)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/encore/entity/input.rb

@@ -1,73 +0,0 @@
-require 'encore/entity/input/errors'
-require 'encore/entity/input/exposed_attributes'
-require 'encore/entity/input/associations'
-
-module Encore
-  module Entity
-    module Input
-      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? ? :partial_update : :create
-        end
-
-        # Convert attribute keys to Attribute objects
-        attributes = self.class.map_attributes(self.class, attributes)
-
-        # Loop through every passed attribute and set it
-        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)
-      end
-
-    protected
-
-      def assign_provided_attributes(attributes)
-        attributes.each_pair do |attribute, value|
-          if self.class.modifiable_attribute?(attribute)
-            attribute.assign(self, value)
-          else
-            raise Encore::Entity::Input::InvalidAttributeError.new("The #{attribute} attribute is not exposed.")
-          end
-        end
-      end
-
-      def reset_forgotten_attributes(attributes)
-        if @context == :update
-          (self.class.modifiable_attributes - attributes.keys).each do |attribute|
-            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

@@ -1,14 +0,0 @@
-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,13 +0,0 @@
-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

@@ -1,44 +0,0 @@
-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
-
-    # Save the object
-    def save
-      run_callbacks(:save) { @object.save }
-    end
-
-    # Delegate everything to the object
-    def method_missing(method, *args, &blk)
-      if @object.respond_to?(method)
-        @object.send(method, *args, &blk)
-      else
-        super
-      end
-    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/helpers/controller_helper.rb

@@ -1,37 +0,0 @@
-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

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