safer_initialize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d1a0a1379fa5b8961957236e9d8874628778b5f0efcb0797dacd212f1f945f3
+  data.tar.gz: '08ebcf3e47c5094f658de8b8f410fbae7703a4b0de277dbbff348bf9759731e1'
+SHA512:
+  metadata.gz: 011f7d7ca6628edf1bf8adb0f7eead6cbeb92e6d66f764c7552a10bbef6e05cbda521d5b8d5e9be9a23271ec71153d5c1d131c7b32bbee1943f00456cb13efc8
+  data.tar.gz: cc5b68986507e190b4162c258a3fc107265e78b29f205d08ca18e97161d518b403129fbe40396f59376a7ee544291101a5cd2ab5eb7de5c4292f3c51917dacf8

data/.gitignore

@@ -0,0 +1,12 @@
+/.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/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First Release

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 lala.akira@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in safer_initialize.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 aki
+
+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,83 @@
+# SaferInitialize
+
+Make ActiveRecord initialization less dangerous.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safer_initialize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install safer_initialize
+
+## Usage
+
+In `config/initializers/safer_initialize.rb`:
+
+```ruby
+SaferInitialize::Globals.attribute :tenant
+```
+
+In `app/models/project.rb`:
+
+```ruby
+belongs_to :tenant
+
+scope :active, -> { where(deleted_at: nil) }
+
+safer_initialize message: 'Forbidden tenant!' do |project|
+  !SaferInitialize::Globals.tenant || SaferInitialize::Globals.tenant == project.tenant
+end
+safer_initialize :active?, message: 'Not active project!'
+
+def active?
+  deleted_at.nil?
+end
+```
+
+In `app/controllers/application_controller.rb`:
+
+```ruby
+before_action :set_tenant
+
+private
+
+def set_tenant
+  SaferInitialize::Globals.tenant = current_tenant
+end
+```
+
+In `app/views/projects/index.html.haml`:
+
+```haml
+# raise error
+- current_tenant.projects.each do |project|
+  = project.name
+
+- Project.active.each do |project|
+  = project.name
+
+# good
+- current_tenant.projects.active.each do |project|
+  = project.name
+
+- SaferInitialize.with_safe do
+  - current_tenant.projecst.each do |project|
+    = project.name
+```
+
+## 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 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).

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 "safer_initialize"
+
+# 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/safer_initialize.rb

@@ -0,0 +1,13 @@
+require 'safer_initialize/version'
+require 'safer_initialize/globals'
+require 'safer_initialize/railtie'
+
+module SaferInitialize
+  class Error < StandardError; end
+
+  module_function
+
+  def with_safe(&block)
+    Globals.set(__safe: true, &block)
+  end
+end

data/lib/safer_initialize/active_record/extensions.rb

@@ -0,0 +1,18 @@
+module SaferInitialize
+  module ActiveRecord
+    module Extensions
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def safer_initialize(filter = nil, message: 'initialize error', &block)
+          after_initialize do |object|
+            unless SaferInitialize::Globals.safe?
+              result = filter ? object.send(filter) : object.instance_exec(object, &block)
+              raise SaferInitialize::Error, message unless result
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/safer_initialize/globals.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+
+module SaferInitialize
+  class Globals < ActiveSupport::CurrentAttributes
+    attribute :__safe
+
+    def safe?
+      !!__safe
+    end
+  end
+end

data/lib/safer_initialize/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'rails/railtie'
+
+module SaferInitialize
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load :active_record do
+      require 'safer_initialize/active_record/extensions'
+      include SaferInitialize::ActiveRecord::Extensions
+    end
+  end
+end

data/lib/safer_initialize/version.rb

@@ -0,0 +1,3 @@
+module SaferInitialize
+  VERSION = '0.1.0'
+end

data/safer_initialize.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/safer_initialize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safer_initialize"
+  spec.version       = SaferInitialize::VERSION
+  spec.authors       = ["aki77"]
+  spec.email         = ["aki77@users.noreply.github.com"]
+
+  spec.summary       = %q{Make ActiveRecord initialization less dangerous.}
+  spec.description   = %q{Make ActiveRecord initialization less dangerous.}
+  spec.homepage      = "https://github.com/aki77/safer_initialize"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'rails', '>= 6.0.0'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: safer_initialize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aki77
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Make ActiveRecord initialization less dangerous.
+email:
+- aki77@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safer_initialize.rb
+- lib/safer_initialize/active_record/extensions.rb
+- lib/safer_initialize/globals.rb
+- lib/safer_initialize/railtie.rb
+- lib/safer_initialize/version.rb
+- safer_initialize.gemspec
+homepage: https://github.com/aki77/safer_initialize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aki77/safer_initialize
+  source_code_uri: https://github.com/aki77/safer_initialize
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Make ActiveRecord initialization less dangerous.
+test_files: []