cardiac 0.2.0.pre2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffcee4b9c9da2df77d5d3530d5562848b497fdab
+  data.tar.gz: d0dc3f4297ef67ddc38f139be6b64b00b7ff4dc9
+SHA512:
+  metadata.gz: d01919339fec4e2519bc8b92479383d7c259247fcae5055e1a2722baceca9f91e070398660c04103a6fb0ffdb70c55faf23a9d04973e0faf24f8fdbf45cc9715
+  data.tar.gz: 55c38c5f11b07b8d92fc6d314d6c3a674bf8bfed80a936ab54b755042d185745d6fa76d217551d851772a00a418b664f24f24293f8df95fc0cb048df1b77f767

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Joe Khoobyar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rake'
+require 'bundler/gem_tasks'
+
+desc 'Default: Run all specs.'
+task :default => 'all:spec'
+
+namespace :all do
+
+  desc "Run specs on all spec apps"
+  task :spec do
+    success = true
+    for_each_directory_of('spec/**/Rakefile') do |directory|
+      env = "SPEC=../../#{ENV['SPEC']} " if ENV['SPEC']
+      success &= system("cd #{directory} && #{env} bundle exec rake spec")
+    end
+    fail "Tests failed" unless success
+  end
+
+  namespace :bundle do
+
+    desc "Bundle all spec apps"
+    task :install do
+      for_each_directory_of('spec/**/Gemfile') do |directory|
+        Bundler.with_clean_env do
+          system("cd #{directory} && bundle install")
+        end
+      end
+    end
+
+    desc "Update all gems, or a list of gem given by the GEM environment variable"
+    task :update do
+      for_each_directory_of('spec/**/Gemfile') do |directory|
+        Bundler.with_clean_env do
+          system("cd #{directory} && bundle update #{ENV['GEM']}")
+        end
+      end
+    end
+
+  end
+
+end
+
+#desc "Bundle the gem"
+#task :bundle  => [:bundle_install] do
+#  sh 'gem build *.gemspec'
+#  sh 'gem install *.gem'
+#  sh 'rm *.gem'
+#end
+#
+#desc "Runs bundle install"
+#task :bundle_install do
+#  sh('bundle install')
+#end
+
+desc "generate rdoc"
+task :rdoc do
+  sh "yardoc"
+end
+
+def for_each_directory_of(path, &block)
+  Dir[path].sort.each do |rakefile|
+    directory = File.dirname(rakefile)
+    puts '', "\033[44m#{directory}\033[0m", ''
+    block.call(directory)
+  end
+end

data/cardiac.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cardiac/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cardiac"
+  s.version     = Cardiac::VERSION
+  s.authors     = ["Joe Khoobyar"]
+  s.email       = ["joe@khoobyar.name"]
+  s.homepage    = "http://github.com/cardiac/cardiac"
+  s.license     = 'MIT'
+  s.summary     = %q{ Cardiac: a REST modeling framework for Ruby }
+  s.description = %q{
+    This gem provides a thin facade around REST-ful resources, aiming to be closer to ActiveRecord than ActiveResource.
+  }
+
+  s.rubyforge_project = "cardiac"
+  
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.files = (Dir.glob("*") + Dir.glob("lib/**/*")).delete_if do |item|
+              item.include?("rdoc") ||
+              item.include?(".git")
+            end
+  s.require_paths = ["lib"]
+  
+  s.test_files = (['.rspec'] + Dir.glob("spec/**/*")).delete_if do |item|
+              item.include?("rdoc") ||
+              item.include?(".git")
+            end
+            
+  s.add_development_dependency 'rake',        '~> 10.1'
+  s.add_development_dependency 'rspec',       '~> 3.0', '< 3.1'
+  s.add_development_dependency 'rspec-rails', '~> 3.0', '< 3.1'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
+  
+  s.add_runtime_dependency "rack",          '>= 1.4.5'
+  s.add_runtime_dependency "rack-cache",    '~> 1.2'
+  s.add_runtime_dependency "rack-client",   '~> 0.4.2'
+  s.add_runtime_dependency "activesupport", '>= 3.2', '< 4.1'
+  s.add_runtime_dependency "multi_json",    '~> 1.0'
+  s.add_runtime_dependency "json",          '> 1.8.0'
+  s.add_runtime_dependency "mime-types",    '> 1.1'
+  s.add_runtime_dependency "i18n",          '~> 0.6', '>= 0.6.4'
+  s.add_runtime_dependency "activemodel",   '>= 3.2', '< 4.1'
+  s.add_runtime_dependency "active_attr",   '>= 0.8.2'
+  
+end

