has_moderated 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,75 @@
+= HasModerated
+
+== Installing
+
+  gem install has_moderated
+
+Right now, rubygems.org is having some problems so I can't push the gem, but you can install from this repo by calling
+
+  rake install
+
+To set up has_moderated in your project, use
+
+  rails generate has_moderated:install
+
+
+  rake db:migrate
+
+This will generate a Moderation model and a migration for it.
+
+== Usage
+To moderate one or more attributes, add
+
+  has_moderated :attr1, :attr2
+
+to your model.
+
+If you want to moderate the creation of a record (for example, you don't want new blog posts to show up until they are accepted by a moderator), use
+
+  has_moderated_existance
+
+You can also specify associations that need to be saved for moderation as well (if moderating the creation of new records) - for example, if a Post has_many :links, and you want to submit these links to moderation as well (note, if you don't, they will be discarded), use
+
+  has_moderated_existance :with_associations => [:links]
+
+in your Post model (post.rb). This only matters when you use has_moderated_existance.
+
+Right now it's not possible to moderate deletion (destruction) of records.
+
+== Manage moderations
+To see pending moderations, simply call
+
+  Moderation.all
+
+You can also see moderations for a specific record. For example, if you have Post model, you can call moderations on it.
+
+  post = Post.first
+  post.moderations
+  
+Moderation is a normal ActiveRecord model, you can inspect it in rails console to see what it holds. Data (attr_value) is serialized in YAML format and can be deserialized by calling
+
+  YAML::load(moderation.attr_value)
+
+To accept a moderation, call
+
+  moderation.accept
+
+to discard (destroy) it, call
+
+  moderation.discard
+
+== Tests
+
+I've tested this project using RSpec. You can find the tests in
+
+  test/dummy/spec/models/task_spec.rb
+
+You can run the tests by running
+
+  rake spec
+
+in the root directory.
+
+== License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasModerated'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates migrations and model for has_moderated.
+
+Example:
+    rails generate has_moderated:install
+
+    This will create:
+        app/models/moderation.rb
+        db/migrate/*_create_moderations.rb

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

@@ -0,0 +1,24 @@
+module HasModerated
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "This generator installs files for has_moderated."
+      source_root File.expand_path('../templates', __FILE__)
+      include Rails::Generators::Migration
+
+      def files
+        class_collisions 'Moderation'
+        template 'moderation.rb', File.join('app/models', 'moderation.rb')
+        migration_template 'migration.rb', 'db/migrate/create_moderations.rb'
+      end
+
+      private
+        def self.next_migration_number(dirname) #:nodoc:
+          if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime("%Y%m%d%H%M%S")
+          else
+            "%.3d" % (current_migration_number(dirname) + 1)
+          end
+        end
+    end
+  end
+end

data/lib/generators/has_moderated/install/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateModerations < ActiveRecord::Migration
+  def self.up
+    create_table "moderations" do |t|
+      t.integer "moderatable_id",  :null => true
+      t.string  "moderatable_type",  :null => false
+      t.string  "attr_name",    :limit => 60,  :null => false
+      t.text    "attr_value",  :null => false
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :moderations
+  end
+end

data/lib/generators/has_moderated/install/templates/moderation.rb

@@ -0,0 +1,60 @@
+class Moderation < ActiveRecord::Base
+  belongs_to :moderatable, :polymorphic => true
+
+  def accept
+    # case: moderated existance (new record)
+    if attr_name == '-'
+      # create the main record
+      rec = moderatable_type.constantize.new
+      loaded_val = YAML::load(attr_value)
+      attrs = loaded_val[:main_model]
+      # bypass attr_accessible protection
+      attrs.each_pair do |key, val|
+        rec.send(key.to_s+"=", val) unless key.to_s == 'id'
+      end
+      # temporarily disable moderation check on save, and save updated record
+      rec.has_moderated_updating = true
+      rec.save
+      rec.has_moderated_updating = false
+
+      # check for saved associated records
+      loaded_val[:associations].each_pair do |assoc_name, assoc_records|
+        # read reflections attribute to determine proper class name and primary key
+        assoc_details = rec.class.reflections[assoc_name.to_sym]
+        m = assoc_details.class_name.constantize
+
+        # all records for this associated model
+        assoc_records.each do |attrs|
+          arec = m.new # new associated model
+          attrs.each_pair do |key, val|
+            arec.send(key.to_s+"=", val) unless key.to_s == 'id'
+          end
+          fk = if assoc_details.respond_to?(:foreign_key)
+            assoc_details.foreign_key
+          else # version < 3.1
+            assoc_details.primary_key_name
+          end
+          arec.send(fk.to_s+"=", rec.id) # set association to the newly created record
+          # disable moderation for associated model (if enabled)
+          arec.has_moderated_updating = true if arec.respond_to?("has_moderated_updating=")
+          arec.save
+          arec.has_moderated_updating = false if arec.respond_to?("has_moderated_updating=")
+        end
+      end
+      self.destroy # destroy this moderation since it has been applied
+      rec
+    # case: moderated attribute (existing record)
+    else
+      moderatable.has_moderated_updating = true
+      # bypass attr_accessible protection
+      moderatable.send(attr_name.to_s+"=", YAML::load(attr_value))
+      moderatable.save
+      moderatable.has_moderated_updating = false
+      self.destroy # destroy this moderation since it has been applied
+    end
+  end
+
+  def discard
+    self.destroy
+  end
+end

data/lib/has_moderated/version.rb

@@ -0,0 +1,3 @@
+module HasModerated
+  VERSION = "0.0.1"
+end

data/lib/has_moderated.rb

@@ -0,0 +1,128 @@
+module HasModerated
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def has_moderated *args, &block
+      # Lazily include the instance methods so we don't clutter up
+      # any more ActiveRecord models than we have to.
+      send :include, InstanceMethods
+
+      has_many :moderations, :as => :moderatable, :dependent => :destroy
+      
+      cattr_accessor :moderated_attributes
+
+      self.moderated_attributes ||= []
+
+      args.each do |arg|
+        self.moderated_attributes.push(arg.to_s)
+      end
+
+      # use an attribute to temporarily disable moderation before_save filter
+      attr_accessor :has_moderated_updating
+
+      # send moderated attributes to moderation before saving the model
+      before_save do
+        if self.valid? && @has_moderated_updating != true &&
+          # don't save moderated attributes if existance is moderated and it's a new record
+          !(self.class.respond_to?("moderated_existance_options") && new_record?)
+          moderations = self.to_moderation
+          if self.id.blank?
+            @pending_moderations ||= []
+            @pending_moderations.concat(moderations)
+          end
+        end
+      end
+
+      # when creating a new record, we must update moderations' id after it is known (after create)
+      after_create do
+        if !self.id.blank? && !@pending_moderations.blank?
+          @pending_moderations.each do |m|
+            m.update_attributes(:moderatable_id => self.id)
+          end
+          @pending_moderations.clear
+        end
+      end
+    end
+    
+    def has_moderated_existance options
+      # Lazily include the instance methods so we don't clutter up
+      # any more ActiveRecord models than we have to.
+      send :include, InstanceMethods
+      
+      # use an attribute to temporarily disable moderation before_save filter
+      attr_accessor :has_moderated_updating
+
+      # save options for use later
+      cattr_accessor :moderated_existance_options
+      self.moderated_existance_options = options
+      
+      alias_method_chain :create_or_update, :moderated_check
+    end
+  end
+  
+  module InstanceMethods
+    def create_or_update_with_moderated_check *args
+      if valid? && new_record? && @has_moderated_updating != true
+        self.to_moderation_created(self.class.moderated_existance_options)
+        true
+      else
+        create_or_update_without_moderated_check *args
+      end
+    end
+    
+    def to_moderation_created options
+      assocs = []
+      
+      unless options.blank?
+        unless options[:with_associations].blank?
+          assocs = options[:with_associations]
+          assocs = [assocs] unless assocs.respond_to?("[]")
+        end
+      end
+
+      assoc_attrs = {}
+      assocs.each do |assoc|
+        one_assoc = []
+        self.send(assoc).each do |m|
+          one_assoc.push(m.attributes)
+        end
+        assoc_attrs[assoc] = one_assoc unless one_assoc.empty?
+      end
+
+      attr_value = {
+        :main_model => self.attributes,
+        :associations => assoc_attrs
+      }
+      
+      Moderation.create!({
+        :moderatable_type => self.class.to_s,
+        :moderatable_id => self.id,
+        :attr_name => "-",
+        :attr_value => attr_value.to_yaml
+      })
+    end
+    
+    def to_moderation
+      moderations = []
+      self.changes.each_pair do |att_name, values|
+        att_name = att_name.to_s
+        next if values[1].blank?
+        if self.class.moderated_attributes.include?(att_name)
+          moderations.push(Moderation.create!({
+            :moderatable_type => self.class.to_s,
+            :moderatable_id => self.id,
+            :attr_name => att_name,
+            :attr_value => self.attributes[att_name].to_yaml
+          }))
+          self.send(att_name+"=", values[0])
+        end
+      end
+      moderations
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, HasModerated

data/lib/tasks/has_moderated_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_moderated do
+#   # Task goes here
+# end

data/test/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/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. 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/test/dummy/app/controllers/application_controller.rb

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

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

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

data/test/dummy/app/models/moderation.rb

@@ -0,0 +1,60 @@
+class Moderation < ActiveRecord::Base
+  belongs_to :moderatable, :polymorphic => true
+
+  def accept
+    # case: moderated existance (new record)
+    if attr_name == '-'
+      # create the main record
+      rec = moderatable_type.constantize.new
+      loaded_val = YAML::load(attr_value)
+      attrs = loaded_val[:main_model]
+      # bypass attr_accessible protection
+      attrs.each_pair do |key, val|
+        rec.send(key.to_s+"=", val) unless key.to_s == 'id'
+      end
+      # temporarily disable moderation check on save, and save updated record
+      rec.has_moderated_updating = true
+      rec.save
+      rec.has_moderated_updating = false
+
+      # check for saved associated records
+      loaded_val[:associations].each_pair do |assoc_name, assoc_records|
+        # read reflections attribute to determine proper class name and primary key
+        assoc_details = rec.class.reflections[assoc_name.to_sym]
+        m = assoc_details.class_name.constantize
+
+        # all records for this associated model
+        assoc_records.each do |attrs|
+          arec = m.new # new associated model
+          attrs.each_pair do |key, val|
+            arec.send(key.to_s+"=", val) unless key.to_s == 'id'
+          end
+          fk = if assoc_details.respond_to?(:foreign_key)
+            assoc_details.foreign_key
+          else # version < 3.1
+            assoc_details.primary_key_name
+          end
+          arec.send(fk.to_s+"=", rec.id) # set association to the newly created record
+          # disable moderation for associated model (if enabled)
+          arec.has_moderated_updating = true if arec.respond_to?("has_moderated_updating=")
+          arec.save
+          arec.has_moderated_updating = false if arec.respond_to?("has_moderated_updating=")
+        end
+      end
+      self.destroy # destroy this moderation since it has been applied
+      rec
+    # case: moderated attribute (existing record)
+    else
+      moderatable.has_moderated_updating = true
+      # bypass attr_accessible protection
+      moderatable.send(attr_name.to_s+"=", YAML::load(attr_value))
+      moderatable.save
+      moderatable.has_moderated_updating = false
+      self.destroy # destroy this moderation since it has been applied
+    end
+  end
+
+  def discard
+    self.destroy
+  end
+end

data/test/dummy/app/models/subtask.rb

@@ -0,0 +1,3 @@
+class Subtask < ActiveRecord::Base
+  belongs_to :task
+end

data/test/dummy/app/models/task.rb

@@ -0,0 +1,6 @@
+class Task < ActiveRecord::Base
+  attr_accessible :title
+  has_many :subtasks
+  has_moderated :title, :desc
+  has_moderated_existance :with_associations => [:subtasks]
+end

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

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

data/test/dummy/config/application.rb

@@ -0,0 +1,50 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "has_moderated"
+
+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]
+
+    # 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'
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => true, :views => false
+      g.fixture_replacement :factory_girl, :dir => "spec/factories"
+    end
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/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/test/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/test/dummy/config/environments/development.rb

@@ -0,0 +1,30 @@
+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
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # 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
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end