active_illusion 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.*.sw*
+*.orig
+.swp
+public/system
+*.*.BACKUP.*.lock
+*.*.BASE.*.lock
+*.*.REMOTE.*.lock
+*.*.LOCAL.*.lock
+.DS_Store
+*.*.gz
+Session.vim
+err.txt
+.sass-cache
+public/stylesheets/*.css

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+# dependencies are specified in jasmine.gemspec
+
+gemspec
+
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    active_illusion (0.0.1)
+      activerecord (>= 3.1.0.rc4)
+      squeel (>= 0.8.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+      bcrypt-ruby (~> 2.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0.rc5)
+      activemodel (= 3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+      arel (~> 2.1.4)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.0.rc5)
+      multi_json (~> 1.0)
+    arel (2.1.4)
+    bcrypt-ruby (2.1.4)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    squeel (0.8.6)
+      activerecord (~> 3.0)
+      activesupport (~> 3.0)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_illusion!
+  rspec

data/README.md

@@ -0,0 +1,47 @@
+Inherit from this class to create tableless models that are backed by a query. Behaves
+a little like a classic SQL view.
+
+For example
+
+    class Award < ActiveRecord::Base
+     has_many :award_type_view
+    end
+
+    class AwardTypeView < ActiveRecord::Illusion
+     column :award_type, :string
+     column :award_id, :integer
+
+     belongs_to :award
+
+     view
+       Award.select{
+           [awards.type.as(award_type), awards.id.as(award_id)]
+       }
+     end
+
+    end
+
+The cool thing is, is that the relations work on both directions
+
+a = AwardTypeView.first
+
+      SELECT "award_type_views".* FROM 
+      (SELECT "awards"."type" AS award_type, "awards"."id" AS award_id FROM awards ) 
+      award_type_views LIMIT 1
+
+a.award
+
+       SELECT "awards".* FROM "awards" WHERE "awards"."id" = 1 LIMIT 1
+
+b = Award.first
+
+       SELECT "awards".* FROM "awards" LIMIT 1
+
+b.award_type_views
+
+       SELECT "award_type_views".* FROM 
+       (SELECT "awards"."type" AS award_type, "awards"."id" AS award_id FROM awards ) 
+       award_type_views 
+       WHERE "award_type_views"."award_id" = 1
+
+Currently this gem depends on the SQUEEL SQL gem

data/active_illusion.gemspec

@@ -0,0 +1,15 @@
+# Provide a simple gemspec so you can easily use your
+# project in your rails apps through git.
+Gem::Specification.new do |s|
+  s.name        = "active_illusion"
+  s.summary     = "Create ActiveRecord models backed only by an SQL query NOT a table."
+  s.description = ""
+  s.files       = `git ls-files`.split "\n"
+  s.authors     = ["Brad Phelan"]
+  s.email       = "bradphelan@xtargets.com"
+  s.homepage    = "https://github.com/bradphelan/Active-Illusion"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.add_dependency  'activerecord', '>= 3.1.0.rc4'  
+  s.add_dependency  'squeel', '>= 0.8.5'  
+end

data/lib/active_illusion.rb

@@ -0,0 +1,99 @@
+require 'active_record'
+require 'active_support/all'
+
+module ActiveRecord
+  # requires the squeel gem
+  #
+  # https://github.com/ernie/squeel
+  # 
+  # Inherit from this class to create tableless
+  # models that are backed by a query.
+  #
+  # For example
+  #
+  # class Award < ActiveRecord::Base
+  #   has_many :award_type_view
+  # end
+  #
+  # class AwardTypeView < Illusion
+  #   column :award_type, :string
+  #   column :award_id, :integer
+  #
+  #   belongs_to :award
+  #
+  #   view
+  #     select{[awards.type.as(award_type), awards.id.as(award_id)]}.from("awards")
+  #   end
+  # end
+  #
+  # The cool thing is, is that the relations work on both directions
+  #
+  # a = AwardTypeView.first
+  #
+  #   SELECT "award_type_views".* FROM 
+  #   (SELECT "awards"."type" AS award_type, "awards"."id" AS award_id FROM awards ) 
+  #   award_type_views LIMIT 1
+  #
+  # a.award
+  #
+  #   SELECT "awards".* FROM "awards" WHERE "awards"."id" = 1 LIMIT 1
+  #
+  # b = Award.first
+  #
+  #   SELECT "awards".* FROM "awards" LIMIT 1
+  #
+  # b.award_type_views
+  #
+  #   SELECT "award_type_views".* FROM 
+  #   (SELECT "awards"."type" AS award_type, "awards"."id" AS award_id FROM awards ) 
+  #   award_type_views 
+  #   WHERE "award_type_views"."award_id" = 1
+
+  # end
+  class Illusion < ActiveRecord::Base
+    def self.columns() 
+      @columns ||= [] 
+    end  
+
+    def self.columns_hash()
+      @columns_hash ||= {}
+    end
+
+    def self.find_all
+      raise "please override"
+    end
+
+    class << self
+      def default_scope_with_wrap
+      end
+    end
+
+    def self.view
+      meta = class << self;self;end
+      m = yield
+      table = self.to_s.underscore.pluralize
+      meta.send :define_method, :default_scope do
+        q = m.arel.as table
+        select{}.from(q)
+      end
+    end
+
+    def self.column(name, sql_type = :string, default = nil, null = true)  
+      column = ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)  
+
+      columns << column
+      columns_hash[name.to_s] = column   
+    end  
+
+    self.abstract_class = true
+
+    def self.table_name
+      to_s.underscore.pluralize
+    end
+
+    def readonly?
+      true
+    end
+
+  end
+end

data/spec/illusion_spec.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'active_illusion'
+require 'squeel'
+
+TIMES = (ENV['N'] || 10000).to_i
+
+require 'rubygems'
+require "active_record"
+
+conn = { :adapter => 'sqlite3', :database => ':memory:' }
+ActiveRecord::Base.establish_connection(conn)
+
+class User < ActiveRecord::Base
+    connection.create_table :users, :force => true do |t|
+        t.string :name, :email
+        t.timestamps
+    end
+
+    has_many :exhibits
+end
+
+class Exhibit < ActiveRecord::Base
+    connection.create_table :exhibits, :force => true do |t|
+        t.belongs_to :user
+        t.string :name
+        t.text :notes
+        t.integer :ssn
+        t.timestamps
+    end
+
+    belongs_to :user
+
+    def look; attributes end
+    def feel; look; user.name end
+
+    def self.look(exhibits) exhibits.each { |e| e.look } end
+    def self.feel(exhibits) exhibits.each { |e| e.feel } end
+end
+
+module ActiveRecord
+    class Faker
+        LOREM = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse non aliquet diam. Curabitur vel urna metus, quis malesuada elit. Integer consequat tincidunt felis. Etiam non erat dolor. Vivamus imperdiet nibh sit amet diam eleifend id posuere diam malesuada. Mauris at accumsan sem. Donec id lorem neque. Fusce erat lorem, ornare eu congue vitae, malesuada quis neque. Maecenas vel urna a velit pretium fermentum. Donec tortor enim, tempor venenatis egestas a, tempor sed ipsum. Ut arcu justo, faucibus non imperdiet ac, interdum at diam. Pellentesque ipsum enim, venenatis ut iaculis vitae, varius vitae sem. Sed rutrum quam ac elit euismod bibendum. Donec ultricies ultricies magna, at lacinia libero mollis aliquam. Sed ac arcu in tortor elementum tincidunt vel interdum sem. Curabitur eget erat arcu. Praesent eget eros leo. Nam magna enim, sollicitudin vehicula scelerisque in, vulputate ut libero. Praesent varius tincidunt commodo".split
+        def self.name
+            LOREM.grep(/^\w*$/).sort_by { rand }.first(2).join ' '
+        end
+
+        def self.email
+            LOREM.grep(/^\w*$/).sort_by { rand }.first(2).join('@') + ".com"
+        end
+    end
+end
+
+class Test0 < ActiveRecord::Illusion
+  column :name
+  column :exhibition
+  column :number
+  #belongs_to :user, :foreign_key => :name
+
+  view do
+    User.joins{exhibits}.select{
+      [users.name.as(name), exhibits.name.as(xname), exhibits.ssn.as(number) ]
+    }
+  end
+end
+
+# pre-compute the insert statements and fake data compilation,
+# so the benchmarks below show the actual runtime for the execute
+# method, minus the setup steps
+
+# Using the same paragraph for all exhibits because it is very slow
+# to generate unique paragraphs for all exhibits.
+notes = ActiveRecord::Faker::LOREM.join ' '
+today = Date.today
+
+
+describe ActiveRecord::Illusion do
+    before :each do
+
+        User.destroy_all
+
+        Exhibit.destroy_all
+
+        puts 'Inserting 100 users and exhibits...'
+        100.times do |i|
+            user = User.create(
+                :created_at => today,
+                :name       => ActiveRecord::Faker.name,
+                :email      => ActiveRecord::Faker.email
+            )
+
+            Exhibit.create(
+                :created_at => today,
+                :name       => ActiveRecord::Faker.name,
+                :user       => user,
+                :notes      => notes,
+                :ssn        => i
+            )
+        end
+
+    end
+
+    it "should have 100 users" do
+        User.count.should == 100
+    end
+
+    it "should have 100 exhibits" do
+        Exhibit.count.should == 100
+    end
+
+    describe Test0 do
+        it "should retrieve 100 rows" do
+            Test0.where{}.to_sql.should ==
+            %Q[SELECT \"test0s\".* FROM (SELECT \"users\".\"name\" AS name, \"exhibits\".\"name\" AS xname, \"exhibits\".\"ssn\" AS number FROM \"users\" INNER JOIN \"exhibits\" ON \"exhibits\".\"user_id\" = \"users\".\"id\") test0s ]
+            Test0.count.should == 100
+
+
+            Test0.where{number < 20}.to_sql.should ==
+              %Q[SELECT "test0s".* FROM (SELECT "users"."name" AS name, "exhibits"."name" AS xname, "exhibits"."ssn" AS number FROM "users" INNER JOIN "exhibits" ON "exhibits"."user_id" = "users"."id") test0s  WHERE "test0s"."number" < 20]
+            Test0.where{number < 20}.count.should == 20
+        end
+    end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: active_illusion
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brad Phelan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.1.0.rc4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: squeel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.5
+  type: :runtime
+  version_requirements: *id002
+description: ""
+email: bradphelan@xtargets.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- active_illusion.gemspec
+- lib/active_illusion.rb
+- spec/illusion_spec.rb
+has_rdoc: true
+homepage: https://github.com/bradphelan/Active-Illusion
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Create ActiveRecord models backed only by an SQL query NOT a table.
+test_files: []
+