typus-rails4 4.0.0.beta6

data/lib/generators/typus/model_generator.rb

@@ -0,0 +1,93 @@
+require "generators/typus/controller_generator"
+
+module Typus
+  module Generators
+    class ModelGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      namespace "typus:model"
+
+      desc <<-DESC
+Description:
+  This generator creates controller and configuration files.
+
+Examples:
+  `rails generate typus:model user`
+  This command creates 2 files like below.
+
+* config/typus/user.yml
+* app/controllers/admin/users_controller.rb
+
+      DESC
+
+      def generate_models
+        Typus.reload!
+
+        models = parse_model_args
+        models.each do |model|
+          generate_yaml(model)
+          generate_controller(model)
+        end
+      end
+
+      protected
+      def configuration
+        @configuration
+      end
+
+      def parse_args
+        ARGV.map { |table| table.singularize.camelize.constantize }
+      end
+
+      def typus_models
+        Typus.application_models.reject { |m| Typus.models.include?(m) }.map(&:constantize)
+      end
+
+      def parse_model_args
+        ARGV.present? ? parse_args : typus_models
+      end
+
+      def create_yaml_data(model)
+        option = {}
+
+        relationships = [ :has_many, :has_one ].map do |relationship|
+                          model.reflect_on_all_associations(relationship).map { |i| i.name.to_s }
+                        end.flatten.join(", ")
+        option[:base] = <<-RAW
+#{model}:
+  fields:
+    default: #{fields_for(model, 'to_label')}
+    form: #{fields_for(model)}
+  relationships: #{relationships}
+  application: Application
+        RAW
+        option[:roles] = "#{model}: create, read, update, delete"
+        option
+      end
+
+      def generate_yaml(model)
+        key = model.name.underscore
+
+        @configuration = create_yaml_data(model)
+
+        template(
+          "config/typus/application.yml",
+          "config/typus/#{key}.yml")
+        template(
+          "config/typus/application_roles.yml",
+          "config/typus/#{key}_roles.yml")
+      end
+
+      def fields_for(model, *defaults)
+        rejections = %w( ^id$ _type$ type created_at created_on updated_at updated_on deleted_at ).join("|")
+        fields = model.table_exists? ? model.columns.map(&:name) : defaults
+        fields.reject { |f| f.match(rejections) }.join(", ")
+      end
+
+      def generate_controller(model)
+        Typus::Generators::ControllerGenerator.new([model.name.pluralize.camelize]).invoke_all
+      end
+    end
+
+  end
+end

data/lib/generators/typus/typus_generator.rb

@@ -0,0 +1,54 @@
+require "typus"
+require "rails/generators/migration"
+
+require "generators/typus/config_generator"
+require "generators/typus/controller_generator"
+require "generators/typus/initializers_generator"
+
+module Typus
+  module Generators
+    class TypusGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      namespace "typus"
+
+      desc <<-DESC
+Description:
+  This generator creates required files to enable an admin panel which allows
+  trusted users to edit structured content.
+
+  To enable session authentication run `rails generate typus:migration`.
+
+      DESC
+
+      def generate_initializers
+        application "require 'typus'"
+        Typus::Generators::InitializersGenerator.new.invoke_all
+      end
+
+      def generate_controllers
+        Typus.application_models.each do |model|
+          Typus::Generators::ControllerGenerator.new([model.pluralize]).invoke_all
+        end
+      end
+
+      def generate_config
+        Typus::Generators::ConfigGenerator.new.invoke_all
+      end
+
+      protected
+
+      def resource
+        @resource
+      end
+
+      def sidebar
+        @sidebar
+      end
+
+    end
+  end
+end

data/lib/generators/typus/views_generator.rb

@@ -0,0 +1,19 @@
+module Typus
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../../../../app", __FILE__)
+
+      desc <<-MSG
+Description:
+  Copies Typus views into your application.
+
+      MSG
+
+      def copy_views
+        directory "views", "app/views"
+      end
+
+    end
+  end
+end

data/lib/support/active_record.rb

@@ -0,0 +1,42 @@
+class ActiveRecord::Base
+
+  #--
+  # On a model:
+  #
+  #     class Post < ActiveRecord::Base
+  #       def self.statuses
+  #         { t("Published") => "published",
+  #           t("Pending") => "pending",
+  #           t("Draft") => "draft" }
+  #       end
+  #     end
+  #
+  #     >> Post.first.status
+  #     => "published"
+  #     >> Post.first.mapping(:status)
+  #     => "Published"
+  #     >> I18n.locale = :es
+  #     => :es
+  #     >> Post.first.mapping(:status)
+  #     => "Publicado"
+  #++
+  def mapping(attribute)
+    values = self.class.send(attribute.to_s.pluralize)
+    array = values.first.is_a?(Array) ? values : values.map { |i| [i, i] }
+    value = array.to_a.rassoc(send(attribute))
+    value ? value.first : send(attribute)
+  end
+
+  def to_label
+    if respond_to?(:name) && name.present?
+      name
+    else
+      [self.class, id].join('#')
+    end
+  end
+
+  def identifier
+    "##{id}"
+  end
+
+end

data/lib/support/fake_user.rb

@@ -0,0 +1,47 @@
+class FakeUser
+
+  def id
+    0
+  end
+
+  def can?(*args)
+    true
+  end
+
+  def cannot?(*args)
+    !can?(*args)
+  end
+
+  def is_root?
+    true
+  end
+
+  def is_not_root?
+    !is_root?
+  end
+
+  def applications
+    Typus.applications
+  end
+
+  def application(name)
+    Typus.application(name)
+  end
+
+  def status
+    true
+  end
+
+  def owns?(resource)
+    true
+  end
+
+  def locale
+    ::I18n.locale
+  end
+
+  def role
+    Typus.master_role
+  end
+
+end

data/lib/support/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+
+  def cleanup
+    whitelist = %w(controller action id _input _popup resource attribute)
+    delete_if { |k, _| !whitelist.include?(k) }
+  end
+
+end

data/lib/support/object.rb

@@ -0,0 +1,9 @@
+class Object
+
+  # OPTIMIZE: Probably there's a better way to verify if a model responds
+  # to a STI pattern.
+  def self.is_sti?
+    (name != base_class.name) && base_class.descends_from_active_record?
+  end
+
+end

data/lib/support/string.rb

@@ -0,0 +1,40 @@
+class String
+
+  def extract_settings
+    split(',').map(&:strip)
+  end
+
+  def remove_prefix
+    split('/')[1..-1].join('/')
+  end
+
+  def extract_class
+    remove_prefix.classify.constantize
+  end
+
+  def extract_singular_class
+    remove_prefix.camelize.constantize
+  end
+
+  # CRUD: create, read, update, delete
+  # Read more at http://en.wikipedia.org/wiki/Create,_read,_update_and_delete
+  def acl_action_mapper
+    case self
+    when 'new', 'create'
+      'create'
+    when 'index', 'show'
+      'read'
+    when 'edit', 'update', 'position', 'toggle', 'relate', 'unrelate'
+      'update'
+    when 'destroy', 'trash'
+      'delete'
+    else
+      self
+    end
+  end
+
+  def to_resource
+    self.underscore.pluralize
+  end
+
+end

data/lib/tasks/typus.rake

@@ -0,0 +1,11 @@
+namespace :typus do
+
+  desc 'List current roles.'
+  task :roles => :environment do
+    Typus::Configuration.roles.each do |role|
+      puts "'#{role.first}' role has access to:"
+      role.last.each { |k, v| puts "- #{k}: #{v}" }
+    end
+  end
+
+end

data/lib/typus.rb

@@ -0,0 +1,215 @@
+require "support/active_record" if defined?(ActiveRecord)
+require "support/hash"
+require "support/object"
+require "support/string"
+
+require "typus/engine"
+require "typus/regex"
+require "typus/version"
+
+require "typus/orm/base/class_methods"
+require "typus/orm/base/search"
+require "typus/orm/active_record"
+
+autoload :FakeUser, "support/fake_user"
+
+module Typus
+
+  autoload :Configuration, "typus/configuration"
+  autoload :I18n, "typus/i18n"
+  autoload :Resources, "typus/resources"
+
+  module Authentication
+    autoload :Base, "typus/authentication/base"
+    autoload :None, "typus/authentication/none"
+    autoload :NoneWithRole, "typus/authentication/none_with_role"
+    autoload :HttpBasic, "typus/authentication/http_basic"
+    autoload :Session, "typus/authentication/session"
+
+    autoload :Devise, "typus/authentication/devise"
+  end
+
+  mattr_accessor :default_locale
+  @@default_locale = :en
+
+  mattr_accessor :admin_title
+  @@admin_title = "Typus"
+
+  mattr_accessor :admin_title_link
+  @@admin_title_link = nil
+
+  # Set authentication (none, http_basic, session)
+  mattr_accessor :authentication
+  @@authentication = :none
+
+  mattr_accessor :config_folder
+  @@config_folder = "config/typus"
+
+  mattr_accessor :username
+  @@username = "admin"
+
+  mattr_accessor :subdomain
+  @@subdomain = nil
+
+  # Define a default password for http authentication.
+  mattr_accessor :password
+  @@password = "columbia"
+
+  # Configure the e-mail address which will be shown in Admin::Mailer.
+  # If not set `forgot_password` feature is disabled.
+  mattr_accessor :mailer_sender
+  @@mailer_sender = nil
+
+  ##
+  # Define `paperclip` attachment styles.
+  #
+
+  mattr_accessor :file_preview
+  @@file_preview = :medium
+
+  mattr_accessor :file_thumbnail
+  @@file_thumbnail = :thumb
+
+  ##
+  # Define `dragonfly` attachment styles.
+  #
+
+  mattr_accessor :image_preview_size
+  @@image_preview_size = '530x'
+
+  mattr_accessor :image_thumb_size
+  @@image_thumb_size = 'x100'
+
+  mattr_accessor :image_table_thumb_size
+  @@image_table_thumb_size = '25x25#'
+
+  # Define the default relationship table.
+  mattr_accessor :relationship
+  @@relationship = "typus_users"
+
+  mattr_accessor :master_role
+  @@master_role = "admin"
+
+  mattr_accessor :user_class_name
+  @@user_class_name = "AdminUser"
+
+  mattr_accessor :user_foreign_key
+  @@user_foreign_key = "admin_user_id"
+
+  mattr_accessor :quick_sidebar
+  @@quick_sidebar = false
+
+  mattr_accessor :ip_whitelist
+  @@ip_whitelist = []
+
+  mattr_accessor :link_to_view_site
+  @@link_to_view_site = false
+
+  mattr_accessor :link_to_help
+  @@link_to_help = false
+
+  class << self
+
+    # Default way to setup typus. Run `rails generate typus` to create a
+    # fresh initializer with all configuration values.
+    def setup
+      yield self
+      reload!
+    end
+
+    def applications
+      hash = {}
+
+      Typus::Configuration.config.map { |i| i.last["application"] }.compact.uniq.each do |app|
+        settings = app.extract_settings
+        hash[settings.first] = settings.size > 1 ? settings.last : 1000
+      end
+
+      hash.sort { |a1, a2| a1[1].to_i <=> a2[1].to_i }.map(&:first)
+    end
+
+    # Lists modules of an application.
+    def application(name)
+      array = []
+
+      Typus::Configuration.config.each do |i|
+        settings = i.last["application"]
+        array << i.first if settings && settings.extract_settings.first.eql?(name)
+      end
+
+      array.compact.uniq
+    end
+
+    # Lists models from the configuration file.
+    def models
+      Typus::Configuration.config.map(&:first).sort
+    end
+
+    # Lists resources, which are tableless models. This is done by looking at
+    # the roles, which handle the permissions for this kind of data.
+    def resources
+      if roles = Typus::Configuration.roles
+        roles.keys.map do |key|
+          Typus::Configuration.roles[key].keys
+        end.flatten.sort.uniq.delete_if { |x| models.include?(x) }
+      else
+        []
+      end
+    end
+
+    # Lists models under <tt>app/models</tt>.
+    def detect_application_models
+      model_dir = Rails.root.join("app/models")
+      Dir.chdir(model_dir.to_s) { Dir["**/*.rb"].reject {|f| f["concerns/"] } }
+    end
+
+    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 is_active_record?(klass)
+      end.compact
+    end
+
+    def is_active_record?(klass)
+      (defined?(ActiveRecord) && klass < ActiveRecord::Base && !klass.abstract_class?)
+    end
+    private :is_active_record?
+
+    def user_class
+      user_class_name.constantize rescue nil
+    end
+
+    def user_class_as_symbol
+      user_class_name.underscore.to_sym
+    end
+
+    def root
+      Rails.root.join(config_folder)
+    end
+
+    def model_configuration_files
+      app = Typus.root.join("**", "*.yml")
+      lib = Rails.root.join("lib", "*", "config", "typus", "**", "*.yml")
+      Dir[app.to_s, lib.to_s].reject { |f| f.match(/_roles.yml/) }.sort
+    end
+
+    def role_configuration_files
+      app = Typus.root.join("**", "*_roles.yml")
+      lib = Rails.root.join("lib", "*", "config", "typus", "**", "*_roles.yml")
+      Dir[app.to_s, lib.to_s].sort
+    end
+
+    def reload!
+      Typus::Configuration.roles!
+      Typus::Configuration.models!
+    end
+
+    # this should be overridden in typus-i18n
+    def available_locales
+      { 'English' => 'en' }
+    end
+
+  end
+
+end