live_resource-activerecord 0.0.1

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+live_resource-activerecord

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Will Madden
+
+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,79 @@
+# LiveResource::ActiveRecord
+
+This gem provides the ActiveRecord LiveResource dependency.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'live_resource-activerecord'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install live_resource-activerecord
+
+## Configuration
+
+You need to add this to the list of supported dependency types in your application config.
+
+```ruby
+# config/application.rb (or development.rb, test.rb etc)
+
+class Application < Rails::Application
+  ...
+  config.live_resource = {
+        dependency_types: [LiveResource::ActiveRecord::Dependency]
+  }
+end
+```
+
+## Usage
+
+```ruby
+# app/controllers/profiles_controller.rb
+
+class ProfilesController < ApplicationController
+  ...
+
+  # show.json
+  # {
+  #   name: @profile.name,
+  #   avatar: {
+  #     alt_text: @profile.avatar.alt_text,
+  #     url: avatar_url( @profile.avatar )
+  #   }
+  # }
+  def show
+    ...
+  end
+
+  live_resource :show do
+    identifier { |profile| profile_path(profile) }
+
+    # When a Profile instance is changed
+    depends_on(Profile) do |profile|
+      # Push an update for the resource belonging to the profile
+      push(profile)
+    end
+
+    # Since the view will change if the avatar changes, depend on that too
+    depends_on(Avatar) do |avatar|
+      push avatar.profile
+    end
+  end
+
+  ...
+end
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/live_resource/activerecord/dependency.rb

@@ -0,0 +1,46 @@
+require "live_resource/dependency"
+require "active_record"
+
+module LiveResource
+  module ActiveRecord
+
+    class Dependency < LiveResource::Dependency
+      DEFAULT_EVENTS = [:after_destroy, :after_save]
+
+      def self.accepts_target?(target)
+        !!(target < ::ActiveRecord::Base) # The < operator returns nil instead of false
+      end
+
+      attr_reader :resource, :model_class
+
+      def initialize(resource, model_class, proc, *events)
+        @model_class = model_class
+
+        if !events.empty?
+          @events = events
+        else
+          @events = DEFAULT_EVENTS
+        end
+
+        super(resource, model_class, proc)
+      end
+
+      def watch
+        @events.each { |event| observe event }
+      end
+
+      def observe(event)
+        dependency = self
+        model_class.class_eval do
+          send(event, dependency)
+        end
+      end
+
+      ::ActiveRecord::Callbacks::CALLBACKS.each do |callback|
+        event = callback
+        define_method(callback) { |record| invoke(record, event) }
+      end
+    end
+
+  end
+end

data/lib/live_resource/activerecord/version.rb

@@ -0,0 +1,5 @@
+module LiveResource
+  module ActiveRecord
+    VERSION = "0.0.1"
+  end
+end

data/live_resource-activerecord.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'live_resource/activerecord/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "live_resource-activerecord"
+  spec.version       = LiveResource::ActiveRecord::VERSION
+  spec.authors       = ["Will Madden"]
+  spec.email         = ["will@letsgeddit.com"]
+  spec.description   = %q{Adds support to LiveRecord for ActiveRecord dependencies}
+  spec.summary       = %q{Adds support to LiveRecord for ActiveRecord dependencies}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'live_resource'
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/live_resource/activerecord/dependency_spec.rb

@@ -0,0 +1,102 @@
+require "spec_helper"
+require 'live_resource/resource'
+
+include LiveResource::ActiveRecord
+
+describe Dependency do
+
+  let(:dependency) { Dependency.new(resource, model_class, proc, *events) }
+
+  let(:resource) { double(LiveResource::Resource) }
+
+  let(:model_class) do
+    class User < ActiveRecord::Base
+    end
+    User
+  end
+
+  let(:events) { nil }
+  let(:proc) { double(Proc) }
+
+  ActiveRecord::Callbacks::CALLBACKS.each do |callback|
+    context "##{callback}" do
+      subject { dependency.send(callback.to_sym, record) }
+
+      let(:record) { model_class.new }
+
+      it "should call #invoke with the ActiveRecord instance and the callback name" do
+        dependency.should_receive(:invoke).with(record, callback)
+        subject
+      end
+    end
+  end
+
+  it "should pass the target to the superclass" do
+    expect(dependency.target).to be model_class
+  end
+
+  it "should pass the resource to the superclass" do
+    expect(dependency.resource).to be resource
+  end
+
+  describe ".accepts_target?" do
+    subject { Dependency.accepts_target?(target) }
+
+    context 'when the target is an ActiveRecord subclass' do
+      let(:user_class) do
+        class User < ActiveRecord::Base
+        end
+        User
+      end
+
+      let(:target) { user_class }
+
+      it { should == true }
+    end
+
+    context 'when the target is not an ActiveRecord subclass' do
+      let(:target) { Class.new }
+
+      it { should == false }
+    end
+  end
+
+  describe "#watch" do
+    subject { dependency.watch }
+
+    context 'when some events are supplied' do
+      let(:events) { [:after_create, :after_destroy] }
+
+      it 'should observe each supplied event' do
+        events.each do |event|
+          dependency.should_receive(:observe).with(event).ordered
+        end
+        subject
+      end
+    end
+
+    context 'when no events are supplied' do
+      it 'should observe each of the default events' do
+        Dependency::DEFAULT_EVENTS.each do |event|
+          dependency.should_receive(:observe).with(event).ordered
+        end
+        subject
+      end
+    end
+  end
+
+  describe "#observe" do
+    subject { dependency.observe(event) }
+
+    let(:event) { :after_create }
+
+    before do
+      model_class.stub(event)
+    end
+
+    it "should register itself for callbacks" do
+      model_class.should_receive(event).with(dependency)
+      subject
+    end
+  end
+end

data/spec/live_resource/activerecord_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe LiveResource::ActiveRecord do
+  it 'should have a version number' do
+    LiveResource::ActiveRecord::VERSION.should_not be_nil
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string :name
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'active_record'
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
+                                        :database => File.dirname(__FILE__) + "/test.sqlite3")
+
+require 'schema'
+
+def require_tree(path)
+  path = File.expand_path(path, File.dirname(__FILE__))
+
+  files = Dir.glob(File.join(path, '**/*.rb'))
+  raise "Directory '#{path}' is empty" unless files.length > 0
+
+  files.each { |file| puts "  require #{file}"; require file }
+end
+
+require_tree '../lib'

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: live_resource-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Will Madden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: live_resource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds support to LiveRecord for ActiveRecord dependencies
+email:
+- will@letsgeddit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/live_resource/activerecord/dependency.rb
+- lib/live_resource/activerecord/version.rb
+- live_resource-activerecord.gemspec
+- spec/live_resource/activerecord/dependency_spec.rb
+- spec/live_resource/activerecord_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds support to LiveRecord for ActiveRecord dependencies
+test_files:
+- spec/live_resource/activerecord/dependency_spec.rb
+- spec/live_resource/activerecord_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb