refinerycms-core 0.9.9.1

data/lib/refinery/plugin.rb

@@ -0,0 +1,106 @@
+module Refinery
+  module Engines; end;
+
+  class Plugin
+
+    def self.register(&block)
+      plugin = self.new
+
+      yield plugin
+
+      raise "A plugin MUST have a name!: #{plugin.inspect}" if plugin.name.blank?
+
+      # Set the root as Rails::Engine.called_from will always be
+      #                 vendor/engines/refinery/lib/refinery
+      new_called_from = begin
+        # Remove the line number from backtraces making sure we don't leave anything behind
+        call_stack = caller.map { |p| p.split(':')[0..-2].join(':') }
+        File.dirname(call_stack.detect { |p| p !~ %r[railties[\w\-\.]*/lib/rails|rack[\w\-\.]*/lib/rack] })
+      end
+
+      klass = Class.new(Rails::Engine)
+      klass.class_eval <<-RUBY
+        def self.called_from; "#{new_called_from}"; end
+      RUBY
+      Object.const_set(plugin.class_name.to_sym, klass)
+    end
+
+    attr_accessor :name, :class_name, :controller, :directory, :url,
+                  :version, :dashboard, :always_allow_access,
+                  :menu_match, :hide_from_menu,
+                  :pathname, :plugin_activity
+    attr_reader   :description
+
+    # Returns the class name of the plugin
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    # Returns the internationalized version of the title
+    def title
+      ::I18n.translate(['plugins', name, 'title'].join('.'))
+    end
+
+    # Returns the internationalized version of the description
+    def description
+      ::I18n.translate(['plugins', name, 'description'].join('.'))
+    end
+
+    # Retrieve information about how to access the latest activities of this plugin.
+    def activity
+      self.plugin_activity ||= []
+    end
+
+    # Stores information that can be used to retrieve the latest activities of this plugin
+    def activity=(activities)
+      [activities].flatten.each { |activity| add_activity(activity) }
+    end
+
+    # Returns true, if the user doesn't require plugin access
+    def always_allow_access?
+      @always_allow_access ||= false
+    end
+
+    # Special property to indicate that this plugin is the dashboard plugin.
+    def dashboard?
+      @dashboard ||= false
+    end
+
+    # Used to highlight the current tab in the admin interface
+    def highlighted?(params)
+      (params[:controller] =~ self.menu_match) or (self.dashboard? and params[:action] == 'error_404')
+    end
+
+    # Returns a RegExp that matches, if the current page is part of the plugin.
+    def menu_match
+      @menu_match ||= /(admin|refinery)\/#{self.name}$/
+    end
+
+    # Returns a hash that can be used to create a url that points to the administration part of the plugin.
+    def url
+      return @url if defined?(@url)
+
+      if self.controller.present?
+        @url = {:controller => "/admin/#{self.controller}"}
+      elsif self.directory.present?
+        @url = {:controller => "/admin/#{self.directory.split('/').pop}"}
+      else
+        @url = {:controller => "/admin/#{self.name}"}
+      end
+    end
+
+  # Make this protected, so that only Plugin.register can use it.
+  protected
+
+    def add_activity(options)
+      (self.plugin_activity ||= []) << Activity::new(options)
+    end
+
+    def initialize
+      # save the pathname to where this plugin is using its lib directory which is standard now.
+      depth = RUBY_VERSION >= "1.9.2" ? 4 : 3
+      self.pathname = Pathname.new(caller(depth).first.match("(.*)#{File::SEPARATOR}lib")[1])
+      Refinery::Plugins.registered << self # add me to the collection of registered plugins
+    end
+  end
+end

data/lib/refinery/plugins.rb

@@ -0,0 +1,75 @@
+module Refinery
+  class Plugins < Array
+
+    def initialize
+      @plugins = []
+    end
+
+    def find_activity_by_model(model)
+      unless (plugin = find_by_model(model)).nil?
+        plugin.activity.detect {|activity| activity.class == model}
+      end
+    end
+
+    def find_by_model(model)
+      model = model.constantize if model.is_a? String
+      self.detect { |plugin| plugin.activity.any? {|activity| activity.class == model } }
+    end
+
+    def find_by_name(name)
+      self.detect { |plugin| plugin.name == name }
+    end
+    alias :[] :find_by_name
+
+    def find_by_title(title)
+      self.detect { |plugin| plugin.title == title }
+    end
+
+    def in_menu
+      self.reject{ |p| p.hide_from_menu }
+    end
+
+    def names
+      self.collect { |p| p.name }
+    end
+
+    def pathnames
+      self.collect { |p| p.pathname }.compact.uniq
+    end
+
+    def titles
+      self.collect { |p| p.title }
+    end
+
+    class << self
+      def active
+        @active_plugins ||= self.new
+      end
+
+      def always_allowed
+        registered.reject { |p| !p.always_allow_access? }
+      end
+
+      def registered
+        @registered_plugins ||= self.new
+      end
+
+      def activate(name)
+        active << registered[name] if registered[name] && !active[name]
+      end
+
+      def deactivate(name)
+        active.delete_if {|p| p.name == name}
+      end
+
+      def set_active(names)
+        @active_plugins = self.new
+
+        names.each do |name|
+          activate(name)
+        end
+      end
+    end
+
+  end
+end

data/lib/refinerycms-core.rb

