the_jobbook_admin_data 1.3.0a

data/lib/admin_data/analytics.rb

@@ -0,0 +1,176 @@
+require "active_support/all"
+
+module AdminData
+  module Analytics
+
+    # a utility class to handle date interpolation for different databases
+    class Dater
+      attr_accessor :adapter, :type
+
+      def initialize(adapter, type = 'daily')
+        @adapter = adapter
+        @type = type
+      end
+
+      def date_select_key
+        "date_data"
+      end
+
+      def group_by_key
+        if adapter =~ /postgresql/i
+          self.type == 'monthly' ? "date_part('year', created_at), date_part('month', created_at)" : "date_data"
+        elsif adapter =~ /mysql/i
+          self.type == 'monthly' ? "YEAR(created_at), MONTH(created_at)" : "date_data"
+        else
+          self.type == 'monthly' ? "strftime('%Y', created_at), strftime('%m', created_at)" : "date_data"
+        end
+      end
+
+      def count_select_key
+        "count_data"
+      end
+
+      def count_function
+        "count(*) as count_data"
+      end
+
+      def date_select_function
+        self.type == 'monthly' ? date_select_function_monthly : date_select_function_daily
+      end
+
+      private
+
+      def date_select_function_monthly
+        if adapter =~ /mysql/i
+          "MONTH(created_at) as date_data"
+        elsif adapter =~ /postgresql/i
+          "date_part('month', created_at) as date_data"
+        else
+          "strftime('%m', created_at) as date_data"
+        end
+      end
+
+      def date_select_function_daily
+        if adapter =~ /mysql/i
+          "date_format(created_at, '%Y-%m-%d') as date_data"
+        else
+          "date(created_at) as date_data"
+        end
+      end
+
+    end
+
+    def self.monthly_report(klass, end_date)
+      begin_date = end_date.ago(1.year)
+      raise "begin_date should not be after end_date" if begin_date > end_date
+      raise AdminData::NoCreatedAtColumnException unless klass.columns.find {|r| r.name == 'created_at'}
+
+      begin_date = begin_date.beginning_of_day
+      end_date = end_date.end_of_day
+
+      dater = Dater.new(ActiveRecord::Base.connection.adapter_name, 'monthly')
+
+      query = klass.unscoped
+      query = query.where(["created_at >= ?", begin_date])
+      query = query.where(["created_at <= ?", end_date])
+      query = query.group(dater.group_by_key)
+      query = query.select(dater.date_select_function)
+      query = query.select(dater.count_function)
+      debug "sql: " + query.to_sql
+      result = query.all
+      debug "sql result: #{result.inspect}"
+
+      extract_data_from_result_set_monthly(result, dater, begin_date, end_date)
+    end
+
+    def self.extract_data_from_result_set_monthly(result, dater, begin_date, end_date)
+      debug "extracting from result set now"
+      result_hash = {}
+      result.each do |record|
+        result_hash.merge!(record[dater.date_select_key].to_i => record[dater.count_select_key])
+      end
+
+      debug "result_hash.inspect is #{result_hash.inspect}"
+      
+      current_month = begin_date.strftime('%m').to_i
+      months_order = (1..current_month).to_a.reverse + (current_month..12).to_a.reverse
+      months_order.uniq!.reverse!
+
+      debug "months order is #{months_order.inspect}"
+
+      final_hash = ActiveSupport::OrderedHash.new
+      months_order.each do |month|
+        month = month.to_i #sqlite3 has months as 03 instead of 3
+        m = Time.now.change(:month => month)
+        m = m.ago(1.year) if month > current_month
+
+        key = m.strftime('%b-%Y')
+        key = "'#{key}'"
+        if dater.adapter =~ /postgresql/i
+          value = result_hash[month]
+        elsif dater.adapter =~ /mysql/i
+          value = result_hash[month]
+        else
+          value = result_hash[month]
+        end
+        value = value.to_i
+        debug "month: #{month} key: #{key} value: #{value}"
+        final_hash.merge!(key => value)
+      end
+
+      final_hash.to_a.tap {|e| debug e.inspect }
+    end
+      
+    def self.daily_report(klass, end_date)
+      begin_date = end_date.ago(1.month)
+      raise "begin_date should not be after end_date" if begin_date > end_date
+      raise AdminData::NoCreatedAtColumnException unless klass.columns.find {|r| r.name == 'created_at'}
+
+      begin_date = begin_date.beginning_of_day
+      end_date = end_date.end_of_day
+
+      dater = Dater.new(ActiveRecord::Base.connection.adapter_name)
+
+      query = klass.unscoped
+      query = query.where(["created_at >= ?", begin_date])
+      query = query.where(["created_at <= ?", end_date])
+      query = query.group(dater.group_by_key)
+      query = query.select(dater.date_select_function)
+      query = query.select(dater.count_function)
+      debug "sql: " + query.to_sql
+      result = query.all
+      debug "sql result: #{result.inspect}"
+
+      extract_data_from_result_set_daily(result, dater, begin_date, end_date).tap {|e| debug "formatted output: "+e.inspect}
+    end
+
+    def self.extract_data_from_result_set_daily(result, dater, begin_date, end_date)
+      count = result.map {|r| r[dater.count_select_key] }
+      dates = result.map {|r| r[dater.date_select_key] }
+
+      debug "count is: #{count.inspect}"
+      debug "dates is: #{dates.inspect}"
+
+      final_output= []
+
+      while(begin_date) do
+        s = begin_date.strftime('%Y-%m-%d')
+        final_count = if index = dates.index(s)
+          count[index].to_i
+        else
+          0
+        end
+        final_output << ["'#{s}'", final_count]
+        begin_date = begin_date.tomorrow
+        break if begin_date > end_date
+      end
+      final_output
+    end
+
+    def self.debug(msg)
+      puts msg
+    end
+
+  end
+
+end

data/lib/admin_data/authenticator.rb

@@ -0,0 +1,15 @@
+# HttpBasic authenticator for feed authentication
+module AdminData
+  class Authenticator
+
+    def initialize(userid, password)
+      @userid = userid
+      @password = password
+    end
+
+    def verify(controller)
+      controller.authenticate_or_request_with_http_basic { |_u, _p| (_u == @userid) && (_p == @password) }
+    end
+
+  end
+end

data/lib/admin_data/config.rb

@@ -0,0 +1,38 @@
+# Following code takes care of providing a nice error
+# message to users who are using old API
+module AdminData
+
+  class Config
+    cattr_accessor :setting
+
+    def self.set=(input = {})
+
+msg=<<EOF
+
+AdminData API has changed in version 1.1 .
+
+The changes are very minor.
+
+Instead of
+
+AdminData::Config.set = {
+ :find_conditions => ....
+}
+
+Now you need to write in following style
+
+AdminData.config do |config|
+ config.find_conditions = ...
+end
+
+Please refer to documentation at
+https://github.com/neerajdotname/admin_data/wiki/Customizing-admin_data-for-a-Rails-3-application
+for more information.
+
+EOF
+
+      raise msg
+    end
+
+  end
+end

data/lib/admin_data/configuration.rb

@@ -0,0 +1,127 @@
+module AdminData
+
+  class Configuration
+
+    # Number of recores displayed while listing records
+    attr_accessor :number_of_records_per_page
+
+    # Default value is false .
+    # Set this value to true if you want admin_data to ignored
+    # the column_limit returned by ActiveRecord .
+    attr_accessor :ignore_column_limit
+
+    # By default this value is true .
+    # Set this value to false if you do not want all the belongs_to
+    # ids to be populated. If set to false then instead of a dropdown
+    # user will get a text field where the id can be entered. It matters
+    # only while editing or creating a new record.
+    attr_accessor :drop_down_for_associations
+
+    # Holds a proc which should be called. If the returned value is
+    # true then user is granted the access. Otherwise access is denied.
+    attr_writer :is_allowed_to_view
+
+    # Holds a proc which should be called. If the returned value is
+    # true then user is granted the access. Otherwise access is denied.
+    attr_writer :is_allowed_to_update
+
+    # Holds a proc which should be called. If the returned value is
+    # true then user is granted the access. Otherwise access is denied.
+    attr_writer :is_allowed_to_view_feed
+
+    # For feed authentication a combination of user_id and password is used.
+    # This attribute sets the user_id .
+    attr_accessor :feed_authentication_user_id
+
+    # For feed authentication a combination of user_id and password is used.
+    # This attribute sets the password .
+    attr_accessor :feed_authentication_password
+
+    # Tell AdminData to not to use id for models like given below.
+    #
+    # class City < ActiveRecord::Base
+    #   def to_param
+    #     self.permanent_name
+    #   end
+    # end
+    #
+    #  AdminData.config do |config|
+    #    proc = lambda {|params| {:conditions => ["permanent_name = ?", params[:id] ] } }
+    #    config.find_conditions = {'City' => proc }
+    #  end
+    #
+    attr_accessor :find_conditions
+
+    # Tell AdminData how to display the value for a column
+    #
+    #  AdminData.config do |config|
+    #    proc = lambda {|model| model.send(:data).inspect}
+    #    config.column_settings = {'City' => {:data => proc } }
+    #  end
+    #
+    attr_accessor :column_settings
+
+    # Tell AdminData how to order the columns for a model.
+    #
+    #  AdminData.config do |config|
+    #    config.column_order = {'City' => [:id, :title, :body, :published_at, :author_name]}
+    #  end
+    #
+    attr_accessor :columns_order
+
+    def is_allowed_to_view
+      return lambda {|controller| return true } if Rails.env.development?
+      @is_allowed_to_view || lambda {|_| nil }
+    end
+
+    def is_allowed_to_update
+      return lambda {|controller| return true } if Rails.env.development?
+      @is_allowed_to_update || lambda {|_| nil }
+    end
+
+    def is_allowed_to_view_feed
+      return lambda {|controller| return true } if Rails.env.development?
+      @is_allowed_to_view_feed || lambda {|_| nil }
+    end
+
+    # TODO explain why it is needed
+    attr_reader :adapter_name
+
+    # Tell AdminData how to name a column in a listing
+    # Example:
+    #
+    # config.column_headers = {'Timesheet' => {:id => 'ID'}
+    #
+    attr_accessor :column_headers
+
+    def initialize
+      @number_of_records_per_page =  50
+      @is_allowed_to_view         = nil
+      @is_allowed_to_update       = nil
+      @is_allowed_to_view_feed    = nil
+      @find_conditions            = {}
+      @drop_down_for_associations = true
+      @columns_order              = {}
+      @column_headers             = {}
+      @column_settings            = {}
+      @adapter_name               =  ActiveRecord::Base.connection.adapter_name
+      @ignore_column_limit        = false
+    end
+   
+    def display_assoc?( class_name )
+      case @drop_down_for_associations
+        when Hash
+          return @drop_down_for_associations[ class_name ]
+        when TrueClass, FalseClass
+          return @drop_down_for_associations
+        when NilClass 
+          return false
+        else
+          raise "Configuration Error. #{@drop_down_for_associations} " \
+                "must be true, false or a Hash."
+      end
+    end 
+
+  end
+
+end

data/lib/admin_data/date_util.rb

@@ -0,0 +1,58 @@
+require 'date'
+
+module AdminData
+  class DateUtil
+
+    # returns a time object for the given input.
+    # validation is not done. It is assumed that client
+    # has done validation using .valid? method.
+    def self.valid?(input)
+      !!parse(input)
+    end
+
+    # Usage:
+    #
+    # parase('13-feb-2008')     # => time object
+    # parse('13-February-2008') # => time object
+    # parse('13-February-2008') # => time object
+    # parse('99-Feb-2008')      #=> false
+    #
+    def self.parse(input)
+      return false if input.blank?
+
+      input.strip!
+
+      # remove all the white space characters
+      input.gsub!(/\s/,'')
+
+      return false if input.length < 9
+
+      dd,mm,yyyy = input.split('-')
+      return false if dd.nil? || mm.nil? || yyyy.nil?
+
+      # month must be of atleast three characters
+      return false if mm.length < 3
+
+      mm = mm.downcase[0,3]
+
+      months = {'jan' => 1, 'feb' => 2, 'mar' => 3, 'apr' => 4, 'may' => 5, 'jun' => 6,
+                'jul' => 7, 'aug' => 8, 'sep' => 9, 'oct' => 10, 'nov' => 11, 'dec' => 12 }
+
+      return false unless months.keys.include? mm
+
+      mm = months[mm].to_i
+      yyyy = yyyy.to_i
+      dd = dd.to_i
+
+      # validate date values
+      begin
+        Date.new(yyyy,mm,dd)
+      rescue
+        return false
+      end
+
+      Time.now.change(:year => yyyy, :month => mm, :day => dd, :hour => 0)
+    end
+
+  end
+end

data/lib/admin_data/engine.rb

@@ -0,0 +1,17 @@
+module AdminData
+  class Engine < ::Rails::Engine
+    isolate_namespace AdminData
+
+    initializer "admin_data precompile hook" do |app|
+      app.config.assets.precompile += [
+        'advance_search/*',
+        'analytics/*',
+        'misc/*',
+        'vendor/*',
+        'vendor/jquery-ui-1.7.2.custom.css',
+        'admin_data.js',
+        'admin_data.css'
+      ]
+    end
+  end
+end

data/lib/admin_data/model_finder.rb

@@ -0,0 +1,15 @@
+module AdminData
+  module ModelFinder
+    extend self
+
+    def models
+      ActiveRecord::Base.send(:subclasses).map do | klass | 
+        namespaced_models(klass).push(klass.name) 
+      end.flatten.sort
+    end
+
+    def namespaced_models(model_klass)
+      model_klass.subclasses.map(&:name)
+    end
+  end
+end