safer_initialize 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1d1a0a1379fa5b8961957236e9d8874628778b5f0efcb0797dacd212f1f945f3
4
+ data.tar.gz: '08ebcf3e47c5094f658de8b8f410fbae7703a4b0de277dbbff348bf9759731e1'
5
+ SHA512:
6
+ metadata.gz: 011f7d7ca6628edf1bf8adb0f7eead6cbeb92e6d66f764c7552a10bbef6e05cbda521d5b8d5e9be9a23271ec71153d5c1d131c7b32bbee1943f00456cb13efc8
7
+ data.tar.gz: cc5b68986507e190b4162c258a3fc107265e78b29f205d08ca18e97161d518b403129fbe40396f59376a7ee544291101a5cd2ab5eb7de5c4292f3c51917dacf8
@@ -0,0 +1,12 @@
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
+ Gemfile.lock
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,6 @@
1
+ ---
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.7.1
6
+ before_install: gem install bundler -v 2.1.4
@@ -0,0 +1,3 @@
1
+ ## 0.1.0
2
+
3
+ - First Release
@@ -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 lala.akira@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 [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in safer_initialize.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 aki
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,83 @@
1
+ # SaferInitialize
2
+
3
+ Make ActiveRecord initialization less dangerous.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'safer_initialize'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle install
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install safer_initialize
20
+
21
+ ## Usage
22
+
23
+ In `config/initializers/safer_initialize.rb`:
24
+
25
+ ```ruby
26
+ SaferInitialize::Globals.attribute :tenant
27
+ ```
28
+
29
+ In `app/models/project.rb`:
30
+
31
+ ```ruby
32
+ belongs_to :tenant
33
+
34
+ scope :active, -> { where(deleted_at: nil) }
35
+
36
+ safer_initialize message: 'Forbidden tenant!' do |project|
37
+ !SaferInitialize::Globals.tenant || SaferInitialize::Globals.tenant == project.tenant
38
+ end
39
+ safer_initialize :active?, message: 'Not active project!'
40
+
41
+ def active?
42
+ deleted_at.nil?
43
+ end
44
+ ```
45
+
46
+ In `app/controllers/application_controller.rb`:
47
+
48
+ ```ruby
49
+ before_action :set_tenant
50
+
51
+ private
52
+
53
+ def set_tenant
54
+ SaferInitialize::Globals.tenant = current_tenant
55
+ end
56
+ ```
57
+
58
+ In `app/views/projects/index.html.haml`:
59
+
60
+ ```haml
61
+ # raise error
62
+ - current_tenant.projects.each do |project|
63
+ = project.name
64
+
65
+ - Project.active.each do |project|
66
+ = project.name
67
+
68
+ # good
69
+ - current_tenant.projects.active.each do |project|
70
+ = project.name
71
+
72
+ - SaferInitialize.with_safe do
73
+ - current_tenant.projecst.each do |project|
74
+ = project.name
75
+ ```
76
+
77
+ ## License
78
+
79
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
80
+
81
+ ## Code of Conduct
82
+
83
+ Everyone interacting in the SaferInitialize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aki77/safer_initialize/blob/master/CODE_OF_CONDUCT.md).
@@ -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
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "safer_initialize"
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__)
@@ -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,13 @@
1
+ require 'safer_initialize/version'
2
+ require 'safer_initialize/globals'
3
+ require 'safer_initialize/railtie'
4
+
5
+ module SaferInitialize
6
+ class Error < StandardError; end
7
+
8
+ module_function
9
+
10
+ def with_safe(&block)
11
+ Globals.set(__safe: true, &block)
12
+ end
13
+ end
@@ -0,0 +1,18 @@
1
+ module SaferInitialize
2
+ module ActiveRecord
3
+ module Extensions
4
+ extend ActiveSupport::Concern
5
+
6
+ class_methods do
7
+ def safer_initialize(filter = nil, message: 'initialize error', &block)
8
+ after_initialize do |object|
9
+ unless SaferInitialize::Globals.safe?
10
+ result = filter ? object.send(filter) : object.instance_exec(object, &block)
11
+ raise SaferInitialize::Error, message unless result
12
+ end
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,11 @@
1
+ require 'active_support'
2
+
3
+ module SaferInitialize
4
+ class Globals < ActiveSupport::CurrentAttributes
5
+ attribute :__safe
6
+
7
+ def safe?
8
+ !!__safe
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+ require 'rails/railtie'
3
+
4
+ module SaferInitialize
5
+ class Railtie < Rails::Railtie
6
+ ActiveSupport.on_load :active_record do
7
+ require 'safer_initialize/active_record/extensions'
8
+ include SaferInitialize::ActiveRecord::Extensions
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,3 @@
1
+ module SaferInitialize
2
+ VERSION = '0.1.0'
3
+ end
@@ -0,0 +1,28 @@
1
+ require_relative 'lib/safer_initialize/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "safer_initialize"
5
+ spec.version = SaferInitialize::VERSION
6
+ spec.authors = ["aki77"]
7
+ spec.email = ["aki77@users.noreply.github.com"]
8
+
9
+ spec.summary = %q{Make ActiveRecord initialization less dangerous.}
10
+ spec.description = %q{Make ActiveRecord initialization less dangerous.}
11
+ spec.homepage = "https://github.com/aki77/safer_initialize"
12
+ spec.license = "MIT"
13
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
14
+
15
+ spec.metadata["homepage_uri"] = spec.homepage
16
+ spec.metadata["source_code_uri"] = spec.homepage
17
+
18
+ # Specify which files should be added to the gem when it is released.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
21
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
22
+ end
23
+ spec.bindir = "exe"
24
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
+ spec.require_paths = ["lib"]
26
+
27
+ spec.add_dependency 'rails', '>= 6.0.0'
28
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: safer_initialize
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - aki77
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-06-16 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 6.0.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 6.0.0
27
+ description: Make ActiveRecord initialization less dangerous.
28
+ email:
29
+ - aki77@users.noreply.github.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".gitignore"
35
+ - ".rspec"
36
+ - ".travis.yml"
37
+ - CHANGELOG.md
38
+ - CODE_OF_CONDUCT.md
39
+ - Gemfile
40
+ - LICENSE.txt
41
+ - README.md
42
+ - Rakefile
43
+ - bin/console
44
+ - bin/setup
45
+ - lib/safer_initialize.rb
46
+ - lib/safer_initialize/active_record/extensions.rb
47
+ - lib/safer_initialize/globals.rb
48
+ - lib/safer_initialize/railtie.rb
49
+ - lib/safer_initialize/version.rb
50
+ - safer_initialize.gemspec
51
+ homepage: https://github.com/aki77/safer_initialize
52
+ licenses:
53
+ - MIT
54
+ metadata:
55
+ homepage_uri: https://github.com/aki77/safer_initialize
56
+ source_code_uri: https://github.com/aki77/safer_initialize
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: 2.5.0
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.2
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Make ActiveRecord initialization less dangerous.
76
+ test_files: []