mercury-rails 0.3.1 → 0.5.0

data/features/regions/editable/inserting_snippets.feature

@@ -25,7 +25,7 @@ Feature:
     And fill in "Favorite Beer" with "Stella"
     And press "Insert Snippet"
     Then the modal window should not be visible
-    And the contents of the editable region should be "this is <div data-version='1' data-snippet='snippet_14' class='mercury-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div><span>simple</span> <b>content</b>"
+    And the contents of the editable region should be "this is <div data-version='1' data-snippet='snippet_14' class='mercury-snippet example-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div><span>simple</span> <b>content</b>"
 
 
   Scenario: A user can use the snippet toolbar to remove a snippet
@@ -52,7 +52,7 @@ Feature:
     When I fill in "First Name" with "Jeremy"
     And fill in "Favorite Beer" with "Stella"
     And press "Insert Snippet"
-    Then the contents of the editable region should be "<div data-version='2' data-snippet='snippet_42' class='mercury-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div> <b>content</b>"
+    Then the contents of the editable region should be "<div data-version='2' data-snippet='snippet_42' class='mercury-snippet example-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div> <b>content</b>"
 
 
   Scenario: A user can make changes to a snippets options, and they'll be versioned for undo and redo
@@ -63,7 +63,7 @@ Feature:
     And I fill in "First Name" with "Jeremy"
     And fill in "Favorite Beer" with "Stella"
     And press "Insert Snippet"
-    Then the contents of the editable region should be "<div data-version='2' data-snippet='snippet_42' class='mercury-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div> <b>content</b>"
+    Then the contents of the editable region should be "<div data-version='2' data-snippet='snippet_42' class='mercury-snippet example-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div> <b>content</b>"
 
     When I edit the snippet
     Then the "First Name" field should contain "Jeremy"
@@ -72,10 +72,10 @@ Feature:
     When fill in "First Name" with "Diesel"
     And fill in "Favorite Beer" with "Bells Hopslam"
     And press "Insert Snippet"
-    Then the content of the editable region should be "<div data-version='3' data-snippet='snippet_42' class='mercury-snippet' contenteditable='false'><strong>Diesel</strong> likes Bells Hopslam</div> <b>content</b>"
+    Then the content of the editable region should be "<div data-version='3' data-snippet='snippet_42' class='mercury-snippet example-snippet' contenteditable='false'><strong>Diesel</strong> likes Bells Hopslam</div> <b>content</b>"
 
     When I click on the "Undo" button
-    Then the contents of the editable region should be "<div data-version='2' data-snippet='snippet_42' class='mercury-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div> <b>content</b>"
+    Then the contents of the editable region should be "<div data-version='2' data-snippet='snippet_42' class='mercury-snippet example-snippet' contenteditable='false'><strong>Jeremy</strong> likes Stella</div> <b>content</b>"
 
     When I edit the snippet
     # todo: this is a bug
@@ -84,7 +84,7 @@ Feature:
 
     When I close the modal
     When I click on the "Redo" button
-    Then the contents of the editable region should be "<div data-version='3' data-snippet='snippet_42' class='mercury-snippet' contenteditable='false'><strong>Diesel</strong> likes Bells Hopslam</div> <b>content</b>"
+    Then the contents of the editable region should be "<div data-version='3' data-snippet='snippet_42' class='mercury-snippet example-snippet' contenteditable='false'><strong>Diesel</strong> likes Bells Hopslam</div> <b>content</b>"
 
     When I edit the snippet
     Then the "First Name" field should contain "Diesel"
@@ -93,7 +93,7 @@ Feature:
     When I fill in "First Name" with "Jen"
     And fill in "Favorite Beer" with "Miller High Life"
     And press "Insert Snippet"
