asir_activerecord 1.0.8

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+-color -f d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asir_activerecord.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kurt Stephens
+
+MIT License
+
+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/README.md

@@ -0,0 +1,29 @@
+# AsirActiverecord
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'asir_activerecord'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asir_activerecord
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+
+# YUCK! http://stackoverflow.com/questions/4755900/how-to-make-jruby-1-6-default-to-ruby-1-9
+ENV['JRUBY_OPTS'] ||= '--1.9'
+
+require "bundler/gem_tasks"
+
+gem 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Default => :test"
+task :default => :test
+
+desc "Run all tests"
+task :test => [ :spec ]
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end

data/asir_activerecord.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+# -*- ruby -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asir_activerecord/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "asir_activerecord"
+  gem.version       = AsirActiverecord::VERSION
+  gem.authors       = ["Kurt Stephens"]
+  gem.email         = ["ks.ruby@kurtstephens.com"]
+  gem.description   = %q{ASIR ActiveRecord Transport}
+  gem.summary       = %q{Store ASIR Message and Result objects in ActiveRecord.}
+  gem.homepage = %q{http://github.com/kstephens/abstracting_services_in_ruby}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "asir", '>= 1.0.8'
+  gem.add_dependency "activerecord", '>= 3.0.0'
+  gem.add_development_dependency "pg", '>= 0.14.0'
+
+  gem.add_development_dependency 'rake', '>= 0.9.0'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'simplecov', '>= 0.1'
+end

data/lib/asir/coder/active_record.rb

@@ -0,0 +1,16 @@
+require 'asir'
+
+require 'active_record'
+
+module ASIR
+  class Coder
+    module ActiveRecord
+      MIGRATIONS = [ ]
+    end
+  end
+end
+
+require 'asir/coder/database'
+require 'asir/coder/active_record/message_model'
+require 'asir/coder/active_record/result_model'
+

data/lib/asir/coder/active_record/message_model.rb

@@ -0,0 +1,84 @@
+require 'asir/coder/active_record'
+
+module ASIR
+  class Coder
+    module ActiveRecord
+      class MessageModel < ::ActiveRecord::Base
+        class Migration < ::ActiveRecord::Migration
+          def self.table_name
+            :asir_messages
+          end
+          def self.class_table_name
+            :asir_classes
+          end
+          def change
+            create_table tn = self.class.class_table_name do | t |
+              t.integer :external_id
+              t.string  :class_name
+            end
+            add_index tn, :class_name, :unique => true
+
+            create_table tn = self.class.table_name do | t |
+              t.integer :external_id
+              t.string  :message_identifier, :null => false
+              t.string  :receiver_class,     :null => false # NORMALIZE?
+              t.string  :message_type,       :null => false, :size => 1
+              t.string  :selector # NORMALIZE?
+              t.binary  :additional_data
+              t.text    :description # NORMALIZE?
+              t.float   :delay
+              t.integer :one_way
+              t.binary  :payload
+              t.timestamps
+            end
+            add_index tn, :external_id
+            add_index tn, :message_identifier, :unique => true
+            add_index tn, [ :receiver_class, :message_type ]
+            add_index tn, :selector
+            add_index tn, :description
+            add_index tn, :created_at
+          end
+        end
+        ActiveRecord::MIGRATIONS << Migration
+
+        self.table_name = Migration.table_name.to_s
+
+        attr_accessor :object, :original_object
+
+        has_one :result, :class_name => 'ASIR::Coder::ActiveRecord::ResultModel'
+
+        validates_uniqueness_of :message_identifier
+        validates_presence_of :receiver_class
+        validates_presence_of :message_type
+        validates_presence_of :selector
+        validates_presence_of :payload
+
+        before_save :prepare_for_save!
+        def prepare_for_save!
+          if message = self.object
+            self.external_id ||= original_object[:external_id]
+            self.message_identifier ||= message.identifier
+            x = original_object.message_kind
+            self.receiver_class = x[0].to_s # original_object.receiver_class.name.to_s
+            self.message_type   = x[1].to_s
+            self.selector ||= message.selector.to_s
+            self.description ||= (original_object[:description] || original_object.description).to_s
+            self.payload ||= object_payload
+          end
+          if additional_data
+            raise TypeError, "additional_data is not a String" \
+              unless String === additional_data
+          end
+        end
+
+        after_save :update_original_object!
+        def update_original_object!
+          if original_object
+            original_object[:database_id] = self.id
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/asir/coder/active_record/result_model.rb

@@ -0,0 +1,82 @@
+require 'asir'
+require 'active_record/migration'
+require 'active_record/base'
+
+module ASIR
+  class Coder
+    module ActiveRecord
+      class ResultModel < ::ActiveRecord::Base
+        class Migration < ::ActiveRecord::Migration
+          def self.table_name
+            :asir_results
+          end
+          def change
+            create_table tn = self.class.table_name do | t |
+              t.integer :external_id
+              t.string  :message_id,      :null => false
+              t.string  :result_class,    :null => false  # NORMALIZE?
+              t.string  :exception_class                  # NORMALIZE?
+              t.text    :exception_message
+              t.text    :exception_backtrace
+              t.binary  :additional_data
+              t.binary  :payload
+              t.timestamps
+            end
+            add_index tn, :external_id
+            add_index tn, :message_id, :unique => true
+            add_index tn, :result_class
+            add_index tn, :exception_class
+            add_index tn, :exception_message
+            add_index tn, :created_at
+          end
+        end
+        ActiveRecord::MIGRATIONS << Migration
+
+        self.table_name = Migration.table_name.to_s
+
+        attr_accessor :object, :original_object, :message_object
+
+        belongs_to :message, :class_name => 'ASIR::Coder::ActiveRecord::MessageModel'
+
+        validates_uniqueness_of :message_id
+        validates_presence_of :message_id
+        validates_presence_of :result_class
+        validates_presence_of :payload
+
+        before_save :prepare_for_save!
+        def prepare_for_save!
+          if result = self.object
+            message = self.message_object || result.message
+            self.external_id ||= result[:external_id]
+            self.message_id  ||= result[:message_id]
+            if message
+              self.external_id ||= message[:external_id]
+              self.message_id  ||= message[:message_id]
+            end
+            self.result_class = result.result.class.name.to_s
+            if e = result.exception
+              e = EncapsulatedException.new(e) unless EncapsulatedException === e
+              self.exception_class = e.exception_class
+              self.exception_message = e.exception_message
+              self.exception_backtrace = (e.exception_backtrace * "\n") << "\n";
+            end
+          end
+          # self.message_id &&= self.message_id.to_i
+          # pp self
+          if additional_data
+            raise TypeError, "additional_data is not a String" \
+              unless String === additional_data
+          end
+        end
+
+        after_save :update_original_object!
+        def update_original_object!
+          if original_object
+            original_object[:database_id] = self.id
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/asir_activerecord.rb

@@ -0,0 +1,7 @@
+require "asir_activerecord/version"
+
+module AsirActiverecord
+end
+
+require 'asir'
+require 'asir/coder/active_record'

data/lib/asir_activerecord/version.rb

@@ -0,0 +1,3 @@
+module AsirActiverecord
+  VERSION = "1.0.8"
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,145 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+require 'asir/coder/yaml'
+require 'asir/coder/json'
+
+describe "ASIR::Coder::ActiveRecord" do
+  attr_accessor :message, :result, :data, :object, :coder, :transport
+
+  before :each do
+    self.data = { }
+    self.object = ASIR::Test::TestObject.new(nil)
+    self.message = ASIR::Message.new(object, nil, nil, nil, nil)
+    message.create_identifier!
+
+    self.result = ASIR::Result.new(message, nil)
+
+    ActiveRecord::Base.
+      establish_connection({
+                             :adapter => 'postgresql',
+                             :host => '127.0.0.1',
+                             :port => 5432,
+                             :username => 'test',
+                             :password => 'test',
+                             :database => 'test',
+                           })
+    # Probe for tables
+    begin
+      ASIR::Coder::ActiveRecord::MessageModel.find(:first)
+    rescue ActiveRecord::StatementInvalid => exc
+      if exc.message =~ /does not exist/
+        ASIR::Coder::ActiveRecord::MIGRATIONS.each do | m |
+          m.migrate(:up)
+        end
+      end
+    end
+    ASIR::Coder::ActiveRecord::MessageModel.delete_all
+    ASIR::Coder::ActiveRecord::ResultModel.delete_all
+
+    self.coder =
+      ASIR::Coder::Database.
+      new(
+      :message_model => ASIR::Coder::ActiveRecord::MessageModel,
+      :result_model  => ASIR::Coder::ActiveRecord::ResultModel,
+      :payload_coder => ASIR::Coder::Yaml.new,
+      :additional_data_coder => ASIR::Coder::JSON.new,
+      )
+  end
+
+  context "with sample Message and Result" do
+    attr_accessor :m, :r
+
+    before :each do
+      message.selector = :instance_method!
+      message.arguments = [ 1, "two", :three, 4.0 ]
+      message[:external_id] = 1234
+      message[:foo] = "bar"
+
+      result.result = "A String Result"
+    end
+  context "with saved MessageModel" do
+    before :each do
+      self.m = coder.prepare.encode(message)
+      m.prepare_for_save!
+      # $stderr.puts m.inspect
+      m.save!
+      m.id.should > 0
+      message[:database_id].should == m.id
+      self.m = m.class.find(m.id)
+      # $stderr.puts m.payload
+    end
+
+    it 'should encode Message.' do
+      m.external_id.should == message[:external_id]
+      m.receiver_class.should == message.receiver.class.name
+      m.message_type.should == '#'
+      m.selector.should == message.selector.to_s
+      ad = coder.additional_data_coder.prepare.decode(m.additional_data)
+      ad.keys.size.should == 2
+      ad['external_id'].should == message[:external_id]
+      ad['foo'].should == message[:foo]
+      m.description.should == "#{message.receiver.class.name}\##{message.selector}"
+      m.delay.should == nil
+      m.one_way.should == nil
+      m.payload.class.should == String
+    end
+
+    it 'should decode Message.' do
+      message_ = coder.prepare.decode(m)
+      message_.receiver.class.should == message.receiver.class
+      message_.selector.should == message.selector
+      message_.arguments.should == message.arguments
+      message_.description.should == message.description
+        ad = message.additional_data.dup
+        ad.delete(:database_id).should == m.id
+      message_.additional_data.should == ad
+    end
+
+      context "with saved ResultModel." do
+        before :each do
+          result[:external_id] = 3456
+          result[:bar] = "A String for Result"
+          # result.message = nil # Simulate Transport#...
+          self.r = coder.prepare.encode(result)
+          r.prepare_for_save!
+          # $stderr.puts m.inspect
+          r.save!
+          r.id.should > 0
+          result[:database_id].should == r.id
+          self.r = r.class.find(r.id)
+          # $stderr.puts r.payload
+        end
+
+        it 'should encode Result.' do
+          r.message_id.to_i.should == m.id
+          r.external_id.should == 3456
+          r.result_class.should == "String"
+          r.exception_class.should == nil
+          r.exception_message.should == nil
+          r.exception_backtrace.should == nil
+          # Note: JSON does not support Symbols.
+          ad = coder.additional_data_coder.prepare.decode(r.additional_data)
+          ade = result.additional_data
+          ad.keys.size.should == 2
+          ad['bar'].should == ade[:bar]
+          ad['external_id'].should == ade[:external_id]
+          r.payload.class.should == String
+        end
+
+        it 'should decode Result.' do
+          result_ = coder.prepare.decode(r)
+          result_.result.class.should == result.result.class
+          # Note: YAML does support Symbols.
+          ad = result_.additional_data
+          ade = result.additional_data.dup
+          ade.delete(:database_id).should == r.id
+          ad.should == ade
+        end
+
+      it 'should capture Unforwardable exceptions.' do
+      end
+    end
+  end # context
+  end # context
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+$:.unshift File.expand_path('../../../asir/lib', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'asir_activerecord'
+
+module ASIR
+  module Test
+    class TestError < ::Exception; end
+    class TestObject
+      include ASIR::Client
+      attr_accessor :spec, :arg, :cls, :msg, :transport, :message
+      def initialize spec
+        @spec = spec
+      end
+
+      def get_data!
+        @transport = ASIR::Transport.current
+        @message = @transport && @transport.message
+      end
+
+      def return_argument arg
+        get_data!
+        @arg = arg
+        arg
+      end
+
+      def raise_exception! cls, msg
+        get_data!
+        @cls = cls
+        @msg = msg
+        raise cls, msg
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: asir_activerecord
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Kurt Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asir
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: ASIR ActiveRecord Transport
+email:
+- ks.ruby@kurtstephens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asir_activerecord.gemspec
+- lib/asir/coder/active_record.rb
+- lib/asir/coder/active_record/message_model.rb
+- lib/asir/coder/active_record/result_model.rb
+- lib/asir_activerecord.rb
+- lib/asir_activerecord/version.rb
+- spec/active_record_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kstephens/abstracting_services_in_ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2428040061942589441
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2428040061942589441
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Store ASIR Message and Result objects in ActiveRecord.
+test_files:
+- spec/active_record_spec.rb
+- spec/spec_helper.rb