bitfields 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc824cf59452e64b1e34422e7416920dd725ea7d
-  data.tar.gz: 78a184dd4eda1d311ef1246f089babc00711a22b
+  metadata.gz: cf9f6971a5470e30369fcfa61814a7533ac62b89
+  data.tar.gz: 559897cbd82a915ae89b0a462da4e40d8f8d9a3a
 SHA512:
-  metadata.gz: 1e3d053623af2a5c60eb9d1818849d72b9e1d66801d2c9bb07fa12a63462770614f3a87e7b802470ca5cfd7609a0aab167d5fa2b3032c2477bdc7c48c86653ae
-  data.tar.gz: c45ced97d18462bf25ddfa2b4221b26e69ea1b75f293c6b200c457a415697c144f14d0c00e72dd781a24214f5e3b7e16236397103a8329a482a6a75eb4219726
+  metadata.gz: dd96cded51293734f1dc013966f26a42d90710efb082f628076728e96425a31011c6cfd8a964d9cb0aa7bdc7f63d2669e6655eb96a37423fddf978aaa35027fc
+  data.tar.gz: b68f9ec05b94f11ead65c5690a19f72199dc50b0d3434e82d3a202c9c22a9a5f7793a195310c28123b334f87c4fc6213643ac1fb196dd188e61d114ee03d695d

data/Readme.md

@@ -17,7 +17,7 @@ user.my_bits # => 3
    - Individual added methods (i.e, `seller_was`, `seller_changed?`, etc..) can be deactivated with `bitfield ..., added_instance_methods: false`
    - **Note**: ActiveRecord 5.2 changes the behavior of `_was` and `_changed?` methods when used in the context of an `after_save` callback.
      - ActiveRecord 5.1 will use the use the values that were _just_ changed.
-     - ActiveRecord 5.2, however, will return `nil` for `_was` and `false` for `_changed?` since the previous changes have been persisted.
+     - ActiveRecord 5.2, however, will return the current value for `_was` and `false` for `_changed?` since the previous changes have been persisted.
  - adds scopes `User.seller.sensible.first` (deactivate with `bitfield ..., scopes: false`)
  - builds sql `User.bitfield_sql(insane: true, sensible: false) # => '(users.my_bits & 6) = 1'`
  - builds sql with OR condition `User.bitfield_sql({ insane: true, sensible: true }, query_mode: :bit_operator_or) # => '(users.my_bits & 2) = 2 OR (users.bits & 4) = 4'`
@@ -25,18 +25,6 @@ user.my_bits # => 3
  - builds update sql `User.set_bitfield_sql(insane: true, sensible: false) == 'my_bits = (my_bits | 6) - 4'`
  - **faster sql than any other bitfield lib** through combination of multiple bits into a single sql statement
  - gives access to bits `User.bitfields[:my_bits][:sensible] # => 4`
- - [`ActiveRecord::AttributeMethods::Dirty`](https://api.rubyonrails.org/v5.1.7/classes/ActiveRecord/AttributeMethods/Dirty.html) and [`ActiveModel::Dirty`](https://api.rubyonrails.org/v5.1.7/classes/ActiveModel/Dirty.html) methods can be used on each bitfield:
- ```ruby
-    user = User.new(seller: false)
-    user.seller = true
-    user.will_save_change_to_seller? # => true
-    user.seller_change_to_be_saved # => [false, true]
-
-    user.save
-
-    user.seller_before_last_save # => false
-    user.saved_change_to_seller # => [false, true]
- ```
 
 Install
 =======
@@ -54,6 +42,49 @@ t.integer :my_bits, default: 0, null: false
 add_column :users, :my_bits, :integer, default: 0, null: false
 ```
 
+Instance Methods
+================
+
+### Global Bitfield Methods
+| Method Name        | Example (`user = User.new(seller: true, insane: true`)  | Result                                                      |
+|--------------------|---------------------------------------------------------|-------------------------------------------------------------|
+| `bitfield_values`  | `user.bitfield_values`                                  | `{"seller" => true, "insane" => true, "sensible" => false}` |
+| `bitfield_changes` | `user.bitfield_changes`                                 | `{"seller" => [false, true], "insane" => [false, true]}`    |
+
+### Individual Bit Methods
+#### Model Getters / Setters
+| Method Name    | Example (`user = User.new`) | Result  |
+|----------------|-----------------------------|---------|
+| `#{bit_name}`  | `user.seller`               | `false` |
+| `#{bit_name}=` | `user.seller = true`        | `true`  |
+| `#{bit_name}?` | `user.seller?`              | `true`  |
+
+#### Dirty Methods:
+
+Some, not all, [`ActiveRecord::AttributeMethods::Dirty`](https://api.rubyonrails.org/v5.1.7/classes/ActiveRecord/AttributeMethods/Dirty.html) and [`ActiveModel::Dirty`](https://api.rubyonrails.org/v5.1.7/classes/ActiveModel/Dirty.html) methods can be used on each bitfield:
+
+##### Before Model Persistence
+| Method Name                        | Example (`user = User.new`)        | Result          |
+|------------------------------------|------------------------------------|-----------------|
+| `#{bit_name}_was`                  | `user.seller_was`                  | `false`         |
+| `#{bit_name}_in_database`          | `user.seller_in_database`          | `false`         |
+| `#{bit_name}_change`               | `user.seller_change`               | `[false, true]` |
+| `#{bit_name}_change_to_be_saved`   | `user.seller_change_to_be_saved`   | `[false, true]` |
+| `#{bit_name}_changed?`             | `user.seller_changed?`             | `true`          |
+| `will_save_change_to_#{bit_name}?` | `user.will_save_change_to_seller?` | `true`          |
+| `#{bit_name}_became_true?`         | `user.seller_became_true?`         | `true`          |
+| `#{bit_name}_became_false?`        | `user.seller_became_false?`        | `false`         |
+
+
+##### After Model Persistence
+| Method Name                    | Example (`user = User.create(seller: true)`)      | Result          |
+|--------------------------------|---------------------------------------------------|-----------------|
+| `#{bit_name}_before_last_save` | `user.seller_before_last_save`                    | `false`         |
+| `saved_change_to_#{bit_name}`  | `user.saved_change_to_seller`                     | `[false, true]` |
+| `saved_change_to_#{bit_name}?` | `user.saved_change_to_seller?`                    | `true`          |
+
+  - **Note**: These methods are dynamically defined for each bitfield, and function separately from the real `ActiveRecord::AttributeMethods::Dirty`/`ActiveModel::Dirty` methods. As such, generic methods (e.g. `attribute_before_last_save(:attribute)`) will not work.
+
 Examples
 ========
 Update all users
@@ -120,6 +151,9 @@ Authors
  - [szTheory](https://github.com/szTheory)
  - [Reed G. Law](https://github.com/reedlaw)
  - [Rael Gugelmin Cunha](https://github.com/reedlaw)
+ - [Alan Wong](https://github.com/naganowl)
+ - [Andrew Bates](https://github.com/a-bates)
+ - [Shirish Pampoorickal](https://github.com/shirish-pampoorickal)
 
 [Michael Grosser](http://grosser.it)<br/>
 michael@grosser.it<br/>

data/lib/bitfields.rb

@@ -82,11 +82,19 @@ module Bitfields
     def add_bitfield_methods(column, options)
       bitfields[column].keys.each do |bit_name|
         if options[:added_instance_methods] != false
-          attribute bit_name, :boolean, default: false
-
           define_method(bit_name) { bitfield_value(bit_name) }
           define_method("#{bit_name}?") { bitfield_value(bit_name) }
-          define_method("#{bit_name}=") { |value| super(value); set_bitfield_value(bit_name, value) }
+          define_method("#{bit_name}=") { |value| set_bitfield_value(bit_name, value) }
+
+          # Dirty methods usable in before_save contexts
+          define_method("#{bit_name}_was") { bitfield_value_was(bit_name) }
+          alias_method "#{bit_name}_in_database", "#{bit_name}_was"
+
+          define_method("#{bit_name}_change") { bitfield_value_change(bit_name) }
+          alias_method "#{bit_name}_change_to_be_saved", "#{bit_name}_change"
+
+          define_method("#{bit_name}_changed?") { bitfield_value_change(bit_name).present? }
+          alias_method "will_save_change_to_#{bit_name}?", "#{bit_name}_changed?"
 
           define_method("#{bit_name}_became_true?") do
             value = bitfield_value(bit_name)
@@ -96,6 +104,11 @@ module Bitfields
             value = bitfield_value(bit_name)
             !value && send("#{bit_name}_was") != value
           end
+
+          # Dirty methods usable in after_save contexts
+          define_method("#{bit_name}_before_last_save") { bitfield_value_before_last_save(bit_name) }
+          define_method("saved_change_to_#{bit_name}") { saved_change_to_bitfield_value(bit_name) }
+          define_method("saved_change_to_#{bit_name}?") { saved_change_to_bitfield_value(bit_name).present? }
         end
 
         if options[:scopes] != false
@@ -186,6 +199,25 @@ module Bitfields
       send("#{column}_was") & bit != 0
     end
 
+    def bitfield_value_before_last_save(bit_name)
+      column, bit, _ = bitfield_info(bit_name)
+      column_before_last_save = send("#{column}_before_last_save")
+      column_before_last_save.nil? ? nil : column_before_last_save & bit != 0
+    end
+
+    def bitfield_value_change(bit_name)
+      values = [bitfield_value_was(bit_name), bitfield_value(bit_name)]
+      values unless values[0] == values[1]
+    end
+
+    def saved_change_to_bitfield_value(bit_name)
+      value_before_last_save = bitfield_value_before_last_save(bit_name)
+      current_value = bitfield_value(bit_name)
+      unless value_before_last_save.nil? || (value_before_last_save == current_value)
+        [value_before_last_save, current_value]
+      end
+    end
+
     def set_bitfield_value(bit_name, value)
       column, bit, current_value = bitfield_info(bit_name)
       new_value = TRUE_VALUES.include?(value)

data/lib/bitfields/version.rb

@@ -1,3 +1,3 @@
 module Bitfields
-  Version = VERSION = "0.11.0"
+  Version = VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitfields
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord