disallow 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: 78d82121c17085826bebcec20150b06037219110d8efa3281dc6234a7b2a4cee
4
+ data.tar.gz: e54ecfbe464d81e39a2db06194bf9a763d8d4968a9baf4783a157500888cec2c
5
+ SHA512:
6
+ metadata.gz: '08f0c70d939e2d7baf31a043b3cfa6b5ec8f267360b0fc475a03be1008527062f8a875e1c7d5bbadc65ae2f6be7bcc7745000ea93d4cff946133ddde22907bdd'
7
+ data.tar.gz: d3126ba669df9c6c15bd3b94d4aadc37d11dbc55261760f41510f5644375d542568e0319fecbfea1e10a35ed6a5f77aa387a997c00a46db05858b50252abad0a
data/.gitignore ADDED
@@ -0,0 +1,11 @@
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
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ ---
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.6.8
6
+ before_install: gem install bundler -v 2.1.4
@@ -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 sh07e1916@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 disallow.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
data/Gemfile.lock ADDED
@@ -0,0 +1,58 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ disallow (0.1.0)
5
+ activerecord
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ activemodel (6.1.7.3)
11
+ activesupport (= 6.1.7.3)
12
+ activerecord (6.1.7.3)
13
+ activemodel (= 6.1.7.3)
14
+ activesupport (= 6.1.7.3)
15
+ activesupport (6.1.7.3)
16
+ concurrent-ruby (~> 1.0, >= 1.0.2)
17
+ i18n (>= 1.6, < 2)
18
+ minitest (>= 5.1)
19
+ tzinfo (~> 2.0)
20
+ zeitwerk (~> 2.3)
21
+ concurrent-ruby (1.2.2)
22
+ diff-lcs (1.5.0)
23
+ i18n (1.13.0)
24
+ concurrent-ruby (~> 1.0)
25
+ minitest (5.18.0)
26
+ rake (12.3.3)
27
+ rspec (3.12.0)
28
+ rspec-core (~> 3.12.0)
29
+ rspec-expectations (~> 3.12.0)
30
+ rspec-mocks (~> 3.12.0)
31
+ rspec-core (3.12.2)
32
+ rspec-support (~> 3.12.0)
33
+ rspec-expectations (3.12.3)
34
+ diff-lcs (>= 1.2.0, < 2.0)
35
+ rspec-support (~> 3.12.0)
36
+ rspec-mocks (3.12.5)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.12.0)
39
+ rspec-support (3.12.0)
40
+ sqlite3 (1.4.2)
41
+ tzinfo (2.0.6)
42
+ concurrent-ruby (~> 1.0)
43
+ with_model (2.1.6)
44
+ activerecord (>= 5.2)
45
+ zeitwerk (2.6.8)
46
+
47
+ PLATFORMS
48
+ ruby
49
+
50
+ DEPENDENCIES
51
+ disallow!
52
+ rake (~> 12.0)
53
+ rspec (~> 3.0)
54
+ sqlite3
55
+ with_model
56
+
57
+ BUNDLED WITH
58
+ 2.1.4
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2023 a5-stable
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.
data/README.md ADDED
@@ -0,0 +1,79 @@
1
+ # Disallow
2
+
3
+ `disallow` gem is a utility for Ruby on Rails that allows you to restrict the usage of default scopes and callbacks in your ActiveRecord models.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'disallow'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle install
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install disallow
20
+
21
+ ## Usage
22
+
23
+ ### Callbacks
24
+
25
+ You can use this gem by just adding the methods to your model.
26
+
27
+ 1. To disallow all callbacks in a model, use disallow_callbacks!:
28
+ ```
29
+ class MyModel < ActiveRecord::Base
30
+ disallow_callbacks!
31
+
32
+ before_save :do_something
33
+ #=> raise Disallow::CallbackError
34
+ end
35
+ ```
36
+
37
+ 2. To disallow specific callbacks, use disallow_XXX_callbacks!, where XXX is the name of the callback:
38
+ ```
39
+ class MyModel < ActiveRecord::Base
40
+ disallow_before_save_allbacks!
41
+ disallow_after_create_callbacks!
42
+
43
+ before_save :do_something
44
+ #=> raise Disallow::CallbackError
45
+
46
+ after_save :do_something
47
+ #=> ok
48
+ end
49
+ ```
50
+
51
+ ### scopes
52
+
53
+ To disallow default scope definitions, use disallow_default_scope!:
54
+ ```
55
+ class MyModel < ActiveRecord::Base
56
+ disallow_default_scope!
57
+ default_scope { where(title: nil) }
58
+ #=> raise Disallow::DefaultScopeError
59
+ end
60
+ ```
61
+
62
+ ## Development
63
+
64
+ 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.
65
+
66
+ 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).
67
+
68
+ ## Contributing
69
+
70
+ Bug reports and pull requests are welcome on GitHub at https://github.com/a5-stable/disallow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/disallow/blob/master/CODE_OF_CONDUCT.md).
71
+
72
+
73
+ ## License
74
+
75
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
76
+
77
+ ## Code of Conduct
78
+
79
+ Everyone interacting in the Disallow project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/a5-stable/disallow/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 "disallow"
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
data/disallow.gemspec ADDED
@@ -0,0 +1,31 @@
1
+ require_relative 'lib/disallow/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "disallow"
5
+ spec.version = Disallow::VERSION
6
+ spec.authors = ["a5-stable"]
7
+ spec.email = ["sh07e1916@gmail.com"]
8
+
9
+ spec.summary = "disallow certain features in ActiveRecord models such as `default_scope`` and `callbacks`"
10
+ spec.homepage = "https://github.com/a5-stable/disallow"
11
+ spec.license = "MIT"
12
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
13
+
14
+ spec.metadata["homepage_uri"] = spec.homepage
15
+ spec.metadata["source_code_uri"] = "https://github.com/a5-stable/disallow"
16
+ spec.metadata["changelog_uri"] = "https://github.com/a5-stable/disallow"
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('activerecord')
28
+
29
+ spec.add_development_dependency('with_model')
30
+ spec.add_development_dependency "sqlite3"
31
+ end
@@ -0,0 +1,42 @@
1
+
2
+ require 'disallow/exceptions'
3
+
4
+ module Disallow
5
+ module Callbacks
6
+ #
7
+ # disallow specific callbacks
8
+ # CALLBACKS = [
9
+ # :after_initialize, :after_find, :after_touch, :before_validation, :after_validation,
10
+ # :before_save, :around_save, :after_save, :before_create, :around_create,
11
+ # :after_create, :before_update, :around_update, :after_update,
12
+ # :before_destroy, :around_destroy, :after_destroy, :after_commit, :after_rollback
13
+ # ]
14
+ #
15
+ ActiveRecord::Callbacks::CALLBACKS.each do |callback|
16
+ kind, name = callback.to_s.split('_').map(&:to_sym)
17
+ method_name = "disallow_#{callback}_callbacks!"
18
+ flag_name = method_name.gsub("!", "")
19
+
20
+ define_method(method_name) do |*args|
21
+ if public_send("_#{name}_callbacks").any? { |c| c.kind == kind && c.name == name }
22
+ raise Disallow::CallbackError.new(self.name, callback)
23
+ end
24
+
25
+ instance_variable_set("@#{flag_name}", true)
26
+ end
27
+
28
+ define_method(callback) do |*args|
29
+ if instance_variable_get("@#{flag_name}")
30
+ raise Disallow::CallbackError.new(self.name, callback)
31
+ else
32
+ super(*args)
33
+ end
34
+ end
35
+ end
36
+
37
+ # disallow all callbacks
38
+ def disallow_callbacks!
39
+ raise Disallow::CallbackError.new(self.name, nil) if __callbacks.any?
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,17 @@
1
+ module Disallow
2
+ class Error < StandardError
3
+ end
4
+
5
+ class DefaultScopeError < Error
6
+ def initialize(class_name)
7
+ super("default_scope is not allowed on #{class_name}")
8
+ end
9
+ end
10
+
11
+ class CallbackError < Error
12
+ def initialize(class_name, callback_name)
13
+ sbj = callback_name ? "#{callback_name} callback is" : "all callbacks are"
14
+ super("#{sbj} not allowed on #{class_name}")
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,21 @@
1
+ require 'disallow/exceptions'
2
+
3
+ module Disallow
4
+ module Scopes
5
+ def disallow_default_scope!(options = {})
6
+ if default_scopes.present?
7
+ raise Disallow::DefaultScopeError.new(name)
8
+ end
9
+
10
+ @disallow_default_scope = true
11
+ end
12
+
13
+ def default_scope(*args)
14
+ if @disallow_default_scope
15
+ raise Disallow::DefaultScopeError.new(name)
16
+ end
17
+
18
+ super(*args)
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,3 @@
1
+ module Disallow
2
+ VERSION = "0.1.0"
3
+ end
data/lib/disallow.rb ADDED
@@ -0,0 +1,20 @@
1
+ require "active_record"
2
+ require "disallow/exceptions"
3
+ require "disallow/scopes"
4
+ require "disallow/callbacks"
5
+ require "disallow/version"
6
+
7
+ module Disallow
8
+ module Model
9
+ module ClassMethods
10
+ include Disallow::Callbacks
11
+ include Disallow::Scopes
12
+ end
13
+
14
+ def self.included(base)
15
+ base.extend ClassMethods
16
+ end
17
+ end
18
+
19
+ ActiveRecord::Base.include Disallow::Model
20
+ end
metadata ADDED
@@ -0,0 +1,106 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: disallow
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - a5-stable
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-05-15 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: with_model
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: sqlite3
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
+ description:
56
+ email:
57
+ - sh07e1916@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - Gemfile.lock
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - disallow.gemspec
74
+ - lib/disallow.rb
75
+ - lib/disallow/callbacks.rb
76
+ - lib/disallow/exceptions.rb
77
+ - lib/disallow/scopes.rb
78
+ - lib/disallow/version.rb
79
+ homepage: https://github.com/a5-stable/disallow
80
+ licenses:
81
+ - MIT
82
+ metadata:
83
+ homepage_uri: https://github.com/a5-stable/disallow
84
+ source_code_uri: https://github.com/a5-stable/disallow
85
+ changelog_uri: https://github.com/a5-stable/disallow
86
+ post_install_message:
87
+ rdoc_options: []
88
+ require_paths:
89
+ - lib
90
+ required_ruby_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: 2.3.0
95
+ required_rubygems_version: !ruby/object:Gem::Requirement
96
+ requirements:
97
+ - - ">="
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ requirements: []
101
+ rubygems_version: 3.0.3.1
102
+ signing_key:
103
+ specification_version: 4
104
+ summary: disallow certain features in ActiveRecord models such as `default_scope``
105
+ and `callbacks`
106
+ test_files: []