@@ -0,0 +1,156 @@
+require 'acts_as_indexed'
+require 'awesome_nested_set'
+require 'friendly_id'
+require 'truncate_html'
+require 'will_paginate'
+
+module Refinery
+  autoload :Activity, File.expand_path('../refinery/activity', __FILE__)
+  autoload :Application, File.expand_path('../refinery/application', __FILE__)
+  autoload :ApplicationController, File.expand_path('../refinery/application_controller', __FILE__)
+  autoload :ApplicationHelper, File.expand_path('../refinery/application_helper', __FILE__)
+  autoload :Plugin,  File.expand_path('../refinery/plugin', __FILE__)
+  autoload :Plugins, File.expand_path('../refinery/plugins', __FILE__)
+end
+
+# These have to be specified after the autoload to correct load issues on some systems.
+# As per commit 12af0e3e83a147a87c97bf7b29f343254c5fcb3c
+require 'refinerycms-base'
+require 'refinerycms-generators'
+require 'refinerycms-settings'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Refinery
+
+  module Core
+    class << self
+      def attach_to_application!
+        ::Rails::Application.subclasses.each do |subclass|
+          begin
+            subclass.send :include, ::Refinery::Application
+          rescue
+            $stdout.puts "Refinery CMS couldn't attach to #{subclass.name}."
+            $stdout.puts "Error was: #{$!.message}"
+            $stdout.puts $!.backtrace
+          end
+        end
+      end
+
+      attr_accessor :root
+      def root
+        @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+      end
+    end
+
+    class Engine < ::Rails::Engine
+
+      config.autoload_paths += %W( #{config.root}/lib )
+
+      # Attach ourselves to the Rails application.
+      config.before_configuration do
+        ::Refinery::Core.attach_to_application!
+      end
+
+      # Wrap errors in spans and cache vendored assets.
+      config.to_prepare do
+        # This wraps errors in span not div
+        ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
+          "<span class=\"fieldWithErrors\">#{html_tag}</span>".html_safe
+        end
+
+        # TODO: Is there a better way to cache assets in engines?
+        ::ActionView::Helpers::AssetTagHelper.module_eval do
+          def asset_file_path(path)
+            unless File.exist?(return_path = File.join(config.assets_dir, path.split('?').first))
+              ::Refinery::Plugins.registered.collect{|p| p.pathname}.compact.each do |pathname|
+                if File.exist?(plugin_asset_path = File.join(pathname.to_s, 'public', path.split('?').first))
+                  return_path = plugin_asset_path.to_s
+                end
+              end
+            end
+
+            return_path
+          end
+        end
+      end
+
+      # Register the plugin
+      config.after_initialize do
+        ::Refinery::Plugin.register do |plugin|
+          plugin.name ="refinery_core"
+          plugin.class_name ="RefineryEngine"
+          plugin.version = ::Refinery.version
+          plugin.hide_from_menu = true
+          plugin.always_allow_access = true
+          plugin.menu_match = /(refinery|admin)\/(refinery_core)$/
+        end
+
+        # Register the dialogs plugin
+        ::Refinery::Plugin.register do |plugin|
+          plugin.name = "refinery_dialogs"
+          plugin.version = ::Refinery.version
+          plugin.hide_from_menu = true
+          plugin.always_allow_access = true
+          plugin.menu_match = /(refinery|admin)\/(refinery_)?dialogs/
+        end
+      end
+
+      # Run other initializer code that used to be in config/initializers/
+      initializer "serve static assets" do |app|
+        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+      end
+
+      initializer 'add catch all routes' do |app|
+        app.routes_reloader.paths << File.expand_path('../refinery/catch_all_routes.rb', __FILE__)
+      end
+
+      initializer 'add presenters' do |app|
+        app.config.autoload_paths += [
+          Rails.root.join("app", "presenters"),
+          Rails.root.join("vendor", "**", "**", "app", "presenters"),
+          Refinery.roots.map{|r| r.join("**", "app", "presenters")}
+        ].flatten
+      end
+
+      initializer "configure acts_as_indexed" do |app|
+        ActsAsIndexed.configure do |config|
+          config.index_file = Rails.root.join('tmp', 'index')
+          config.index_file_depth = 3
+          config.min_word_size = 3
+        end
+      end
+
+      initializer "fix rack <= 1.2.1" do |app|
+        ::Rack::Utils.module_eval do
+          def escape(s)
+            regexp = case
+              when RUBY_VERSION >= "1.9" && s.encoding === Encoding.find('UTF-8')
+                /([^ a-zA-Z0-9_.-]+)/u
+              else
+                /([^ a-zA-Z0-9_.-]+)/n
+              end
+            s.to_s.gsub(regexp) {
+              '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
+            }.tr(' ', '+')
+          end
+        end if ::Rack.version <= "1.2.1"
+      end
+
+      initializer 'set will_paginate link labels' do |app|
+        WillPaginate::ViewHelpers.pagination_options[:previous_label] = "&laquo;".html_safe
+        WillPaginate::ViewHelpers.pagination_options[:next_label] = "&raquo;".html_safe
+      end
+
+      initializer 'ensure devise is initialised' do |app|
+        unless Rails.root.join('config', 'initializers', 'devise.rb').file?
+          load Refinery.roots('core').join(*%w(lib generators templates config initializers devise.rb))
+        end
+      end
+
+    end
+  end
+
+end
+
+::Refinery.engines << 'core'

data/lib/tasks/doc.rake

@@ -0,0 +1,29 @@
+namespace :doc do
+
+  task :app => [:refinery]
+
+  desc "Generate documentation for the application"
+  Rake::RDocTask.new(:refinery) { |rdoc|
+    rdoc.title    = "Refinery CMS Documentation"
+    rdoc.main = "readme.md"
+    rdoc.options = ['--inline-source']
+    rdoc.rdoc_files.include('lib/**/*.rb',
+                             'lib/*',
+                             'app/**/*.rb',
+                             'db/seeds.rb',
+                             'config/preinitializer.rb',
+                             'vendor/engines/images/**/*.rb',
+                             'vendor/engines/authentication/**/*.rb',
+                             'vendor/engines/dashboard/**/*.rb',
+                             'vendor/engines/inquiries/**/*.rb',
+                             'vendor/engines/news/**/*.rb',
+                             'vendor/engines/pages/**/*.rb',
+                             'vendor/engines/refinery/**/*.rb',
+                             'vendor/engines/refinery_dialogs/**/*.rb',
+                             'vendor/engines/refinery_settings/**/*.rb',
+                             'vendor/engines/resources/**/*.rb',
+                             'vendor/engines/themes/**/*.rb',
+                             'readme.md', 'license.md', 'vendor/engines/themes/readme.md')
+  }
+
+end

data/lib/tasks/refinery.rake

@@ -0,0 +1,231 @@
+namespace :refinery do
+
+  desc "Override files for use in an application"
+  task :override => :environment do
+    require 'fileutils'
+
+    if (view = ENV["view"]).present?
+      pattern = "#{view.split("/").join(File::SEPARATOR)}*.{erb,builder}"
+      looking_for = Refinery::Plugins.registered.pathnames.map{|p| p.join("app", "views", pattern).to_s}
+
+      # copy in the matches
+      matches = looking_for.collect{|d| Dir[d]}.flatten.compact.uniq
+      if matches.any?
+        matches.each do |match|
+          dir = match.split("/app/views/").last.split('/')
+          file = dir.pop # get rid of the file.
+          dir = dir.join(File::SEPARATOR) # join directory back together
+
+          unless (theme = ENV["theme"]).present?
+            destination_dir = Rails.root.join("app", "views", dir)
+          else
+            destination_dir = Rails.root.join("themes", theme, "views", dir)
+          end
+          FileUtils.mkdir_p(destination_dir)
+          FileUtils.cp match, (destination = File.join(destination_dir, file))
+
+          puts "Copied view template file to #{destination.gsub("#{Rails.root.to_s}#{File::SEPARATOR}", '')}"
+        end
+      else
+        puts "Couldn't match any view template files in any engines like #{view}"
+      end
+    elsif (controller = ENV["controller"]).present?
+      pattern = "#{controller.split("/").join(File::SEPARATOR)}*.rb"
+      looking_for = Refinery::Plugins.registered.pathnames.map{|p| p.join("app", "controllers", pattern).to_s}
+
+      # copy in the matches
+      matches = looking_for.collect{|d| Dir[d]}.flatten.compact.uniq
+      if matches.any?
+        matches.each do |match|
+          dir = match.split("/app/controllers/").last.split('/')
+          file = dir.pop # get rid of the file.
+          dir = dir.join(File::SEPARATOR) # join directory back together
+
+          destination_dir = Rails.root.join("app", "controllers", dir)
+          FileUtils.mkdir_p(destination_dir)
+          FileUtils.cp match, (destination = File.join(destination_dir, file))
+
+          puts "Copied controller file to #{destination.gsub("#{Rails.root.to_s}#{File::SEPARATOR}", '')}"
+        end
+      else
+        puts "Couldn't match any controller files in any engines like #{controller}"
+      end
+    elsif (model = ENV["model"]).present?
+      pattern = "#{model.split("/").join(File::SEPARATOR)}*.rb"
+      looking_for = Refinery::Plugins.registered.pathnames.map{|p| p.join("app", "models", pattern).to_s}
+
+      # copy in the matches
+      matches = looking_for.collect{|d| Dir[d]}.flatten.compact.uniq
+      if matches.any?
+        matches.each do |match|
+          dir = match.split("/app/models/").last.split('/')
+          file = dir.pop # get rid of the file.
+          dir = dir.join(File::SEPARATOR) # join directory back together
+
+          destination_dir = Rails.root.join("app", "models", dir)
+          FileUtils.mkdir_p(destination_dir)
+          FileUtils.cp match, (destination = File.join(destination_dir, file))
+
+          puts "Copied model file to #{destination.gsub("#{Rails.root.to_s}#{File::SEPARATOR}", '')}"
+        end
+      else
+        puts "Couldn't match any model files in any engines like #{model}"
+      end
+    elsif (javascripts = ENV["javascript"]).present?
+      pattern = "#{javascripts.split("/").join(File::SEPARATOR)}*.js"
+      looking_for = Refinery::Plugins.registered.pathnames.map{|p| p.join("public", "javascripts", pattern).to_s}
+
+      # copy in the matches
+      matches = looking_for.collect{|d| Dir[d]}.flatten.compact.uniq
+      if matches.any?
+        matches.each do |match|
+          dir = match.split("/public/javascripts/").last.split('/')
+          file = dir.pop # get rid of the file.
+          dir = dir.join(File::SEPARATOR) # join directory back together
+
+          destination_dir = Rails.root.join("public", "javascripts", dir)
+          FileUtils.mkdir_p(destination_dir)
+          FileUtils.cp match, (destination = File.join(destination_dir, file))
+
+          puts "Copied javascript file to #{destination.gsub("#{Rails.root.to_s}#{File::SEPARATOR}", '')}"
+        end
+      else
+        puts "Couldn't match any javascript files in any engines like #{javascript}"
+      end
+    elsif (stylesheets = ENV["stylesheet"]).present?
+      pattern = "#{stylesheets.split("/").join(File::SEPARATOR)}*.css"
+      looking_for = Refinery::Plugins.registered.pathnames.map{|p| p.join("public", "stylesheets", pattern).to_s}
+
+      # copy in the matches
+      matches = looking_for.collect{|d| Dir[d]}.flatten.compact.uniq
+      if matches.any?
+        matches.each do |match|
+          dir = match.split("/public/stylesheets/").last.split('/')
+          file = dir.pop # get rid of the file.
+          dir = dir.join(File::SEPARATOR) # join directory back together
+
+          destination_dir = Rails.root.join("public", "stylesheets", dir)
+          FileUtils.mkdir_p(destination_dir)
+          FileUtils.cp match, (destination = File.join(destination_dir, file))
+
+          puts "Copied stylesheet file to #{destination.gsub("#{Rails.root.to_s}#{File::SEPARATOR}", '')}"
+        end
+      else
+        puts "Couldn't match any stylesheet files in any engines like #{stylesheets}"
+      end
+    else
+      puts "You didn't specify anything to override. Here's some examples:"
+      {
+        :view => ['pages/home', 'pages/home theme=demolicious', '**/*menu', 'shared/_menu_branch'],
+        :javascript => %w(jquery),
+        :stylesheet => %w(refinery/site_bar),
+        :controller => %w(pages),
+        :model => %w(page)
+      }.each do |type, examples|
+        examples.each do |example|
+          puts "rake refinery:override #{type}=#{example}"
+        end
+      end
+    end
+  end
+
+  desc "Un-crudify a method on a controller that uses crudify"
+  task :uncrudify => :environment do
+    if (model_name = ENV["model"]).present? and (action = ENV["action"]).present?
+      singular_name = model_name.to_s
+      class_name = singular_name.camelize
+      plural_name = singular_name.pluralize
+
+      crud_lines = Refinery.roots('core').join('lib', 'refinery', 'crud.rb').read
+      if (matches = crud_lines.scan(/(\ +)(def #{action}.+?protected)/m).first).present? and
+         (method_lines = "#{matches.last.split(%r{^#{matches.first}end}).first.strip}\nend".split("\n")).many?
+        indent = method_lines.second.index(%r{[^ ]})
+        crud_method = method_lines.join("\n").gsub(/^#{" " * indent}/, "  ")
+
+        default_crud_options = ::Refinery::Crud.default_options(model_name)
+        crud_method.gsub!('#{options[:redirect_to_url]}', default_crud_options[:redirect_to_url])
+        crud_method.gsub!('#{options[:conditions].inspect}', default_crud_options[:conditions].inspect)
+        crud_method.gsub!('#{options[:title_attribute]}', default_crud_options[:title_attribute])
+        crud_method.gsub!('#{singular_name}', singular_name)
+        crud_method.gsub!('#{class_name}', class_name)
+        crud_method.gsub!('#{plural_name}', plural_name)
+        crud_method.gsub!('\\#{', '#{')
+
+        puts crud_method
+      end
+    else
+      puts "You didn't specify anything to uncrudify. Here's some examples:"
+      puts "rake refinery:uncrudify model=page action=create"
+      puts "rake refinery:uncrudify model=product action=new"
+    end
+  end
+
+  desc "Update the core files with the gem"
+  task :update => :environment do
+    verbose = ENV["verbose"] || false
+    require 'fileutils'
+
+    # Clean up mistakes
+    if (bad_migration = Rails.root.join('db', 'migrate', '20100913234704_add_cached_slug_to_pages.rb')).file?
+      FileUtils::rm bad_migration
+    end
+
+    unless (devise_config = Rails.root.join('config', 'initializers', 'devise.rb')).file?
+      devise_config.parent.mkpath
+      FileUtils::cp Refinery.roots('core').join(*%w(lib generators templates config initializers devise.rb)),
+                    devise_config,
+                    :verbose => verbose
+    end
+
+    (contents = Rails.root.join('Gemfile').read).gsub!("group :test do", "group :development, :test do")
+    Rails.root.join('Gemfile').open("w") do |f|
+      f.puts contents
+    end
+
+    # copy in any new migrations, except for ones that create schemas (this is an update!)
+    # or ones that exist already.
+    Rails.root.join("db", "migrate").mkpath
+    migrations = Pathname.glob(Refinery.roots.map{|r| r.join("db", "migrate", "*.rb")}).reject{|m|
+      m.to_s =~ %r{\d+_create_refinerycms_.+?_schema\.rb} or
+      Dir[Rails.root.join('db', 'migrate', "*#{m.split.last.to_s.split(/\d+_/).last}")].any?
+    }
+    FileUtils::cp migrations,
+                  Rails.root.join('db', 'migrate').cleanpath.to_s,
+                  :verbose => verbose
+
+    Rails.root.join("db", "seeds").mkpath
+    Pathname.glob(Refinery.roots.map{|r| r.join('db', 'seeds', '*.rb')}).each do |seed|
+      unless (destination = Rails.root.join('db', 'seeds', seed.split.last)).exist?
+        FileUtils::cp seed, destination.to_s, :verbose => verbose
+      end
+    end
+
+    puts "\n" if verbose
+
+    unless (ENV["from_installer"] || 'false').to_s == 'true'
+      puts "\n=== ACTION REQUIRED ==="
+      puts "Please run rake db:migrate to ensure your database is at the correct version.\n"
+    end
+  end
+
+  namespace :cache do
+    desc "Eliminate existing cache files for javascript and stylesheet resources in default directories"
+    task :clear => :environment do
+      FileUtils.rm(Dir[Rails.root.join("public", "javascripts", "cache", "[^.]*").cleanpath.to_s])
+      FileUtils.rm(Dir[Rails.root.join("public", "stylesheets", "cache", "[^.]*").cleanpath.to_s])
+    end
+  end
+
+end
+
+desc 'Removes trailing whitespace across the entire application.'
+task :whitespace do
+  require 'rbconfig'
+  if Config::CONFIG['host_os'] =~ /linux/
+    sh %{find . -name '*.*rb' -exec sed -i 's/\t/  /g' {} \\; -exec sed -i 's/ *$//g' {} \\; }
+  elsif Config::CONFIG['host_os'] =~ /darwin/
+    sh %{find . -name '*.*rb' -exec sed -i '' 's/\t/  /g' {} \\; -exec sed -i '' 's/ *$//g' {} \\; }
+  else
+    puts "This doesn't work on systems other than OSX or Linux. Please use a custom whitespace tool for your platform '#{Config::CONFIG["host_os"]}'."
+  end
+end