typus 0.9.39 → 1.0.0.pre

data/lib/typus.rb

@@ -1,125 +1,163 @@
 # coding: utf-8
 
+require "support/active_record"
+require "support/array"
+require "support/hash"
+require "support/object"
+require "support/string"
+require "typus/engine"
+require "typus/configuration"
+require "typus/resources"
+require "typus/orm/active_record"
+require "typus/user"
+require "vendor/paginator"
+
 module Typus
 
+  # Define the application name.
+  mattr_accessor :admin_title
+  @@admin_title = "Typus"
+
+  # Define a subtitle
+  mattr_accessor :admin_sub_title
+  @@admin_sub_title = <<-CODE
+<a href="http://core.typuscms.com/">typus</a> by <a href="http://intraducibles.com">intraducibles.com</a>
+  CODE
+
+  # Authentication mechanism: none, basic, advanced
+  mattr_accessor :authentication
+  @@authentication = :none
+
+  # Define the configuration folder.
+  mattr_accessor :config_folder
+  @@config_folder = "config/typus"
+
+  # Define the username
+  mattr_accessor :username
+  @@username = "admin"
+
+  # Define the password: Used as a default password and for the http
+  # authentication.
+  mattr_accessor :password
+  @@password = "columbia"
+
+  # Configure the e-mail address which will be shown in Admin::Mailer.
+  mattr_accessor :mailer_sender
+  @@mailer_sender = nil
+
+  # Define the file preview.
+  mattr_accessor :file_preview
+  @@file_preview = :medium
+
+  # Define the file thumbnail.
+  mattr_accessor :file_thumbnail
+  @@file_thumbnail = :thumb
+
+  # Defines the default relationship table.
+  mattr_accessor :relationship
+  @@relationship = "typus_users"
+
+  # Defines the default master role.
+  mattr_accessor :master_role
+  @@master_role = "admin"
+
+  # Defines the default user_class_name.
+  mattr_accessor :user_class_name
+  @@user_class_name = "TypusUser"
+
+  # Defines the default user_fk.
+  mattr_accessor :user_fk
+  @@user_fk = "typus_user_id"
+
+  mattr_accessor :available_locales
+  @@available_locales = [:en]
+
   class << self
 
-    def version
-      @@version ||= File.read("#{root}/VERSION").strip
+    # Default way to setup typus. Run rails generate typus to create
+    # a fresh initializer with all configuration values.
+    def setup
+      yield self
     end
 
     def root
-      File.dirname(__FILE__) + '/../'
-    end
-
-    def locales
-      [ [ "German", 'de' ],
-        [ "English", 'en' ], 
-        [ "Español", 'es' ],
-        [ "Français", 'fr' ],
-        [ "Portuguese", 'pt-BR' ], 
-        [ "Russian", 'ru' ] ]
+      (File.dirname(__FILE__) + "/../").chomp("/lib/../")
     end
 
     def applications
-      Typus::Configuration.config.collect { |i| i.last['application'] }.compact.uniq.sort
+      Typus::Configuration.config.collect { |i| i.last["application"] }.compact.uniq.sort
     end
 
-    # List of the modules of an application.
+    # Lists modules of an application.
     def application(name)
-      Typus::Configuration.config.collect { |i| i.first if i.last['application'] == name }.compact.uniq.sort
+      Typus::Configuration.config.collect { |i| i.first if i.last["application"] == name }.compact.uniq.sort
     end
 
-    ##
-    # Gets a list of all the models on the configuration file.
-    #
+    # Lists models from the configuration file.
     def models
       Typus::Configuration.config.map { |i| i.first }.sort
     end
 
-    def models_on_header
-      models.collect { |m| m if m.constantize.typus_options_for(:on_header) }.compact
-    end
-
-    ##
-    # List of resources, which are tableless models.
-    #
+    # Lists resources, which are tableless models.
     def resources
       Typus::Configuration.roles.keys.map do |key|
         Typus::Configuration.roles[key].keys
       end.flatten.sort.uniq.delete_if { |x| models.include?(x) }
     end
 
-    ##
-    # Gets a list of models under app/models
-    #
-    def discover_models
-      all_models = []
-      Dir.chdir(File.join(Rails.root, 'app/models')) do
-        Dir['**/*.rb'].each do |m|
-          class_name = m.sub(/\.rb$/,'').camelize
-          klass = class_name.split('::').inject(Object){ |klass,part| klass.const_get(part) }
-          all_models << "#{class_name}" if klass < ActiveRecord::Base && !klass.abstract_class?
-        end
+    # Lists models under <tt>app/models</tt>.
+    def detect_application_models
+      model_dir = Rails.root.join("app/models")
+      Dir.chdir(model_dir) do
+        models = Dir["**/*.rb"]
       end
-      return all_models
     end
 
-    def user_class
-      Typus::Configuration.options[:user_class_name].constantize
+    def locales
+      human = available_locales.map { |i| locales_mapping[i.to_s] }
+      available_locales.map { |i| i.to_s }.to_hash_with(human)
     end
 
-    def user_fk
-      Typus::Configuration.options[:user_fk]
+    def locales_mapping
+      mapping = { "ca"    => "Català",
+                  "de"    => "German",
+                  "en"    => "English",
+                  "es"    => "Español",
+                  "fr"    => "Français",
+                  "hu"    => "Magyar",
+                  "pt-BR" => "Portuguese",
+                  "ru"    => "Russian",
+                  "it"    => "Italiano" }
+      mapping.default = "Unknown"
+      return mapping
     end
 
-    def relationship
-      Typus::Configuration.options[:relationship]
+    def detect_locales
+      available_locales.each do |locale|
+        I18n.load_path += Dir[File.join(Typus.root, "config", "available_locales", "#{locale}*")]
+      end
     end
 
-    def testing?
-      Rails.env.test? && Dir.pwd == "#{Rails.root}/vendor/plugins/typus"
+    def application_models
+      detect_application_models.map do |model|
+        class_name = model.sub(/\.rb$/,"").camelize
+        klass = class_name.split("::").inject(Object) { |klass,part| klass.const_get(part) }
+        class_name if klass < ActiveRecord::Base && !klass.abstract_class?
+      end.compact
     end
 
-    def plugin?
-      File.directory?("#{Rails.root}/vendor/plugins/typus")
+    def user_class
+      user_class_name.constantize
     end
 
-    def boot!
-
-      if testing?
-        Typus::Configuration.options[:config_folder] = 'vendor/plugins/typus/test/config/working'
-      end
-
-      # Ruby Extensions
-      require 'typus/hash'
-      require 'typus/object'
-      require 'typus/string'
-
-      # Load configuration and roles.
-      Typus::Configuration.config!
+    def reload!
       Typus::Configuration.roles!
-
-      # Rails Extensions.
-      require 'typus/active_record'
-      require 'typus/extensions/routes'
-
-      # Mixins.
-      require 'typus/authentication'
-      require 'typus/format'
-      require 'typus/preview'
-      require 'typus/preferences'
-      require 'typus/reloader'
-      require 'typus/quick_edit'
-      require 'typus/user'
-
-      # Vendor.
-      require 'vendor/active_record'
-      require 'vendor/paginator'
-      require 'vendor/rss_parser'
-
+      Typus::Configuration.config!
+      detect_locales
     end
 
   end
 
-end
+end
+
+Typus.reload!

data/lib/vendor/paginator.rb

@@ -18,7 +18,7 @@ class Paginator
   # * A total count of the number of objects to paginate
   # * The number of objects in each page
   # * A block that returns the array of items
-  #   * The block is passed the item offset 
+  #   * The block is passed the item offset
   #     (and the number of items to show per page, for
   #     convenience, if the arity is 2)
   def initialize(count, per_page, &select)
@@ -53,7 +53,7 @@ class Paginator
   # Retrieve page object by number
   def page(number)
     number = (n = number.to_i) > 0 ? n : 1
-    Page.new(self, number, lambda { 
+    Page.new(self, number, lambda {
       offset = (number - 1) * @per_page
       args = [offset]
       args << @per_page if @select.arity == 2

data/test/factories/assets.rb

@@ -0,0 +1,5 @@
+Factory.define :asset do |f|
+  f.caption "Caption"
+  f.resource_type Post
+  f.resource_id 1
+end

data/test/factories/categories.rb

@@ -0,0 +1,3 @@
+Factory.define :category do |f|
+  f.name "Category"
+end

data/test/factories/comments.rb

@@ -0,0 +1,6 @@
+Factory.define :comment do |f|
+  f.name "John"
+  f.email "john@example.com"
+  f.body "Body of the comment"
+  f.association :post
+end

data/test/factories/pages.rb

@@ -0,0 +1,5 @@
+Factory.define :page do |f|
+  f.title "Title"
+  f.body "Content"
+  f.status "published"
+end

data/test/factories/pictures.rb

@@ -0,0 +1,7 @@
+Factory.define :picture do |f|
+  f.title "Some picture"
+  f.picture_file_name "dog.jpg"
+  f.picture_content_type "image/jpeg"
+  f.picture_file_size "175938"
+  f.picture_updated_at 3.days.ago.to_s(:db)
+end

data/test/factories/posts.rb

@@ -0,0 +1,6 @@
+Factory.define :post do |f|
+  f.title "Post"
+  f.body "Body"
+  f.status "published"
+  # f.association :typus_user
+end

data/test/factories/typus_users.rb

@@ -0,0 +1,8 @@
+Factory.define :typus_user do |f|
+  f.email "admin@example.com"
+  f.role "admin"
+  f.status true
+  f.token "1A2B3C4D5E6F"
+  f.password "12345678"
+  f.preferences Hash.new({ :locale => :en })
+end

data/test/{config → fixtures/config}/default/typus.yml

@@ -1,5 +1,6 @@
 TypusUser:
   fields:
+    default: first_name, last_name, role, email
     list: email, role, status
     form: first_name, last_name, role, email, password, password_confirmation
     options:
@@ -9,4 +10,4 @@ TypusUser:
   filters: status, role
   search: first_name, last_name, email, role
   application: Typus
-  description: System Users Administration
+  description: System Users Administration

data/test/fixtures/config/namespaced/application.yml

@@ -0,0 +1,5 @@
+Delayed::Task:
+  fields:
+    default: name
+  search: name
+  application: System

data/test/fixtures/config/namespaced/application_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  Delayed::Task: all

data/test/fixtures/config/working/application.yml

@@ -0,0 +1,73 @@
+Asset:
+  fields:
+    default: caption
+  application: Site
+
+Category:
+  fields:
+    default: name, position
+    form: name, permalink, position
+  order_by: position
+  module: Post
+
+Comment:
+  fields:
+    list: email, post, post_id, spam
+    form: email, post
+    csv: email, post_id
+  export: csv
+  filters: post
+  search: email, body
+  application: Blog
+
+Page:
+  fields:
+    # Body field is overwrited from a Page class method.
+    list: title
+    form: title, body
+  actions:
+    index: rebuild_all
+    edit: rebuild
+  application: Site
+  options:
+    form_rows: 25
+
+Post:
+  fields:
+    list: title, created_at, status
+    form: title, body, created_at, status, published_at
+    relationship: title, created_at
+    csv: title, status
+    xml: title, status
+    options:
+      selectors: status
+      read_only: permalink
+      auto_generated: created_at
+      date_formats:
+        created_at: post_short
+      templates:
+        published_at: datepicker
+  relationships: assets, categories, comments, views
+  actions:
+    index: cleanup
+    edit: send_as_newsletter, preview
+  filters: status, created_at
+  search: title
+  order_by: title, -created_at
+  application: Blog
+  export: csv, xml
+
+Picture:
+  fields:
+    default: title, picture
+    list: title, created_at
+  search: title
+  application: Blog
+
+CustomUser:
+  fields:
+    list: first_name, last_name, email
+
+View:
+  fields:
+    default: ip, post

data/test/fixtures/config/working/application_roles.yml

@@ -0,0 +1,24 @@
+admin:
+  Asset: create, read, update, delete
+  Category: create, read, update, delete
+  Comment: create, read, update, delete
+  Git: index, commit
+  Order:
+  Page: create, read, update, delete, rebuild, rebuild_all
+  Post: create, read, update, delete
+  Status: index
+  WatchDog: index, cleanup
+  View: create, read, update, delete
+
+editor:
+  Category: create, read, update
+  Comment: read, update, delete
+  Git: index
+  Post: create, read, update
+  TypusUser: read, update
+  View: create, read, update, delete
+
+designer:
+  Category: read, update
+  Comment: read
+  Post: read, update

data/{generators/typus/templates/config/typus → test/fixtures/config/working}/typus.yml

@@ -1,5 +1,6 @@
 TypusUser:
   fields:
+    default: first_name, last_name, role, email, language
     list: email, role, status
     form: first_name, last_name, role, email, password, password_confirmation, language
     options:
@@ -9,4 +10,4 @@ TypusUser:
   filters: status, role
   search: first_name, last_name, email, role
   application: Typus
-  description: System Users Administration
+  description: System Users Administration