lib/view/helpers/view_helper.rb resources/rdoc/horo.rb @@ -1,2 +1,3 @@ .DS_Store -pkg/* \ No newline at end of file +pkg/* +doc/* \ No newline at end of file .gitignore @@ -1,3 +1,9 @@ +2008-02-25 + * Improved documentation now is online here http://api.lipsiasoft.com + * Refactored text_field, text_area, password_field helpers + * Refactored country_select helper + * Refactored ext_date_select, ext_datetime_select helpers + 2008-02-24 * Rename Js app from Lipsiadmin.app to Backend.app * Added the possibility to reuse pages/froms/grids in windows. @@ -19,7 +25,7 @@ * Added a pdf builder for actionmailer * Added method missing in ActiveRecord to intercept calls to non-localized methods (eg. name instead of name_cz) * Added utility scopes for paginate, include, search - * Added a new literal method for prevent json to "strignify" javascripts funtctions (eg. "function() { alert('me')}".to_lt) + * Added a new literal method for prevent json to "strignify" javascripts funtctions (eg. "function() { alert('me')}".to_l) * Added a new module for escape utf8 chars for servers that don't have java with utf8 fonts (it's used by pdf builder) 2008-05-21 CHANGELOG @@ -1,11 +1,5 @@ -Created by Davide D'Agostino on 2008-01-11. -Copyright 2009 Lipsiasoft s.r.l. All rights reserved. - -Released under the MIT license - ==Lipsiadmin - Lipsiadmin is a new revolutionary admin for your projects. Is developped by http://www.lipsiasoft.com that use it from 2 years in production enviroments. @@ -17,6 +11,11 @@ because the aim of developper wose build in a agile way web/site apps so we use intelligent way a mixin of <tt>old</tt> html and new ajax functions, for example ext manage the layout of page, grids, tree and errors, but form are in html code. +Author:: Davide D'Agostino +Copyright:: Copyright (c) 2009 Lipsiasoft s.r.l. (http://www.lipsiasoft.com) +License:: MIT License (http://www.opensource.org/licenses/mit-license.php) +Api Documentation:: http://api.lipsiasoft.com + ==Requirements Rails 2.0 @@ -24,27 +23,37 @@ Haml 2.0 ==Installation -script/plugin install git://github.com/Lipsiasoft/lipsiadmin.git + script/plugin install git://github.com/Lipsiasoft/lipsiadmin.git The version 2.9 version is an alpha relase and the gem will be aviable from 3.0 +In future you can simply do: + + in config/environments.rb + config.gem "lipsiadmin" + +then (if you don't have it already) + + $ rake gems:install + ==Examples now run script/generate and you can see some like: -Installed Generators - Builtin: controller, integration_test, mailer, migration, model, observer, performance_test, plugin, resource, scaffold, session_migration - Lipsiadmin: attachment, backend, backend_page, pdf - -script/generate backend # Generate the base admin -script/generate backend_page yourmodel # Generate a "scaffold" for your model -script/generate attachment # Generate the an attachments -script/generate pdf PdfName # Generate a new pdf document + Installed Generators + Builtin: controller, integration_test, mailer, migration, model, etc.. + Lipsiadmin: attachment, backend, backend_page, pdf -==Remember +So you can do: -That now Lipsiadmin use your current locale of environment for generate localized pages + $ script/generate backend # Generate the base admin + $ script/generate backend_page yourmodel # Generate a "scaffold" for your model + $ script/generate attachment # Generate the an attachments + $ script/generate pdf PdfName # Generate a new pdf document ==Contribute -Please contribute in coding, patch, and submitting translation. \ No newline at end of file +Please contribute in coding, patch, and submitting translation api documentation etc... + +* Community can be found here:: http://groups.google.com/group/lipsiadmin +* Api documentation can be found here:: http://api.lipsiasoft.com \ No newline at end of file README @@ -19,8 +19,10 @@ desc 'Generate documentation for the lipsiadmin plugin.' Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'doc' rdoc.title = 'Lipsiadmin' - rdoc.options << '--line-numbers' << '--inline-source' - rdoc.rdoc_files.include('README*') + rdoc.options << '--line-numbers' << '--inline-source' << '--accessor' << 'cattr_accessor=object' + rdoc.options << '--charset' << 'utf-8' + rdoc.template = 'resources/rdoc/horo' + rdoc.rdoc_files.include('README', 'CHANGELOG') rdoc.rdoc_files.include('lib/**/*.rb') end @@ -69,6 +71,11 @@ task :gemspec do end end +desc "Publish the API documentation" +task :pdoc => [:rdoc] do + Rake::SshDirPublisher.new("root@server1.lipsiasoft.com", "/var/www/apps/lipsiadmin/rdoc", "doc").upload +end + desc "Publish the release files to RubyForge." task :release => [ :package ] do require 'rubyforge' Rakefile @@ -3,23 +3,42 @@ module Lipsiadmin # This provide a simple login for backend and frontend. # Use backend_login_required in backend and # frontend_login_requirded in frontend. + # + # Examples: + # + # class FrontendController < ApplicationController + # before_filter :login_frontend_required, :except => [:login] + # end + # module Authentication protected + + # Returns true if <tt>current_account</tt> is logged and active. def logged_in? current_account != :false && current_account.active? end - + + # Returns the current_account, it's an instance of <tt>Account</tt> model def current_account @current_account ||= (login_from_session || :false) end - + + # Ovverride the current_account, you must provide an instance of Account Model + # + # Examples: + # + # current_account = Account.last + # def current_account=(new_account) session[:account] = (new_account.nil? || new_account.is_a?(Symbol)) ? nil : new_account.id @current_account = new_account end + # Returns true if the <tt>current_account</tt> is allowed to see the requested + # controller/action. + # + # For configure this role please refer to: <tt>Lipsiadmin::AccessControl::Base</tt> def allowed? - allowed = current_account.maps.collect(&:allowed)[0] denied = current_account.maps.collect(&:denied)[0] @@ -36,15 +55,26 @@ module Lipsiadmin return allow && !deny end + # Returns a helper to pass in a <tt>before_filter</tt> for check if + # an account are: <tt>logged_in?</tt> and <tt>allowed?</tt> + # + # By default this method is used in BackendController so is not necessary def backend_login_required logged_in? && allowed? || access_denied(:backend) end - + + # Returns a helper to pass in a <tt>before_filter</tt> for check if + # an account are: <tt>logged_in?</tt> and <tt>allowed?</tt> + # + # Examples: + # + # before_filter :login_frontend_required, :except => [:login] + # def fronted_login_required logged_in? && allowed? || access_denied(:backend) end - def access_denied(where) + def access_denied(where)#:nodoc: respond_to do |format| format.html { redirect_to :controller => "#{where}/sessions", :action => :new } format.js { render(:update) { |page| page.alert "You don't allowed to access to this javascript" } } @@ -52,20 +82,22 @@ module Lipsiadmin false end - def store_location + def store_location#:nodoc: session[:return_to] = request.request_uri end - + + # Redirect the account to the page that requested an authentication or + # if the account is not allowed/logged return it to a default page def redirect_back_or_default(default) redirect_to(session[:return_to] || default) session[:return_to] = nil end - def self.included(base) + def self.included(base)#:nodoc: base.send :helper_method, :current_account, :logged_in? end - def login_from_session + def login_from_session#:nodoc: self.current_account = Account.find_by_id(session[:account]) if session[:account] end end # Module Authentication lib/access_control/authentication.rb @@ -95,22 +95,22 @@ module Lipsiadmin @project_modules << ProjectModule.new(name, controller, &block) end - # Globally but for current role allow an action + # Globally allow an action of a controller for the current role def allow_action(path) @allowed << recognize_path(path) end - # Globally but for current role deny an action + # Globally deny an action of a controllerfor the current role def deny_action(path) @denied << recognize_path(path) end - # Globally but for current role allow an action + # Globally allow all actions from a controller for the current role def allow_all_actions(path) @allowed << { :controller => recognize_path(path)[:controller] } end - # Globally but for current role deny an action + # Globally denty all actions from a controller for the current role def deny_all_actions(path) @denied << { :controller => recognize_path(path)[:controller] } end @@ -144,6 +144,7 @@ module Lipsiadmin yield self end + # Build a new menu and automaitcally add the action on the allowed actions. def menu(name, path=nil, options={}, &block) @menus << Menu.new(name, path, options, &block) end @@ -220,6 +221,7 @@ module Lipsiadmin end end - class AccessControlError < StandardError; end; + class AccessControlError < StandardError#:nodoc: + end end end \ No newline at end of file lib/access_control/base.rb @@ -1,10 +1,10 @@ module Lipsiadmin#:nodoc: module Controller#:nodoc: - # Base Backend Controller that defined: + # Base Backend Controller that define: # - # layout false - # before_filter :backend_login_required - # helper Lipsiadmin::View::Helpers::BackendHelper + # layout false + # before_filter :backend_login_required + # helper Lipsiadmin::View::Helpers::BackendHelper # class Base < ActionController::Base def self.inherited(subclass)#:nodoc: lib/controller/lipsiadmin_controller.rb @@ -1,6 +1,19 @@ module Lipsiadmin module Controller - # This module convert a string/controller to + # This module convert a string/controller to a pdf through Pd4ml java library (included in this plugin) + # + # For generate a pdf you can simply do + # + # script/generate pdf invoice + # + # then edit your template /app/views/pdf/invoice.html.haml + # + # Then in any of your controllers add some like this: + # + # def generate_pdf_invoice + # render_pdf :invoice, 'invoice_file.pdf' + # end + # module PdfBuilder include Lipsiadmin::Utils::HtmlEntities @@ -34,7 +47,8 @@ module Lipsiadmin end # Errors For PDF - class PdfError < StandardError; end + class PdfError < StandardError#:nodoc: + end end end end \ No newline at end of file lib/controller/pdf_builder.rb @@ -1,8 +1,11 @@ module Lipsiadmin module Controller # This module are raised when an exception fire up in controllers. - # Now you can personalize exception and simplify the layout using templates - # in app/views/exception + # + # Now you can personalize exception and simplify the layout using templates in: + # + # app/views/exception + # # when an exception is raised it try to send an email, and for send an email # you need to configure in enviroment or in an initializer some like this: # @@ -14,7 +17,7 @@ module Lipsiadmin # module Rescue - def self.included(base) + def self.included(base)#:nodoc: base.class_eval do alias_method_chain :rescue_action_in_public, :notifier end lib/controller/rescue.rb @@ -1,6 +1,7 @@ module Lipsiadmin module Controller # Executes the response body as JavaScript in the context of the parent window. + # # Use this method of you are posting a form to a hidden IFRAME or if you would like # to use IFRAME base RPC. module RespondsToParent lib/controller/responds_to_parent.rb @@ -1,24 +1,3 @@ -# Attachment allows file attachments that are stored in the filesystem. All graphical -# transformations are done using the Graphics/ImageMagick command line utilities and -# are stored in Tempfiles until the record is saved. Attachment does not require a -# separate model for storing the attachment's information, instead adding a few simple -# columns to your table. -# -# Author:: Jon Yurek -# Copyright:: Copyright (c) 2008 thoughtbot, inc. -# License:: MIT License (http://www.opensource.org/licenses/mit-license.php) -# -# Attachment defines an attachment as any file, though it makes special considerations -# for image files. You can declare that a model has an attached file with the -# +has_one_attachment+ method: -# -# class User < ActiveRecord::Base -# has_one_attachment -# or -# has_many_attachments -# end -# -# See the +has_one_attachment+ or +has_many_attachments+ documentation for more details. require 'tempfile' require 'data_base/attachment/upfile' require 'data_base/attachment/iostream' @@ -36,18 +15,30 @@ end module Lipsiadmin module DataBase - # The base module that gets included in ActiveRecord::Base. See the - # documentation for Attachment::ClassMethods for more useful information. module Attachment - class << self + class << self#:nodoc: def included(base) #:nodoc: base.extend(ClassMethods) end end module ClassMethods - + + # Attach a single file/image to your model. + # + # Examples: + # + # has_one_attachment :image + # attachment_styles_for :image, :normal, "128x128!" + # validates_attachment_presence_for :image + # validates_attachment_size_for :image, :greater_than => 10.megabytes + # validates_attachment_content_type_for :image, "image/png" + # + # Then in your form (with multipart) you can simply add: + # + # =file_field :mymodel, :image_attributes + # def has_one_attachment(name, options={}) options[:as] ||= :attacher options[:class_name] ||= "Attachment" @@ -88,6 +79,21 @@ module Lipsiadmin end end + # Attach a many files/images to your model. + # + # Examples: + # + # has_one_attachment :images + # attachment_styles_for :images, :normal, "128x128!" + # validates_attachment_presence_for :images + # validates_attachment_size_for :images, :greater_than => 10.megabytes + # validates_attachment_content_type_for :images, "image/png" + # + # Then in your form (with multipart) you can simply add: + # + # =fields_for "yourmodel[attachments_attributes][]", @yourmodel.images.build do |image| + # =image.file_field :file + # def has_many_attachments(name, options = {}) options[:as] ||= :attacher options[:class_name] ||= "Attachment" lib/data_base/attachment.rb @@ -1,4 +1,33 @@ module Lipsiadmin + # Attachment allows file attachments that are stored in the filesystem. All graphical + # transformations are done using the Graphics/ImageMagick command line utilities and + # are stored in Tempfiles until the record is saved. Attachment does not require a + # separate model for storing the attachment's information, instead adding a few simple + # columns to your table. + # + # Author:: Jon Yurek + # Copyright:: Copyright (c) 2008 thoughtbot, inc. + # License:: MIT License (http://www.opensource.org/licenses/mit-license.php) + # + # Attachment defines an attachment as any file, though it makes special considerations + # for image files. You can declare that a model has an attached file with the + # +has_one_attachment+ method: + # + # From your console: + # script/generate attachment + # + # Then in any model you can do: + # + # class User < ActiveRecord::Base + # has_many_attachments :attachments, :dependent => :destroy + # has_one_attachment :image + # attachment_styles_for :attachments, :normal, "128x128!" + # validates_attachment_presence_for :attachments + # validates_attachment_size_for :attachments, :greater_than => 10.megabytes + # validates_attachment_content_type_for :attachments, "image/png" + # end + # + # See the <tt>Lipsiadmin::DataBase::Attachment::ClassMethods</tt> documentation for more details. module Attachment class << self @@ -30,7 +59,7 @@ module Lipsiadmin processor end - def interpolates(key, &block) + def interpolates(key, &block) #:nodoc: Lipsiadmin::Attachment.interpolations[key] = block end @@ -418,12 +447,12 @@ module Lipsiadmin end end - def fire_events(which) + def fire_events(which) #:nodoc: return true if callback(:"#{which}_post_process") == false return true if callback(:"#{which}_#{name}_post_process") == false end - def post_process_styles + def post_process_styles #:nodoc: log("Post-processing #{name}") @styles.each do |name, args| begin lib/data_base/attachment/attach.rb @@ -1,50 +1,54 @@ -# Provides method that can be included on File-type objects (IO, StringIO, Tempfile, etc) to allow stream copying -# and Tempfile conversion. -module IOStream +module Lipsiadmin + module Attachment + # Provides method that can be included on File-type objects (IO, StringIO, Tempfile, etc) to allow stream copying + # and Tempfile conversion. + module IOStream - # Returns a Tempfile containing the contents of the readable object. - def to_tempfile - tempfile = Tempfile.new("stream") - tempfile.binmode - self.stream_to(tempfile) - end + # Returns a Tempfile containing the contents of the readable object. + def to_tempfile + tempfile = Tempfile.new("stream") + tempfile.binmode + self.stream_to(tempfile) + end - # Copies one read-able object from one place to another in blocks, obviating the need to load - # the whole thing into memory. Defaults to 8k blocks. If this module is included in both - # StringIO and Tempfile, then either can have its data copied anywhere else without typing - # worries or memory overhead worries. Returns a File if a String is passed in as the destination - # and returns the IO or Tempfile as passed in if one is sent as the destination. - def stream_to(path_or_file, in_blocks_of = 8192) - dstio = case path_or_file - when String then File.new(path_or_file, "wb+") - when IO then path_or_file - when Tempfile then path_or_file - end - buffer = "" - self.rewind - while self.read(in_blocks_of, buffer) do - dstio.write(buffer) + # Copies one read-able object from one place to another in blocks, obviating the need to load + # the whole thing into memory. Defaults to 8k blocks. If this module is included in both + # StringIO and Tempfile, then either can have its data copied anywhere else without typing + # worries or memory overhead worries. Returns a File if a String is passed in as the destination + # and returns the IO or Tempfile as passed in if one is sent as the destination. + def stream_to(path_or_file, in_blocks_of = 8192) + dstio = case path_or_file + when String then File.new(path_or_file, "wb+") + when IO then path_or_file + when Tempfile then path_or_file + end + buffer = "" + self.rewind + while self.read(in_blocks_of, buffer) do + dstio.write(buffer) + end + dstio.rewind + dstio + end end - dstio.rewind - dstio end end class IO #:nodoc: - include IOStream + include Lipsiadmin::Attachment::IOStream end %w( Tempfile StringIO ).each do |klass| if Object.const_defined? klass Object.const_get(klass).class_eval do - include IOStream + include Lipsiadmin::Attachment::IOStream end end end # Corrects a bug in Windows when asking for Tempfile size. if defined? Tempfile - class Tempfile + class Tempfile#:nodoc: def size if @tmpfile @tmpfile.fsync lib/data_base/attachment/iostream.rb @@ -32,7 +32,7 @@ module Lipsiadmin end if defined? StringIO - class StringIO + class StringIO#:nodoc: attr_accessor :original_filename, :content_type def original_filename @original_filename ||= "stringio.txt" lib/data_base/attachment/upfile.rb @@ -1,8 +1,19 @@ module Lipsiadmin module DataBase + # This is the table that handle the attachments. + # You can define some global info like: + # + # attachment_styles :thumb, "128x128" + # + # In this way all models that use <tt>has_one_attachment</tt> or + # <tt>has_many_attachments</tt> handle a default style called *thumb* + # + # Remember that any model that use <tt>has_one_attachment</tt> or + # <tt>has_many_attachments</tt> can override/add styles/validations etc... + # class AttachmentTable < ActiveRecord::Base - def self.inherited(subclass) + def self.inherited(subclass)#:nodoc: super subclass.write_inheritable_attribute(:attachment_definitions, {}) if subclass.attachment_definitions.nil? subclass.attachment_definitions[subclass.name] = {:validations => {}}.merge(Lipsiadmin::Attachment.options) @@ -19,28 +30,32 @@ module Lipsiadmin #validates_presence_of :filename + # Returns the url of the attachment, optionally you can pass the style like url(:thumb) def url(style=nil) file.to_s(style) end - + + # Returns a <tt>Lipsiadmin::Attachment::Attach</tt> instance def file @_file ||= Lipsiadmin::Attachment::Attach.new(:attached, self, attachment_definitions) end - + + # Assign a <tt>Lipsiadmin::Attachment::Attach</tt> instance to the current file def file=(tempfile) file.assign(tempfile) end - + + # Returns true if the file exist def file? file.exist? end - def attachment_definitions=(options) + def attachment_definitions=(options)#:nodoc: attachment_definitions.merge!(options.symbolize_keys) end # This is the custom instance attachment_definition - def attachment_definitions + def attachment_definitions#:nodoc: @instance_attachment_definitions ||= self.class.attachment_definitions[self.class.name].clone return @instance_attachment_definitions end @@ -49,12 +64,14 @@ module Lipsiadmin attachment = record.file attachment.send(:flush_errors) unless attachment.valid? end - + + # Perform <tt>file</tt>.save def save_attached_files logger.info("[Attachment] Saving attachments.") file.save end - + + # Perform <tt>file</tt>.destroy def destroy_attached_files logger.info("[Attachment] Deleting attachments.") file.queue_existing_for_delete @@ -62,7 +79,7 @@ module Lipsiadmin end end - module ClassMethods + module ClassMethods#:nodoc: def attachment_url(url) attachment_attachment_url_for(self.name, url) @@ -112,7 +129,6 @@ module Lipsiadmin validates_attachment_thumbnails_for(self.name, options) end - # Places ActiveRecord-style validations on the presence of a file. def validates_attachment_presence(options = {}) validates_attachment_presence_for(self.name, options) end lib/data_base/attachment_table.rb @@ -1,5 +1,23 @@ module Lipsiadmin module DataBase + # With this method we can translate define and automatically translate columns for + # the current rails locale. + # + # Defining some columns like these: + # + # m.col :string, :name_it, :name_en, :name_cz + # m.col :text, :description_it, :description_en, :description_cz + # + # we can call + # + # myinstance.name + # + # or + # + # puts myinstance.description + # + # Lipsiadmin look for name_#{I18n.locale} + # module TranslateAttributes # Define <tt>method missing</tt> to intercept calls to non-localized methods (eg. +name+ instead of +name_cz+) def method_missing(method_name, *arguments) lib/data_base/translate_attributes.rb @@ -1,27 +1,56 @@ module Lipsiadmin module DataBase + # This class create a *fake* table that can be usefull if you need for example + # perform validations. Take a look to this test case: + # + # Examples: + # + # class Contact < Lipsiadmin::DataBase::WithoutTable + # column :name, :string + # column :company, :string + # column :telephone, :string + # column :email, :string + # column :message, :text + # + # validates_presence_of :name, :message + # validates_format_of :email, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i + # end + # + # Now we need to validate a contact, and if the validations is okey send an email or if not raise errors + # + # @contact = Contact.new(params[:contact]) + # if @contact.valid? + # Notifier.deliver_support_request(@contact) + # else + # flash[:notice] = "There are some problems" + # render :action => :support_request + # end + # class WithoutTable < ActiveRecord::Base self.abstract_class = true - def create_or_update + def create_or_update#:nodoc: errors.empty? end class << self - def inherited(klass) + def inherited(klass)#:nodoc: columns_hash.each do |name, column| klass.columns << column unless klass.column_names.include(name) end end - + + # Returns columns for this *fake* table def columns() @columns ||= [] end - + + # Define columns for a this *fake* table def column(name, sql_type = nil, default = nil, null = true) columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null) reset_column_information end + # Resets all the cached information about columns, which will cause them to be reloaded on the next request. def reset_column_information generated_methods.each { |name| undef_method(name) } lib/data_base/without_table.rb @@ -6,10 +6,8 @@ require 'mailer/pdf_builder' require 'mailer/exception_notifier' require 'view/helpers/active_record_helper' require 'view/helpers/backend_helper' -require 'view/helpers/country_select_helper' -require 'view/helpers/date_helper' +require 'view/helpers/view_helper' require 'view/helpers/ext_helper' -require 'view/helpers/tag_helper' require 'controller/ext' require 'controller/pdf_builder' require 'controller/responds_to_parent' @@ -37,9 +35,14 @@ ActiveRecord::Base.class_eval do end ActionView::Base.class_eval do - include Lipsiadmin::View::Helpers::TagHelper + include Lipsiadmin::View::Helpers::FormHelper + include Lipsiadmin::View::Helpers::FormTagHelper + include Lipsiadmin::View::Helpers::DateHelper + include Lipsiadmin::View::Helpers::CountrySelectHelper end +ActionView::Helpers::FormBuilder.send(:include, Lipsiadmin::View::Helpers::FormBuilder) + ActionView::Helpers::PrototypeHelper::JavaScriptGenerator::GeneratorMethods.class_eval do include Lipsiadmin::View::Helpers::ExtHelper end lib/lipsiadmin.rb @@ -1,5 +1,7 @@ module Lipsiadmin module Mailer + # This class send notification through mail if an exception + # occour in a controller. class ExceptionNotifier < ActionMailer::Base @@sender_address = %("Exception Notifier" <exception.notifier@default.com>) @@ -17,8 +19,11 @@ module Lipsiadmin self.mailer_name = "exception" self.template_root = "#{File.dirname(__FILE__)}" - def self.reloadable?() false end - + def self.reloadable?#:nodoc: + false + end + + # This method deliver the exception for the given controller and request def exception(exception, controller, request) content_type "text/plain" lib/mailer/exception_notifier.rb @@ -1,11 +1,36 @@ module Lipsiadmin module Mailer + # This module convert a string/controller to a pdf through Pd4ml java library (included in this plugin) + # + # For generate a pdf you can simply do + # + # script/generate pdf invoice + # + # then edit your template /app/views/pdf/invoice.html.haml + # + # Then in any of your mailers add some like this: + # + # def order_invoiced(order) + # recipients my@mail.com + # from my@server.com + # subject Your Invoice + # + # attachment "application/pdf" do |a| + # a.body = render_pdf(:invoice, :invoice => order.invoice, :other => order.invoice.other) + # end + # + # part "text/plain" do |a| + # a.body = render_message("order_invoiced", :order => order, :body_template => @body_template) + # end + # end + # module PdfBuilder include Lipsiadmin::Utils::HtmlEntities # Path to the pd4ml jarfile JARPATH = "../../resources" + # Convert a stream to pdf, the template must be located in app/view/pdf/yourtemplate.pdf.erb def render_pdf(template, body) # set the landescape landescape = (body[:landescape].delete || false) @@ -35,6 +60,7 @@ module Lipsiadmin end # Errors For PDF - class PdfError < StandardError; end + class PdfError < StandardError#:nodoc: + end end end \ No newline at end of file lib/mailer/pdf_builder.rb @@ -1,5 +1,12 @@ module Lipsiadmin module Utils + # Returns an object whose to_json evaluates to code. + # Use this to pass a literal JavaScript expression as an argument to another JavaScriptGenerator method. + # + # Examples: + # + # "function() { alert('test') }".to_l + # module Literal # Returns an object whose <tt>to_json</tt> evaluates to +code+. Use this to pass a literal JavaScript # expression as an argument to another JavaScriptGenerator method. lib/utils/literal.rb @@ -2,6 +2,7 @@ module Lipsiadmin module View module Helpers module BackendHelper + # This method work like builtin Rails error_message_for but use an Ext.Message. def simple_error_messages_for(*params) options = params.last.is_a?(Hash) ? params.pop.symbolize_keys : {} objects = params.collect {|object_name| instance_variable_get("@#{object_name}") }.compact @@ -18,38 +19,71 @@ module Lipsiadmin '' end end - + + # This method add tab for in your view def tab(name, padding=true, options={}, &block) options[:style] = "padding:10px;#{options[:style]}" if padding options[:id] ||= name.to_s.downcase.gsub(/[^a-z0-9]+/, '_').gsub(/-+$/, '').gsub(/^-+$/, '') concat content_tag(:div, capture(&block), { :id => options[:id], :class => "x-hide-display", :style => options[:style], :tabbed => true, :title => name }) end + # Set the title of the page def title(title) content_tag(:script, "Backend.app.setTitle(#{title.to_json})", :type => Mime::JS) end + # Store the location to come back from for example an extjs grid def back_to(location) content_tag(:script, "Backend.app.backTo(#{url_for(location)})", :type => Mime::JS) end + # Generate the menu from the Lispiadmin::AccessControl def backend_menu config = current_account.maps.collect(&:project_modules)[0].collect(&:config) config << { :text => "Backend.locale.buttons.help".to_l, :handler => "function() { Backend.app.openHelp() }".to_l } return config.to_json end + + # Open a new windows that can contain a form that you can reuse + # + # Example: + # + # # in app/views/dossiers/_form.html.haml + # %tr + # %td{:style=>"width:100px"} + # %b Customer: + # %td + # %span{:id => :account_name}=@dossier.account ? @dossier.account.full_name : "None" + # =hidden_field :dossier, :account_id + # =open_window "/backend/accounts.js", :id, :name, :dossier_account_id, :account_name + # def open_window(url, value, display, render_value_to, render_display_to) link_to_function(image_tag("backend/new.gif", :style=>"vertical-align:bottom"), "Backend.window.open({url:'#{url}', display:'#{display}', value:'#{value}', displayField:'#{render_display_to}', valueField:'#{render_value_to}'})") end - + + # This method call a remote_function and in the same time do a + # + # Backend.app.mask() + # + # and when the function is complete + # + # Backend.app.unmask() + # def link_to_remote_with_wait(name, options={}, html_options={}) options[:complete] = "Backend.app.unmask();" options[:before] = "Backend.app.mask('#{I18n.t('backend.messages.wait.message')}')"; link_to_function(name, remote_function(options), html_options || options.delete(:html)) end - + + # This method generates a new ExtJs BoxComponent. + # + # Examples: + # + # =box "My Title", "My Subtitle", :submit => true, :collapsible => true do + # my content + # def box(title=nil, subtitle=nil, options={}, &block) return <<-HTML <div class="x-box" style="width:99%"> lib/view/helpers/backend_helper.rb @@ -6,7 +6,7 @@ module Lipsiadmin#:nodoc: # This is the base class of ext components class Component - def initialize(options={}, &block) + def initialize(options={}, &block)#:nodoc: @config = Configuration.new(options) @before, @after = [], [] if block_given? @@ -58,26 +58,26 @@ module Lipsiadmin#:nodoc: end end - # Return the array JavaScript to add before component. + # Returns an array of javascripts to add before component is rendered. # def before @before end - # Return the raw JavaScript to add before component. - # + # Returns the javascript to add before component is rendered. + # def before_js @before.uniq.compact.join("\n\n") + "\n\n" end - # Return the array JavaScript to add after component. - # + # Returns an array of javascripts to add afters component is rendered. + # def after @after end - # Return the raw JavaScript to add after component. - # + # Returns the javascript to add after component is rendered. + # def after_js "\n\n" + @after.uniq.compact.join("\n\n") end lib/view/helpers/ext/component.rb @@ -1,15 +1,17 @@ module Lipsiadmin module Ext - # Ext configuration of used by components + # Ext configuration used by components # # Generates: { name: 'name', handler: function(){ alert('Hello World') } } # class Configuration < Hash - def initialize(hash) + def initialize(hash)#:nodoc: hash.each { |k,v| self[k] = v } end + # Returns the configuration as a string. + # Optionally you can specify the indentation spaces. def to_s(indent=1) i = (" "*indent) s = self.size > 0 ? "\n" : " " lib/view/helpers/ext/configuration.rb @@ -1,7 +1,26 @@ module Lipsiadmin module Ext - - # Generate a new Ext.grid.GridPanel + # Generate a full customizable Ext.GridPanel + # + # Examples: + # + # page.grid do |grid| + # grid.id "grid-posts" + # grid.title "List all Post" + # grid.base_path "/backend/posts" + # grid.forgery_protection_token request_forgery_protection_token + # grid.authenticity_token form_authenticity_token + # grid.tbar :default + # grid.store do |store| + # store.url "/backend/posts.json" + # store.fields @column_store.store_fields + # end + # grid.columns do |columns| + # columns.fields @column_store.column_fields + # end + # grid.bbar :store => grid.get_store, :pageSize => params[:limit] + # end + # class Grid < Component def initialize(options={}, &block)#:nodoc: # Call Super Class for initialize configuration @@ -18,6 +37,17 @@ module Lipsiadmin view :default if config[:view].blank? end + # Define the selection model of this grid. + # You can pass: + # + # * :checkbox + # * :default (alias for checkbox) + # * :row + # + # It generate some like: + # + # new Ext.grid.CheckboxSelectionModel() + # def sm(value) case value when :checkbox || :default @@ -29,14 +59,17 @@ module Lipsiadmin end end + # Define the title of the grid def title(title) before << "Backend.app.setTitle(#{title.to_json});" end + # Assign plugins for the current grid def plugins(plugins) config[:plugins] = plugins end - + + # Add a single plugin to the grid plugins def add_plugin(plugins) config[:plugins] << plugins end lib/view/helpers/ext/grid.rb @@ -13,7 +13,7 @@ module Lipsiadmin # Module containing the methods useful for ext/prototype module ExtHelper - def self.included(base) + def self.included(base)#:nodoc: base.class_eval do alias_method_chain :to_s, :refactoring end @@ -104,85 +104,27 @@ module Lipsiadmin end end - # Generate a full customizable Ext.Grid + # Generate a full customizable Ext.GridPanel # # Examples: # # page.grid do |grid| - # - # #Some standard config - # grid.title "List of all Account" - # grid.selection :checkbox - # - # # TopBar & Buttons - # grid.ttbar do |bar| - # bar.add "Add", :handler => grid.l("Backend.app.loadHtml('/backend/accounts/new')"), :icon => "...", :other => "..." - # bar.add "Edit", :handler => grid.l("Backend.app.loadHtml('/backend/accounts/'+accounts_grid.getSelected().id+'/edit')"), :other => "..." - # bar.add "Print" do |submenu| - # submenu.add "Print Invoice", :foo => "..." - # submenu.add "Print Account", :bar => "..." - # end - # end - # - # or simply: - # - # grid.ttbar :default do |ttbar| - # ttbar.path "/backend/accounts" - # ttbar.forgery_protection_token request_forgery_protection_token - # ttbar.authenticity_token form_authenticity_token - # end - # - # # Columns - # grid.columns do |col| - # col.add "Name", "accounts.name", :searchable => false, :sortable => true - # col.add "Category Name", "accounts.category.name", :sortable => :false - # col.add "Created At", "accounts.created_at", :type => "date", :format => "c", :renderer => Ext.call("Ext.Util.DateRenderer", "m/d/y") + # grid.id "grid-posts" + # grid.title "List all Post" + # grid.base_path "/backend/posts" + # grid.forgery_protection_token request_forgery_protection_token + # grid.authenticity_token form_authenticity_token + # grid.tbar :default + # grid.store do |store| + # store.url "/backend/posts.json" + # store.fields @column_store.store_fields # end - # - # # alternative you can simply do - # # - # # grid.columns :defaults, Account - # # and they add all columns of Account Model. - # # - # # or - # # - # # grid.coumns :default do |col| - # # col.add "Projects", "accounts.projects.collect(&:name).join(", ")", :searchable => false, :sortable => true - # # col.add "Category Name", "accounts.category.name", :sortable => :false - # # ... - # # end - # # In this way add other than accounts columns "Projects" and "Category Name"! - # - # # Extra Examples - # # - # # Render: - # # - # # grid.on('dblclick', function(){ - # # Ext.Msg.alert('Title', 'Content'); - # # }); - # # - # - # grid.on "dblclick" do - # Ext.call("Ext.Msg.alert", "Title", "Content") - # end - # - # grid.on "dblclick" do - # Ext.call "Ext.Msg.alert", "Selected the row", "with name: #{Ext.grid.selected.name}" - # end - # - # grid.columns.first.on("dblclick") do - # Ext.call("Ext.Msg.alert", "Some", "One") + # grid.columns do |columns| + # columns.fields @column_store.column_fields # end - # - # button = grid.buttons.get_by(:title, "Add") - # button = grid.buttons.get_by(:id, "add") - # col = grid.columns.get_by(:id, "category_name") - # - # button.on("dblclick", Ext.fn("Ext.Msg.alert", "Hello World")) - # - # grid.append "/backend/accounts/grid_fn.js" # or :controller => :accounts, :action => :grid_fn, :format => :js + # grid.bbar :store => grid.get_store, :pageSize => params[:limit] # end - # + # def grid(&block) self << Lipsiadmin::Ext::Grid.new(&block) end lib/view/helpers/ext_helper.rb @@ -1,6 +1,5 @@ page.grid do |grid| grid.id "grid-accounts" - grid.var :finocchio grid.title "Elenco Accounts" grid.base_path "/backend/accounts" grid.forgery_protection_token request_forgery_protection_token lipsiadmin_generators/backend/templates/views/backend/accounts/index.rjs @@ -1,6 +1,5 @@ page.grid do |grid| grid.id "grid-<%= plural_name %>" - grid.var :finocchio grid.title "List all <%= model_instance.class.human_name %>" grid.base_path "/backend/<%= plural_name %>" grid.forgery_protection_token request_forgery_protection_token lipsiadmin_generators/backend_page/templates/view_index.rjs.erb lib/view/helpers/country_select_helper.rb lib/view/helpers/date_helper.rb lib/view/helpers/tag_helper.rb 053e263e50529bfd6b085b036f6c755fabc5d11e Davide D'Agostino DAddYE@DAddYE.local http://github.com/Lipsiasoft/lipsiadmin/commit/56ef3d85d9652cee95266421c4f4103c9d8f5602 56ef3d85d9652cee95266421c4f4103c9d8f5602 2009-02-25T07:47:03-08:00 2009-02-25T07:47:03-08:00 Improved documentation now is online here http://api.lipsiasoft.com Refactored text_field, text_area, password_field helpers Refactored country_select helper Refactored ext_date_select, ext_datetime_select helpers 42a38a274026c21606a748290d078b09e9a21d55 Davide D'Agostino DAddYE@DAddYE.local