admin_data 1.0.22 → 1.1.0

data/app/views/admin_data/shared/_secondary_navigation.html.erb

@@ -1,28 +1,27 @@
 <%
-  @quick_search_tab_active = params[:action] == 'quick_search' ? 'active' : ''
-  @advance_search_tab_active = params[:action] == 'advance_search' ? 'active' : ''
-  @table_structure_tab_active = params[:action] == 'table_structure' ? 'active' : ''
-  @add_new_record_tab_active = %w(new create).include?(params[:action]) ? 'active' : ''
+  quick_search_tab_active = params[:action] == 'quick_search' ? 'active' : ''
+  advance_search_tab_active = params[:action] == 'advance_search' ? 'active' : ''
+  table_structure_tab_active = params[:controller] == 'admin_data/table_structure' ? 'active' : ''
+  add_new_record_tab_active = %w(new create).include?(params[:action]) ? 'active' : ''
 %>
-
 <ul>
 
-  <li class="first <%=@quick_search_tab_active%>">
-    <%= link_to 'Quick Search', admin_data_search_path(:klass => klass.name.underscore) %> 
+  <li class="first <%=quick_search_tab_active%>">
+    <%= link_to 'Quick Search', admin_data_search_path(:klass => klass.name.underscore) %>
   </li>
 
-  <li class="<%=@advance_search_tab_active%>">
+  <li class="<%=advance_search_tab_active%>">
     <%= link_to 'Advance Search', admin_data_advance_search_path(:klass => klass.name.underscore)  %>
   </li>
 
-  <li class="<%=@table_structure_tab_active%>">
+  <li class="<%=table_structure_tab_active%>">
     <%= link_to 'Table Structure', admin_data_table_structure_path(:klass => klass.name.underscore) %>
   </li>
-  
-  <% if admin_data_is_allowed_to_update? %>
-    <li class="<%=@add_new_record_tab_active%>"> 
+
+  <% if is_allowed_to_update? %>
+    <li class="<%=add_new_record_tab_active%>">
       <%= link_to '+Add New Record', admin_data_new_path(:klass => klass.name.underscore) %>
     </li>
-  <% end %>  
-  
+  <% end %>
+
 </ul>

data/app/views/admin_data/{main/table_structure.html.erb → table_structure/index.html.erb}

@@ -1,17 +1,17 @@
 <div id="main">
 
-  <%= admin_data_breadcrum do %>
-    <%= link_to @klass, admin_data_search_path(:klass => @klass.name) %> 
+  <%= breadcrum do %>
+    <%= link_to @klass, admin_data_search_path(:klass => @klass.name) %>
   <% end %>
-  
+
   <%= render 'admin_data/shared/flash_message', :model => @model %>
-  
+
   <div class="block" id="block-tables">
     <div class="secondary-navigation">
       <%= render 'admin_data/shared/secondary_navigation', :klass => @klass %>
       <div class="clear"></div>
-    </div>          
-    <div class="content rounded">          
+    </div>
+    <div class="content rounded">
       <h2 class="title"></h2>
       <div class="inner">
         <h1 class='table_name'>Table name : <%=@klass.send(:table_name)%></h1>
@@ -29,13 +29,13 @@
               <td><%=column.null%></td>
               <td><%= AdminData::Util.string_representation_of_data(column.default) if column.has_default?%></td>
             </tr>
-          <% end %>  
+          <% end %>
         </table>
 
-        <h2>Index</h2>            
+        <h2>Index</h2>
         <% if @indexes.size == 0 %>
           <p>No index was found </p>
-        <% else %>  
+        <% else %>
           <table class="table colorize">
             <tr>
               <th>Info</th>
@@ -44,10 +44,10 @@
               <tr>
                 <td><%= index %></td>
               </tr>
-            <% end %>  
+            <% end %>
           </table>
         <% end %>
-        
+
       </div>
     </div>
   </div>

data/app/views/layouts/admin_data.html.erb

@@ -6,35 +6,35 @@
       <%= @page_title.blank? ? 'admin_data' : "#{@page_title} - admin_data" %>
     </title>
 
-    <%= AdminData::Util.google_hosted_jquery_ui_css(self).html_safe %>
+    <%= stylesheet_link_tag('vendor/jquery-ui-1.7.2.custom.css') %>
 
-    <%= AdminData::Util.stylesheet_link_tag('base').html_safe %>
+    <%= stylesheet_link_tag('base') %>
 
-    <%= AdminData::Util.google_hosted_jquery(self).html_safe %>
+    <%= javascript_include_tag('vendor/jquery-1.4.2.js', 'vendor/jquery-ui-1.7.2.custom.min.js') %>
 
-    <%= AdminData::Util.javascript_include_tag('vendor/jquery.form').html_safe %> 
+    <%= javascript_include_tag('vendor/jquery_form') %>
 
-    <%= AdminData::Util.javascript_include_tag('vendor/log', 
+    <%= javascript_include_tag('vendor/log',
                                                'vendor/rails',
                                                'misc/drop_down_change',
                                                'misc/quick_search_input_focus',
                                                'advance_search/global_ajax_setting',
-                                               'misc/js_util').html_safe %>
+                                               'misc/js_util') %>
 
     <% if params[:action] == 'advance_search' %>
-      <%= AdminData::Util.javascript_include_tag(
-                                                 'advance_search/advance_search', 
-                                                 'advance_search/advance_search_structure', 
+      <%= javascript_include_tag(
+                                                 'advance_search/advance_search',
+                                                 'advance_search/advance_search_structure',
                                                  'advance_search/ajaxify_advance_search',
                                                  'advance_search/act_on_result',
                                                  'advance_search/build_first_row',
                                                  'advance_search/event_bindings',
                                                  'advance_search/trigger_submit_on_domready'
-                                                ).html_safe %>
+                                                ) %>
     <% end %>
 
     <%= csrf_meta_tag %>
-  
+
   </head>
 
   <body>
@@ -46,14 +46,14 @@
     <div>
       <%= render 'admin_data/shared/header', :drop_down_for_klasses => @drop_down_for_klasses %>
       <div class='clear'></div>
-    </div>  
+    </div>
     <div id="container">
       <div id="wrapper">
         <%= yield %>
-        <div class="clear"></div>      
-      </div>    
+        <div class="clear"></div>
+      </div>
       <%= render :partial => 'admin_data/shared/powered_by' %>
     </div>
   </body>
-  
+
 </html>

data/config/routes.rb

@@ -7,9 +7,7 @@ Rails.application.routes.draw do
   namespace(:admin_data) do
     scope :admin_data do
 
-      controller "main" do
-        match '/',                              :to => :index,            :as => :index
-        match '/klass/:klass/table_structure',  :to => :table_structure,  :as => :table_structure, :via => :get
+      controller "crud" do
         match '/klass/(:klass)',                :to => :index,            :as => :index,           :via => :get
         match '/klass/(:klass)',                :to => :create,           :as => :index,           :via => :post
         match '/klass/:klass/new',              :to => :new,              :as => :new, :via => :get
@@ -25,9 +23,11 @@ Rails.application.routes.draw do
         match '/jstest',    :to => :jstest, :as => :jstest
       end
 
+      match '/table_structure/:klass' => "table_structure#index", :as => :table_structure
       match '/quick_search/:klass' => "search#quick_search", :as => :search
       match '/advance_search/:klass' => "search#advance_search", :as => :advance_search
       match '/public/*file' => "public#serve"
+      root :to => "home#index"
 
     end
   end

data/lib/admin_data.rb

@@ -1,6 +1,34 @@
 require 'will_paginate'
+require 'admin_data/configuration'
 
 module AdminData
+  LIBPATH = File.expand_path(::File.dirname(__FILE__)) + File::SEPARATOR
+
+  def self.plugin_dir
+    File.expand_path(File.join(LIBPATH, '..')) + File::SEPARATOR
+  end
+
+  def self.public_dir
+    File.expand_path(File.join(LIBPATH, '..', 'public')) + File::SEPARATOR
+  end
+
+  class << self
+    # A configuration object that acts like a hash.
+    # See AdminData::Configuration for details.
+    attr_accessor :configuration
+
+    # Call this method to modify defaults in initializer.
+    #
+    # @example
+    #   AdminData.config do |config|
+    #     config.number_of_records_per_page = 20
+    #   end
+    def config
+      self.configuration ||= Configuration.new
+      block_given? ? yield(self.configuration) : self.configuration
+    end
+  end
+
 end
 
 if Rails.version >= '3.0'
@@ -12,12 +40,7 @@ end
 # move date_validation to inside admin_data
 require 'admin_data_date_validation'
 
-require 'admin_data/helpers'
-require 'admin_data/chelper'
-require 'admin_data/settings'
+require 'admin_data/deprecation'
 require 'admin_data/extension'
 require 'admin_data/util'
 require 'admin_data/active_record_util'
-
-AdminData::Config.initialize_defaults
-ActionView::Base.send :include, AdminData::Helpers

data/lib/admin_data/active_record_util.rb

@@ -1,26 +1,50 @@
 module AdminData
   class ActiveRecordUtil
 
+    # class User
+    #   has_and_belongs_to_many :clubs
+    # end
+    #
+    # User.declared_habtm_association_names(Club)
+    # #=> ['clubs']
     def self.declared_habtm_association_names(klass)
       delcared_association_names_for(klass, :has_and_belongs_to_many).map(&:name).map(&:to_s)
     end
 
+    # class User
+    #   belongs_to :club
+    # end
+    #
+    # User.declared_belongs_to_association_names(Club)
+    # #=> ['club']
     def self.declared_belongs_to_association_names(klass)
       delcared_association_names_for(klass, :belongs_to).map(&:name).map(&:to_s)
     end
 
+    # class User
+    #   has_one :car
+    # end
+    #
+    # User.declared_has_one_association_names(Car)
+    # #=> ['car']
     def self.declared_has_one_association_names(klass)
       delcared_association_names_for(klass, :has_one).map(&:name).map(&:to_s)
     end
 
+    # class User
+    #   has_many :cars
+    # end
+    #
+    # User.declared_has_many_association_names(Car)
+    # #=> ['cars']
     def self.declared_has_many_association_names(klass)
       delcared_association_names_for(klass, :has_many).map(&:name).map(&:to_s)
     end
 
     # returns declared association names like
-    # #=> [comments]
-    # #=> [positive_comments]
-    # #=> [negative_comments]
+    # #=> ['comments']
+    # #=> ['positive_comments']
+    # #=> ['negative_comments']
     def self.delcared_association_names_for(klass, association_type)
       klass.name.camelize.constantize.reflections.values.select do |value|
         value.macro == association_type
@@ -28,7 +52,13 @@ module AdminData
     end
 
     # returns an array of classes
-    # #=> [Comment]
+    #
+    # class User
+    #   has_and_belongs_to_many :clubs
+    # end
+    #
+    # ActiveRecordUtil.habtm_klasses_for(User)
+    # #=> [Club]
     def self.habtm_klasses_for(klass)
       declared_habtm_association_names(klass).map do |assoc_name|
         klass_for_association_type_and_name(klass, :has_and_belongs_to_many, assoc_name)
@@ -41,7 +71,8 @@ module AdminData
     #   has_many :comments
     # end
     #
-    # AdminData::ActiveRecordUtil.habtm_klass_for_association_name(User, 'comments') #=> Comment
+    # ActiveRecordUtil.klass_for_association_type_and_name(User, :has_many, 'comments') #=> Comment
+    #
     def self.klass_for_association_type_and_name(klass, association_type, association_name)
       data = klass.name.camelize.constantize.reflections.values.detect do |value|
         value.macro == association_type && value.name.to_s == association_name
@@ -51,7 +82,8 @@ module AdminData
     # TODO test with polymorphic
 
 
-    def self.association_info_size(k)
+    # returns false if the given Klass has no association info. Otherwise returns true.
+    def self.has_association_info?(k)
       AdminData::ActiveRecordUtil.declared_belongs_to_association_names(k).any? ||
       AdminData::ActiveRecordUtil.declared_has_many_association_names(k).any? ||
       AdminData::ActiveRecordUtil.declared_has_many_association_names(k).any? ||

data/lib/admin_data/configuration.rb

@@ -0,0 +1,113 @@
+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
+
+  end
+
+end

data/lib/admin_data/deprecation.rb

@@ -0,0 +1,31 @@
+class AdminData::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 do
+
+AdminData.config do |config|
+ config.find_conditions = ...
+}
+
+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