the_moderator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 421b8e05b09df91ed6b0563933587edf3f07e5b4
+  data.tar.gz: 203d3f693d580c47b1868dd435eaf3247d0c11e5
+SHA512:
+  metadata.gz: f70f543eab96bce0a9449022f5e21a99bed5da5146e8fd6c5888989e03082e2cde39792f5827de4f6b7e21260aa910e33b88d81e0ad9f165337ea765f68a07cb
+  data.tar.gz: db57bac199438ac4f4f6b77144b7fed879de8975023492ab3d0c8ee8fda49c0e326fef62d3d82eee6e594f6d3e2f5988e42e3253a9caec62830270d04b69a925

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.sqlite
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.s[a-w][a-z]

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_moderator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guillaume DOTT
+
+MIT License
+
+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.md

@@ -0,0 +1,75 @@
+# TheModerator
+
+Moderate fields before their insertion in the database by serializing and saving them into a separate 'moderations' table.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'the_moderator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install the_moderator
+
+Then use the generator for the migration and the basic `Moderation` model:
+
+    $ rails generate the_moderator:install
+
+## Usage
+
+To use `TheModerator`, you need to include `TheModerator::Model` in the models you want to moderate.
+
+```ruby
+class Article
+  include TheModerator::Model
+end
+```
+
+The `Moderation` model added by the genenrator is used to access the moderations.
+
+### Moderate attributes
+
+This gem adds 3 methods to your models.
+
+- `moderate`
+- `moderated?`
+- `moderated_fields_for(assoc)`
+
+### Manage moderations
+
+To list pending moderations, you can use the `Moderation` model
+
+```ruby
+Moderation.all
+```
+
+You can access the moderations for a specific object with
+
+```ruby
+post = Post.last
+post.moderations
+```
+
+A `Moderation` instance has 4 methods:
+- `moderation.data` returns a hash of the moderated attributes
+- `moderation.data_display` returns a user-friendly hash to display the moderated attributes
+- `moderation.preview`
+- `moderation.accept` modifies the moderated object with the specified attributes and saves it
+- `moderation.discard` destroys the moderation
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+TheModerator is released under AGPLv3 license. Copyright (c) 2013 La Fourmi Immo

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/the_moderator/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

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

@@ -0,0 +1,18 @@
+class TheModerator::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_model
+    template 'moderation.rb', File.join('app', 'models', 'moderation.rb')
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_moderations.rb'
+  end
+
+  def self.next_migration_number(dirname)
+    ActiveRecord::Migration.next_migration_number(
+      current_migration_number(dirname) + 1)
+  end
+end

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

@@ -0,0 +1,15 @@
+class CreateModerations < ActiveRecord::Migration
+  def self.up
+    create_table "moderations" do |t|
+      t.references :moderatable, polymorphic: true
+      t.text :data, :null => false
+      t.text :data_display, :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :moderations
+  end
+end

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

@@ -0,0 +1,3 @@
+class Moderation < ActiveRecord::Base
+  include TheModerator::ModerationModel
+end

data/lib/the_moderator/exceptions.rb

@@ -0,0 +1,4 @@
+module TheModerator
+  class ModerationNotAccepted < StandardError
+  end
+end

data/lib/the_moderator/model.rb

@@ -0,0 +1,99 @@
+require 'active_support/concern'
+
+module TheModerator
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :moderations, as: :moderatable, dependent: :destroy
+    end
+
+    module ClassMethods
+    end
+
+    def moderate(*moderated_attributes)
+      data = moderation_data(*moderated_attributes)
+      moderations.build(data: {attributes: data[:data]},
+                        data_display: data[:data_display]) unless data[:data].empty?
+    end
+
+    def moderated?(attr_name)
+      moderations.each do |moderation|
+        return true if moderation.include?(attr_name)
+      end
+      false
+    end
+
+    def moderated_fields_for(assoc)
+      moderations.map { |m| m.moderated_fields_for(assoc) }
+                 .inject(&:|)
+    end
+
+    protected
+
+    def moderation_data(*moderated_attributes)
+      moderate_object moderated_attributes
+    end
+
+    private
+
+    def moderate_object(moderated_attributes)
+      object_fields, object_fields_display = {}, {}
+
+      moderated_attributes.each do |attribute|
+        if attribute.is_a?(Hash)
+          attribute.each do |key, value|
+            data = moderate_association(key, value)
+            object_fields[:"#{key}_attributes"] = data[:data] unless data[:data].empty?
+            object_fields_display.merge!(data[:data_display]) unless data[:data_display].empty?
+          end
+        elsif changed.include?(attribute.to_s)
+          object_fields[attribute.to_sym] = send(attribute)
+          class_name ||= self.class.name.to_sym
+          object_fields_display[class_name] ||= {}
+          object_fields_display[class_name].merge!(attribute.to_sym => send(attribute))
+          send("#{attribute}=", changed_attributes[attribute.to_s])
+        end
+      end
+
+      { data: object_fields, data_display: object_fields_display }
+    end
+
+    def moderate_association(assoc, moderated_attributes)
+      assoc_fields, assoc_fields_display = {}, {}
+      objects = send(assoc)
+
+      if respond_to?("#{assoc}_attributes=")
+        if objects.is_a?(Array)
+          data = moderate_has_many_association(objects, moderated_attributes)
+          assoc_fields = data[:data]
+          assoc_fields_display = data[:data_display]
+        else
+          data = objects.moderation_data(*moderated_attributes)
+          assoc_fields = data[:data].merge(id: objects.id) unless data[:data].empty?
+          assoc_fields_display = data[:data_display] unless data[:data_display].empty?
+        end
+      end
+
+      { data: assoc_fields, data_display: assoc_fields_display }
+    end
+
+    def moderate_has_many_association(objects, moderated_attributes)
+      assoc_fields, assoc_fields_display = {}, {}
+      tab = []
+
+      objects.each do |resource|
+        data = resource.moderation_data(*moderated_attributes)
+
+        assoc_fields[resource.id] = data[:data].merge(id: resource.id) unless data[:data].empty?
+        unless data[:data_display].empty?
+          key = data[:data_display].keys.first
+          assoc_fields_display[key] ||= {}
+          assoc_fields_display[key] = tab.push(data[:data])
+        end
+      end
+
+      { data: assoc_fields, data_display: assoc_fields_display }
+    end
+  end
+end

data/lib/the_moderator/moderation_model.rb

@@ -0,0 +1,69 @@
+require 'active_support/concern'
+
+module TheModerator
+  module ModerationModel
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :moderatable, polymorphic: true
+      serialize :data
+      serialize :data_display
+    end
+
+    module ClassMethods
+    end
+
+    def accept
+      self.class.transaction do
+        destroy
+        moderatable.update_attributes(data)
+      end
+    end
+
+    def accept!
+      accept || raise(TheModerator::ModerationNotAccepted)
+    end
+
+    def discard
+      destroy
+    end
+
+    def preview
+      preview = moderatable.clone
+      preview.attributes = data
+      preview.freeze
+    end
+
+    def parsed_data
+      data
+    end
+
+    def parsed_data_display
+      data_display
+    end
+
+    def include?(attribute)
+      include_attribute?(attribute, data[:attributes])
+    end
+
+    def moderated_fields_for(assoc)
+      (data[:attributes][assoc].try(:keys) || []) - [:id]
+    end
+
+    private
+
+    def include_attribute?(attribute, attr_data)
+      return false if attr_data.nil?
+      if attribute.is_a?(Hash)
+        include_assoc?(attribute, attr_data)
+      else
+        attr_data.keys.include?(attribute)
+      end
+    end
+
+    def include_assoc?(attribute, assoc_data)
+      include_attribute?(attribute.first.last,
+                         assoc_data[attribute.first.first])
+    end
+  end
+end

data/lib/the_moderator/version.rb

@@ -0,0 +1,3 @@
+module TheModerator
+  VERSION = "0.1.0"
+end

data/lib/the_moderator.rb

@@ -0,0 +1,4 @@
+require 'the_moderator/version'
+require 'the_moderator/exceptions'
+require 'the_moderator/model'
+require 'the_moderator/moderation_model'

data/spec/internal/app/models/category.rb

@@ -0,0 +1,6 @@
+class Category < ActiveRecord::Base
+  include TheModerator::Model
+
+  has_one :page
+  accepts_nested_attributes_for :page
+end

data/spec/internal/app/models/link.rb

@@ -0,0 +1,3 @@
+class Link < ActiveRecord::Base
+  belongs_to :page
+end

data/spec/internal/app/models/moderation.rb

@@ -0,0 +1,3 @@
+class Moderation < ActiveRecord::Base
+  include TheModerator::ModerationModel
+end

data/spec/internal/app/models/page.rb

@@ -0,0 +1,8 @@
+class Page < ActiveRecord::Base
+  include TheModerator::Model
+
+  has_many :links
+  accepts_nested_attributes_for :links
+
+  belongs_to :category
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,28 @@
+ActiveRecord::Schema.define do
+  create_table :categories, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :pages, :force => true do |t|
+    t.integer :category_id
+    t.string :name
+    t.text   :content
+    t.timestamps
+  end
+
+  create_table :links, :force => true do |t|
+    t.integer :page_id
+    t.string :name
+    t.string :url
+    t.timestamps
+  end
+
+  create_table :moderations, :force => true do |t|
+    t.integer  :moderatable_id
+    t.string   :moderatable_type
+    t.text     :data
+    t.text :data_display
+    t.timestamps
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'combustion'
+
+require 'the_moderator'
+
+Combustion.initialize! :active_record, :active_model
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/spec/the_moderator/model_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe TheModerator::Model do
+  describe '#moderate' do
+    it 'moderates simple field' do
+      page = Page.new(name: 'Name', content: 'Content')
+      page.moderate(:name)
+
+      expect(page.moderations).to have(1).moderation
+      expect(page.moderations.first.data[:attributes]).to include(name: 'Name')
+      expect(page.name).to be_nil
+      expect(page.content).to eq('Content')
+    end
+
+    it 'moderates association fields' do
+      category = Category.new(name: 'category')
+      category.create_page
+      category.save
+
+      category.attributes = {page_attributes: {
+        name: 'name', content: 'content', id: category.page.id}}
+      category.moderate(page: :name)
+
+      expect(category.moderations).to have(1).moderation
+      expect(category.moderations.first.data[:attributes])
+        .to include(page_attributes: {name: 'name', id: category.page.id})
+      expect(category.page.name).to be_nil
+    end
+  end
+
+  describe '#moderated?' do
+    it 'detects moderated field' do
+      page = Page.new(name: 'Name', content: 'Content')
+      page.moderate(:name)
+
+      expect(page.moderated?(:name)).to be_true
+      expect(page.moderated?(:content)).to be_false
+    end
+  end
+end

data/spec/the_moderator/moderation_model_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe TheModerator::ModerationModel do
+  subject do
+    page = Page.new(name: 'Name', content: 'Content')
+    moderation = page.moderate(:name)
+    page.save
+
+    moderation
+  end
+
+  describe '#accept' do
+    it 'accepts moderated data' do
+      expect(subject.moderatable.name).to be_nil
+      subject.accept
+
+      expect(subject.moderatable.name).to eq('Name')
+      expect(subject.destroyed?).to be_true
+    end
+  end
+
+  describe '#discard' do
+    it 'discards moderated data' do
+      expect(subject.moderatable.name).to be_nil
+      subject.discard
+
+      expect(subject.moderatable.name).to be_nil
+      expect(subject.destroyed?).to be_true
+    end
+  end
+
+  describe '#preview' do
+    it 'previews moderated data' do
+      expect(subject.moderatable.name).to be_nil
+      preview = subject.preview
+
+      expect(preview.frozen?).to be_true
+      expect(preview.name).to eq('Name')
+    end
+  end
+
+  describe '#include?' do
+    it 'includes name' do
+      expect(subject.include?(:name)).to be_true
+      expect(subject.include?(:content)).to be_false
+    end
+  end
+end

data/the_moderator.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_moderator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "the_moderator"
+  spec.version       = TheModerator::VERSION
+  spec.authors       = ["Guillaume DOTT"]
+  spec.email         = ["guillaume+github@dott.fr"]
+  spec.description   = %q{Moderate fields of a model or its associations}
+  spec.summary       = %q{Moderate fields before their insertion in the database by serializing and saving them into a separate 'moderations' table.}
+  spec.homepage      = "https://github.com/gdott9/the_moderator"
+  spec.license       = "AGPL"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel", ">= 3.2.0", "< 5.0"
+  spec.add_dependency "activerecord", ">= 3.2.0", "< 5.0"
+  spec.add_dependency "activesupport", ">= 3.2.0", "< 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.3"
+
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "combustion", "~> 0.5"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: the_moderator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume DOTT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Moderate fields of a model or its associations
+email:
+- guillaume+github@dott.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/the_moderator/install/USAGE
+- lib/generators/the_moderator/install/install_generator.rb
+- lib/generators/the_moderator/install/templates/migration.rb
+- lib/generators/the_moderator/install/templates/moderation.rb
+- lib/the_moderator.rb
+- lib/the_moderator/exceptions.rb
+- lib/the_moderator/model.rb
+- lib/the_moderator/moderation_model.rb
+- lib/the_moderator/version.rb
+- spec/internal/app/models/category.rb
+- spec/internal/app/models/link.rb
+- spec/internal/app/models/moderation.rb
+- spec/internal/app/models/page.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb
+- spec/the_moderator/model_spec.rb
+- spec/the_moderator/moderation_model_spec.rb
+- the_moderator.gemspec
+homepage: https://github.com/gdott9/the_moderator
+licenses:
+- AGPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Moderate fields before their insertion in the database by serializing and
+  saving them into a separate 'moderations' table.
+test_files:
+- spec/internal/app/models/category.rb
+- spec/internal/app/models/link.rb
+- spec/internal/app/models/moderation.rb
+- spec/internal/app/models/page.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb
+- spec/the_moderator/model_spec.rb
+- spec/the_moderator/moderation_model_spec.rb