idempotent_transaction 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: dcd664a58b6c461af1bec8fba8282778e8a0b13214d376f3f6162d438af769a0
4
+ data.tar.gz: b9b85a18ec9b858ba905924aa50b9b3634aca5801aafd6f14eca2ec1626bfd1a
5
+ SHA512:
6
+ metadata.gz: f16f1c13b364afdaed065a440657f6c9b989cfc0118589c3b6db94d64c8c1837a67eac0c17fde27058dd9003beb356281d8f8e8a3ca30544f0ca1b6a67b68ba5
7
+ data.tar.gz: 7d8e1a8ac855c6b29c7a8a218def7d2d23d1ce3d29a1c9a4e8eb47df88aad82a156cbfdb8712fd41150bf9b0baad81df900c5d26a8b2ddbcfa7621a187d0d265
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ Gemfile.lock
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,16 @@
1
+ inherit_gem:
2
+ fincop:
3
+ - 'config/rails.yml'
4
+ - 'config/rspec.yml'
5
+ - 'config/rubocop.yml'
6
+ # If you are using Rails 4, activate this cop.
7
+ # - 'config/disabled_for_rails_4.yml'
8
+
9
+ Naming/VariableNumber:
10
+ Enabled: false
11
+
12
+ Style/MethodCalledOnDoEndBlock:
13
+ Enabled: false
14
+
15
+ AllCops:
16
+ TargetRubyVersion: 2.5
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.5.1
7
+ before_install: gem install bundler -v 1.16.3
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at ota42y@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in idempotent_transaction.gemspec
6
+ gemspec
data/README.md ADDED
@@ -0,0 +1,166 @@
1
+ # IdempotentTransaction
2
+
3
+ This gem execute passed block by once using database unique key.
4
+
5
+ ```ruby
6
+ class IdempotentExecutor < ApplicationRecord
7
+ # user_id :bigint(8) not null
8
+ # transaction_type :integer(11) not null
9
+ # signature :string(255) not null
10
+ # expired_time :datetime not null
11
+ #
12
+ # Indexes
13
+ #
14
+ # unique_index (user_id, type, signature) UNIQUE
15
+
16
+ include IdempotentTransaction
17
+
18
+ enum transaction_type: [:post_create]
19
+
20
+ register_idempotent_column :user_id, :transaction_type, :signature
21
+ end
22
+
23
+ exec = IdempotentExecutor.new(user_id: user.id, transaction_type: :post_create, signature: 'abcdefg')
24
+ exec.idempotent_transaction do
25
+ user.user_posts.create(params[:new_post])
26
+ end
27
+
28
+ # we don't execute block and raise IdempotentTransaction::IdempotentError
29
+ exec.idempotent_transaction do
30
+ user.user_posts.create(params[:new_post])
31
+ end
32
+ ```
33
+
34
+ ## Installation
35
+
36
+ Add this line to your application's Gemfile:
37
+
38
+ ```ruby
39
+ gem 'idempotent_transaction'
40
+ ```
41
+
42
+ And then execute:
43
+
44
+ $ bundle
45
+
46
+ Or install it yourself as:
47
+
48
+ $ gem install idempotent_transaction
49
+
50
+ ## Usage
51
+
52
+ ### Basic
53
+ ```ruby
54
+ exec_1 = IdempotentExecutor.new(user_id: user.id, transaction_type: :post_create, signature: 'abcdefg')
55
+
56
+ # first time, we got no error and executed block
57
+ exec_1.finished?
58
+ # => false
59
+
60
+ exec.idempotent_transaction do
61
+ user.user_posts.create(params[:new_post])
62
+ end
63
+
64
+ user.user_posts.count
65
+ # => 1
66
+
67
+ exec_1.finished?
68
+ # => true
69
+
70
+ exec_1.executed?
71
+ # => true
72
+
73
+ # second time, we didn't execute block
74
+ exec_2 = IdempotentExecutor.new(user_id: user.id, transaction_type: :post_create, signature: 'abcdefg')
75
+ exec_2.finished?
76
+ # => true
77
+ exec_2.executed?
78
+ # => false
79
+
80
+ exec_2.idempotent_transaction do
81
+ user.user_posts.create(params[:new_post])
82
+ end
83
+
84
+ user.user_posts.count
85
+ # => 1 we don't execute block
86
+
87
+ exec_2.finished?
88
+ # => true
89
+ exec_2.executed?
90
+ # => false
91
+ ```
92
+
93
+ ### Force execute
94
+ When you pass force option, we always execute block and update state.
95
+
96
+ ```ruby
97
+ exec.finished?
98
+ # => true
99
+
100
+ exec.idempotent_transaction(force: true) do
101
+ user.user_posts.create(params[:new_post])
102
+ end
103
+
104
+ exec.executed?
105
+ # => true
106
+ ```
107
+
108
+ ### Stop execute block
109
+ If you raise error in block, we stop execute block and rollback state.
110
+
111
+ ```ruby
112
+ exec.idempotent_transaction do
113
+ raise 'error'
114
+ end
115
+
116
+ # when retry, execute block because above block didn't completed
117
+ exec.idempotent_transaction do
118
+ user.user_posts.create(params[:new_post])
119
+ end
120
+
121
+ ```
122
+
123
+ ## Background
124
+ ```ruby
125
+ exec = IdempotentExecutor.new(user_id: user.id, type: :post_create, signature: 'abcdefg')
126
+ exec.idempotent_transaction do
127
+ user.user_posts.create(params[:new_post])
128
+ end
129
+ ```
130
+
131
+ We use transaction so we rewrite this code like this.
132
+
133
+ ```
134
+ exec = IdempotentExecutor.new(user_id: user.id, type: :post_create, signature: 'abcdefg')
135
+
136
+ ActiveRecord::Base.transaction do
137
+ user.user_posts.create(params[:new_post])
138
+
139
+ begin
140
+ exec.save!
141
+ exec.executed = true
142
+ exec.finished = true
143
+ rescue => ActiveRecord::RecordNotUnique
144
+ exec.finished = true
145
+ exec.executed = false
146
+ end
147
+ end
148
+ ```
149
+
150
+ ## Development
151
+
152
+ 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.
153
+
154
+ 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).
155
+
156
+ ## Contributing
157
+
158
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idempotent_transaction. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
159
+
160
+ ## License
161
+
162
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
163
+
164
+ ## Code of Conduct
165
+
166
+ Everyone interacting in the IdempotentTransaction project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/idempotent_transaction/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'idempotent_transaction'
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(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,32 @@
1
+ lib = File.expand_path('lib', __dir__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'idempotent_transaction/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'idempotent_transaction'
7
+ spec.version = IdempotentTransaction::VERSION
8
+ spec.authors = ['ota42y']
9
+ spec.email = ['ota42y@gmail.com']
10
+
11
+ spec.summary = 'Execute passed transaction block by once using database unique key.'
12
+ spec.description = 'Execute passed transaction block by once using database unique key.'
13
+ spec.homepage = 'https://github.com/ota42y/idempotent_transaction'
14
+
15
+ # Specify which files should be added to the gem when it is released.
16
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
17
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
18
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
19
+ end
20
+ spec.bindir = 'exe'
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ['lib']
23
+
24
+ spec.add_dependency 'activerecord'
25
+
26
+ spec.add_development_dependency 'bundler', '~> 1.16'
27
+ spec.add_development_dependency 'database_rewinder'
28
+ spec.add_development_dependency 'fincop'
29
+ spec.add_development_dependency 'rake', '~> 10.0'
30
+ spec.add_development_dependency 'rspec', '~> 3.0'
31
+ spec.add_development_dependency 'sqlite3'
32
+ end
@@ -0,0 +1,3 @@
1
+ module IdempotentTransaction
2
+ VERSION = '0.1.0'.freeze
3
+ end
@@ -0,0 +1,46 @@
1
+ require 'idempotent_transaction/version'
2
+
3
+ module IdempotentTransaction
4
+ def self.included(base)
5
+ base.extend(ClassMethods)
6
+ end
7
+
8
+ module ClassMethods
9
+ def register_idempotent_column(*columns)
10
+ @idempotent_columns = columns
11
+ end
12
+
13
+ def idempotent_columns
14
+ @idempotent_columns
15
+ end
16
+ end
17
+
18
+ def finished?
19
+ @finished ||= record_exist?
20
+ end
21
+
22
+ def executed?
23
+ @executed ||= false
24
+ end
25
+
26
+ def idempotent_transaction(force: false)
27
+ self.class.transaction do
28
+ yield
29
+
30
+ begin
31
+ save!
32
+ rescue ActiveRecord::RecordNotUnique
33
+ raise ActiveRecord::Rollback unless force
34
+ end
35
+
36
+ @finished = true
37
+ @executed = true
38
+ end
39
+ end
40
+
41
+ private
42
+
43
+ def record_exist?
44
+ self.class.exists?(self.class.idempotent_columns.map { |k| [k, send(k)] }.to_h)
45
+ end
46
+ end
metadata ADDED
@@ -0,0 +1,154 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: idempotent_transaction
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - ota42y
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-08-17 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: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.16'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.16'
41
+ - !ruby/object:Gem::Dependency
42
+ name: database_rewinder
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: fincop
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '10.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '10.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.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
+ description: Execute passed transaction block by once using database unique key.
112
+ email:
113
+ - ota42y@gmail.com
114
+ executables: []
115
+ extensions: []
116
+ extra_rdoc_files: []
117
+ files:
118
+ - ".gitignore"
119
+ - ".rspec"
120
+ - ".rubocop.yml"
121
+ - ".travis.yml"
122
+ - CODE_OF_CONDUCT.md
123
+ - Gemfile
124
+ - README.md
125
+ - Rakefile
126
+ - bin/console
127
+ - bin/setup
128
+ - idempotent_transaction.gemspec
129
+ - lib/idempotent_transaction.rb
130
+ - lib/idempotent_transaction/version.rb
131
+ homepage: https://github.com/ota42y/idempotent_transaction
132
+ licenses: []
133
+ metadata: {}
134
+ post_install_message:
135
+ rdoc_options: []
136
+ require_paths:
137
+ - lib
138
+ required_ruby_version: !ruby/object:Gem::Requirement
139
+ requirements:
140
+ - - ">="
141
+ - !ruby/object:Gem::Version
142
+ version: '0'
143
+ required_rubygems_version: !ruby/object:Gem::Requirement
144
+ requirements:
145
+ - - ">="
146
+ - !ruby/object:Gem::Version
147
+ version: '0'
148
+ requirements: []
149
+ rubyforge_project:
150
+ rubygems_version: 2.7.6
151
+ signing_key:
152
+ specification_version: 4
153
+ summary: Execute passed transaction block by once using database unique key.
154
+ test_files: []