rewritten 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7457fe2750b09f702f64e2255515fcb1b7d681f1
-  data.tar.gz: a7653f8eb5b983e220f4332d6395d0f17fec6e4a
+  metadata.gz: 4bbca7b948eee5641bd22eb57aec66f65a2501fc
+  data.tar.gz: 9eba6f5b82e869fef3c50a487f8ba0e60f793d3e
 SHA512:
-  metadata.gz: e0f1fb6a8ee92c5517963ec40e34d7ac286312ae4382049c9b10209e3402b6a858d7d9346abd06fc0925ad3124c9a7c6f5523f0ddaf9e603d3d9215c66b5020e
-  data.tar.gz: 23194964b145fe819f7aa68a6bc327661f932483a5046d16d9868604c350be7fc829cf2c6c82aaa0e77dc953f05e57fa0ef8d403fb96b98af7afb3b200ec9351
+  metadata.gz: 7b0ab0e5fc9379e0ea051040a864fbdeb5f78662fa92f24d9d15bc3c933a78313518160f2e0c20cce80bfbe36d4ec62d3cb9bde81eb3bb24dfc4f31f6ea66331
+  data.tar.gz: 4b237a6666a91216654ac7f894bce5882dbcf73274e8cc07b9ed237f2be64c9e987663ca2106fde7c783957c13706ac800f3e5fdf13b1065523538d80b796df3

data/HISTORY.rdoc

@@ -1,3 +1,7 @@
+== 0.6.0 
+
+  * backwards translations (from resource to current translation)
+
 == 0.5.0
 
   * dump and import scripts in bin/

data/lib/rack/url.rb

@@ -8,8 +8,9 @@ module Rack
 
       def initialize(app, &block)
         @app = app
+        @translate_backwards = false
 
-        self.instance_eval(&block) if block_given?
+        instance_eval(&block) if block_given?
       end
 
       def call(env)
@@ -17,7 +18,12 @@ module Rack
 
         subdomain = env["SUBDOMAIN"] ? "#{env["SUBDOMAIN"]}:" : ""
 
-        if to = ::Rewritten.includes?("#{subdomain}#{req.path_info}")
+        path = "#{subdomain}#{req.path_info}"
+
+        if ::Rewritten.includes?(path) or translate_backwards? && ::Rewritten.exist_translation_for?(path) 
+
+          to = ::Rewritten.includes?(path) || path
+
           current_path = ::Rewritten.get_current_translation(to)
           current_path = current_path.split(":").last
 
@@ -42,7 +48,7 @@ module Rack
             r.redirect(new_path, 301)
             a = r.finish
           end
-        else
+       else
           @app.call(req.env) 
         end
       end
@@ -54,10 +60,13 @@ module Rack
 
 
       private
+
+      def translate_backwards?
+        @translate_backwards  
+      end
       
-      def add_translation(from,to)
-        ::Rewritten.redis = :test unless ::Rewritten.redis == :test
-        ::Rewritten.add_translation(from, to)
+      def translate_backwards=(yes_or_no)
+        @translate_backwards = yes_or_no
       end
 
 

data/lib/rewritten/server.rb

@@ -153,6 +153,7 @@ module Rewritten
 
       if params[:f] && params[:f] != ""
         @translations = []
+
         keys = Rewritten.redis.keys("*#{params[:f]}*")
         keys.each do |key|
           prefix, url = key.split(":") 
@@ -164,12 +165,13 @@ module Rewritten
             @translations << [from, url]
           end
         end
+
         @size = @translations.size
         @translations = @translations[params[:start].to_i..params[:start].to_i+Rewritten.per_page-1]
 
       else
-        @size = Rewritten.size("froms") 
-        froms = Rewritten.list_range("froms", @start, Rewritten.per_page) 
+        @size = Rewritten.num_froms
+        froms = Rewritten.all_froms[@start, @start+Rewritten.per_page-1]
         @translations = froms.map{|f| [f, Rewritten.redis.get("from:#{f}")]}
       end
 
@@ -227,7 +229,7 @@ module Rewritten
     get "/cleanup" do
       # find keys that have no target
       @from_without_tos= []
-      Rewritten.redis.lrange("froms", 0, -1).each do |from|
+      Rewritten.all_froms.each do |from|
         if Rewritten.redis.get("from:#{from}").empty?
           @from_without_tos << from
         end

data/lib/rewritten/version.rb

@@ -1,4 +1,4 @@
 module Rewritten
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end
 

data/lib/rewritten.rb

@@ -35,9 +35,6 @@ module Rewritten
       @redis = Redis::Namespace.new(namespace, :redis => redis)
     when Redis::Namespace
       @redis = server
