sql_pager 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= SqlPager
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SqlPager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+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/generators/active_record/sql_pager_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class SqlPagerGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/sql_pager_create_#{table_name}"
+      end
+      
+      def create_model
+        invoke 'active_record:model', [name], :migration => false
+      end
+      
+      def inject_model_content
+        inject_into_class model_path, class_name, model_data if model_exists?
+      end
+      
+      # Helpers
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+      
+      def model_data
+<<CONTENT
+  # Attributes
+  attr_accessible :body, :format, :handler, :path, :partial, :locale
+    
+  # Validation
+  validates :body, :presence => true
+  validates :handler, :inclusion => ActionView::Template::Handlers.extensions.map(&:to_s)
+  validates :format, :inclusion => Mime::SET.symbols.map(&:to_s)
+  validates :locale, :inclusion => I18n.available_locales.map(&:to_s)
+  validates :path, :presence => true
+    
+  after_save do
+    SqlPager::Resolver.instance(self.class.model_name.underscore).clear_cache
+  end
+CONTENT
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,15 @@
+class SqlPagerCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+      t.text :body
+      t.string :path
+      t.string :format
+      t.string :locale
+      t.string :handler
+      t.boolean :partial, default: false
+      # To add filtering capabilities
+      # t.string :keyword
+      t.timestamps
+    end
+  end
+end

data/lib/generators/sql_pager/install_generator.rb

@@ -0,0 +1,9 @@
+module SqlPager
+  class InstallGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+    desc "This generator creates an initializer file at config/initializers"
+    def create_initializer_file
+      template "sql_pager.rb", "config/initializers/sql_pager.rb"
+    end
+  end
+end

data/lib/generators/sql_pager/sql_pager_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module SqlPager
+  module Generators
+    class SqlPagerGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+      
+      check_class_collision :suffix => "Controller"
+      
+      source_root File.expand_path("../templates", __FILE__)
+      
+      def create_controller
+        template "controller.rb", File.join('app/controllers', class_path, "#{controller_file_name}_controller.rb")
+      end
+      
+      def add_route
+        route "get '(*view_path)' => '#{plural_name}#show'"
+      end
+      
+      hook_for :orm
+      
+    end
+  end
+end

data/lib/generators/sql_pager/templates/controller.rb

@@ -0,0 +1,9 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  
+  with_sql_resolver :<%= singular_name.to_s %>
+  
+  def show
+    render params[:view_path]
+  end
+  
+end

data/lib/generators/sql_pager/templates/sql_pager.rb

@@ -0,0 +1,6 @@
+# SqlPager initializer
+SqlPager.setup do |config|
+  # Set the name of the page model
+  config.model_name = :<%= class_name.underscore %>
+  config.filter_column = :keyword
+end

data/lib/sql_pager/controller_helper.rb

@@ -0,0 +1,13 @@
+module SqlPager
+  module ControllerHelper
+    module ClassMethods
+      def with_sql_resolver(*args)
+        append_view_path Resolver.instance *args
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.extend ClassMethods
+    end
+  end
+end

data/lib/sql_pager/railtie.rb

@@ -0,0 +1,5 @@
+module SqlPager
+  class Railtie < ::Rails::Railtie
+    config.sql_pager = SqlPager
+  end
+end

data/lib/sql_pager/resolver.rb

@@ -0,0 +1,106 @@
+module SqlPager
+  class Resolver < ActionView::Resolver
+    
+    # Provide only 
+    @@singleton__instances__ = {}
+    @@singleton__mutex__ = Mutex.new
+    def self.instance model = SqlPager.model_name, filter = nil
+      singleton_name = normalize_singleton_name(model, filter)
+      return @@singleton__instances__[singleton_name] if @@singleton__instances__[singleton_name]
+      @@singleton__mutex__.synchronize {
+        return @@singleton__instances__[singleton_name] if @@singleton__instances__[singleton_name]
+        @@singleton__instances__[singleton_name] = new(model, filter)
+      }
+      @@singleton__instances__[singleton_name]
+    end
+    
+    # Based on singleton
+    def _dump(depth = -1)
+      ''
+    end
+    def clone
+      raise TypeError, "can't clone instance of singleton #{self.class}"
+    end
+    def dup
+      raise TypeError, "can't dup instance of singleton #{self.class}"
+    end
+    
+    private
+    def self.normalize_singleton_name(model, filter)
+      if filter
+        "#{model.to_s}_#{filter.to_s}".to_sym
+      else
+        "#{model.to_s}".to_sym
+      end
+    end
+    
+    def initialize model, filter
+      @model = model.to_s.camelize.constantize
+      @filter = filter
+      super()
+    end
+    private_class_method :new
+    
+    def find_templates(name, prefix, partial, details)
+      prefix = normalize_prefix(prefix)
+      locals = normalize_array(details[:locale])
+      formats = normalize_array(details[:formats])
+      conditions = {
+        path: normalize_path(name, prefix),
+        handler: normalize_array(details[:handlers]),
+        format: formats,
+        locale: locals,
+        partial: partial || false
+      }
+      conditions[SqlPager.filter_column] = @filter unless @filter.nil?
+      query = @model.where(conditions)
+      if locals.count > 1
+        query.order("FIELD(locale,#{order_clause(locals)})")
+      end
+      if formats.count > 1
+        query.order("FIELD(format,#{order_clause(formats)})")
+      end
+      query.map do |record|
+        initialize_template(record)
+      end
+    end
+    
+    def normalize_prefix(prefix)
+      prefix == @model.to_s.underscore.pluralize ? "" : prefix
+    end
+    def normalize_path(name, prefix)
+      prefix.present? ? "#{prefix}/#{name}" : name
+    end
+    def normalize_array(array)
+      array.map(&:to_s)
+    end
+    def order_clause(array)
+      array.map(&lambda{|el|
+        "\"#{el}\""
+      }).join(",")
+    end
+    
+    def initialize_template(record)
+      source = record.body
+      identifier = "#{@model.to_s} - #{record.id} - #{record.path.inspect}"
+      handler = ActionView::Template.registered_template_handler(record.handler)
+      
+      details = {
+        format: Mime[record.format],
+        updated_at: record.updated_at,
+        virtual_path: virtual_path(record)
+      }
+      
+      ActionView::Template.new source, identifier, handler, details
+    end
+    
+    def virtual_path(record)
+      return record.path unless record.partial
+      if index = record.path.rindex('/')
+        record.path.insert(index + 1, '_')
+      else
+        "_#{record.path}"
+      end
+    end
+  end
+end

data/lib/sql_pager/version.rb

@@ -0,0 +1,3 @@
+module SqlPager
+  VERSION = "0.2.0"
+end

data/lib/sql_pager.rb

@@ -0,0 +1,24 @@
+require 'rails'
+
+module SqlPager
+  autoload :Resolver, 'sql_pager/resolver'
+  autoload :ControllerHelper, 'sql_pager/controller_helper'
+  
+  mattr_accessor :model_name
+  @@model_name = :page
+  
+  mattr_accessor :filter_column
+  @@filter_column = :keyword
+  
+  # Config API
+  def self.setup
+    yield self
+  end
+  
+end
+
+ActionController::Base.send(:include, SqlPager::ControllerHelper)
+
+require 'sql_pager/railtie'
+
+

data/lib/tasks/sql_pager_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sql_pager do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

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

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

data/test/dummy/app/controllers/email_pages_controller.rb

@@ -0,0 +1,9 @@
+class EmailPagesController < ApplicationController
+  
+  with_sql_resolver :email_page
+  
+  def show
+    render params[:view_path]
+  end
+  
+end

data/test/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,8 @@
+class PagesController < ApplicationController
+  
+  with_sql_resolver
+  
+  def show
+    render params[:page]
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/pages_helper.rb

@@ -0,0 +1,2 @@
+module PagesHelper
+end