calib-rails 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec33c98e4c2fd75072cc6eda243e73628fd28a47278536082ff4d9402af681d
-  data.tar.gz: 35fad2a56d46148731d6acce0586c1dbb4844b2606a48bf9532cd0318ec0babe
+  metadata.gz: a169448262ad90005944b50c2a715536f06f14ce4c3f7c9410b8c626cb06153d
+  data.tar.gz: 0a8a6d38c66d06ba4aa7cad08688627e912ee52913cfc5fe1f4654013726583e
 SHA512:
-  metadata.gz: 5c7b5bab0933ebbf9a7e0af9c486595e1fd67dd3c77173921761677b83915c6eee589a3e23d99a944d545fe09a5e374e1421b4a3b7eb951c557c79ce2921c239
-  data.tar.gz: c3f74b134e5b83b59aa9f6d6799265ffb93fece584d7bba53328712e87514a7f217819cfdfabba518f323a1b7184a4f476ecfb89d15bc3f29134f645acec8bce
+  metadata.gz: 9aedee16b3782063afeb706fea29e76be213b916997b2b0ad8867f185aac994f5fb08fc1594711a2d5510c4ff7876732e6fa0df5ce6a8706d4412a69612f1da0
+  data.tar.gz: 681cf919772a6c90f154d6d539c8bb9dbebc1959d0e8a9c151e394b431fa0fcc34e9a5db07325be22f13aafdb98fd888f520feaeba2dcf0f3599044c4090e980

data/lib/calib/delegatable.rb

@@ -0,0 +1,14 @@
+module Calib::Delegatable
+  extend ActiveSupport::Concern
+
+  included do
+    def self.delegate_all(targets)
+      targets = Array(targets)
+      define_method('method_missing') do |method, *args|
+        target = targets.find {|target| target.respond_to?(method) }
+        return target.send(method, *args) if target.present?
+        super
+      end
+    end
+  end
+end

data/lib/calib/devise/friendly_forwardable.rb

@@ -0,0 +1,32 @@
+module Calib::Devise::FriendlyForwardable
+  extend ActiveSupport::Concern
+
+  included do
+    # @see https://github.com/plataformatec/devise/wiki/How-To:-Redirect-back-to-current-page-after-sign-in,-sign-out,-sign-up,-update
+    before_action :store_access_location!, if: :storable_location?
+  end
+
+  private
+
+  # path with stored_location or root
+  def smart_path(r = devise_key_for_store_location)
+    stored_location_for(r) || root_path
+  end
+
+  def storable_location?
+    request.get? &&
+      is_navigational_format? &&
+      !devise_controller? &&
+      request.fullpath != root_path && # for return on creating new account
+      !request.xhr?
+  end
+
+  def store_access_location!
+    Rails.logger.debug("store_#{devise_key_for_store_location}_location!: #{request.fullpath}")
+    store_location_for(devise_key_for_store_location, request.fullpath)
+  end
+
+  def devise_key_for_store_location
+    Devise.mappings.keys[0]
+  end
+end

data/lib/calib/devise/soft_deletion.rb

@@ -0,0 +1,82 @@
+# on schema:
+#
+# with coulumn for soft_deleted_flag
+# t.integer "alive", default: 1
+#
+# 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
+#
+module Calib::Devise::SoftDeletion
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :alive_column_name
+
+    def self.devise_soft_deletable(alive_column_name = :alive)
+      self.alive_column_name = alive_column_name
+
+      # @see http://blog.319ring.net/2016/05/24/devise-kakurenbo-puti/
+      # remove unique email Devise::validatable
+      # https://gist.github.com/brenes/4503386
+      self._validators.delete(:email)
+      self._validate_callbacks.each do |callback|
+        if callback.raw_filter.respond_to? :attributes
+          callback.raw_filter.attributes.delete :email
+        end
+      end
+
+      # redefine email unique with column for soft deletation
+      self.validates :email, presence: true
+      self.validates_format_of :email, with: email_regexp, allow_blank: true, if: :will_save_change_to_email?
+      self.validates :email, uniqueness: { scope: alive_column_name }, if: :will_save_change_to_email?
+
+      self.scope :alive, -> { where(alive_column_name => 1) }
+    end
+
+    def self.find_for_authentication(warden_conditions)
+      alive.where(email: warden_conditions[:email]).first
+    end
+  end
+
+  def canceled?
+    self.alive_value == nil
+  end
+
+  def soft_destroy
+    save if pre_destroy
+  end
+
+  def soft_destroy!
+    save! if pre_destroy
+  end
+
+  def alive_value
+    self.send(self.class.alive_column_name)
+  end
+
+  private
+
+  def pre_destroy
+    return false if canceled?
+
+    self.attributes = cancel_attributes
+    self.skip_reconfirmation!
+    true
+  end
+
+  def cancel_attributes
+    key = Devise.friendly_token.first(8)
+
+    attrs = {
+      email: "calceled_#{self.id}_#{key}@canceled.com",
+      password: key,
+      canceled_at: Time.zone.now
+    }
+
+    attrs[self.class.alive_column_name] = nil
+    attrs
+  end
+end

data/lib/calib/devise/soft_deletion_migration_enhancable.rb

@@ -0,0 +1,15 @@
+module Calib::Devise::SoftDeletionMigrationEnhancable
+  include Calib::SoftDeletion::MigrationEnhancable
+
+  def change_for_device_soft_deletion(scope, filter_column = :alive, canceled_at_column = :canceled_at)
+    reversible do |dir|
+      dir.up { remove_index scope, :email }
+      dir.down { add_index scope, :email, unique: true }
+    end
+
+    add_column scope, canceled_at_column, :datetime
+
+    add_column_for_soft_deletion(scope, filter_column)
+    add_unique_index_for_soft_deletion(scope, :email, filter_column)
+  end
+end

data/lib/calib/illegal_access_error.rb

@@ -0,0 +1,3 @@
+module Calib
+  class IllegalAccessError < StandardError; end
+end

data/lib/calib/pundit/controller_nestable.rb

@@ -0,0 +1,34 @@
+# @see https://stackoverflow.com/questions/43707745/pundit-with-namespaced-controllers
+module Calib::Pundit::ControllerNestable
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :namespace
+
+    def self.nested_namespace(namespace)
+      self.namespace = Array(namespace)
+    end
+  end
+
+  def initialize(user, record)
+    @user = user
+    @record = record.is_a?(Array) ? record.last : record
+  end
+
+  def scope
+    Pundit.policy_scope! user, self.class.namespace + [record.class]
+  end
+
+  class Scope # :nodoc:
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user = user
+      @scope = scope.is_a?(Array) ? scope.last : scope
+    end
+
+    def resolve
+      scope
+    end
+  end
+end

data/lib/calib/pundit/nestable.rb

@@ -0,0 +1,27 @@
+# @see https://stackoverflow.com/questions/43707745/pundit-with-namespaced-controllers
+# @see https://github.com/elabs/pundit/pull/392/files
+module Calib::Pundit::Nestable
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :namespace
+
+    def self.nested_namespace(namespace)
+      self.namespace = Array(namespace)
+    end
+  end
+
+  def policy_scope(scope)
+    super self.class.namespace + [scope]
+  end
+
+  def authorize(record, query = nil)
+    super self.class.namespace + [record], query
+    record
+  end
+
+  def policy(record)
+    # if record is Array, as already namespace array
+    super record.is_a?(Array) ? record : self.class.namespace + [record]
+  end
+end

data/lib/calib/rails/version.rb

@@ -1,5 +1,5 @@
 module Calib
   module Rails
-    VERSION = '0.1.2'
+    VERSION = '0.1.6'
   end
 end

data/lib/calib/rails.rb

@@ -1,6 +1,25 @@
 module Calib
-  module Rails
+  module Controllers
+    autoload :BasicAuth, 'calib/controllers/basic_auth'
+  end
+  
+  module Devise
+    autoload :FriendlyForwardable, 'calib/devise/friendly_forwardable'
+    autoload :SoftDeletionMigrationEnhancable, 'calib/devise/soft_deletion_migration_enhancable'
+    autoload :SoftDeletion, 'calib/devise/soft_deletion'
+  end  
+
+  module Pundit
+    autoload :ControllerNestable, 'calib/pundit/controller_nestable'
+    autoload :Nestable, 'calib/pundit/nestable'
   end
-end
 
-require 'calib/controllers/basic_auth'
+  module SoftDeletion
+    autoload :MigrationEnhancable, 'calib/soft_deletion/migration_enhancable'
+  end
+
+  autoload :Delegatable, 'calib/delegatable'
+  autoload :IllegalAccessError, 'calib/illegal_access_error'
+  autoload :Service, 'calib/service'
+  autoload :UnauthenticatedError, 'calib/unauthenticated_error'
+end

data/lib/calib/service.rb

@@ -0,0 +1,9 @@
+# @see https://techracho.bpsinc.jp/hachi8833/2017_10_16/46482
+module Calib::Service
+  extend ActiveSupport::Concern
+  class_methods do
+    def call(*args)
+      new(*args).call
+    end
+  end
+end

data/lib/calib/soft_deletion/migration_enhancable.rb

@@ -0,0 +1,20 @@
+module Calib::SoftDeletion::MigrationEnhancable
+  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
+
+  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
+
+  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
+    else
+      # @see http://rny.io/rails/postgresql/2013/08/20/postgresql-indexing-in-rails.html
+      add_index table, [unique_column, filter_column], unique: true, where: "#{filter_column} = 1" # for Postgresql indexes partial
+    end
+  end
+end

data/lib/calib/unauthenticated_error.rb

@@ -0,0 +1,3 @@
+module Calib
+  class UnauthenticatedError < IllegalAccessError; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calib-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - ms2sato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,8 +63,18 @@ files:
 - README.md
 - Rakefile
 - lib/calib/controllers/basic_auth.rb
+- lib/calib/delegatable.rb
+- lib/calib/devise/friendly_forwardable.rb
+- lib/calib/devise/soft_deletion.rb
+- lib/calib/devise/soft_deletion_migration_enhancable.rb
+- lib/calib/illegal_access_error.rb
+- lib/calib/pundit/controller_nestable.rb
+- lib/calib/pundit/nestable.rb
 - lib/calib/rails.rb
 - lib/calib/rails/version.rb
+- lib/calib/service.rb
+- lib/calib/soft_deletion/migration_enhancable.rb
+- lib/calib/unauthenticated_error.rb
 - lib/tasks/calib/rails_tasks.rake
 homepage: https://github.com/CircleAround/calib-rails
 licenses: