kiteditor 1.0.1

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,211 @@
+# TL;DR: YOU SHOULD DELETE THIS FILE
+#
+# This file was generated by Cucumber-Rails and is only here to get you a head start
+# These step definitions are thin wrappers around the Capybara/Webrat API that lets you
+# visit pages, interact with widgets and make assertions about page content.
+#
+# If you use these step definitions as basis for your features you will quickly end up
+# with features that are:
+#
+# * Hard to maintain
+# * Verbose to read
+#
+# A much better approach is to write your own higher level step definitions, following
+# the advice in the following blog posts:
+#
+# * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
+# * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
+# * http://elabs.se/blog/15-you-re-cuking-it-wrong
+#
+
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within ([^:]+)$/ do |s, parent|
+  with_scope(parent) { step(s) }
+end
+
+# Multi-line step scoper
+When /^(.*) within ([^:]+):$/ do |s, parent, table_or_string|
+  with_scope(parent) { step "#{s}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    step %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
+
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/features/support/env.rb

@@ -0,0 +1,46 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+require 'cucumber/rails'
+require 'capybara/firebug'
+
+# You can enable firebug in your tests by tagging them @firebug.
+# To change the version of firebug use the FIREBUG_VERSION environment variable.
+# For firefox 4+ use 1.7.0
+# For firefox 3 use 1.6.2
+Selenium::WebDriver::Firefox::Profile.firebug_version = ENV['FIREBUG_VERSION'] || '1.8.3'
+
+# Capybara defaults to XPath selectors rather than Webrat's default of CSS3. In
+# order to ease the transition to Capybara we set the default here. If you'd
+# prefer to use XPath just remove this line and adjust any selectors in your
+# steps to use the XPath syntax.
+Capybara.default_selector = :css
+Capybara.ignore_hidden_elements = true
+
+# By default, any exception happening in your Rails application will bubble up
+# to Cucumber so that your scenario will fail. This is a different from how
+# your application behaves in the production environment, where an error page will
+# be rendered instead.
+#
+# Sometimes we want to override this default behaviour and allow Rails to rescue
+# exceptions and display an error page (just like when the app is running in production).
+# Typical scenarios where you want to do this is when you test your error pages.
+# There are two ways to allow Rails to rescue exceptions:
+#
+# 1) Tag your scenario (or feature) with @allow-rescue
+#
+# 2) Set the value below to true. Beware that doing this globally is not
+# recommended as it will mask a lot of errors for you!
+#
+ActionController::Base.allow_rescue = false
+
+# Remove/comment out the lines below if your app doesn't have a database.
+# For some databases (like MongoDB and CouchDB) you may need to use :truncation instead.
+begin
+  DatabaseCleaner.strategy = :transaction
+rescue NameError
+  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
+end

data/features/support/mercury_contents.rb

@@ -0,0 +1,25 @@
+module MercuryContentsHelpers
+  def contents_for(name)
+    case name
+      when 'simple content' then "this is <span>simple</span> <b>content</b>"
+      when 'justifiable content' then "<div>first line</div><br/>this is <span>justifiable</span> <b>content</b>"
+      when 'wrapped content' then "<span>this <a href='http://google.com'>is</a> <i>wrapped</i> <b>content</b></span>"
+      when 'an image' then "this is <img src='/assets/mercury/temp-logo.png'> <b>content</b>"
+      when 'a table' then "this is a <table><tr><td><span>1</span></td><td><span>2</span></td></tr><tr><td><span>3</span></td><td><span>4</span></td></tr></table> <b>content</b>"
+      when 'the snippet', 'that snippet' then "<div class='mercury-snippet' data-snippet='#{@snippet_id || 'snippet_42'}'>#{@snippet_id || 'snippet_42'}</div> <b>content</b>"
+
+      else name
+    end
+  end
+
+  def parse_snippet_options_from(options_string)
+    json = []
+    options_string.scan(/(?:,\s)?([^:]*): ("[^"]*")/).each do |pair|
+      json << %Q{'options[#{pair[0]}]': #{pair[1]}}
+    end
+
+    "{#{json.join(', ')}}"
+  end
+end
+
+World(MercuryContentsHelpers)

data/features/support/mercury_selectors.rb

@@ -0,0 +1,148 @@
+module MercurySelectorsHelpers
+
+  def mercury_selector_for(locator)
+    case locator
+
+      # toolbar selectors
+      when 'the toolbar' then '.mercury-toolbar-container'
+
+      when /^the "(.*?)" button$/
+        ".mercury-primary-toolbar .mercury-#{mercury_button_mapping_for($1)}-button"
+
+      when /^the (.*?) editor (button|dropdown|palette)$/
+        ".mercury-editable-toolbar .mercury-#{mercury_button_mapping_for($1)}-button"
+
+      when /^the (.*?) toolbar button$/
+        ".mercury-snippet-toolbar .mercury-#{mercury_button_mapping_for($1)}-button"
+
+      when /^the (.*?) select$/
+        ".mercury-#{mercury_button_mapping_for($1)}-select"
+
+      when /^the (.*?) palette$/
+        ".mercury-#{mercury_button_mapping_for($1)}-palette"
+
+      # palette / select dropdown
+      when 'the color red' then '.mercury-palette .picker:nth-child(22n)'
+
+      when 'the red style' then '.mercury-select-options .red'
+      when 'the heading 2 block' then '.mercury-select-options h2'
+
+      # statusbar selectors
+      when 'the statusbar' then '.mercury-statusbar'
+      when 'the about the editor link' then 'a.mercury-statusbar-about'
+
+      # panel selectors
+      when 'the panel', /^the (.*?) panel$/ then '.mercury-panel'
+
+      # modal window selectors
+      when 'the modal', 'the modal window', /^the (.*?) modal$/ then '.mercury-modal'
+      when 'the modal overlay' then '.mercury-modal-overlay'
+      when 'the modal title' then '.mercury-modal h1.mercury-modal-title'
+      when 'the modal close button' then '.mercury-modal h1.mercury-modal-title a'
+
+      when 'the sweet snowman' then '.mercury-modal .character:nth-child(247n)'
+
+      when 'the first cell in the first row' then '.mercury-modal tr:nth-child(1n) td:nth-child(1n)'
+      when 'the third cell in the first row' then '.mercury-modal tr:nth-child(1n) td:nth-child(3n)'
+      when 'the forth cell in the first row' then '.mercury-modal tr:nth-child(1n) td:nth-child(4n)'
+      when 'the second cell in the second row' then '.mercury-modal tr:nth-child(2n) td:nth-child(2n)'
+      when 'the forth cell in the second row' then '.mercury-modal tr:nth-child(2n) td:nth-child(4n)'
+
+      when 'a selected cell' then '.mercury-modal td.selected'
+
+      # lightview selectors
+      when 'the lightview', 'the lightview window', /^the (.*?) lightview$/ then '.mercury-lightview'
+      when 'the lightview overlay' then '.mercury-lightview-overlay'
+      when 'the lightview title' then '.mercury-lightview h1.mercury-lightview-title'
+      when 'the lightview close button' then '.mercury-lightview h1.mercury-lightview-title a'
+
+      # snippet selectors
+      when 'the snippet toolbar' then '.mercury-snippet-toolbar'
+      when 'the snippet', 'that snippet' then "div[data-snippet=#{@snippet_id || 'snippet_42'}]"
+
+      # other selectors
+      when 'the first image' then 'img:nth-child(1n)'
+
+    end
+  end
+
+  def mercury_button_mapping_for(locator)
+    case locator.downcase
+
+      # primary toolbar
+      when 'save' then 'save'
+      when 'preview' then 'preview'
+      when 'undo' then 'undo'
+      when 'redo' then 'redo'
+      when 'link', 'insert link' then 'insertLink'
+      when 'media', 'insert media' then 'insertMedia'
+      when 'table', 'insert table' then 'insertTable'
+      when 'character', 'insert character' then 'insertCharacter'
+      when 'snippet', 'insert snippet' then 'snippetPanel'
+      when 'history', 'view history' then 'historyPanel'
+      when 'notes', 'view notes' then 'notesPanel'
+
+      # editor toolbar
+      when 'predefined styles' then 'style'
+      when 'block format' then 'formatblock'
+      when 'backcolor', 'background color' then 'backColor'
+      when 'forecolor', 'foreground color' then 'foreColor'
+      when 'italicize' then 'italic'
+      when 'overline' then 'overline'
+      when 'strike through' then 'strikethrough'
+      when 'underline' then 'underline'
+      when 'subscript' then 'subscript'
+      when 'superscript' then 'superscript'
+      when 'justify left', 'left justify' then 'justifyLeft'
+      when 'justify center', 'center justify' then 'justifyCenter'
+      when 'justify right', 'right justify' then 'justifyRight'
+      when 'justify full', 'full justification' then 'justifyFull'
+      when 'unordered list', 'insert unordered list' then 'insertUnorderedList'
+      when 'ordered list', 'insert ordered list' then 'insertOrderedList'
+      when 'hr', 'insert hr', 'horizontal rule', 'insert horizontal rule' then 'horizontalRule'
+      when 'clean formatting', 'remove formatting' then 'removeFormatting'
+      when 'html editor' then 'htmlEditor'
+
+      # table context buttons
+      when 'add row before', 'insert row before' then 'insertRowBefore'
+      when 'add row after', 'insert row after' then 'insertRowAfter'
+      when 'delete row' then 'deleteRow'
+      when 'add column before', 'insert column before' then 'insertColumnBefore'
+      when 'add column after', 'insert column after' then 'insertColumnAfter'
+      when 'delete column' then 'deleteColumn'
+      when 'increase colspan' then 'increaseColspan'
+      when 'decrease colspan' then 'decreaseColspan'
+      when 'increase rowspan' then 'increaseRowspan'
+      when 'decrease rowspan' then 'decreaseRowspan'
+
+      # snippet toolbar
+      when 'edit snippet settings', 'edit snippet' then 'editSnippet'
+      when 'remove snippet' then 'removeSnippet'
+
+      else locator
+    end
+  end
+
+  def region_selector_for(locator)
+    case locator.downcase
+
+      when 'the first editable region', 'the editable region' then '#editable1'
+      when 'the first markupable region', 'the markupable region', 'the markdown region' then '#markupable1'
+      when 'the first snippetable region', 'the first snippet region', 'the snippetable region', 'the snippet region' then '#snippetable1'
+
+      else locator
+    end
+  end
+
+  def snippet_name_for(locator)
+    case locator.downcase
+
+      when 'the example snippet' then 'example'
+
+      else locator
+    end
+  end
+
+end
+
+World(MercurySelectorsHelpers)

data/features/support/paths.rb

@@ -0,0 +1,38 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+      when 'an editable page', 'the editable page' then '/editor'
+      when 'the test page' then '/mercury/test_page'
+
+
+      when /the root( page)?/ then '/'
+      when /the home\s?page/ then '/'
+      when /the url: "(.*)"/ then url_for($1)
+
+      # Add more mappings here.
+      # Here is an example that pulls values out of the Regexp:
+      #
+      #   when /^(.*)'s profile page$/i
+      #     user_profile_path(User.find_by_login($1))
+
+      else
+        begin
+          page_name =~ /the (.*) page/
+          path_components = $1.split(/\s+/)
+          self.send(path_components.push('path').join('_').to_sym)
+        rescue Object => e
+          raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+            "Now, go and add a mapping in #{__FILE__}"
+        end
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/support/selectors.rb

@@ -0,0 +1,44 @@
+module HtmlSelectorsHelpers
+  # Maps a name to a selector. Used primarily by the
+  #
+  #   When /^(.+) within (.+)$/ do |step, scope|
+  #
+  # step definitions in web_steps.rb
+  #
+  def selector_for(locator)
+
+    # add in for mercury support
+    result = mercury_selector_for(locator)
+    return result if result.present?
+
+    case locator
+
+      when /the page/
+        "html > body"
+
+      # Add more mappings here.
+      # Here is an example that pulls values out of the Regexp:
+      #
+      #  when /the (notice|error|info) flash/
+      #    ".flash.#{$1}"
+
+      # You can also return an array to use a different selector
+      # type, like:
+      #
+      #  when /the header/
+      #    [:xpath, "//header"]
+
+      # This allows you to provide a quoted selector as the scope
+      # for "within" steps as was previously the default for the
+      # web steps:
+      when /"(.+)"/
+        $1
+
+      else
+        raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+                      "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(HtmlSelectorsHelpers)

data/lib/generators/mercury/install/install_generator.rb

@@ -0,0 +1,49 @@
+module Mercury
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root Mercury::Engine.root
+
+      desc "Installs Mercury into your application by copying the configuration file."
+
+      class_option :orm, :default => 'active_record', :banner => 'mongoid',
+                   :desc => 'ORM for required models -- active_record, or mongoid'
+
+      class_option :full, :type => :boolean, :aliases => '-g',
+                   :desc => 'Full installation will install the layout and css overrides for easier customization.'
+
+      def copy_config
+        copy_file 'vendor/assets/javascripts/mercury.js', 'app/assets/javascripts/mercury.js'
+      end
+
+      def add_routes
+        route %Q{Mercury::Engine.routes}
+      end
+
+      def copy_models
+        if options[:orm] == 'mongoid'
+          copy_file 'lib/generators/mercury/install/templates/mongoid_paperclip_image.rb', 'app/models/mercury/image.rb'
+        else
+          copy_file 'app/models/mercury/image.rb' if options[:full]
+        end
+      end
+
+      def copy_layout_and_css_overrides
+        if options[:full] || yes?("Install the layout and CSS overrides files? [yN]")
+          copy_file 'app/views/layouts/mercury.html.erb', 'app/views/layouts/mercury.html.erb'
+          copy_file 'vendor/assets/stylesheets/mercury_overrides.css', 'app/assets/stylesheets/mercury_overrides.css'
+        end
+      end
+
+      def copy_authentication_overrides
+        if options[:full] || yes?("Install the authentication file so you can restrict access to editing? [yN]")
+          copy_file 'lib/mercury/authentication.rb'
+        end
+      end
+
+      def display_readme
+        readme 'POST_INSTALL' if behavior == :invoke
+      end
+
+    end
+  end
+end

data/lib/generators/mercury/install/templates/mongoid_paperclip_image.rb

@@ -0,0 +1,17 @@
+class Mercury::Image
+  include Mongoid::Document
+  include Mongoid::Paperclip
+
+  has_mongoid_attached_file :image
+
+  validates_presence_of :image
+
+  delegate :url, :to => :image
+
+  def serializable_hash(options = nil)
+    options ||= {}
+    options[:methods] ||= []
+    options[:methods] << :url
+    super(options)
+  end
+end

data/lib/mercury/authentication.rb

@@ -0,0 +1,8 @@
+module Mercury
+  module Authentication
+
+    def can_edit?
+      true # check here to see if the user is logged in/has access
+    end
+  end
+end

data/lib/mercury-rails.rb

@@ -0,0 +1,3 @@
+require 'paperclip'
+
+require File.expand_path('../config/engine', File.dirname(__FILE__))