model_guard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c29591b1550e24e865cea207fd16c5411c82590af263b183e6e57e49aeeb2926
+  data.tar.gz: 517f5c5aaeea46026e48db66f9c282760fee77c6ba1b965d88dd08048a45734f
+SHA512:
+  metadata.gz: 54d4f71aafac8ba06ea5b3122a3d1597748137c87e63642cca5f294373cfc0451ef9fd0f9690b0f3cfa14f980e41180b42bcb36575007753b9ee857cc96693a6
+  data.tar.gz: 299343b6d88f4fd44a91f0b136f7c105e74e326400f4bb3a6e761667c97c80f048023516ecd79736310410f6ac90c9e9c900a83ba88ceead8cd34bf1c4ad4104

data/.rspec

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+gemspec
+
+group :development, :test do
+  gem "factory_bot"
+end
+
+group :test do
+  gem "faker"
+  gem "rspec-rails"
+  gem "shoulda-matchers"
+end

data/Gemfile.lock

@@ -0,0 +1,145 @@
+PATH
+  remote: .
+  specs:
+    model_guard (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    factory_bot (6.4.2)
+      activesupport (>= 5.0.0)
+    faker (3.2.2)
+      i18n (>= 1.8.11, < 2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.9.1)
+      rdoc
+      reline (>= 0.3.8)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    nokogiri (1.15.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.5-x86_64-linux)
+      racc (~> 1.4)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.1.0)
+    rdoc (6.6.0)
+      psych (>= 4.0.0)
+    reline (0.4.0)
+      io-console (~> 0.5)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.1.0)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    shoulda-matchers (5.3.0)
+      activesupport (>= 5.2.0)
+    sqlite3 (1.6.8-arm64-darwin)
+    sqlite3 (1.6.8-x86_64-linux)
+    stringio (3.0.9)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webrick (1.8.1)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 7)
+  factory_bot
+  faker
+  model_guard!
+  rspec-rails
+  shoulda-matchers
+  sqlite3
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Martin Moen Wulffeld
+
+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,65 @@
+# model_guard
+
+[![Gem Version](http://img.shields.io/gem/v/model_guard.svg)](https://rubygems.org/gems/model_guard)
+[![Build Status](https://github.com/wulffeld/model_guard/workflows/CI/badge.svg?branch=main)](https://github.com/wulffeld/model_guard/actions?query=workflow%3ACI)
+[![Gem Downloads](https://img.shields.io/gem/dt/model_guard.svg)](https://rubygems.org/gems/model_guard)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7b3c646f87ca2d6d691c/maintainability)](https://codeclimate.com/github/wulffeld/model_guard)
+
+Two small concerns for ActiveRecord that can guard against direct creates, updates and destroys. Handy if you want to force the use of directing all
+persistence through service objects and guard against accidental CRUD operations
+in the console.
+
+## Installation
+
+Include the gem in your Gemfile:
+
+```ruby
+gem "model_guard"
+```
+
+## Usage
+
+### Create / update protection
+
+Protects against #save, #save!, #update, #update!. Instead use #guarded_save, #guarded_save!, #guarded_update, #guarded_update! or #guarded_create.
+
+```ruby
+class User < ActiveRecord::Base
+  include ModelGuard::CreateOrUpdateGuard
+end
+
+CreateGuardedUser.guarded_create(name: "Joe")
+user.guarded_update(name: "Joe")
+```
+
+or
+
+```ruby
+user.allow_direct_create_or_update!
+user.save
+```
+
+### Destroy protection
+
+```ruby
+class User < ActiveRecord::Base
+  include ModelGuard::DestroyGuard
+end
+```
+
+Will raise an exception when calling `destroy` on an instance of `User`. Instead use `guarded_destroy`, `guarded_destroy!` or `guarded_delete`.
+
+```ruby
+user.guarded_destroy
+user.guarded_destroy!
+```
+
+## Support
+
+Submit suggestions or feature requests as a GitHub Issue or Pull
+Request (preferred). If you send a pull request, remember to update the
+corresponding unit tests and/or add new tests.
+
+## Versioning
+
+Semantic Versioning 2.0 as defined at <http://semver.org>.

data/Rakefile

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

data/lib/model_guard/concerns/create_or_update_guard.rb

@@ -0,0 +1,70 @@
+module ModelGuard
+  class DirectCreateOrUpdateException < Exception; end
+
+  module CreateOrUpdateGuard
+    extend ActiveSupport::Concern
+
+    included do
+      class_eval do
+        attr_accessor :model_guard_save_okay
+
+        before_create do
+          raise(DirectCreateOrUpdateException.new("Can't create object #{self.class.to_s} directly.")) unless @model_guard_save_okay
+        end
+
+        after_create do
+          disallow_direct_create_or_update!
+        end
+
+        before_update do
+          raise(DirectCreateOrUpdateException.new("Can't update object #{self.class.to_s} directly.")) unless @model_guard_save_okay
+        end
+
+        after_update do
+          disallow_direct_create_or_update!
+        end
+
+        def allow_direct_create_or_update!
+          @model_guard_save_okay = true
+        end
+
+        def disallow_direct_create_or_update!
+          @model_guard_save_okay = false
+        end
+
+        def guarded_save
+          allow_direct_create_or_update!
+          save
+        end
+
+        def guarded_save!
+          allow_direct_create_or_update!
+          save!
+        end
+
+        def guarded_update(attributes)
+          allow_direct_create_or_update!
+          update(attributes)
+        end
+
+        def guarded_update!(attributes)
+          allow_direct_create_or_update!
+          update!(attributes)
+        end
+
+        def self.guarded_create(attributes = nil, &block)
+          if attributes.is_a?(Array)
+            attributes.collect do |attr|
+              guarded_create(attr, &block)
+            end
+          else
+            object = new(attributes, &block)
+            object.allow_direct_create_or_update!
+            object.save!
+            object
+          end
+        end
+      end
+    end
+  end
+end

data/lib/model_guard/concerns/destroy_guard.rb

@@ -0,0 +1,42 @@
+module ModelGuard
+  class DirectDestroyException < Exception; end
+
+  module DestroyGuard
+    extend ActiveSupport::Concern
+
+    included do
+      class_eval do
+        attr_accessor :model_guard_destroy_okay
+
+        before_destroy do
+          raise(DirectDestroyException.new("Can't destroy #{self.class.to_s} directly.")) unless @model_guard_destroy_okay
+        end
+
+        def allow_direct_destroy!
+          @model_guard_destroy_okay = true
+        end
+
+        def disallow_direct_destroy!
+          @model_guard_destroy_okay = false
+        end
+
+        def guarded_destroy
+          allow_direct_destroy! and destroy
+        end
+
+        def guarded_destroy!
+          allow_direct_destroy! and destroy!
+        end
+
+        def guarded_delete
+          allow_direct_destroy! and delete
+        end
+
+        def delete(**args)
+          raise(DirectDestroyException.new("Can't delete #{self.class.to_s} directly.")) unless @model_guard_destroy_okay
+          super(args)
+        end
+      end
+    end
+  end
+end

data/lib/model_guard/version.rb

@@ -0,0 +1,3 @@
+module ModelGuard
+  VERSION = "1.0.0"
+end

data/lib/model_guard.rb

@@ -0,0 +1,4 @@
+module ModelGuard
+  autoload :CreateOrUpdateGuard, "model_guard/concerns/create_or_update_guard"
+  autoload :DestroyGuard, "model_guard/concerns/destroy_guard"
+end

data/model_guard.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/model_guard/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "model_guard"
+  spec.version = ModelGuard::VERSION
+  spec.authors = ["Martin Moen Wulffeld"]
+  spec.email = ["martin@wulffeld.dk"]
+
+  spec.summary = "Various concerns for ActiveModel."
+  spec.description = "Sometimes you want to protect your models from being updated or destroyed directly. This gem provides concerns for that."
+  spec.homepage = "https://github.com/wulffeld/model_guard"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wulffeld/model_guard"
+  spec.metadata["changelog_uri"] = "https://github.com/wulffeld/model_guard/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activerecord", "~> 7"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: model_guard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Martin Moen Wulffeld
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !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: Sometimes you want to protect your models from being updated or destroyed
+  directly. This gem provides concerns for that.
+email:
+- martin@wulffeld.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/model_guard.rb
+- lib/model_guard/concerns/create_or_update_guard.rb
+- lib/model_guard/concerns/destroy_guard.rb
+- lib/model_guard/version.rb
+- model_guard.gemspec
+homepage: https://github.com/wulffeld/model_guard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wulffeld/model_guard
+  source_code_uri: https://github.com/wulffeld/model_guard
+  changelog_uri: https://github.com/wulffeld/model_guard/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Various concerns for ActiveModel.
+test_files: []