typus-rails4 4.0.0.beta6

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

@@ -0,0 +1,76 @@
+module Typus
+  module Orm
+    module ActiveRecord
+      module InstanceMethods
+
+        def to_label
+          email
+        end
+
+        def resources
+          Typus::Configuration.roles[role.to_s].compact
+        end
+
+        def models
+          Typus.models.delete_if { |m| cannot?('read', m) }
+        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.to_s
+
+          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 active?
+          status && Typus::Configuration.roles.has_key?(role)
+        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_foreign_key)
+        end
+
+        def set_token
+          token = "#{SecureRandom.hex(6)}-#{SecureRandom.hex(6)}"
+          token.encode!('UTF-8') if token.respond_to?(:encode)
+          self.token = token
+        end
+        protected :set_token
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Typus
+  module Orm
+    module ActiveRecord
+      module Search
+
+        include Typus::Orm::Base::Search
+
+        def build_search_conditions(key, value)
+          data = Array.new.tap do |search|
+            query = ::ActiveRecord::Base.connection.quote_string(value.downcase)
+
+            typus_search_fields.each do |local_key, local_value|
+              _query = case local_value
+                       when '=' then query
+                       when '^' then "#{query}%"
+                       when '@' then "%#{query}%"
+                       end
+
+              column_name = (local_key.match('\.') ? local_key : "#{table_name}.#{local_key}")
+              table_key = (adapter == 'postgresql') ? "LOWER(TEXT(#{column_name}))" : "#{column_name}"
+
+              search << "#{table_key} LIKE '#{_query}'"
+            end
+          end
+
+          data.join(' OR ')
+        end
+
+        # TODO: Use Rails scopes to build the search: where(key => interval)
+        def build_filter_interval(interval, key)
+          ["#{table_name}.#{key} BETWEEN ? AND ?", interval.first.to_s(:db), interval.last.to_s(:db)]
+        end
+
+        def build_my_joins(params)
+          query_params = params.dup
+          query_params.reject! { |k, _| !model_relationships.keys.include?(k.to_sym) }
+          query_params.compact.map { |k, _| k.to_sym }
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+module Typus
+  module Orm
+    module Base
+      module ClassMethods
+
+        # 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_scopes
+          typus_defaults_for(:scopes).reject { |s| !respond_to?(s) }
+        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
+          name = read_model_config['application'] || 'Unknown'
+          name.extract_settings.first
+        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(&:to_sym) : []
+        end
+
+        #--
+        # With +Typus::Resources.setup+ we can define application defaults.
+        #
+        #     Typus::Resources.setup do |config|
+        #       config.per_page = 25
+        #     end
+        #
+        # If for any reason we need a better default for an specific resource we
+        # can override it on +application.yaml+.
+        #
+        #     Post:
+        #       ...
+        #       options:
+        #         per_page: 25
+        #++
+        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_order_by
+          typus_defaults_for(:order_by).map do |field|
+            field.include?('-') ? "#{field.delete('-')} DESC" : "#{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.connection_config[:adapter]
+        end
+
+        def typus_user_id?
+        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
+
+        def custom_attribute?(field)
+          case field.to_s
+          when 'parent', 'parent_id' then :tree
+          when /password/            then :password
+          when /\./                  then :transversal
+          end
+        end
+
+        def virtual_fields
+          (instance_methods - model_fields.keys).map(&:to_s)
+        end
+
+      end
+    end
+  end
+end

data/lib/typus/orm/base/search.rb

@@ -0,0 +1,70 @@
+module Typus
+  module Orm
+    module Base
+      module Search
+
+        def build_search_conditions(key, value)
+          raise 'Not implemented!'
+        end
+
+        def build_boolean_conditions(key, value)
+          { key => (value == 'true') ? true : false }
+        end
+
+        def build_date_conditions(key, value)
+          if %w(all_day all_week all_month all_year).include?(value)
+            interval = Time.zone.now.send(value)
+            build_filter_interval(interval, key)
+          else
+            raise "#{value} is not allowed!"
+          end
+        end
+
+        alias_method :build_datetime_conditions, :build_date_conditions
+        alias_method :build_timestamp_conditions, :build_date_conditions
+
+        def build_filter_interval(interval, key)
+          raise 'Not implemented!'
+        end
+
+        def build_string_conditions(key, value)
+          { key => value }
+        end
+
+        alias_method :build_integer_conditions, :build_string_conditions
+        alias_method :build_belongs_to_conditions, :build_string_conditions
+
+        # TODO: Detect the primary_key for this object.
+        def build_has_many_conditions(key, value)
+          ["#{key}.id = ?", value]
+        end
+
+        # To build conditions we accept only model fields and the search
+        # param.
+        def build_conditions(params)
+          Array.new.tap do |conditions|
+            query_params = params.dup
+
+            query_params.reject! do |k, v|
+              !model_fields.keys.include?(k.to_sym) &&
+              !model_relationships.keys.include?(k.to_sym) &&
+              !(k.to_sym == :search)
+            end
+
+            query_params.compact.each do |key, value|
+              filter_type = model_fields[key.to_sym] || model_relationships[key.to_sym] || key
+              conditions << send("build_#{filter_type}_conditions", key, value)
+            end
+          end
+        end
+
+        def build_my_joins(params)
+          query_params = params.dup
+          query_params.reject! { |k, _| !model_relationships.keys.include?(k.to_sym) }
+          query_params.compact.map { |k, _| k.to_sym }
+        end
+
+      end
+    end
+  end
+end

data/lib/typus/regex.rb

@@ -0,0 +1,11 @@
+module Typus
+  module Regex
+
+    Email = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/
+
+    Domain = /^(((?:[-a-z0-9]+\.)+[a-z]{2,}))/
+
+    Url = /(^$)|(^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$)/ix
+
+  end
+end

data/lib/typus/resources.rb

@@ -0,0 +1,55 @@
+module Typus
+  module Resources
+
+    # Usage:
+    #
+    #     Typus::Resources.setup do |config|
+    #       config.default_action_on_item = 'index'
+    #     end
+    #
+    def self.setup
+      yield self
+    end
+
+    mattr_accessor :default_action_on_item
+    @@default_action_on_item = 'edit'
+
+    mattr_accessor :end_year
+    @@end_year = nil
+
+    mattr_accessor :form_rows
+    @@form_rows = 15
+
+    mattr_accessor :minute_step
+    @@minute_step = nil
+
+    mattr_accessor :only_user_items
+    @@only_user_items = false
+
+    mattr_accessor :per_page
+    @@per_page = 20
+
+    mattr_accessor :sortable
+    @@sortable = true
+
+    mattr_accessor :start_year
+    @@start_year = nil
+
+    mattr_accessor :hide_from_sidebar
+    @@hide_from_sidebar = false
+
+    mattr_accessor :hide_from_dashboard
+    @@hide_from_dashboard = false
+
+    mattr_accessor :export
+    @@export = ''
+
+    mattr_accessor :counters
+    @@counters = false
+
+    def self.method_missing(*args)
+      nil
+    end
+
+  end
+end