platanus 0.0.17 → 0.0.19

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
 ## Tools & Usage
 
+### Enum
+
+TODO: Write usage instructions here
+
 ### Stacked
 
 TODO: Write usage instructions here

data/lib/platanus/api_base.rb

@@ -20,24 +20,24 @@ module Platanus
       base.rescue_from 'Exception' do |exc|
         logger.error exc.message
         logger.error exc.backtrace.join("\n")
-        api_respond_error(:internal_server_error, { type: exc.class.to_s, msg: exc.message } )
+        api_respond_error(:internal_server_error, { msg: 'server_error', exception: { type: exc.class.to_s, msg: exc.message } } )
       end
 
       base.rescue_from 'ActiveRecord::RecordNotFound' do |exc|
-        api_respond_error(:not_found)
+        api_respond_error(:not_found, { msg: 'record_not_found', detail: exc.message })
       end
 
-      base.rescue_from 'ActiveRecord::RecordInvalid' do |exc|
-        api_respond_error(:unprocessable_entity, { why: 'invalid', errors: exc.record.errors } )
+      base.rescue_from 'ActiveModel::MassAssignmentSecurity::Error' do |exc|
+        api_respond_error(:bad_request, { msg: 'protected_attributes', detail: exc.message } )
       end
 
-      base.rescue_from 'ActiveModel::MassAssignmentSecurity::Error' do |exc|
-        api_respond_error(:bad_request, { why: 'attribute_protected' } )
+      base.rescue_from 'ActiveRecord::RecordInvalid' do |exc|
+        api_respond_error(:bad_request, { msg: 'invalid_attributes', errors: exc.record.errors } )
       end
 
       # Platanus error support (of course)
       base.rescue_from 'Platanus::StatusError' do |exc|
-        api_respond_error(exc.status, exc)
+        api_respond_error(exc.status, { msg: exc.message })
       end
 
       base.extend ClassMethods
@@ -67,6 +67,9 @@ module Platanus
     # # Enables cors
     def enable_cors
       # TODO: maybe cors support should be implemented as a middleware.
+      # response.headers['Access-Control-Allow-Headers'] = 'X-Requested-With,Content-Type'
+      # response.headers['Access-Control-Allow-Methods'] = 'OPTIONS,GET,HEAD,POST,PUT,DELETE'
+      # response.headers['Access-Control-Allow-Origin'] = '*'
     end
 
   end
@@ -77,7 +80,6 @@ module Platanus
     def api_respond_empty(_options={})
       _options[:json] = {}
       api_respond_with(_options)
-      render_headers
     end
 
     # # Renders a regular response
@@ -92,7 +94,6 @@ module Platanus
       respond_with(*_params) do |format|
         format.json { render _options }
       end
-      render_headers
     end
 
     # # Renders an error response
@@ -104,13 +105,6 @@ module Platanus
       respond_with do |format|
         format.json { render :status => _status, :json => _error_obj }
       end
-      render_headers
-    end
-
-    def render_headers
-      response.headers['Access-Control-Allow-Headers'] = 'X-Requested-With,Content-Type'
-      response.headers['Access-Control-Allow-Methods'] = 'OPTIONS,GET,HEAD,POST,PUT,DELETE'
-      response.headers['Access-Control-Allow-Origin'] = '*'
     end
 
   end

data/lib/platanus/canned.rb

@@ -204,8 +204,8 @@ module Platanus
         # This can optionally take an inherit parameter to use
         # another profile as base for the new one.
         def profile(_name, _options={})
-          inherit = _options.fetch(:inherits,nil)
-          def_test = _options.fetch(:default,:equals)
+          inherit = _options.fetch(:inherits, nil)
+          def_test = _options.fetch(:default, :equals)
           yield self.profiles[_name.to_s] = BProfile.new(self,self.profiles[inherit],def_test)
         end
 

data/lib/platanus/http_helpers.rb

@@ -8,25 +8,20 @@ module Platanus
 
   # Allows to use an exception driven scheme to notify
   # the request that a especial status should be send
-  # back to the client. Usefull when used with rescue_from.
+  # back to the client.
+  # Usefull when used with +api_base+ or +rescue_from+.
   class StatusError < StandardError
 
     class << self
       instance_variable_set(:@status, nil)
-      instance_variable_set(:@msg, nil)
     end
 
-    def self.setup(_status, _msg)
+    def self.setup(_status)
       @status = _status
-      @msg = _msg
     end
 
     def self.status; @status; end
-    def self.message; @msg; end
-
-    def self.as_json(_options={})
-      { 'status' => @status.to_s, 'msg' => @msg }
-    end
+    def self.message; "status_#{@status.to_s}"; end
 
     def initialize(_msg=nil)
       @msg = _msg
@@ -34,28 +29,25 @@ module Platanus
 
     def status; self.class.status; end
     def message; if @msg.nil? then self.class.message else @msg end; end
-    def as_json(_options={})
-      { 'status' => status.to_s, 'msg' => message }
-    end
   end
 
   class StatusNotFound < StatusError
-    setup :not_found, 'Not found'
+    setup :not_found
   end
 
   class StatusUnauthorized < StatusError
-    setup :unauthorized, 'Not authorized'
+    setup :unauthorized
   end
 
   class StatusUnprocessable < StatusError
-    setup :unprocessable_entity, 'Invalid object'
+    setup :unprocessable_entity
   end
 
   class StatusBadRequest < StatusError
-    setup :bad_request, 'Invalid parameters'
+    setup :bad_request
   end
 
   class StatusConflict < StatusError
-    setup :conflict, 'Model conflict'
+    setup :conflict
   end
 end

data/lib/platanus/stacked.rb

@@ -8,6 +8,8 @@ module Platanus
   #
   module StackedAttr
 
+    class NotSupportedError < StandardError; end
+
     def self.included(base)
       base.extend ClassMethods
     end
@@ -18,70 +20,77 @@ module Platanus
       def has_stacked(_name, _options={}, &block)
 
         tname = _name.to_s
+        tname_single = tname.singularize
+
         to_cache = _options.delete(:cached)
         to_cache_prf = if _options[:cache_prf].nil? then 'last_' else _options.delete(:cache_prf) end
-        stack_key = if _options[:stack_key].nil? then 'created_at DESC, id DESC' else _options.delete(:stack_key) end
 
         # Retrieve callbacks
         before_push = _options.delete(:before_push)
         after_push = _options.delete(:after_push)
 
-        _options[:order] = stack_key
+        raise NotSupportedError.new('Only autosave mode is supported') if _options[:autosave] == false
+
+        _options[:order] = 'created_at DESC, id DESC'
         _options[:limit] = 10 if _options[:limit].nil?
 
-        # Protect cached attributes.
+        # Prepare cached attributes, generate read-only aliases without prefix.
         unless to_cache.nil?
-          to_cache = to_cache.map { |name| name.to_s }
-          to_cache.each { |name| attr_protected(to_cache_prf + name) }
+          to_cache = to_cache.map do |name|
+            name = name.to_s
+            # attr_protected(to_cache_prf + name)
+            send :define_method, name do self.send(to_cache_prf + name) end
+            name
+          end
         end
 
         private
-        has_many(_name,_options)
+        has_many _name, _options
         public
 
-        send :define_method, 'push_' + tname[0...-1] + '!' do |obj|
+        send :define_method, "push_#{tname_single}!" do |obj|
           self.class.transaction do
 
-            # Execute before callbacks
+            # execute before callbacks
             self.send(before_push, obj) unless before_push.nil?
             block.call(self, obj) unless block.nil?
 
-            # Cache required fields
+            # cache required fields
             unless to_cache.nil?
               to_cache.each { |name| send(to_cache_prf + name + '=', obj.send(name)) }
             end
 
-            # Save model and push attribute, cache last stacked attribute.
-            self.save! if _options.fetch(:autosave, true) and (self.new_record? or self.changed?)
+            # push attribute, this will save the model if new.
             raise ActiveRecord::RecordInvalid.new(obj) unless self.send(tname).send('<<',obj)
-            @_stacked_last = obj
 
-            # Execute after callback
+            # update inverse association if posible
+            if self.attributes.has_key? "top_#{tname_single}_id"
+              self["top_#{tname_single}_id"] = obj.id
+            else
+              @_stacked_last = obj
+            end
+
+            # execute after callback
             self.send(after_push, obj) unless after_push.nil?
+
+            self.save! if self.changed? # Must save again, no other way...
           end
         end
 
-        send :define_method, 'push_' + tname[0...-1] do |obj|
+        send :define_method, "push_#{tname_single}" do |obj|
           begin
-            return self.send('push_' + tname[0...-1] + '!', obj)
+            return self.send("push_#{tname_single}!", obj)
           rescue ActiveRecord::RecordInvalid
             return false
           end
         end
 
-        send :define_method, 'top_' + tname[0...-1] do
-          # Storing the last stacked value will not prevent race conditions
-          # when simultaneous updates occur.
-          return @_stacked_last unless @_stacked_last.nil?
-          @_stacked_last = self.send(_name).first
-        end
-
-        # Generate shorcut properties for cached attributes.
-        unless to_cache.nil?
-          to_cache.each do |name|
-            send :define_method, name.to_s do
-              self.send(to_cache_prf + name)
-            end
+        unless self.column_names.include? "top_#{tname_single}_id"
+          send :define_method, "top_#{tname_single}" do
+            # Storing the last stacked value will not prevent race conditions
+            # when simultaneous updates occur.
+            return @_stacked_last unless @_stacked_last.nil?
+            @_stacked_last = self.send(_name).first
           end
         end
       end

data/lib/platanus/version.rb

@@ -1,3 +1,3 @@
 module Platanus
-  VERSION = "0.0.17"
+  VERSION = "0.0.19" # 0.1 will come with tests!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: platanus
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-10-03 00:00:00.000000000 Z
 dependencies: []
 description: Platan.us utility gem
 email:
@@ -70,3 +70,4 @@ summary: This gem contains various ruby classes used by Platanus in our rails pr
 test_files:
 - spec/canned_spec.rb
 - spec/spec_helper.rb
+has_rdoc: