draftsman 0.1.0

data/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe UsersController do
+  let(:trashable) { Trashable.create!(:name => 'Bob') }
+
+  describe :create do
+    before { post :create }
+    subject { Draftsman::Draft.last }
+    its(:whodunnit) { should eql 'A User' }
+  end
+
+  describe :update do
+    before { put :update, :id => trashable.id }
+    subject { return Draftsman::Draft.last }
+    its(:whodunnit) { should eql 'A User' }
+  end
+
+  describe :destroy do
+    before { delete :destroy, :id => trashable.id }
+    subject { return Draftsman::Draft.last }
+    its(:whodunnit) { should eql 'A User' }
+  end
+end

data/spec/controllers/whodunnits_controller_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+# Tests the automatic usage of `current_user` as the `whodunnit` attribute on the draft object
+describe WhodunnitsController do
+  let(:trashable) { Trashable.create!(:name => 'Bob') }
+
+  describe :create do
+    before { post :create }
+    subject { Draftsman::Draft.last }
+    its(:whodunnit) { should eql "153" }
+  end
+
+  describe :update do
+    before { put :update, :id => trashable.id }
+    subject { Draftsman::Draft.last }
+    its(:whodunnit) { should eql "153" }
+  end
+
+  describe :destroy do
+    before { delete :destroy, :id => trashable.id }
+    subject { Draftsman::Draft.last }
+    its(:whodunnit) { should eql "153" }
+  end
+end

data/spec/draftsman_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper.rb'
+
+describe ::Draftsman do
+  describe 'Sanity Test' do
+    it { should be_a Module }
+  end
+
+  describe :whodunnit do
+    before(:all) { ::Draftsman.whodunnit = 'foobar' }
+    # Clears out `source` before each test
+    its(:whodunnit) { should be_nil }
+  end
+
+  describe :controller_info do
+    before(:all) { ::Draftsman.controller_info = { foo: 'bar' } }
+    # Clears out `controller_info` before each test
+    its(:controller_info) { should == {} }
+  end
+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,20 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def create
+    Trashable.new(:name => 'Bob').draft_creation
+    render nothing: true
+  end
+
+  def update
+    trashable = Trashable.last
+    trashable.name = 'Sam'
+    trashable.draft_update
+    render nothing: true
+  end
+
+  def destroy
+    Trashable.last.draft_destroy
+    render nothing: true
+  end
+end

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

@@ -0,0 +1,8 @@
+class InformantsController < ApplicationController
+
+private
+
+  def info_for_draftsman
+    { :ip => '123.45.67.89', :user_agent => '007' }
+  end
+end

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

@@ -0,0 +1,8 @@
+class UsersController < ApplicationController
+
+private
+
+  def user_for_draftsman
+    'A User'
+  end
+end

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

@@ -0,0 +1,8 @@
+class WhodunnitsController < ApplicationController
+
+private
+
+  def current_user
+    153
+  end
+end

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

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

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

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

data/spec/dummy/app/models/bastard.rb

@@ -0,0 +1,3 @@
+class Bastard < ActiveRecord::Base
+  belongs_to :parent
+end

data/spec/dummy/app/models/child.rb

@@ -0,0 +1,4 @@
+class Child < ActiveRecord::Base
+  has_drafts
+  belongs_to :parent
+end

data/spec/dummy/app/models/parent.rb

@@ -0,0 +1,5 @@
+class Parent < ActiveRecord::Base
+  has_drafts
+  has_many :children, :dependent => :destroy
+  has_many :bastards, :dependent => :destroy
+end

data/spec/dummy/app/models/trashable.rb

@@ -0,0 +1,3 @@
+class Trashable < ActiveRecord::Base
+  has_drafts
+end

data/spec/dummy/app/models/vanilla.rb

@@ -0,0 +1,3 @@
+class Vanilla < ActiveRecord::Base
+  has_drafts
+end

data/spec/dummy/app/models/whitelister.rb

@@ -0,0 +1,3 @@
+class Whitelister < ActiveRecord::Base
+  has_drafts only: [:name]
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<div id="nav">
+  <%= link_to 'Home', root_path %>
+</div>
+<%= yield %>
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+require 'draftsman'
+
+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)
+
+    # 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
+
+    # 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 = false if ::Draftsman.active_record_protected_attributes?
+
+    # Do not access the DB or load models when precompiling assets
+    config.assets.initialize_on_precompile = false
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,32 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict if ::Draftsman.active_record_protected_attributes?
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,73 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict if ::Draftsman.active_record_protected_attributes?
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_key_base = '22049ee90e16e6dcc10f4d855f7869c5802435f25ca2e34a5f26574d6944379870f06c6a302a938ed1fa38659406cf5094cff01414377404a9f7cf8f306720f4'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters :format => [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,6 @@
+Dummy::Application.routes.draw do
+  resources :whodunnits
+  resources :disableds
+  resources :informants
+  resources :users
+end

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/db/migrate/20110208155312_set_up_test_tables.rb

@@ -0,0 +1,86 @@
+class SetUpTestTables < ActiveRecord::Migration
+  def self.up
+    create_table :drafts, :force => true do |t|
+      t.string  :item_type
+      t.integer :item_id
+      t.string  :event, :null => false
+      t.string  :whodunnit
+      t.text    :object
+      t.text    :object_changes
+      t.text    :previous_draft
+      t.timestamps
+
+      # Metadata column
+      t.integer :answer
+
+      # Controller info column
+      t.string :ip
+      t.string :user_agent
+    end
+
+    create_table :vanillas, :force => true do |t|
+      t.string     :name
+      t.references :draft
+      t.datetime   :published_at
+      t.timestamps
+    end
+
+    create_table :trashables, :force => true do |t|
+      t.string     :name
+      t.string     :title, :null => true
+      t.references :draft
+      t.datetime   :published_at
+      t.datetime   :trashed_at
+      t.timestamps
+    end
+
+    create_table :draft_as_sketches, :force => true do |t|
+      t.string     :name
+      t.references :sketch
+      t.datetime   :published_at
+      t.timestamps
+    end
+
+    create_table :whitelisters, :force => true do |t|
+      t.string     :name
+      t.string     :ignored
+      t.references :draft
+      t.datetime   :published_at
+      t.timestamps
+    end
+
+    create_table :parents, :force => true do |t|
+      t.string     :name
+      t.references :draft
+      t.datetime   :trashed_at
+      t.datetime   :published_at
+      t.timestamps
+    end
+
+    create_table :children, :force => true do |t|
+      t.string     :name
+      t.references :parent
+      t.references :draft
+      t.datetime   :trashed_at
+      t.datetime   :published_at
+      t.timestamps
+    end
+
+    create_table :bastards, :force => true do |t|
+      t.string     :name
+      t.references :parent
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :drafts
+    drop_table :vanillas
+    drop_table :trashables
+    drop_table :draft_as_sketches
+    drop_table :whitelisters
+    drop_table :parents
+    drop_table :children
+    drop_table :bastards
+  end
+end