benmanns-atreides 2.0.4

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

data/lib/atreides/extendable.rb

@@ -0,0 +1,12 @@
+module Atreides
+    module Extendable
+      extend ActiveSupport::Concern
+
+      included do |base|
+        base.class_exec {
+          public
+          Atreides.configuration.inject_overrides base
+        }
+      end
+    end
+end

data/lib/atreides/i18n_helpers.rb

@@ -0,0 +1,65 @@
+require 'unicode_utils'
+
+module Atreides
+
+  # Implement a series of helpers to translate Atreides.
+  # These are injected into ActionView::Helpers::TranslationHelper
+  module I18nHelpers
+
+    def self.included(recipient)
+      recipient.class_eval do
+
+        def atreides_translate *args
+          options = args.extract_options!
+          scope_ = options.fetch(:scope, [])
+          # puts "ttt: #{args[0]}, scope_: #{scope_.inspect}"
+          if args[0].to_s.starts_with?('.') && scope_.include?('atreides')
+            # puts "already correctly scoped"
+            args << options
+            translate(*args)
+          else
+            # puts "re-scoping"
+            raise "NotImplemented" unless scope_.empty?
+            options[:scope] = 'atreides'
+            args << options
+            translate(*args)
+          end
+        end
+
+        def capitalize(str)
+          str.sub str.first, UnicodeUtils.upcase(str.first, I18n.locale)
+        end
+
+        def atreides_translate_capitalize(*args)
+          capitalize atreides_translate(*args)
+        end
+
+        def atreides_translate_titleize(*args)
+          if I18n.locale == :en
+            UnicodeUtils.titlecase atreides_translate(*args), I18n.locale
+          else
+            capitalize atreides_translate(*args)
+          end
+        end
+
+        alias :tt :atreides_translate
+        alias :ttc :atreides_translate_capitalize
+        alias :ttt :atreides_translate_titleize
+
+        if recipient.respond_to? :helper_method
+          helper_method :atreides_translate, :atreides_translate_capitalize, :atreides_translate_titleize
+          helper_method :tt, :ttc, :ttt
+        end
+      end
+    end
+  end
+end
+
+module ActionView
+  module Helpers
+    module TranslationHelper
+      unloadable
+      include Atreides::I18nHelpers
+    end
+  end
+end

data/lib/atreides/railties/tasks.rake

@@ -0,0 +1,68 @@
+module ActiveRecord
+  class Migration
+    class << self
+      def copy(destination, sources, options = {})
+        copied = []
+
+        FileUtils.mkdir_p(destination) unless File.exists?(destination)
+
+        destination_migrations = ActiveRecord::Migrator.migrations(destination)
+        last = destination_migrations.last
+        sources.each do |name, path|
+          source_migrations = ActiveRecord::Migrator.migrations(path)
+
+          source_migrations.each do |migration|
+            source = File.read(migration.filename)
+            source = "# This migration comes from #{name} (originally #{migration.version})\n#{source}"
+
+            if duplicate = destination_migrations.detect { |m| m.name == migration.name }
+              options[:on_skip].call(name, migration) if File.read(duplicate.filename) != source && options[:on_skip]
+              next
+            end
+
+            # migration.version = next_migration_number(last ? last.version + 1 : 0).to_i
+            new_path = File.join(destination, "#{migration.version}_#{migration.name.underscore}.rb")
+            old_path, migration.filename = migration.filename, new_path
+            last = migration
+
+            FileUtils.cp(old_path, migration.filename)
+            copied << migration
+            options[:on_copy].call(name, migration, old_path) if options[:on_copy]
+            destination_migrations << migration
+          end
+        end
+
+        copied
+      end
+    end
+  end
+end
+
+# class Hash
+#   def to_query
+#     result = []
+#     each do |k, v|
+#       result << "#{k}=#{v}"
+#     end
+#     result.join("&")
+#   end
+# end
+
+namespace :atreides do
+  namespace :install do
+    desc "Copy migrations from Atreides to application"
+    task :migrations => :"db:load_config" do
+
+      # Adapted from rails edge activerecord/lib/active_record/railties/databases.rake
+      on_skip = Proc.new do |name, migration|
+        puts "NOTE: Migration #{migration.name} from #{name} has been skipped. Migration with the same name already exists."
+      end
+
+      on_copy = Proc.new do |name, migration, old_path|
+        puts "Copied migration #{migration.name} from #{name}"
+      end
+
+      ActiveRecord::Migration.copy( 'db/migrate', { 'atreides' => Atreides::Engine.new.paths['db/migrate'].first }, :on_skip => on_skip, :on_copy => on_copy)
+    end
+  end
+end

data/lib/atreides/time_formats.rb

@@ -0,0 +1,19 @@
+Time::DATE_FORMATS[:default] = "%d %B %Y %I:%M %p"
+Time::DATE_FORMATS[:month_and_year] = "%B %Y"
+Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
+Time::DATE_FORMATS[:month_and_day_ordinal] = "%d %b"
+Time::DATE_FORMATS[:long_ordinal] = lambda { |time|
+	time.strftime("#{time.day.ordinalize}, %b %Y %I:%M %p (#{Time.zone.utc_offset==-18000 ? 'EST' : Time.zone.name})")
+}
+Time::DATE_FORMATS[:date_ordinal] = lambda { |time|
+	time.strftime("%d %b '%y")
+}
+Time::DATE_FORMATS[:long_date_ordinal] = lambda { |time|
+	time.strftime("%B #{time.day.ordinalize} %Y")
+}
+Time::DATE_FORMATS[:datetime_ordinal] = lambda { |time|
+	time.strftime("%d %b '%y %I:%M %p")
+}
+Time::DATE_FORMATS[:short_month_and_year] = "%b %Y"
+Time::DATE_FORMATS[:month_and_day] = "%B %d"
+Time::DATE_FORMATS[:day] = "%d"

data/lib/atreides/validators.rb

@@ -0,0 +1,15 @@
+# Custom validator checking for an email address
+class EmailValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value) #:nodoc:
+    record.errors[attribute] << (options[:message] || "is not an email") unless
+      value =~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+  end
+end
+
+# Custom validator checking for an URL
+class UrlValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value) #:nodoc:
+    record.errors[attribute] << (options[:message] || "is not a url") unless
+      value =~ URI::regexp(%w(http https))
+  end
+end

data/lib/atreides/version.rb

@@ -0,0 +1,4 @@
+# Version string of the Atreides engine
+module Atreides
+  VERSION = "2.0.4".freeze
+end

data/lib/generators/atreides/atreides_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module Atreides
+  module Generators
+    class AtreidesGenerator < Rails::Generators::Base
+      namespace "atreides"
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), '..', 'templates')
+      end
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def create_migration_file
+        generate('acts_as_taggable_on:migration')
+        generate('delayed_job:active_record')
+        generate('devise:install')
+
+        %w(create_videos create_photos create_orders create_posts
+           create_pages create_likes create_messages
+           create_features create_products create_line_items create_links
+           create_votes create_tweets create_sessions create_sites
+           create_content_parts add_userid_to_resources devise_create_users
+           add_role_to_users create_preferences).each do |f|
+          src = "#{f}.rb"
+          dst = "db/migrate/#{src}"
+          migration_template(src, dst) rescue puts $!
+        end
+      end
+
+      def create_configuration_file
+        copy_file 'initializer.rb', 'config/initializers/atreides.rb'
+        copy_file 'string_extensions.rb', 'config/initializers/string_extensions.rb'
+        copy_file 'new_relic.rb', 'config/initializers/new_relic.rb'
+        copy_file 'unicorn.rb', 'config/unicorn.rb'
+        copy_file 'settings.yml', 'config/settings.yml'
+        copy_file 'oembed.yml', 'config/oembed.yml'
+        copy_file 'delayed_job.rb', 'config/initializers/delayed_job.rb'
+        copy_file 'Procfile', 'Procfile'
+        gsub_file 'config/application.rb', 'config.active_record.whitelist_attributes = true', 'config.active_record.whitelist_attributes = false'
+        remove_file 'public/index.html'
+        remove_file 'assets/images/rails.png'
+      end
+    end
+  end
+end