skylinecms 3.1.0 → 3.2.0

data/db/migrate/20090508145820_create_skyline_pages.rb

@@ -7,8 +7,8 @@ class CreateSkylinePages < ActiveRecord::Migration
       t.integer :position, :null => false
       t.timestamps
     end
-    add_index :skyline_pages, [:page_id, :position]
-    add_index :skyline_pages, [:page_id, :in_navigation]
+    add_index :skyline_pages, [:page_id, :position], :name => "sp_page_id_position"
+    add_index :skyline_pages, [:page_id, :in_navigation], :name => "sp_page_id_in_navigation"
   end
 
   def self.down

data/db/migrate/20090508145852_create_skyline_page_versions.rb

@@ -17,8 +17,8 @@ class CreateSkylinePageVersions < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :skyline_page_versions, [:type, :page_id, :version]
-    add_index :skyline_page_versions, :url_part
+    add_index :skyline_page_versions, [:type, :page_id, :version], :name => "spv_type_page_id_version"
+    add_index :skyline_page_versions, :url_part, :name => "spv_url_part"
   end
 
   def self.down

data/db/migrate/20090508150149_create_skyline_sections.rb

@@ -8,7 +8,7 @@ class CreateSkylineSections < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :skyline_sections, [:page_version_id, :position]
+    add_index :skyline_sections, [:page_version_id, :position], :name => "ss_page_version_id_position"
   end
 
   def self.down

data/db/migrate/20090610142139_add_skyline_tags_taggable_type.rb

@@ -1,11 +1,11 @@
 class AddSkylineTagsTaggableType < ActiveRecord::Migration
   def self.up
     add_column :skyline_tags, :taggable_type, :string, :null => false, :default => ""
-    add_index :skyline_tags, [:taggable_type, :tag]
+    add_index :skyline_tags, [:taggable_type, :tag], :name => "sk_taggable_type_tag"
     execute("UPDATE skyline_tags SET taggable_type='Skyline::MediaFile'")
   end
 
   def self.down
     remove_column :skyline_tags, :taggable_type
   end
-end
+end

data/db/migrate/20090624154251_create_skyline_link_section_links.rb

@@ -8,7 +8,7 @@ class CreateSkylineLinkSectionLinks < ActiveRecord::Migration
       t.integer :position, :null => false
       t.timestamps
     end
-    add_index :skyline_link_section_links, [:link_section_id, :position]
+    add_index :skyline_link_section_links, [:link_section_id, :position], :name => "slsl_link_section_id_position"
   end
 
   def self.down

data/db/migrate/20100120113953_remove_unused_articles_index.rb

@@ -1,6 +1,6 @@
 class RemoveUnusedArticlesIndex < ActiveRecord::Migration
   def self.up
-    remove_index :skyline_articles, :name => "index_skyline_pages_on_page_id_and_in_navigation"
+    remove_index :skyline_articles, :name => "sp_page_id_in_navigation"
   end
 
   def self.down

data/db/migrate/20110816080626_add_skyline_test_article_data.rb

@@ -0,0 +1,13 @@
+class AddSkylineTestArticleData < ActiveRecord::Migration
+  def self.up
+    create_table :skyline_test_article_data, :force => true do |t|
+      t.text :intro
+      t.integer :link_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :skyline_test_article_data
+  end
+end

data/db/migrate/20111101092405_rename_indexes.rb

@@ -0,0 +1,24 @@
+class RenameIndexes < ActiveRecord::Migration
+  def self.up
+    [
+      ["skyline_articles", "index_skyline_pages_on_page_id_and_position", "sp_page_id_position"],
+      ["skyline_articles", "index_skyline_pages_on_page_id_and_in_navigation", "sp_page_id_in_navigation"],
+      ["skyline_article_versions", "index_skyline_page_versions_on_type_and_page_id_and_version", "spv_type_page_id_version"],
+      ["skyline_article_versions", "index_skyline_page_versions_on_url_part", "spv_url_part"],
+      ["skyline_sections", "index_skyline_sections_on_page_version_id_and_position", "ss_page_version_id_position"],
+      ["skyline_tags", "index_skyline_tags_on_taggable_type_and_tag", "sk_taggable_type_tag"],
+      ["skyline_link_section_links", "index_skyline_link_section_links_on_link_section_id_and_position", "slsl_link_section_id_position"],
+      ["skyline_associated_tags", "index_skyline_associated_tags_on_taggable_type_and_taggable_id_and_tag_id", "sat_tt"],
+    ].each do |tbl, old, nw|
+      begin
+        rename_index tbl, old, nw
+      rescue 
+        puts "Could not rename index '#{old}' on '#{tbl}'"
+      end
+    end
+  end
+
+  def self.down
+    # Nothing to do here!
+  end
+end

