listings 0.0.3 → 0.1.0

data/lib/listings/filter_descriptor.rb

@@ -0,0 +1,7 @@
+module Listings
+  class FilterDescriptor < BaseFieldDescriptor
+    def initialize(path, props, proc)
+      super
+    end
+  end
+end

data/lib/listings/filter_view.rb

@@ -0,0 +1,19 @@
+module Listings
+  class FilterView < BaseFieldView
+    def initialize(listing, filter_description)
+      super
+    end
+
+    def values
+      @values ||= listing.data_source.values_for_filter(field)
+    end
+
+    def value_for(value)
+      if @field_description.proc
+        listing.instance_exec value, &@field_description.proc
+      else
+        value
+      end
+    end
+  end
+end

data/lib/listings/sources.rb

@@ -0,0 +1,7 @@
+module Listings::Sources
+end
+
+require 'listings/sources/data_source'
+require 'listings/sources/object_data_source'
+require 'listings/sources/active_record_data_source'
+

data/lib/listings/sources/active_record_data_source.rb

@@ -0,0 +1,159 @@
+module Listings::Sources
+  class ActiveRecordDataSource < DataSource
+    attr_reader :model_instance
+
+    def initialize(model)
+      @items = model
+      if model.is_a?(ActiveRecord::Relation)
+        @items_for_filter = model.clone
+        @model_instance = model.klass.new
+      else
+        @items_for_filter = model
+        @model_instance = model.new
+      end
+    end
+
+    def connection
+      model_instance.class.connection
+    end
+
+    def items
+      if @items.is_a?(Class)
+        if Rails::VERSION::MAJOR == 3
+          @items.scoped
+        else
+          @items.all
+        end
+      else
+        @items
+      end
+    end
+
+    def scope
+      @items = yield @items
+      @items_for_filter = yield @items_for_filter
+    end
+
+    def sort_with_direction(field, direction)
+      @items = field.sort @items, direction
+    end
+
+    def values_for_filter(field)
+      @items_for_filter.reorder(field.query_column).pluck("distinct #{field.query_column}").reject(&:nil?)
+    end
+
+    def search(fields, value)
+      criteria = []
+      values = []
+      fields.each do |field|
+        criteria << "#{field.query_column} like ?"
+        values << "%#{value}%"
+      end
+      @items = @items.where(criteria.join(' or '), *values)
+    end
+
+    def filter(field, value)
+      @items = @items.where("#{field.query_column} = ?", value)
+    end
+
+    def paginate(page, page_size)
+      @items = @items.page(page).per(page_size)
+    end
+
+    def joins(relation)
+      @items = @items.eager_load(relation)
+      @items_for_filter = @items_for_filter.joins(relation)
+    end
+
+    def build_field(path)
+      path = self.class.sanitaize_path(path)
+      if path.is_a?(Array)
+        ActiveRecordAssociationField.new(path, self)
+      else
+        ActiveRecordField.new(path, self)
+      end
+    end
+  end
+
+  class DataSource
+    class << self
+      def for_with_active_record(model)
+        if (model.is_a?(Class) && model.ancestors.include?(ActiveRecord::Base)) || model.is_a?(ActiveRecord::Relation)
+          ActiveRecordDataSource.new(model)
+        else
+          for_without_active_record(model)
+        end
+      end
+
+      alias_method_chain :for, :active_record
+    end
+  end
+
+  class ActiveRecordField < Field
+    delegate :connection, to: :data_source
+    delegate :quote_table_name, :quote_column_name, to: :connection
+
+    def initialize(attribute_name, data_source)
+      super(data_source)
+      @attribute_name = attribute_name
+    end
+
+    def value_for(item)
+      item.send @attribute_name
+    end
+
+    def query_column
+      "#{quote_table_name(data_source.items.table_name)}.#{quote_column_name(@attribute_name)}"
+    end
+
+    def sort(items, direction)
+      items.reorder("#{query_column} #{direction}")
+    end
+
+    def key
+      @attribute_name.to_s
+    end
+
+    def human_name
+      data_source.model_instance.class.human_attribute_name(@attribute_name)
+    end
+  end
+
+  class ActiveRecordAssociationField < Field
+    delegate :connection, to: :data_source
+    delegate :quote_table_name, :quote_column_name, to: :connection
+
+    def initialize(path, data_source)
+      super(data_source)
+      @path = path
+
+      data_source.joins(path[0])
+    end
+
+    def value_for(item)
+      result = item
+      @path.each do |attribute_name|
+        result = result.try { |o| o.send(attribute_name) }
+      end
+
+      result
+    end
+
+    def query_column
+      association = data_source.model_instance.association(@path[0])
+      "#{quote_table_name(association.reflection.table_name)}.#{quote_column_name(@path[1])}"
+    end
+
+    def sort(items, direction)
+      items.reorder("#{query_column} #{direction}")
+    end
+
+    def key
+      @path.join('_')
+    end
+
+    def human_name
+      @path.join(' ').titleize
+    end
+  end
+end

data/lib/listings/sources/data_source.rb

@@ -0,0 +1,76 @@
+module Listings::Sources
+  class DataSource
+    DESC = 'desc'
+    ASC = 'asc'
+
+    # returns items for the data source
+    # if +paginate+ is called, items will return just the current page
+    def items
+    end
+
+    # applies filter to the items
+    # scope will be called with a block with the ongoing items
+    # the result of the block is used as the narrowed items
+    def scope
+    end
+
+    # applies a human friendly search to items among multiple fields
+    def search(fields, value)
+    end
+
+    # applies exact match filtering among specified field
+    def filter(field, value)
+    end
+
+    # applies sorting with specified direction to items
+    # subclasses should implement +sort_with_direction+ in order to leave
+    # default direction logic in +DataSource+
+    def sort(field, direction = ASC)
+      sort_with_direction(field, direction)
+    end
+
+    # returns all values of field
+    # usually calling +search+/+filter+/+sort+/+paginate+ should not affect the results.
+    # calling +scope+ should affect the results.
+    def values_for_filter(field)
+    end
+
+    # apply pagination filter to +items+
+    # items of the selected page can be obtained through +items+
+    def paginate(page, page_size)
+    end
+
+    # returns a +Field+ for the specified options
+    def build_field(path)
+    end
+
+    def self.for(model)
+      raise "Unable to create datasource for #{model}"
+    end
+
+    def self.sanitaize_path(path)
+      if path.is_a?(Array)
+        path
+      elsif path.is_a?(Hash) && path.size == 1
+        path.to_a.first
+      else
+        path
+      end
+    end
+  end
+
+  class Field
+    attr_reader :data_source
+
+    def initialize(data_source)
+      @data_source = data_source
+    end
+
+    # returns this field over the item
+    def value_for(item)
+    end
+
+    def key
+    end
+  end
+end

data/lib/listings/sources/object_data_source.rb

@@ -0,0 +1,91 @@
+module Listings::Sources
+  class ObjectDataSource < DataSource
+    def initialize(items)
+      @items = items
+      @items_for_filter = items
+    end
+
+    def items
+      @items
+    end
+
+    def paginate(page, page_size)
+      @items = Kaminari.paginate_array(@items).page(page).per(page_size)
+    end
+
+    def scope
+      @items = yield @items
+      @items_for_filter = yield @items_for_filter
+    end
+
+    def sort_with_direction(field, direction)
+      @items = @items.sort do |a, b|
+        b, a = a, b if direction == DESC
+        field.value_for(a) <=> field.value_for(b)
+      end
+    end
+
+    def values_for_filter(field)
+      @items_for_filter.map { |o| field.value_for(o) }.uniq.reject(&:nil?).sort
+    end
+
+    def search(fields, value)
+      @items = @items.select do |item|
+        fields.any? do |field|
+          field.value_for(item).try { |o| o.include?(value) }
+        end
+      end
+    end
+
+    def filter(field, value)
+      @items = @items.select do |item|
+        field.value_for(item) == value
+      end
+    end
+
+    def build_field(path)
+      path = self.class.sanitaize_path(path)
+      unless path.is_a?(Array)
+        path = [path]
+      end
+      ObjectField.new(path, self)
+    end
+  end
+
+  class DataSource
+    class << self
+      def for_with_object(model)
+        ObjectDataSource.new(model)
+      end
+
+      alias_method_chain :for, :object
+    end
+  end
+
+  class ObjectField < Field
+    def initialize(path, data_source)
+      super(data_source)
+      @path = path
+    end
+
+    def value_for(item)
+      @path.inject(item) do |obj, attribute|
+        if obj.nil?
+          nil
+        elsif obj.is_a?(Hash) && obj.key?(attribute)
+          obj[attribute]
+        else
+          obj.send attribute
+        end
+      end
+    end
+
+    def key
+      @path.join('_')
+    end
+
+    def human_name
+      @path.join(' ')
+    end
+  end
+end

data/lib/listings/version.rb

@@ -1,3 +1,3 @@
 module Listings
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/rspec/listings_helpers.rb

@@ -1,15 +1,37 @@
 module RSpec::ListingsHelpers
-  class FakeViewContext
-    include ::Listings::ActionViewExtensions
+  class FakeRoutes
+    def listing_full_path(*options)
+      "/"
+    end
+
+    def listing_full_url(*options)
+      "/"
+    end
 
-    def listings
-      nil
+    def listing_content_url(*options)
+      "/"
     end
   end
 
   def query_listing(name)
-    context = FakeViewContext.new
+    context = fake_context
     context.prepare_listing({:listing => name}, context)
   end
 
+  def render_listing(name)
+    fake_context.render_listing(name)
+  end
+
+  def fake_context
+    controller = ActionController::Base.new
+    controller.request = ActionController::TestRequest.new(:host => "http://test.com")
+    context = controller.view_context
+
+    context.class.send(:define_method, 'listings') do
+      FakeRoutes.new
+    end
+
+    context
+  end
+
 end

data/spec/dummy/app/controllers/welcome_controller.rb

@@ -7,4 +7,7 @@ class WelcomeController < ApplicationController
 
   def hash
   end
+
+  def tracks
+  end
 end

data/spec/dummy/app/listings/array_listing.rb

@@ -10,6 +10,7 @@ class ArrayListing < Listings::Base
     end
   end
 
+  # paginates_per :none
   paginates_per 10
 
   column 'Num' do |n|

data/spec/dummy/app/listings/tracks_fixed_order_listing.rb

@@ -0,0 +1,13 @@
+class TracksFixedOrderListing < Listings::Base
+
+  model Track
+
+  sortable false
+
+  filter album: :name
+
+  column :order
+  column :title
+  column album: :name
+
+end