zen 0.4.2 → 0.4.3

data/lib/zen/public/admin/zen/js/lib/hash.js

@@ -40,35 +40,35 @@ namespace('Zen');
  *
  *     hash.getHash(); // => "#!/users/active?limit=10"
  *
- * @since 19-12-2011
+ * @since 2011-12-19
  */
 Zen.Hash = new Class(
 {
     /**
      * String containing the raw URL hash before it was parsed.
      *
-     * @since 19-12-2011
+     * @since 2011-12-19
      */
     raw_hash: '',
 
     /**
      * Object containing all the parsed hash parameters.
      *
-     * @since 19-12-2011
+     * @since 2011-12-19
      */
     params: {},
 
     /**
      * Array containing all the hash segments.
      *
-     * @since 19-12-2011
+     * @since 2011-12-19
      */
     segments: [],
 
     /**
      * Creates a new instance of the class, sets the raw hash and parses it.
      *
-     * @since 19-12-2011
+     * @since 2011-12-19
      * @param {string} hash The URL hash to parse.
      */
     initialize: function(hash)
@@ -79,7 +79,7 @@ Zen.Hash = new Class(
     /**
      * Parses the supplied hash and stores the results in ``this.params``.
      *
-     * @since 19-12-2011
+     * @since 2011-12-19
      * @param {string} hash The hash to parse.
      */
     parse: function(hash)
@@ -140,7 +140,7 @@ Zen.Hash = new Class(
      * Returns a string containing the hash URL for the current segments and
      * parameters.
      *
-     * @since  19-12-2011
+     * @since  2011-12-19
      * @return {string}
      */
     getHash: function()

data/lib/zen/public/admin/zen/js/lib/tabs.js

@@ -100,7 +100,7 @@ Zen.Tabs = new Class(
      * Binds various events to show the right tab fields when a tab is clicked
      * or when the URL hash is changed.
      *
-     * @since 21-12-2011
+     * @since 2011-12-21
      */
     addEvents: function()
     {
@@ -134,7 +134,7 @@ Zen.Tabs = new Class(
      * Determines the default tab field to display based on the option
      * ``this.options.default`` or the current hash URL.
      *
-     * @since 21-12-2011
+     * @since 2011-12-21
      */
     displayDefault: function()
     {
@@ -164,7 +164,7 @@ Zen.Tabs = new Class(
     /**
      * Activates the tab field for the given ID.
      *
-     * @since 21-12-2011
+     * @since 2011-12-21
      * @param {string} id The ID of the tab field to show.
      */
     toggleTab: function(id)

data/lib/zen/public/admin/zen/js/lib/window.js

@@ -105,7 +105,7 @@ Zen.Window = new Class(
     /**
      * The background overlay for the current window.
      *
-     * @since 18-12-2011
+     * @since 2011-12-18
      */
     overlay: null,
 

data/lib/zen/security.rb

@@ -3,7 +3,7 @@ module Zen
   # Module for dealing with various security related actions such as sanitizing
   # user input/output.
   #
-  # @since 07-01-2012
+  # @since 2012-01-07
   #
   module Security
     class << self
@@ -21,7 +21,7 @@ module Zen
       #
       #  Zen::Input.sanitize(input) # => "Hello \#\{puts 10\}"
       #
-      # @since  03-01-2012
+      # @since  2012-01-03
       # @param  [String] input The input string to sanitize.
       # @param  [TrueClass|FalseClass] clean_html When set to true certain HTML
       #  elements will be removed using Loofah.

data/lib/zen/spec/helper.rb

@@ -1,12 +1,6 @@
-require 'ramaze'
-require 'stringio'
-
-Ramaze.setup(:verbose => false) do
-  gem 'capybara', ['>= 1.1.1']
-  gem 'bacon'   , ['>= 1.1.0']
-  gem 'webmock' , ['>= 1.6.4']
-end
-
+require 'capybara'
+require 'bacon'
+require 'webmock'
 require 'capybara/dsl'
 require 'ramaze/spec/bacon'
 

data/lib/zen/spec/helper/capybara.rb

@@ -4,7 +4,7 @@ module Zen
       ##
       # Module providing various helper methods for Capybara based tests.
       #
-      # @since 18-02-2012
+      # @since 2012-02-18
       #
       module Capybara
         ##
@@ -30,7 +30,7 @@ module Zen
         ##
         # Automatically saves a form with the given ID.
         #
-        # @since 18-02-2012
+        # @since 2012-02-18
         # @param [String] id The ID of the form.
         #
         def autosave_form(id)
@@ -50,7 +50,7 @@ module Zen
         ##
         # Switches Capybara's driver to the default Javascript driver.
         #
-        # @since 18-02-2012
+        # @since 2012-02-18
         #
         def enable_javascript
           WebMock.disable!
@@ -63,7 +63,7 @@ module Zen
         ##
         # Switches Capybara's driver back to the default driver.
         #
-        # @since 18-02-2012
+        # @since 2012-02-18
         #
         def disable_javascript
           ::Capybara.use_default_driver

data/lib/zen/spec/helper/general.rb

@@ -4,7 +4,7 @@ module Zen
       ##
       # Module providing general spec helpers.
       #
-      # @since 18-02-2012
+      # @since 2012-02-18
       #
       module General
         ##

data/lib/zen/spec/simplecov.rb

@@ -1,8 +1,4 @@
-require 'ramaze'
-
-Ramaze.setup(:verbose => false) do
-  gem 'simplecov', ['>= 0.4.2']
-end
+require 'simplecov'
 
 SimpleCov.configure do
   root         __DIR__('../../../')

data/lib/zen/task/build.rake

@@ -1,23 +1,29 @@
 namespace :build do
-  desc 'Build the YARD docs'
-  task :doc => ['clean:yard'] do
-    root = File.expand_path('../../../../', __FILE__)
-    Dir.chdir(root)
+  desc 'Generates the Manifest'
+  task :manifest do
+    files  = `git ls-files`.split("\n").sort
+    handle = File.open(File.expand_path('../../../../MANIFEST', __FILE__), 'w')
 
-    sh('yard doc')
+    handle.write(files.join("\n"))
+    handle.close
   end
 
-  desc 'Builds a new Gem'
-  task :gem do
-    root = File.expand_path('../../../../', __FILE__)
-    name = "#{Zen::Gemspec.name}-#{Zen::Gemspec.version.version}.gem"
-    path = File.join(root, name)
-    pkg  = File.join(root, 'pkg', name)
-
-    # Build and install the gem
-    sh('gem', 'build', File.join(root, 'zen.gemspec'))
-    sh('mv' , path, pkg)
-    sh('gem', 'install', pkg)
+  desc 'Generates a .gems file for RVM'
+  task :gems do
+    handle   = File.open(File.expand_path('../../../../.gems', __FILE__), 'w')
+    run_deps = ['# Runtime Dependencies']
+    dev_deps = ['# Development Dependencies']
+
+    GEMSPEC.dependencies.each do |gem|
+      if gem.type == :runtime
+        run_deps << gem.name + ' -v ' + gem.requirement.to_s.gsub('~> ', '')
+      else
+        dev_deps << gem.name
+      end
+    end
+
+    handle.write(run_deps.sort.join("\n") + "\n\n" + dev_deps.sort.join("\n"))
+    handle.close
   end
 
   desc 'Build a list of changes'

data/lib/zen/task/db.rake

@@ -77,8 +77,9 @@ namespace :db do
 
     if group.nil?
       group = Users::Model::UserGroup.new(
-        :name => 'Administrators',
-        :slug => 'administrators', :super_group => true
+        :name        => 'Administrators',
+        :slug        => 'administrators',
+        :super_group => true
       ).save
     end
 

data/lib/zen/task/spelling.rake

@@ -1,22 +1,22 @@
-# Task that checks the documentation for spelling errors using Raspell/Aspell.
-# This task requires Aspell to be installed along with an English dictionary. On
-# Arch Linux these can be installed as following:
+# Task that checks the documentation for spelling errors using Aspell.  This
+# task requires Aspell to be installed along with an English dictionary. On Arch
+# Linux these can be installed as following:
 #
 #     $ sudo pacman -S aspell aspell-en
 #
 desc 'Search docs for spelling errors'
 task :spelling do
-  require 'raspell'
+  require 'ffi/aspell'
   require 'ripper'
 
-  speller = Aspell.new1(
-    'lang'        => 'en',
+  speller = FFI::Aspell::Speller.new(
+    'en',
     'personal'    => File.expand_path('../../../../.aspell.en.pws', __FILE__),
-    'ignore-case' => 'true'
+    'ignore-case' => true
   )
 
   base_dir         = File.expand_path('../../../..', __FILE__)
-  files            = Dir['lib/zen/**/*.rb']
+  files            = Dir['lib/zen/**/*.rb'] + Dir['guide/**/*.md']
   exclude_lines    = [/^#\s*@/, /^#\s{2,}/, /^#\s*!\[/, /^#\s*\[/]
   exclude_patterns = [/\d+/, /_+/, /^`/]
 
@@ -68,8 +68,8 @@ task :spelling do
 
         next if skip == true
 
-        unless speller.check(word)
-          suggested = speller.suggest(word)[0]
+        unless speller.correct?(word)
+          suggested = speller.suggestions(word)[0]
 
           if suggested
             errors << {

data/lib/zen/task/test.rake

@@ -1,40 +1,50 @@
 namespace :test do
-  spec_dir = File.expand_path('../../../../spec', __FILE__)
-  command  = 'rake db:delete; rake db:migrate; rake db:test_user; ' \
-    'ruby zen/all.rb'
-
-  desc 'Run specifications'
+  desc 'Run test using default settings'
   task :default do
-    Dir.chdir(spec_dir)
+    Dir.chdir(File.expand_path('../../../../spec', __FILE__))
+
+    sh('rake db:delete')
+    sh('rake db:migrate')
+    sh('rake db:test_user')
 
-    sh(command)
+    # Hack to prevent Simplecov from generating code coverage while migrating
+    # the database.
+    if ENV['_COVERAGE']
+      ENV['_COVERAGE'] = nil
+      ENV['COVERAGE']  = '1'
+    end
+
+    sh('ruby zen/all.rb')
   end
 
-  desc 'Runs specifications using MySQL'
+  desc 'Run tests using MySQL'
   task :mysql do
-    Dir.chdir(spec_dir)
-
     ENV['DATABASE'] = 'zen_dev'
     ENV['ADAPTER']  = 'mysql2'
     ENV['USERNAME'] = 'zen'
 
-    sh(command)
+    Rake::Task['test:default'].invoke
   end
 
-  desc 'Runs specifications using PostgreSQL'
+  desc 'Run tests using PostgreSQL'
   task :postgres do
-    Dir.chdir(spec_dir)
-
     ENV['DATABASE'] = 'zen_dev'
     ENV['ADAPTER']  = 'postgres'
     ENV['USERNAME'] = 'zen'
 
-    sh(command)
+    Rake::Task['test:default'].invoke
+  end
+
+  desc 'Generates code coverage'
+  task :coverage do
+    ENV['_COVERAGE'] = '1'
+
+    Rake::Task['test:default'].invoke
   end
 
   # Task that ensures that the various Travis CI tests each use their own
   # database based on the Ruby version.
-  desc 'Runs the tests for Travis CI'
+  desc 'Run tests for Travis CI'
   task :travis do
     suffix = '_' + RUBY_VERSION.gsub('.', '_')
 
@@ -48,8 +58,6 @@ namespace :test do
       end
     end
 
-    Dir.chdir(spec_dir)
-
-    sh(command)
+    Rake::Task['test:default'].invoke
   end
 end

data/lib/zen/theme.rb

@@ -97,7 +97,7 @@ module Zen
   #
   # <div class="note deprecated">
   #     <p>
-  #         <strong>Warning</strong>: Most likely your template will use files
+  #         <strong>Warning:</strong> Most likely your template will use files
   #         such as CSS and Javascript files. It's important to store these
   #         under their own namespace similar to assets used in the backend to
   #         prevent any collisions.
@@ -257,7 +257,7 @@ module Zen
   #
   # <div class="note deprecated">
   #     <p>
-  #         <strong>Warning</strong>: Don't run custom SQL queries inside your
+  #         <strong>Warning:</strong> Don't run custom SQL queries inside your
   #         templates, create a helper, regular class or module if you want to
   #         retrieve custom data.
   #     </p>
@@ -291,7 +291,7 @@ module Zen
   #
   # <div class="note todo">
   #     <p>
-  #         <strong>Note</strong>: The variables set in the partial method are
+  #         <strong>Note:</strong> The variables set in the partial method are
   #         available as instance variables, not regular variables.
   #     </p>
   # </div>
@@ -376,7 +376,7 @@ module Zen
     ##
     # Creates a new instance of the theme.
     #
-    # @since 12-02-2012
+    # @since 2012-02-12
     #
     def initialize
       @env = OpenStruct.new
@@ -396,7 +396,7 @@ module Zen
     # Returns the name of the theme as either plain text or an anchor tag if the
     # URL attribute is set.
     #
-    # @since  19-11-2011
+    # @since  2011-11-19
     # @return [String]
     #
     def formatted_name
@@ -430,7 +430,7 @@ module Zen
     # Returns the name of the default template group or "default" if no custom
     # name is set.
     #
-    # @since  22-11-2011
+    # @since  2011-11-22
     # @return [String]
     #
     def default_template_group

data/lib/zen/version.rb

@@ -1,4 +1,4 @@
 module Zen
   # :nodoc:
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/spec/zen/all.rb

@@ -1,5 +1,9 @@
 require File.expand_path('../../helper', __FILE__)
 
+puts "# Ruby version: #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+puts "# Database adapter: #{Zen.database.adapter_scheme}"
+puts "# Database: #{ENV['DATABASE'] || 'SQLite3'}"
+
 Dir.glob(__DIR__ + '/**/*.rb').each do |t|
   require(t) if File.basename(t) != 'all.rb'
 end

data/spec/zen/package/sections/controller/revisions.rb

@@ -0,0 +1,235 @@
+require File.expand_path('../../../../../helper', __FILE__)
+
+describe 'Sections::Controller::Revisions' do
+  behaves_like :capybara
+
+  textbox_id  = CustomFields::Model::CustomFieldType[:name => 'textbox'].id
+  checkbox_id = CustomFields::Model::CustomFieldType[:name => 'checkbox'].id
+  section     = Sections::Model::Section.create(
+    :name                    => 'Spec section',
+    :comment_allow           => true,
+    :comment_require_account => true,
+    :comment_moderate        => true,
+    :comment_format          => 'plain'
+  )
+
+  group = CustomFields::Model::CustomFieldGroup.create(:name => 'Spec fields')
+
+  field = CustomFields::Model::CustomField.create(
+    :name                  => 'Spec field',
+    :sort_order            => 0,
+    :format                => 'markdown',
+    :required              => true,
+    :text_editor           => false,
+    :custom_field_group_id => group.id,
+    :custom_field_type_id  => textbox_id
+  )
+
+  field_1 = CustomFields::Model::CustomField.create(
+    :name                  => 'Spec checkbox',
+    :sort_order            => 1,
+    :format                => 'plain',
+    :required              => true,
+    :text_editor           => false,
+    :custom_field_group_id => group.id,
+    :custom_field_type_id  => checkbox_id,
+    :possible_values       => "Yorick Peterse|yorick\nChuck Norris|chuck"
+  )
+
+  section.custom_field_group_pks = [group.id]
+
+  entries_url    = Sections::Controller::SectionEntries.r(:index, section.id).to_s
+  edit_url       = Sections::Controller::SectionEntries.r(:edit, section.id).to_s
+  revisions_url  = lang('revisions.titles.index')
+  restore_url    = lang('revisions.labels.restore')
+  new_button     = lang('section_entries.buttons.new')
+  save_button    = lang('section_entries.buttons.save')
+  compare_button = lang('revisions.buttons.compare')
+  title_field    = lang('section_entries.labels.title')
+
+  it 'Create a new revision each time a section entry is saved' do
+    visit(entries_url)
+
+    click_on(new_button)
+
+    within '#section_entry_form' do
+      fill_in(title_field, :with => 'Entry with revisions')
+      fill_in(field.name, :with => 'Original value')
+      check("form_custom_field_value_#{field_1.id}_0")
+
+      click_on(save_button)
+    end
+
+    current_path.should                         =~ /#{edit_url}\/[0-9]+/
+    page.has_selector?('.message.error').should == false
+
+    9.times do |number|
+      within '#section_entry_form' do
+        fill_in(field.name, :with => "Modified #{number}")
+
+        click_on(save_button)
+      end
+    end
+
+    page.find_field(field.name).value.should == 'Modified 8'
+
+    Sections::Model::SectionEntry[:title => 'Entry with revisions'] \
+      .revisions.length.should == 10
+  end
+
+  it 'Compare two different revisions' do
+    entry = Sections::Model::SectionEntry[:title => 'Entry with revisions']
+    url   = Sections::Controller::Revisions \
+      .r(:index, entry.section_id, entry.id) \
+      .to_s
+
+    revisions = Sections::Model::Revision.filter(:section_entry_id => entry.id) \
+      .order(:id.asc) \
+      .all
+
+    visit(entries_url)
+    click_on(revisions_url)
+
+    page.current_path.should                == url
+    page.all('table tbody tr').count.should == 10
+
+    choose("old_revision_id_#{revisions[0].id}")
+    choose("new_revision_id_#{revisions[1].id}")
+
+    click_on(compare_button)
+
+    page.has_selector?('.diff').should              == true
+    page.has_selector?('.diff .ins').should         == true
+    page.has_selector?('.diff .del').should         == true
+    page.has_selector?('.diff .line_number').should == true
+
+    page.has_content?('Original value').should == true
+    page.has_content?('Modified 0').should     == true
+
+    page.find('.diff .del').text.strip.should == '-Original value'
+    page.find('.diff .ins').text.strip.should == '+Modified 0'
+
+    choose("old_revision_id_#{revisions[1].id}")
+    choose("new_revision_id_#{revisions[2].id}")
+
+    click_on(compare_button)
+
+    page.find('.diff .del').text.strip.should == '-Modified 0'
+    page.find('.diff .ins').text.strip.should == '+Modified 1'
+  end
+
+  it 'Compare the same two revisions' do
+    entry = Sections::Model::SectionEntry[:title => 'Entry with revisions']
+    url   = Sections::Controller::Revisions \
+      .r(:index, entry.section_id, entry.id) \
+      .to_s
+
+    revisions = Sections::Model::Revision.filter(:section_entry_id => entry.id) \
+      .order(:id.asc) \
+      .all
+
+    visit(entries_url)
+    click_on(revisions_url)
+
+    page.current_path.should                == url
+    page.all('table tbody tr').count.should == 10
+
+    choose("old_revision_id_#{revisions[0].id}")
+    choose("new_revision_id_#{revisions[0].id}")
+
+    click_on(compare_button)
+
+    page.has_selector?('.diff').should                                  == false
+    page.has_content?(lang('revisions.messages.no_differences')).should == true
+  end
+
+  it 'The oldest revision should be removed if the limit is exceeded' do
+    entry  = Sections::Model::SectionEntry[:title => 'Entry with revisions']
+    oldest = entry.revisions[-1].id
+
+    visit(entries_url)
+
+    click_on('Entry with revisions')
+
+    5.times do |number|
+      within '#section_entry_form' do
+        fill_in(field.name, :with => "Overwritten #{number}")
+        click_on(save_button)
+      end
+    end
+
+    revisions = Sections::Model::Revision.filter(:section_entry_id => entry.id) \
+      .order(:id.asc) \
+      .all
+
+    revisions.length.should == 10
+    revisions[0].id.should  > oldest
+  end
+
+  it 'Gracefully handle non numeric revision IDs' do
+    visit(entries_url)
+    visit(Sections::Controller::Revisions.r(:restore, 'a').to_s)
+
+    page.current_path.should                    == entries_url
+    page.has_selector?('.message.error').should == true
+  end
+
+  it 'Restore a revision and delete newer revisions' do
+    visit(entries_url)
+    click_on(revisions_url)
+
+    within 'table tbody tr:last-child' do
+      click_on(restore_url)
+    end
+
+    page.has_selector?('.message.success').should == true
+    page.all('table tbody tr').count.should       == 1
+
+    Sections::Model::SectionEntry[:title => 'Entry with revisions'] \
+      .revisions \
+      .length \
+      .should == 1
+
+    visit(entries_url)
+    click_on('Entry with revisions')
+
+    page.find_field(field.name).value.should == 'Modified 4'
+  end
+
+  it 'Compare array based values of two revisions' do
+    visit(entries_url)
+
+    click_on('Entry with revisions')
+
+    within '#section_entry_form' do
+      check("form_custom_field_value_#{field_1.id}_1")
+      click_on(save_button)
+    end
+
+    page.has_selector?('.message.error').should == false
+
+    visit(entries_url)
+    click_on(revisions_url)
+
+    entry     = Sections::Model::SectionEntry[:title => 'Entry with revisions']
+    revisions = Sections::Model::Revision.filter(:section_entry_id => entry.id) \
+      .order(:id.asc) \
+      .all
+
+    choose("old_revision_id_#{revisions[-1].id}")
+    choose("new_revision_id_#{revisions[-2].id}")
+
+    click_on(compare_button)
+
+    page.has_selector?('.diff .ins').should == false
+    page.has_selector?('.diff .del').should == true
+
+    page.has_content?('yorick').should == true
+    page.has_content?('chuck').should  == true
+  end
+
+  field.destroy
+  field_1.destroy
+  group.destroy
+  section.destroy
+end