review_and_approve 0.0.1.alpha → 0.0.1

data/README.md

@@ -18,14 +18,56 @@ Or install it yourself as:
 
 ## Usage
 
+### Setup
 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
+  review_and_approve
+  attr_accessible :field1, :field2.. #Make sure attr_accessible is defined properly
 end
 ```
 
+Use Cancan or other authorization mechanism to define a custom ability to 'publish' the records
+Make sure your controller has access to current_ability method and it returns true or false on can? :publish, @product
+
+In your controller and views, allow the users to set the published flag on the model when you are ready to publish
+
+#### Customizations
+
+```ruby
+review_and_approve :by => [:as_json, :to_json]
+  # defaults to :by => [:as_json] 
+  # list of methods whose output will be cached for delta comparisons
+
+review_and_approve :field => :published 
+  # Override the field used to track whether we are publishing or not.
+```
+
+### Showing differences from published version
+A method called `published_version` is defined on the model that provides access to cached methods as of the last published version. For example:
+
+```ruby
+  @product.published_version(:as_json)   
+  # => returns the as_json hash from the last time the product was published
+
+  # Rendering the differences
+  render :partial => "review_and_approve/delta", 
+    :locals => {:published => @product.published_version(:as_json),
+                 :current => @product.as_json}
+  # Given two hashes (before/after), this will render the changes in a table
+
+  #styling the differences
+  Check out delta.css in the gem and override the styles in your application
+```
+
+## Limitations
+* only certified on Rails 3.1, ruby 1.9.2
+* Will use Rails.cache to store the output of methods provided to review_and_approve. We currently assume that the cache has infinite space -i.e. the cached value is never lost
+ - possibly use the database in future for storing cached values
+* Currently depends on the application to call attr_accessible
+
+
 ## Contributing
 
 1. Fork it

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

@@ -1,8 +1,3 @@
-.review_and_approve table tr td{
-  border: 1px solid black;
-}
-
-
 .review_and_approve
 {
   font-family: "Lucida Sans Unicode", "Lucida Grande", Sans-Serif;

data/lib/review_and_approve.rb

@@ -1,6 +1,7 @@
 require "review_and_approve/version"
-require "review_and_approve/engine"
+require "review_and_approve/engine" if defined? Rails
 require "review_and_approve/model_additions"
+require "review_and_approve/controller_additions"
 require "review_and_approve/railtie" if defined? Rails
 
 module ReviewAndApprove

data/lib/review_and_approve/controller_additions.rb

@@ -0,0 +1,13 @@
+module ReviewAndApprove
+  module ControllerAdditions
+    def self.extended(base)
+      base.send :define_method, :review_ability do |&block|
+        Thread.current[:reviewAndApprove_current_ability] = self.send :current_ability
+        block.call
+      end
+
+      base.around_filter :review_ability
+    end
+
+  end
+end

data/lib/review_and_approve/model_additions.rb

@@ -1,42 +1,54 @@
 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)
+      # Extracting options:
+      # 1. methods to cache - option :by, default value [:as_json]
+      # 2. attribute to track as published - option :field, default value :publish
       methods = [:as_json]
+      field = :publish
       args.each do |arg|
         if arg.is_a? Hash
-          if arg[:by].present?
+          if !arg[:by].nil?
             methods = arg[:by]
           end
+          if !arg[:field].nil?
+            field = arg[:field]
+          end
         end
       end
-      before_save do
-        if Thread.current[:reviewAndApprove_current_ability].cannot? :publish, self
-          self.published = false
-        end
-        true
-      end
+
+      # define the field as an attribute on the model
+      attr_accessor field
 
       after_save do
-        if self.published
+        published = self.send(field)
+        #If we are publishing the record
+        if published and (published==true or published=="true" or self.send(field).to_i>0 rescue false) #in case the field gets set to "0" and "1"
           methods.each do |method|
+            # Refresh all caches
             Rails.cache.write("ReviewAndApprove_#{self.class.name}_#{self.id}_#{method}", self.send(method))
           end
         end
+
+        true
       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)
+      send(:define_method, :mass_assignment_authorizer) do |role = :default|
+        # force add the :publish attribute into attr_accessible
+        super(role) + [field]
+      end
+
+      validates_each field do |record, attr, value|
+        able = Thread.current[:reviewAndApprove_current_ability].try(:can?, :publish, record)
+        # if user can not publish the record, create an error.
+        if !able and value and (value==true or value=="true" or value.to_i>0 rescue false)
+          record.errors[attr] << "can not be marked as true by this user"
+        end
+      end
     end
   end
 end

data/lib/review_and_approve/railtie.rb

@@ -5,5 +5,11 @@ module ReviewAndApprove
         extend ModelAdditions
       end
     end
+
+    initializer "review_and_approve.contoller_additions" do
+      ActiveSupport.on_load(:action_controller) do
+        extend ReviewAndApprove::ControllerAdditions # ActiveSupport::Concern
+      end
+    end
   end
 end

data/lib/review_and_approve/version.rb

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

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: review_and_approve
 version: !ruby/object:Gem::Version 
-  prerelease: 6
-  version: 0.0.1.alpha
+  prerelease: 
+  version: 0.0.1
 platform: ruby
 authors: 
 - Paramveer Singh
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-15 00:00:00 Z
+date: 2013-05-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -29,11 +29,66 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.7
+        version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: supermodel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cancan
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: debugger
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Adds Review and Approval functionality for content sites.
 email: 
 - paramveer.singh@hikeezee.com
@@ -47,6 +102,7 @@ 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/controller_additions.rb
 - lib/review_and_approve/engine.rb
 - lib/review_and_approve/model_additions.rb
 - lib/review_and_approve/railtie.rb
@@ -71,9 +127,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
 requirements: []
 
 rubyforge_project: