cyrax 0.2.12 → 0.3.0.pre2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmE4NDdlOGZmMzJkNTcyNzMwZmZmNGMwNzdmZTQwOTI1MzE5YmZjMw==
+    N2ExMDYyODcwNjBlZDU0M2VhZmJjMmMzODhmZTY4OGY0NTBlNTc0NQ==
   data.tar.gz: !binary |-
-    M2U2MjQ4OWFhZmZjNjllNjFmMGZiY2VjMGY1Mjk1NmRjNWVhNGJjNA==
+    MGEzNzgzYjhmOWFiMDc2M2JiN2ZhOTJlYTNjOWRlMGRkOWE3N2FlZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjJiYTZlNDQ3OWYzMDgxM2M3MWMzZGMxNTFmYzEzMTFkZDBlYzBjZjhlOTQy
-    NTJjOTg3OWYzZDcwZTdmMTZlMjc2YTVjNzhiY2VjMmY4YWQ1MjY5Yzk2YzY5
-    MWExMjliNGJkZjkyZGZiNTkyODhiMzFhMjQ0NzRiZTEwNTBmMjM=
+    MWJjMGJlYTM4YTQ4ODZhZjlkNWRjY2Y0ZjAzN2FlNjBmNmMxNTcyNzJkZWQ4
+    ODY4NGIzZTk4NzhjNWY5ZjI0MDM1MGM3NTc4MzU4MWY0MTc0MWU4NmQxMzQx
+    ZmRiNDUzYWMyM2U2OGRlYzA5ZjNmMDg3NTY4Y2E1NjEwZWJhYTU=
   data.tar.gz: !binary |-
-    Y2JkNzVkNWZlNDZmZTg4Zjk0MDZkNTJjMmVlNjM5OTE1MTNiZWY2ZDUyNmY2
-    Y2NiZTlkOGY1NTI4MzAyMzhkMTdlNGZjNDZiYTJkOTk0YjNkYjE1YTBiNDJi
-    YmIxYmRlOTNhYjAwZWNhYWYyYWYzZDdkYWVjNmZlOTJkZGVjNTY=
+    NjhmY2I2ZjczZjM3NzhhNTYyMTJhYTU1ZWRiZmZlN2M3ZmU0MDU1YjNhMjk3
+    YjUxZjRhOTU1ZTIxM2YxZjY0YTIyYzY3ZmFkYjE3NGY4M2NiODg2OTZhYTIx
+    NDEwNjk1YWU5NjYzZjI4NGNmMWVlNTM1ZDEyMGQwYjUxMmFjMDI=

data/lib/cyrax.rb

@@ -4,14 +4,18 @@ require "cyrax/extensions/has_response.rb"
 require "cyrax/extensions/has_callbacks.rb"
 require "cyrax/extensions/has_service.rb"
 require "cyrax/extensions/has_decorator.rb"
+require "cyrax/extensions/has_serializer.rb"
+require "cyrax/presenters/base_collection.rb"
+require "cyrax/presenters/decorated_collection.rb"
+require "cyrax/serializers/scope.rb"
+require "cyrax/helpers/controller.rb"
 require "cyrax/base.rb"
-require "cyrax/base_resource.rb"
-require "cyrax/base_presenter.rb"
+require "cyrax/resource.rb"
+require "cyrax/presenter.rb"
 require "cyrax/response.rb"
 require "cyrax/callbacks.rb"
-require "cyrax/base_collection_presenter.rb"
-require "cyrax/decorated_collection_presenter.rb"
 require "cyrax/decorator.rb"
+require "cyrax/serializer.rb"
 
 module Cyrax
   @@strong_parameters = false
@@ -23,4 +27,17 @@ module Cyrax
   def self.strong_parameters=(value)
     @@strong_parameters = value
   end
+
+  def self.const_missing(const_name)
+    case const_name
+    when :BaseResource
+      warn "`Cyrax::BaseResource` has been deprecated. Use `Cyrax::Resource` instead."
+      Cyrax::Resource
+    when :DecoratedCollectionPresenter
+      warn "`Cyrax:DecoratedCollectionPresenter` has been deprecated. Use `Cyrax::Presenters::DecoratedCollection` instead."
+      Cyrax::Presenters::DecoratedCollection
+    else
+      super
+    end
+  end
 end

data/lib/cyrax/decorator.rb

@@ -31,7 +31,7 @@ class Cyrax::Decorator
     alias_method :decorate, :new
 
     def decorate_collection(resource)
-      Cyrax::DecoratedCollectionPresenter.decorate(resource, decorator: self)
+      Cyrax::Presenters::DecoratedCollection.decorate(resource, decorator: self)
     end
   end
 end

data/lib/cyrax/extensions/has_response.rb

@@ -9,7 +9,6 @@ module Cyrax::Extensions
 
     def assign_resource(resource_name, resource, options = {})
       if options[:decorator]
-        options.merge!(decorable: true)
         resource = Cyrax::BasePresenter.present(resource, options)
       end
       @_assignments ||= {}
@@ -40,10 +39,13 @@ module Cyrax::Extensions
     def respond_with(result, options = {})
       name = options[:name] || response_name
       result = result.result.to_model if result.is_a?(Cyrax::Response)
-      if respond_to?(:decorable?)
-        options.merge!(decorable: decorable?, decorator: decorator_class)
-        result = Cyrax::BasePresenter.present(result, options)
+      if respond_to?(:decorable?) && decorable?
+        options = {decorator: decorator_class}.merge(options)
       end
+      if respond_to?(:seializable?) && seializable?
+        options = {serializer: serializer_class}.merge(options)
+      end
+      result = Cyrax::Presenter.present(result, options)
       response = Cyrax::Response.new(name, result)
       response.message = @_message
       response.errors = @_errors

data/lib/cyrax/extensions/has_serializer.rb

@@ -0,0 +1,23 @@
+module Cyrax::Extensions
+  module HasSerializer
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :serializer_class_name
+    end
+
+    def seializable?
+      !self.class.serializer_class_name.nil?
+    end
+
+    def serializer_class
+      self.class.serializer_class_name.to_s.classify.constantize
+    end
+
+    module ClassMethods
+      def serializer(name)
+        self.serializer_class_name = name ? name.to_s : nil
+      end
+    end
+  end
+end

data/lib/cyrax/extensions/has_service.rb

@@ -13,14 +13,16 @@ module Cyrax::Extensions
 
     def create(custom_attributes=nil)
       resource = build_resource(nil, custom_attributes||resource_attributes)
-      invoke_callback(:before_create, resource)
-      invoke_callback(:before_save, resource)
-      if save_resource(resource)
-        invoke_callback(:after_create, resource)
-        invoke_callback(:after_save, resource)
-        set_message("#{resource_name.titleize} successfully created")
-      else
-        add_errors_from(resource)
+      transaction do
+        invoke_callback(:before_create, resource)
+        invoke_callback(:before_save, resource)
+        if save_resource(resource)
+          invoke_callback(:after_create, resource)
+          invoke_callback(:after_save, resource)
+          set_message("#{resource_name.titleize} successfully created")
+        else
+          add_errors_from(resource)
+        end
       end
       respond_with(resource)
     end
@@ -33,23 +35,27 @@ module Cyrax::Extensions
 
     def update(custom_attributes=nil)
       resource = build_resource(params[:id], custom_attributes||resource_attributes)
-      invoke_callback(:before_update, resource)
-      invoke_callback(:before_save, resource)
-      if save_resource(resource)
-        invoke_callback(:after_update, resource)
-        invoke_callback(:after_save, resource)
-        set_message("#{resource_name.titleize} successfully updated")
-      else
-        add_errors_from(resource)
+      transaction do
+        invoke_callback(:before_update, resource)
+        invoke_callback(:before_save, resource)
+        if save_resource(resource)
+          invoke_callback(:after_update, resource)
+          invoke_callback(:after_save, resource)
+          set_message("#{resource_name.titleize} successfully updated")
+        else
+          add_errors_from(resource)
+        end
       end
       respond_with(resource)
     end
 
     def destroy
       resource = find_resource(params[:id])
-      invoke_callback(:before_destroy, resource)
-      delete_resource(resource)
-      invoke_callback(:after_destroy, resource)
+      transaction do
+        invoke_callback(:before_destroy, resource)
+        delete_resource(resource)
+        invoke_callback(:after_destroy, resource)
+      end
       respond_with(resource)
     end
 
@@ -78,5 +84,15 @@ module Cyrax::Extensions
     def build_collection
       resource_scope
     end
+
+    def transaction(&block)
+      if defined?(ActiveRecord::Base)
+        ActiveRecord::Base.transaction do
+          block.call
+        end
+      else
+        block.call
+      end
+    end
   end
 end

data/lib/cyrax/helpers/controller.rb

@@ -0,0 +1,28 @@
+module Cyrax::ControllerHelper
+  def respond_with(*args)
+    if args.present? && args.first.is_a?(Cyrax::Response)
+      response, options = *args
+      default_options = {
+        notice: response.notice,
+        error: response.error
+      }
+      set_resource_from(response)
+      flash[:notice] = response.notice if response.notice.present?
+
+      # convert result to model if possible
+      result = response.result
+      result = result.to_model if result.respond_to?(:to_model)
+
+      super(result, default_options.merge(options || {}))
+    else
+      super(*args)
+    end
+  end
+
+  def set_resource_from(response)
+    instance_variable_set("@#{response.resource_name}", response.result)
+    response.assignments.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end if response.assignments.present? && response.assignments.is_a?(Hash)
+  end
+end

data/lib/cyrax/{base_presenter.rb → presenter.rb}

@@ -1,8 +1,7 @@
-class Cyrax::BasePresenter
-
+class Cyrax::Presenter
   def present(object, options = {})
     should_decorate = options[:decorate].nil? || options[:decorate]
-    if options[:decorable] && should_decorate
+    if options[:decorator] && should_decorate
       present_with_decoration(object, options)
     else
       present_without_decoration(object, options)
@@ -19,7 +18,7 @@ class Cyrax::BasePresenter
 
   def present_with_decoration(object, options)
     if options[:present] == :collection
-      options[:decorator].decorate_collection(object)
+      Cyrax::Presenters::DecoratedCollection.new(object, options)
     else
       options[:decorator].decorate(object)
     end
@@ -27,7 +26,7 @@ class Cyrax::BasePresenter
 
   def present_without_decoration(object, options)
     if options[:present] == :collection
-      Cyrax::BaseCollectionPresenter.new(object).fetched_collection
+      Cyrax::Presenters::BaseCollection.new(object, options)
     else
       object
     end

data/lib/cyrax/presenters/base_collection.rb

@@ -0,0 +1,36 @@
+module Cyrax::Presenters
+  class BaseCollection
+    attr_reader :collection, :options
+    
+    def initialize(collection, options = {})
+      @collection = collection
+      @options = options
+    end
+
+    array_methods = Array.instance_methods - Object.instance_methods
+    delegate *array_methods, to: :presented_collection
+
+    def presented_collection
+      if collection.is_a?(ActiveRecord::Relation)
+        collection.to_a
+      elsif collection.respond_to?(:all)
+        collection.all
+      else
+        Array.wrap collection
+      end
+    end
+
+    def as_json
+      if options[:serializer]
+        options[:serializer].new(presented_collection).serialize
+      else
+        presented_collection.as_json
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless collection.respond_to?(method)
+      collection.send(method, *args, &block)
+    end
+  end
+end

data/lib/cyrax/presenters/decorated_collection.rb

@@ -0,0 +1,24 @@
+module Cyrax::Presenters
+  class DecoratedCollection < Cyrax::Presenters::BaseCollection
+    def initialize(collection, options = {})
+      super
+      unless options[:decorator]
+        raise "Decorator is not defined! Please define it with option :decorator"
+      end
+    end
+
+    def presented_collection
+      @decorated_collection ||= super.map {|item| decorate_item(item)}
+    end
+
+    def self.decorate(*args)
+      new(*args).presented_collection
+    end
+
+    private
+
+      def decorate_item(item)
+        options[:decorator].new(item)
+      end
+  end
+end

data/lib/cyrax/{base_resource.rb → resource.rb}

@@ -1,6 +1,7 @@
-class Cyrax::BaseResource < Cyrax::Base
+class Cyrax::Resource < Cyrax::Base
   include Cyrax::Extensions::HasResource
   include Cyrax::Extensions::HasCallbacks
   include Cyrax::Extensions::HasService
   include Cyrax::Extensions::HasDecorator
+  include Cyrax::Extensions::HasSerializer
 end

data/lib/cyrax/serializer.rb

@@ -0,0 +1,28 @@
+class Cyrax::Serializer
+  attr_accessor :object
+  def initialize(object)
+    @object = object
+  end
+
+  def serialize
+    self.class.scope.serialize(object)
+  end
+
+  class << self
+    def scope
+      @scope ||= Cyrax::Serializers::Scope.new()
+    end
+
+    def namespace(name, &block)
+      scope.namespace(name, &block)
+    end
+
+    def attributes(*attrs)
+      scope.attributes(*attrs)
+    end
+
+    def attribute(attribute, options = {})
+      scope.attribute(attribute, options)
+    end
+  end
+end

data/lib/cyrax/serializers/scope.rb

@@ -0,0 +1,35 @@
+module Cyrax::Serializers
+  class Scope
+    def initialize(&block)
+      @attrs = {}
+      instance_eval(&block) if block_given?
+    end
+
+    def namespace(name, &block)
+      @attrs[name] = self.class.new(&block)
+    end
+
+    def attributes(*attrs)
+      attrs.map do |attribute|
+        attribute(attribute)
+      end
+    end
+
+    def attribute(attribute, options = {})
+      @attrs ||= {}
+      @attrs[attribute] ||= attribute
+    end
+
+    def serialize(object)
+      result = {}
+      @attrs.map do |attribute, options|
+        value = object.send(attribute)
+        if options.is_a?(Cyrax::Serializers::Scope)
+          value = options.serialize(value)
+        end
+        result[attribute] = value
+      end
+      result
+    end
+  end
+end

data/lib/cyrax/version.rb

@@ -1,3 +1,3 @@
 module Cyrax
-  VERSION = "0.2.12"
+  VERSION = "0.3.0.pre2"
 end

data/spec/cyrax/{base_resource_spec.rb → resource_spec.rb}

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 class Foo; end
 module Cyrax
-  describe BaseResource do
+  describe Resource do
     describe 'it should behave like resource' do
       context 'instance methods' do
-        subject { Cyrax::BaseResource.new }
+        subject { Cyrax::Resource.new }
         it{ should respond_to(:accessor) }
         it{ should respond_to(:params) }
         it{ should respond_to(:resource_name) }
@@ -25,7 +25,7 @@ module Cyrax
       end
     end
 
-    subject { Cyrax::BaseResource.new }
+    subject { Cyrax::Resource.new }
     let(:resource) { double.as_null_object }
     let(:collection) { [double] }
     before do

data/spec/cyrax/serializer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class FooSerializer < Cyrax::Serializer
+  attribute :name
+  namespace :some do
+    attributes :foo, :bar
+  end
+end
+
+module Cyrax
+  describe FooSerializer do
+    let(:serializable) { double(name: 'me', some: double(foo: '1234', bar: '1234')) }
+    subject { FooSerializer.new(serializable).serialize }
+
+    it 'should serialize object' do
+      subject[:name].should eq('me')
+      subject[:some][:foo].should eq('1234')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyrax
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.3.0.pre2
 platform: ruby
 authors:
 - Droidlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-03 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,24 +73,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/cyrax/base.rb
