sequel 4.27.0 → 4.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e0006e87c72a9cee83298b0fab32a7ccea74ef
-  data.tar.gz: 46a222bb7aa35ce30d2a931c56c0cc49d8fd1b3a
+  metadata.gz: 4342ce776d6f7e929b8ef1e9621f79f4544357b4
+  data.tar.gz: 64ed417591b155d46f3ca0abdbe38f515ea9e15f
 SHA512:
-  metadata.gz: db00224bfcada026d014fbe777cee84849e8786a33519258197a371e9f48970c8a37a1e45e05462f90e0c9e89fb638dcfd1c5442855f1d6b02e7a79b2a21901d
-  data.tar.gz: 79bbb7ad3a536b02bd7242c2fd2b6f08b2772a5b44ba5acdca66224fe93c009e093861ec9e61b877b8349d77ae3d2c5350edcae41cfd6f10827984be0e77ffde
+  metadata.gz: 2e672203108c7301da9abcaf7596368a1aa09b8302175bb6f49d9bc189993a84e7089343e16fcdb69b9409d3677746694b36e7cbb25d1c179779ab605cd63343
+  data.tar.gz: 198aa8d381bd263e27bb03b646f0fa50d45225b5370084236d6da55eb1f6032396c6548f114c8ccf0d187091ab2a195c5d298e62e5a185bf992ce4fb06615d15

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 4.28.0 (2015-11-02)
+
+* Add boolean_subsets plugin, which adds a subset for each boolean column (jeremyevans)
+
+* Add subset_conditions plugin, which adds a method for each subset returning the filter conditions for the subset (jeremyevans)
+
+* Make the list plugin work better with the auto_validations plugin when there is a validation on the position column (jeremyevans)
+
+* Make to_csv for model datasets call instance methods, just like Model#to_csv, in the csv_serializer plugin (skrobul) (#1088)
+
+* Raise Sequel::NoExistingObject instead of generic error if Model#refresh can't find the related row (jeremyevans)
+
 === 4.27.0 (2015-10-01)
 
 * Don't stub Sequel.synchronize on MRI (YorickPeterse) (#1083)

data/doc/release_notes/4.28.0.txt

@@ -0,0 +1,57 @@
+= New Features
+
+* A subset_conditions plugin has been added, which adds a method
+  for each subset that returns the filter conditions for the
+  subset.  This makes it easier to reuse the subset conditions:
+
+    class Foo < Sequel::Model
+      plugin :subset_conditions
+      subset :active, :active=>true
+    end
+
+    Foo.exclude(Foo.active_conditions)
+    Foo.where(:a=>1).or(Foo.active_conditions)
+
+* A boolean_subsets plugin has been added, which adds a subset for each
+  boolean column:
+
+    # Assume boolean column :active
+    Foo.plugin :boolean_subsets
+
+    Foo.active
+    # SELECT * FROM foos WHERE (active IS TRUE)
+
+  You can provide a block to the plugin to change the arguments passed
+  to subset:
+    
+    Foo.plugin :boolean_subsets do |column|
+      [:"where_#{column}", column]
+    end
+
+    Foo.where_active
+    # SELECT * FROM foos WHERE active
+
+  As with similar plugins, you can add the boolean_subsets plugin to
+  Sequel::Model itself, and all subclasses created afterward will have
+  the boolean subset methods automatically created.
+
+= Other Improvements
+
+* If Model#refresh can't find the related row, Sequel now raises a
+  Sequel::NoExistingObject exception instead of a generic
+  Sequel::Error exception.
+
+* In the csv_serializer plugin, when calling #to_csv on a model class
+  or dataset, instead of using #[] to access data, #send is used to
+  call methods.  This is more similar to other plugins as well as
+  Model#to_csv.
+
+* The list plugin now works better with the auto_validations plugin,
+  or any other time there is a validation on the position column.
+
+= Backwards Compatibility
+
+* The change to the csv_serializer plugin can change results if you
+  are overriding any of the column accessor methods.  It can also
+  break existing code if one of the columns being used isn't defined
+  as a method or the method requires more than one argument.

data/doc/transactions.rdoc

@@ -6,7 +6,10 @@ Sequel uses autocommit mode by default for all of its database adapters, so in g
 * Model#save
 * Model#destroy
 * Migrations if the database supports transactional schema
-* A few model plugins
+* Database#use_cursor in the postgres adapter
+* Dataset#lock on PostgreSQL if given a block
+* setter methods created by the association_pks plugin
+* move* methods in the list plugin
 
 Everywhere else, it is up to you to use a database transaction if you want to.
 

data/doc/validations.rdoc

@@ -1,6 +1,6 @@
 = Model Validations
 
-This guide is based on http://guides.rubyonrails.org/activerecord_validations_callbacks.html
+This guide is based on http://guides.rubyonrails.org/active_record_validations.html
 
 == Overview
 

data/lib/sequel/adapters/postgres.rb

@@ -674,9 +674,11 @@ module Sequel
       end
 
       # Uses a cursor for fetching records, instead of fetching the entire result
-      # set at once.  Can be used to process large datasets without holding
-      # all rows in memory (which is what the underlying drivers may do
-      # by default). Options:
+      # set at once.  Note this uses a transaction around the cursor usage by
+      # default and can be changed using `hold: true` as described below.
+      # Cursors can be used to process large datasets without holding all rows
+      # in memory (which is what the underlying drivers may do by default).
+      # Options:
       #
       # :cursor_name :: The name assigned to the cursor (default 'sequel_cursor').
       #                 Nested cursors require different names.

data/lib/sequel/model/base.rb

@@ -1867,7 +1867,7 @@ module Sequel
       # Refresh using a particular dataset, used inside save to make sure the same server
       # is used for reading newly inserted values from the database
       def _refresh(dataset)
-        _refresh_set_values(_refresh_get(dataset) || raise(Error, "Record not found"))
+        _refresh_set_values(_refresh_get(dataset) || raise(NoExistingObject, "Record not found"))
         changed_columns.clear
       end
 
@@ -1939,7 +1939,7 @@ module Sequel
       # default values of all columns.  Separated from _save so it
       # can be overridden to avoid the refresh.
       def _save_refresh
-        _save_set_values(_refresh_get(this.server?(:default)) || raise(Error, "Record not found"))
+        _save_set_values(_refresh_get(this.server?(:default)) || raise(NoExistingObject, "Record not found"))
         changed_columns.clear
       end
 

data/lib/sequel/plugins/boolean_subsets.rb

@@ -0,0 +1,56 @@
+module Sequel
+  module Plugins
+    # The boolean_subsets plugin allows for the automatic creation of subsets for
+    # for boolean columns, which can DRY up model classes that define such subsets
+    # manually.  By default, subsets are created for all columns of type :boolean,
+    # with the subset name being the same as column name, and the conditions being
+    # <tt>column IS TRUE</tt> (assuming the database supports that syntax).
+    #
+    # You can provide a block to the plugin, which will be called with column name
+    # symbol, and should return an array of arguments to pass to +subset+.
+    # Using this, you can change the method name and arguments for each column.
+    # This block is executed in the context of the model class.
+    #
+    # Usage:
+    #
+    #   # Add boolean subset methods for all columns of type :boolean
+    #   # in all model subclasses (called before loading subclasses)
+    #   Sequel::Model.plugin :boolean_subsets
+    #
+    #   # Add subsets for all boolean columns in the Album class
+    #   Album.plugin(:boolean_subsets)
+    #
+    #   # Remove is_ from the front of the column name when creating the subset
+    #   # method name, and use (column = 'Y') as the filter conditions
+    #   Sequel::Model.plugin :boolean_subsets do |column|
+    #     [column.to_s.sub(/\Ais_/, ''), {column=>'Y'}]
+    #   end
+    module BooleanSubsets
+      # Add the boolean_attribute? class method to the model, and create
+      # attribute? boolean reader methods for the class's columns if the class has a dataset.
+      def self.configure(model, &block)
+        model.instance_eval do
+          (class << self; self; end).send(:define_method, :boolean_subset_args, &block) if block
+          send(:create_boolean_subsets) if @dataset
+        end
+      end
+
+      module ClassMethods
+        Plugins.after_set_dataset(self, :create_boolean_subsets)
+
+        private
+
+        # The arguments to use when automatically defining a boolean subset for the given column.
+        def boolean_subset_args(c)
+          [c, {c=>true}]
+        end
+
+        # Add subset methods for all of the boolean columns in this model.
+        def create_boolean_subsets
+          cs = columns rescue return
+          cs.each{|c| subset(*boolean_subset_args(c)) if db_schema[c][:type] == :boolean}
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/csv_serializer.rb

@@ -163,7 +163,7 @@ module Sequel
 
           CSV.generate(opts) do |csv|
             items.each do |object|
-              csv << opts[:headers].map{|header| object[header]}
+              csv << opts[:headers].map{|header| object.send(header) }
             end
           end
         end

data/lib/sequel/plugins/list.rb

@@ -87,15 +87,6 @@ module Sequel
           list_dataset.first(position_field => p)
         end
 
-        # Set the value of the position_field to the maximum value plus 1 unless the
-        # position field already has a value.
-        def before_create
-          unless get_column_value(position_field)
-            set_column_value("#{position_field}=", list_dataset.max(position_field).to_i+1)
-          end
-          super
-        end
-
         # When destroying an instance, move all entries after the instance down
         # one position, so that there aren't any gaps
         def after_destroy
@@ -179,6 +170,15 @@ module Sequel
 
         private
 
+        # Set the value of the position_field to the maximum value plus 1 unless the
+        # position field already has a value.
+        def _before_validation
+          unless get_column_value(position_field)
+            set_column_value("#{position_field}=", list_dataset.max(position_field).to_i+1)
+          end
+          super
+        end
+
         # The model's position field, an instance method for ease of use.
         def position_field
           model.position_field

data/lib/sequel/plugins/subset_conditions.rb

@@ -0,0 +1,36 @@
+module Sequel
+  module Plugins
+    # The subset_conditions plugin creates an additional *_conditions method
+    # for every subset created, which returns the filter conditions the subset
+    # uses.  This can be useful if you want to use the conditions for a separate
+    # filter or combine them with OR.
+    #
+    # Usage:
+    #
+    #   # Add subset_conditions in the Album class
+    #   Album.plugin :subset_conditions
+    #
+    #   # This will now create a published_conditions method
+    #   Album.subset :published, :published => true
+    #
+    #   Album.where(Album.published_conditions).sql
+    #   # SELECT * FROM albums WHERE (published IS TRUE)
+    #
+    #   Album.exclude(Album.published_conditions).sql
+    #   # SELECT * FROM albums WHERE (published IS NOT TRUE)
+    #
+    #   Album.where(Sequel.|(Album.published_conditions, :ready=>true)).sql
+    #   # SELECT * FROM albums WHERE ((published IS TRUE) OR (ready IS TRUE))
+    module SubsetConditions
+      module ClassMethods
+        # Also create a method that returns the conditions the filter uses.
+        def subset(name, *args, &block)
+          super
+          cond = args
+          cond = cond.first if cond.size == 1
+          def_dataset_method(:"#{name}_conditions"){filter_expr(cond, &block)}
+        end
+      end
+    end
+  end
+end

data/lib/sequel/version.rb

@@ -3,7 +3,7 @@ module Sequel
   MAJOR = 4
   # The minor version of Sequel.  Bumped for every non-patch level
   # release, generally around once a month.
-  MINOR = 27
+  MINOR = 28
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.
   TINY  = 0

data/spec/extensions/boolean_subsets_spec.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "spec_helper")
+
+describe "boolean_subsets plugin" do
+  before do
+    @db = Sequel::Database.new
+    def @db.supports_schema_parsing?() true end
+    def @db.schema(*args)
+      [[:asdaf9898as, {}], [:active, {:type=>:boolean}]]
+    end
+
+    @c = Class.new(Sequel::Model(@db[:items]))
+    @p = proc do
+      @columns = [:asdaf9898as, :active]
+      def columns; @columns; end
+    end
+    @c.instance_eval(&@p)
+  end 
+
+  it "should create subsets only for boolean attributes" do
+    @c.plugin(:boolean_subsets)
+    @c.active.sql.must_equal "SELECT * FROM items WHERE (active IS TRUE)"
+    @c.respond_to?(:asdaf9898as).must_equal false
+  end
+
+  it "should handle a block passed to the plugin" do
+    @c.plugin(:boolean_subsets){|c| ["where_#{c}", c]}
+    @c.where_active.sql.must_equal "SELECT * FROM items WHERE active"
+    @c.respond_to?(:active).must_equal false
+  end
+
+  it "should create boolean subsets when set_dataset is called" do
+    c = Class.new(Sequel::Model(@db))
+    c.instance_eval(&@p)
+    c.plugin(:boolean_subsets)
+    c.respond_to?(:active).must_equal false
+
+    c.set_dataset(@db[:items])
+    c.active.sql.must_equal "SELECT * FROM items WHERE (active IS TRUE)"
+    c.respond_to?(:asdaf9898as).must_equal false
+  end
+
+  it "should handle cases where getting the columns raises an error" do
+    @c.meta_def(:columns){raise Sequel::Error}
+    @c.plugin(:boolean_subsets)
+    @c.respond_to?(:active).must_equal false
+  end
+end

data/spec/extensions/list_spec.rb

@@ -264,4 +264,15 @@ describe "List plugin" do
     @o.prev(-1).must_equal @c.load(:id=>9, :position=>4)
     @db.sqls.must_equal ["SELECT * FROM items WHERE (position = 4) ORDER BY position LIMIT 1"]
   end
+
+  it "should work correctly with validation on position" do
+    @c.class_eval do
+      def validate
+        super
+        errors.add(:position, "not set") unless position
+      end
+    end
+    @c.create
+    @db.sqls.must_equal ["SELECT max(position) AS max FROM items LIMIT 1", "INSERT INTO items (position) VALUES (2)", "SELECT * FROM items WHERE (id = 10) ORDER BY position LIMIT 1"]
+  end
 end

data/spec/extensions/subset_conditions_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper')
+
+describe "subset_conditions plugin" do
+  before do
+    @c = Class.new(Sequel::Model(:a))
+    @c.plugin :subset_conditions
+  end
+
+  it "should provide *_conditions method return the arguments passed" do
+    @c.subset(:published, :published => true)
+    @c.where(@c.published_conditions).sql.must_equal @c.published.sql
+
+    @c.subset(:active, :active)
+    @c.where(@c.active_conditions).sql.must_equal @c.active.sql
+
+    @c.subset(:active_published, :active, :published => true)
+    @c.where(@c.active_published_conditions).sql.must_equal @c.active_published.sql
+    @c.where(Sequel.&(@c.active_conditions, @c.published_conditions)).sql.must_equal @c.active_published.sql
+    @c.where(Sequel.|(@c.active_conditions, @c.published_conditions)).sql.must_equal "SELECT * FROM a WHERE (active OR (published IS TRUE))"
+    @c.where(Sequel.|(@c.active_published_conditions, :foo)).sql.must_equal "SELECT * FROM a WHERE ((active AND (published IS TRUE)) OR foo)"
+  end
+
+  it "should work with blocks" do
+    p1 = proc{{:published=>true}}
+    @c.subset(:published, &p1)
+    @c.where(@c.published_conditions).sql.must_equal @c.published.sql
+
+    p2 = proc{:active}
+    @c.subset(:active, &p2)
+    @c.where(@c.active_conditions).sql.must_equal @c.active.sql
+
+    @c.subset(:active_published, p2, &p1)
+    @c.where(@c.active_published_conditions).sql.must_equal @c.active_published.sql
+    @c.where(Sequel.&(@c.active_conditions, @c.published_conditions)).sql.must_equal @c.active_published.sql
+    @c.where(Sequel.|(@c.active_conditions, @c.published_conditions)).sql.must_equal "SELECT * FROM a WHERE (active OR (published IS TRUE))"
+    @c.where(Sequel.|(@c.active_published_conditions, :foo)).sql.must_equal "SELECT * FROM a WHERE ((active AND (published IS TRUE)) OR foo)"
+  end
+end

data/spec/model/record_spec.rb

@@ -67,6 +67,12 @@ describe "Model#save" do
     DB.sqls.must_equal ["INSERT INTO items (x) VALUES (1)", "SELECT * FROM items WHERE (id = 13) LIMIT 1"]
   end
 
+  it "should raise if the object can't be refreshed after save" do
+    o = @c.new(:x => 1)
+    @c.instance_dataset._fetch =@c.dataset._fetch = []
+    proc{o.save}.must_raise(Sequel::NoExistingObject)
+  end
+
   it "should use dataset's insert_select method if present" do
     ds = @c.instance_dataset
     ds._fetch = {:y=>2}
@@ -1738,7 +1744,7 @@ describe Sequel::Model, "#refresh" do
   it "should raise if the instance is not found" do
     @m = @c.new(:id => 555)
     @c.instance_dataset._fetch =@c.dataset._fetch = []
-    proc {@m.refresh}.must_raise(Sequel::Error)
+    proc {@m.refresh}.must_raise(Sequel::NoExistingObject)
     DB.sqls.must_equal ["SELECT * FROM items WHERE (id = 555) LIMIT 1"]
   end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 4.27.0
+  version: 4.28.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -228,6 +228,7 @@ extra_rdoc_files:
 - doc/release_notes/4.25.0.txt
 - doc/release_notes/4.26.0.txt
 - doc/release_notes/4.27.0.txt
+- doc/release_notes/4.28.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -343,6 +344,7 @@ files:
 - doc/release_notes/4.25.0.txt
 - doc/release_notes/4.26.0.txt
 - doc/release_notes/4.27.0.txt
+- doc/release_notes/4.28.0.txt
 - doc/release_notes/4.3.0.txt
 - doc/release_notes/4.4.0.txt
 - doc/release_notes/4.5.0.txt
@@ -535,6 +537,7 @@ files:
 - lib/sequel/plugins/before_after_save.rb
 - lib/sequel/plugins/blacklist_security.rb
 - lib/sequel/plugins/boolean_readers.rb
+- lib/sequel/plugins/boolean_subsets.rb
 - lib/sequel/plugins/caching.rb
 - lib/sequel/plugins/class_table_inheritance.rb
 - lib/sequel/plugins/column_conflicts.rb
@@ -584,6 +587,7 @@ files:
 - lib/sequel/plugins/static_cache.rb
 - lib/sequel/plugins/string_stripper.rb
 - lib/sequel/plugins/subclasses.rb
+- lib/sequel/plugins/subset_conditions.rb
 - lib/sequel/plugins/table_select.rb
 - lib/sequel/plugins/tactical_eager_loading.rb
 - lib/sequel/plugins/timestamps.rb
@@ -637,6 +641,7 @@ files:
 - spec/extensions/blacklist_security_spec.rb
 - spec/extensions/blank_spec.rb
 - spec/extensions/boolean_readers_spec.rb
+- spec/extensions/boolean_subsets_spec.rb
 - spec/extensions/caching_spec.rb
 - spec/extensions/class_table_inheritance_spec.rb
 - spec/extensions/column_conflicts_spec.rb
@@ -737,6 +742,7 @@ files:
 - spec/extensions/string_date_time_spec.rb
 - spec/extensions/string_stripper_spec.rb
 - spec/extensions/subclasses_spec.rb
+- spec/extensions/subset_conditions_spec.rb
 - spec/extensions/table_select_spec.rb
 - spec/extensions/tactical_eager_loading_spec.rb
 - spec/extensions/thread_local_timezones_spec.rb
@@ -858,4 +864,3 @@ signing_key:
 specification_version: 4
 summary: The Database Toolkit for Ruby
 test_files: []
-has_rdoc: true