brainsome_typus 4.0.0.beta1

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

@@ -0,0 +1,184 @@
+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 'position'            then :position
+          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, v| !model_relationships.keys.include?(k.to_sym) }
+          query_params.compact.map { |k, v| 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 = 25
+
+    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

data/lib/typus/version.rb

@@ -0,0 +1,10 @@
+module Typus
+  module VERSION
+    MAJOR = 4
+    MINOR = 0
+    TINY  = 0
+    PRE   = "beta1"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/typus.rb

@@ -0,0 +1,212 @@
+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 :admin_title
+  @@admin_title = "Typus"
+
+  mattr_accessor :admin_title_link
+  @@admin_title_link = nil
+
+  mattr_accessor :admin_sub_title
+  @@admin_sub_title = <<-CODE
+<a href="http://core.typuscmf.com/">core.typuscmf.com</a>
+  CODE
+
+  # 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
+    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
+
+  end
+
+end

data/typus.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typus/version'
+
+files = Dir['**/*'].keep_if{|file| File.file?(file)}
+test_files = Dir['test/**/*'].keep_if{|file| File.file?(file)}
+ignores = Dir['doc/**/*'].keep_if{|file| File.file?(file)} + %w(.travis.yml .gitignore)
+
+Gem::Specification.new do |spec|
+  spec.name          = "brainsome_typus"
+  spec.version       = Typus::VERSION::STRING
+  spec.authors       = ["Francesc Esplugas", "Brainsome-Developers"]
+  spec.email         = ["support@typuscmf.com", nil]
+  spec.description   = "Ruby on Rails Admin Panel (Engine) to allow trusted users edit structured content."
+  spec.summary       = "Effortless backend interface for Ruby on Rails applications. (Admin scaffold generator)"
+  spec.homepage      = "http://github.com/torial/typus"
+  spec.license       = "MIT"
+
+  spec.platform = Gem::Platform::RUBY
+
+  spec.files         = files - test_files - ignores
+  spec.test_files    = []
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_rubygems_version = '>= 1.8.11'
+
+  spec.add_dependency "bcrypt-ruby", "~> 3.1.2"
+  spec.add_dependency "jquery-rails"
+  spec.add_dependency "rails", "~> 4"
+end