data/doc/INSTALL.md

@@ -4,50 +4,63 @@ Skyline installation instructions
 Choose your flavour
 -------------------
 
-**Install as a gem** The skylinecms gem is perfect if you want to have stable environment
+### Install as a packaged gem ###
+The skylinecms gem is perfect if you want to have stable environment
 and don't care too much about cutting-edge new features. We release new versions fairly
 often.
 
-**Install the plugin** Use the plugin if you want to be on the latest development version
+### Install as a local gem ###
+Use the "local" gem if you want to be on the latest development version
 with all the 'cool' new features. Especially if you use git, because we're hosting the
-source on github. It's of course entirely possible to use a stable tagged version as a
-plugin too.
+source on github. 
 
 Create your rails app
 ---------------------
 
-Create an empty rails app. Make sure you're usin MySQL for now,
-we didn't test with other databases yet.
+Create an empty rails app. 
 
-    rails my_app --database=mysql
+    rails new my_app
     cd my_app
 
-Installation as a gem
+Installation as a packaged gem
 ---------------------
 
-Install the gems, and initialize Skyline. 
+Edit the Gemfile and add
 
-    gem install skylinecms
-    skylincms init
+    gem "skylinecms"
     
-Continue below.
+Continue with "Run bundler".
 
-Installation as plugin
+Installation as a local gem
 -----------------------
 
 Download the Skyline source from [http://github.com/DigitPaint/skyline](http://github.com/DigitPaint/skyline).
 You can use it as a Git submodule or yust download the zip version and unpack it to
-`vendor/plugins/skyline`
+`vendor/skylinecms`
 
 If you're using bundler, add the following to your `Gemfile`
 
-    skyline_gemfile = File.join(File.dirname(__FILE__), 'vendor', 'plugins', 'skyline', 'Gemfile')
-    instance_eval(File.read(skyline_gemfile), skyline_gemfile)
+    gem "skylinecms", :path => "vendor/skylinecms"
+
+Run bundler
+-----------
+
+Just run bundle install to fetch and install all dependencies:
+
+    bundle install
+
+Bootstrap skyline
+-----------------
+
+Run the skyline init script to initialize all required configurations. You might want to skip this step
+if you want to update Skyline frequently (you can do most of these steps by hand: see below)
+
+    bundle exec skylinecms init
 
 Setup your database
 -------------------
 
-Modify `config/database.yml` to match your database configuration and then run:
+Modify `config/database.yml` to match your database configuration if needed. Run:
 
     rake db:create
     rake skyline:db:migrate
@@ -56,19 +69,34 @@ Modify `config/database.yml` to match your database configuration and then run:
 Create your first user and grant him/her access
 -----------------------------------------------
 
-Open a Rails console by running `./script/console`
+Open a Rails console by running `rails console`
 
-    u = Skyline::User.new(:email => 'admin@admin.com', :password => 'secret')
-    u.roles << Skyline::Role.first
-    u.save!
+    user = Skyline::User.new(:email => 'admin@admin.com', :password => 'secret')
+    user.grants.build(:role => Skyline::Role.find_by_name("super"))
+    user.save
 
 Make sure the user exists in the database.
 
-If you went the "gem route" you're done now just start the server with `./script/server`
-and browse to `http://localhost:3000/skyline` and log in with the just created user.
+Boot your server!
+-----------------
+
+You should be good to go. Start your server:
+
+    rails server
+    
+and browse to *http://localhost:9000/skyline* to reach Skyline. 
+
+Where to go from here?
+----------------------
+
+* Check the documentation
+* Look at our [sample implementation on github](http://github.com/DigitPaint/skyline_demo_site)
+* Roam around our Google Group ([http://groups.google.com/group/skylinecms](http://groups.google.com/group/skylinecms))
+* Follow us on twitter [@skylinecms](http://twitter.com/skylinecms)
+
 
-Extra work when using the plugin
---------------------------------
+Configurating Skyline manually
+------------------------------
 
 ### Create configuration file
 
@@ -78,7 +106,6 @@ add the following:
     Skyline::Configuration.configure do |config|  
       config.assets_path = File.join(Rails.root,"tmp/upload")
       config.media_file_cache_path = File.join(Rails.root,"tmp/cache/media_files/cache")
-      config.rss_section_cache_path = File.join(Rails.root,"tmp/cache/rss_sections/cache")   
     end
 
 ### Create template folder
@@ -91,4 +118,4 @@ Create the template folder in your `app` directory.
 
 Open `config/routes.rb` and add the default Skyline route below all other routes:
 
-    map.connect '*url', :controller => "skyline/site/pages", :action => "show"  
+    match '(*url)', :to => "skyline/site/pages#show", :constraints => Skyline::RouteConstraint

data/doc/MIGRATION.md

@@ -6,12 +6,37 @@ General update recipe
 
 After every Skyline update make sure that:
 
-* You have updated your `Gemfile`, or the `config.gem` specifications in your `environment.rb`.
+* You have updated your `Gemfile`
 * Run `rake skyline:db:migrate` to update your Skyline tables.
 * Run `rake skyline:db:seed` to update roles/rights and other important data updates.
-* **Plugin users only!** The assets (`RAILS_ROOT/public/skyline`) are from the new version. If they are symlinked, Skyline will 
+* The assets (`RAILS_ROOT/public/skyline`) are from the new version. If they are symlinked, Skyline will 
   take care of them for you.
 
+
+Version 3.1.0 -> Version 3.2.0
+------------------------------
+
+**Important**: Skyline now is Rails 3.0.x only!!
+
+**Important**: Read the changelog for Skyline 3.2.0!!
+
+Skyline is now a fully-fledged Rails 3.0.x engine and should be used as such. 
+
+## For custom sections ##
+
+* Skyline no longer enforces it's own FormBuilder, so instead of `form_for` / `fields_for` use
+  `skyline_form_for` and `skyline_fields_for` in your edit interface.
+
+## For custom Artciles ##
+
+The following things have changed and may have effect on your implementation:
+
+* [Articles] Remove Article#enable_publishing? in favour of the documented Article.publishable?
+* [Articles] Remove Article#enable_locking? in favour of Article#lockable? and Article.lockable?
+* [Articles] Remove Article#enable_multiple_variants? in favour of Article.can_have_multiple_variants? and Article#can_have_multiple_variants?
+* [Articles] Remove unused Article#rollbackable?
+
+
 Version 3.0.8 -> Version 3.1.0
 ------------------------------
 

data/lib/skyline.rb

@@ -22,4 +22,5 @@ module Skyline
   end
   module_function :version  
   
-end
+end
+

data/lib/skyline/authentication/user.rb

@@ -0,0 +1,80 @@
+# Use this module in your User model you want Skyline to use. By default Skyline
+#  uses its own Skyline::User model, but you can specify your own using this
+#  interface.
+#
+# @example Usage
+#
+# class User < ActiveRecord::Base
+#   include Skyline::Authentication::User
+#   
+#   def self.authenticate(email, password)
+#     self.first(:conditions => {:email => email.to_s.downcase, :password => encrypt(password.to_s)})
+#   end
+#   
+#   def identification
+#     self.id
+#   end
+# 
+#   def allow?(right_or_class, suffix = nil)
+#     true
+#   end
+#   
+#   def display_name
+#     self.name.present? ? self.name : self.email
+#   end
+# end
+#
+module Skyline::Authentication::User
+
+  def self.included(base)
+    raise(TypeError, "Expected #{base.inspect} to be a subclass of ActiveRecord::Base") unless base < ActiveRecord::Base
+    base.send(:has_many, :user_preferences, :class_name => "Skyline::UserPreference")
+  end
+    
+  # Return the logged in user when successfully authenticated
+  #
+  # @see Skyline::Authentication::User For a usage example.
+  #
+  # @overload self.authenticate(email, password)
+  #   @param email [String] The e-mail address or username of the user.
+  #   @param password [String] The password the user entered.
+  #
+  # @return <User>:: an instance of the class this module includes
+  def self.authenticate(email, password)
+    raise "self.authenticate(email, password) is not implemented yet"
+  end
+  
+  # Return the unique identifier for this user (probably the DB id)
+  #
+  # @return <Integer,String>:: an identification String or Integer
+  def identification
+    raise "identification is not implemented yet"
+  end
+  
+  # Check if a user has a specific right
+  #
+  # @see Skyline::Authentication::User For a usage example.
+  #
+  # @overload allow?(right_or_class, suffix = nil)
+  #   @param right_or_class [String,Symbol,~right_prefix] Can be a string or a symbol to check a 
+  #     specific right, or you can pass an object that responds to #right_prefix, right_prefix must 
+  #     return a string
+  #   @param suffix [String,Symbol] A suffix to append to the right, mostly usefull in combination 
+  #     with an object
+  #
+  # @return <Boolean>:: true if the right exists in one of the roles fo the user
+  def allow?(right_or_class, suffix = nil)
+    raise "allow?(right_or_class, suffix = nil) is not implemented yet"
+  end
+  
+  # Display the name or e-mailaddress of the user for display purposes.
+  #
+  # @see Skyline::Authentication::User For a usage example.
+  #
+  # @overload display_name
+  #
+  # @return <String>:: The user's name to be displayed in Skyline
+  def display_name
+    raise "display_name is not implemented yet"
+  end
+end

data/lib/skyline/belongs_to_referable.rb

@@ -113,7 +113,7 @@ module Skyline::BelongsToReferable
   
   # @private
   def clone_with_referable_content
-    returning clone_without_referable_content do |clone|      
+    clone_without_referable_content.tap do |clone|      
       if self.referable_contents.any?
         self.referable_contents.each do |field|
           if self.send(field).present?

data/lib/skyline/cli/init.rb

@@ -1,3 +1,4 @@
+require 'thor/group'
 require 'pathname'
 require 'fileutils'
 
@@ -15,34 +16,24 @@ module Skyline
         say "=> Verifying if this is a Rails(like) app"
         unless (self.target_dir + "lib").exist? &&
             (self.target_dir + "public").exist? &&
-            (self.target_dir + "config/environment.rb").exist?
+            (self.target_dir + "Gemfile").exist?
             
-          raise Thor::Error, "This does not seem like a valid Rails app (need lib, public and config/environment.rb)"
+          raise Thor::Error, "This does not seem like a valid Rails app (need lib, public and Gemfile)"
         end
       end
       
-      def add_config_gem
-        environment_rb = (self.target_dir + "config/environment.rb")
-        if File.read(environment_rb) =~ /^\s*config.gem\s+[\":']skylinecms[\"']?(.+[\":']version[\"']?\s*=>\s*[\"'](.+)[\"'])?/i
+      def add_to_gemfile
+        gemfile = (self.target_dir + "Gemfile")
+        if File.read(gemfile) =~ /^\s*gem\s+[\":']skylinecms[\"']?\s*,\s*([\"'](.+)[\"'])?/i
           say_status "exist", "Already found gem version #{$2}, not doing anything, check gem dependency manually", :blue
         else
-          say "=> Adding config.gem line to environment.rb"
-          inject_into_file environment_rb, :after => "Rails::Initializer.run do |config|\n" do
-            "  config.gem \"skylinecms\", :version => \"#{Skyline::VERSION::STRING}\"\n"
+          say "=> Adding gem line to Gemfile"
+          append_to_file gemfile do
+            "  gem \"skylinecms\", \"~>#{Skyline::VERSION::STRING}\"\n"
           end
         end
       end
       
-      def create_stub_tasks_file
-        tasks_dir = (self.target_dir + "lib/tasks")
-        
-        say "=> Creating lib/tasks directory"
-        empty_directory tasks_dir
-        
-        say "=> Creating lib/tasks/skyline.rake"
-        copy_file self.template_dir + "tasks/skyline.rake", tasks_dir + "skyline.rake"
-      end
-      
       def copy_assets
         say "=> Copying assets"
         
@@ -80,17 +71,14 @@ module Skyline
       
       def add_default_pages_route
         routes_rb = self.target_dir + "config/routes.rb"
-        route_string = "map.connect '*url', :controller => \"skyline/site/pages\", :action => \"show\""
-        
+        routing_code = "match '(*url)', :to => \"skyline/site/pages#show\", :constraints => Skyline::RouteConstraint"
+        sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+
         say "=> Add default pages route"
-        if File.read(routes_rb) =~ /#{Regexp.escape(route_string)}$/
+        if File.read(routes_rb) =~ /#{Regexp.escape(routing_code)}$/
           say_status "exist", "default pages route", :blue
         else
-          inject_into_file routes_rb, :after => "map.connect ':controller/:action/:id.:format'\n" do
-            "\n" +
-            "  # The default Skyline pages route\n" +
-            "  #{route_string}\n"
-          end
+          inject_into_file routes_rb, "\n  #{routing_code}\n", { :after => sentinel, :verbose => false }
         end
       end