calib-rails 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c136ae28f6cd9225817e20d584b8fe3a10c2eeb94fb0954cb0e5c35203f361b
-  data.tar.gz: c355b4cba03b6b191d0cbf0a47e0830cb09a9c11e7fdfbf1428bb8b800311474
+  metadata.gz: bfdcbe8fbfa7c4b62dcc3527dc8979d03f5c491690c832b7b9ec8f0d083ae05e
+  data.tar.gz: 5df15af026bd6823fbd0f262fe91faa1edd3307f99b81eb45eddbadee8c98409
 SHA512:
-  metadata.gz: b327099d26cef807af1c22101dd7600c36c9ccd1469e79b2c382dc9024c3f9e1c5a611980f9cecac1bdfad141272a3db7344222da71d04a019ba40724ad95df2
-  data.tar.gz: 6f7adea3885ab9dc94ad99bd8b7ab83bd7037259a66af3d1b336738c33aaa7bb0ce83131afabdd3913bcd470095db215ad261568d7bf9603bb3d04b71d959b17
+  metadata.gz: 66445fec8cff243bafa2e060f5a650741fd0a51004d968159604314997ce4e39e569d91fbe85ae9919e3f4d54b95e0ea21d31ccdb2c086c7e51ee27a97f0420f
+  data.tar.gz: 71fc441f650e9858bf7a82a40b8051539731f8f0fa857738147fae855101cadb639cbee5a1c9249518fb6344552827c2659b641ad6525454602e782a2552d0e2

data/lib/calib/controllers/basic_auth.rb

@@ -2,19 +2,20 @@
 # authenticated status stored in session.
 # avoid frequently logging in
 #
-# [usage]
-# class ApplicationController < ActionController::Base
-#   include Calib::Controllers::BasicAuth
-#   basic_auth(user: 'myuser', pass: 'secret')
-#  ...
-# end
+# === usage
+#  class ApplicationController < ActionController::Base
+#    include Calib::Controllers::BasicAuth
+#    basic_auth(user: 'myuser', pass: 'secret')
+#    ...
+#  end
 # 
-# basic_auth # read ENV['BASIC_AUTH_USER'] and ENV['BASIC_AUTH_PASS']
-# basic_auth(user: 'myuser', pass: 'secret') # standard
+# === options
+#  basic_auth # read ENV['BASIC_AUTH_USER'] and ENV['BASIC_AUTH_PASS']
+#  basic_auth(user: 'myuser', pass: 'secret') # standard
 #
-# basic_auth(user: 'myuser', pass: 'secret') do
-#   request.domain != 'localhost' # localhost is unblocked domain.
-# end
+#  basic_auth(user: 'myuser', pass: 'secret') do |request|
+#    request.domain != 'localhost' # localhost is unblocked domain.
+#  end
 module Calib::Controllers::BasicAuth
   extend ActiveSupport::Concern
 

data/lib/calib/delegatable.rb

@@ -5,7 +5,7 @@ module Calib::Delegatable
     def self.delegate_all(targets)
       targets = Array(targets)
       define_method('method_missing') do |method, *args|
-        target = targets.find {|target| target.respond_to?(method) }
+        target = targets.find {|t| t.respond_to?(method) }
         return target.send(method, *args) if target.present?
         super
       end

data/lib/calib/devise/friendly_forwardable.rb

@@ -2,11 +2,11 @@
 # Redirect back to current page after sign in.
 # @see https://github.com/plataformatec/devise/wiki/How-To:-Redirect-back-to-current-page-after-sign-in,-sign-out,-sign-up,-update
 # 
-# [usage]
-# class ApplicationController < ActionController::Base
-#   include Calib::Devise::FriendlyForwardable
-#  ...
-# end
+# === usage
+#  class ApplicationController < ActionController::Base
+#    include Calib::Devise::FriendlyForwardable
+#    ...
+#  end
 module Calib::Devise::FriendlyForwardable
   extend ActiveSupport::Concern
 

data/lib/calib/devise/soft_deletion.rb

@@ -1,20 +1,27 @@
-# on schema:
+# == Soft deletation for devise
+# use with SoftDeletionMigrationEnhancable
 #
-# with coulumn for soft_deleted_flag
-# t.integer "alive", default: 1
+# === usage 
+# include to Devise Model.
 #
-# unique index
-# [for postgresql] # partial indexes
-#   t.index ["email", "alive"], name: "index_users_on_email_and_alive", unique: true, where: "(alive = 1)"
-# [for mysql] # ignoring null column
-#   t.index ["email", "alive"], name: "index_users_on_email_and_alive", unique: true
+#  class User < ApplicationRecord
+#    include Calib::Devise::SoftDeletion
 #
+#    devise :database_authenticatable, :registerable,
+#           :recoverable, :rememberable, :trackable, :validatable,
+#           :confirmable  
+#
+#    devise_soft_deletable # call below `device` method 
+#
+#    ...
+#  end  
 module Calib::Devise::SoftDeletion
   extend ActiveSupport::Concern
 
   included do
     class_attribute :alive_column_name
 
+    # initialize method to call on Devise Model.
     def self.devise_soft_deletable(alive_column_name = :alive)
       self.alive_column_name = alive_column_name
 
@@ -41,18 +48,22 @@ module Calib::Devise::SoftDeletion
     end
   end
 
+  # check canceled
   def canceled?
     self.alive_value == nil
   end
 
+  # do soft destroy
   def soft_destroy
     save if pre_destroy
   end
 
+  # do soft destroy! 
   def soft_destroy!
     save! if pre_destroy
   end
 
+  # get alive_column_value
   def alive_value
     self.send(self.class.alive_column_name)
   end

data/lib/calib/devise/soft_deletion_migration_enhancable.rb

@@ -1,3 +1,30 @@
+# == A Module for migration with soft deletation 
+# 1. unique email to ununique
+# 2. email and _filter_column_ to composite unique 
+# 3. add colunn _caneled_at_column_ for storing canceled datetime
+#
+# === usage
+# create migration file
+#
+#  class ChangeForSoftDeletationToUsers < ActiveRecord::Migration[5.1]
+#    include Calib::Devise::SoftDeletionMigrationEnhancable
+#    def change
+#      change_for_device_soft_deletion(:users)
+#    end
+#  end
+#
+# do migration
+#
+# and results on schema.rb:
+#
+#  # with coulumn for soft_deleted_flag
+#  t.integer "alive", default: 1
+#
+#  # unique indexes
+#  # [for postgresql] - partial indexes -
+#  t.index ["email", "alive"], name: "index_users_on_email_and_alive", unique: true, where: "(alive = 1)"
+#  # [for mysql] - ignoring null column -
+#  t.index ["email", "alive"], name: "index_users_on_email_and_alive", unique: true
 module Calib::Devise::SoftDeletionMigrationEnhancable
   include Calib::SoftDeletion::MigrationEnhancable
 

data/lib/calib/rails/version.rb

@@ -1,5 +1,5 @@
 module Calib
   module Rails
-    VERSION = '0.1.9'
+    VERSION = '0.1.10'
   end
 end

data/lib/calib/soft_deletion/migration_enhancable.rb

@@ -1,14 +1,32 @@
+# == A Module for soft deletation on MySQL and PostgreSQL.
+# with unique constraints(`deleted_at = nil` couldn't do it).
+#
+# === usage
+# create migration file
+#  
+#  # Inlude this Modlule and edit.
+#  class AddNameToUsers < ActiveRecord::Migration[5.1]
+#    include Calib::SoftDeletion::MigrationEnhancable
+#    def change
+#      add_unique_column_for_soft_deletion :users, :name      
+#    end
+#  end
+#
+# and migrate
 module Calib::SoftDeletion::MigrationEnhancable
+  # add unique column with soft deletation column as _filter_column_
   def add_unique_column_for_soft_deletion(table, unique_column, filter_column = :alive)
     add_column_for_soft_deletion(table, filter_column)
     add_unique_index_for_soft_deletion(table, unique_column, filter_column)
   end
 
+  # add column for soft deletation as _filter_column_
   def add_column_for_soft_deletion(table, filter_column = :alive)
     # @see https://qiita.com/yuba/items/70165875cfe02b03513d
     add_column table, filter_column, :integer, default: 1 # if canceled, alive=NULL for MYSQL
   end
 
+  # add unique index with soft deletation column as _filter_column_
   def add_unique_index_for_soft_deletion(table, unique_column, filter_column = :alive)
     if connection.adapter_name == 'MySQL'
       add_index table, [unique_column, filter_column], unique: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calib-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - ms2sato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails