filtrum 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWM1YzdlMjg3MjljNjM5YWMyOGFjODE5OTBkYWQ4NzcxZmYwNmYzMA==
+  data.tar.gz: !binary |-
+    YjYxOGQ3MjJhMDNmODE3MmQ5NmIzY2IxZTdjYzQ3OWYxNjEyZGQyMA==
+SHA512:
+  metadata.gz: !binary |-
+    YzI2MDYxYjg0OWUzNzFmMjgwOWMzMWVhMDMxM2I0YTJiNzYxYzIyZTliZWI0
+    ZGYxNGQzOWNlMDcyZmI4YzcxMWRhNGQwZDY5MWJiZWI4ZmZiOTE3YjI1Yjg0
+    NGE0NWY5OWQzMWU2MjMwNmQ4NzJhNDRmZjkzNzc0OGUyMjFhMDM=
+  data.tar.gz: !binary |-
+    NjdjZGNiZjM2NDcwMjU5NDYyNDdiZTMzMGQxZjAzNjAxNWFiYjZmZTg3Mjdl
+    OTgzNDVkNDgwMmM4NTk2NGY1MTk1YzE0MDUzZDNlYjAzOWQ4OTc4MGEyZDNj
+    MWU0YmVmNjI4YTgwZjY2M2IzZjc2M2FiYTkzNGMyYjE1YTE0Y2M=

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2014 Simon Oulevay (Alpha Hydrae)
+
+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,8 @@
+# filtrum
+
+**Active record filtering and serialization library.**
+
+## Meta
+
+* **Author:** Simon Oulevay a.k.a. Alpha Hydrae
+* **License:** MIT (see [LICENSE.txt](https://github.com/AlphaHydrae/filtrum/blob/master/LICENSE.txt))

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/filtrum.rb

@@ -0,0 +1,4 @@
+module Filtrum
+end
+
+Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }

data/lib/filtrum/config.rb

@@ -0,0 +1,33 @@
+module Filtrum
+
+  class Configuration
+    attr_reader :model, :settings
+
+    def initialize model, options = {}, &block
+
+      @model = model
+      @views = []
+
+      @settings = Settings.new Filtrum.settings
+      extend @settings.dsl
+
+      instance_eval &block if block
+      @frozen = true
+    end
+
+    def view name, options = {}, &block
+      return @views.find{ |v| v.name.to_s == name.to_s } if @frozen
+      @views.delete_if{ |v| v.name.to_s == name }
+      View.new(name, self, options, &block).tap{ |v| @views << v }
+    end
+
+    def default_view options = {}, &block
+      view :default, options, &block
+    end
+
+    def process params
+      raise ConfigurationError, "You must specify a default view" unless view(:default)
+      view(:default).process params
+    end
+  end
+end

data/lib/filtrum/engine.rb

@@ -0,0 +1,4 @@
+module Filtrum
+  class Engine < Rails::Engine
+  end
+end

data/lib/filtrum/errors.rb

@@ -0,0 +1,5 @@
+module Filtrum
+  class Error < StandardError; end
+  class BaseQueryError < Error; end
+  class ConfigurationError < Error; end
+end

data/lib/filtrum/ext.rb

@@ -0,0 +1,13 @@
+module Filtrum
+
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def filtrum options = {}, &block
+        @filtrum ||= Filtrum::Configuration.new(self, options, &block)
+      end
+    end
+  end
+end

data/lib/filtrum/field.rb

@@ -0,0 +1,84 @@
+module Filtrum
+
+  class Field
+    attr_accessor :name, :alias
+
+    def initialize name, view, options = {}, &block
+
+      @name, @view = name.to_s, view
+      @alias = options[:as].try :to_s
+      @value_column = options[:value].try :to_s
+      @includes = options[:includes]
+
+      if options[:order] == false
+        @no_order = true
+      elsif options[:order]
+        @order_column = options[:order].to_s
+      end
+
+      instance_eval &block if block
+    end
+
+    def working_name
+      @alias || @name
+    end
+
+    def as name
+      @alias = name.to_s
+    end
+
+    def order &block
+      @order_block = block
+    end
+
+    def no_order
+      @no_order = true
+    end
+
+    def value &block
+      @value_block = block
+    end
+
+    def includes &block
+      @includes_block = block
+    end
+
+    def with_order query, direction
+      return if @no_order
+      if @order_block
+        @order_block.call query, direction
+      else
+        query.order "#{model.table_name}.#{@order_column || @name} #{direction}"
+      end
+    end
+
+    def with_includes query
+      if @includes_block
+        @includes_block.call query
+      elsif @includes
+        query.includes @includes
+      else
+        query
+      end
+    end
+
+    def extract object
+      if @value_block
+        @value_block.call object
+      else
+        serialize object.send(@value_column || @name)
+      end
+    end
+
+    private
+
+    def model
+      @view.config.model
+    end
+
+    def serialize value
+      type_serializer = @view.settings.type_serializers.find{ |s| s.match? value }
+      type_serializer ? type_serializer.serialize(value) : value
+    end
+  end
+end

data/lib/filtrum/global.rb

@@ -0,0 +1,10 @@
+module Filtrum
+
+  def self.settings
+    @settings ||= Settings.new
+  end
+
+  def self.global &block
+    settings.configure &block
+  end
+end

data/lib/filtrum/settings.rb

@@ -0,0 +1,33 @@
+module Filtrum
+
+  class Settings
+
+    def initialize parent = nil
+      @parent = parent
+      @type_serializers = []
+    end
+
+    def configure &block
+      instance_eval &block if block
+    end
+
+    def serialize_type type, &block
+      @type_serializers << TypeSerializer.new(type, block)
+    end
+
+    def type_serializers
+      (@parent ? @parent.type_serializers : []) + @type_serializers
+    end
+
+    def dsl
+      m = Module.new do
+
+        def serialize_type type, &block
+          @settings.serialize_type type, &block
+        end
+      end
+      m.instance_variable_set :@settings, self
+      m
+    end
+  end
+end

data/lib/filtrum/type_serializer.rb

@@ -0,0 +1,17 @@
+module Filtrum
+
+  class TypeSerializer
+
+    def initialize type, block
+      @type, @block = type, block
+    end
+
+    def match? value
+      value.kind_of? @type
+    end
+
+    def serialize value
+      @block.call value
+    end
+  end
+end

data/lib/filtrum/version.rb

@@ -0,0 +1,3 @@
+module Filtrum
+  VERSION = "0.1.0"
+end

data/lib/filtrum/view.rb

@@ -0,0 +1,116 @@
+module Filtrum
+
+  class View
+    attr_reader :name, :config, :settings, :fields
+    attr_accessor :base_query, :base_count_query, :quick_search_block, :serialize_record_block, :serialize_response_block
+
+    def initialize name, config, options = {}, &block
+
+      @name, @config = name, config
+      @fields = []
+
+      @base_query = @config.model
+      @base_count_query = nil
+
+      @settings = Settings.new @config.settings
+
+      if block
+        dsl = DSL.new self
+        dsl.extend @settings.dsl
+        dsl.instance_eval &block
+      end
+    end
+
+    def field name
+      @fields.find{ |f| f.name.to_s == name.to_s }
+    end
+
+    def process options = {}
+      
+      q = options[:base] || @base_query
+      cq = options[:base_count] || @base_count_query
+
+      if @quick_search_block and options[:quickSearch].present?
+        q = @quick_search_block.call q, options[:quickSearch].to_s
+        cq = @quick_search_block.call cq, options[:quickSearch].to_s if cq
+      end
+
+      total = (cq || q).count
+      raise BaseQueryError, "Count query must return a number" unless total.kind_of?(Fixnum)
+
+      if options[:sort].present?
+        options[:sort].select{ |item| item.match /\A([^ ]+)* (asc|desc)\Z/i }.each do |item|
+          parts = item.split ' '
+          # TODO: handle unknown fields
+          f = @fields.find{ |f| f.working_name.to_s == parts[0] }
+          q = f.with_order q, parts[1].downcase.to_sym if f
+        end
+      end
+
+      @fields.each{ |f| q = f.with_includes q }
+
+      response_options = (options[:response] || {}).merge({
+        total: total
+      })
+
+      page_size = options[:pageSize].to_i
+      page_size = 10 if page_size <= 0
+      q = q.limit page_size
+
+      max_page = (total.to_f / page_size).ceil
+      page = options[:page].to_i
+
+      # TODO: allow this to be disabled
+      if page < 1 or page > max_page
+        page = 1
+        response_options[:page] = 1
+      end
+
+      q = q.offset (page - 1) * page_size
+
+      serialize_response q, response_options
+    end
+
+    class DSL
+
+      def initialize view
+        @view = view
+      end
+
+      def field name, options = {}, &block
+        @view.fields.delete_if{ |f| f.name.to_s == name.to_s }
+        Field.new(name, @view, options, &block).tap{ |f| @view.fields << f }
+      end
+
+      %w(base base_count).each do |m|
+        define_method m do |q|
+          @view.send "#{m}_query=", q
+        end
+      end
+
+      %w(quick_search serialize_record serialize_response).each do |m|
+        define_method m do |&block|
+          @view.send "#{m}_block=", block
+        end
+      end
+    end
+
+    private
+
+    def serialize_response query, response_options = {}
+
+      res = response_options.merge data: query.to_a
+
+      if @serialize_response_block
+        @serialize_response_block.call res
+      else
+        res[:data] = res[:data].collect{ |r| serialize_record r }
+        res
+      end
+    end
+
+    def serialize_record record
+      @serialize_record_block ? @serialize_record_block.call(record) : @fields.inject({}){ |memo,f| memo[f.working_name] = f.extract(record); memo }
+    end
+  end
+end

data/spec/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.