refinerycms-pages 0.9.9.1

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+ 
+Copyright (c) 2005-2010 [Resolve Digital](http://www.resolvedigital.com)
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,156 @@
+# Pages
+
+![Refinery Pages](http://refinerycms.com/system/images/0000/0656/pages.png)
+
+## About
+
+One core part of Refinery is Pages. Plugins such as News and Inquiries hook to pages. The menu is rendered based off the structure of your pages.
+
+Pages have one key thing about them that is unique - page parts.
+
+## Page Parts
+
+![Refinery Page Parts](http://refinerycms.com/system/images/0000/0586/editing-page.png)
+
+### What are they?
+
+Think of a page part is a single piece of content on your page. At [Resolve Digital](http://www.resolvedigital.com) we often simply use ``body`` and ``side_body``. One is for the main content and one is for the content which goes on a side bit of the page to display other information.
+
+### Default Page Parts
+
+You can change what the default page parts are called or add more by editing the "Default Page Parts" setting. This is a serialized array of names. The default looks like this
+
+    ---
+    - Body
+    - Side Body
+
+Edit this setting to suit your taste.
+
+### Adding Page Parts for Specific Pages
+
+You can add extra page parts to your pages by setting the "New Page Parts" to ``true``.
+
+Now do this
+
+* Edit the page you want to add a part to
+* Click the little "+" icon up by the page part tabs
+* Type the name of your new part and hit add.
+
+_Note: in the user-facing front end we call them "content sections" not "page parts"._
+
+## Page Options
+
+### Draft/Published
+
+You can have draft and published pages. This is controlled by checking and unchecking the "Save as Draft" field on the page form, when editing the page.
+
+### Custom Title
+
+There are three options for how the page title will be rendered on the front end.
+
+* ``None``: will just default to the page title
+* ``Text``: allows you to have a different name for the page in the backend to the front end (sometimes good for SEO)
+* ``Image``: If your designer is using a custom non-standard web font, this is ideal. Bang the image of your title right in there (_we don't recommend this though! Standard web fonts are always a good idea_)
+
+### Show in Menu
+
+You can hide a page from the navigation if you like by unchecking "show in menu". This is good for extra reference pages or even pages you might want to link someone up to directly but not "advertise" the pages existence on the menu.
+
+### Custom URL
+
+This allows you to make your page not link to a normal page but make it show something else. This could be a donation link to a completely different site or as Refinery uses it, you might want to link to another plugin.
+
+The "contact us" page for example has a Custom URL of ``/contact``, this is because we want it to load the inquiries form from the inquiries plugin instead and we have this ``match '/contact', :to => 'inquiries#new', :as => 'new_inquiry'`` in the routes.
+
+### WYMeditor (the visual editor)
+
+Refinery is backed by [WYMeditor](http://www.wymeditor.org/)
+
+It's a standards compliant editor that we've trimmed to only have what we feel is absolutely necessary. When you're editing the content in a page part you're using [WYMeditor](http://www.wymeditor.org/).
+
+We have since modified the source code of WYMeditor to allow for a lot of new features like our custom dialogues however it is all based on the release: WYMeditor 0.5 rc1.
+
+You can also switch to "source" view and edit XHTML manually if the visual editor is not playing nice.
+
+### Custom Selectable Styles in WYMeditor
+
+![Refinery Page Editor Styles](http://refinerycms.com/system/images/0000/0596/editing-page-style.png)
+
+Some sites require a little more than just your standard bold and heading controls. This is where the "css" style drop down comes in handy.
+
+It allows your users to select a style you define. You need to edit/create a CSS file called ``theme.css``.
+
+This file should be located in ``/public/stylesheets/themes.css``
+
+Inside that file you define your styles like this
+
+    .category-name-style-name {
+      // apply your CSS rules here
+    }
+
+For example, if I wanted to add a style that allowed my users to highlight their text a light yellow colour, I would put this
+
+    .text-highlight-yellow {
+      background: LightYellow;
+    }
+
+Now edit ``public/javascripts/admin.js``. We're going to need to tell WYMeditor that we have some new styles it should load when the editor is loaded.
+
+Currently your ``admin.js`` file will have something like this
+
+    var custom_wymeditor_boot_options = {
+
+    };
+
+If we open ``public/javascripts/boot_wym.js`` we can see this inside which is the default:
+
+    , classesItems: [
+      {name: 'text-align', rules:['left', 'center', 'right', 'justify'], join: '-'}
+      , {name: 'image-align', rules:['left', 'right'], join: '-'}
+      , {name: 'font-size', rules:['small', 'normal', 'large'], join: '-'}
+    ]
+
+Let's just breakdown a single WYMeditor line and understand it:
+
+    {name: 'font-size', rules:['small','normal','large'], join: '-'}
+
+``font-size`` is the name of the category and ``small``, ``normal``, ``large`` are the actual styles. So for this to match up with the styles in my theme.css file the class name has to be:
+
+    .font-size-small { // CSS rules here }
+    .font-size-normal { // CSS rules here }
+    .font-size-large { // CSS rules here }
+
+So going back to our text highlighting style above, we make the new style show up in the editor by changing our ``admin.js`` file to:
+
+    var custom_wymeditor_boot_options = {
+      classesItems: [
+        {name: 'text-align', rules:['left', 'center', 'right', 'justify'], join: '-'}
+        , {name: 'image-align', rules:['left', 'right'], join: '-'}
+        , {name: 'font-size', rules:['small','normal','large'], join: '-'}
+        , {name: 'text-highlight', rules:['yellow'], join: '-'}
+      ]
+    }
+
+### Dialogs that show from WYMeditor
+
+![Refinery Page Editor Link Dialog](http://refinerycms.com/system/images/0000/0636/link-dialog.png)
+
+## Page Link dialog
+
+The link dialog lets you link in several different ways:
+
+* To an internal page
+* To an external page
+* To an email address
+* To a resource you've uploaded in the Resources tab.
+
+## Insert Image dialog
+
+Simply lets you select from an existing image found in the Images tab or upload a new one right within the dialog.
+
+## Refinery Default Pages
+
+Some pages you have to keep in order for Refinery to stay fully functional:
+
+* Home page - the page that has ``link_url`` to ``root_url`` (normally /)
+* Page not found - the default 404 page

data/refinerycms-pages.gemspec

@@ -0,0 +1,110 @@
+# DO NOT EDIT THIS FILE DIRECTLY! Instead, use lib/gemspec.rb to generate it.
+
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-pages}
+  s.version           = %q{0.9.9.1}
+  s.summary           = %q{Pages engine for Refinery CMS}
+  s.description       = %q{The default content engine of Refinery CMS. This engine handles the administration and display of user-editable pages.}
+  s.date              = %q{2011-02-15}
+  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()
+
+  s.files             = [
+    'app',
+    'app/controllers',
+    'app/controllers/admin',
+    'app/controllers/admin/page_parts_controller.rb',
+    'app/controllers/admin/pages_controller.rb',
+    'app/controllers/admin/pages_dialogs_controller.rb',
+    'app/controllers/pages_controller.rb',
+    'app/helpers',
+    'app/helpers/pages_helper.rb',
+    'app/models',
+    'app/models/page.rb',
+    'app/models/page_part.rb',
+    'app/presenters',
+    'app/presenters/page_presenter.rb',
+    'app/views',
+    'app/views/admin',
+    'app/views/admin/pages',
+    'app/views/admin/pages/_form.html.erb',
+    'app/views/admin/pages/_form_advanced_options.html.erb',
+    'app/views/admin/pages/_form_advanced_options_seo.html.erb',
+    'app/views/admin/pages/_form_fields_after_title.html.erb',
+    'app/views/admin/pages/_form_new_page_parts.html.erb',
+    'app/views/admin/pages/_form_page_parts.html.erb',
+    'app/views/admin/pages/_locale_picker.html.erb',
+    'app/views/admin/pages/_page.html.erb',
+    'app/views/admin/pages/_page_part_field.html.erb',
+    'app/views/admin/pages/_sortable_list.html.erb',
+    'app/views/admin/pages/edit.html.erb',
+    'app/views/admin/pages/index.html.erb',
+    'app/views/admin/pages/new.html.erb',
+    'app/views/admin/pages_dialogs',
+    'app/views/admin/pages_dialogs/_page_link.html.erb',
+    'app/views/admin/pages_dialogs/link_to.html.erb',
+    'app/views/pages',
+    'app/views/pages/home.html.erb',
+    'app/views/pages/show.html.erb',
+    'config',
+    'config/locales',
+    'config/locales/cs.yml',
+    'config/locales/da.yml',
+    'config/locales/de.yml',
+    'config/locales/el.yml',
+    'config/locales/en.yml',
+    'config/locales/es.yml',
+    'config/locales/fr.yml',
+    'config/locales/it.yml',
+    'config/locales/lolcat.yml',
+    'config/locales/lt.yml',
+    'config/locales/lv.yml',
+    'config/locales/nb.yml',
+    'config/locales/nl.yml',
+    'config/locales/pl.yml',
+    'config/locales/pt-BR.yml',
+    'config/locales/rs.yml',
+    'config/locales/ru.yml',
+    'config/locales/sl.yml',
+    'config/locales/sv.yml',
+    'config/locales/vi.yml',
+    'config/locales/zh-CN.yml',
+    'config/locales/zh-TW.yml',
+    'config/routes.rb',
+    'db',
+    'db/migrate',
+    'db/migrate/20100913234708_create_refinerycms_pages_schema.rb',
+    'db/migrate/20101214040815_translate_page_plugin.rb',
+    'db/migrate/20101216194133_remove_cached_slug_from_pages.rb',
+    'db/seeds',
+    'db/seeds/pages.rb',
+    'features',
+    'features/manage_pages.feature',
+    'features/step_definitions',
+    'features/step_definitions/page_steps.rb',
+    'features/support',
+    'features/support/paths.rb',
+    'features/visit_pages.feature',
+    'lib',
+    'lib/gemspec.rb',
+    'lib/generators',
+    'lib/generators/refinerycms_pages_generator.rb',
+    'lib/pages',
+    'lib/pages/marketable_routes.rb',
+    'lib/pages/tabs.rb',
+    'lib/refinerycms-pages.rb',
+    'license.md',
+    'readme.md',
+    'refinerycms-pages.gemspec',
+    'spec',
+    'spec/models',
+    'spec/models/page_spec.rb'
+  ]
+
+  s.add_dependency 'refinerycms-core', '~> 0.9.9.1'
+end

data/spec/models/page_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe Page do
+
+  def reset_page(options = {})
+    @valid_attributes = {
+      :id => 1,
+      :title => "RSpec is great for testing too",
+      :deletable => true
+    }
+
+    @page.destroy! if @page
+    @page = Page.create!(@valid_attributes.update(options))
+  end
+
+  def page_cannot_be_destroyed
+    @page.destroy.should == false
+  end
+
+  def create_child
+    @child = @page.children.create(:title => 'The child page')
+  end
+
+  def create_page_parts
+    @page.parts.create(:title => 'body', :content => "I'm the first page part for this page.")
+    @page.parts.create(:title => 'side body', :content => "Closely followed by the second page part.")
+  end
+
+  def turn_off_marketable_urls
+    RefinerySetting.set(:use_marketable_urls, {:value => false, :scoping => 'pages'})
+  end
+
+
+  before(:each) do
+    reset_page
+  end
+
+  context "cannot be deleted under certain rules" do
+    it "if link_url is present" do
+      reset_page({:link_url => '/plugin-name'})
+      page_cannot_be_destroyed
+    end
+
+
+    it "if refinery team deems it so" do
+      reset_page({:deletable => false})
+      page_cannot_be_destroyed
+    end
+
+    it "if menu_match is present" do
+      reset_page({:menu_match => '^/RSpec is great for testing too.*$'})
+      page_cannot_be_destroyed
+    end
+
+    it "unless you really want it to! >:]" do
+      reset_page
+      @page.destroy!
+    end
+  end
+
+  context "page urls" do
+
+    it "should return a full path" do
+      @page.path.should == 'RSpec is great for testing too'
+    end
+
+    it "and all of its parent page titles, reversed" do
+      create_child
+      @child.path.should == 'RSpec is great for testing too - The child page'
+    end
+
+    it "or normally ;-)" do
+      create_child
+      @child.path({:reversed => false}).should == 'The child page - RSpec is great for testing too'
+    end
+
+    it "should return its url" do
+      @page.link_url = '/contact'
+      @page.url.should == '/contact'
+    end
+
+    it "should return its path with marketable urls" do
+      @page.url[:id].should be_nil
+      @page.url[:path].should == ["rspec-is-great-for-testing-too"]
+    end
+
+    it "should not have a path without marketable urls" do
+      turn_off_marketable_urls
+      @page.url[:path].should be_nil
+      @page.url[:id].should == "rspec-is-great-for-testing-too"
+    end
+  end
+
+  context "home page" do
+    it "should respond as the home page" do
+      @page.link_url = '/'
+      @page.home?.should == true
+    end
+
+    it "should not respond as the home page" do
+      @page.home?.should == false
+    end
+  end
+
+  context "content sections (page parts)" do
+    it "should return the content when using []" do
+      create_page_parts
+
+      @page[:body].should == "<p>I'm the first page part for this page.</p>"
+      @page["BoDY"].should == "<p>I'm the first page part for this page.</p>"
+    end
+
+    it "should return all page part content" do
+      create_page_parts
+
+      @page.all_page_part_content.should == "<p>I'm the first page part for this page.</p> <p>Closely followed by the second page part.</p>"
+    end
+
+    it "should reposition correctly" do
+      create_page_parts
+      @page.parts.first.position = 6
+      @page.parts.last.position = 4
+
+      @page.parts.first.position.should == 6
+      @page.parts.last.position.should == 4
+
+      @page.reposition_parts!
+
+      @page.parts.first.position.should == 0
+      @page.parts.last.position.should == 1
+    end
+  end
+
+  context "draft pages" do
+    it "should not be a live page when set to draft" do
+      @page.draft = true
+      @page.live?.should == false
+
+      @page.draft = false
+      @page.live?.should == true
+    end
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-pages
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.9.1
+platform: ruby
+authors: 
+- Resolve Digital
+- Philip Arndt
+- David Jones
+- Steven Heidel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-15 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: refinerycms-core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.9.1
+  type: :runtime
+  version_requirements: *id001
+description: The default content engine of Refinery CMS. This engine handles the administration and display of user-editable pages.
+email: info@refinerycms.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/admin/page_parts_controller.rb
+- app/controllers/admin/pages_controller.rb
+- app/controllers/admin/pages_dialogs_controller.rb
+- app/controllers/pages_controller.rb
+- app/helpers/pages_helper.rb
+- app/models/page.rb
+- app/models/page_part.rb
+- app/presenters/page_presenter.rb
+- app/views/admin/pages/_form.html.erb
+- app/views/admin/pages/_form_advanced_options.html.erb
+- app/views/admin/pages/_form_advanced_options_seo.html.erb
+- app/views/admin/pages/_form_fields_after_title.html.erb
+- app/views/admin/pages/_form_new_page_parts.html.erb
+- app/views/admin/pages/_form_page_parts.html.erb
+- app/views/admin/pages/_locale_picker.html.erb
+- app/views/admin/pages/_page.html.erb
+- app/views/admin/pages/_page_part_field.html.erb
+- app/views/admin/pages/_sortable_list.html.erb
+- app/views/admin/pages/edit.html.erb
+- app/views/admin/pages/index.html.erb
+- app/views/admin/pages/new.html.erb
+- app/views/admin/pages_dialogs/_page_link.html.erb
+- app/views/admin/pages_dialogs/link_to.html.erb
+- app/views/pages/home.html.erb
+- app/views/pages/show.html.erb
+- config/locales/cs.yml
+- config/locales/da.yml
+- config/locales/de.yml
+- config/locales/el.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/lolcat.yml
+- config/locales/lt.yml
+- config/locales/lv.yml
+- config/locales/nb.yml
+- config/locales/nl.yml
+- config/locales/pl.yml
+- config/locales/pt-BR.yml
+- config/locales/rs.yml
+- config/locales/ru.yml
+- config/locales/sl.yml
+- config/locales/sv.yml
+- config/locales/vi.yml
+- config/locales/zh-CN.yml
+- config/locales/zh-TW.yml
+- config/routes.rb
+- db/migrate/20100913234708_create_refinerycms_pages_schema.rb
+- db/migrate/20101214040815_translate_page_plugin.rb
+- db/migrate/20101216194133_remove_cached_slug_from_pages.rb
+- db/seeds/pages.rb
+- features/manage_pages.feature
+- features/step_definitions/page_steps.rb
+- features/support/paths.rb
+- features/visit_pages.feature
+- lib/gemspec.rb
+- lib/generators/refinerycms_pages_generator.rb
+- lib/pages/marketable_routes.rb
+- lib/pages/tabs.rb
+- lib/refinerycms-pages.rb
+- license.md
+- readme.md
+- refinerycms-pages.gemspec
+- spec/models/page_spec.rb
+has_rdoc: true
+homepage: http://refinerycms.com
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: refinerycms
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Pages engine for Refinery CMS
+test_files: []
+