active-list 4.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2012 Brice Texier
+
+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,46 @@
+= ActiveList
+
+ActiveList is a simple list widget. It permits to create a controller 
+method and view helper to displays lists.
+
+The first need was to have a simple component to build easily HTML 
+tables. No scaffolds, only listings.
+
+ActiveList works only with Rails ≥ 3.1.
+
+== Quick start
+
+First, the JS code must be added to the pipeline in app/assets/javascripts/application.js:
+
+    //= require active-list.jquery
+
+And get a better, you can add in app/assets/stylesheets/application.css:
+
+    *= require active-list
+
+The simple way to use it is to write in our controller:
+  
+    class PeopleController < ApplicationController
+      list
+
+      def index
+      end
+    end
+
+And in the view app/views/people/index.html.erb:
+
+    <%=list-%>
+
+== Build Status {<img src="https://secure.travis-ci.org/burisu/active-list.png"/>}[http://travis-ci.org/burisu/active-list]
+
+== To do
+
+* Provides styles as @mixins for a better customization
+* Adds support for Prototype JS
+* Adds implicit exporters JSON, XML,
+
+== License
+
+ActiveList is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/VERSION

@@ -0,0 +1 @@
+4.0.0

data/lib/active-list.rb

@@ -0,0 +1,37 @@
+require 'fastercsv'
+require 'csv'
+require 'action_dispatch'
+require 'rails'
+require 'compass'
+
+module ActiveList #:nodoc:
+  
+
+  CSV = (::CSV.const_defined?(:Reader) ? ::FasterCSV : ::CSV).freeze
+
+  def self.version 
+    v = nil
+    File.open(File.join(File.dirname(__FILE__), "..", "VERSION")) {|f| v = f.read.strip}
+    return v
+  end
+  VERSION = self.version.freeze
+
+  def self.assets_path
+    File.join(File.dirname(__FILE__), "assets", "images")
+  end
+
+  def self.compass_extension_path
+    File.join(File.dirname(__FILE__), "active-list", "compass")
+  end
+
+end
+
+# Compass registration
+Compass::Frameworks.register('active-list', :path => ActiveList.compass_extension_path)
+
+require "active-list/definition"
+require "active-list/generator"
+require "active-list/action_pack"
+require "active-list/rails/engine"
+
+

data/lib/active-list/action_pack.rb

@@ -0,0 +1,48 @@
+require 'action_controller'
+require 'action_view'
+
+module ActiveList
+
+  module ActionController
+
+    def self.included(base) #:nodoc:
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Permits to define and generate methods to manage dynamic 
+      # table ActiveList
+      def list(*args, &block)
+        name, options = nil, {}
+        name = args[0] if args[0].is_a? Symbol
+        options = args[-1] if args[-1].is_a? Hash
+        name ||= self.controller_name.to_sym
+        model = (options[:model]||name).to_s.classify.constantize
+        options[:controller_method_name] = "list#{'_'+name.to_s if name != self.controller_name.to_sym}"
+        options[:view_method_name]       = "_#{self.controller_name}_list_#{name}_tag"
+        options[:records_variable_name]  = "@#{name}"
+        table = ActiveList::Table.new(name, model, options)
+        if block_given?
+          yield table
+        else
+          table.load_default_columns
+        end
+        
+        class_eval(table.send(:generate_controller_method_code), __FILE__, __LINE__)
+        ActionView::Base.send(:class_eval, table.send(:generate_view_method_code), __FILE__, __LINE__)
+      end
+
+    end
+
+  end
+
+  module ViewsHelper
+    def list(*args, &block)
+      name, options = nil, {}
+      name = args[0] if args[0].is_a? Symbol
+      options = args[-1] if args[-1].is_a? Hash
+      self.send("_#{options[:controller]||self.controller_name}_#{__method__}_#{name||self.controller_name}_tag", &block)
+    end
+  end
+
+end

data/lib/active-list/columns/action_column.rb

@@ -0,0 +1,70 @@
+# coding: utf-8
+module ActiveList
+
+  class Table
+
+    # Add a new method in Table which permit to define data columns
+    def action(name, options={})
+      @columns << ActionColumn.new(self, name, options)
+    end
+
+  end
+
+  class ActionColumn < Column
+
+    def header_code
+      "'ƒ'"
+    end
+
+
+    def operation(record='record')
+      link_options = ""
+      link_options += ", :confirm=>::I18n.translate('labels.#{@options[:confirm]}')" unless @options[:confirm].nil?
+      link_options += ", :method=>#{@options[:method].inspect}" if @options[:method].is_a? Symbol
+      action = @name
+      format = @options[:format] ? ", :format=>'#{@options[:format]}'" : ""
+      if @options[:remote]
+        raise Exception.new("Sure to use :remote ?")
+        remote_options = @options.dup
+        remote_options[:confirm] = ::I18n.translate('labels.'+@options[:confirm].to_s) unless @options[:confirm].nil?
+        remote_options.delete :remote
+        remote_options.delete :image
+        remote_options = remote_options.inspect.to_s
+        remote_options = remote_options[1..-2]
+        code  = "link_to_remote(#{image}"
+        code += ", {:url=>{:action=>:"+@name.to_s+", :id=>"+record+".id"+format+"}"
+        code += ", "+remote_options+"}"
+        code += ", {:title=>::I18n.translate('labels.#{action}')}"
+        code += ")"
+      elsif @options[:actions]
+        raise Exception.new("options[:actions] have to be a Hash.") unless @options[:actions].is_a? Hash
+        cases = []
+        for a in @options[:actions]
+          v = a[1][:action].to_s.split('_')[-1]
+          cases << record+"."+@name.to_s+".to_s=="+a[0].inspect+"\nlink_to(::I18n.translate('labels.#{v}')"+
+            ", {"+(a[1][:controller] ? ':controller=>:'+a[1][:controller].to_s+', ' : '')+":action=>'"+a[1][:action].to_s+"', :id=>"+record+".id"+format+"}"+
+            ", {:id=>'"+@name.to_s+"_'+"+record+".id.to_s"+link_options+", :title=>::I18n.translate('labels.#{v}')}"+
+            ")\n"
+        end
+
+        code = "if "+cases.join("elsif ")+"end"
+      else
+        url = @options[:url] ||= {}
+        url[:controller] ||= @options[:controller]||self.table.model.name.underscore.pluralize.to_sym
+        url[:action] ||= @name
+        url[:id] ||= "RECORD.id"
+        url.delete_if{|k, v| v.nil?}
+        url = "{"+url.collect{|k, v| ":#{k}=>"+(v.is_a?(String) ? v.gsub(/RECORD/, record) : v.inspect)}.join(", ")+format+"}"
+        code = "{:id=>'"+@name.to_s+"_'+"+record+".id.to_s"+link_options+", :title=>::I18n.translate('labels.#{action}')}"
+        code = "link_to(::I18n.translate('labels.#{action}'), "+url+", "+code+")"
+      end
+      code = "if ("+@options[:if].gsub('RECORD', record)+")\n"+code+"\n end" if @options[:if]
+      code
+    end
+
+
+
+
+  end
+
+end

data/lib/active-list/columns/data_column.rb

@@ -0,0 +1,138 @@
+module ActiveList
+
+  class Table
+
+    # Retrieves all columns in database
+    def table_columns
+      cols = self.model_columns.collect{|c| c.name}
+      @columns.select{|c| c.is_a? DataColumn and cols.include? c.name.to_s}
+    end
+
+    def data_columns
+      @columns.select{|c| c.is_a? DataColumn}
+    end
+
+    # Add a new method in Table which permit to define data columns
+    def column(name, options={})
+      @columns << DataColumn.new(self, name, options)
+    end
+
+  end
+
+  class DataColumn < Column
+
+    def header_code
+      if @options[:label].is_a? String
+        "::I18n.translate('labels.#{@options[:label].strip}')"
+      elsif through = @options[:through]
+        through = [through] unless through.is_a? Array
+        model, reflection = @table.model, nil
+        for ref in through
+          unless reflection.nil?
+            model = reflection.class_name.constantize rescue nil
+          end
+          raise Exception.new("Unknown model #{reflection.class_name}") if model.nil?
+          reflection = model.reflections[ref]
+          raise Exception.new("Unknown reflection :#{ref} (#{through.inspect}) for the ActiveRecord: "+model.name) if reflection.nil?
+        end
+        "#{model.name}.human_attribute_name('#{reflection.name}')"
+      else
+        "#{@table.model.name}.human_attribute_name('#{@name}')"
+      end
+    end
+
+
+    # Code for rows
+    def datum_code(record='rekord', child = false)
+      code = if child and @options[:children].is_a? Symbol
+               "#{record}.#{@options[:children]}"
+             elsif child and @options[:children].is_a? FalseClass
+               "nil"
+             elsif through = @options[:through] and !child
+               through = [through] unless through.is_a?(Array)
+               foreign_record = record
+               through.each { |x| foreign_record += '.'+x.to_s }
+               "(#{foreign_record}.#{@name} rescue nil)"
+             else
+               "#{record}.#{@name}"
+             end
+      return code
+    end
+
+    # Code for exportation
+    def exporting_datum_code(record='rekord', noview=false)
+      datum = self.datum_code(record)
+      if self.datatype == :boolean
+        datum = "(#{datum} ? ::I18n.translate('list.export.true_value') : ::I18n.translate('list.export.false_value'))"
+      elsif self.datatype == :date
+        datum = "(#{datum}.nil? ? '' : ::I18n.localize(#{datum}))"
+      elsif self.datatype == :decimal and not noview
+        currency = nil
+        if currency = self.options[:currency]
+          currency = currency[:body] if currency.is_a?(Hash)
+          currency = :currency if currency.is_a?(TrueClass)
+          currency = "RECORD.#{currency}" if currency.is_a?(Symbol)
+          raise Exception.new("Option :currency is not valid. Hash, Symbol or true/false") unless currency.is_a?(String)
+        end
+        datum = "(#{datum}.nil? ? '' : ::I18n.localize(#{datum}#{', :currency=>'+currency.gsub(/RECORD/, record) if currency}))"
+      elsif @name.to_s.match(/(^|\_)currency$/) and self.datatype == :string and self.limit == 3
+        datum = "(#{datum}.nil? ? '' : ::I18n.currency_label(#{datum}))"
+      elsif @name==:country and  self.datatype == :string and self.limit == 2
+        datum = "(#{datum}.nil? ? '' : ::I18n.translate('countries.'+#{datum}))"
+      elsif @name==:language and self.datatype == :string and self.limit <= 8
+        datum = "(#{datum}.nil? ? '' : ::I18n.translate('languages.'+#{datum}))"
+      end
+      return datum
+    end
+
+    # Returns the data type of the column if the column is in the database
+    def datatype
+      @options[:datatype] || (@column ? @column.type : nil)
+    end
+
+
+    def numeric?
+      [:decimal, :integer, :float, :numeric].include? self.datatype
+    end
+
+    # Returns the size/length of the column if the column is in the database
+    def limit
+      @column.limit if @column
+    end
+
+
+    # Returns the class name of the used model
+    def class_name
+      klass = self.table.model
+      if through = @options[:through]
+        through = [through] unless through.is_a? Array
+        for ref in through
+          klass = klass.reflections[ref].class_name.constantize
+        end
+      end
+      return klass.name
+    end
+
+    # Defines if column is exportable
+    def exportable?
+      true
+    end
+
+    # Check if a column is sortable
+    def sortable?
+      #not self.action? and 
+      not self.options[:through] and not @column.nil?
+    end
+
+    # Generate code in order to get the (foreign) record of the column
+    def record_expr(record='record')
+      if @options[:through]
+        return ([record]+[@options[:through]]).flatten.join(".")
+      else
+        return record
+      end
+    end
+
+  end
+
+end

data/lib/active-list/columns/field_column.rb

@@ -0,0 +1,29 @@
+module ActiveList
+
+  class Table
+
+    # Add a new method in Table which permit to define text_field columns
+    def text_field(name, options={})
+      @columns << TextFieldColumn.new(self, name, options)
+    end
+
+    # Add a new method in Table which permit to define check_box columns
+    def check_box(name, options={})
+      @columns << CheckBoxColumn.new(self, name, options)
+    end
+
+  end
+
+  class FieldColumn < Column
+    def header_code
+      "#{@table.model.name}.human_attribute_name('#{@name}')"
+    end
+  end
+
+  class TextFieldColumn < FieldColumn
+  end
+
+  class CheckBoxColumn < FieldColumn
+  end
+
+end

data/lib/active-list/compass/stylesheets/_active-list.scss

@@ -0,0 +1,7 @@
+@import "active-list/minimal";
+@import "active-list/background";
+@import "active-list/theme";
+
+.active-list { 
+  @include active-list-theme;
+}

data/lib/active-list/compass/stylesheets/active-list/_background.scss

@@ -0,0 +1,37 @@
+// Provides mixin to generate colors for cells backgrounds
+//
+
+@function merge-color($color-1, $color-2) {
+  $col2: rgb(red($color-2), green($color-2), blue($color-2));
+  $percent: 100*alpha($color-2);
+  @return mix($col2, $color-1, $percent);
+}
+
+@function merge-colors($color, $color-1: rgba(0, 0, 0, 0), $color-2: rgba(0, 0, 0, 0), $color-3: rgba(0, 0, 0, 0), $color-4: rgba(0, 0, 0, 0), $color-5: rgba(0, 0, 0, 0), $color-6: rgba(0, 0, 0, 0), $color-7: rgba(0, 0, 0, 0), $color-8: rgba(0, 0, 0, 0), $color-9: rgba(0, 0, 0, 0), $color-10: rgba(0, 0, 0, 0)) {
+  @return merge-color(merge-color(merge-color(merge-color(merge-color(merge-color(merge-color(merge-color(merge-color(merge-color($color, $color-1), $color-2), $color-3), $color-4), $color-5), $color-6), $color-7), $color-8), $color-9), $color-10);
+}
+
+$list-line-backgrounds: ("" rgba(255, 255, 255, 0)) (".odd" rgba(255, 255, 255, 0.5)) (".even" rgba(255, 255, 255, 0.5));
+$list-column-backgrounds: ("" rgba(255, 255, 255, 0)) (".act" rgba(255, 134, 0, 0)) (".sor" rgba(0, 18, 132, 0.05));
+$list-hover-backgrounds: ("" rgba(255, 255, 255, 0)) (":hover" rgba(209, 218, 255, 0.3));
+
+@mixin list-colors($bgcolor: #000000, $selector: '&') {
+  tr {
+    #{$selector} {
+      @each $line-background in $list-line-backgrounds {
+        &#{nth($line-background, 1)} {
+          @each $hover-background in $list-hover-backgrounds {
+            &#{nth($hover-background, 1)} {
+              @each $col-background in $list-column-backgrounds {
+                td#{nth($col-background, 1)} {
+                  background-color: merge-colors($bgcolor, nth($line-background, 2), nth($col-background, 2), nth($hover-background, 2));
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+

data/lib/active-list/compass/stylesheets/active-list/_minimal.scss

@@ -0,0 +1,89 @@
+// Minimal style to get a working ActiveList
+
+div[data-list-source] {
+  table.list {
+    thead { 
+      tr {
+        th { 
+          &[data-list-column-sort] { 
+            cursor: pointer;
+          }
+
+          &.spe {
+            padding: 0;
+            .list-menu {
+              position: relative;
+              a { cursor: pointer; }
+              .list-menu-start {
+                display: block;
+                height: 16px;
+                padding: 2px;
+              }
+              &:hover {
+                .list-menu-start { z-index:5000;  position: relative; top: 0px; }
+                & > ul { display: block; }
+              }
+              ul {
+                display: none;
+                position:absolute;
+                top: 20px;
+                padding: 1px;
+                margin:0;
+                html[dir="ltr"] & { right: -1px;}
+                html[dir="rtl"] & { left: -1px;}
+                li {
+                  &[data-list-change-page-size], &[data-list-toggle-column] { 
+                    cursor: pointer;
+                    display: block;
+                    padding: 0.3ex;
+                  }
+                  list-style-type: none;
+                  width: 25ex;
+                  position: relative;
+                  a {
+                    display: block;
+                    padding: 0.3ex;
+                  }
+                  ul {
+                    display: none;
+                    position: absolute;
+                    top: -2px; 
+                    html[dir="ltr"] & { right: 25ex; }
+                    html[dir="rtl"] & { left: 25ex; }
+                    &:hover { display:block; }
+                  }
+                  &:hover ul { display:block; }
+                }
+              }
+            }
+          }
+
+          &.hidden { 
+            display: none;
+          }
+
+        }
+      }
+    }
+      
+    tbody { 
+      tr {
+        td.hidden { 
+          display: none;
+        }
+      }
+    }
+  
+  }
+
+  div.extras { 
+    .pagination {
+      a[data-list-move-to-page] { 
+        cursor: pointer;
+      }
+      a[data-list-move-to-page][disabled] { 
+        cursor: default;
+      }
+    }
+  }
+}