data/lib/cardiac/declarations.rb

@@ -0,0 +1,70 @@
+module Cardiac
+  class DeclarationBuilder < ::Cardiac::ExtensionBuilder
+    # Overridden to build directly on a resource/subresource.
+    def initialize(base, extension_module=nil)
+      case base
+      when ::Cardiac::Resource
+        builder = ::Cardiac::Subresource.new(base)
+      when ::URI, ::String
+        builder = ::Cardiac::Resource.new(base)
+      else
+        raise ArgumentError, 'a base URI or Resource must be provided'
+      end
+      super builder, extension_module
+    end
+
+    # Overridden to return an extended resource/subresource,
+    # but skip building the extension module if no block is given.
+    def extension_exec(*args, &block)
+      builder = super(*args, &block)
+      builder.extending(__extension_module__) if block
+      builder
+    end
+  end
+
+  module DeclarationMethods
+    
+    # Declares a new resource off of the given base, using the given extension block.
+    def resource base, &declaration
+      DeclarationBuilder.new(base).extension_eval(&declaration)
+    end
+  
+    # Dynamically declares a new subresource (optionally targetting a given sub-url),
+    # and yields a new OperationProxy which targets that subresource.
+    def with_resource(at=nil)
+      yield OperationProxy.new(at ? Subresource.new(base_resource).at(at) : base_resource)
+    end
+  end
+  
+  module Declarations
+    extend ActiveSupport::Concern
+    
+    included do
+      if respond_to? :class_attribute
+        class_attribute :base_resource, instance_reader: false, instance_writer: false
+      else
+        mattr_accessor :base_resource, instance_reader: false, instance_writer: false
+      end
+    end
+    
+    # Extensions for a class or even a module, so it may declare resources.
+    module ClassMethods
+      include DeclarationMethods
+      
+      delegate :base_url, to: :base_resource
+    
+      # Overridden to always write to the base_resource
+      def resource base=base_resource, &declaration
+        self.base_resource = super(base, &declaration)
+      end
+    end
+    
+    # Instance-level extensions for declaring resources.
+    include DeclarationMethods
+    
+    # These start out as private, especially since an instance-level :with_resource
+    # would need an instance-level implementation of :base_resource
+    private :resource, :with_resource
+  end
+
+end

data/lib/cardiac/errors.rb

@@ -0,0 +1,65 @@
+module Cardiac
+  
+  # Exception classes.
+  class ProtocolError < StandardError
+  end
+  class ResourceError < StandardError
+  end
+  class UnresolvableResourceError < ResourceError
+  end
+  class InvalidOperationError < ResourceError
+  end
+  class InvalidRepresentationError < ResourceError
+  end
+  class OperationAbortError < ResourceError
+  end
+  class OperationFailError < ResourceError
+  end
+  
+  # Thrown when a request has failed, due to a non-2xx status code.
+  class RequestFailedError < ResourceError
+    attr_reader :response
+    def initialize(response,message=nil)
+      @response = response
+      super(message || Rack::Utils::HTTP_STATUS_CODES[@response.status])
+    end
+  end
+  
+  # @see ActiveRecord::RecordInvalid
+  class RecordInvalid < ResourceError
+    attr_reader :record # :nodoc:
+    def initialize(record) # :nodoc:
+      @record = record
+      
+      errors = @record.errors.full_messages.join(", ")
+      remote_errors = @record.remote_errors.full_messages.join(", ")
+      
+      if remote_errors.present?
+        remote_errors = "(previous remote operation) #{remote_errors}"
+        errors += ' ' if errors.present?
+      end
+      
+      super I18n.t(:"#{@record.class.i18n_scope}.errors.messages.record_invalid",
+                   errors:        errors,
+                   remote_errors: remote_errors,
+                   default:       :"errors.messages.record_invalid")
+    end
+  end
+    
+  # @see ActiveRecord::RecordNotFound
+  class RecordNotFound < OperationFailError
+  end
+  
+  # @see ActiveRecord::RecordNotSaved
+  class RecordNotSaved < OperationFailError
+  end
+  
+  # @see ActiveRecord::RecordNotDestroyed
+  class RecordNotDestroyed < OperationFailError
+  end
+  
+  # @see ActiveRecord::ReadOnlyRecord
+  class ReadOnlyRecord < OperationFailError
+  end
+  
+end

