atreides 2.0.0

data/lib/atreides.rb

@@ -0,0 +1,82 @@
+require 'inherited_resources'
+require 'haml'
+require 'formtastic'
+require 'settingslogic'
+require 'will_paginate'
+require 'acts_as_commentable'
+require 'validates_email_format_of'
+require 'dropbox_sdk'
+require 'analytical'
+require 'jquery-rails'
+require 'aws/s3'
+require 'devise'
+require 'oauth2'
+
+require 'cancan'
+# TODO: pull request in CanCan
+module CanCan
+  # For use with Inherited Resources
+  class InheritedResource < ControllerResource # :nodoc:
+    # defer this directly to Inherited Resources
+    def load_collection
+      @controller.send(:collection)
+    end
+
+    def resource_instance=(instance)
+    end
+
+    # def resource_instance
+    #   @controller.send(:resource) if load_instance?
+    # end
+
+    def collection_instance=(instance)
+    end
+
+    def collection_instance
+      @controller.send :collection
+    end
+  end
+end
+
+require File.expand_path('atreides/engine', File.dirname(__FILE__)) if defined?(Rails) && Rails::VERSION::MAJOR == 3
+
+require "acts-as-taggable-on"
+require "paperclip"
+require "dynamic_form"
+require "gattica"
+require "delayed_job"
+require 'mini_fb'
+
+[ 'atreides/configuration',
+  'atreides/extendable',
+  'atreides/validators',
+  'atreides/time_formats',
+  "atreides/i18n_helpers",
+  'atreides/base/base',
+  'atreides/base/taggable',
+  'atreides/base/aasmstates',
+  'atreides/base/validation',
+].each do |path|
+  require File.expand_path(path, File.dirname(__FILE__))
+end
+
+module Atreides
+  class << self
+
+    # Modify configuration
+    # Example:
+    #   Atreides.configure do |config|
+    #     config.user_model = 'MyUser'
+    #   end
+    def configure
+      yield configuration
+    end
+
+    # Accessor for Atreides::Configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias :config :configuration
+
+  end
+end

data/lib/atreides/base/aasmstates.rb

@@ -0,0 +1,117 @@
+module Atreides
+  class Base < ActiveRecord::Base
+
+    #
+    # Common class responsible for the management of Atreides model states. The focus is on managing the states between creation and publication of content.
+    #
+    module AasmStates
+      def self.included(recipient)
+        recipient.class_eval do
+          require 'aasm'
+          include ::AASM
+          aasm_column :state
+          aasm_initial_state :pending
+          aasm_state :pending
+          aasm_state :drafted
+          aasm_state :queued
+          aasm_state :published, :enter => :do_publish
+
+          aasm_event :publish do
+            transitions :from => [:pending, :drafted, :queued], :to => :published
+          end
+
+          aasm_event :draft do
+            transitions :from => [:pending, :published, :queued], :to => :drafted
+          end
+
+          aasm_event :queue do
+            transitions :from => [:pending, :published, :drafted], :to => :queued
+          end
+
+          #
+          # Validation
+          #
+          validates :state, :inclusion => { :in => aasm_states.map(&:name).compact.map(&:to_s) }
+
+          #
+          # Scopes
+          #
+          aasm_states.map(&:name).each do |state|
+            scope state, where(:state => state.to_s)
+          end
+
+          scope :by_state, lambda { |state|
+            where(:state => state.to_s)
+          }
+
+          scope :live, lambda {
+            # Needs to be sep variable or AR will cache the first time and it'll never change
+            where("#{table_name}.state = 'published' and #{table_name}.published_at <= ?", Time.zone.now)
+          }
+
+          #
+          # Callbacks
+          #
+          after_initialize :set_initial_state
+
+          # Make sure that the state of all objects are set after initialization
+          def set_initial_state
+            # Touch the state attribute and if missing reload
+            self.state rescue self.reload
+
+            self.state ||= self.class.aasm_initial_state
+          end
+
+          before_validation :stringify_state
+          def stringify_state
+            self.state = state.to_s if state?
+          end
+
+          #
+          # Methods
+          #
+
+          # Create a list if states used in a HTML select drop-down
+          def states_for_select
+            [
+              [I18n.t(:publish_now,  :scope => [:model, :states]).capitalize, :publish_now],
+              [I18n.t(:drafted,      :scope => [:model, :states]).capitalize, :drafted],
+              # ["Add to queue", :queued],
+              [I18n.t(:published_at, :scope => [:model, :states]).capitalize, :published_at]
+            ]
+          end
+
+          # Set state.
+          # If the value is 'published' then update the published_at attribute to now
+          def state=(value)
+            case value.to_s.to_sym
+            when :publish_now
+              self[:state] = "published"
+              self.published_at = Time.zone.now
+            when :published_at
+              self[:state] = "published"
+            else
+              self[:state] = value if self.class.aasm_states.map(&:name).include?(value.to_s.to_sym)
+            end
+          end
+
+          # Has this object been published? Is it live?
+          def live?
+            self.published? and self.published_at? and self.published_at < Time.zone.now
+          end
+
+          # Is this object schedule to be published on a date?
+          def publish_on_date?
+            self.published? and self.published_at?
+          end
+
+          private
+
+          # Override this in local models
+          def do_publish
+          end
+        end
+      end
+    end
+  end
+end

data/lib/atreides/base/base.rb

@@ -0,0 +1,40 @@
+module Atreides
+
+  # Base class inherited by every model in Atreides
+  class Base < ActiveRecord::Base
+
+    #
+    # Includes
+    #
+    include ActiveModel::Validations
+
+    #
+    # Class definitions
+    #
+    self.abstract_class = true
+
+    # Give a string identifying the model based on it's properties.
+    # In order:
+    # - _slug_ if it has a property *slug*
+    # - _id-name_ if it has a property *name*
+    # - _id-title_ if it has a property *title*
+    # - _id_ otherwise
+    # @return A string describing an instance of a model
+    def to_param
+      return slug.to_s if self.respond_to?(:slug) and !slug.blank?
+      return "#{id}-#{name.to_s.parameterize}" if self.respond_to?(:name) and self.name?
+      return "#{id}-#{title.to_s.parameterize}" if self.respond_to?(:title) and self.title?
+      id.to_s
+    end
+
+    # Give a DOM friendly ID for an object. This is used extensively with UI Javascript behaviours.
+    # @param [Prefix] prefix the id with a custom name. Defaults to the objects model name.
+    # @return [String] the dom id
+    def dom_id(prefix=nil)
+      display_id = new_record? ? "new" : id
+      prefix ||= self.class.name.demodulize
+      prefix != :bare ? "#{prefix.to_s.parameterize('_')}_#{display_id}" : display_id
+    end
+
+  end
+end

data/lib/atreides/base/taggable.rb

@@ -0,0 +1,43 @@
+module Atreides
+  class Base < ActiveRecord::Base
+
+    #
+    # Module providing common tagging functionality. Uses the _acts_as_taggable_ mixin.
+    #
+    module Taggable
+      def self.included(recipient)
+        recipient.class_eval do
+
+          # Throws errors if table doesn't exist on first project setup
+          if recipient.table_exists?
+            acts_as_taggable
+
+            if Rails.env.development? || Rails.env.staging?
+              Settings.load! # Needed for dev env when reloading class caches
+            end
+
+            if defined?(Settings.tags[self.table_name]) && defined?(Settings.tags[self.table_name]['groups'])
+              acts_as_taggable_on Settings.tags[self.table_name]['groups']
+              scope :tagged, lambda { |tags|
+                tags_sql = tags.is_a?(Array) ? tags.map{|t|"'#{t}'"}.join(",") : "'#{tags}'"
+                select("#{table_name}.*").
+                joins("JOIN taggings ON taggings.taggable_id = #{table_name}.id AND taggings.taggable_type IN ('#{to_s}')").
+                where("taggings.tag_id in (SELECT id from tags where LOWER(name) IN (#{tags_sql.downcase}))")
+              }
+            end
+          end
+
+          # Add callback to normalize tags
+          before_save :normalize_tags
+
+          private
+
+          def normalize_tags
+            self.tag_list = self.tag_list.map(&:parameterize)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/atreides/base/validation.rb

@@ -0,0 +1,23 @@
+module Atreides
+  class Base < ActiveRecord::Base
+
+    #
+    # Module providing common validations functionality.
+    #
+    module Validation
+      def self.included(recipient)
+        recipient.class_eval do
+          before_validation :update_slug
+
+          # Sets the object's slug. Slugs are used to create SEO friendly URLs.
+          def update_slug
+            # Set slug if not set
+            if respond_to?(:slug) and respond_to?(:title)
+              self.slug = title? ? title.parameterize : id if !slug? or slug.match(/^\d+$/)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/atreides/configuration.rb

@@ -0,0 +1,61 @@
+class Atreides::Configuration
+  attr_accessor :user_model
+  attr_accessor :admin_route_prefix
+  attr_accessor :admin_route_redirect
+
+  @@overrides ||= {}
+  @@overriden_from ||= {}
+
+  # Configuration defaults
+  def initialize
+    @user_model           = 'User'
+    @admin_route_prefix   = 'admin'
+    @admin_route_redirect = "/#{@admin_route_prefix}/pages"
+  end
+
+  def overrides
+    @@overrides
+  end
+
+  def override *args
+    from = caller[0]
+    overrides = args.extract_options!
+    args.each { |arg| overrides[arg] = arg.to_sym }
+    overrides.each do | atreides_classname, host_concern_name |
+      unless atreides_classname.to_s.starts_with? 'Atreides::'
+        atreides_classname = "Atreides::#{atreides_classname}"
+      end
+      @@overrides[atreides_classname.to_sym] = [] if @@overrides[atreides_classname.to_sym].nil?
+      @@overrides[atreides_classname.to_sym] << host_concern_name
+      @@overriden_from[atreides_classname.to_sym] = from
+    end
+  end
+
+  def inject_overrides atreides_class
+    # Rails.logger.debug { "Injecting overrides in class #{atreides_class.inspect} !" }
+
+    modules = @@overrides[atreides_class.to_s.to_sym] || []
+
+    modules.uniq.each do |hostapp_module_name|
+      begin
+        host_module = hostapp_module_name.to_s.constantize
+        # puts "\t\tInjecting #{host_module} into #{atreides_class}"
+        atreides_class.instance_eval {
+          include host_module
+        }
+      rescue NameError => e
+        from = @overriden_from[atreides_class.to_s.to_sym] rescue "---"
+        puts <<-ERR
+        Atreides configuration error !
+        Following Atreides's configuration, here: #{from.inspect}
+
+        Atreides's' '#{atreides_class.to_s}' class should be overriden by a class named #{hostapp_module_name.inspect}.
+
+        This #{hostapp_module_name.inspect} class could not be loaded !
+
+        ERR
+        raise e
+      end
+    end
+  end
+end

data/lib/atreides/engine.rb

@@ -0,0 +1,41 @@
+require "rails"
+
+module Atreides
+  class Engine < Rails::Engine
+    paths['db/migrate']         = 'db/migrate'
+    # paths['atreides/base']    = 'atreides/base'
+    paths['app/inputs'] = 'app/inputs'
+
+    # Since the database can't be set up when running the generators,
+    # we move the models path to autoload instead of eager_load.
+    # otherwise, we would get "could not find table 'xxxx'" exceptions.
+    config.eager_load_paths -= [ paths["app/models"].first ]
+    config.autoload_paths << paths["app/models"].first
+    config.autoload_paths += %W(#{Rails.root}/app/atreides/models)
+    config.eager_load_paths += [ paths["app/inputs"].first ]
+
+    # Force routes to be loaded if we are doing any eager load.
+    config.before_eager_load { |app| app.reload_routes! }
+
+    initializer :load_overrides do
+      filename = File.expand_path('config/initializers/overrides', Rails.root)
+      require filename if File.exists?(filename)
+    end
+
+    initializer "atreides.asset_pipeline" do |app|
+      app.config.assets.precompile += %w( atreides/admin_edit.js atreides/admin.js atreides/public.js atreides/admin.css atreides/public.css )
+    end
+
+    initializer 'atreides.formtastic.inputs' do
+      load_path = paths['app/inputs'].first
+      matcher = /\A#{Regexp.escape(load_path)}\/(.*)\.rb\Z/
+      Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
+        require_dependency file.sub(matcher, '\1')
+      end
+    end
+
+    rake_tasks do
+      load 'atreides/railties/tasks.rake'
+    end
+  end
+end