review_and_approve 0.0.1.alpha

data/README.md

@@ -0,0 +1,35 @@
+# ReviewAndApprove
+
+Add functionality in a content based app to explicitly review and approve all data changes before they are visible to end users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'review_and_approve'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install review_and_approve
+
+## Usage
+
+call `review_and_approve` in an ActiveRecord class
+
+```ruby
+class Product < ActiveRecord::Base
+  review_and_approve :by => [:as_json, :to_json] #defaults to :by => [:as_json] - list of methods whose output will be cached for delta comparisons
+end
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/assets/stylesheets/review_and_approve/application.css

@@ -0,0 +1,3 @@
+/*
+ *= require ./delta
+*/

data/app/assets/stylesheets/review_and_approve/delta.css

@@ -0,0 +1,49 @@
+.review_and_approve table tr td{
+  border: 1px solid black;
+}
+
+
+.review_and_approve
+{
+  font-family: "Lucida Sans Unicode", "Lucida Grande", Sans-Serif;
+  font-size: 12px;
+  margin: 45px;
+  width: 480px;
+  text-align: left;
+  border-collapse: collapse;
+}
+.review_and_approve thead th.rounded-company
+{
+  background: #b9c9fe url('table-images/left.png') left -1px no-repeat;
+}
+.review_and_approve thead th.rounded-q4
+{
+  background: #b9c9fe url('table-images/right.png') right -1px no-repeat;
+}
+.review_and_approve th
+{
+  padding: 8px;
+  font-weight: normal;
+  font-size: 13px;
+  color: #039;
+  background: #b9c9fe;
+}
+.review_and_approve td
+{
+  padding: 8px;
+  background: #e8edff;
+  border-top: 1px solid #fff;
+  color: #669;
+}
+.review_and_approve tfoot td.rounded-foot-left
+{
+  background: #e8edff url('table-images/botleft.png') left bottom no-repeat;
+}
+.review_and_approve tfoot td.rounded-foot-right
+{
+  background: #e8edff url('table-images/botright.png') right bottom no-repeat;
+}
+.review_and_approve tbody tr:hover td
+{
+  background: #d0dafd;
+}

data/app/views/review_and_approve/_delta.html.erb

@@ -0,0 +1,26 @@
+<% published ||= {} %>
+<% diff_keys = published.diff(current).keys %>
+<div class="review_and_approve">
+<% if diff_keys.count > 0 %>
+  <table>
+    <thead>
+      <tr>
+        <th scope="col" class="rounded-company">Field Name</th>
+        <th scope="col" class="rounded-q1">Published Value</th>
+        <th scope="col" class="rounded-q4">Current Value</th>
+      </tr>
+    </thead>
+    <% published.diff(current).keys.each do |key| %>
+    <tbody>
+      <tr>
+        <td><%= key %></td>
+        <td><%= published[key] || "<BLANK>" %></td>
+        <td><%= current[key] || "<BLANK>" %></td>
+      </tr>
+    </tbody>
+    <% end %>
+  </table>
+<% else %>
+  Latest version is published
+<% end %>
+</div>

data/lib/review_and_approve/engine.rb

@@ -0,0 +1,4 @@
+module ReviewAndApprove
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/review_and_approve/model_additions.rb

@@ -0,0 +1,42 @@
+module ReviewAndApprove
+  module ModelAdditions
+    class ModelValidator < ActiveModel::Validator
+      def validate(record)
+        if Thread.current[:reviewAndApprove_current_ability].cannot?(:publish, record) and record.published
+          record.errors[:published] << "can not be marked as true by this user"
+        end
+      end
+    end
+
+    def review_and_approve(*args)
+      methods = [:as_json]
+      args.each do |arg|
+        if arg.is_a? Hash
+          if arg[:by].present?
+            methods = arg[:by]
+          end
+        end
+      end
+      before_save do
+        if Thread.current[:reviewAndApprove_current_ability].cannot? :publish, self
+          self.published = false
+        end
+        true
+      end
+
+      after_save do
+        if self.published
+          methods.each do |method|
+            Rails.cache.write("ReviewAndApprove_#{self.class.name}_#{self.id}_#{method}", self.send(method))
+          end
+        end
+      end
+
+      send(:define_method, :published_version) do |method_name|
+        Rails.cache.read("ReviewAndApprove_#{self.class.name}_#{self.id}_#{method_name}")
+      end
+
+      send(:validates_with, ReviewAndApprove::ModelAdditions::ModelValidator)
+    end
+  end
+end

data/lib/review_and_approve/railtie.rb

@@ -0,0 +1,9 @@
+module ReviewAndApprove
+  class Railtie < Rails::Railtie
+    initializer 'review_and_approve.model_additions' do
+      ActiveSupport.on_load(:active_record) do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/review_and_approve/version.rb

@@ -0,0 +1,3 @@
+module ReviewAndApprove
+  VERSION = "0.0.1.alpha"
+end

data/lib/review_and_approve.rb

@@ -0,0 +1,8 @@
+require "review_and_approve/version"
+require "review_and_approve/engine"
+require "review_and_approve/model_additions"
+require "review_and_approve/railtie" if defined? Rails
+
+module ReviewAndApprove
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: review_and_approve
+version: !ruby/object:Gem::Version 
+  prerelease: 6
+  version: 0.0.1.alpha
+platform: ruby
+authors: 
+- Paramveer Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+description: Adds Review and Approval functionality for content sites.
+email: 
+- paramveer.singh@hikeezee.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/assets/stylesheets/review_and_approve/application.css
+- app/assets/stylesheets/review_and_approve/delta.css
+- app/views/review_and_approve/_delta.html.erb
+- lib/review_and_approve/engine.rb
+- lib/review_and_approve/model_additions.rb
+- lib/review_and_approve/railtie.rb
+- lib/review_and_approve/version.rb
+- lib/review_and_approve.rb
+- Rakefile
+- README.md
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds Review and Approval functionality for content sites.
+test_files: []
+