brainsome_typus 4.0.0.beta1

data/lib/generators/templates/config/initializers/typus_authentication.rb

@@ -0,0 +1,18 @@
+Typus.setup do |config|
+
+  # Define authentication: +:none+, +:http_basic+, +:session+
+  config.authentication = :session
+
+  # Define master_role.
+  # config.master_role = "admin"
+
+  # Define relationship.
+  # config.relationship = "typus_users"
+
+  # Define user_class_name.
+  config.user_class_name = "<%= options[:user_class_name] %>"
+
+  # Define user_foreign_key.
+  config.user_foreign_key = "<%= options[:user_foreign_key] %>"
+
+end

data/lib/generators/templates/config/initializers/typus_resources.rb

@@ -0,0 +1,24 @@
+Typus::Resources.setup do |config|
+
+  # Defines default_action_on_item.
+  # config.default_action_on_item = "edit"
+
+  # Defines end_year.
+  # config.end_year = nil
+
+  # Defines form_rows.
+  # config.form_rows = 15
+
+  # Defines minute_step.
+  # config.minute_step = 5
+
+  # Defines only_user_items.
+  # config.only_user_items = false
+
+  # Defines per_page.
+  # config.per_page = 25
+
+  # Defines start_year.
+  # config.start_year = nil
+
+end

data/lib/generators/templates/config/typus/README

@@ -0,0 +1,58 @@
+# Models
+
+This is an example of a **Typus** enabled model with all available options.
+Use this example as reference to customize your YAML files.
+
+    Entry:
+      fields:
+        default: id, title, category_id, created_at, is_published?
+        list: id, title, category_id, created_at, is_published?
+        form: title, body, is_published?, created_at
+        show: title, category, is_published?
+        relationship: title, status
+        options:
+          booleans:
+            is_published: ["Yes, it is", "No, it isn't"]
+          date_formats:
+            created_at: post_long
+          selectors:
+          templates:
+            body: rich_text
+      actions:
+        index: cleanup
+        edit: send_as_newsletter
+        show: rebuild
+      order_by: created_at
+      relationships:
+      filters: is_published?, created_at, category_id
+      search: title, body
+      application: Application
+      description: Some text to describe the model
+      options:
+        default_action_on_item: show
+        end_year: 2015
+        form_rows: 25
+        minute_step: 15
+        only_user_items: true
+        per_page: 25
+        start_year: 1990
+
+# Roles
+
+This is an example of a roles file. Use this example as reference to customize
+your YAML files.
+
+    admin:
+      Entry: create, read, update, delete
+      Category: create, read, update, delete
+      AdminUser: all
+
+    editor:
+      Entry: create, read, update
+      Category: read, update
+
+You can also define `resources` which are not related to a model, for example
+to control `Redis`.
+
+    admin:
+      Redis: index, flush_all

data/lib/generators/templates/config/typus/application.yml

@@ -0,0 +1,3 @@
+# Use the README file as a reference to customize settings.
+
+<%= configuration[:base] %>

data/lib/generators/templates/config/typus/application_roles.yml

@@ -0,0 +1,4 @@
+# Use the README file as a reference to customize settings.
+
+admin:
+  <%= configuration[:roles] %>

data/lib/generators/templates/config/typus/typus.yml

@@ -0,0 +1,15 @@
+# Use the README file as a reference to customize settings.
+
+<%= options[:user_class_name] %>:
+  fields:
+    default: first_name, last_name, role, email, locale
+    list: email, role, status
+    form: first_name, last_name, role, email, password, password_confirmation, locale, status
+    options:
+      selectors: role, locale
+      booleans:
+        status: Active, Inactive
+  filters: status, role
+  search: first_name, last_name, email, role
+  application: Admin
+  description: Users Administration

data/lib/generators/templates/config/typus/typus_roles.yml

@@ -0,0 +1,4 @@
+# Use the README file as a reference to customize settings.
+
+admin:
+  <%= options[:user_class_name] %>: all

data/lib/generators/templates/controller.erb

@@ -0,0 +1,2 @@
+class Admin::<%= resource %>Controller < Admin::ResourcesController
+end

data/lib/generators/templates/migration.erb

@@ -0,0 +1,22 @@
+class <%= migration_name %> < ActiveRecord::Migration
+
+  def self.up
+    create_table :<%= admin_users_table_name %> do |t|
+      t.string :first_name, :default => "", :null => false
+      t.string :last_name, :default => "", :null => false
+      t.string :role, :null => false
+      t.string :email, :null => false
+      t.boolean :status, :default => false
+      t.string :token, :null => false
+      t.string :password_digest, :null => false
+      t.string :preferences
+      t.timestamps
+    end
+    add_index :<%= admin_users_table_name %>, :email, :unique => true
+  end
+
+  def self.down
+    drop_table :<%= admin_users_table_name %>
+  end
+
+end

data/lib/generators/templates/view.html.erb

@@ -0,0 +1,13 @@
+<% content_for :main_grid do %>
+  <h2><%= resource.titleize %></h2>
+
+  <p>Find me in app/views/<%= resource.underscore %>/index.html.erb</p>
+<% end %>
+
+<div class="grid_2">
+  <%= sidebar %>
+</div>
+
+<div class="grid_8">
+  <%= yield :main_grid %>
+</div>

data/lib/generators/typus/config_generator.rb

@@ -0,0 +1,67 @@
+module Typus
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc <<-MSG
+Description:
+  Creates configuration files.
+
+      MSG
+
+      def generate_config
+        copy_file "config/typus/README"
+        generate_yaml.each do |key, value|
+          if (@configuration = value)[:base].present?
+            template "config/typus/application.yml", "config/typus/#{key}.yml"
+            template "config/typus/application_roles.yml", "config/typus/#{key}_roles.yml"
+          end
+        end
+      end
+
+      protected
+
+      def configuration
+        @configuration
+      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_yaml
+        Typus.reload!
+
+        configuration = {}
+        models = Typus.application_models.reject { |m| Typus.models.include?(m) }.map(&:constantize)
+
+        models.each do |model|
+          key = model.name.underscore
+
+          configuration[key] = {}
+
+          relationships = [ :has_many, :has_one ].map do |relationship|
+                            model.reflect_on_all_associations(relationship).map { |i| i.name.to_s }
+                          end.flatten.join(", ")
+
+          configuration[key][:base] = <<-RAW
+#{model}:
+  fields:
+    default: #{fields_for(model, 'to_label')}
+    form: #{fields_for(model)}
+  relationships: #{relationships}
+  application: Application
+          RAW
+
+          configuration[key][:roles] = "#{model}: create, read, update, delete"
+        end
+
+        configuration
+      end
+
+    end
+  end
+end

data/lib/generators/typus/controller_generator.rb

@@ -0,0 +1,25 @@
+module Typus
+  module Generators
+    class ControllerGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      alias_method :resource, :name
+
+      desc <<-MSG
+Description:
+  Generates admin controllers for the given resource.
+
+      MSG
+
+      def generate_controller
+        template "controller.erb", "app/controllers/admin/#{file_name}_controller.rb"
+      end
+
+      hook_for :test_framework do |instance, generator|
+        instance.invoke generator, ["admin/#{instance.name}"]
+      end
+
+    end
+  end
+end

data/lib/generators/typus/initializers_generator.rb

@@ -0,0 +1,20 @@
+module Typus
+  module Generators
+    class InitializersGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc <<-MSG
+Description:
+  Copies Typus initializers into your application.
+
+      MSG
+
+      def generate_initializers
+        template "config/initializers/typus.rb", "config/initializers/typus.rb"
+        template "config/initializers/typus_resources.rb", "config/initializers/typus_resources.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/typus/migration_generator.rb

@@ -0,0 +1,94 @@
+require "rails/generators/migration"
+require "generators/typus/controller_generator"
+
+module Typus
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      class_option :user_class_name, :default => "AdminUser", :aliases => "-u"
+      class_option :user_foreign_key, :default => "admin_user_id", :aliases => "-fk"
+
+      desc <<-DESC
+Description:
+  This generator creates required configuration files and a migration to
+  enable authentication on the admin panel.
+
+Examples:
+
+  `rails generate typus:migration`
+
+    creates needed files with `AdminUser` as the Typus user.
+
+  `rails generate typus:migration -u User`
+
+    creates needed files with `User` as the Typus user.
+
+      DESC
+
+      def self.next_migration_number(path)
+        Time.zone.now.to_s(:number)
+      end
+
+      def generate_model
+        unless model_exists?
+          invoke "active_record:model", [options[:user_class_name]], :migration => false
+        end
+      end
+
+      def inject_mixins_into_model
+        inject_into_class "app/models/#{model_filename}.rb", options[:user_class_name] do
+          <<-MSG
+  include Typus::Orm::ActiveRecord::AdminUser
+          MSG
+        end
+      end
+
+      def generate_initializer
+        template "config/initializers/typus_authentication.rb", "config/initializers/typus_authentication.rb"
+      end
+
+      def generate_typus_yaml
+        template "config/typus/typus.yml", "config/typus/typus.yml"
+      end
+
+      def generate_typus_roles_yaml
+        template "config/typus/typus_roles.yml", "config/typus/typus_roles.yml"
+      end
+
+      def generate_controller
+        Typus::Generators::ControllerGenerator.new([options[:user_class_name].pluralize]).invoke_all
+      end
+
+      def generate_migration
+        migration_template "migration.erb", "db/migrate/create_#{admin_users_table_name}"
+      end
+
+      protected
+
+      def admin_users_table_name
+        options[:user_class_name].tableize
+      end
+
+      def migration_name
+        "Create#{options[:user_class_name]}s"
+      end
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{model_filename}.rb")
+      end
+
+      def model_filename
+        options[:user_class_name].underscore
+      end
+
+    end
+  end
+end

data/lib/generators/typus/typus_generator.rb

@@ -0,0 +1,52 @@
+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
+        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,12 @@
+class Hash
+
+  def compact
+    delete_if { |k, v| v.blank? }
+  end
+
+  def cleanup
+    whitelist = %w(controller action id _input _popup resource attribute)
+    delete_if { |k, v| !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 an 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/authentication/base.rb

@@ -0,0 +1,24 @@
+module Typus
+  module Authentication
+    module Base
+
+      def admin_user
+        @admin_user
+      end
+
+      def current_role
+        admin_user.role.to_sym
+      end
+
+      def authenticate; end
+      def check_if_user_can_perform_action_on_user; end
+      def check_if_user_can_perform_action_on_resources; end
+      def check_if_user_can_perform_action_on_resource; end
+      def check_resource_ownership; end
+      def check_resources_ownership; end
+      def set_attributes_on_create; end
+      def set_attributes_on_update; end
+
+    end
+  end
+end

data/lib/typus/authentication/devise.rb

@@ -0,0 +1,19 @@
+module Typus
+  module Authentication
+    module Devise
+
+      protected
+
+      include Base
+
+      def admin_user
+        send("current_#{Typus.user_class_name.underscore}")
+      end
+
+      def authenticate
+        send("authenticate_#{Typus.user_class_name.underscore}!")
+      end
+
+    end
+  end
+end

data/lib/typus/authentication/http_basic.rb

@@ -0,0 +1,18 @@
+module Typus
+  module Authentication
+    module HttpBasic
+
+      protected
+
+      include Base
+
+      def authenticate
+        @admin_user = FakeUser.new
+        authenticate_or_request_with_http_basic(Typus.admin_title) do |username, password|
+          username == Typus.username && password == Typus.password
+        end
+      end
+
+    end
+  end
+end