pk-merb_history 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,3 @@
+== merb_history
+
+A plugin for *the* Merb framework that provides ...

data/Rakefile

@@ -6,7 +6,7 @@ require 'merb-core'
 require 'merb-core/tasks/merb'
 
 GEM_NAME = "merb_history"
-GEM_VERSION = "0.0.1"
+GEM_VERSION = "0.0.2"
 AUTHOR = "Pavel Kunc"
 EMAIL = "pavel.kunc@gmail.com"
 HOMEPAGE = "http://github.com/pk/merb_history"
@@ -18,15 +18,15 @@ spec = Gem::Specification.new do |s|
   s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
   s.summary = SUMMARY
   s.description = s.summary
   s.author = AUTHOR
   s.email = EMAIL
   s.homepage = HOMEPAGE
-  s.add_dependency('merb', '>= 1.0.11')
+  s.add_dependency('merb-core', '>= 1.0.11')
   s.require_path = 'lib'
-  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+  s.files = %w(LICENSE README.rdoc Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
   
 end
 

data/lib/merb_history.rb

@@ -7,6 +7,7 @@ if defined?(Merb::Plugins)
   require File.join(File.dirname(__FILE__) / "merb_history" /  "history" / "history")
   require File.join(File.dirname(__FILE__) / "merb_history" /  "merb" / "controller")
   require File.join(File.dirname(__FILE__) / "merb_history" /  "merb" / "request")
+  require File.join(File.dirname(__FILE__) / "merb_history" /  "merb" / "url_helpers")
 
   Merb::BootLoader.before_app_loads do
     # require code that must be loaded before the application

data/lib/merb_history/history/history.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module MerbHistory
 
   class History
@@ -9,7 +11,7 @@ module MerbHistory
     SESSION_RETURN_TO_KEY = :return_to
 
     # Accessors
-    attr_accessor :max_size, :exclude
+    attr_accessor :max_size, :exclude, :return_to
     attr_reader :history
 
     def initialize(session, options = {})
@@ -40,15 +42,6 @@ module MerbHistory
       !@return_to.empty?
     end
     
-    def return_to(default, keep = false)
-      if should_return?
-        url = keep ? @return_to.first : @return_to.pop
-      else
-        url = default.is_a? Symbol ? url(default) : default
-      end
-      url
-    end
-
     def init_session(session)
       session[SESSION_HISTORY_KEY] = [] if session[SESSION_HISTORY_KEY].nil?
       session[SESSION_RETURN_TO_KEY] = [] if session[SESSION_RETURN_TO_KEY].nil?

data/lib/merb_history/merb/controller.rb

@@ -1,24 +1,12 @@
 module MerbHistory
   module Controller
 
-    def self.included(base)
-      base.class_eval <<-RUBY 
-        alias original_url url 
-        def url(name, *args)
-            if args.include?(:return_here)
-              args.delete(:return_here)
-              args << {:return_here => 1}
-            end
-          original_url(name, *args)
-        end
-      RUBY
-    end
-
     def record_history
       request.history.push(request)
     end
 
     def init_history(options = {})
+      self.class.send(:include, MerbHistory::UrlHelpers)
       request.history ||= History.new(session, options)
     end
 

data/lib/merb_history/merb/request.rb

@@ -9,5 +9,6 @@ module MerbHistory
       raise ArgumentError, 'Pass MerbHistory::History objects only.' unless h.is_a? History
       @_history = h
     end
-  end
-end
+
+  end #Request
+end #MerbHistory

data/lib/merb_history/merb/url_helpers.rb

@@ -1,9 +1,28 @@
 module MerbHistory
   module UrlHelpers
+    
+    def self.included(base)
+      base.class_eval do
+        override! :url
+        alias :merb_controller_url :url unless method_defined?(:merb_controller_url)
+        alias :url :url_with_normalized_history_params
+      end
+    end
+
+    def url_with_normalized_history_params(name, *args)
+      return merb_controller_url(name) if args.empty?
+      args[args.length - 1] = args.last.merge({:return_here => 1}) if args.last.is_a?(Hash) && args.last.delete(:return_here)
+      merb_controller_url(name, *args)
+    end
 
-    alias :original_url, :url
-    def url(name, *args)
+    def return_to(default, keep = false)
+      if request.history.should_return?
+        keep ? request.history.return_to.first : request.history.return_to.pop
+      else
+        default.is_a?(Symbol) ? url(default) : default
+      end
     end
+    alias :return_in_history_or_to :return_to
 
-  end
-end
+  end #UrlHelpers
+end #MerbHistory

data/spec/{merb_history_history_spec.rb → history/history_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe MerbHistory::History do
 

data/spec/{merb_history_controller_spec.rb → merb/controller_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe MerbHistory::Controller do
 
@@ -6,6 +6,7 @@ describe MerbHistory::Controller do
 
     before(:all) do
       @controller = HistoryfiedController.new(fake_request)
+      @controller.init_history
     end
 
     it "should allow to record history" do
@@ -15,6 +16,14 @@ describe MerbHistory::Controller do
     it "should allow to init history" do
       @controller.should respond_to(:init_history)
     end
+
+    it "should include MerbHistoy URL helpers" do
+      @controller.class.ancestors.should include(MerbHistory::UrlHelpers)
+    end
+
+    it "should respond to return_to" do
+      @controller.should respond_to(:return_to)
+    end
   end
 
   describe "#init_history" do

data/spec/merb/request_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe MerbHistory::Request do
+  before(:each) do
+    @request = fake_request
+  end
+
+  it "should add history method to request" do 
+    @request.should respond_to(:history)
+  end
+
+  it "should add history= method to request" do 
+    @request.should respond_to(:history=)
+  end
+end

data/spec/merb/url_helpers_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe MerbHistory::UrlHelpers do
+
+  before(:each) do
+    @controller = HistoryfiedController.new(fake_request)
+    @controller.init_history
+  end
+
+  describe "#url()" do
+    it "should normalize return_here parameter and keep other parameters" do
+      addr = @controller.url(:home, :return_here => 'yes', :test => 'x')
+      addr.should match(/^\/index\?(&|return_here=1|test=x)/)
+    end
+
+    it "should not affect route parameters with return_here and other params" do
+      addr = @controller.url(:index_with_params, 1, 2, :return_here => 'yes', :test => 'x')
+      addr.should match(/^\/index\/1\/2\?(&|return_here=1|test=x)/)
+    end
+
+    it "should not affect route parameters with return_here" do
+      addr = @controller.url(:index_with_params, 1, 2, :return_here => 'yes')
+      addr.should match(/^\/index\/1\/2\?return_here=1/)
+    end
+
+    it "should not affect route parameters without return_here" do
+      addr = @controller.url(:index_with_params, 1, 2)
+      addr.should match(/^\/index\/1\/2/)
+    end
+  end
+
+  describe "return_to()" do
+    before(:all) do
+      # Add history recording and initialization to controller
+      class HistoryfiedController
+        before :init_history
+        after :record_history
+      end
+    end
+
+    it "should have verbose alias return_in_history_or_to" do
+      HistoryfiedController.new(fake_request).should respond_to(:return_in_history_or_to)
+    end
+
+    describe "without set to return here" do
+      before(:each) do
+        with_cookies(HistoryfiedController) do
+          get('/index')
+          get('/show')
+          @controller = get('/edit')
+        end
+      end
+    
+      it "should return default URL" do
+        @controller.return_to(:home).should match(/^\/index/)
+      end
+    end
+
+    describe "with set to return here" do
+      before(:each) do
+        with_cookies(HistoryfiedController) do
+          get('/index')
+          get('/show')
+          @controller = get('/edit', {:return_here => 1})
+        end
+      end
+      it "should return URL from history" do
+        @controller.return_to(:home).should match(/^\/show/)
+      end
+
+      it "should pop off URL from history when returned" do
+        @controller.return_to(:home).should match(/^\/show/)
+        @controller.return_to(:home).should match(/^\/index/)
+      end
+
+      it "should not pop off URL from history when returned if we ask to not pop off" do
+        @controller.return_to(:home, true).should match(/^\/show/)
+        @controller.return_to(:home, true).should match(/^\/show/)
+      end
+    end
+  end
+
+end

data/spec/merb_history_spec.rb

@@ -3,11 +3,11 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe "merb_history" do
 
   it "should historyfi controllers" do
-    HistoryfiedController.ancestors.include? MerbHistory::Controller
+    HistoryfiedController.ancestors.should include(MerbHistory::Controller)
   end
 
   it "should historyfi request" do
-    Merb::Request.ancestors.include? MerbHistory::Request
+    Merb::Request.ancestors.should include(MerbHistory::Request)
   end
 
 end

data/spec/spec_helper.rb

@@ -21,6 +21,8 @@ Spec::Runner.configure do |config|
 end
 
 Merb::Router.prepare do
+  match('/index').to(:controller => 'historyfied_controller').name(:home)
+  match('/index/:first/:second').to(:controller => 'historyfied_controller').name(:index_with_params)
   match('/:action').to(:controller => 'historyfied_controller')
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pk-merb_history
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Pavel Kunc
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-16 00:00:00 -07:00
+date: 2009-04-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: merb
+  name: merb-core
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -29,12 +29,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - LICENSE
 - TODO
 files: 
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - TODO
 - lib/merb_history
@@ -46,11 +46,15 @@ files:
 - lib/merb_history/merb/url_helpers.rb
 - lib/merb_history/merbtasks.rb
 - lib/merb_history.rb
+- spec/history
+- spec/history/history_spec.rb
 - spec/historyfied_controller.rb
 - spec/log
 - spec/log/merb_test.log
-- spec/merb_history_controller_spec.rb
-- spec/merb_history_history_spec.rb
+- spec/merb
+- spec/merb/controller_spec.rb
+- spec/merb/request_spec.rb
+- spec/merb/url_helpers_spec.rb
 - spec/merb_history_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -77,7 +81,7 @@ requirements: []
 rubyforge_project: merb_history
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Merb plugin that provides history management for user actions (URLs).
 test_files: []
 

data/README

@@ -1,4 +0,0 @@
-merb_history
-============
-
-A plugin for the Merb framework that provides ...