typus 3.0.8 → 3.0.9

data/lib/typus/orm/active_record.rb

@@ -2,12 +2,12 @@ if defined?(ActiveRecord)
   require 'typus/orm/active_record/class_methods'
   ActiveRecord::Base.extend Typus::Orm::ActiveRecord::ClassMethods
 
-  require 'typus/orm/active_record/instance_methods'
-  ActiveRecord::Base.send :include, Typus::Orm::ActiveRecord::InstanceMethods
-
   require 'typus/orm/active_record/search'
   ActiveRecord::Base.extend Typus::Orm::ActiveRecord::Search
 
-  require 'typus/orm/active_record/user'
-  ActiveRecord::Base.send :include, Typus::Orm::ActiveRecord::User
+  require 'typus/orm/active_record/admin_user_v1'
+  ActiveRecord::Base.extend Typus::Orm::ActiveRecord::AdminUserV1::ClassMethods
+
+  require 'typus/orm/active_record/admin_user_v2'
+  ActiveRecord::Base.extend Typus::Orm::ActiveRecord::AdminUserV2::ClassMethods
 end

data/lib/typus/orm/active_record/admin_user_v1.rb

@@ -0,0 +1,93 @@
+require 'typus/orm/active_record/user/instance_methods'
+
+module Typus
+  module Orm
+    module ActiveRecord
+      module AdminUserV1
+
+        module ClassMethods
+
+          def enable_as_typus_user
+
+            attr_accessor :password
+            attr_protected :status
+
+            validates :email,
+                      :presence => true,
+                      :uniqueness => true,
+                      :format => { :with => Typus::Regex::Email }
+
+            validates :password,
+                      :confirmation => { :if => :password_required? },
+                      :presence => { :if => :password_required? }
+
+            validates_length_of :password, :within => 6..40, :if => :password_required?
+
+            validates :role, :presence => true
+
+            before_save :initialize_salt, :encrypt_password, :initialize_token
+
+            serialize :preferences
+
+            def authenticate(email, password)
+              user = find_by_email_and_status(email, true)
+              user && user.authenticated?(password) ? user : nil
+            end
+
+            def generate(*args)
+              options = args.extract_options!
+              options[:password] ||= ActiveSupport::SecureRandom.hex(4)
+              options[:role] ||= Typus.master_role
+              new :email => options[:email], :password => options[:password], :role => options[:role]
+            end
+
+            include InstanceMethods
+            include Typus::Orm::ActiveRecord::User::InstanceMethods
+
+          end
+
+        end
+
+        module InstanceMethods
+
+          def authenticated?(password)
+            crypted_password == encrypt(password)
+          end
+
+          protected
+
+          def generate_hash(string)
+            Digest::SHA1.hexdigest(string)
+          end
+
+          def encrypt_password
+            return if password.blank?
+            self.crypted_password = encrypt(password)
+          end
+
+          def encrypt(string)
+            generate_hash("--#{salt}--#{string}--")
+          end
+
+          def initialize_salt
+            self.salt = generate_hash("--#{Time.zone.now.to_s(:number)}--#{email}--") if new_record?
+          end
+
+          def initialize_token
+            generate_token if new_record?
+          end
+
+          def generate_token
+            self.token = encrypt("--#{Time.zone.now.to_s(:number)}--#{password}--").first(12)
+          end
+
+          def password_required?
+            crypted_password.blank? || !password.blank?
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/typus/orm/active_record/admin_user_v2.rb

@@ -0,0 +1,49 @@
+require 'typus/orm/active_record/user/instance_methods'
+require 'bcrypt'
+
+module Typus
+  module Orm
+    module ActiveRecord
+      module AdminUserV2
+
+        module ClassMethods
+
+          def has_admin
+
+            attr_reader   :password
+            attr_accessor :password_confirmation
+
+            validates :email, :presence => true, :uniqueness => true, :format => { :with => Typus::Regex::Email }
+            validates :password, :confirmation => true, :length => { :within => 6..40 }
+            validates :password_digest, :presence => true
+
+            include InstanceMethodsOnActivation
+            include Typus::Orm::ActiveRecord::User::InstanceMethods
+
+          end
+
+        end
+
+        module InstanceMethodsOnActivation
+
+          # Returns self if the password is correct, otherwise false.
+          def authenticate(unencrypted_password)
+            if BCrypt::Password.new(password_digest) == unencrypted_password
+              self
+            else
+              false
+            end
+          end
+
+          # Encrypts the password into the password_digest attribute.
+          def password=(unencrypted_password)
+            @password = unencrypted_password
+            self.password_digest = BCrypt::Password.create(unencrypted_password)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/typus/orm/active_record/class_methods.rb

@@ -3,6 +3,8 @@ module Typus
     module ActiveRecord
       module ClassMethods
 
+        include Typus::Orm::Base
+
         # Model fields as an <tt>ActiveSupport::OrderedHash</tt>.
         def model_fields
           ActiveSupport::OrderedHash.new.tap do |hash|
@@ -17,16 +19,31 @@ module Typus
           end
         end
 
-        # Model description for admin panel.
-        def typus_description
-          read_model_config['description']
-        end
-
         # Form and list fields
         def typus_fields_for(filter)
           ActiveSupport::OrderedHash.new.tap do |fields_with_type|
             data = read_model_config['fields']
-            fields = data[filter.to_s] || data['default'] || ""
+
+            ##
+            # Let's say for example we want to get the fields for actions
+            # related with editing stuff.
+            #
+
+            fields = case filter.to_sym
+                     when :list, :form
+                       # TODO: This statement is for backwards compatibility
+                       #       with the current tests, so can be removed in
+                       #       the near future.
+                       data[filter.to_s] || data['default'] || ""
+                     when :index
+                       data['index'] || data['list'] || data['default'] || ""
+                     when :new, :create
+                       data['new'] || data['form'] || data['default'] || ""
+                     when :edit, :update, :toggle
+                       data['edit'] || data['form'] || data['default'] || ""
+                     else
+                       data[filter.to_s] || data['default'] || ""
+                     end
 
             virtual_fields = instance_methods.map { |i| i.to_s } - model_fields.keys.map { |i| i.to_s }
 
@@ -84,143 +101,6 @@ module Typus
           end
         end
 
-        # Extended actions for this model on Typus.
-        def typus_actions_on(filter)
-          actions = read_model_config['actions']
-          actions && actions[filter.to_s] ? actions[filter.to_s].extract_settings : []
-        end
-
-        # Used for +search+, +relationships+
-        def typus_defaults_for(filter)
-          read_model_config[filter.to_s].try(:extract_settings) || []
-        end
-
-        def typus_search_fields
-          Hash.new.tap do |search|
-            typus_defaults_for(:search).each do |field|
-              if field.starts_with?("=")
-                field.slice!(0)
-                search[field] = "="
-              elsif field.starts_with?("^")
-                field.slice!(0)
-                search[field] = "^"
-              else
-                search[field] = "@"
-              end
-            end
-          end
-        end
-
-        def typus_application
-          read_model_config['application'] || 'Unknown'
-        end
-
-        def typus_field_options_for(filter)
-          options = read_model_config['fields']['options']
-          options && options[filter.to_s] ? options[filter.to_s].extract_settings.map { |i| i.to_sym } : []
-        end
-
-        #--
-        # With Typus::Resources we some application defaults.
-        #
-        #     Typus::Resources.setup do |config|
-        #       config.per_page = 15
-        #     end
-        #
-        # If for any reason we need a better default for an specific resource we
-        # we override it on `application.yaml`.
-        #
-        #     Post:
-        #       ...
-        #       options:
-        #         per_page: 15
-        #++
-        def typus_options_for(filter)
-          options = read_model_config['options']
-
-          unless options.nil? || options[filter.to_s].nil?
-            options[filter.to_s]
-          else
-            Typus::Resources.send(filter)
-          end
-        end
-
-        def typus_export_formats
-          read_model_config['export'].try(:extract_settings) || []
-        end
-
-        def typus_order_by
-          typus_defaults_for(:order_by).map do |field|
-            field.include?('-') ? "#{table_name}.#{field.delete('-')} DESC" : "#{table_name}.#{field} ASC"
-          end.join(', ')
-        end
-
-        #--
-        # Define our own boolean mappings.
-        #
-        #     Post:
-        #       fields:
-        #         default: title, status
-        #         options:
-        #           booleans:
-        #             status: "Published", "Not published"
-        #
-        #++
-        def typus_boolean(attribute = :default)
-          options = read_model_config['fields']['options']
-
-          boolean = if options && options['booleans'] && boolean = options['booleans'][attribute.to_s]
-                      boolean.is_a?(String) ? boolean.extract_settings : boolean
-                    else
-                      ["True", "False"]
-                    end
-
-          [[boolean.first, "true"], [boolean.last, "false"]]
-        end
-
-        #--
-        # Custom date formats.
-        #++
-        def typus_date_format(attribute = :default)
-          options = read_model_config['fields']['options']
-          if options && options['date_formats'] && options['date_formats'][attribute.to_s]
-            options['date_formats'][attribute.to_s].to_sym
-          else
-            :default
-          end
-        end
-
-        #--
-        # This is user to use custome templates for attribute:
-        #
-        #     Post:
-        #       fields:
-        #         form: title, body, status
-        #         options:
-        #           templates:
-        #             body: rich_text
-        #
-        # Templates are stored on <tt>app/views/admin/templates</tt>.
-        #++
-        def typus_template(attribute)
-          options = read_model_config['fields']['options']
-          if options && options['templates'] && options['templates'][attribute.to_s]
-            options['templates'][attribute.to_s]
-          end
-        end
-
-        def adapter
-          @adapter ||= ::ActiveRecord::Base.configurations[Rails.env]['adapter']
-        end
-
-        def typus_user_id?
-          columns.map { |u| u.name }.include?(Typus.user_fk)
-        end
-
-        def read_model_config
-          Typus::Configuration.config[name] or raise "No typus configuration specified for #{name}"
-        end
-
       end
     end
   end

data/lib/typus/orm/active_record/user/instance_methods.rb

@@ -0,0 +1,64 @@
+module Typus
+  module Orm
+    module ActiveRecord
+      module User
+        module InstanceMethods
+
+          def to_label
+            full_name = [first_name, last_name].delete_if { |s| s.blank? }
+            full_name.any? ? full_name.join(" ") : email
+          end
+
+          def resources
+            Typus::Configuration.roles[role.to_s].compact
+          end
+
+          def applications
+            Typus.applications.delete_if { |a| application(a).empty? }
+          end
+
+          def application(name)
+            Typus.application(name).delete_if { |r| !resources.keys.include?(r) }
+          end
+
+          def can?(action, resource, options = {})
+            resource = resource.model_name if resource.is_a?(Class)
+
+            return false if !resources.include?(resource)
+            return true if resources[resource].include?("all")
+
+            action = options[:special] ? action : action.acl_action_mapper
+
+            resources[resource].extract_settings.include?(action)
+          end
+
+          def cannot?(*args)
+            !can?(*args)
+          end
+
+          def is_root?
+            role == Typus.master_role
+          end
+
+          def is_not_root?
+            !is_root?
+          end
+
+          def locale
+            (preferences && preferences[:locale]) ? preferences[:locale] : ::I18n.default_locale
+          end
+
+          def locale=(locale)
+            self.preferences ||= {}
+            self.preferences[:locale] = locale
+          end
+
+          def owns?(resource)
+            id == resource.send(Typus.user_fk)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/typus/orm/base.rb

@@ -0,0 +1,170 @@
+module Typus
+  module Orm
+    module Base
+
+      # Model fields as an <tt>ActiveSupport::OrderedHash</tt>.
+      def model_fields; end
+
+      # Model relationships as an <tt>ActiveSupport::OrderedHash</tt>.
+      def model_relationships; end
+
+      # Model description for admin panel.
+      def typus_description
+        read_model_config['description']
+      end
+
+      # Form and list fields
+      def typus_fields_for(filter); end
+
+      def typus_filters; end
+
+      # Extended actions for this model on Typus.
+      def typus_actions_on(filter)
+        actions = read_model_config['actions']
+        actions && actions[filter.to_s] ? actions[filter.to_s].extract_settings : []
+      end
+
+      # Used for +search+, +relationships+
+      def typus_defaults_for(filter)
+        read_model_config[filter.to_s].try(:extract_settings) || []
+      end
+
+      def typus_search_fields
+        Hash.new.tap do |search|
+          typus_defaults_for(:search).each do |field|
+            if field.starts_with?("=")
+              field.slice!(0)
+              search[field] = "="
+            elsif field.starts_with?("^")
+              field.slice!(0)
+              search[field] = "^"
+            else
+              search[field] = "@"
+            end
+          end
+        end
+      end
+
+      def typus_application
+        read_model_config['application'] || 'Unknown'
+      end
+
+      def typus_field_options_for(filter)
+        options = read_model_config['fields']['options']
+        options && options[filter.to_s] ? options[filter.to_s].extract_settings.map { |i| i.to_sym } : []
+      end
+
+      #--
+      # With Typus::Resources we some application defaults.
+      #
+      #     Typus::Resources.setup do |config|
+      #       config.per_page = 15
+      #     end
+      #
+      # If for any reason we need a better default for an specific resource we
+      # we override it on `application.yaml`.
+      #
+      #     Post:
+      #       ...
+      #       options:
+      #         per_page: 15
+      #++
+      def typus_options_for(filter)
+        options = read_model_config['options']
+
+        unless options.nil? || options[filter.to_s].nil?
+          options[filter.to_s]
+        else
+          Typus::Resources.send(filter)
+        end
+      end
+
+      def typus_export_formats
+        read_model_config['export'].try(:extract_settings) || []
+      end
+
+      def typus_order_by
+        typus_defaults_for(:order_by).map do |field|
+          field.include?('-') ? "#{table_name}.#{field.delete('-')} DESC" : "#{table_name}.#{field} ASC"
+        end.join(', ')
+      end
+
+      #--
+      # Define our own boolean mappings.
+      #
+      #     Post:
+      #       fields:
+      #         default: title, status
+      #         options:
+      #           booleans:
+      #             status: "Published", "Not published"
+      #
+      #++
+      def typus_boolean(attribute = :default)
+        options = read_model_config['fields']['options']
+
+        boolean = if options && options['booleans'] && boolean = options['booleans'][attribute.to_s]
+                    boolean.is_a?(String) ? boolean.extract_settings : boolean
+                  else
+                    ["True", "False"]
+                  end
+
+        [[boolean.first, "true"], [boolean.last, "false"]]
+      end
+
+      #--
+      # Custom date formats.
+      #++
+      def typus_date_format(attribute = :default)
+        options = read_model_config['fields']['options']
+        if options && options['date_formats'] && options['date_formats'][attribute.to_s]
+          options['date_formats'][attribute.to_s].to_sym
+        else
+          :default
+        end
+      end
+
+      #--
+      # This is user to use custome templates for attribute:
+      #
+      #     Post:
+      #       fields:
+      #         form: title, body, status
+      #         options:
+      #           templates:
+      #             body: rich_text
+      #
+      # Templates are stored on <tt>app/views/admin/templates</tt>.
+      #++
+      def typus_template(attribute)
+        options = read_model_config['fields']['options']
+        if options && options['templates'] && options['templates'][attribute.to_s]
+          options['templates'][attribute.to_s]
+        end
+      end
+
+      def adapter
+        @adapter ||= ::ActiveRecord::Base.configurations[Rails.env]['adapter']
+      end
+
+      def typus_user_id?
+        columns.map { |u| u.name }.include?(Typus.user_fk)
+      end
+
+      def read_model_config
+        Typus::Configuration.config[name] or raise "No typus configuration specified for #{name}"
+      end
+
+      #--
+      #     >> Post.to_resource
+      #     => "posts"
+      #     >> Admin::User.to_resource
+      #     => "admin/users"
+      #++
+      def to_resource
+        name.underscore.pluralize
+      end
+
+    end
+  end
+end