browsercms-artirix 4.0.0.rc1.art4

data/lib/cms/concerns/can_be_addressable.rb

@@ -0,0 +1,326 @@
+module Cms
+  module Concerns
+    module CanBeAddressable
+
+      # Adds Addressable behavior to a model. This allows models to be inserted into the sitemap, having parent
+      # sections. By default, this method is available to all ActiveRecord::Base classes.
+      #
+      # @params [Hash] options
+      # @option options [String] :path The base path where instances will be placed.
+      # @option options [String] :no_dynamic_path Set as true if the Record has a :path attribute managed as a column in the db. (Default: false)
+      # @option options [Symbol] :destroy_if Name of a custom method used to determine when this object should be destroyed. Rather than dependant: destroy to determine if the section node should be destroyed when this object is.
+      def is_addressable(options={})
+        has_one_options = {as: :node, inverse_of: :node, class_name: 'Cms::SectionNode', validate: true}
+        unless options[:destroy_if]
+          has_one_options[:dependent] = :destroy
+        else
+          before_destroy options[:destroy_if]
+          after_destroy :destroy_node
+        end
+
+        has_one :section_node, has_one_options
+        # For reasons that aren't clear, just using :autosave doesn't work.
+        after_save do
+          if section_node && section_node.changed?
+            section_node.save
+          end
+        end
+
+        after_validation do
+          # Copy errors from association for slug
+          if section_node && !section_node.valid?
+            section_node.errors[:slug].each do |message|
+              errors.add(:slug, message)
+            end
+          end
+        end
+
+        include Cms::Concerns::Addressable
+        extend Cms::Concerns::Addressable::ClassMethods
+        include Cms::Concerns::Addressable::NodeAccessors
+        include Cms::Concerns::Addressable::MarkAsDirty
+        extend Cms::Configuration::ConfigurableTemplate
+
+        if options[:path]
+          @path = options[:path]
+          include GenericSitemapBehavior
+        end
+
+        @template = options[:template]
+
+        unless options[:no_dynamic_path]
+          include Addressable::DynamicPath
+        end
+      end
+
+      # @return [Boolean] Until is_addressable is called, this will always be false.
+      def addressable?
+        false
+      end
+
+      # @return [Boolean] Some addressable content types don't require a slug.
+      def requires_slug?
+        false
+      end
+    end
+
+    # Implements behavior for displaying content blocks that should appear in the sitemap.
+    #
+    module GenericSitemapBehavior
+      def self.included(klass)
+        klass.before_validation :assign_parent_if_needed
+      end
+
+      def partial_for
+        "addressable_content_block"
+      end
+
+      def hidden?
+        false
+      end
+
+      def assign_parent_if_needed
+        unless parent || parent_id
+          new_parent = Cms::Section.with_path(self.class.path).first
+
+          unless new_parent
+            logger.warn "Creating default section for #{self.try(:display_name)} in #{self.class.path}."
+            section_attributes = {:name => self.class.name.demodulize.pluralize,
+                                  :path => self.class.path,
+                                  :hidden => true,
+                                  allow_groups: :all}
+            section_parent = Cms::Section.root.first
+            if section_parent
+              section_attributes[:parent] = section_parent
+            end
+            new_parent = Cms::Section.create!(section_attributes)
+          end
+          self.parent_id = new_parent.id
+        end
+      end
+    end
+
+    module Addressable
+
+      module ClassMethods
+
+        def requires_slug?
+          !@path.nil?
+        end
+
+        # The base path where new records will be added.
+        # @return [String]
+        def path
+          @path
+        end
+
+        # @return [Boolean] Once is_addressable is called, this will always be true.
+        def addressable?
+          true
+        end
+
+        def calculate_path(slug)
+          "#{self.path}/#{slug}"
+        end
+
+        # Used in UI forms to show what the complete URL will look like with a slug added to it.
+        def base_path
+          "#{self.path}/"
+        end
+
+        # Find an addressable object with the given content type.
+        #
+        # @param [String] slug
+        # @return [Addressable] The content block with that slug (if it exists). Nil otherwise
+        def with_slug(slug)
+          section_node = SectionNode.where(slug: slug).where(node_type: self.name).first
+          section_node ? section_node.node : nil
+        end
+
+        # Returns the layout (Page Template) that should be used to render instances of this content.
+        # Can be specified as is_addressable template: 'subpage'
+        # @return [String] template/default unless template was set.
+        def layout
+          normalize_layout(self, @template)
+        end
+      end
+
+      module DynamicPath
+
+        # @return [String] The relative path to this content
+        def path
+          self.class.calculate_path(slug)
+        end
+
+        def slug
+          if section_node
+            section_node.slug
+          else
+            nil
+          end
+        end
+
+        def slug=(slug)
+          if section_node
+            section_node.slug = slug
+          else
+            @slug = slug # Store temporarily until there is a section_node created.
+          end
+          dirty!
+        end
+      end
+
+      # Resources are accessible to guests if their parent section is. Variables are passed in for performance reasons
+      # since this gets called 'MANY' times on the sitemap.
+      #
+      # @param [Array<Section>] public_sections
+      # @param [Section] parent
+      def accessible_to_guests?(public_sections, parent)
+        public_sections.include?(parent)
+      end
+
+      # Returns all classes which need a custom route to show themselves.
+      def self.classes_that_require_custom_routes
+        descendants.select { |klass| klass.path != nil }
+      end
+
+      # List of all classes that can be in the sitemap.
+      #
+      # @return [Array<Class>] Returns all classes which inherit from Cms::Concerns::Addressable
+      def self.descendants
+        ObjectSpace.each_object(::Class).select { |klass| klass < Cms::Concerns::Addressable }
+      end
+
+      # Allows for manual destruction of node
+      def destroy_node
+        node.destroy
+      end
+
+      # Whether or not this content is the 'landing' page for its section.
+      #
+      # @return [Boolean] false always, since a content block won't ever be the landing page for the section
+      def landing_page?
+        false
+      end
+
+      # Returns the value that will appear in the <title> element of the page when this content is rendered.
+      # Subclasses can override this.
+      #
+      # @return [String]
+      # @example Override the page title
+      #   class MyWidget < ActiveRecord::Base
+      #     def page_title
+      #       "My Widget | #{name}"
+      #     end
+      #   end
+      def page_title
+        name
+      end
+
+      # Returns a list of all Addressable objects that are ancestors to this record.
+      # @param [Hash] options
+      # @option [Symbol] :include_self If this object should be included in the Array
+      # @return [Array<Addressable>] Or [] if no ancestors and/or has no parent.
+      #
+      def ancestors(options={})
+        return [] unless node
+        ancestor_nodes = node.ancestors
+        ancestors = ancestor_nodes.collect { |node| node.node }
+        ancestors << self if options[:include_self]
+        ancestors
+      end
+
+      def parent
+        @parent if @parent
+        node ? node.section : nil
+      end
+
+      def cache_parent(section)
+        @parent = section
+      end
+
+      def parent_id
+        parent.try(:id)
+      end
+
+      def parent_id=(id)
+        self.parent = Cms::Section.find(id)
+        # Handles slug being set before there is a parent
+        if @slug
+          self.slug = @slug
+          @slug = nil
+        end
+      end
+
+      def parent=(sec)
+        if node
+          node.move_to_end(sec)
+        else
+          build_section_node(:node_id => self.id, :section => sec)
+        end
+      end
+
+      # Computes the name of the partial used to render this object in the sitemap.
+      def partial_for
+        self.class.name.demodulize.underscore
+      end
+
+      # alias :node, :section_node
+      module NodeAccessors
+        def node
+          section_node
+        end
+
+        def node=(n)
+          self.section_node = n
+        end
+      end
+
+      # These exist for backwards compatibility to avoid having to change tests.
+      # I want to get rid of these in favor of parent and parent_id
+      module DeprecatedPageAccessors
+
+        def self.included(model_class)
+          #model_class.attr_accessible :section_id, :section
+        end
+
+
+        def build_node(opts)
+          build_section_node(opts)
+        end
+
+        def section_id
+          section ? section.id : nil
+        end
+
+        def section_id=(sec_id)
+          self.section = Section.find(sec_id)
+        end
+
+        def section
+          parent
+        end
+
+        def section=(sec)
+          self.parent = sec
+
+        end
+      end
+
+      # Allows records to be marked as being changed, which can be called to trigger updates when
+      # associated objects may have been changed.
+      module MarkAsDirty
+        # Forces this record to be changed, even if nothing has changed
+        # This is necessary if just the section.id has changed, for example
+        # test if this is necessary now that the attributes are in the
+        # model itself.
+        def dirty!
+          # Seems like a hack, is there a better way?
+          self.updated_at = Time.now
+        end
+      end
+    end
+
+
+  end
+end