-- lib/cyrax/base_collection_presenter.rb
-- lib/cyrax/base_presenter.rb
-- lib/cyrax/base_resource.rb
 - lib/cyrax/callbacks.rb
-- lib/cyrax/decorated_collection_presenter.rb
 - lib/cyrax/decorator.rb
 - lib/cyrax/extensions/has_callbacks.rb
 - lib/cyrax/extensions/has_decorator.rb
 - lib/cyrax/extensions/has_resource.rb
 - lib/cyrax/extensions/has_response.rb
+- lib/cyrax/extensions/has_serializer.rb
 - lib/cyrax/extensions/has_service.rb
+- lib/cyrax/helpers/controller.rb
+- lib/cyrax/presenter.rb
+- lib/cyrax/presenters/base_collection.rb
+- lib/cyrax/presenters/decorated_collection.rb
+- lib/cyrax/resource.rb
 - lib/cyrax/response.rb
+- lib/cyrax/serializer.rb
+- lib/cyrax/serializers/scope.rb
 - lib/cyrax/version.rb
 - lib/cyrax.rb
 - LICENSE.txt
 - Rakefile
 - README.md
-- spec/cyrax/base_resource_spec.rb
 - spec/cyrax/base_spec.rb
 - spec/cyrax/callbacks_spec.rb
 - spec/cyrax/decorator_spec.rb
@@ -99,7 +102,9 @@ files:
 - spec/cyrax/extensions/has_resource_spec.rb
 - spec/cyrax/extensions/has_response_spec.rb
 - spec/cyrax/extensions/has_service_spec.rb
+- spec/cyrax/resource_spec.rb
 - spec/cyrax/response_spec.rb
+- spec/cyrax/serializer_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses:
@@ -116,9 +121,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.5
@@ -126,7 +131,6 @@ signing_key:
 specification_version: 4
 summary: Small library for adding service layer to Rails projects
 test_files:
-- spec/cyrax/base_resource_spec.rb
 - spec/cyrax/base_spec.rb
 - spec/cyrax/callbacks_spec.rb
 - spec/cyrax/decorator_spec.rb
@@ -135,5 +139,7 @@ test_files:
 - spec/cyrax/extensions/has_resource_spec.rb
 - spec/cyrax/extensions/has_response_spec.rb
 - spec/cyrax/extensions/has_service_spec.rb
+- spec/cyrax/resource_spec.rb
 - spec/cyrax/response_spec.rb
+- spec/cyrax/serializer_spec.rb
 - spec/spec_helper.rb

data/lib/cyrax/base_collection_presenter.rb

@@ -1,17 +0,0 @@
-class Cyrax::BaseCollectionPresenter
-  attr_reader :collection
-  
-  def initialize(collection, options = {})
-    @collection = collection
-  end
-
-  def fetched_collection
-    if collection.is_a?(ActiveRecord::Relation)
-      collection.to_a
-    elsif collection.respond_to?(:all)
-      collection.all
-    else
-      Array.wrap collection
-    end
-  end
-end

data/lib/cyrax/decorated_collection_presenter.rb

@@ -1,31 +0,0 @@
-class Cyrax::DecoratedCollectionPresenter < Cyrax::BaseCollectionPresenter
-  attr_reader :decorator
-
-  def initialize(collection, options = {})
-    super
-    @decorator = options[:decorator]
-    raise "Decorator class is not defined! Please define it with option :decorator" unless decorator
-  end
-
-  class << self
-    alias_method :decorate, :new
-  end
-
-  array_methods = Array.instance_methods - Object.instance_methods
-  delegate *array_methods, to: :decorated_collection
-
-  def decorated_collection
-    @decorated_collection ||= fetched_collection.map {|item| decorate_item(item)}
-  end
-
-  def method_missing(method, *args, &block)
-    return super unless collection.respond_to?(method)
-    collection.send(method, *args, &block)
-  end
-
-  private
-
-  def decorate_item(item)
-    decorator.new(item)
-  end
-end