-    Then the contents of the editable region should be "<div data-version='4' data-snippet='snippet_42' class='mercury-snippet' contenteditable='false'><strong>Jen</strong> likes Miller High Life</div> <b>content</b>"
+    Then the contents of the editable region should be "<div data-version='4' data-snippet='snippet_42' class='mercury-snippet example-snippet' contenteditable='false'><strong>Jen</strong> likes Miller High Life</div> <b>content</b>"
 
 
 #  Scenario: When a user saves, the snippets should be gone from the html, but the options are serialized

data/features/regions/simple/basic_editing.feature

@@ -0,0 +1,5 @@
+@javascript
+Feature:
+  As a content editor type person
+  In order to manage content
+  I should be able to manipulate text

data/features/step_definitions/generator_steps.rb

@@ -0,0 +1,27 @@
+When /^I add Mercury as a gem dependency$/ do
+  append_to_file('Gemfile', %{\ngem "mercury-rails", :path => "#{File.expand_path('../../../', __FILE__)}"\n})
+end
+
+When "I have created a new rails application" do
+  step %{I reset Bundler environment variable}
+  step %{I successfully run `bundle exec rails new testapp --skip-bundle`}
+  step %{I cd to "testapp"}
+  step %{I add Mercury as a gem dependency}
+  step %{I run `bundle install --local`}
+end
+
+Then /^the file "([^"]*)" should contain:$/ do |file, partial_content|
+  check_file_content(file, partial_content, true)
+end
+
+Then /^should have the migration "([^"]*)"$/ do |migration|
+  in_current_dir do
+    Dir["db/migrate/*_#{migration}"].length.should == 1
+  end
+end
+
+Then /^should not have the migration "([^"]*)"$/ do |migration|
+  in_current_dir do
+    Dir["db/migrate/*_#{migration}"].length.should == 0
+  end
+end

data/features/step_definitions/mercury_steps.rb

@@ -155,6 +155,7 @@ Given /^save results will be cached$/ do
   page.driver.execute_script <<-JAVASCRIPT
     Mercury.PageEditor.prototype.save = function() {
       window.cachedResults = this.serialize();
+      Mercury.changes = false;
     }
   JAVASCRIPT
 end

data/features/support/aruba.rb

@@ -0,0 +1,28 @@
+BUNDLE_ENV_VARS = %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE)
+ORIGINAL_BUNDLE_VARS = Hash[ENV.select{ |key,value| BUNDLE_ENV_VARS.include?(key) }]
+
+Before do
+  if ! ENV['BUNDLE_GEMFILE'].include?(Dir.pwd)
+    ENV['BUNDLE_GEMFILE'] = File.join(Dir.pwd, ENV['BUNDLE_GEMFILE'])
+  end
+end
+
+After do
+  ORIGINAL_BUNDLE_VARS.each_pair do |key, value|
+    ENV[key] = value
+  end
+end
+
+When /^I reset Bundler environment variable$/ do
+  BUNDLE_ENV_VARS.each do |key|
+    ENV[key] = nil
+  end
+end
+
+Before do
+  @aruba_timeout_seconds = 20
+end
+
+Before('@slow') do
+  @aruba_timeout_seconds = 180
+end

data/features/support/env.rb

@@ -4,14 +4,16 @@
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
+ENV["RAILS_ROOT"] = File.expand_path('../../../spec/dummy', __FILE__)
 require 'cucumber/rails'
-require 'capybara/firebug'
+# require 'capybara/firebug'
+require 'aruba/cucumber'
 
 # 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'
+# 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
@@ -44,3 +46,11 @@ begin
 rescue NameError
   raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
 end
+
+Before('@use_hidden_elements') do
+  Capybara.ignore_hidden_elements = false
+end
+
+After('@use_hidden_elements') do
+  Capybara.ignore_hidden_elements = true
+end

data/features/support/mercury_contents.rb

@@ -2,7 +2,7 @@ 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 '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>"
@@ -22,4 +22,4 @@ module MercuryContentsHelpers
   end
 end
 
-World(MercuryContentsHelpers)
+World(MercuryContentsHelpers)

