liszt 0.0.1 → 0.0.3

data/.gitignore

@@ -2,9 +2,13 @@
 log/*.log
 pkg/
 doc/
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
+test/dummy_2.3/db/*.sqlite3
+test/dummy_2.3/log/*.log
+test/dummy_2.3/tmp/
+test/dummy_3.1/db/*.sqlite3
+test/dummy_3.1/log/*.log
+test/dummy_3.1/tmp/
 .yardoc/
 .rvmrc
 /tags
+/dump.rdb

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 gem 'rails', '3.1.0'
 gem 'sqlite3'
+gem 'shoulda-context'
 
 # Specify your gem's dependencies in has_rank.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    liszt (0.0.1)
+    liszt (0.0.3)
+      rails (>= 2.3.2)
       redis
 
 GEM
@@ -73,9 +74,11 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
-    rake (0.8.7)
+    rake (0.9.2)
+    rdiscount (1.6.8)
     rdoc (3.9.4)
     redis (2.2.2)
+    shoulda-context (1.0.0.beta1)
     sprockets (2.0.0)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -87,6 +90,7 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.29)
+    yard (0.7.2)
 
 PLATFORMS
   ruby
@@ -94,4 +98,7 @@ PLATFORMS
 DEPENDENCIES
   liszt!
   rails (= 3.1.0)
+  rdiscount
+  shoulda-context
   sqlite3
+  yard

data/Gemfile.rails2

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'rails', '2.3.14'
+gem 'sqlite3'
+gem 'shoulda-context'
+
+# Specify your gem's dependencies in has_rank.gemspec
+gemspec

data/Gemfile.rails2.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    liszt (0.0.3)
+      rails (>= 2.3.2)
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.14)
+      actionpack (= 2.3.14)
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activeresource (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    rack (1.1.2)
+    rails (2.3.14)
+      actionmailer (= 2.3.14)
+      actionpack (= 2.3.14)
+      activerecord (= 2.3.14)
+      activeresource (= 2.3.14)
+      activesupport (= 2.3.14)
+      rake (>= 0.8.3)
+    rake (0.9.2)
+    rdiscount (1.6.8)
+    redis (2.2.2)
+    shoulda-context (1.0.0.beta1)
+    sqlite3 (1.3.4)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  liszt!
+  rails (= 2.3.14)
+  rdiscount
+  shoulda-context
+  sqlite3
+  yard

data/Rakefile

@@ -2,6 +2,12 @@
 
 require 'bundler/gem_tasks'
 
+desc "Install gems for Rails 2.3.14 and Rails 3.1.0"
+task :install_bundle do
+  system "bundle install --gemfile Gemfile"
+  system "bundle install --gemfile Gemfile.rails2"
+end
+
 begin
   require 'yard'
   YARD::Rake::YardocTask.new
@@ -17,4 +23,29 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-task :default => :test
+def execute(cmd)
+  Dir.chdir "test/dummy_2.3"
+  system "env RAILS_ENV=test BUNDLE_GEMFILE=../../Gemfile.rails2 bundle exec #{cmd}"
+  Dir.chdir "../dummy_3.1"
+  system "env RAILS_ENV=test BUNDLE_GEMFILE=../../Gemfile bundle exec #{cmd}"
+  Dir.chdir "../.."
+end
+
+desc "Create and migrate the test databases for Rails 2.3.14 and Rails 3.1.0"
+task :set_up_test_dbs do
+  execute "rake db:create"
+  execute "rake db:migrate"
+end
+
+desc "Open console in Rails 2.3.14 app"
+task :console_rails_2 do
+  Dir.chdir("test/dummy_2.3")
+  system("env RAILS_ENV=test BUNDLE_GEMFILE=../../Gemfile.rails2 bundle exec script/console")
+end
+
+desc "Run tests on Rails 2.3.14"
+task :test_rails_2 do
+  system("env BUNDLE_GEMFILE=Gemfile.rails2 bundle exec rake test")
+end
+
+task :default => [:test, :test_rails_2]

data/lib/liszt/{list.rb → redis_list.rb}

@@ -1,15 +1,20 @@
 module Liszt
-  class List
+  class RedisList
     # @param [String] key The Redis key associated with this list.
     def initialize(key)
       @key = key
     end
 
+    # Completely delete the list from Redis, leaving no marker.
+    def uninitialize
+      redis.del(@key)
+    end
+
     # Remove existing list items and repopulate the list with the given ids
     # (in the given order).
     # @param [Array<Fixnum>] ids
     # @return [Array<Fixnum>]
-    def clear_and_populate!(ids, &block)
+    def clear_and_populate!(ids)
       redis.multi do
         clear
         # reverse and unshift to avoid touching the marker
@@ -21,7 +26,7 @@ module Liszt
     # Has the list been initialized?
     # @return [Boolean]
     def initialized?
-      !length.nil?
+      redis.exists(@key)
     end
 
     # Does the list currently include this id?
@@ -181,17 +186,17 @@ module Liszt
       def with_lock
         start_time = Time.now
         until get_lock
-          sleep 0.25
-          raise "Timed out!" if (Time.now - start_time) > 2.0
+          sleep 0.2
+          raise "Timed out!" if (Time.now - start_time) > 10
         end
         yield
       ensure
         release_lock
       end
 
-      def get_lock
+      def get_lock(timeout=lock_expiration_time)
         if redis.setnx(lock_key, true)
-          redis.expire(lock_key, lock_expiration_time)
+          redis.expire(lock_key, timeout)
           true
         else
           false

data/lib/liszt/version.rb

@@ -1,3 +1,3 @@
 module Liszt
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/liszt.rb

@@ -1,6 +1,6 @@
 require "liszt/version"
 require "liszt/instantizeable"
-require "liszt/list"
+require "liszt/redis_list"
 
 module Liszt
   mattr_accessor :redis
@@ -11,10 +11,17 @@ module Liszt
   # currently support re-sorting lists when a scope changes. The assumption is
   # that attributes used as scopes won't change after creation.
   #
+  # The other major limitation at the moment is that scopes can't be <tt>nil</tt>.
+  # If a record has nil for a scope value, its associated list will never have
+  # any items in it.
+  #
   # @param [Hash] options
   # @option options [Symbol, Array] :scope The attribute or attributes to use
   #   as list constraints.
   # @option options [Hash] :conditions Any extra constraints to impose.
+  # @option options [Proc] :sort_by A lambda to pass into initialize_list! the first
+  #   time an item is added to an uninitialized list. It has the same semantics as
+  #   <tt>Enumerable#sort_by</tt>.
   def acts_as_liszt(options = {})
     extend Instantizeable
     extend ClassMethods
@@ -28,8 +35,9 @@ module Liszt
     options.reverse_merge! :conditions => {}, :scope => []
 
     @liszt_conditions = options[:conditions]
-    @liszt_scope = Array(options[:scope]).sort
+    @liszt_scope = Array(options[:scope]).sort_by(&:to_s)
     @liszt_query = nil
+    @liszt_sort_by = options[:sort_by]
   end
 
   module ClassMethods
@@ -42,7 +50,11 @@ module Liszt
       ids = if block_given?
               objects.sort_by(&block).map(&:id)
             else
-              objects.map(&:id).sort.reverse
+              if @liszt_sort_by
+                objects.sort_by(&@liszt_sort_by).map(&:id)
+              else
+                objects.map(&:id).sort.reverse
+              end
             end
 
       ordered_list(obj).clear_and_populate!(ids)
@@ -50,7 +62,7 @@ module Liszt
     end
 
     def ordered_list(obj={})
-      Liszt::List.new(liszt_key(obj))
+      Liszt::RedisList.new(liszt_key(obj))
     end
 
     def ordered_list_initialized?(obj={})
@@ -69,8 +81,8 @@ module Liszt
       if double_check
         objs = find(:all, :conditions => liszt_query(obj))
         real_ids = objs.map(&:id)
-        if real_ids != ids
-          unlisted_ids = real_ids - ids
+        unlisted_ids = real_ids - ids
+        if unlisted_ids.count > 0
           ids = ordered_list(obj).clear_and_populate!(unlisted_ids + ids)
         end
       else
@@ -135,8 +147,16 @@ module Liszt
     end
 
     def add_to_list
-      if meets_list_conditions?
-        ordered_list.unshift(self)
+      if ordered_list_initialized?
+        if meets_list_conditions?
+          ordered_list.unshift(self.id)
+        end
+      else
+        if @liszt_sort_by
+          initialize_list!(&@liszt_sort_by)
+        else
+          initialize_list!
+        end
       end
       true
     end

data/test/dummy_2.3/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/dummy_2.3/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/test/dummy_2.3/app/models/group.rb

@@ -0,0 +1,2 @@
+class Group < ActiveRecord::Base
+end

data/test/dummy_2.3/app/models/person.rb

@@ -0,0 +1,3 @@
+class Person < ActiveRecord::Base
+  acts_as_liszt :scope => [:group_id, :is_male]
+end

data/test/dummy_2.3/config/boot.rb

@@ -0,0 +1,114 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      if load_error.message =~ /Could not find RubyGem rails/
+        STDERR.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+        exit 1
+      else
+        raise
+      end
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/dummy_2.3/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy_2.3/config/environment.rb

@@ -0,0 +1,43 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.14' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.autoload_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end
+
+Liszt.redis = Redis.new(:host => "localhost", :port => "10001")

data/test/dummy_2.3/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/test/dummy_2.3/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/test/dummy_2.3/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying do debug a problem that might steem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy_2.3/config/initializers/bundler.rb

@@ -0,0 +1,4 @@
+Bundler.require
+require 'redis'
+require 'liszt'
+require 'shoulda-context'

data/test/dummy_2.3/config/initializers/cookie_verification_secret.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.cookie_verifier_secret = 'e1e07ce996758305fbf99d89d2319082ab582c3e0b4f070d79533a43b1e09abf8ad8f18c809e565d0ade3186fa030b412d77f92bd49a6736a52cbbcba5a0358a';

data/test/dummy_2.3/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/dummy_2.3/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,21 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+ActionController::Routing.generate_best_match = false
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/test/dummy_2.3/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_dummy_2.3_session',
+  :secret      => '619392db010b8f2f53e05d969fddcf8fc241a5a6b16d084982f46c4c26d671ad3693435cef5272083db46d2c5ff962964ff643d14c3548bc2cb4086720c3b145'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/test/dummy_2.3/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"