live_resource-rails 0.0.1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/.ruby-gemset

@@ -0,0 +1 @@
+live_resource-rails

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in live_resource-rails.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug'
+
+gem 'live_resource', path: '/Users/Will/Projects/Balanced Tree/live_resource'

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,81 @@
+# LiveResource::Rails
+
+Rails does not have an elegant abstraction for defining resources that exist between requests.
+
+Requesting a resource, for example, /profiles.json, is handled very well, and will route through the ProfilesController,
+load the collection of Profile models, and render the index view (MVC).
+
+The LiveResource gem adds the concept of a Resource, which is an object derived from server state (such as models) that
+can be *pulled* (requested, as in the above example), or *pushed* when changes to server state are detected.
+
+LiveResource-Rails adds support to Rails for defining and configuring live resources.
+
+## Example
+
+```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 (requires live_resource-activerecord)
+    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
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'live_resource-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install live_resource-rails
+
+## 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
+
+## TODO
+
+- Integration test with dummy Rails app (also as an example for getting started)
+- Test injection of URL helpers in DSL into Builder

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LiveResourceRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/live_resource/rails/controller_dsl.rb

@@ -0,0 +1,57 @@
+require "live_resource/builder"
+
+module LiveResource
+  module Rails
+    module ControllerDSL
+
+      def self.included(base)
+        base.extend(InstanceMethods)
+      end
+
+      module InstanceMethods
+        def live_resource(resource_identifier, &block)
+          config = ::Rails.configuration.live_resource if ::Rails.configuration.respond_to?(:live_resource)
+          raise 'You must configure config.live_resource (e.g. in application.rb)' unless config
+
+          protocol = config[:protocol]
+          raise 'You must set config.live_resource.protocol (e.g. in application.rb)' unless protocol
+
+          dependency_types = ::Rails.configuration.live_resource[:dependency_types]
+          raise 'You must set config.live_resource.dependency_types (e.g. in application.rb)' unless dependency_types
+
+          # Set up the builder
+          builder = Builder.new(resource_identifier, protocol, dependency_types, Module.new do
+            # TODO: This is added for convenience, so that in the execution scope of the identifier block we'll have
+            # access to path helpers. This needs to be refactored into something more elegant.
+            include ::Rails.application.routes.url_helpers
+
+            def default_url_options
+              ::Rails.application.routes.default_url_options
+            end
+          end)
+
+          block.call(builder)
+
+          # Grab the result
+          resource = builder.resource
+
+          # Create a method on the controller to allow access to the Resource
+          self.instance_eval do
+            define_method(:"#{resource.name}_resource", Proc.new { resource })
+          end
+
+          # Create a helper method to allow views to access the resource ID
+          ActionController::Base.helper do
+            define_method(:"live_#{builder.resource.name}_id") do |*context|
+              resource.identifier(*context)
+            end
+          end
+
+          # Activate the dependencies
+          resource.dependencies.each { |dependency| dependency.watch }
+        end
+      end
+
+    end
+  end
+end

data/lib/live_resource/rails/init.rb

@@ -0,0 +1,8 @@
+require 'live_resource/rails'
+require "live_resource/rails/controller_dsl"
+
+require 'action_controller'
+
+ActionController::Base.class_eval do
+  include LiveResource::Rails::ControllerDSL
+end

data/lib/live_resource/rails/version.rb

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

data/lib/live_resource/rails.rb

@@ -0,0 +1 @@
+require "live_resource/rails/version"

data/live_resource-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'live_resource/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "live_resource-rails"
+  spec.version     = LiveResource::Rails::VERSION
+  spec.authors     = ["Will Madden"]
+  spec.email       = ["will@letsgeddit.com"]
+  spec.description = %q{Convenience methods for using LiveResource in Rails applications}
+  spec.summary     = %q{Convenience methods for using LiveResource in Rails applications}
+  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_dependency "rails", "~> 3.2.13"
+  spec.add_dependency 'live_resource'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/live_resource/rails/controller_dsl_spec.rb

@@ -0,0 +1,152 @@
+require "spec_helper"
+require "action_controller/base"
+require 'live_resource/protocol'
+require 'live_resource/dependency'
+require 'rails'
+
+include LiveResource::Rails
+
+describe LiveResource::Rails::ControllerDSL do
+
+  let(:controller_class) do
+    class DummyController < ActionController::Base
+      include ControllerDSL
+    end
+  end
+
+  let(:url_helpers_module) do
+    module URLHelpers
+    end
+    URLHelpers
+  end
+
+  before do
+    Rails.stub_chain(:application, :routes, :url_helpers).and_return(url_helpers_module)
+  end
+
+  describe "#live_resource" do
+
+    subject do
+      b = block # let'ed methods are lost in the scope of the proc
+      controller_class.class_eval(&Proc.new { live_resource(:some_thing, &b) })
+    end
+
+    let(:controller) { DummyController.new }
+    let(:builder) do
+      double(LiveResource::Builder,
+             resource_method: resource_method,
+             resource:        resource)
+    end
+    let(:block) { Proc.new {} }
+    let(:resource_method) { Proc.new {} }
+    let(:resource) { double(LiveResource::Resource, name: resource_name) }
+    let(:resource_name) { :some_method }
+
+    before do
+      LiveResource::Builder.stub(:new).and_return(builder)
+      ActionController::Base.stub(:helper)
+    end
+
+    context 'when live resource is not configured' do
+      before do
+        Rails.stub(:configuration)
+      end
+
+      it 'should raise an error' do
+        expect(-> { subject }).to raise_error('You must configure config.live_resource (e.g. in application.rb)')
+      end
+    end
+
+    context 'when live resource is configured' do
+      let(:protocol) {}
+      let(:dependency_types) {}
+
+      let(:live_resource_configuration) do
+        {
+            protocol:         protocol,
+            dependency_types: dependency_types
+        }
+      end
+
+      before do
+        Rails.stub_chain(:configuration, :live_resource).and_return(live_resource_configuration)
+      end
+
+      context 'when the protocol is not configured' do
+        it 'should raise an error' do
+          expect(-> { subject }).to raise_error('You must set config.live_resource.protocol (e.g. in application.rb)')
+        end
+      end
+
+      context 'when the protocol is configured' do
+        let(:protocol) { double(LiveResource::Protocol) }
+
+        context 'but the supported dependency types are not set' do
+          it 'should raise an error' do
+            expected_error = 'You must set config.live_resource.dependency_types (e.g. in application.rb)'
+            expect(-> { subject }).to raise_error(expected_error)
+          end
+        end
+
+        context 'and the supported dependency types are set' do
+          let(:dependency_types) { [double(LiveResource::Dependency)] }
+
+          let(:dependencies) { [] }
+
+          before do
+            resource.stub(dependencies: dependencies)
+          end
+
+          it "should instantiate a new builder" do
+            LiveResource::Builder.should_receive(:new).with(:some_thing, protocol, dependency_types,
+                                                            an_instance_of(Module))
+            subject
+          end
+
+          it "should call the block with the builder" do
+            block.should_receive(:call).with(builder)
+            subject
+          end
+
+          it "should define a new method on the controller" do
+            controller_class.should_receive(:define_method).with(:"#{resource.name}_resource", instance_of(Proc))
+            subject
+          end
+
+          describe "the method" do
+            before do
+              _proc = nil
+              controller_class.stub(:define_method) { |name, proc| _proc = proc }
+              subject
+              @proc = _proc
+            end
+
+            let(:method) { @proc }
+
+            it 'should return the resource' do
+              expect(method.call).to be resource
+            end
+          end
+
+          it "should define a helper method for the identifier" do
+            ActionController::Base.should_receive(:helper)
+            subject
+          end
+
+          context 'when the block defines some dependencies' do
+            let(:dependencies) { [dependency1, dependency2] }
+            let(:dependency1) { double(LiveResource::Dependency, watch: nil) }
+            let(:dependency2) { double(LiveResource::Dependency, watch: nil) }
+
+            it 'should activate each dependency' do
+              dependency1.should_receive(:watch)
+              dependency2.should_receive(:watch)
+              subject
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+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,164 @@
+--- !ruby/object:Gem::Specification
+name: live_resource-rails
+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: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !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: 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: 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: Convenience methods for using LiveResource in Rails applications
+email:
+- will@letsgeddit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/live_resource/rails.rb
+- lib/live_resource/rails/controller_dsl.rb
+- lib/live_resource/rails/init.rb
+- lib/live_resource/rails/version.rb
+- live_resource-rails.gemspec
+- spec/live_resource/rails/controller_dsl_spec.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'
+      segments:
+      - 0
+      hash: 1742430517839249327
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1742430517839249327
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Convenience methods for using LiveResource in Rails applications
+test_files:
+- spec/live_resource/rails/controller_dsl_spec.rb
+- spec/spec_helper.rb