fesplugas-typus 0.9.0

data/lib/typus.rb

@@ -0,0 +1,133 @@
+module Typus
+
+  class << self
+
+    def root
+      File.dirname(__FILE__) + '/../'
+    end
+
+    def locales
+      Typus::Configuration.options[:locales]
+    end
+
+    def default_locale
+      locales.map(&:last).first
+    end
+
+    def applications
+      Typus::Configuration.config.collect { |i| i.last['application'] }.compact.uniq.sort
+    end
+
+    ##
+    # Returns a list of the modules of an application.
+    #
+    def application(name)
+      Typus::Configuration.config.collect { |i| i.first if i.last['application'] == name }.compact.uniq.sort
+    end
+
+    ##
+    # Returns a list of the submodules of a module.
+    #
+    def module(name)
+      Typus::Configuration.config.collect { |i| i.first if i.last['module'] == name.name }.compact.uniq.sort
+    end
+
+    ##
+    # Parent
+    #
+    #  Typus::Configuration.config['Post']['module']
+    #  Typus::Configuration.config['Post']['application']
+    #
+    def parent(model, name)
+      Typus::Configuration.config[model.name][name] || ''
+    end
+
+    def models
+      Typus::Configuration.config.map { |i| i.first }.sort
+    end
+
+    ##
+    # Return a list of resources, which are models tableless.
+    #
+    def resources(models = get_model_names)
+
+      all_resources = Typus::Configuration.roles.keys.map do |key|
+                        Typus::Configuration.roles[key].keys
+                      end.flatten.sort.uniq
+
+      all_resources.delete_if { |x| models.include?(x) || x == 'TypusUser' } rescue []
+
+    end
+
+    def get_model_names
+      Dir[ "#{Rails.root}/app/models/**/*.rb", 
+           "#{Rails.root}/vendor/plugins/**/app/models/**/*.rb" ].collect { |m| File.basename(m).sub(/\.rb$/,'').camelize }
+    end
+
+    def module_description(modulo)
+      Typus::Configuration.config[modulo]['description']
+    end
+
+    def user_class
+      Typus::Configuration.options[:user_class_name].constantize
+    end
+
+    def user_fk
+      Typus::Configuration.options[:user_fk]
+    end
+
+    def testing?
+      Rails.env.test? && Dir.pwd == "#{Rails.root}/vendor/plugins/typus"
+    end
+
+    def plugin?
+      File.exists?("#{Rails.root}/vendor/plugins/typus")
+    end
+
+    ##
+    # Enable application. This is used at boot time.
+    #
+    #   Typus.enable
+    #
+    def enable
+
+      # Ruby Extensions
+      require 'typus/hash'
+      require 'typus/object'
+      require 'typus/string'
+
+      # Load configuration and roles.
+      Typus::Configuration.config!
+      Typus::Configuration.roles!
+
+      # Load translation files from the plugin or the gem.
+      if plugin?
+        I18n.load_path += Dir[File.join("#{Rails.root}/vendor/plugins/typus/config/locales/**/*.{rb,yml}")]
+      else
+        Gem.path.each { |g| I18n.load_path += Dir[File.join("#{g}/gems/typus-**/config/locales/**/*.{rb,yml}")] }
+      end
+
+      # Require the test/models on when testing.
+      require File.dirname(__FILE__) + '/../test/models' if Typus.testing?
+
+      # Rails Extensions.
+      require 'typus/active_record'
+
+      # Mixins.
+      require 'typus/authentication'
+      require 'typus/format'
+      require 'typus/generator'
+      require 'typus/locale'
+      require 'typus/reloader'
+      require 'typus/quick_edit'
+      require 'typus/user'
+
+      # Vendor.
+      require 'vendor/active_record'
+      require 'vendor/paginator'
+
+    end
+
+  end
+
+end

data/lib/vendor/active_record.rb

@@ -0,0 +1,15 @@
+class ActiveRecord::Base
+
+  def to_dom(*args)
+
+    options = args.extract_options!
+    display_id = new_record? ? 'new' : id
+
+    [ options[:prefix], 
+      self.class.name.underscore, 
+      display_id, 
+      options[:suffix] ].compact.join('_')
+
+  end
+
+end

data/lib/vendor/paginator.rb

@@ -0,0 +1,143 @@
+require 'forwardable'
+
+class Paginator
+
+  VERSION = '1.1.1'
+
+  include Enumerable
+
+  class ArgumentError < ::ArgumentError; end
+  class MissingCountError < ArgumentError; end
+  class MissingSelectError < ArgumentError; end
+
+  attr_reader :per_page, :count
+
+  # Instantiate a new Paginator object
+  #
+  # Provide:
+  # * 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 
+  #     (and the number of items to show per page, for
+  #     convenience, if the arity is 2)
+  def initialize(count, per_page, &select)
+    @count, @per_page = count, per_page
+    unless select
+      raise MissingSelectError, "Must provide block to select data for each page"
+    end
+    @select = select
+  end
+
+  # Total number of pages
+  def number_of_pages
+     (@count / @per_page).to_i + (@count % @per_page > 0 ? 1 : 0)
+  end
+
+  # First page object
+  def first
+    page 1
+  end
+
+  # Last page object
+  def last
+    page number_of_pages
+  end
+
+  def each
+    1.upto(number_of_pages) do |number|
+      yield page(number)
+    end
+  end
+
+  # Retrieve page object by number
+  def page(number)
+    number = (n = number.to_i) > 0 ? n : 1
+    Page.new(self, number, lambda { 
+      offset = (number - 1) * @per_page
+      args = [offset]
+      args << @per_page if @select.arity == 2
+      @select.call(*args)
+    })
+  end
+
+  # Page object
+  #
+  # Retrieves items for a page and provides metadata about the position
+  # of the page in the paginator
+  class Page
+
+    include Enumerable
+
+    attr_reader :number, :pager
+
+    def initialize(pager, number, select) #:nodoc:
+      @pager, @number = pager, number
+      @offset = (number - 1) * pager.per_page
+      @select = select
+    end
+
+    # Retrieve the items for this page
+    # * Caches
+    def items
+      @items ||= @select.call
+    end
+
+    # Does this page have any items?
+    def empty?
+      items.empty?
+    end
+
+    # Checks to see if there's a page before this one
+    def prev?
+      @number > 1
+    end
+
+   # Get previous page (if possible)
+   def prev
+     @pager.page(@number - 1) if prev?
+   end
+
+    # Checks to see if there's a page after this one
+    def next?
+      @number < @pager.number_of_pages
+    end
+
+    # Get next page (if possible)
+   def next
+     @pager.page(@number + 1) if next?
+   end
+
+    # The "item number" of the first item on this page
+    def first_item_number
+      1 + @offset
+    end
+
+    # The "item number" of the last item on this page
+    def last_item_number
+      if next?
+        @offset + @pager.per_page
+      else
+        @pager.count
+      end
+    end
+
+    def ==(other) #:nodoc:
+      @pager == other.pager && self.number == other.number
+    end
+
+    def each(&block)
+      items.each(&block)
+    end
+
+    def method_missing(meth, *args, &block) #:nodoc:
+      if @pager.respond_to?(meth)
+        @pager.__send__(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+  end
+
+end

data/tasks/typus_tasks.rake

@@ -0,0 +1,26 @@
+namespace :typus do
+
+  desc 'Install acts_as_list, acts_as_tree and paperclip.'
+  task :misc do
+    plugins = [ 'git://github.com/thoughtbot/paperclip.git', 
+                'git://github.com/rails/acts_as_list.git', 
+                'git://github.com/rails/acts_as_tree.git' ]
+    system "script/plugin install #{plugins.join(' ')} --force"
+  end
+
+  desc 'List current roles.'
+  task :roles => :environment do
+    Typus::Configuration.roles.each do |role|
+      puts "\n#{role.first.capitalize} role has access to:"
+      role.last.each { |key, value| puts "- #{key}: #{value}" }
+    end
+    puts "\n"
+  end
+
+  desc 'Install ssl_requirement.'
+  task :ssl do
+    plugins = [ 'git://github.com/rails/ssl_requirement.git' ]
+    system "script/plugin install #{plugins.join(' ')} --force"
+  end
+
+end

data/test/config/broken/application.yml

@@ -0,0 +1,68 @@
+Page:
+  fields:
+    # Body field is overwrited from a Page class method.
+    list: title, body, status
+    form: title, body, status
+  relationships:
+    has_many: assets
+  application: Site
+
+Asset:
+  fields:
+    list: caption
+    form: caption
+  application: Site
+
+Category:
+  fields:
+    list: name, position
+    form: name, permalink, position
+  order_by: position
+  module: Post
+
+Post:
+  fields:
+    list: title, created_at, status
+    form: title, body, created_at, status
+    relationship: title, created_at
+    options:
+      selectors: status
+      read_only: permalink
+      auto_generated: created_at
+      date_formats:
+        created_at: post_short
+  relationships: assets, categories
+  actions:
+    index: cleanup
+    edit: send_as_newsletter, preview
+  filters: status, created_at, user, user_id
+  search: title
+  order_by: title, -created_at
+  application: Blog
+
+User:
+  fields:
+    list: first_name, last_name, email
+
+Comment:
+  fields:
+    list: email, post, post_id
+    form: email, post
+  filters: post
+  search: email, body
+  application: Blog
+
+TypusUser:
+  fields:
+    list: first_name, last_name, email, role, status
+    form: first_name, last_name, email, role, password, password_confirmation
+    relationship: first_name, last_name, role, email, status
+    options:
+      selectors: role
+      booleans:
+        status: active, inactive
+  filters: status, role, unexisting
+  search: first_name, last_name, email, role
+  module: Typus
+  description: System Users Administration
+  application: Typus

data/test/config/broken/application_roles.yml

@@ -0,0 +1,20 @@
+admin:
+  Asset: create, read, update, delete
+  Category: create, read, update, delete
+  Comment: create, read, update, delete
+  TypusUser: create, read, update, delete
+  Page: create, read, update, delete
+  Post: create, read, update, delete
+  Status: index
+  Order:
+
+editor:
+  Category: create, read, update
+  Comment: read, update, delete
+  Post: create, read, update
+  TypusUser: read, update
+
+designer:
+  Category: read, update
+  Comment: read
+  Post: read

data/test/config/broken/undefined.yml

@@ -0,0 +1,3 @@
+Page:
+
+User:

data/test/config/broken/undefined_roles.yml

@@ -0,0 +1,6 @@
+admin:
+
+designer:
+  Category: read, update
+  Comment: read
+  Post: read

data/test/config/default/typus.yml

@@ -0,0 +1,14 @@
+TypusUser:
+  fields:
+    list: email, role, status
+    form: first_name, last_name, role, email, password, password_confirmation
+    options:
+      selectors: role
+      booleans:
+        status: Active, Inactive
+  filters: status, role
+  search: first_name, last_name, email, role
+  application: Typus
+  description: System Users Administration
+  options:
+    icon_on_boolean: false

data/test/config/default/typus_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  TypusUser: create, read, update, delete

data/test/config/locales/es.yml

@@ -0,0 +1,10 @@
+# Spanish translations for Rails
+# by Francisco Fernando García Nieto (ffgarcianieto@gmail.com)
+
+es:
+  activerecord:
+    models:
+      # Overrides default messages
+      comment: "Comentario"
+    attributes:
+        # Overrides model and default messages.

data/test/config/ordered/001_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  categories: read, update

data/test/config/ordered/002_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  categories: read

data/test/config/unordered/app_one_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  categories: read

data/test/config/unordered/app_two_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  categories: read, update

data/test/config/working/application.yml

@@ -0,0 +1,67 @@
+Asset:
+  fields:
+    list: caption
+    form: caption
+  application: Site
+  options:
+
+Category:
+  fields:
+    list: name, position
+    form: name, permalink, position
+  order_by: position
+  module: Post
+
+Comment:
+  fields:
+    list: email, post, post_id
+    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, is_published?
+    form: title, body, is_published?
+    options:
+      booleans:
+        is_published: ["Yes, it is", "No, it isn't"]
+  actions:
+    index: rebuild_all
+    edit: rebuild
+  application: Site
+  filters: is_published?
+  options:
+    form_rows: 25
+
+Post:
+  fields:
+    list: title, created_at, status
+    form: title, body, created_at, status, published_at
+    relationship: title, created_at
+    options:
+      selectors: status
+      read_only: permalink
+      auto_generated: created_at
+      date_formats:
+        created_at: post_short
+      templates:
+        published_at: datepicker
+  relationships: assets, categories
+  actions:
+    index: cleanup
+    edit: send_as_newsletter, preview
+  filters: status, created_at, user, user_id
+  search: title
+  order_by: title, -created_at
+  application: Blog
+
+CustomUser:
+  fields:
+    list: first_name, last_name, email
+    csv: first_name, last_name, email
+  export: csv

data/test/config/working/application_roles.yml

@@ -0,0 +1,22 @@
+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
+
+editor:
+  Category: create, read, update
+  Comment: read, update, delete
+  Git: index
+  Post: create, read, update
+  TypusUser: read, update
+
+designer:
+  Category: read, update
+  Comment: read
+  Post: read

data/test/config/working/typus.yml

@@ -0,0 +1,14 @@
+TypusUser:
+  fields:
+    list: email, role, status
+    form: first_name, last_name, role, email, password, password_confirmation
+    options:
+      selectors: role
+      booleans:
+        status: Active, Inactive
+  filters: status, role
+  search: first_name, last_name, email, role
+  application: Typus
+  description: System Users Administration
+  options:
+    icon_on_boolean: false

data/test/config/working/typus_roles.yml

@@ -0,0 +1,2 @@
+admin:
+  TypusUser: create, read, update, delete

data/test/fixtures/app/controllers/admin/assets_controller.rb

@@ -0,0 +1,2 @@
+class Admin::AssetsController < Admin::MasterController
+end

data/test/fixtures/app/controllers/admin/categories_controller.rb

@@ -0,0 +1,2 @@
+class Admin::CategoriesController < Admin::MasterController
+end

data/test/fixtures/app/controllers/admin/comments_controller.rb

@@ -0,0 +1,2 @@
+class Admin::CommentsController < Admin::MasterController
+end

data/test/fixtures/app/controllers/admin/pages_controller.rb

@@ -0,0 +1,2 @@
+class Admin::PagesController < Admin::MasterController
+end

data/test/fixtures/app/controllers/admin/posts_controller.rb

@@ -0,0 +1,2 @@
+class Admin::PostsController < Admin::MasterController
+end

data/test/fixtures/app/controllers/admin/status_controller.rb

@@ -0,0 +1,6 @@
+class Admin::StatusController < TypusController
+
+  def index
+  end
+
+end

data/test/fixtures/app/controllers/admin/typus_users_controller.rb

@@ -0,0 +1,2 @@
+class Admin::TypusUsersController < Admin::MasterController
+end

data/test/fixtures/app/controllers/admin/watch_dog_controller.rb

@@ -0,0 +1,6 @@
+class Admin::WatchDogController < TypusController
+
+  def index
+  end
+
+end

data/test/fixtures/app/views/admin/comments/_edit_bottom.html.erb

@@ -0,0 +1 @@
+_edit_bottom.html.erb

data/test/fixtures/app/views/admin/comments/_edit_sidebar.html.erb

@@ -0,0 +1 @@
+_edit_sidebar.html.erb

data/test/fixtures/app/views/admin/comments/_edit_top.html.erb

@@ -0,0 +1 @@
+_edit_top.html.erb

data/test/fixtures/app/views/admin/comments/_index_bottom.html.erb

@@ -0,0 +1 @@
+_index_bottom.html.erb

data/test/fixtures/app/views/admin/comments/_index_sidebar.html.erb

@@ -0,0 +1 @@
+_index_sidebar.html.erb

data/test/fixtures/app/views/admin/comments/_index_top.html.erb

@@ -0,0 +1 @@
+_index_top.html.erb

data/test/fixtures/app/views/admin/comments/_new_bottom.html.erb

@@ -0,0 +1 @@
+_new_bottom.html.erb

data/test/fixtures/app/views/admin/comments/_new_sidebar.html.erb

@@ -0,0 +1 @@
+_new_sidebar.html.erb

data/test/fixtures/app/views/admin/comments/_new_top.html.erb

@@ -0,0 +1 @@
+_new_top.html.erb

data/test/fixtures/app/views/admin/comments/_show_bottom.html.erb

@@ -0,0 +1 @@
+_show_bottom.html.erb

data/test/fixtures/app/views/admin/comments/_show_sidebar.html.erb

@@ -0,0 +1 @@
+_show_sidebar.html.erb

data/test/fixtures/app/views/admin/comments/_show_top.html.erb

@@ -0,0 +1 @@
+_show_top.html.erb

data/test/fixtures/app/views/admin/dashboard/_bottom.html.erb

@@ -0,0 +1 @@
+_bottom.html.erb

data/test/fixtures/app/views/admin/dashboard/_sidebar.html.erb

@@ -0,0 +1 @@
+_sidebar.html.erb