-    when :test
-      @redis = :test
-      @static_translations = {}
     else
       @redis = Redis::Namespace.new(:rewritten, :redis => server)
     end
@@ -130,14 +127,10 @@ module Rewritten
   #
 
   def add_translation(from, to)
-    if @redis == :test
-      @static_translations[from] = to
-    else
-      redis.set("from:#{from}", to)
-      redis.lpush(:froms, from) 
-      redis.lpush(:tos, to) 
-      redis.rpush("to:#{to}", from) 
-    end
+    redis.set("from:#{from}", to)
+    redis.sadd(:froms, from) 
+    redis.sadd(:tos, to) 
+    redis.rpush("to:#{to}", from) 
   end
 
   def add_translations(to, froms)
@@ -145,14 +138,14 @@ module Rewritten
   end
 
   def num_translations(to)
-    Rewritten.size("to:#{to}")
+    Rewritten.redis.llen("to:#{to}")
   end
 
   def remove_translation(from, to)
     Rewritten.redis.del("from:#{from}")
-    Rewritten.redis.lrem("froms", 0, from)
+    Rewritten.redis.srem(:froms, from)
     Rewritten.redis.lrem("to:#{to}", 0, from)
-    Rewritten.redis.lrem("tos", 0, to) if num_translations(to) == 0
+    Rewritten.redis.srem(:tos, to) if num_translations(to) == 0
  end
 
   def remove_all_translations(to)
@@ -162,20 +155,20 @@ module Rewritten
   end
 
   def clear_translations
-    if Rewritten.redis == :test
-      @static_translations = {}    
-    else
-      Rewritten.redis.del(*Rewritten.redis.keys) unless Rewritten.redis.keys.empty?
-    end
+    Rewritten.redis.del(*Rewritten.redis.keys) unless Rewritten.redis.keys.empty?
+  end
+
+  # Returns an array of all known source URLs (that are to translated)
+  def froms
+    Array(redis.smembers(:froms))
+  end
+
+  def all_froms
+    Array(redis.smembers(:froms))
   end
 
   def all_tos
-    tos = []
-    if Rewritten.redis == :test
-      tos = @static_translations.values.uniq
-    else
-      tos = Rewritten.redis.lrange("tos",0,-1).uniq
-    end
+    Array(Rewritten.redis.smembers(:tos))
   end
 
   def all_translations
@@ -183,32 +176,18 @@ module Rewritten
   end
 
   def get_all_translations(to)
-    if Rewritten.redis == :test
-      @static_translations.to_a.select{|k,v| v == to}.map{|k,v| k} 
-    else
-      Rewritten.redis.lrange("to:#{to}", 0, -1)
-    end
+    Rewritten.redis.lrange("to:#{to}", 0, -1)
   end
 
   def get_current_translation(path)
-    if @redis == :test
-
-      translations = @static_translations.select{|k,v| v == path}
-
-      if translations.size > 0
-        return translations.keys.last
-      else
-        return path
-      end
-
-    else
-      translation = Rewritten.list_range("to:#{path}", -1)  
-      return translation if translation
-      return path
-    end
+    translation = Rewritten.list_range("to:#{path}", -1)  
+    return translation if translation
+    return path
   end
 
-
+  def exist_translation_for?(path)
+    get_current_translation(path) != path
+  end
 
   def add_hit(path, code, content_type)
     h = {:path => path, :code => code, :content_type => content_type}
@@ -220,61 +199,12 @@ module Rewritten
   end
 
   def includes?(path)
-    if @redis == :test
-      @static_translations[path]        
-    else
-      Rewritten.redis.get("from:#{path}")
-    end
-  end
-
-  #
-  # queue manipulation
-  #
-
-  # Pushes a job onto a queue. Queue name should be a string and the
-  # item should be any JSON-able Ruby object.
-  #
-  # Resque works generally expect the `item` to be a hash with the following
-  # keys:
-  #
-  #   class - The String name of the job to run.
-  #    args - An Array of arguments to pass the job. Usually passed
-  #           via `class.to_class.perform(*args)`.
-  #
-  # Example
-  #
-  #   Resque.push('archive', :class => 'Archive', :args => [ 35, 'tar' ])
-  #
-  # Returns nothing
-  def push(queue, item)
-    watch_queue(queue)
-    redis.rpush "queue:#{queue}", encode(item)
+    Rewritten.redis.get("from:#{path}")
   end
 
-  # Pops a job off a queue. Queue name should be a string.
-  #
-  # Returns a Ruby object.
-  def pop(queue)
-    decode redis.lpop("queue:#{queue}")
-  end
-
-  # Returns an integer representing the size of translations for a target. 
-  # Target name should be a string.
-  def size(target)
-    #redis.llen("target:#{target}").to_i
-    redis.llen(target).to_i
-  end
-
-  # Returns an array of items currently queued. Queue name should be
-  # a string.
-  #
-  # start and count should be integer and can be used for pagination.
-  # start is the item to begin, count is how many items to return.
-  #
-  # To get the 3rd page of a 30 item, paginatied list one would use:
-  #   Resque.peek('my_list', 59, 30)
-  def peek(queue, start = 0, count = 1)
-    list_range("queue:#{queue}", start, count)
+  # return the number of froms
+  def num_froms
+    redis.scard(:froms).to_i
   end
 
   # Does the dirty work of fetching a range of items from a Redis list
@@ -301,13 +231,6 @@ module Rewritten
     Array(redis.smembers(:targets))
   end
 
-  # Returns an array of all known source URLs (that are to translated)
-  def froms
-    Array(redis.smembers(:froms))
-  end
-
-
-
   # Given a queue name, completely deletes the queue.
   def remove_queue(queue)
     redis.srem(:queues, queue.to_s)
@@ -320,118 +243,7 @@ module Rewritten
     redis.sadd(:queues, queue.to_s)
   end
 
-
-  #
-  # job shortcuts
-  #
-
-  # This method can be used to conveniently add a job to a queue.
-  # It assumes the class you're passing it is a real Ruby class (not
-  # a string or reference) which either:
-  #
-  #   a) has a @queue ivar set
-  #   b) responds to `queue`
-  #
-  # If either of those conditions are met, it will use the value obtained
-  # from performing one of the above operations to determine the queue.
-  #
-  # If no queue can be inferred this method will raise a `Resque::NoQueueError`
-  #
-  # This method is considered part of the `stable` API.
-  def enqueue(klass, *args)
-    Job.create(queue_from_class(klass), klass, *args)
-
-    Plugin.after_enqueue_hooks(klass).each do |hook|
-      klass.send(hook, *args)
-    end
-  end
-
-  # This method can be used to conveniently remove a job from a queue.
-  # It assumes the class you're passing it is a real Ruby class (not
-  # a string or reference) which either:
-  #
-  #   a) has a @queue ivar set
-  #   b) responds to `queue`
-  #
-  # If either of those conditions are met, it will use the value obtained
-  # from performing one of the above operations to determine the queue.
-  #
-  # If no queue can be inferred this method will raise a `Resque::NoQueueError`
-  #
-  # If no args are given, this method will dequeue *all* jobs matching
-  # the provided class. See `Resque::Job.destroy` for more
-  # information.
-  #
-  # Returns the number of jobs destroyed.
-  #
-  # Example:
-  #
-  #   # Removes all jobs of class `UpdateNetworkGraph`
-  #   Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph)
-  #
-  #   # Removes all jobs of class `UpdateNetworkGraph` with matching args.
-  #   Resque.dequeue(GitHub::Jobs::UpdateNetworkGraph, 'repo:135325')
-  #
-  # This method is considered part of the `stable` API.
-  def dequeue(klass, *args)
-    Job.destroy(queue_from_class(klass), klass, *args)
-  end
-
-  # Given a class, try to extrapolate an appropriate queue based on a
-  # class instance variable or `queue` method.
-  def queue_from_class(klass)
-    klass.instance_variable_get(:@queue) ||
-      (klass.respond_to?(:queue) and klass.queue)
-  end
-
-  # This method will return a `Resque::Job` object or a non-true value
-  # depending on whether a job can be obtained. You should pass it the
-  # precise name of a queue: case matters.
-  #
-  # This method is considered part of the `stable` API.
-  def reserve(queue)
-    Job.reserve(queue)
-  end
-
-  # Validates if the given klass could be a valid Resque job
-  #
-  # If no queue can be inferred this method will raise a `Resque::NoQueueError`
-  #
-  # If given klass is nil this method will raise a `Resque::NoClassError`
-  def validate(klass, queue = nil)
-    queue ||= queue_from_class(klass)
-
-    if !queue
-      raise NoQueueError.new("Jobs must be placed onto a queue.")
-    end
-
-    if klass.to_s.empty?
-      raise NoClassError.new("Jobs must be given a class.")
-    end
-  end
-
-
-  #
-  # worker shortcuts
-  #
-
-  # A shortcut to Worker.all
-  def workers
-    Worker.all
-  end
-
-  # A shortcut to Worker.working
-  def working
-    Worker.working
-  end
-
-  # A shortcut to unregister_worker
-  # useful for command line tool
-  def remove_worker(worker_id)
-    worker = Resque::Worker.find(worker_id)
-    worker.unregister_worker
-  end
-
+  
   #
   # stats
   #

data/test/rack/rewritten_url_test.rb

@@ -1,7 +1,4 @@
-require 'rewritten'
-require 'rack/mock'
-require 'minitest/autorun'
-require 'pry'
+require 'test_helper'
 
 describe Rack::Rewritten::Url do
 
@@ -15,16 +12,21 @@ describe Rack::Rewritten::Url do
       'rack.url_scheme' => 'http'}.merge(overrides)
   end
 
+  before {
+    Rewritten.add_translation '/foo/bar', '/products/1'
+    Rewritten.add_translation '/foo/baz', '/products/1'
+    Rewritten.add_translation '/foo/with/params', '/products/2?w=1'
+  }
+
   describe "redirection behavior" do
 
     before {
       @app = MiniTest::Mock.new
+      @rack = Rack::Rewritten::Url.new(@app)
 
-      @rack = Rack::Rewritten::Url.new(@app) do
-        add_translation '/foo/bar', '/products/1'
-        add_translation '/foo/baz', '/products/1'
-        add_translation '/foo/with/params', '/products/2?w=1'
-      end
+      Rewritten.add_translation '/foo/bar', '/products/1'
+      Rewritten.add_translation '/foo/baz', '/products/1'
+      Rewritten.add_translation '/foo/with/params', '/products/2?w=1'
     }
 
     it "must not redirect if there are no entries" do
@@ -33,7 +35,7 @@ describe Rack::Rewritten::Url do
       @app.verify
     end
 
-    it "must 301 redirect to latest translation" do
+    it "must 301 redirect from old translation to latest translation" do
       ret = @rack.call( call_args.merge('REQUEST_URI' => '/foo/bar', 'PATH_INFO' => '/foo/bar' ))
       @app.verify
       ret[0].must_equal 301
@@ -47,7 +49,6 @@ describe Rack::Rewritten::Url do
       ret[1]['Location'].must_equal "http://www.example.org/foo/baz?w=1"
     end
 
-
     it "must stay on latest translation" do
       @app.expect :call, [200, {'Content-Type' => 'text/plain'},[""]], [Hash]
       ret = @rack.call( call_args.merge('REQUEST_URI' => '/foo/baz', 'PATH_INFO' => '/foo/baz' ))
@@ -55,9 +56,33 @@ describe Rack::Rewritten::Url do
       ret[0].must_equal 200
     end
 
+    describe "enforce nice urls" do
+
+      it "must not redirect from resource url to nice url by default" do
+        @app.expect :call, [200, {'Content-Type' => 'text/plain'},[""]], [Hash]
+        ret = @rack.call( call_args.merge('REQUEST_URI' => '/products/1', 'PATH_INFO' => '/products/1' ))
+        @app.verify
+        ret[0].must_equal 200
+      end
+
+      it "must redirect from resource url to nice url if enabled xxx" do
+        @rack = Rack::Rewritten::Url.new(@app) do
+          self.translate_backwards = true
+        end
+
+        ret = @rack.call( call_args.merge('REQUEST_URI' => '/products/1', 'PATH_INFO' => '/products/1' ))
+        @app.verify
+        ret[0].must_equal 301
+        ret[1]['Location'].must_equal "http://www.example.org/foo/baz"
+      end
+
+    end
+
+
   end
 
 
+
   describe "the env" do
 
     before {

data/test/rewritten_test.rb

@@ -1,18 +1,15 @@
-require 'rewritten'
-require 'minitest/autorun'
+require 'test_helper'
 
 describe Rewritten do
 
   before{
-    Rewritten.redis = :test
-    Rewritten.clear_translations
     Rewritten.add_translation('/from', '/to')
     Rewritten.add_translation('/from2', '/to')
     Rewritten.add_translation('/from3', '/to2')
   }
 
   it "must give all tos" do
-    Rewritten.all_tos.must_equal ["/to", "/to2"] 
+    Rewritten.all_tos.sort.must_equal ["/to", "/to2"] 
   end
 
   it "must return all translations" do

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rewritten'
+require 'minitest/autorun'
+require 'pry'
+
+class Minitest::Spec 
+
+  before :each do
+    Rewritten.redis = "localhost:6379/test_rewritten"
+    Rewritten.clear_translations
+  end
+
+  after :each do
+    Rewritten.clear_translations
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rewritten
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kai Rubarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -182,6 +182,7 @@ files:
 - rewritten.gemspec
 - test/rack/rewritten_url_test.rb
 - test/rewritten_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses: []
 metadata: {}