dm_preferences 0.5.6 → 1.0

data/Rakefile

@@ -1,36 +1,29 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run all tests.'
-task :default => :test
-
-desc "Test preferences."
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.test_files = Dir['test/**/*_test.rb']
-  t.verbose = true
-end
-
 begin
-  require 'rcov/rcovtask'
-  namespace :test do
-    desc "Test preferences with Rcov."
-    Rcov::RcovTask.new(:rcov) do |t|
-      t.libs << 'lib'
-      t.test_files = Dir['test/**/*_test.rb']
-      t.rcov_opts << '--exclude="^(?!lib/|app/)"'
-      t.verbose = true
-    end
-  end
+  require 'bundler/setup'
 rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run specs for Preferences"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec
+
+require 'rdoc/task'
 desc "Generate documentation for preferences."
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'preferences'
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main=README.rdoc'
-  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb', 'app/**/*.rb')
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main=README.md'
+  rdoc.rdoc_files.include('README.md', 'CHANGELOG.md', 'LICENSE', 'lib/**/*.rb', 'app/**/*.rb')
 end

data/dm_preferences.gemspec

@@ -9,13 +9,15 @@ Gem::Specification.new do |s|
   s.description       = "Adds support for easily creating custom preferences for ActiveRecord models"
   s.summary           = "Custom preferences for ActiveRecord models"
   s.homepage          = 'https://github.com/digitalmoksha/preferences'
+  s.licenses          = ['MIT']
 
   s.require_paths     = ["lib"]
   s.files             = `git ls-files`.split("\n")
-  s.test_files        = `git ls-files -- test/*`.split("\n")
+  s.test_files        = Dir["spec/**/*"]
   s.rdoc_options      = %w(--line-numbers --inline-source --title preferences --main README.rdoc)
-  s.extra_rdoc_files  = %w(README.rdoc CHANGELOG.rdoc LICENSE)
+  s.extra_rdoc_files  = %w(README.md CHANGELOG.md LICENSE)
   
-  s.add_development_dependency("rake")
-  s.add_development_dependency("plugin_test_helper", ">= 0.3.2")
-end
+  s.add_development_dependency "rails", "~> 4.2"
+  s.add_development_dependency "sqlite3", '~> 0'
+  s.add_development_dependency 'rspec-rails', '~> 3.0'
+ end

data/lib/generators/{templates → preferences/templates}/create_preferences.rb

@@ -1,5 +1,5 @@
 class CreatePreferences < ActiveRecord::Migration
-  def change
+  def up
     create_table :preferences do |t|
       t.string :name, :null => false
       t.references :owner, :polymorphic => true, :null => false
@@ -9,4 +9,8 @@ class CreatePreferences < ActiveRecord::Migration
     end
     add_index :preferences, [:owner_id, :owner_type, :name, :group_id, :group_type], :unique => true, :name => 'index_preferences_on_owner_and_name_and_preference'
   end
+
+  def down
+    drop_table :preferences
+  end
 end

data/lib/preferences.rb

@@ -46,6 +46,7 @@ require 'preferences/preference_definition'
 #   u.valid?                        # => true
 module Preferences
   module MacroMethods
+
     # Defines a new preference for all records in the model.  By default,
     # preferences are assumed to have a boolean data type, so all values will
     # be typecasted to true/false based on ActiveRecord rules.
@@ -156,7 +157,7 @@ module Preferences
         class_attribute :preference_definitions
         self.preference_definitions = {}
 
-        has_many :stored_preferences, :as => :owner, :class_name => 'Preference', :dependent => :destroy
+        has_many :stored_preferences, :as => :owner, :class_name => 'Preference', :dependent => :delete_all
 
         after_save :update_preferences
 
@@ -259,12 +260,13 @@ module Preferences
 
         # Since each preference is a different record, they need their own
         # join so that the proper conditions can be set
-        joins << "LEFT JOIN preferences AS #{table} ON #{table}.owner_id = #{table_name}.#{primary_key} AND " + sanitize_sql(
-          "#{table}.owner_type" => base_class.name.to_s,
-          "#{table}.group_id" => group_id,
-          "#{table}.group_type" => group_type,
-          "#{table}.name" => preference
-        )
+        joins << "LEFT JOIN preferences AS #{table} ON #{table}.owner_id = #{table_name}.#{primary_key} AND " + 
+          sanitize_sql_hash_for_conditions(
+            "#{table}.owner_type" => base_class.name.to_s,
+            "#{table}.group_id" => group_id,
+            "#{table}.group_type" => group_type,
+            "#{table}.name" => preference
+          )
 
         if inverse
           statements << "#{table}.id IS NOT NULL AND #{table}.value " + (value.nil? ? ' IS NOT NULL' : ' != ?') + (!is_default ? " OR #{table}.id IS NULL" : '')
@@ -275,8 +277,22 @@ module Preferences
       end
 
       sql = statements.map! {|statement| "(#{statement})"} * ' AND '
-      self.joins(joins).where(values.unshift(sql))
+      joins(joins).where(values.unshift(sql))
+    end
+
+    # this function is deprecated in 4.2 and to be removed in 5.0.
+    # but it's useful, particularly how it can handle conditions that are nil.
+    # so keep it for now.
+    def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
+      attrs = ActiveRecord::PredicateBuilder.resolve_column_aliases self, attrs
+      attrs = expand_hash_conditions_for_aggregates(attrs)
+
+      table = Arel::Table.new(table_name, arel_engine).alias(default_table_name)
+      ActiveRecord::PredicateBuilder.build_from_hash(self, attrs, table).map { |b|
+        connection.visitor.compile b
+      }.join(' AND ')
     end
+
   end
 
   module InstanceMethods
@@ -498,6 +514,7 @@ module Preferences
     end
 
     private
+
       # Asserts that the given name is a valid preference in this model.  If it
       # is not, then an ArgumentError exception is raised.
       def assert_valid_preference(name)
@@ -606,13 +623,19 @@ module Preferences
       def find_preferences(attributes)
         if stored_preferences.loaded?
           stored_preferences.select do |preference|
-            attributes.all? {|attribute, value| preference[attribute] == value}
+            attributes.all? do |attribute, value|
+              if value.is_a?(Array)
+                value.include?(preference[attribute])
+              else
+                preference[attribute] == value
+              end
+            end
           end
         else
           stored_preferences.where(attributes)
         end
       end
-      
+
       # Was removed from Rails 4, so inlne it here
       def convert_number_column_value(value)
         case value

data/lib/preferences/engine.rb

@@ -1,4 +1,5 @@
 module Preferences
-  class Engine < Rails::Engine
+  class Engine < ::Rails::Engine
+    config.preferences = Preferences
   end
 end

data/lib/preferences/preference_definition.rb

@@ -10,9 +10,18 @@ module Preferences
       
       @type = args.first ? args.first.to_sym : :boolean
       
+      case @type
+      when :any
+        @klass = "ActiveRecord::Type::Value".constantize.new
+      when :datetime
+        @klass = "ActiveRecord::Type::DateTime".constantize.new
+      else
+        @klass = "ActiveRecord::Type::#{@type.to_s.classify}".constantize.new
+      end
+
       # Create a column that will be responsible for typecasting
-      @column = ActiveRecord::ConnectionAdapters::Column.new(name.to_s, options[:default], @type == :any ? nil : @type.to_s)
-      
+      @column = ActiveRecord::ConnectionAdapters::Column.new(name.to_s, options[:default], @klass)
+
       @group_defaults = (options[:group_defaults] || {}).inject({}) do |defaults, (group, default)|
         defaults[group.is_a?(Symbol) ? group.to_s : group] = type_cast(default)
         defaults
@@ -27,7 +36,7 @@ module Preferences
     # The default value to use for the preference in case none have been
     # previously defined
     def default_value(group = nil)
-      @group_defaults.include?(group) ? @group_defaults[group] : @column.default
+      @group_defaults.include?(group) ? @group_defaults[group] : type_cast(@column.default)
     end
     
     # Determines whether column backing this preference stores numberic values
@@ -39,7 +48,9 @@ module Preferences
     # This uses ActiveRecord's typecast functionality so the same rules for
     # typecasting a model's columns apply here.
     def type_cast(value)
-      @type == :any ? value : @column.type_cast(value)
+      return 1 if @type == :integer && value == true
+      return 0 if @type == :integer && value == false
+      @type == :any ? value : @column.type_cast_from_database(value)
     end
     
     # Typecasts the value to true/false depending on the type of preference

data/lib/preferences/version.rb

@@ -1,3 +1,3 @@
 module Preferences
-  VERSION = '0.5.6'
+  VERSION = '1.0'
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "preferences"
+
+module Dummy
+  class Application < Rails::Application
+    # 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.
+
+    # 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. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # 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}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# 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:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.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 web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end