idempotent_block 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 403dc93ff41b7e946e742f4572457f8c0953266964e68100485c14c6b22dbcca
+  data.tar.gz: 59fce33f70d02c6723e31f1728e01407633bec76ec0a5d3a71c70ba798e2d2b8
+SHA512:
+  metadata.gz: bba6b97c91074a38b900f3a0028f604c29b35b855980c106e3876132122d9cdd5140e2fd1652c1b6c6e73d56d0c33826a0fa98d70be190a20308b3e3f655b2c8
+  data.tar.gz: 167765267eefe2fcfca755cb65dabd5e3d9076ad5079d135eafb354f7f201faf09a84b01c18666cd1e9baf721d5ab58e28992c82770dcc161747424ea903a79b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  fincop:
+    - 'config/rails.yml'
+    - 'config/rspec.yml'
+    - 'config/rubocop.yml'
+    # If you are using Rails 4, activate this cop.
+    # - 'config/disabled_for_rails_4.yml'
+
+Naming/VariableNumber:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ota42y@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in idempotent_block.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ota42y
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# IdempotentBlock
+
+This gem execute passed block by once using database unique key.  
+
+```ruby
+class IdempotentExecutor < ApplicationRecord
+  #  user_id             :bigint(8)      not null
+  #  block_type          :integer(11)    not null
+  #  signature           :string(255)    not null
+  #  expired_time        :datetime       not null
+  #
+  # Indexes
+  #
+  #  unique_index  (user_id, type, signature) UNIQUE
+
+  include IdempotentBlock
+
+  enum block_type: [:post_create]
+
+  register_idempotent_column :user_id, :block_type, :signature
+end
+
+exec = IdempotentExecutor.new(user_id: user.id, block_type: :post_create, signature: 'abcdefg')
+exec.start do
+  user.user_posts.create(params[:new_post])
+end
+
+# we don't execute block and raise IdempotentBlock::IdempotentError
+exec.start do
+  user.user_posts.create(params[:new_post])
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idempotent_block'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install idempotent_block
+
+## Usage
+
+### Basic
+```ruby
+exec_1 = IdempotentExecutor.new(user_id: user.id, block_type: :post_create, signature: 'abcdefg')
+
+# first time, we got no error and executed block 
+exec_1.finished?
+# => false
+
+exec.start do
+  user.user_posts.create(params[:new_post])
+end
+
+user.user_posts.count
+# => 1
+
+exec_1.finished?
+# => true
+
+exec_1.executed?
+# => true
+
+# second time, we didn't execute block
+exec_2 = IdempotentExecutor.new(user_id: user.id, block_type: :post_create, signature: 'abcdefg')
+exec_2.finished?
+# => true
+exec_2.executed?
+# => false
+
+exec_2.start do
+  user.user_posts.create(params[:new_post])
+end
+
+user.user_posts.count
+# => 1 we don't execute block
+
+exec_2.finished?
+# => true
+exec_2.executed?
+# => false
+```
+
+### Force execute
+When you pass force option, we always execute block and update state.
+
+```ruby
+exec.finished?
+# => true
+
+exec.start(force: true) do
+  user.user_posts.create(params[:new_post])
+end
+
+exec.executed?
+# => true
+```
+
+### Stop execute block
+If you raise error in block, we stop execute block and rollback state.
+
+```ruby
+exec.start do
+  raise 'error'
+end
+
+# when retry, execute block because above block didn't completed
+exec.start do
+  user.user_posts.create(params[:new_post])
+end
+
+```
+
+## Background
+```ruby
+exec = IdempotentExecutor.new(user_id: user.id, type: :post_create, signature: 'abcdefg')
+exec.start do
+  user.user_posts.create(params[:new_post])
+end
+```
+
+We use transaction so we rewrite this code like this. 
+
+```
+exec = IdempotentExecutor.new(user_id: user.id, type: :post_create, signature: 'abcdefg')
+
+ActiveRecord::Base.transaction do
+  user.user_posts.create(params[:new_post])
+
+  begin
+    exec.save!
+    exec.executed = true
+    exec.finished = true
+  rescue => ActiveRecord::RecordNotUnique
+    exec.finished = true
+    exec.executed = false
+  end 
+end
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idempotent_block. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IdempotentBlock project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/idempotent_block/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'idempotent_block'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/idempotent_block.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'idempotent_block/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'idempotent_block'
+  spec.version       = IdempotentBlock::VERSION
+  spec.authors       = ['ota42y']
+  spec.email         = ['ota42y@gmail.com']
+
+  spec.summary       = 'Execute passed transaction block by once using database unique key.'
+  spec.description   = 'Execute passed transaction block by once using database unique key.'
+  spec.homepage      = 'https://github.com/ota42y/idempotent_block'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'database_rewinder'
+  spec.add_development_dependency 'fincop'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/idempotent_block.rb

@@ -0,0 +1,46 @@
+require 'idempotent_block/version'
+
+module IdempotentBlock
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def register_idempotent_column(*columns)
+      @idempotent_columns = columns
+    end
+
+    def idempotent_columns
+      @idempotent_columns
+    end
+  end
+
+  def finished?
+    @finished ||= record_exist?
+  end
+
+  def executed?
+    @executed ||= false
+  end
+
+  def start(force: false)
+    self.class.transaction do
+      yield
+
+      begin
+        save!
+      rescue ActiveRecord::RecordNotUnique
+        raise ActiveRecord::Rollback unless force
+      end
+
+      @finished = true
+      @executed = true
+    end
+  end
+
+  private
+
+    def record_exist?
+      self.class.exists?(self.class.idempotent_columns.map { |k| [k, send(k)] }.to_h)
+    end
+end

data/lib/idempotent_block/version.rb

@@ -0,0 +1,3 @@
+module IdempotentBlock
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: idempotent_block
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ota42y
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: database_rewinder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fincop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Execute passed transaction block by once using database unique key.
+email:
+- ota42y@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- idempotent_block.gemspec
+- lib/idempotent_block.rb
+- lib/idempotent_block/version.rb
+homepage: https://github.com/ota42y/idempotent_block
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Execute passed transaction block by once using database unique key.
+test_files: []