set_as_primary 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09252a0d5cef2ec2dbf697837059b9604bad6617f82e2938fb95b0e7ea54749e'
-  data.tar.gz: 8bed32971351c098816889638e39307b44692445fb5593a6941b28010344ea26
+  metadata.gz: 06f7d231ec1dc1effe46cd6b516c12bcffdf98b3feadde4d0f0a5b8e193f2047
+  data.tar.gz: 6f21389fa3d8aa3c8a2bc512dfb26874b84c9b3cfd060afc3b9c7ba18cac9781
 SHA512:
-  metadata.gz: 7ff0a54d3af341c41ba937311a449ebb3adf582390b4dee9880aa36e548d56433c1314836e0246680b9e8611b9643085a390f48ab9962edbe5aa31501adb5ecd
-  data.tar.gz: b4f24ce736c8f261252e48e342896a13a0710a36fc2abf17fb3b170e4291f945ad47dc900cb0ee0c2ae839d7af0f3358c4657cf21806f1d4ae1d07178ee7ae18
+  metadata.gz: 625e12dd80c2c13f78d5d557504db3cfbce52124846c64d735ed71a16f4f0feb1b41f69a8da8a3c20e58ecc29e3ebff5fdd0cb229dc9c1f78495fb6ff46b56fc
+  data.tar.gz: b706248616ceacf293a0b0ff8c9769226ae5e088c026cc655b3937159c5606132b8bb37665e425bac213c2c95e93da43a8132631e50822f94a19f8d6a4030446

data/.rubocop.yml

@@ -81,7 +81,7 @@ Layout/EmptyLinesAroundModuleBody:
 Style/HashSyntax:
   Enabled: true
 
-Layout/IndentFirstArgument:
+Layout/FirstArgumentIndentation:
   Enabled: true
 
 # Method definitions after `private` or `protected` isolated calls need one
@@ -170,7 +170,7 @@ Layout/Tab:
   Enabled: true
 
 # Blank lines should not have any spaces.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # No trailing whitespace.
@@ -197,7 +197,7 @@ Lint/RequireParentheses:
 Lint/ShadowingOuterLocalVariable:
   Enabled: true
 
-Lint/StringConversionInInterpolation:
+Lint/RedundantStringCoercion:
   Enabled: true
 
 Lint/UriEscapeUnescape:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.2 (2019-02-02)
+- Supported unique partial index.
+- Changed generator definition. Now it also accepts `flag_name`, `owner_key`.
+- Handled `force_primary` in `after_create` callback.
+- Refactored the code.
+
 ## 0.1.1 (2019-12-29)
 
 - Added support for single model with no association.

data/Gemfile

@@ -8,7 +8,7 @@ gemspec
 gem "activerecord", "~> 6.0.0"
 
 group :development do
-  gem "rubocop", ">= 0.47", require: false
-  gem "rubocop-performance", require: false
-  gem "rubocop-rails", require: false
+  gem "rubocop", ">= 0.47"
+  gem "rubocop-performance"
+  gem "rubocop-rails"
 end

data/README.md

@@ -1,12 +1,19 @@
 # SetAsPrimary
 
-The simplest way to handle the primary or default flag (:white_check_mark:) to
+The simplest way to handle the primary or default flag to
 your Rails models.
 
-Supports PostgreSQL, MySQL, and SQLite.
+Features:
+
+* Supports single model (without association), model with (`belongs_to`) association, and even polymorphic associations
+* Force primary
+* Supports PostgreSQL's unique partial index (constraint)
+* Supports PostgreSQL, MySQL, and SQLite
+
+
 
 [Demo Rails application](https://cryptic-lake-90495.herokuapp.com/) |
-[Demo Rails application GitHub repository](https://github.com/mechanicles/set_as_primary_rails_app)
+[Source code of Demo Rails application](https://github.com/mechanicles/set_as_primary_rails_app)
 
 [![Build Status](https://travis-ci.org/mechanicles/set_as_primary.svg?branch=master)](https://travis-ci.org/mechanicles/set_as_primary)
 
@@ -33,7 +40,7 @@ Address, etc., which belong to the User/Person model or polymorphic model. There
 you might need to set a primary email address, primary phone number, or default
 address for a user, and this gem helps you to do that.
 
-It also supports single model with no association's context. 
+It also supports a single model with no association context. 
 
 Examples:
 
@@ -57,20 +64,20 @@ class Address < ApplicationRecord
   set_as_primary :primary, owner_key: :owner
 end
 
-# Single model with no owner/association's context.
+# Single model with no owner/association context.
 class Post < ApplicationRecord
   include SetAsPrimary
   
-  set_as_primary
+  set_as_primary :primary
 end
 ``` 
 
 You need to include `SetAsPrimary` module in your model where you want to handle the primary flag.
 Then to `set_as_primary` class helper method, pass your primary flag attribute. You might need to pass
- association key `owner_key` if you wan to consider owner's (association's) context.
+ association key `owner_key` if you wan to consider owner (association) context.
 
-**NOTE:**  Default primary flag attribute is `primary`, and you can use another one too like `default` but
-make sure that flag should be present in the table and should be a boolean column type.
+**Note:**  Default primary flag attribute is `primary`, and you can use another one too like `default` but
+make sure that flag should be present in the table and should be a boolean data type column.
 
 #### Migration
 
@@ -78,20 +85,55 @@ If your table does not have the primary flag column, then you can add it by runn
 following command in your rails project:
 
 ```ssh
-rails generate set_as_primary your_table_name
+rails generate set_as_primary your_table_name flag_name
+```
+
+Example:
+
+If you want to add a `primary` column to your `posts` table, then you can run command like this:
+
+```shell
+rails generate set_as_primary posts primary
+```
+
+Then migration gets created like this:
+
+```ruby
+class AddPrimaryColumnToPosts < ActiveRecord::Migration[6.0]
+  def change
+    add_column :posts, :primary, :boolean, default: false, null: false
+    # NOTE: Please uncomment following line if you want only one 'true' (constraint) in the table.
+    # add_index :posts, :primary, unique: true, where: "(posts.primary IS TRUE)"
+  end
+end
+```
+
+If you want to create a primary column to `email_addresses` table, then you can run command like this:
+
+```shell
+rails generate set_as_primary email_addresses primary user
 ```
 
-If you run above command for `email_addresses` table, then it creates
-migration like this:
+Then it creates migration like this:
 
 ```ruby
 class AddPrimaryColumnToEmailAddresses < ActiveRecord::Migration[6.0]
   def change
     add_column :email_addresses, :primary, :boolean, default: false, null: false
+    # NOTE: Please uncomment following line if you want only one 'true' (constraint) in the table.
+    # add_index :email_addresses, %i[user_id, primary], unique: true, where: "(email_addresses.primary IS TRUE)"
   end
 end
 ```
-Don't forget to run `rails db:migrate` to create actual column in the table.
+You might have seen extra commented lines there. These lines are there for handling the unique constraint. Currently, these lines get created only for `PostgreSQL` adapter as it supports partial index.
+
+Please note that here we have passed an extra option `user` in the command that is nothing but the owner/association name. This extra option helps to handle the unique partial index.
+
+**Note:** Partial indexes are only supported for PostgreSQL and SQLite 3.8.0+. But I also found that SQLite gives an error so currently this gem only supports PostgreSQL's unique partial index constraint.
+
+**Even if we don't have constraint (only one 'true' constraint in the table), this gem takes care of it so don't worry about the constraint.**
+
+Once migration file gets created, don't forget to run `rails db:migrate` to create an actual column in the table.
 
 #### force_primary
 
@@ -114,8 +156,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake test` to run the tests. You can also run `bin/console` for an interactive
 prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at 

data/bin/console

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #!/usr/bin/env ruby
 
 require "bundler/setup"

data/bin/setup

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'

data/lib/generators/set_as_primary/set_as_primary_generator.rb

@@ -6,21 +6,54 @@ module SetAsPrimary
   module Generators
     class SetAsPrimaryGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-
       source_root File.expand_path("templates", __dir__)
-      argument :table_name, type: :string
 
-      desc "Adds a boolean column 'primary' to the given table."
+      desc "Adds a user defined boolean column to the given table."
+
+      argument :table_name, type: :string
+      argument :flag_name, type: :string
+      argument :owner_key, type: :string, default: ""
 
       def copy_migration
         migration_template "migration.rb", "db/migrate/add_primary_column_to_#{table_name}.rb",
-          migration_version: migration_version
+          migration_version: migration_version,
+          index_on: index_on,
+          support_partial_index: support_partial_index
       end
 
       def migration_version
         "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
 
+      def index_on
+        if owner_key.present?
+          klass = table_name.classify.constantize
+          owner_association = klass.reflect_on_association(owner_key.to_sym)
+
+          if owner_association.nil?
+            raise ActiveRecord::AssociationNotFoundError.new(klass, owner_key)
+          end
+
+          owner_id_key = "#{owner_key}_id"
+
+          if owner_association.options[:polymorphic]
+            owner_type_key = "#{owner_key}_type"
+            "%i[#{owner_id_key}, #{owner_type_key}, #{flag_name}]"
+          else
+            "%i[#{owner_id_key}, #{flag_name}]"
+          end
+        else
+          ":#{flag_name}"
+        end
+      end
+
+      def support_partial_index
+        # NOTE: Partial indexes are only supported for PostgreSQL and SQLite 3.8.0+.
+        # Also found that, even if we use SQLite 3.8.0+, we still get a syntax error.
+        # So currently we have ignored SQLite.
+        ActiveRecord::Base.connection.adapter_name.downcase.to_sym == :postgresql
+      end
+
       def self.next_migration_number(dirname)
         ActiveRecord::Generators::Base.next_migration_number(dirname)
       end

data/lib/generators/set_as_primary/templates/migration.rb

@@ -1,6 +1,10 @@
 class AddPrimaryColumnTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    add_column :<%= table_name.to_sym %>, :primary, :boolean, default: false, null: false
+    add_column :<%= table_name %>, :<%= flag_name %>, :boolean, default: false, null: false
+    <%- if support_partial_index -%>
+    # NOTE: Please uncomment following line if you want only one 'true' (constraint) in the table.
+    # add_index :<%= table_name %>, <%= index_on %>, unique: true, where: "(<%= table_name %>.<%= flag_name %> IS TRUE)"
+    <%- end -%>
   end
 end
 

data/lib/set_as_primary.rb

@@ -10,22 +10,22 @@ module SetAsPrimary
 
   included do
     before_save :unset_old_primary
-    before_save :force_primary, if: -> { self.class._force_primary }
+    before_save :force_primary, if: -> { _klass._force_primary }
+    after_destroy :force_primary, if: -> { _klass._force_primary }
 
     instance_eval do
       class_attribute :_primary_flag_attribute, :_owner_key, :_force_primary
 
       def set_as_primary(primary_flag_attribute = :primary, options = {})
         if primary_flag_attribute.is_a?(Hash)
-          options = primary_flag_attribute
-          primary_flag_attribute = :primary
+          options = primary_flag_attribute; primary_flag_attribute = :primary
         end
 
         configuration = { owner_key: nil, force_primary: true }
 
         configuration.update(options) if options.is_a?(Hash)
 
-        handle_setup_errors(primary_flag_attribute, configuration)
+        _handle_setup_errors(primary_flag_attribute, configuration)
 
         self._primary_flag_attribute = primary_flag_attribute
         self._owner_key = configuration[:owner_key]
@@ -33,9 +33,9 @@ module SetAsPrimary
       end
 
       private
-        def handle_setup_errors(primary_flag_attribute, configuration)
+        def _handle_setup_errors(primary_flag_attribute, configuration)
           if !primary_flag_attribute.is_a?(Symbol)
-            raise SetAsPrimary::Error, "Wrong attribute! Please provide attribute in symbol type."
+            raise SetAsPrimary::Error, "wrong argument type (expected Symbol)"
           end
 
           owner_key = configuration[:owner_key]
@@ -49,40 +49,49 @@ module SetAsPrimary
 
   private
     def unset_old_primary
-      return unless self.public_send(self.class._primary_flag_attribute)
-
-      scope = self.class.where(scope_options) if scope_options.present?
+      return unless public_send(_klass._primary_flag_attribute)
 
+      scope = _klass
+      scope = scope.where(_scope_options) if _scope_options.present?
       scope = scope.where("id != ?", id) unless new_record?
 
-      scope.update_all(self.class._primary_flag_attribute => false)
+      scope.update_all(_klass._primary_flag_attribute => false)
     end
 
     def force_primary
-      count = self.class.where(scope_options).count
-
-      if (count == 1 && !new_record?) || (count == 0 && new_record?)
-        self.public_send("#{self.class._primary_flag_attribute}=", true)
+      scope = _klass
+      scope = scope.where(_scope_options) if _scope_options.present?
+      count = scope.count
+
+      if count == 1 && destroyed?
+        object = scope.first
+        object.update_columns(_klass._primary_flag_attribute => true)
+      elsif (count == 1 && !new_record?) || (count == 0 && new_record?)
+        public_send("#{_klass._primary_flag_attribute}=", true)
       end
     end
 
-    def scope_options
-      return nil if self.class._owner_key.nil?
+    def _scope_options
+      return nil if _klass._owner_key.nil?
 
-      @scope_option ||= if self.class.reflect_on_association(self.class._owner_key).options[:polymorphic]
-                          polymorphic_condition_options
-                        else 
-                          owner_id = "#{self.class._owner_key}_id".to_sym
-                          { owner_id => self.public_send(owner_id) }
-                        end
+      @_scope_options ||= if _klass.reflect_on_association(_klass._owner_key).options[:polymorphic]
+        _polymorphic_condition_options
+      else
+        owner_id = "#{_klass._owner_key}_id".to_sym
+        { owner_id => public_send(owner_id) }
+      end
     end
 
-    def polymorphic_condition_options
+    def _polymorphic_condition_options
       owner = self.public_send(self.class._owner_key)
 
       {
-        "#{self.class._owner_key}_id".to_sym =>  owner.id,
-        "#{self.class._owner_key}_type".to_sym => owner.class.name
+        "#{_klass._owner_key}_id".to_sym =>  owner.id,
+        "#{_klass._owner_key}_type".to_sym => owner.class.name
       }
     end
+
+    def _klass
+      self.class
+    end
 end

data/lib/set_as_primary/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SetAsPrimary
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: set_as_primary
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Santosh Wadghule
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-29 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport