pivotable 0.0.2

data/README.markdown

@@ -0,0 +1,3 @@
+# Pivotable
+
+TODO

data/lib/pivotable/collection.rb

@@ -0,0 +1,17 @@
+class Pivotable::Collection < Hash
+
+  attr_reader :model
+
+  def initialize(model)
+    @model = model
+    super()
+  end
+
+  # Adds a new rotation to this collection
+  def rotation(name, &block)
+    name, parent = name.is_a?(Hash) ? name.to_a.first : [name, nil]
+    item = Pivotable::Rotation.new(self, name, parent, &block)
+    self[item.name] = item
+  end
+
+end

data/lib/pivotable/column.rb

@@ -0,0 +1,35 @@
+class Pivotable::Column
+
+  attr_reader :attribute
+
+  def initialize(model, attribute, options = {})
+    @as        = options[:as]
+    @attribute = case attribute
+    when Arel::Attribute
+      attribute
+    else
+      model.arel_table[attribute]
+    end
+    raise ArgumentError, "Invalid attribute #{attribute.inspect}" unless @attribute
+  end
+
+  def name
+    @as || attribute.name
+  end
+
+  def calculate!(function)
+    @as     ||= attribute.name
+    @function = attribute.send(function)
+  end
+
+  def to_select
+    select = (@function || attribute).clone
+    select.as(@as.to_s) if @as
+    select
+  end
+
+  def to_group
+    attribute.clone
+  end
+
+end

data/lib/pivotable/model.rb

@@ -0,0 +1,55 @@
+# Includable module, for ActiveRecord::Base
+module Pivotable::Model
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :_pivotable
+    self._pivotable = {}
+  end
+
+  module ClassMethods
+
+    # Pivotable definition for a model. Example:
+    #
+    #   class Stat < ActiveRecord::Base
+    #
+    #     # Add your rotations
+    #     pivotable do
+    #
+    #       rotation :overall do
+    #         sum :visits
+    #       end
+    #
+    #       # Rotations can in herit parent definitions
+    #       rotation :by_day => :overall do
+    #         by :day
+    #       end
+    #
+    #     end
+    #
+    #     # Add your custom rotations, e.g. for admins
+    #     pivotable :admin do
+    #
+    #       rotation :overall do
+    #         sum :visits
+    #         maximum :bounce_rate
+    #       end
+    #
+    #     end
+    #
+    #   end
+    #
+    def pivotable(name = nil, &block)
+      name = name.present? ? name.to_sym : :_default
+      _pivotable[name] ||= Pivotable::Collection.new(self)
+      _pivotable[name.to_sym].instance_eval(&block) if block
+      _pivotable[name]
+    end
+
+    # Delegator to Relation#pivot
+    def pivot(*args)
+      scoped.pivot(*args)
+    end
+
+  end
+end

data/lib/pivotable/pivoting.rb

@@ -0,0 +1,19 @@
+module Pivotable::Pivoting
+
+  # Apply pivot retations. Example:
+  #
+  #   Stat.pivot(:overall)
+  #
+  #   # Use custom (e.g. admin) rotation
+  #   Stat.pivot(:admin, :by_day)
+  #
+  #   # Combine it with relations & scopes
+  #   Stat.latest.order('some_column').pivot(:by_day).paginate :page => 1
+  #
+  def pivot(*args)
+    rotation = args.pop
+    scope    = args.first.is_a?(Symbol) ? args.shift : nil
+    klass.pivotable(scope)[rotation].merge(self)
+  end
+
+end

data/lib/pivotable/rotation.rb

@@ -0,0 +1,86 @@
+class Pivotable::Rotation
+
+  attr_reader :collection, :name, :parent, :block, :selects, :groups, :joins, :loaded
+  delegate    :model, :to => :collection
+  alias       :loaded? :loaded
+
+  def initialize(collection, name, parent = nil, &block)
+    @collection = collection
+    @name       = name.to_sym
+    @parent     = parent.to_sym if parent
+    @selects    = []
+    @groups     = []
+    @joins      = []
+    @block      = block
+    @loaded     = false
+  end
+
+  def sum(*cols)
+    calculate :sum, *cols
+  end
+
+  def minimum(*cols)
+    calculate :minimum, *cols
+  end
+
+  def maximum(*cols)
+    calculate :maximum, *cols
+  end
+
+  def average(*cols)
+    calculate :average, *cols
+  end
+
+  def by(*cols)
+    cols = columns(*cols)
+    @selects += cols
+    @groups  += cols
+  end
+
+  def calculate(function, *cols)
+    columns(*cols).each do |col|
+      col.calculate!(function)
+      @selects << col
+    end
+  end
+
+  def joins(*names)
+    @joins += names
+  end
+
+  def merge(relation)
+    load! unless loaded?
+
+    selects.each do |column|
+      relation = relation.select(column.to_select)
+    end
+
+    groups.each do |column|
+      relation = relation.group(column.to_group)
+    end
+
+    joins.each do |join|
+      relation = relation.joins(join)
+    end
+
+    relation
+  end
+
+  private
+
+    def load!
+      return if loaded?
+
+      instance_eval &collection[parent].block if parent
+      instance_eval &block
+      @loaded = true
+    end
+
+    def columns(*cols)
+      opts = cols.extract_options!
+      cols.map do |col|
+        Pivotable::Column.new(model, col, opts)
+      end
+    end
+
+end

data/lib/pivotable.rb

@@ -0,0 +1,19 @@
+require "active_support/core_ext"
+require "active_record"
+require "active_record/relation"
+
+module Pivotable
+  autoload :Model,      "pivotable/model"
+  autoload :Pivoting,   "pivotable/pivoting"
+  autoload :Rotation,   "pivotable/rotation"
+  autoload :Column,     "pivotable/column"
+  autoload :Collection, "pivotable/collection"
+end
+
+ActiveRecord::Base.class_eval do
+  include ::Pivotable::Model
+end
+
+ActiveRecord::Relation.class_eval do
+  include ::Pivotable::Pivoting
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: pivotable
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: abstract
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+description: Great for building APIs & reports
+email: dimitrij@blacksquaremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/pivotable/pivoting.rb
+- lib/pivotable/column.rb
+- lib/pivotable/collection.rb
+- lib/pivotable/rotation.rb
+- lib/pivotable/model.rb
+- lib/pivotable.rb
+has_rdoc: true
+homepage: https://github.com/bsm/pivotable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Build pivotable data tables with ActiveRecord
+test_files: []
+