listable 0.1.1

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.2.3"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2.3)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Johannes Baldursson
+
+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,24 @@
+= listable
+
+With listable you can consolidate fields from several models into one, backed up by a database view.
+It is perfect for e.g. a front page where you may want to display the most recent additions to your site in a joint list.
+By providing scopes for each model you wish to include in a view, Listable will automatically create the database view for you.
+
+== How to use
+Coming soon...
+
+== Contributing to listable
+ 
+* 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) 2013 Johannes Baldursson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# 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 = "listable"
+  gem.homepage = "http://github.com/baldursson/listable"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails extension that makes it easy to list and query several models through a single view backed model.}
+  gem.description = %Q{With listable you can consolidate fields from several models into one, backed up by a database view.
+                       It is perfect for e.g. a front page where you may want to display the most recent additions to your site in a joint list.
+                       By providing scopes for each model you wish to include in a view, Listable will automatically create the database view for you.}
+  gem.email = "johannes.baldursson@gmail.com"
+  gem.authors = ["Johannes Baldursson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'simplecov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "listable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/listable.rb

@@ -0,0 +1,50 @@
+require 'active_support/concern'
+
+require 'listable/view_manager'
+require 'listable/connection_adapters'
+require 'listable/querying'
+require 'listable/railtie' if defined?(Rails)
+
+module Listable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def listable_through(listable_view_name, scope_name)
+      has_one listable_view_name.to_s.singularize, as: :listable
+
+      ViewManager.add_listable listable_view_name, self.name, scope_name
+    end
+
+    def acts_as_listable_view
+      self.table_name = ViewManager.prefixed_view_name(self.name)
+      belongs_to :listable, polymorphic: true
+      include ViewMethods
+    end
+  end
+
+  module ViewMethods
+    def hash
+      listable_id.hash + listable_type.hash
+    end
+
+    def eql?(result)
+      listable_type == result.listable_type and
+      listable_id == result.listable_id
+    end
+
+    def readonly?
+      true
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include Listable
+  include Listable::Querying
+end
+
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include Listable::ConnectionAdapters::SchemaStatements
+end
+
+

data/lib/listable/connection_adapters.rb

@@ -0,0 +1,78 @@
+module Listable
+  module ConnectionAdapters
+
+    module SchemaStatements
+      def create_view(view_name, queries)
+        create_sql = "CREATE VIEW #{view_name.to_s.pluralize} AS "
+        queries.map!(&:to_sql) # Compile the arel queries to sql
+        create_sql << queries * ' UNION ' # Combines the queries with union
+
+        execute create_sql
+      end
+
+      def drop_view(view_name)
+        execute "DROP VIEW #{view_name}"
+      end
+    end
+
+    module ConcatenationMethods
+      module PipeOperator
+        def concat(args)
+          args * " || "
+        end
+      end
+
+      module PlusOperator
+        def concat(args)
+          args * " + "
+        end
+      end
+
+      module Function
+        def concat(args)
+          "CONCAT(#{args * ', '})"
+        end
+      end
+    end
+
+    module PostgreSQLExtensions
+      include ConcatenationMethods::PipeOperator
+
+      def views
+        query(<<-SQL, 'SCHEMA').map { |row| row[0] }
+          SELECT table_name
+          FROM INFORMATION_SCHEMA.views
+          WHERE table_schema = ANY (current_schemas(false))
+        SQL
+      end
+    end
+
+    module SQLiteExtensions
+      include ConcatenationMethods::PipeOperator
+
+      def views
+        exec_query(<<-SQL, 'SCHEMA').map { |row| row['name'] }
+          SELECT name
+          FROM sqlite_master
+          WHERE type = 'view';
+        SQL
+      end
+    end
+
+    module MySQLExtensions
+      include ConcatenationMethods::Function
+
+      def views()
+        query = <<-SQL
+          SHOW FULL TABLES 
+          IN #{quote_table_name(current_database)} 
+          WHERE TABLE_TYPE LIKE 'VIEW'
+        SQL
+
+        execute_and_free(query, 'SCHEMA') do |result|
+          result.collect { |field| field.first }
+        end
+      end
+    end
+  end
+end

data/lib/listable/querying.rb

@@ -0,0 +1,29 @@
+module Listable
+  module Querying
+
+    module ClassMethods
+      def concat_select(fields, as_name)
+        fields.map! do |field|
+          if field.is_a? Symbol
+            connection.quote_column_name(field)
+          else
+            connection.quote(field)
+          end
+        end
+        select("#{connection.concat(fields)} AS #{as_name}")
+      end
+
+      def select_as(fields)
+        selection = []
+        fields.each do |field, as_name|
+          selection << "#{connection.quote_column_name(field)} AS #{as_name}"
+        end
+        select(selection * ', ')
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend ClassMethods
+    end
+  end
+end

data/lib/listable/railtie.rb

@@ -0,0 +1,35 @@
+#require 'rake'
+
+module Listable
+  class Railtie < Rails::Railtie
+    initializer "listable" do
+      # Rebuild views after db:migrate
+      # Rake::Task['db:migrate'].enhance do
+      #   Rake::Task['listable:migrate'].invoke
+      # end
+
+      ActiveSupport.on_load :active_record do
+        # Extending connection adapters
+        if ActiveRecord::ConnectionAdapters.const_defined?(:PostgreSQLAdapter)
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:include, Listable::ConnectionAdapters::PostgreSQLExtensions)
+        end
+
+        if ActiveRecord::ConnectionAdapters.const_defined?(:SQLiteAdapter)
+          ActiveRecord::ConnectionAdapters::SQLiteAdapter.send(:include, Listable::ConnectionAdapters::SQLiteExtensions)
+        end
+
+        if ActiveRecord::ConnectionAdapters.const_defined?(:MysqlAdapter)
+          ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:include, Listable::ConnectionAdapters::MySQLExtensions)
+        end
+
+        if ActiveRecord::ConnectionAdapters.const_defined?(:Mysql2Adapter)
+          ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, Listable::ConnectionAdapters::MySQLExtensions)
+        end
+      end
+    end
+
+    rake_tasks do
+      load 'tasks/listable.rake'
+    end
+  end
+end

data/lib/listable/view_manager.rb

@@ -0,0 +1,51 @@
+module Listable
+  class ViewManager
+    cattr_reader :listables
+
+    class << self
+      def prefixed_view_name(name)
+        prefix << name.underscore.pluralize
+      end
+
+      def prefix
+        'lstble_'  
+      end
+
+      def add_listable(view_name, model_name, model_scope_name)
+        @@listables ||= {}
+        @@listables[view_name] ||= {}
+        @@listables[view_name][model_name] = model_scope_name
+      end
+
+      def listable_view?(name)
+        name.start_with? prefix
+      end
+
+      def create_views
+        ActiveRecord::Base.transaction do
+          drop_views # First drop all listable views to get a fresh start
+          listables.each do |view_name, query_info|
+            queries = []
+            view_name = prefixed_view_name(view_name.to_s) # Appending a prefix to views
+            query_info.each do |model_name, scope|
+              model_class = Kernel.const_get(model_name)
+              query = model_class.select_as(id: :listable_id) # Always begin selection with the original model ID
+              query = query.send(scope) # Appends selection from scope
+              query = query.select([:created_at, :updated_at]) # Include Rails' timestamps in view
+              query = query.select("CAST('#{model_name}' AS char) AS listable_type") # Finish with the original model name, needed for the polymorphic relation
+
+              queries << query
+            end
+            ActiveRecord::Base.connection.create_view view_name, queries
+          end
+        end
+      end
+
+      def drop_views
+        ActiveRecord::Base.connection.views.each do |name|
+          ActiveRecord::Base.connection.drop_view(name) if listable_view? name
+        end
+      end
+    end
+  end  
+end

data/lib/tasks/listable.rake

@@ -0,0 +1,13 @@
+namespace :listable do
+  desc "(Re)creates all listable views"
+  task :migrate => :environment do
+    puts "Creating Listable views..."
+    Rails.application.eager_load!
+    Listable::ViewManager.create_views
+  end
+end
+
+# Rebuild views after db:migrate
+Rake::Task['db:migrate'].enhance do
+  Rake::Task['listable:migrate'].invoke
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'listable'
+
+class Test::Unit::TestCase
+end

data/test/test_listable.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestListable < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: listable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Johannes Baldursson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: ! "With listable you can consolidate fields from several models into
+  one, backed up by a database view.\n                       It is perfect for e.g.
+  a front page where you may want to display the most recent additions to your site
+  in a joint list.\n                       By providing scopes for each model you
+  wish to include in a view, Listable will automatically create the database view
+  for you."
+email: johannes.baldursson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/listable.rb
+- lib/listable/connection_adapters.rb
+- lib/listable/querying.rb
+- lib/listable/railtie.rb
+- lib/listable/view_manager.rb
+- lib/tasks/listable.rake
+- test/helper.rb
+- test/test_listable.rb
+homepage: http://github.com/baldursson/listable
+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: -3454069564760365007
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Rails extension that makes it easy to list and query several models through
+  a single view backed model.
+test_files: []