data/lib/cms/concerns/has_content_type.rb

@@ -0,0 +1,46 @@
+module Cms
+  module Concerns
+    module HasContentType
+
+      # Adds ContentType information to the object.
+      # @param [Hash] options
+      # @option options [Symbol] :module The module name, same as would be passed to content_module()
+      def has_content_type(options={})
+        include InstanceMethods
+        extend ClassMethods
+
+        if options[:module]
+          content_module options[:module]
+        end
+
+      end
+
+      # Used as a marker for finding classes that implement Content Types.
+      module InstanceMethods
+
+      end
+
+      module ClassMethods
+
+        # Returns the Cms::ContentType which provides information about the content.
+        def content_type
+          Cms::ContentType.new(name: self.name)
+        end
+
+        # Allows a content block to configure which module it will be placed in.
+        # @param [Symbol] module_name (Optional) Sets value if provided.
+        # @return [Symbol] module_name
+        def content_module(module_name=nil)
+          if module_name
+            @module_name = module_name
+          end
+          if @module_name
+            @module_name
+          else
+            :general
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cms/concerns/ignores_publishing.rb

@@ -0,0 +1,9 @@
+# Allows content types (like Category) to be handled as blocks.
+# Intended as temporary
+module Cms::Concerns::IgnoresPublishing
+
+  # Needs due to content controller automatically setting a default 'publish_on_save: false' when creating content.
+  def self.included(klass)
+    klass.send :attr_accessor, :publish_on_save
+  end
+end

data/lib/cms/concerns.rb

@@ -0,0 +1,7 @@
+# Each concern should be automatically added to each ActiveRecord class using extend.
+module Cms::Concerns; end
+
+Dir["#{File.dirname(__FILE__)}/concerns/*.rb"].each do |b|
+  require File.join("cms", "concerns", File.basename(b, ".rb"))
+  ActiveRecord::Base.extend "Cms::Concerns::#{File.basename(b, ".rb").camelize}".constantize
+end

data/lib/cms/configuration/configurable_template.rb

@@ -0,0 +1,24 @@
+module Cms
+  module Configuration
+
+    # Handles content that has configurable templates. Use the following rails configuration:
+    #
+    #   config.cms.templates['cms/form'] = 'my-form-layout'
+    #   config.cms.templates['cms/sites/sessions_controller'] = :subpage
+    module ConfigurableTemplate
+
+      # Given a class name return a layout file path.
+      # Looks in app.config.cms.templates first, then for the explicit_template
+      def normalize_layout(klass, explicit_template)
+        found = Rails.configuration.cms.templates[klass.name.underscore]
+        if found
+          "templates/#{found}"
+        elsif explicit_template
+          "templates/#{explicit_template}"
+        else
+          "templates/default"
+        end
+      end
+    end
+  end
+end

data/lib/cms/configuration/devise.rb

@@ -0,0 +1,256 @@
+# Happens before configuration in applications, so these values can be overridden.
+Devise.setup do |config|
+
+  # Tells devise to use routing instructions in Cms::Engine.
+  # See https://github.com/plataformatec/devise/wiki/How-To:-Use-devise-inside-a-mountable-engine for details.
+  config.router_name = :cms
+
+  # BrowserCMS apps will have their own secret_key.
+  #config.secret_key = ''
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  config.authentication_keys = [ :login ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :login ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :login ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication. The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = '51e7553dae80619e2250975968e7ac4d42519f981ea000f0f2fffbce0cd5e0c0e2229e228aec17fb051498f25ae827c2195bcc3bbdd2a68722758579f9ef0024'
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 8..128.
+  config.password_length = 8..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = false
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: '/my_engine'
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+end