admin_data 1.0.22 → 1.1.0

data/History.txt

@@ -1,3 +1,10 @@
+=== 2010-12-07
+* new router api
+* new configuration api. It is not backward compatible. However the error message is nice.
+* cucumber tests are inside the repo
+* support for column_headers
+* support for column_settings
+
 === 2010-11-08 v1.0.20
 * support for habtm
 * do not get the list of nested models. It breaks routing. Comprehensive nested models fix coming soon.
@@ -38,7 +45,7 @@
 * fix for options defined in ~/config/initializers/admin_data_settings.rb not taking effect
 
 === 2010-08-17 v1.0.3
-* added more tests 
+* added more tests
 * fixed a bug related to :is_allowed_to_view_klass
 
 
@@ -116,7 +123,7 @@
 
 === 0.0.26 2009-11-04
 
-* cleaning up History.txt file 
+* cleaning up History.txt file
 
 === 0.0.25 2009-11-03
 
@@ -139,7 +146,7 @@
 
 === 0.0.21 2009-10-26
 
-* fixed the formatting issue while displaying missing index in diagnostic section 
+* fixed the formatting issue while displaying missing index in diagnostic section
 * by passing additional parameter called 'attr' editing of a record would display
 only one field to avoid any accidental change.
 
@@ -154,7 +161,7 @@ override the sql that is built by admin_data
 
 === 0.0.18 2009-10-16
 
-* changed theme from warehouse to dark because the association info on the right 
+* changed theme from warehouse to dark because the association info on the right
 hand side was not appearing correctly
 * homepage should have main tab selected
 * changed urls to support models that override to_param to other than id
@@ -164,14 +171,14 @@ as A,Q,B instead of A,B,Q.
 === 0.0.17 2009-10-08
 
 * drop down of klasses is now available at the center of home page
-* current model will be selected in the drop down  
+* current model will be selected in the drop down
 
 === 0.0.16 2009-10-07
 
 * form UI foreign keys are dropdown (display name attribute if it exists and id otherwise)
 * form UI date fields use date_select (with free text year since we cannot guess a good range)
 * form UI refactored to use form_for instead of form_tag and hadcoded html
-     
+
 === 0.0.15 2009-10-06
 
 * cache the list of models
@@ -182,21 +189,21 @@ as A,Q,B instead of A,B,Q.
 
 === 0.0.14 2009-10-05
 
-* while editing match was being done for hard coded value id. Now it looks for klass.primary_key 
+* while editing match was being done for hard coded value id. Now it looks for klass.primary_key
 
 === 0.0.13 2009-10-04
 
-* fixed IE7 bug 
+* fixed IE7 bug
 
 === 0.0.12 2009-10-04
 
-* fixed bug regarding integer values not appearning in listing 
+* fixed bug regarding integer values not appearning in listing
 * better indentation
 
 === 0.0.11 2009-10-01
 
-* Major contribution in this release by Alex Rothenberg. http://github.com/alexrothenberg 
-* this plugin now treats each model as a restful resource. 
+* Major contribution in this release by Alex Rothenberg. http://github.com/alexrothenberg
+* this plugin now treats each model as a restful resource.
 * security fix and test for it
 * commented out offending code for has_one relationship
 * has_one and habtm relationships along with test would be taken up in next release
@@ -210,7 +217,7 @@ as A,Q,B instead of A,B,Q.
 
 === 0.0.10 2009-09-18
 
-* fixed listing and has_many association info for namespaced model 
+* fixed listing and has_many association info for namespaced model
 
 === 0.0.9 2009-09-18
 
@@ -224,7 +231,7 @@ as A,Q,B instead of A,B,Q.
 
 === 0.0.7 2009-09-17
 
-* fixed test for Vehicle::Car 
+* fixed test for Vehicle::Car
 
 === 0.0.6 2009-09-09
 
@@ -242,9 +249,9 @@ as A,Q,B instead of A,B,Q.
 
 * changed the way security configiruation is passed to the plugin
 
-* users can configure number of records in a page. Default is 50 
+* users can configure number of records in a page. Default is 50
 
-* fixed bug associated with advance search 
+* fixed bug associated with advance search
 
 * added link to report bug in footer
 
@@ -253,7 +260,7 @@ as A,Q,B instead of A,B,Q.
 === 0.0.4 2009-08-28
 
 * storing serialized array in string causing problem in truncate method. more at
-  http://github.com/neerajdotname/admin_data/issues#issue/3. 
+  http://github.com/neerajdotname/admin_data/issues#issue/3.
 
 === 0.0.3 2009-08-10
 

data/README.md

@@ -14,7 +14,7 @@
 
 #Test#
 
-Test code currently resides in a different project [admin_data_test](http://github.com/neerajdotname/admin_data_test) . Test code should be merged into this project very soon.
+cd _test/rails_app_ and read the instructions mentioned at README.md there.
 
 
 ### License

data/Rakefile

@@ -17,7 +17,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'AdminData'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
@@ -31,7 +31,7 @@ begin
     s.email = "neerajdotname@gmail.com"
     s.homepage = "http://github.com/neerajdotname/admin_data"
     s.authors = ['Neeraj Singh']
-    s.files = FileList["[A-Z]*", "{app,config,lib,test}/**/*", 'init.rb']
+    s.files = FileList["[A-Z]*", "{app,config,lib}/**/*", 'init.rb']
 
     s.add_dependency('will_paginate', '>= 3.0.pre2')
 

data/app/controllers/admin_data/application_controller.rb

@@ -0,0 +1,111 @@
+module AdminData
+
+  class ApplicationController < ::ApplicationController
+
+    before_filter :ensure_is_allowed_to_view
+
+    helper_method :is_allowed_to_update?
+
+    layout 'admin_data'
+
+    before_filter :build_klasses, :build_drop_down_for_klasses, :check_page_parameter, :prepare_drop_down_klasses
+
+    attr_reader :klass, :model
+
+    protected
+
+    self.config.asset_path = lambda {|asset| "/admin_data/public#{asset}"}
+
+    private
+
+    def prepare_drop_down_klasses
+      k = params[:klass] || ''
+      @drop_down_url = "http://#{request.host_with_port}/admin_data/quick_search/#{CGI.escape(k)}"
+    end
+
+    def ensure_is_allowed_to_view
+      render :text => 'not authorized' unless is_allowed_to_view?
+    end
+
+    def ensure_is_allowed_to_update
+      render :text => 'not authorized' unless is_allowed_to_update?
+    end
+
+    def get_class_from_params
+      begin
+        @klass = Util.camelize_constantize(params[:klass])
+      rescue TypeError => e # in case no params[:klass] is supplied
+        render :text => 'wrong params[:klass] was supplied' and return
+      rescue NameError # in case wrong params[:klass] is supplied
+        render :text => 'wrong params[:klass] was supplied' and return
+      end
+    end
+
+    def build_klasses
+      @klasses = _build_all_klasses
+    end
+
+    def _build_all_klasses
+      if defined? $admin_data_all_klasses
+        return $admin_data_all_klasses
+      else
+        model_dir = File.join(Rails.root, 'app', 'models')
+        model_names = Dir.chdir(model_dir) { Dir["*.rb"] }
+        klasses = get_klass_names(model_names)
+        $admin_data_all_klasses = remove_klasses_without_table(klasses).sort_by {|r| r.name.underscore}
+      end
+    end
+
+    def _build_custom_klasses
+      _build_all_klasses.compact.select do |klass_local|
+        @klass = klass_local
+        is_allowed_to_view_klass?
+      end
+    end
+
+    def remove_klasses_without_table(klasses)
+      klasses.select { |k| k.ancestors.include?(ActiveRecord::Base) && k.connection.table_exists?(k.table_name) }
+    end
+
+    def get_klass_names(model_names)
+      model_names.inject([]) do |output, model_name|
+        klass_name = model_name.sub(/\.rb$/,'').camelize
+        begin
+          output << Util.constantize_klass(klass_name)
+        rescue Exception => e
+          Rails.logger.debug e.message
+        end
+        output
+      end
+    end
+
+    def build_drop_down_for_klasses
+      @drop_down_for_klasses = @klasses.inject([]) do |result, klass|
+        result << [klass.name.underscore, admin_data_search_url(:klass => klass.name.underscore)]
+      end
+    end
+
+    def check_page_parameter
+      # Got hoptoad error because of url like
+      # http://localhost:3000/admin_data/User/advance_search?page=http://201.134.249.164/intranet/on.txt?
+      if params[:page].blank? || (params[:page] =~ /\A\d+\z/)
+        # proceed
+      else
+        render :text => 'Invalid params[:page]', :status => :unprocessable_entity
+      end
+    end
+
+    def per_page
+      AdminData.config.number_of_records_per_page
+    end
+
+    def is_allowed_to_view?
+      AdminData.config.is_allowed_to_view.call(self)
+    end
+
+    def is_allowed_to_update?
+      AdminData.config.is_allowed_to_update.call(self)
+    end
+
+  end
+end

data/app/controllers/admin_data/crud_controller.rb

@@ -0,0 +1,100 @@
+module AdminData
+
+  class CrudController  < ApplicationController
+
+    before_filter :get_class_from_params, :only => [:show, :destroy, :del, :edit, :new, :update, :create]
+
+    before_filter :get_model_and_verify_it, :only => [:destroy, :del, :edit, :update, :show]
+
+    before_filter :ensure_is_allowed_to_update, :only => [:destroy, :del, :edit, :update, :create]
+
+    def show
+      @page_title = "#{@klass.name.underscore}:#{@model.id}"
+      respond_to {|format| format.html}
+    end
+
+    def destroy
+      @klass.send(:destroy, params[:id])
+      redirect_to admin_data_search_path(:klass => @klass.name.underscore)
+    end
+
+    def del
+      @klass.send(:delete, params[:id])
+      flash[:success] = 'Record was deleted'
+      redirect_to admin_data_search_path(:klass => @klass.name.underscore)
+    end
+
+    def edit
+      @page_title = "edit #{@klass.name.underscore}:#{@model.id}"
+      @columns = columns_list
+      respond_to {|format| format.html}
+    end
+
+    def new
+      @page_title = "new #{@klass.name.underscore}"
+      @model = @klass.send(:new)
+      @columns = columns_list
+      respond_to {|format| format.html}
+    end
+
+    def update
+      model_attrs = params[@klass.name.underscore]
+      @columns = columns_list
+
+      respond_to do |format|
+        if @model.update_attributes(model_attrs)
+          format.html do
+            flash[:success] = "Record was updated"
+            redirect_to admin_data_path(:id => @model, :klass => @klass.name.underscore)
+          end
+          format.js { render :json => {:success => true}}
+        else
+          format.html { render :action => 'edit' }
+          format.js { render :json => {:error => @model.errors.full_messages.join } }
+        end
+      end
+    end
+
+    def create
+      model_attrs = params[@klass.name.underscore]
+      @model = @klass.create(model_attrs)
+      @columns = columns_list
+
+      respond_to do |format|
+        if @model.errors.any?
+          format.html { render :action => 'new' }
+          format.js { render :json => {:error => @model.errors.full_messages.join() }}
+        else
+          format.html do
+            flash[:success] = "Record was created"
+            redirect_to admin_data_path(:id => @model, :klass => @klass.name.underscore)
+          end
+          format.js { render :json => {} }
+        end
+      end
+    end
+
+    private
+
+    def get_model_and_verify_it
+      primary_key = @klass.primary_key.intern
+      conditional_id = params[:id] =~ /^(\d+)-.*/ ? params[:id].to_i : params[:id]
+      condition = {primary_key => conditional_id}
+
+      _proc = AdminData.config.find_conditions[@klass.name]
+      if _proc && find_conditions = _proc.call(params)
+        condition = find_conditions.fetch(:conditions) if find_conditions.has_key?(:conditions)
+      end
+
+      unless @model = @klass.find(:first, :conditions => condition)
+        render :text => "#{@klass.name} not found: #{params[:id]}"
+        return
+      end
+    end
+
+    def columns_list
+      params[:attr].blank? ? @klass.columns : @klass.columns.find_all {|col| params[:attr] == col.name}
+    end
+
+  end
+end

data/app/controllers/admin_data/feed_controller.rb

@@ -1,26 +1,48 @@
-class AdminData::FeedController < AdminData::BaseController
+module AdminData
 
-  unloadable
+  class FeedController < ApplicationController
 
-  before_filter :ensure_is_allowed_to_view_feed
+    def index
+      render :text => "Usage: http://localhost:3000/admin_data/feed/<model name>" and return if params[:klasss].blank?
 
-  def index
-    render :text => "Usage: http://localhost:3000/admin_data/feed/<model name>" and return if params[:klasss].blank?
+      begin
+        @klass = Util.camelize_constantize(params[:klasss])
+        @title = "Feeds from admin_data #{@klass.name}"
+        @description = "feeds from AdminData #{@klass.name}"
+        @records = @klass.find(:all, :order => "#{@klass.primary_key} desc", :limit => 100)
+      rescue NameError => e
+        render :text => "No constant was found with name #{params[:klasss]}" and return
+      end
+    end
+
+    private
 
-    begin
-      @klass = AdminData::Util.camelize_constantize(params[:klasss])
-      @title = "Feeds from admin_data #{@klass.name}"
-      @description = "feeds from AdminData #{@klass.name}"
-      @records = @klass.find(:all, :order => "#{@klass.primary_key} desc", :limit => 100)
-    rescue NameError => e
-      render :text => "No constant was found with name #{params[:klasss]}" and return
+    def ensure_is_allowed_to_view_feed
+      render :text => 'not authorized' unless is_allowed_to_view_feed?(self)
     end
-  end
 
-  private
+    def is_allowed_to_view_feed?(controller)
+      return true if Rails.env.development?
+
+      if AdminData.config.feed_authentication_user_id.blank?
+        Rails.logger.info 'No user id has been supplied for feed'
+        return false
+      elsif AdminData.config.feed_authentication_password.blank?
+        Rails.logger.info 'No password has been supplied for feed'
+        return false
+      end
+
+      stored_userid = AdminData.config.feed_authentication_user_id
+      stored_password = AdminData.config.feed_authentication_password
+      perform_basic_authentication(stored_userid, stored_password, controller)
+    end
+
+    def perform_basic_authentication(stored_userid, stored_password, controller)
+      controller.authenticate_or_request_with_http_basic do |input_userid, input_password|
+        (input_userid == stored_userid) && (input_password == stored_password)
+      end
+    end
 
-  def ensure_is_allowed_to_view_feed
-    render :text => 'not authorized' unless AdminData::Util.is_allowed_to_view_feed?(self)
   end
 
 end

data/app/controllers/admin_data/home_controller.rb

@@ -0,0 +1,11 @@
+module AdminData
+  class HomeController < ApplicationController
+
+    def index
+      respond_to do |format|
+        format.html
+      end
+    end
+
+  end
+end

data/app/controllers/admin_data/migration_controller.rb

@@ -1,18 +1,18 @@
-class AdminData::MigrationController < AdminData::BaseController
+module AdminData
+  class MigrationController < ApplicationController
 
-  unloadable
+    before_filter :ensure_is_allowed_to_view
 
-  before_filter :ensure_is_allowed_to_view
+    def index
+      @page_title = 'migration information'
+      @data = ActiveRecord::Base.connection.select_all('select * from schema_migrations')
+      respond_to {|format| format.html}
+    end
 
-  def index
-    @page_title = 'migration information'
-    @data = ActiveRecord::Base.connection.select_all('select * from schema_migrations')
-    respond_to {|format| format.html}
-  end
+    def jstest
+      @page_title = 'jstest'
+      respond_to {|format| format.html { render :layout => false}}
+    end
 
-  def jstest
-    @page_title = 'jstest'
-    respond_to {|format| format.html { render :layout => false}}
   end
-
 end