preview 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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,4 @@
+Preview
+=======
+
+Make an ActiveRecord object pre-viewable, and display the preview using existing/custom templates

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'  
+require 'rake'  
+  
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "preview"  
+    gemspec.version = "0.0.2"
+    gemspec.summary = "Add preview functionality to rails resources"  
+    gemspec.description = "Make an ActiveRecord object previewable, and display the preview using existing/custom templates"  
+    gemspec.email = "bigbeliever@gmail.com"  
+    gemspec.homepage = "http://github.com/zerothabhishek/preview"  
+    gemspec.authors = ["sifar"]  
+  end
+  Jeweler::RubygemsDotOrgTasks.new   
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/preview.rb

@@ -0,0 +1,52 @@
+require 'preview/preview_processor'
+
+module Preview
+  module Controllers
+    
+    def self.included base 
+      base.extend(Preview::Controllers::ClassMethods)
+      Preview::Views.modify_form_helpers
+    end
+        
+    module ClassMethods
+      def previewable options={}        
+        include Preview::Controllers::InstanceMethods        
+        self.class_eval { cattr_accessor :preview }
+        self.preview = PreviewProcessor.new(self, options)
+        self.before_filter(:do_preview, {:only => self.preview.actions })              
+      end            
+    end
+    
+    module InstanceMethods
+      def do_preview
+        return if params[:preview].blank?
+        self.class.preview.process request
+        render self.class.preview.template
+      end
+    end
+    
+  end
+  
+  module Views
+    def self.modify_form_helpers
+      ActionView::Helpers::FormBuilder.class_eval do
+        alias orig_submit submit        
+        def submit value=nil, options={}
+          options[:onclick] = "this.form.target='';return true;"
+          orig_submit(value, options)
+        end
+      end
+      ActionView::Helpers::FormBuilder.send(:include, Preview::Views::Helpers)
+    end
+    
+    module Helpers        
+      def preview options={}
+        options[:id] = "preview"
+    	  options[:name] = "preview"
+    	  options[:onclick] = "this.form.target='_blank';return true;"
+    	  orig_submit("preview", options)      
+      end
+    end    
+  end
+  
+end

data/lib/preview/preview_processor.rb

@@ -0,0 +1,39 @@
+module Preview
+  class PreviewProcessor
+    
+    attr_accessor :controller, :modelKlass, :actions, :template
+    
+    def initialize controllerKlass, options={}
+      @controller = controllerKlass                         # the class name of controller
+      @modelKlass = model_for @controllerName               # the class name of the corresponding model
+      @actions = options[:actions] || [:create, :update]
+      @template = options[:template] || "show"
+    end
+
+    def process request
+      controllerInstance = request.env["action_controller.instance"]
+      params = controllerInstance.params
+      
+      data = params[@modelKlass.to_s.downcase]      
+      modelObj = @modelKlass.new(data)
+      modelObj.id = params[:id].to_i
+      
+      instanceVariable = ("@" + @modelKlass.to_s.downcase).to_sym
+      controllerInstance.instance_variable_set(instanceVariable, modelObj)
+    end
+    
+    private 
+    
+    def model_for controllerKlass
+      @controller.to_s.split("Controller").first.singularize.constantize
+    end
+    
+    def controller_from request
+      controllerName = request.parameters[:controller]                          # "posts"
+      controllerKlass = (controllerName.capitalize +"Controller").constantize   # "posts"->"Posts"->"PostsController"->PostsController
+      # controllerKlass = request.env["action_controller.instance"].class
+      return controllerKlass
+    end
+  
+  end
+end

data/preview.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{preview}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["sifar"]
+  s.date = %q{2011-01-14}
+  s.description = %q{Make an ActiveRecord object previewable, and display the preview using existing/custom templates}
+  s.email = %q{bigbeliever@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "install.rb",
+    "lib/preview.rb",
+    "lib/preview/preview_processor.rb",
+    "pkg/preview-0.0.1.gem",
+    "preview.gemspec",
+    "rails/init.rb",
+    "test/preview_processor_test.rb",
+    "test/preview_test.rb",
+    "test/test_helper.rb",
+    "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/zerothabhishek/preview}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.1}
+  s.summary = %q{Add preview functionality to rails resources}
+  s.test_files = [
+    "test/preview_processor_test.rb",
+    "test/preview_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), "lib", "preview")
+
+# Ask ActiveRecord::Base to include code in the Preview::Models module
+# Execute the ActiveRecord::Base.include method with Preview::Models arg
+#ActiveRecord::Base.send(:include, Preview::Models)
+
+# Ask ActionController::Base to include Preivew::Controller::InstanceMethods
+ActionController::Base.send(:include, Preview::Controllers)

data/test/preview_processor_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'mocha'
+
+class FoosController < ActionController::Base ; end
+class Foo; end
+class FakeRequest
+  def env
+    fc = FoosController.new
+    {"action_controller.instance" => fc}
+  end
+end
+
+class PreviewProcessorTest < ActiveSupport::TestCase
+  
+  test "initialize should initialize the attributes controller, modelKlass, actions and template" do
+    p = Preview::PreviewProcessor.new FoosController
+    assert FoosController, p.controller
+    assert Foo, p.modelKlass
+    assert [:create, :update], p.actions
+    assert "show", p.template
+  end
+  
+  test "process should set an instance variable by the name of the model for the controller instance" do
+    p = Preview::PreviewProcessor.new FoosController
+    request = FakeRequest.new
+    FoosController.any_instance.stubs(:params).returns(:Foo => {})
+    Foo.stubs(:new).returns(Foo.new)
+    
+    p.process request
+    assert p.instance_variable_defined?(:@foo)
+  end
+  
+end  

data/test/preview_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+require 'mocha'
+
+class TestController < ActionController::Base ; end
+
+class PreviewTest < ActiveSupport::TestCase
+  
+  def setup
+  end
+
+  # previewable
+  test "the class method _previewable_ should be available to all controllers in project using the gem" do
+    assert ActionController::Base.respond_to?"previewable"
+  end
+
+  test "a controller using _previewable_ declaration should get the *do_preview* instance method" do
+    TestController.previewable
+    assert TestController.method_defined? :do_preview
+  end
+  
+  test "a controller using _previewable_ declaration should get the class attribute _preview_" do
+    TestController.previewable
+    assert TestController.class_variable_defined?(:@@preview)
+    assert TestController.respond_to? :preview
+    assert TestController.respond_to? :preview=
+  end
+  
+  test "a controller using _previewable_ should have the preview attribute holding a PreviewProcessor object" do
+    TestController.previewable
+    assert_equal Preview::PreviewProcessor, TestController.preview.class
+  end
+  
+  test "controller using _previewable_ should get a do_preview before_filter for the specified actions" do
+    TestController.expects(:before_filter).with(:do_preview, {:only => :create})
+    TestController.previewable :actions=>:create
+  end
+  
+  # do_preview
+  test "do_preview should not process preview if the preview parameter is not set" do
+    TestController.any_instance.stubs(:params).returns({:preview => nil})
+    Preview::PreviewProcessor.expects(:process).never
+    TestController.previewable
+    assert_equal nil, TestController.new.do_preview
+  end
+  
+  test "do_preview should process preview if preview parameter is set" do
+    TestController.any_instance.stubs(:params).returns({:preview => true})
+    TestController.any_instance.stubs(:request).returns("requestHash")
+    Preview::PreviewProcessor.any_instance.stubs(:process).returns(true)
+    
+    TestController.any_instance.expects(:render).with("show").returns(true)
+    Preview::PreviewProcessor.any_instance.expects(:process).with("requestHash").once
+    
+    TestController.previewable  
+    TestController.new.do_preview  
+  end
+  
+  # form helpers
+  test "a *preview* form builder method should be available for a project using the gem" do
+    assert ActionView::Helpers::FormBuilder.method_defined? :preview
+  end
+  
+  test "the *submit* form builder method should be aliased as *orig_submit* for a project using the gem" do
+    assert ActionView::Helpers::FormBuilder.method_defined? :orig_submit
+  end
+  
+  test "the *submit* form builder method should be modified so it sets an onclick JS option" do
+    assert true
+  end
+    
+=begin  
+  test "previewable should include the Preview::Controllers::InstanceMethods module in the calling class" do
+    # stub the other functionality
+    TestClass.stubs(:class_eval).returns(true)
+    TestClass.stubs(:before_filter).returns(true)
+    TestClass.stubs(:preview=).returns(true)
+    Preview::PreviewProcessor.stubs(:new).returns(true)
+    
+    TestClass.expects(:include).with(Preview::Controllers::InstanceMethods).once
+    TestClass.previewable
+  end
+
+  test "previewable should add the preview attribute to the calling class" do
+    # stub the other functionality
+    TestClass.stubs(:before_filter).returns(true)
+    TestClass.stubs(:include).returns(true)
+    PreviewProcessor.stubs(:new).returns("foo")
+    
+    TestClass.previewable
+    assert_equal "foo", TestClass.preview
+    assert_nothing_raised(NoMethodError){  TestClass.preview = "hello" }  
+  end
+  
+  test "previewable should assign a PreviewProcessor object to the class attribute preview " do
+    # stub out the other functionality
+    TestClass.stubs(:before_filter).returns(true)
+    TestClass.stubs(:include).returns(true)
+    PreviewProcessor.stubs(:new).returns("preview_processor_obj")
+    
+    TestClass.previewable
+    assert_equal "preview_processor_obj", TestClass.preview
+  end
+  
+  test "previewable should invoke the before_filter for the calling class" do
+    # stub the other functionality
+    TestClass.stubs(:include).returns(true)
+    TestClass.stubs(:class_eval).returns(true)
+    TestClass.stubs(:preview=).returns(true)
+    PreviewProcessor.stubs(:new).returns(true)
+    
+    TestClass.expects(:before_filter).with(:do_preview).once
+    TestClass.previewable
+  end
+=end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'action_controller'
+
+gem_root = File.join(File.dirname(__FILE__), '..')
+$LOAD_PATH << File.join(gem_root, 'lib')
+$LOAD_PATH << File.join(gem_root, 'lib', 'preview')
+
+require File.join(gem_root, 'init.rb')

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: preview
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- sifar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-14 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: Make an ActiveRecord object previewable, and display the preview using existing/custom templates
+email: bigbeliever@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- install.rb
+- lib/preview.rb
+- lib/preview/preview_processor.rb
+- pkg/preview-0.0.1.gem
+- preview.gemspec
+- rails/init.rb
+- test/preview_processor_test.rb
+- test/preview_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/zerothabhishek/preview
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Add preview functionality to rails resources
+test_files: 
+- test/preview_processor_test.rb
+- test/preview_test.rb
+- test/test_helper.rb