operate_do 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb96f21d59bf8d815368c54374b139e5a8818f980119ce5fae6dca4e251ff992
+  data.tar.gz: e68765cdf3028124a0627e3e9fc35dd578ccd7c69ca14e2c8d12d489feb0e588
+SHA512:
+  metadata.gz: d819bb6f645184704cadc4176f8c85e9b47c9b2e75f706188a3ff5295f93e573e215c47af60fef18af4bc18f332a048106ea9440e44f90509bbc97cb638462d0
+  data.tar.gz: bfde8c1f33c6c10422d6e81f909a07d9b8bb879927adb3383e7015fddf6b3aa364f926d1b83b556401f48c3875c850db8d71ec6e1b7b9b8962f432bc493366bb

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 takkanm@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 operate_do.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 takkanm
+
+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,132 @@
+# OperateDo
+
+PerateDo provides a simple way to manage thread-local variable which represents the operator of a transaction.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'operate_do'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install operate_do
+
+## Usage
+
+First, include OperateDo::Operator into the class which represents a operator.
+
+```ruby
+class Admin
+  include OperateDo::Operator
+end
+```
+
+`OperateDo::Operator` provides `operate` and `self_operate` methods.
+
+`operate` methods accept block. `OperateDo.current_operator` is `operate` method reciver takes a block.
+
+While the block is being executed, `OperateDo.current_operator` returns current operator, the receiver of this method calling.
+
+```ruby
+admin = Admin.new # => #<Admin:0x007ff02b235cf8>
+
+admin.operate do
+  OperateDo.current_operator # => #<Admin:0x007ff02b235cf8>
+end
+```
+
+Since it's a thread-local, you can get it in everywhere. For example, when you call `admin.operate do...` in the rails' controller layer then you can get the `OperateDo.current_operator` from the model layer.
+
+`operate` method can nest.
+Of cource, `operate` can be nested, like nested transactions.
+
+```ruby
+admin1 = Admin.new
+admin2 = Admin.new
+
+admin1.operate do
+  OperateDo.current_operator == admin1 # => true
+  admin2.operate do
+    OperateDo.current_operator == admin2 # => true
+  end
+  OperateDo.current_operator == admin1 # => true
+end
+```
+
+OperateDo has a flexible logging mechanism. If you logging with operator, you can use `OperateDo.write` method.
+
+```ruby
+admin.operate do
+  OperateDo.write 'a resource is being modified'
+end
+
+# => I, [2017-10-04T07:13:15.713900 #21515]  INFO -- : 2017/10/04/ 07:13:15 - #<Admin:0x007ff02b235cf8> has operated : call in admin blcok
+```
+
+`OperateDo.write` uses `OperateDo::Logger` is a wrapper of Ruby's Logger by default.
+
+You can create your custome logger and use it by setting.
+
+Your custome logger class expect and implements `flush!` method.
+`flush!` method recive array of `OperateDo::Message`.
+A logger class is expected to implement `flush!` method. This method receives an array of `OperateDo::Message`.
+
+```ruby
+class StringIOLogger
+  def initialize(io_object)
+    @io_object = io_object
+  end
+
+  def flush!(messages)
+    messages.each do |message|
+      @io_object.puts [
+        message.operate_at.strftime('%Y/%m/%d/ %H:%M:%S'),
+        "#{message.operator.operate_inspect} has operated : #{message.message}"
+      ].join(" - ")
+    end
+  end
+end
+```
+
+And then, set `OperateDo.configure`.
+
+```ruby
+logger_string = StringIO.new
+
+OperateDo.configure do |config|
+  config.logger = StringIOLogger
+  config.logger_initialize_proc = -> { logger_string }
+end
+admin.operate do
+  OperateDo.write 'call in admin blcok'
+end
+
+logger_string.rewind
+logger_string.read # => 2017/10/04/ 07:47:57 - #<Admin:0x007f9f6695cc40> has operated : a resource is being modified
+```
+
+## 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/esminc/operate_do. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OperateDo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/esminc/operate_do/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 "operate_do"
+
+# 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/lib/operate_do/version.rb

@@ -0,0 +1,3 @@
+module OperateDo
+  VERSION = "0.1.0"
+end

data/lib/operate_do.rb

@@ -0,0 +1,171 @@
+require "operate_do/version"
+require 'logger'
+
+module OperateDo
+  OPERATE_DO_KEY = :operate_do_operator
+
+  class Config
+    attr_reader :logger_class, :logger_initialize_proc
+
+    def initialize
+      @logger_class = OperateDo::Logger
+      @logger_initialize_proc = nil
+    end
+
+    def logger=(logger_class)
+      @logger_class = logger_class
+    end
+
+    def logger_initialize_proc=(initialize_proc)
+      @logger_initialize_proc = initialize_proc
+    end
+  end
+
+
+  class Logger
+    def initialize(logger_instance = ::Logger.new(STDOUT))
+      logger_insance ||= ::Logger.new(STDOUT)
+      @logger_instance = logger_instance
+    end
+
+    def flush!(messages)
+      messages.each do |message|
+        @logger_instance.log log_level, build_message(message)
+      end
+    end
+
+    def build_message(message)
+      [
+        message.operate_at.strftime('%Y/%m/%d/ %H:%M:%S'),
+        "#{message.operator.operate_inspect} has operated : #{message.message}"
+      ].join(" - ")
+    end
+
+    def log_level
+      ::Logger::INFO
+    end
+  end
+
+  class Message
+    attr_reader :operator, :message, :operate_at
+
+    def initialize(operator, message, operate_at)
+      @operator   = operator
+      @message    = message
+      @operate_at = operate_at
+    end
+  end
+
+  class Recorder
+    def initialize
+      @operators = []
+      @messages  = []
+    end
+
+    def push_operator(operator)
+      @operators.push operator
+    end
+
+    def pop_operator
+      @operators.pop
+    end
+
+    def current_operator
+      @operators.last
+    end
+
+    def write(message, operate_at = Time.now)
+      @messages << OperateDo::Message.new(current_operator, message, operate_at)
+    end
+
+    def flush_message!
+      OperateDo.current_logger.flush!(@messages)
+      @messages.clear
+    end
+  end
+
+  class << self
+    def configure
+      @config ||= OperateDo::Config.new
+      yield @config if block_given?
+    end
+
+    def current_logger
+      configure unless @config
+      @current_logger ||= setup_logger
+    end
+
+    private def setup_logger
+      if @config.logger_initialize_proc
+        @config.logger_class.new(@config.logger_initialize_proc.call)
+      else
+        @config.logger_class.new
+      end
+    end
+
+    def push_operator(operator)
+      Thread.current[OPERATE_DO_KEY] ||= OperateDo::Recorder.new
+      Thread.current[OPERATE_DO_KEY].push_operator operator
+    end
+
+    def pop_operator
+      Thread.current[OPERATE_DO_KEY].pop_operator
+    end
+
+    def current_operator
+      Thread.current[OPERATE_DO_KEY]&.current_operator
+    end
+
+    def flush_message!
+      Thread.current[OPERATE_DO_KEY].flush_message!
+    end
+
+    def write(message, operate_at = Time.now)
+      Thread.current[OPERATE_DO_KEY].write(message, operate_at)
+    end
+  end
+
+  class OperateProxy
+    def initialize(operator)
+      @operator = operator
+    end
+
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      ret_val = nil
+
+      @operator.operate do
+        ret_val = @operator.__send__(method_name, *args, &block)
+      end
+
+      ret_val
+    end
+
+    def respond_to_missing?(symbol, include_private)
+      @operator.__send__(:respond_to_missing?, symbol, include_private)
+    end
+  end
+
+  module Operator
+    def operate
+      OperateDo.push_operator self
+
+      begin
+        yield
+      ensure
+        OperateDo.pop_operator
+        OperateDo.flush_message! unless OperateDo.current_operator
+      end
+    end
+
+    def self_operate
+      OperateDo::OperateProxy.new(self)
+    end
+
+    def operate_inspect
+      inspect
+    end
+  end
+end

data/operate_do.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "operate_do/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "operate_do"
+  spec.version       = OperateDo::VERSION
+  spec.authors       = ["takkanm"]
+  spec.email         = ["takkanm@gmail.com"]
+
+  spec.summary       = %q{operate_do is audit logger}
+  spec.description   = %q{operate_do is audit logger}
+  spec.homepage      = "https://github.com/esminc/operate_do"
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: operate_do
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- takkanm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: operate_do is audit logger
+email:
+- takkanm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/operate_do.rb
+- lib/operate_do/version.rb
+- operate_do.gemspec
+homepage: https://github.com/esminc/operate_do
+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.6.14
+signing_key: 
+specification_version: 4
+summary: operate_do is audit logger
+test_files: []