soft_deletable_petit 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +10 -0
- data/.rspec +2 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/README.md +83 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/soft_deletable_petit.rb +5 -0
- data/lib/soft_deletable_petit/builder.rb +68 -0
- data/lib/soft_deletable_petit/config.rb +30 -0
- data/lib/soft_deletable_petit/soft_deletable.rb +11 -0
- data/lib/soft_deletable_petit/version.rb +3 -0
- data/soft_deletable_petit.gemspec +29 -0
- metadata +170 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c1f687ed5886b497ff04fad86edb25059cb6d6fd
|
4
|
+
data.tar.gz: f9cd2ea9ad144190ac77b96a137ac1af13657f66
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ac9fe027b8a6af9afa64688bc9517cf3863ccd912aea831df843089d1bbcbc4c630d1f9722f92bdec9dd3d1d419b68c26566b9938361feb35fb43a181cb98d79
|
7
|
+
data.tar.gz: 402a1552506b23d4dd9ac749b97c8b3d74fb5ec24ecf3d4fd891d980f55b9112d34383d29b907e4f1d3d0d93bab23f58ce1bef07f2b2b156d7e1c340782f4249
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
# SoftDeletablePetit
|
2
|
+
|
3
|
+
Based on [kakurenbo-puti](https://github.com/alfa-jpn/kakurenbo-puti).
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'soft_deletable_petit'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install soft_deletable_petit
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Add `deleted_at` column to your model.
|
24
|
+
|
25
|
+
and
|
26
|
+
```ruby
|
27
|
+
class YourModel < ActiveRecord::Base
|
28
|
+
soft_deletable
|
29
|
+
end
|
30
|
+
```
|
31
|
+
|
32
|
+
### Methods
|
33
|
+
```ruby
|
34
|
+
m.destroy_softly # or destroy_softly!
|
35
|
+
m.deleted? # => true
|
36
|
+
|
37
|
+
m.restore # or m.restore!
|
38
|
+
m.living? # => true
|
39
|
+
```
|
40
|
+
|
41
|
+
### Scopes
|
42
|
+
```ruby
|
43
|
+
YourModel.living
|
44
|
+
YourModel.deleted
|
45
|
+
```
|
46
|
+
|
47
|
+
## Configuration
|
48
|
+
|
49
|
+
In model
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
class YourModel < ActiveRecord::Base
|
53
|
+
soft_deletable \
|
54
|
+
column: :deleted_at,
|
55
|
+
soft_delete_method_name: :destroy_softly,
|
56
|
+
restore_method_name: :restore,
|
57
|
+
soft_deleted_scope: :deleted,
|
58
|
+
without_soft_deleted_scope: :living
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
and you can change default configuration with `SoftDeletablePetit.configure`.
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
# config/initializers/soft_deletable_petit.rb
|
66
|
+
SoftDeletablePetit.configure do |config|
|
67
|
+
config.column = :deleted_at
|
68
|
+
config.soft_delete_method_name = :destroy_softly
|
69
|
+
config.restore_method_name = :restore
|
70
|
+
config.soft_deleted_scope = :deleted
|
71
|
+
config.without_soft_deleted_scope = :living
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
## Development
|
76
|
+
|
77
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
78
|
+
|
79
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
80
|
+
|
81
|
+
## Contributing
|
82
|
+
|
83
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/soft_deletable_petit.
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "soft_deletable_petit"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
require "soft_deletable_petit/config"
|
2
|
+
|
3
|
+
module SoftDeletablePetit
|
4
|
+
class Builder
|
5
|
+
attr_reader :klass, :options
|
6
|
+
|
7
|
+
def self.build(klass, options = {})
|
8
|
+
new(klass, options).build
|
9
|
+
end
|
10
|
+
|
11
|
+
def initialize(klass, options = {})
|
12
|
+
@klass = klass
|
13
|
+
@options = options
|
14
|
+
end
|
15
|
+
|
16
|
+
def build
|
17
|
+
define_column_name_accessor(options.column)
|
18
|
+
|
19
|
+
define_instance_methods(options.soft_delete_method_name, options.restore_method_name)
|
20
|
+
define_scopes(options.soft_deleted_scope, options.without_soft_deleted_scope)
|
21
|
+
end
|
22
|
+
|
23
|
+
private
|
24
|
+
|
25
|
+
def define_column_name_accessor(col)
|
26
|
+
klass.class_eval do
|
27
|
+
define_singleton_method(:soft_delete_column){ col }
|
28
|
+
define_method(:soft_delete_column){ col }
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
def define_instance_methods(soft_delete_method_name, restore_method_name)
|
33
|
+
klass.class_eval do
|
34
|
+
define_model_callbacks soft_delete_method_name
|
35
|
+
define_model_callbacks restore_method_name
|
36
|
+
|
37
|
+
define_method "#{soft_delete_method_name}!" do
|
38
|
+
run_callbacks(soft_delete_method_name) { touch soft_delete_column; self }
|
39
|
+
end
|
40
|
+
define_method soft_delete_method_name do
|
41
|
+
!! send("#{soft_delete_method_name}!") rescue false
|
42
|
+
end
|
43
|
+
|
44
|
+
define_method "#{restore_method_name}!" do
|
45
|
+
run_callbacks(restore_method_name) { update_column soft_delete_column, nil; self }
|
46
|
+
end
|
47
|
+
define_method restore_method_name do
|
48
|
+
!! send("#{restore_method_name}!") rescue false
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
def define_scopes(soft_deleted_scope, without_soft_deleted_scope)
|
54
|
+
klass.class_eval do
|
55
|
+
scope soft_deleted_scope, ->{ where.not(soft_delete_column => nil) }
|
56
|
+
scope without_soft_deleted_scope, ->{ where(soft_delete_column => nil) }
|
57
|
+
|
58
|
+
define_method "#{soft_deleted_scope}?" do
|
59
|
+
send("#{soft_delete_column}?")
|
60
|
+
end
|
61
|
+
|
62
|
+
define_method "#{without_soft_deleted_scope}?" do
|
63
|
+
!send("#{soft_delete_column}?")
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
require 'active_support/configurable'
|
2
|
+
require 'active_support/core_ext/hash/slice'
|
3
|
+
|
4
|
+
module SoftDeletablePetit
|
5
|
+
def self.configure(&block)
|
6
|
+
yield config
|
7
|
+
end
|
8
|
+
|
9
|
+
def self.config
|
10
|
+
@config ||= Configuration.new
|
11
|
+
end
|
12
|
+
|
13
|
+
class Configuration
|
14
|
+
include ActiveSupport::Configurable
|
15
|
+
|
16
|
+
config_accessor :column do :deleted_at end
|
17
|
+
config_accessor :soft_delete_method_name do :destroy_softly end
|
18
|
+
config_accessor :restore_method_name do :restore end
|
19
|
+
config_accessor :soft_deleted_scope do :deleted end
|
20
|
+
config_accessor :without_soft_deleted_scope do :living end
|
21
|
+
|
22
|
+
def config
|
23
|
+
self.class.config
|
24
|
+
end
|
25
|
+
|
26
|
+
def merge(options)
|
27
|
+
config.merge(options.slice(*config.keys))
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
require "soft_deletable_petit/config"
|
2
|
+
require "soft_deletable_petit/builder"
|
3
|
+
|
4
|
+
module SoftDeletablePetit
|
5
|
+
module SoftDeletable
|
6
|
+
def soft_deletable(options = {})
|
7
|
+
@_soft_deletable_options = SoftDeletablePetit.config.merge(options)
|
8
|
+
SoftDeletablePetit::Builder.build(self, @_soft_deletable_options)
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'soft_deletable_petit/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "soft_deletable_petit"
|
8
|
+
spec.version = SoftDeletablePetit::VERSION
|
9
|
+
spec.authors = ["ichi"]
|
10
|
+
spec.email = ["ichi.ttht.1@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Soft Deletable for ActiveRecord.}
|
13
|
+
spec.description = %q{Soft Deletable for ActiveRecord.}
|
14
|
+
spec.homepage = "https://github.com/ichi/soft_deletable_petit"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_dependency "activerecord", "~> 4.2"
|
21
|
+
spec.add_dependency "activesupport", "~> 4.2"
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.11"
|
24
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
25
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
26
|
+
spec.add_development_dependency "rspec-its"
|
27
|
+
spec.add_development_dependency "sqlite3"
|
28
|
+
spec.add_development_dependency "pry"
|
29
|
+
end
|
metadata
ADDED
@@ -0,0 +1,170 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: soft_deletable_petit
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- ichi
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-03-16 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activerecord
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '4.2'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '4.2'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: activesupport
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '4.2'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '4.2'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.11'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.11'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '3.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '3.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rspec-its
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: sqlite3
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: pry
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
description: Soft Deletable for ActiveRecord.
|
126
|
+
email:
|
127
|
+
- ichi.ttht.1@gmail.com
|
128
|
+
executables: []
|
129
|
+
extensions: []
|
130
|
+
extra_rdoc_files: []
|
131
|
+
files:
|
132
|
+
- ".gitignore"
|
133
|
+
- ".rspec"
|
134
|
+
- ".travis.yml"
|
135
|
+
- Gemfile
|
136
|
+
- README.md
|
137
|
+
- Rakefile
|
138
|
+
- bin/console
|
139
|
+
- bin/setup
|
140
|
+
- lib/soft_deletable_petit.rb
|
141
|
+
- lib/soft_deletable_petit/builder.rb
|
142
|
+
- lib/soft_deletable_petit/config.rb
|
143
|
+
- lib/soft_deletable_petit/soft_deletable.rb
|
144
|
+
- lib/soft_deletable_petit/version.rb
|
145
|
+
- soft_deletable_petit.gemspec
|
146
|
+
homepage: https://github.com/ichi/soft_deletable_petit
|
147
|
+
licenses:
|
148
|
+
- MIT
|
149
|
+
metadata: {}
|
150
|
+
post_install_message:
|
151
|
+
rdoc_options: []
|
152
|
+
require_paths:
|
153
|
+
- lib
|
154
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
155
|
+
requirements:
|
156
|
+
- - ">="
|
157
|
+
- !ruby/object:Gem::Version
|
158
|
+
version: '0'
|
159
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
160
|
+
requirements:
|
161
|
+
- - ">="
|
162
|
+
- !ruby/object:Gem::Version
|
163
|
+
version: '0'
|
164
|
+
requirements: []
|
165
|
+
rubyforge_project:
|
166
|
+
rubygems_version: 2.5.1
|
167
|
+
signing_key:
|
168
|
+
specification_version: 4
|
169
|
+
summary: Soft Deletable for ActiveRecord.
|
170
|
+
test_files: []
|