ayl-rails 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'ayl', ">= 0.1.0"
+gem 'rails', ">= 3.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.3.0"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.6.4"
+  gem "rcov", ">= 0"
+  gem "sqlite3" # This is used for the spec tests (setting up activerecord models)
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.2)
+      actionpack (= 3.1.2)
+      mail (~> 2.3.0)
+    actionpack (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.0)
+    activemodel (3.1.2)
+      activesupport (= 3.1.2)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.2)
+      activemodel (= 3.1.2)
+      activesupport (= 3.1.2)
+    activesupport (3.1.2)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    ayl (0.1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.3)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.2)
+      actionmailer (= 3.1.2)
+      actionpack (= 3.1.2)
+      activerecord (= 3.1.2)
+      activeresource (= 3.1.2)
+      activesupport (= 3.1.2)
+      bundler (~> 1.0)
+      railties (= 3.1.2)
+    railties (3.1.2)
+      actionpack (= 3.1.2)
+      activesupport (= 3.1.2)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sprockets (2.1.1)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ayl (>= 0.1.0)
+  bundler (>= 1.0.0)
+  jeweler (>= 1.6.4)
+  rails (>= 3.0.0)
+  rcov
+  rspec (>= 2.3.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 j0hnds@gmail.com
+
+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.rdoc

@@ -0,0 +1,19 @@
+= ayl-rails
+
+Description goes here.
+
+== Contributing to ayl-rails
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 j0hnds@gmail.com. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ayl-rails"
+  gem.homepage = "http://github.com/j0hnds/ayl-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{Ayl Extension for Rails ActiveRecord support.}
+  gem.description = %Q{Ayl Extension for Rails ActiveRecord support.}
+  gem.email = "j0hnds@gmail.com"
+  gem.authors = ["j0hnds@gmail.com"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ayl-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ayl-rails.rb

@@ -0,0 +1 @@
+require 'ayl-rails/railtie'

data/lib/ayl-rails/railtie.rb

@@ -0,0 +1,87 @@
+module Ayl
+
+  class Railtie < ::Rails::Railtie
+
+    # The hooks to be created/installed on ActiveRecord::Base
+    HOOKS = [ :after_update, :after_create, :after_save ]
+
+    initializer "Ayl::Railtie.extend" do
+      # Want the ayl_send/opts at the instance level
+      ActiveRecord::Base.send :include, Extensions
+      # Want the instance-level stuff there.
+      ActiveRecord::Base.send :include, InstanceExtensions
+      # Want the ayl_send/opts at the class level as well
+      ActiveRecord::Base.send :extend, Extensions
+    end
+
+    initializer "Ayl::Railtie.hooks" do
+
+      class << ActiveRecord::Base
+
+        # Add each of the hooks to ActiveRecord::Base
+        HOOKS.each do | hook |
+          method_code = <<-EOF
+            def ayl_#{hook}(*args, &block)
+              add_ayl_hook(#{hook.inspect}, *args, &block)
+            end
+          EOF
+          class_eval(method_code, __FILE__, __LINE__ - 1)
+        end
+
+        def add_ayl_hook(hook, *args, &block)
+          if args && args.first.is_a?(Symbol)
+            method = args.shift
+            ayl_hooks[hook] << lambda{|o| o.send(method)}
+          else
+            ayl_hooks[hook] << block
+          end
+        end
+
+        def ayl_hooks
+          @ayn_hooks ||= Hash.new do |hash, hook|
+            # Remember: this block is invoked only once for each
+            # access of a key that has not been used before.
+            
+            # Define the name of a method that the standard hook
+            # method will call when the standard hook fires
+            ahook = "_ayl_#{hook}".to_sym
+            
+            # This is for the producer's benefit
+            # So, this is the equivalent of performing the following
+            # in the ActiveRecord class:
+            # 
+            #   after_create { |o| ayl_send(:_ayl_after_create, o)
+            #
+            # What this means is that the block will be executed after
+            # the model has been save/created.
+            #
+            # So, the self.class target for the ayl_send is because we
+            # need to call the ayl_send method at the singleton level.
+            #
+            send(hook) { |o| self.class.ayl_send(ahook, o) }
+
+            # This is for the worker's benefit
+            #
+            # This defines the instance method
+            method_code = <<-EOF
+              def #{ahook}(o)
+                _run_ayl_hooks(#{hook.inspect}, o)
+              end
+            EOF
+            instance_eval(method_code, __FILE__, __LINE__ - 1)
+
+            hash[hook] = []
+          end
+        end
+
+        def _run_ayl_hooks(hook, o)
+          ayl_hooks[hook].each { |b| b.call(o) }
+        end
+
+      end
+      
+    end
+
+  end
+
+end

data/spec/rails_extensions_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+module ClassMethod; end
+
+class ClassMethod::MyModel < ActiveRecord::Base
+
+  def self.the_async_method(arg1, arg2)
+    WhatHappened.instance << "the static async method(#{arg1}, #{arg2})"
+  end
+
+end
+
+
+module InstanceMethod; end
+
+class InstanceMethod::MyModel < ActiveRecord::Base
+
+  def the_async_method(arg1, arg2)
+    WhatHappened.instance << "the instance async method(#{arg1}, #{arg2})"
+  end
+
+end
+
+module AfterSave; end
+
+# Setup the class to deal with a before_save callback
+class AfterSave::MyModel < ActiveRecord::Base
+  ayl_after_save :handle_after_save
+
+  private
+
+  def handle_after_save
+    WhatHappened.instance << "handle after save"
+  end
+end
+
+module AfterUpdate; end
+
+# Setup the class to deal with a before_save callback
+class AfterUpdate::MyModel < ActiveRecord::Base
+  ayl_after_update :handle_after_update
+
+  private
+
+  def handle_after_update
+    WhatHappened.instance << "handle after update"
+  end
+end
+
+module AfterCreate; end
+
+# Setup the class to deal with a before_save callback
+class AfterCreate::MyModel < ActiveRecord::Base
+  ayl_after_create :handle_after_create
+
+  private
+
+  def handle_after_create
+    WhatHappened.instance << "handle after create"
+  end
+end
+
+describe "Rails Extensions" do
+
+  before(:each) do
+    # Set up a null logger
+    Ayl::Logger.instance.logger = Ayl::NullLogger.new
+
+    # Set up an in-memory database so that we can quickly do ActiveRecord
+    # tests.
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3',
+                                            :database => ":memory:")
+
+    ActiveRecord::Schema.define do
+      create_table :my_models do |t|
+        t.column :name, :string
+      end
+    end
+
+  end
+
+  after(:each) do
+    WhatHappened.instance.clear
+  end
+
+  context "when handling lifecycle callbacks" do
+    it "the ayl_after_save handler should fire when the model is saved" do
+      
+      model = AfterSave::MyModel.new(:name => 'spud')
+      model.save.should be_true
+
+      WhatHappened.instance.what_ran.should == [ 'handle after save' ] 
+      WhatHappened.instance.clear
+
+      model.update_attribute(:name, 'joan')
+
+      WhatHappened.instance.what_ran.should == [ 'handle after save' ] 
+    end
+
+    it "the ayl_after_update handler should fire when the model is updated" do
+      
+      model = AfterUpdate::MyModel.new(:name => 'spud')
+      model.save.should be_true
+
+      WhatHappened.instance.what_ran.should be_nil
+
+      model.update_attribute(:name, 'joan')
+
+      WhatHappened.instance.what_ran.should == [ 'handle after update' ]
+    end
+
+    it "the ayl_after_create handler should fire when the model is created" do
+      
+      model = AfterCreate::MyModel.new(:name => 'spud')
+      model.save.should be_true
+
+      WhatHappened.instance.what_ran.should == [ 'handle after create' ]
+      WhatHappened.instance.clear
+
+      model.update_attribute(:name, 'joan')
+
+      WhatHappened.instance.what_ran.should be_nil
+    end
+
+  end
+
+  context "when using the instance extensions" do
+
+    it "should represent the instance of a particular model using a 'find'" do
+      model = InstanceMethod::MyModel.create(:name => 'loud')
+
+      model.to_rrepr.should == "InstanceMethod::MyModel.find(#{model.id})"
+    end
+
+    it "should invoke the instance method asynchronously with no options" do
+      model = InstanceMethod::MyModel.create(:name => 'loud')
+
+      model.ayl_send(:the_async_method, "first", "second")
+      
+      WhatHappened.instance.what_ran.should == [ "the instance async method(first, second)" ]
+    end
+
+    it "should invoke the instance method asynchronously with options" do
+      model = InstanceMethod::MyModel.create(:name => 'loud')
+
+      model.ayl_send_opts(:the_async_method, {}, "first", "second")
+      
+      WhatHappened.instance.what_ran.should == [ "the instance async method(first, second)" ]
+    end
+
+  end
+
+  context "when using the class extensions" do
+
+    it "should invoke the static method asynchronously with no options" do
+      ClassMethod::MyModel.ayl_send(:the_async_method, "first", "second")
+      
+      WhatHappened.instance.what_ran.should == [ "the static async method(first, second)" ]
+    end
+
+    it "should invoke the instance method asynchronously with options" do
+      ClassMethod::MyModel.ayl_send_opts(:the_async_method, {}, "first", "second")
+      
+      WhatHappened.instance.what_ran.should == [ "the static async method(first, second)" ]
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rails/all'
+require 'ayl'
+require 'ayl-rails'
+
+# Run the initializers in the Railtie to get them to register
+Ayl::Railtie.instance.run_initializers
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/null_logger.rb

@@ -0,0 +1,16 @@
+module Ayl
+
+  #
+  # A logger to use to limit the amount of junk output while the test is running
+  #
+  class NullLogger
+
+    Ayl::Logger::LOG_METHODS.each do | method |
+      define_method(method) do |message|
+        # Do nothing
+      end
+    end
+
+  end
+
+end

data/spec/support/what_happened.rb

@@ -0,0 +1,7 @@
+class WhatHappened
+  include Singleton
+  attr_accessor :what_ran
+  def <<(message) @what_ran ||= []; @what_ran << message end
+  def clear() @what_ran = nil end
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ayl-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- j0hnds@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ayl
+  requirement: &88427140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *88427140
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &88426740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *88426740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &88426440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *88426440
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &88426050 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *88426050
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &88425610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *88425610
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &88425070 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *88425070
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &88424690 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *88424690
+description: Ayl Extension for Rails ActiveRecord support.
+email: j0hnds@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ayl-rails.rb
+- lib/ayl-rails/railtie.rb
+- spec/rails_extensions_spec.rb
+- spec/spec_helper.rb
+- spec/support/null_logger.rb
+- spec/support/what_happened.rb
+homepage: http://github.com/j0hnds/ayl-rails
+licenses:
+- MIT
+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: -897926769
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ayl Extension for Rails ActiveRecord support.
+test_files: []