refinerycms-core 0.9.9.1

data/engines.md

@@ -0,0 +1,179 @@
+# Extending Refinery with Engines
+
+## Introduction
+
+__Refinery is designed to be easily extended so you can quickly customise your Refinery site to manage new areas you want to add to your site. If you see something you want to customise, the chances are you can customise it.__
+
+The main way of extending Refinery is through adding new engines to your app. By default you can edit pages in Refinery's backend, but how do you add a new section to manage like products?
+
+See: [The Refinery Engine Generator](http://github.com/resolve/refinerycms-generators/blob/master/readme.md#readme)
+
+## The Structure of an Engine
+
+Think of a engine in Refinery as a small Rails app. Engines have a structure that is extremely similar to a Rails app. Here's an example of Refinery's pages engine (located in Refinery's ``pages/`` folder)
+
+    pages
+      |- app
+      |   |- controllers
+      |   |   |- admin
+      |   |   |    |- pages_dialogs_controller.rb
+      |   |   |    |- page_parts_controller.rb
+      |   |   |    |- pages_controller.rb
+      |   |   |- pages_controller.rb
+      |   |- helpers
+      |   |   |- pages_helper.rb
+      |   |- models
+      |   |   |- page.rb
+      |   |- views
+      |       |- pages
+      |       |   |- home.html.erb
+      |       |   |- show.html.erb
+      |       |- admin
+      |           |- pages
+      |               |- _form.html.erb
+      |               |- edit.html.erb
+      |               |- index.html.erb
+      |               |- new.html.erb
+      |- config
+      |   |- routes.rb
+      |- rails
+          |- init.rb
+
+
+### app/controllers
+
+In this example you see one "public" controller ``app/controllers/pages_controller`` that is responsible for managing the front end when I view a page.
+
+### app/controllers/admin
+
+This bit is important. It's where all the controllers are held to manage pages in the Refinery back end in this example. You can ignore the ``pages_dialogs_controller.rb`` and ``page_parts_controller.rb`` for now and let's just focus on the ``admin/pages_controller.rb`` file. Here's what that looks like inside at a basic level:
+
+    module Admin
+      class PagesController < Admin::BaseController
+
+        crudify :page, :conditions => {:parent_id => nil},
+                       :order => "position ASC", :paging => false
+
+      end
+    end
+
+This single controller allows us to create, read, update and delete pages in the backend. With a little bit of Refinery magic we utilise the [crudify mixin](http://github.com/resolve/refinerycms/blob/master/core/crud.md) which gives us all of these regular features out of the box.
+
+How crudify works is an entire topic of it's own. Checkout the [crudify documentation](http://github.com/resolve/refinerycms/blob/master/core/crud.md) to get an insight into how that works.
+
+### app/views and app/helpers
+
+Works exactly the same as ``app/views`` and ``app/helpers`` in a normal Rails app. You just put the views and helpers related to this engine in here instead of in your actual main app directory.
+
+### config/routes.rb
+
+Works exactly the same as ``config/routes.rb`` in your app except this routes file only loads the routes for this engine.
+
+### rails/init.rb
+
+This file runs when your site is started up. All is does is registers this engine with Refinery so it knows that it exists, how to handle it in the Refinery admin menu and how to render recent activity on the Dashboard (see "Getting your Engine to Report Activity in the Dashboard")
+
+NOTE: The latest version of Refinery requires that you only specify a engine.name. plugin.title &amp; plugin.description will be looked up by the I18n system.
+
+# pages/lib/pages.rb
+    ::Refinery::Plugin.register do |plugin|
+      plugin.name = "pages"
+      plugin.version = 1.0
+      plugin.menu_match = /(refinery|admin)\/page(_dialog|part)?s$/
+      plugin.activity = {
+        :class => Page,
+        :url_prefix => "edit_",
+        :title => "title",
+        :created_image => "page_add.png",
+        :updated_image => "page_edit.png"
+      }
+    end
+
+# pages/config/locales/en.yml
+    en:
+      plugins:
+        refinery_pages:
+          title: Pages
+          description: Manage content pages
+
+## Getting your Engine to Report Activity in the Dashboard
+
+Recent activity reporting is built right in, so all you need to do is follow the convention below and your engine will start showing up in the recent activity list of the Dashboard.
+
+In our example above we showed the use of ``plugin.activity`` for the pages engine.
+
+    ::Refinery::Plugin.register do |plugin|
+      plugin.name = "pages"
+      plugin.version = 1.0
+      plugin.menu_match = /(refinery|admin)\/page(_dialog|part)?s$/
+      plugin.activity = {
+        :class => Page,
+        :url_prefix => "edit_",
+        :title => "title",
+        :created_image => "page_add.png",
+        :updated_image => "page_edit.png"
+      }
+    end
+
+Here's what the different activity options mean:
+
+### Required
+
+    :class
+    # the name of the class we're watching.
+
+    :url_prefix
+    # Just use "edit_" if you're not sure how this works.
+    #
+    # When it says "'About' page was updated about 4 hours ago", the page title "About"
+    # is linked to that page in a way we specify.  So by setting "_edit" as a :url_prefix what
+    # we're doing is making it link to the page that allows us to edit this page.
+    # So the next result is edit_admin_page_url(page)
+
+    :title
+    # which attribute on the :class should be in the activty message. In our case it's "title"
+    # because we want it to run something like this "#{page.title} was updated about ...."
+
+### Optional
+
+    :created_image and :updated_image
+    # the activity monitor knows if something is created or updated and shows a different icon
+    # depending on how you want that to look. You can specify the filename to any image you
+    # want in the public/images/refinery/icons/ directory.
+
+## Search Engine Optimisation: Improving the default URLs
+
+In our example above we extended Refinery to manage a products area. The problem is when I look at a product on the front end I get a URL like [http://localhost:3000/products/1](http://localhost:3000/products/1) but I would really like it to be something like [http://localhost:3000/products/my-product](http://localhost:3000/products/my-product)
+
+To achieve this all you need to do is open up the product model (found in ``/vendor/plugins/products/app/models/product.rb``) and add the following line inside your class:
+
+    has_friendly_id :title, :use_slug => true
+
+Note you want to change ``:title`` to the field which you want to show up in the URL.
+
+This will work just fine for new products added from this point, but you'll want to migrate any existing products you have to use this new URL format. All you have to do is save each product you have in the database to make it create a nice URL for you.
+
+    ruby script/console
+    >> Product.all.each {|p| p.save };nil
+
+Now all the products in your database will have nice URLs.
+
+## How to get a WYSIWYG editor to show on your form fields
+
+Refinery uses a standards compliant visual editor called [WYMeditor](http://www.wymeditor.org/)
+
+_Note: When using the Refinery generator, if you apply a field type of "text" to any of your fields, they automatically load as a WYMEditor._
+
+The WYSIWYG editor can only be applied to a ``textarea``. All you need to do is add a class of "wymeditor widest" to a ``textarea`` in your form and a WYSIWYG WYMEditor will load right in place.
+
+### Example
+
+Again going back to our product plugin example if you had this in your ``vendor/plugins/products/app/views/admin/products/_form.html.erb`` file:
+
+    <%= f.text_area :description %>
+
+Just change that to:
+
+    <%= f.text_area :description, :class => "wymeditor widest" %>
+
+Refresh and you're done.

data/features/search.feature

@@ -0,0 +1,55 @@
+@refinerycms @search
+Feature: Search
+  In order find content more quickly
+  As an administrator
+  I want to use search
+
+  Background:
+    Given I am a logged in refinery user
+
+  @search-existing
+  Scenario Outline: Search Existing Item
+    Given I have a <item> titled "<title>"
+    When I go to the list of <location>
+    And I fill in "search" with "<title>"
+    And I press "Search"
+    Then I should see "<title>"
+
+    Examples:
+      |  item  | title  |   location   |
+      |page    |testitem|pages         |
+      |setting |testitem|settings      |
+
+  # This will only run when resources engine is installed.
+  @search-file
+  Scenario: Search File
+    When I upload the file at "refinery_is_awesome.txt"
+    And I go to the list of files
+    And I fill in "search" with "Refinery Is Awesome"
+    And I press "Search"
+    Then I should see "Refinery Is Awesome"
+
+  # This will only run when images engine is installed.
+  @search-image
+  Scenario: Search Image
+    When I upload the image at "beach.jpeg"
+    And I go to the list of images
+    And I fill in "search" with "Beach"
+    And I press "Search"
+    Then I should see "Beach"
+
+  @search-nonexisting
+  Scenario Outline: Search Nonexisting Item
+    Given I have no <item>
+    When I go to the list of <location>
+    And I fill in "search" with "nonexisting"
+    And I press "Search"
+    Then I should see "Sorry, no results found"
+
+    Examples:
+      |  item   |   location   |
+      |pages    |pages         |
+      |images   |images        |
+      |files    |files         |
+      |settings |settings      |
+

data/features/site_bar.feature

@@ -0,0 +1,24 @@
+@refinerycms @site_bar
+Feature: Site Bar
+  In order to allow administrators to easily switch between editing and viewing their website
+  I want logged in refinery users to see a site bar
+  And I want logged in customers to not see a site bar
+
+  Background:
+    Given I have a page titled "Home" with a custom url "/"
+    And I am not logged in
+
+  Scenario: Not logged in
+    When I go to the home page
+    Then I should not see "Log out"
+
+  Scenario: Logged in as a Refinery user
+    Given I am a logged in refinery user
+    When I go to the home page
+    Then I should see "Log out"
+
+  Scenario: Logged in as a customer
+    Given A Refinery user exists
+    And I am a logged in customer
+    When I go to the home page
+    Then I should not see "Switch to your website editor"

data/features/step_definitions/core_steps.rb

@@ -0,0 +1,61 @@
+# Login stuff
+Given %r`not logged in$` do
+  visit destroy_user_session_path
+end
+
+Given /locale is (.+?)$/ do |locale|
+  if defined?(::Refinery::I18n)
+    ::Refinery::I18n.current_locale = locale.to_sym
+  end
+end
+
+Given %r`(?:log|am logged) in as "([^\"]+)"$` do |login|
+  @my_username = login
+  visit refinery_login_path
+  And %Q`enter the username "#{login}"`
+  And %Q`enter the password "#{login}-123"`
+  And "press the login button"
+end
+
+Then 'I should( not)? see a login form' do |negative|
+  expect_opposite_if(negative) do
+    response.should have_tag('form#new_user_session') do
+      field_labeled('Username').should_not be_nil
+      field_labeled('Password', :password).should_not be_nil
+    end
+  end
+end
+
+When %r`enter the username "(.+)"$` do |login|
+  fill_in 'user_session[login]'   , :with => login
+end
+
+When %r`enter the password "(.+)-123"$` do |login|
+  fill_in 'user_session[password]', :with => "#{login}-123"
+end
+
+When %r`press the login button$` do
+  click_button 'Sign In'
+end
+
+Then %r`not be allowed to log in$` do
+  When %Q`log in as "#{@my_username}"`
+  Then 'I should see a login form'
+end
+
+Then %r`be redirected to login$` do
+  request.fullpath.should == refinery_login_path
+end
+
+Then /^"([^\"]*)" can log in$/ do |name|
+  user = User.find_by_login!(name)
+  visit refinery_login_path
+  When %Q`I enter the username "#{name}"`
+  And %Q`I enter the password "#{name}-123"`
+  And 'I press the login button'
+  Then 'I should not see a login form'
+end
+
+Then /^I should be redirected back to "([^\"]*)"$/ do |page_name|
+  visit path_to(page_name)
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+module NavigationHelpers
+  module Refinery
+    module Core
+      def path_to(page_name)
+        # no paths
+        nil
+        #case page_name
+        #else
+        #  nil
+        #end
+      end
+    end
+  end
+end

data/features/uploads/refinery_is_awesome.txt

@@ -0,0 +1 @@
+http://www.refineryhq.com/

data/lib/gemspec.rb

@@ -0,0 +1,43 @@
+require 'pathname'
+gempath = Pathname.new(File.expand_path('../../', __FILE__))
+require gempath.join('..', 'base', 'lib', 'base', 'refinery')
+
+gemspec = <<EOF
+# DO NOT EDIT THIS FILE DIRECTLY! Instead, use lib/gemspec.rb to generate it.
+
+Gem::Specification.new do |s|
+  s.name              = %q{#{gemname = 'refinerycms-core'}}
+  s.version           = %q{#{::Refinery.version}}
+  s.summary           = %q{Core engine for Refinery CMS}
+  s.description       = %q{The core of Refinery CMS. This handles the common functionality and is required by most engines}
+  s.date              = %q{#{Time.now.strftime('%Y-%m-%d')}}
+  s.email             = %q{info@refinerycms.com}
+  s.homepage          = %q{http://refinerycms.com}
+  s.rubyforge_project = %q{refinerycms}
+  s.authors           = ['Resolve Digital', 'Philip Arndt', 'David Jones', 'Steven Heidel']
+  s.license           = %q{MIT}
+  s.require_paths     = %w(lib)
+  s.executables       = %w(#{Pathname.glob(gempath.join('bin/*')).map{|d| d.relative_path_from(gempath)}.sort.join(" ")})
+
+  s.add_dependency 'refinerycms-base',            '~> #{::Refinery::Version}'
+  s.add_dependency 'refinerycms-settings',        '~> #{::Refinery::Version}'
+  s.add_dependency 'refinerycms-generators',      '~> 0.9.9.3'
+  s.add_dependency 'acts_as_indexed',             '~> 0.7'
+  s.add_dependency 'friendly_id_globalize3',      '~> 3.2.0'
+  s.add_dependency 'globalize3',                  '>= 0.1.0.beta'
+  s.add_dependency 'moretea-awesome_nested_set',  '= 1.4.3.1'
+  s.add_dependency 'rails',                       '~> 3.0.3'
+  s.add_dependency 'rdoc',                        '>= 2.5.11' # helps fix ubuntu
+  s.add_dependency 'truncate_html',               '~> 0.5'
+  s.add_dependency 'will_paginate',               '~> 3.0.pre'
+
+  s.files             = [
+    '#{%w( **/{*,.rspec,.gitignore,.yardopts} ).map { |file| Pathname.glob(gempath.join(file)) }.flatten.reject{|f|
+      !f.exist? or f.to_s =~ /\.gem$/ or (f.directory? and f.children.empty?)
+    }.map{|d| d.relative_path_from(gempath)}.uniq.sort.join("',\n    '")}'
+  ]
+end
+EOF
+
+(gemfile = gempath.join("#{gemname}.gemspec")).open('w') {|f| f.puts(gemspec)}
+puts `cd #{gempath} && gem build #{gemfile}` if ARGV.any?{|a| a == "BUILD=true"}

data/lib/generators/refinerycms_generator.rb

@@ -0,0 +1,110 @@
+require 'refinery/generators'
+
+class RefinerycmsGenerator < ::Refinery::Generators::EngineInstaller
+
+  engine_name :refinerycms
+  source_root Pathname.new(File.expand_path('../templates', __FILE__))
+
+  class_option :update, :type => :boolean, :aliases => nil, :group => :runtime,
+                        :desc => "Update an existing Refinery CMS based application"
+
+  def generate
+    # Ensure the generator doesn't output anything using 'puts'
+    self.silence_puts = true
+
+    # Only pretend to do the next actions if this is Refinery to stay DRY
+    if Rails.root == Refinery.root
+      say_status :'-- pretending to make changes that happen in an actual installation --', nil, :yellow
+      old_pretend = self.options[:pretend]
+      new_options = self.options.dup
+      new_options[:pretend] = true
+      self.options = new_options
+    end
+
+    # First, effectively move / rename files that get in the way of Refinery CMS
+    %w(public/index.html config/cucumber.yml app/views/layouts/application.html.erb).each do |roadblock|
+      if (roadblock_path = Rails.root.join(roadblock)).file?
+        create_file "#{roadblock}.backup",
+                    :verbose => true do roadblock_path.read end
+        remove_file roadblock_path, :verbose => true
+      end
+    end
+
+    unless self.options[:update]
+      # Copy asset files (JS, CSS) so they're ready to use.
+      %w(application.css formatting.css home.css theme.css).map{ |ss|
+        Refinery.roots('core').join('public', 'stylesheets', ss)
+      }.reject{|ss| !ss.file?}.each do |stylesheet|
+        copy_file stylesheet,
+                  Rails.root.join('public', 'stylesheets', stylesheet.split.last),
+                  :verbose => true
+      end
+      copy_file Refinery.roots('core').join('public', 'javascripts', 'admin.js'),
+                Rails.root.join('public', 'javascripts', 'admin.js'),
+                :verbose => true
+    end
+
+    # Ensure the config.serve_static_assets setting is present and enabled
+    %w(development test production).map{|e| "config/environments/#{e}.rb"}.each do |env|
+      gsub_file env, %r{#.*config.serve_static_assets}, 'config.serve_static_assets', :verbose => false
+
+      gsub_file env, "serve_static_assets = false", "serve_static_assets = true # Refinery CMS requires this to be true", :verbose => false
+
+      unless Rails.root.join(env).read =~ %r{Refinery.rescue_not_found}
+        append_file env, "Refinery.rescue_not_found = #{env.split('/').last.split('.rb').first == 'production'}"
+      end
+    end
+
+    # Stop pretending
+    if Rails.root == Refinery.root
+      say_status :'-- finished pretending --', nil, :yellow
+      new_options = self.options.dup
+      new_options[:pretend] = old_pretend
+      self.options = new_options
+    end
+
+    # Ensure .gitignore exists and append our rules to it.
+    create_file ".gitignore" unless Rails.root.join('.gitignore').file?
+    our_ignore_rules = self.class.source_root.join('.gitignore').read
+    our_ignore_rules = our_ignore_rules.split('# REFINERY CMS DEVELOPMENT').first if Rails.root != Refinery.root
+    append_file ".gitignore", our_ignore_rules
+
+    # If the admin/base_controller.rb file exists, ensure it does not do the old inheritance
+    if (admin_base = Rails.root.join('app', 'controllers', 'admin', 'base_controller.rb')).file?
+      gsub_file admin_base,
+                "# You can extend refinery backend with your own functions here and they will likely not get overriden in an update.",
+                "",
+                :verbose => self.options[:update]
+
+      gsub_file admin_base, "< Refinery::AdminBaseController", "< ActionController::Base",
+                :verbose => self.options[:update]
+    end
+
+
+    # Append seeds.
+    append_file 'db/seeds.rb', :verbose => true do
+      self.class.source_root.join('db', 'seeds.rb').read
+    end
+
+    force_options = self.options.dup
+    force_options[:force] = self.options[:force] || self.options[:update]
+    self.options = force_options
+    # Seeds and migrations now need to be copied from their various engines.
+    existing_source_root = self.class.source_root
+    ::Refinery::Plugins.registered.pathnames.reject{|p| !p.join('db').directory?}.sort.each do |pathname|
+      self.class.source_root pathname
+      super
+    end
+    self.class.source_root existing_source_root
+
+    super
+
+    # The engine installer only installs database templates.
+    Pathname.glob(self.class.source_root.join('**', '*')).reject{|f|
+      f.directory? or f.to_s =~ /\/db\//
+    }.sort.each do |path|
+      copy_file path, path.to_s.gsub(self.class.source_root.to_s, Rails.root.to_s)
+    end
+  end
+
+end