resource_inclusion 0.0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+# Version 0.0.1
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0.1"
+
+group :development, :test do
+  gem 'sqlite3-ruby', :require => 'sqlite3'    
+  gem 'rspec-rails'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.0)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rails (~> 3.0.1)
+  rspec-rails
+  sqlite3-ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John-Mason P. Shackelford
+
+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,126 @@
+== Resource Inclusion
+
+Resource Inclusion uses the power of Responders in Rails 3 to enable a macro
+for specifying that resources rendered as xml or json include associated 
+resources. This may be used in conjunction with Inherited Resources to keep your
+controllers lean and mean.
+
+Given a model such as:
+
+    create_table :users do |t|
+      t.string  :login_id
+      t.string  :display_name    
+      t.string  :email
+    end
+
+    create_table :comments do |t|
+      t.text       :text
+      t.references :user
+    end
+    
+Our CommentsController need only have the following to include the user's 
+attributes:
+
+   class CommentsController < ApplicationController
+     
+     inherit_resources
+       
+     include_resources :user
+         
+     #  If you like to type, you could have written the following, but you still
+     #  would lack the behavior for other actions which return the resources.
+     #    
+     #  def index 
+     #    index! do |format|
+     #      format.xml{  render :xml  => collection.to_xml(  render_options ) }
+     #      format.json{ render :json => collection.to_json( render_options ) }        
+     #    end
+     #  end
+     #  
+     #  def show
+     #    show! do |format|
+     #      format.xml{ render :xml  => resource.to_xml(  render_options ) }
+     #      format.xml{ render :json => resource.to_json( render_options ) }
+     #    end
+     #  end
+     #
+     #  def render_options
+     #    { :include => [:user] }
+     #  end
+     #
+     
+   end
+
+Thus /comments/1.xml would render:
+
+    <?xml version="1.0" encoding="UTF-8"?> 
+    <comment> 
+      <id type="integer">1</id> 
+      <text>This is comment text.</text> 
+      <user-id type="integer">1</user-id> 
+      <user> 
+        <login-id>aperson</login-id> 
+        <display-name>A. Person</display-name> 
+        <email>a.person@somedomain.com</email> 
+        <id type="integer">1</id> 
+      </user> 
+    </comment> 
+
+The output for the json format would be analogous.
+
+== Installation
+
+Resource Inclusion requires Rails 3.
+
+You can let bundler to install Resource Inclusion by adding this line to your application's Gemfile:
+
+  gem 'resource_inclusion', '0.0.1'
+
+And then execute:
+
+  bundle install 
+
+Add resource_inclusion to your app/controllers/application_controller.rb file (or
+to any of your other controllers):
+   
+   class ApplicationController < ActionController::Base
+   
+      resource_inclusion
+      
+   end
+
+Then use the macro to your controllers as shown above.
+
+== Limitations
+
+In this release of Resource Inclusion the macros support no configuration 
+options beyond what you can pass to serializer (#to_xml or #to_json) with the
+:include option. These options will be passed to the serializer for any action
+that uses ActionController#respond_with and with all formats, excluding HTML. 
+
+For more on #respond_with see:
+* http://apidock.com/rails/ActionController/MimeResponds/respond_with
+* http://davidwparker.com/2010/03/09/api-in-rails-respond-to-and-respond-with/
+* http://railscasts.com/episodes/224-controllers-in-rails-3
+
+Note that this plug-in has no dependency on Inherited Resources and should work
+just fine without it. That said, I have not tested with in an application
+which doesn't use Inherited Resources so I'll be interested in feedback from
+users.
+
+== Acknowledgments
+
+Thanks to Jose Valim for pointing me in the right direction and his must-have
+Inherit Resources plug-in. If are on Rails 3, wish to expose an REST API and are 
+not using this plug-in, you probably writing more code than you should be. See:
+
+* https://github.com/josevalim/inherited_resources
+
+== Bugs and Feedback
+
+Feedback is welcome. If you discover any bugs or want to drop a line, file 
+issues on GitHub or contact me personally via GitHub.
+
+Copyright (c) 2010 John-Mason P. Shackelford
+
+See the attached MIT License.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'resource_inclusion', 'version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "resource_inclusion"
+    s.version = ResourceInclusion::VERSION.dup
+    #   s.rubyforge_project = "resource_inclusion"
+    s.summary = "A handy macro for including associated models in your REST APIs."
+    s.email = "jpshack@gmail.com"
+    s.homepage = "http://github.com/jpshackelford/resource_inclusion"
+    s.description = "Resource Inclusion allows one to specify once per controller associated resources to be included when a resource is serialized."
+    s.authors = ['John-Mason P. Shackelford']
+    s.files =  FileList["*", "{lib}/**/*", "{test}/**/*"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+AppDir = File.join(File.dirname(__FILE__), 'test', 'app')
+
+desc 'Run tests for InheritedResources.'
+task :test do
+  Dir.chdir( AppDir ) do
+    sh %{ bundle exec rake  }
+  end
+end
+
+task :default => :test
+
+desc 'Generate documentation for InheritedResources.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ResourceInclusion'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/resource_inclusion/class_methods.rb

@@ -0,0 +1,24 @@
+module ResourceInclusion
+  module ClassMethods
+    
+    protected
+   
+    # Pass arguments to the serializer with the :include option, e.g.
+    # object.to_xml(:include => your_args).
+    def include_resource(*args)
+      
+      @included_resources = args.dup.freeze
+      
+      # TODO Is there a shortcut for appending a responder?
+      unless self.responder.include?( ResourceInclusion::ResourceIncludeResponder )
+        klass = Class.new( self.responder )
+        klass.send(:include, ResourceInclusion::ResourceIncludeResponder)
+        self.responder = klass        
+      end
+    
+    end
+    
+    alias include_resources include_resource
+    
+  end
+end

data/lib/resource_inclusion/instance_methods.rb

@@ -0,0 +1,9 @@
+module ResourceInclusion
+  module InstanceMethods   
+    
+    def included_resources
+      self.class.send(:instance_variable_get, :@included_resources)
+    end
+     
+  end
+end

data/lib/resource_inclusion/resource_include_responder.rb

@@ -0,0 +1,10 @@
+module ResourceInclusion
+
+  module ResourceIncludeResponder
+    def display(resource, given_options={})
+      given_options.store( :include, *controller.included_resources )
+      super
+    end
+  end
+  
+end

data/lib/resource_inclusion/resource_inclusion.rb

@@ -0,0 +1,13 @@
+class ActionController::Base
+
+  # Add the #include_resource and #include_resources macros. 
+  def self.resource_inclusion
+    
+    self.class_eval do
+      extend  ResourceInclusion::ClassMethods
+      include ResourceInclusion::InstanceMethods
+    end
+      
+  end
+
+end

data/lib/resource_inclusion/version.rb

@@ -0,0 +1,3 @@
+module ResourceInclusion
+  VERSION = '0.0.1'.freeze
+end

data/lib/resource_inclusion.rb

@@ -0,0 +1,4 @@
+require 'resource_inclusion/class_methods'
+require 'resource_inclusion/instance_methods'
+require 'resource_inclusion/resource_inclusion'
+require 'resource_inclusion/resource_include_responder'

data/resource_inclusion.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{resource_inclusion}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John-Mason P. Shackelford"]
+  s.date = %q{2011-01-11}
+  s.description = %q{Resource Inclusion allows one to specify once per controller associated resources to be included when a resource is serialized.}
+  s.email = %q{jpshack@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "lib/resource_inclusion.rb",
+    "lib/resource_inclusion/class_methods.rb",
+    "lib/resource_inclusion/instance_methods.rb",
+    "lib/resource_inclusion/resource_include_responder.rb",
+    "lib/resource_inclusion/resource_inclusion.rb",
+    "lib/resource_inclusion/version.rb",
+    "resource_inclusion.gemspec",
+    "test/app/Gemfile",
+    "test/app/Gemfile.lock",
+    "test/app/Rakefile",
+    "test/app/app/controllers/application_controller.rb",
+    "test/app/app/controllers/comments_controller.rb",
+    "test/app/app/models/comment.rb",
+    "test/app/app/models/user.rb",
+    "test/app/config.ru",
+    "test/app/config/application.rb",
+    "test/app/config/boot.rb",
+    "test/app/config/database.yml",
+    "test/app/config/environment.rb",
+    "test/app/config/environments/test.rb",
+    "test/app/config/routes.rb",
+    "test/app/db/development.sqlite3",
+    "test/app/db/migrate/20110111090943_initial_test.rb",
+    "test/app/db/test.sqlite3",
+    "test/app/log/development.log",
+    "test/app/log/test.log",
+    "test/app/spec/controllers/comments_controller_spec.rb",
+    "test/app/spec/spec_helper.rb",
+    "test/app/spec/support/xpath_matcher.rb"
+  ]
+  s.homepage = %q{http://github.com/jpshackelford/resource_inclusion}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A handy macro for including associated models in your REST APIs.}
+  s.test_files = [
+    "test/app/app/controllers/application_controller.rb",
+    "test/app/app/controllers/comments_controller.rb",
+    "test/app/app/models/comment.rb",
+    "test/app/app/models/user.rb",
+    "test/app/config/application.rb",
+    "test/app/config/boot.rb",
+    "test/app/config/environment.rb",
+    "test/app/config/environments/test.rb",
+    "test/app/config/routes.rb",
+    "test/app/db/migrate/20110111090943_initial_test.rb",
+    "test/app/spec/controllers/comments_controller_spec.rb",
+    "test/app/spec/spec_helper.rb",
+    "test/app/spec/support/xpath_matcher.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.1"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0.1"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0.1"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/test/app/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gem 'rails', '~> 3.0.1'
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+group :development, :test do  
+  gem 'rspec-rails'
+end

data/test/app/Gemfile.lock

@@ -0,0 +1,88 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.0)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (~> 3.0.1)
+  rspec-rails
+  sqlite3-ruby

data/test/app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+App::Application.load_tasks

data/test/app/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  resource_inclusion
+end

data/test/app/app/controllers/comments_controller.rb

@@ -0,0 +1,17 @@
+class CommentsController < ApplicationController
+  
+  respond_to :xml, :json
+
+  include_resource :user
+  
+  def index
+    @comments = Comment.all
+    respond_with(@comments)
+  end
+
+  def show
+    @comment = Comment.find(params[:id])
+    respond_with(@comment)
+  end
+  
+end

data/test/app/app/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  belongs_to :user
+end

data/test/app/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/app/config/application.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../../../lib')
+require 'resource_inclusion'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module App
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+    config.filter_parameters += [:password]
+  end
+end

data/test/app/config/boot.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)

data/test/app/config/database.yml

@@ -0,0 +1,17 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+  

data/test/app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+App::Application.initialize!