data/lib/generators/mercury/install/authentication/authentication_generator.rb

@@ -0,0 +1,15 @@
+module Mercury
+  module Generators
+    module Install
+      class AuthenticationGenerator < Rails::Generators::Base
+        source_root Mercury::Engine.root
+
+        desc "Installs an authentication example so you can restrict access to editing."
+
+        def copy_authentication_overrides
+          copy_file 'lib/mercury/authentication.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/mercury/install/images/images_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators/active_record'
+module Mercury
+  module Generators
+    module Install
+      class ImagesGenerator < Rails::Generators::Base
+        include Rails::Generators::Migration
+        source_root File.expand_path("../templates", __FILE__)
+
+        desc "Installs image processing migrations and model."
+
+        class_option :orm, :default => 'active_record', :banner => 'mongoid',
+                     :desc => 'ORM for required models -- active_record, or mongoid'
+
+        def copy_models
+          if options[:orm] == 'mongoid'
+            copy_file 'mongoid_paperclip_image.rb', 'app/models/mercury/image.rb'
+          else
+            copy_file 'ar_paperclip_image.rb', 'app/models/mercury/image.rb'
+            migration_template 'ar_paperclip_image_migration.rb', 'db/migrate/create_mercury_images.rb'
+          end
+        end
+
+        def copy_controller
+          copy_file 'images_controller.rb', 'app/controllers/mercury/images_controller.rb'
+        end
+
+        def add_routes
+          route %Q{  namespace :mercury do
+      resources :images
+    end}
+        end
+
+        def add_gemfile_dependencies
+          prepend_to_file "Gemfile", %Q{gem 'paperclip'}
+        end
+
+        # Implement the required interface for Rails::Generators::Migration.
+        def self.next_migration_number(dirname) #:nodoc:
+          ActiveRecord::Generators::Base.next_migration_number(dirname)
+        end
+      end
+    end
+  end
+end

data/{app/models/mercury/image.rb → lib/generators/mercury/install/images/templates/ar_paperclip_image.rb}

@@ -2,7 +2,9 @@ class Mercury::Image < ActiveRecord::Base
 
   self.table_name = :mercury_images
 
-  has_attached_file :image, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+  has_attached_file :image, :styles => { :medium => "300x300>", :thumb => "100x100>" },
+        :path => ":rails_root/public/system/:attachment/:id/:style/:filename",
+        :url => "/system/:attachment/:id/:style/:filename"
 
   delegate :url, :to => :image
 

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

@@ -5,38 +5,21 @@ module Mercury
 
       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'
+        copy_file 'app/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
+        route %Q{mount Mercury::Engine => '/'}
       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'
+          copy_file 'app/assets/stylesheets/mercury_overrides.css', 'app/assets/stylesheets/mercury_overrides.css'
         end
       end
 

data/lib/mercury-rails.rb

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

data/lib/mercury/authentication.rb

@@ -4,5 +4,6 @@ module Mercury
     def can_edit?
       true # check here to see if the user is logged in/has access
     end
+
   end
 end

data/lib/mercury/engine.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module Mercury
+  class Engine < ::Rails::Engine
+
+    # Additional application configuration to include precompiled assets.
+    initializer :assets, :group => :all do |app|
+      app.config.assets.precompile += %w( mercury.js mercury.css mercury_overrides.css mercury_overrides.js )
+    end
+
+    # Require mercury authentication module and potentially other aspects later (so they can be overridden).
+    initializer 'mercury.add_lib' do |app|
+      require 'mercury/authentication'
+    end
+
+  end
+end

data/lib/mercury/rails.rb

@@ -0,0 +1,4 @@
+module Mercury
+  require 'mercury/version'
+  require 'mercury/engine'
+end

data/lib/mercury/version.rb

@@ -0,0 +1,3 @@
+module Mercury
+  VERSION = '0.5.0'
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "mercury-rails"
+require 'evergreen/rails'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+