data/lib/cardiac/log_subscriber.rb

@@ -0,0 +1,55 @@
+module Cardiac
+  
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    
+    delegate :logger, to: '::Cardiac::Model::Base'
+
+    def initialize
+      super
+      @odd_or_even = false
+    end
+
+    def operation(event)
+      return unless logger.debug?
+
+      payload = event.payload
+      
+      url   = payload[:url]
+      stats = "#{event.duration.round(1)}ms"
+      stats = "CACHED #{stats}" if /fresh/ === payload[:response_headers].try(:[],'X-Rack-Client-Cache')
+      name  = "#{payload[:name]} #{payload[:verb]} (#{stats})"
+
+      if extra = payload.except(:name, :verb, :url, :response_headers).presence
+        extra = "  " + extra.map{|key,value|
+                   key = key.to_s.underscore.upcase
+                   "#{key}: #{key=='PAYLOAD' ? value : value.inspect}"
+                 }.join(",\n\t +")
+      end
+
+      if odd?
+        name = color(name, CYAN, true)
+        url  = color(url, nil, true)
+      else
+        name = color(name, MAGENTA, true)
+      end
+
+      debug "  #{name}  #{url}#{extra}"
+    end
+
+    def identity(event)
+      return unless logger.debug?
+
+      name = color(event.payload[:name], odd? ? CYAN : MAGENTA, true)
+      line = odd? ? color(event.payload[:line], nil, true) : event.payload[:line]
+
+      debug "  #{name}  #{line}"
+    end
+
+    def odd?
+      @odd_or_even = !@odd_or_even
+    end
+  end
+      
+  # Make sure that the log subscriber is listening for events.
+  LogSubscriber.attach_to :cardiac
+end

data/lib/cardiac/model/attributes.rb

@@ -0,0 +1,146 @@
+module Cardiac
+  module Model
+    
+    # Cardiac::Model attribute methods.
+    # Some of this has been "borrowed" from ActiveRecord.
+    module Attributes
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+      
+        # Overridden to support passing in aliases at the same time.
+        # This could decrease the code size for attributes declarations by almost 50% for models with
+        # non-friendly remote attribute names.
+        def attribute(name,options={})
+          aliases = Array(options[:aliases])
+          super name, options.except(:aliases)
+          aliases.each{|k| alias_attribute k, name } if aliases
+        end
+
+      protected
+              
+        # Unwraps a payload returned by the remote, requiring it to be present.
+        #
+        # Callers could pass <code>{allow_empty: true}</code> in the options to prevent
+        # empty results from being converted to <code>nil</code>.
+        def unwrap_remote_data(data,options={})
+          data = data.values.first if Hash===data && data.keys.size==1 && data.keys.first.to_s!='errors'
+          data = data.presence unless options[:allow_empty]
+          data
+        end
+      end
+      
+      included do
+        class_attribute :readonly_attributes, instance_writer: false
+        class_attribute :key_attributes, instance_writer: false
+        class_attribute :id_delimiter
+        
+        self.readonly_attributes = []
+        self.key_attributes = [:id]
+        self.id_delimiter = '-'
+      end
+    
+      # Retrieves the most recently unpacked/decoded remote attributes.
+      def remote_attributes
+        @remote_attributes.with_indifferent_access
+      end
+      
+      # Overridden to use this model's key_attributes to build the key.
+      # Returns an array of the key values, if they are all present, otherwise, returns nil.
+      def to_key
+        keys = key_attributes.presence and keys.map do |key|
+          return unless query_attribute(key)
+          read_attribute(key)
+        end
+      end
+      
+      # This baseline implementation uses this model's id_delimiter to join what is returned by to_key.
+      # If the id_delimiter is set to nil, it will simply return an array instead.
+      #
+      # NOTE: Defining an :id attribute on your model will override this implementation.
+      def id
+        delim, values = id_delimiter, to_key
+        (delim && values) ? values.join(delim) : values
+      end
+      
+    protected
+
+      # Stores the attributes returned by the remote, after performing any unpacking/decoding.
+      def assign_remote_attributes(data,options={})
+        @remote_attributes = Hash[
+          decode_remote_attributes(unwrap_remote_attributes(data, options), options).map do |key,value|
+            [key, value.duplicable? ? value.clone : value]
+          end
+        ]
+      end
+      
+      alias remote_attributes= assign_remote_attributes
+  
+      # Returns a copy of this model's attributes, cloning the duplicable values.
+      def clone_attributes(reader_method = :read_attribute, attributes = {}) # :nodoc:
+        attribute_names.each do |name|
+          attributes[name] = clone_attribute_value(reader_method, name)
+        end
+        attributes
+      end
+  
+      # Reads an attribute value and returns a clone, if it is duplicable, or the original value, if not.
+      def clone_attribute_value(reader_method, attribute_name) # :nodoc:
+        value = send(reader_method, attribute_name)
+        value.duplicable? ? value.clone : value
+      rescue TypeError, NoMethodError
+        value
+      end
+
+      # Unwraps attributes returned by the remote, requiring the data to be non-empty.
+      #
+      # Callers could pass <code>{allow_empty: true}</code> in the options to prevent
+      # empty results from being converted to <code>nil</code>.
+      #
+      # NOTE: The baseline implementation just delegates to the class method: unwrap_remote_data
+      def unwrap_remote_attributes(data,options={})
+        self.class.send :unwrap_remote_data, data, options
+      end
+      
+      # Decodes attributes returned by the remote, requiring the data to be non-nil.
+      # Callers could pass <code>{only: ...}</code> or <code>{except: ...}</code> in the options
+      # to filter the attributes by key.
+      #
+      # If the remote did not return a Hash, the data is first wrapped in a single key: <code>:data</code>
+      def decode_remote_attributes(data,options={})
+        unless data.nil?
+          data = Hash===data ? data.with_indifferent_access : {data: data}
+          data = data.slice(*options[:only]) if options[:only]
+          data = data.except(*options[:except]) if options[:except]
+        end
+        data
+      end
+
+    private
+      
+      # Filters the primary keys and readonly attributes from the attribute names.
+      def attributes_for_update(attribute_names)
+        attributes.slice(*attribute_names).except(*(readonly_attributes+key_attributes))
+      end
+  
+      # Filters out the primary keys, from the attribute names, when the primary
+      # key is to be generated (e.g. the id attribute has no value).
+      def attributes_for_create(attribute_names)
+        attributes.slice(*attribute_names).except(*key_attributes.reject{|k| query_attribute(k) })
+      end
+  
+      def readonly_attribute?(name)
+        self.class.readonly_attributes.include?(name)
+      end
+  
+      def key_attribute?(name)
+        self.class.key_attributes.include?(name)
+      end
+  
+      # No seralized attribute support yet.
+      def serialized_attribute_value(name)
+        read_attribute(name)
+      end
+    end
+  end
+end

data/lib/cardiac/model/base.rb

@@ -0,0 +1,161 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_attr'
+
+module Cardiac
+  module Model
+    class Base
+      include ActiveAttr::Model
+      include Cardiac::Model::Attributes
+      include Cardiac::Model::Querying
+      include Cardiac::Model::Persistence
+      include Cardiac::Model::Validations
+      include Cardiac::Model::Dirty
+      include Cardiac::Model::Callbacks
+      include Cardiac::Model::Declarations
+      include Cardiac::Model::Operations
+      include ActiveSupport::Configurable
+      
+      # Instances may not explicitly define their own base resource.
+      undef_method :resource if method_defined? :resource
+			
+      # Expose instance-level with_resource since there is a useful instance-level implementation of base_resource.
+      public :with_resource
+      
+      config_accessor :operation_context
+      self.operation_context = {}.with_indifferent_access
+      
+      # @see ActiveRecord::Core
+      mattr_accessor :logger, instance_writer: false
+      
+      # Configure whether or not to treat all instances as read-only.
+      class_attribute :readonly, instance_writer: false
+      
+      # Subclasses have an internationalization scope separate from active model.
+      def self.i18n_scope
+        :cardiac_model
+      end
+      
+      # @see ActiveRecord::Core#initialize
+      def initialize(attributes = nil, options = {})
+        super
+        init_internals
+        init_changed_attributes
+        run_callbacks :initialize unless _initialize_callbacks.empty?
+      end
+
+      # @see ActiveRecord::Core#init_with
+      def init_with(coder)
+        _remote = coder['remote']
+        self.attributes = _remote ? {} : coder['attributes']
+        init_internals
+        @new_record = false
+        if _remote
+          _remote = {} unless Hash===_remote
+          self.attributes = decode_remote_attributes( unwrap_remote_attributes(coder['attributes'], _remote),
+                                                      _remote )
+          @changed_attributes.clear
+        end
+        run_callbacks :find
+        run_callbacks :initialize
+        self
+      end
+      
+      # @see ActiveRecord::Core#slice
+      def slice(*methods)
+        Hash[methods.map { |method| [method, public_send(method)] }].with_indifferent_access
+      end
+      
+      # @see ActiveRecord::Core#inspect
+      def inspect
+        defined?(@attributes) && @attributes ? super : "#<#{self.class} not initialized>"
+      end
+      
+      # @see ActiveRecord::Core#encode_with
+      def encode_with(coder)
+        coder['attributes'] = attributes
+      end
+
+      # @see ActiveRecord::Core#==
+      def ==(comparison_object)
+        super ||
+          comparison_object.instance_of?(self.class) &&
+          id.present? &&
+          comparison_object.id == id
+      end
+      alias :eql? :==
+
+      # @see ActiveRecord::Core#hash
+      def hash
+        id.hash
+      end
+
+      # @see ActiveRecord::Core#freeze
+      def freeze
+        @attributes = @attributes.clone.freeze
+        self
+      end
+
+      # @see ActiveRecord::Core#frozen
+      def frozen?
+        @attributes.frozen?
+      end
+
+      # @see ActiveRecord::Core#<=>
+      def <=>(other_object)
+        if other_object.is_a?(self.class)
+          self.to_key <=> other_object.to_key
+        end
+      end
+
+      # @see ActiveRecord::Core#readonly?
+      def readonly?
+        @readonly
+      end
+
+      # @see ActiveRecord::Core#readonly!
+      def readonly!
+        @readonly = true
+      end
+      
+    private
+
+      # @see ActiveRecord::Core#init_changed_attributes
+      def init_changed_attributes
+        attribute_defaults.each do |name,value|
+          @changed_attributes[name] = value if _field_changed?(name, value, @attributes[name])
+        end
+      end
+
+      # Under Ruby 1.9, Array#flatten will call #to_ary (recursively) on each of the elements
+      # of the array, and then rescues from the possible NoMethodError. If those elements are
+      # ActiveRecord::Base's, then this triggers the various method_missing's that we have,
+      # which significantly impacts upon performance.
+      #
+      # So we can avoid the method_missing hit by explicitly defining #to_ary as nil here.
+      #
+      # See also http://tenderlovemaking.com/2011/06/28/til-its-ok-to-return-nil-from-to_ary.html
+      def to_ary # :nodoc:
+        nil
+      end
+
+      # @see ActiveRecord::Core#init_internals
+      def init_internals
+        @attributes ||= {}
+          
+        self.class.key_attributes.each do |key|
+          @attributes[key] = nil unless @attributes.key?(key)
+        end
+
+        @previously_changed       = {}
+        @changed_attributes       = {}
+        @readonly                 = !! self.class.readonly?
+        @destroyed                = false
+        @new_record               = true
+        @remote_attributes        = {}
+      end
+    end
+    
+    ActiveSupport.run_load_hooks(:cardiac, Base)
+  end
+
+end