basic_assert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1efadba56623ddda47c99eebf7b6e157081e4646
+  data.tar.gz: a784c715b34b882a93c584c55b441346e59b608f
+SHA512:
+  metadata.gz: 50252d47a6d154eed63cb272f1c9b1abf1c635b28b1e2e5066af3d44e32d8e2769b14562276dd8c19185bca97a516fb9420c510af1ecbb08f94e20c6fb9effa7
+  data.tar.gz: dc06a5a7fe7c08b2cc8777d277cf601f331fe74edc35028daabcf9b11e7bc6360136ac50dab217376fb32a421cedfee1d7d17e9bf79eb820c6ef5232e8d656b6

data/README.md

@@ -0,0 +1,57 @@
+# Basic Assert
+
+A basic, customizable assertion library for lightweight pre and post-conditions checking.
+
+## Installation
+
+Just add this line to your application's Gemfile:
+
+```ruby
+gem 'basic_assert'
+```
+
+## What's this for ?
+
+TODO: add rationale and examples
+
+## Usage
+
+In order to use this library you need to include an *asserter* and a *raiser* in the current `self` context.
+
+In, say, a Rails project, you may just add an initializer like
+
+```ruby
+class Object
+  case Rails.configuration.assert_mode
+  when :raise
+    include BasicAssert::ExceptionRaiser
+    include BasicAssert::BasicAsserter
+  else # :ignore
+    include BasicAssert::NoopAsserter
+  end
+end
+```
+
+or define your own asserting policies and side effects, or override them for the given `self` where appropriate.
+
+An *asserter* is a concern exposing an `assert()` function responsible of evaluating the given condition; a *raiser* is a concern exposing an `assert_raise()` function responsible of managing the actual condition failure.
+
+Currently, the following asserters and raisers are defined:
+- `BasicAsserter`: exposes plain and block versions, with or without message
+- `NoopAsserter`: does nothing, blocks are never evaluated in this case
+- `ExceptionRaiser`: raises an `ExceptionRaiser::AssertionException`
+
+
+## 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/maxjanes/basic_assert.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/basic_assert/basic_asserter.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+
+module BasicAssert
+  module BasicAsserter
+    extend ActiveSupport::Concern
+
+    included do
+      # check a pre/post-condition, used as:
+      # - assert condition
+      # - assert condition, message
+      # - assert { condition }
+      # - assert(message) { condition }
+      def assert(*args)
+        if block_given?
+          assert yield, args[0]
+        elsif !args[0]
+          assert_raise args[1]
+        end
+      end
+    end
+  end
+end

data/lib/basic_assert/exception_raiser.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module BasicAssert
+  # ExceptionRaiser's exception
+  # you'll should never rescue this in user code; indeed, ceci n'est pas un StandardError ...
+  class AssertionException < Exception
+  end
+
+  module ExceptionRaiser
+    extend ActiveSupport::Concern
+
+    included do
+      def assert_raise(message)
+        raise AssertionException, message || caller_locations(2..2)
+      end
+    end
+  end
+end

data/lib/basic_assert/noop_asserter.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module BasicAssert
+  module NoopAsserter
+    extend ActiveSupport::Concern
+
+    included do
+      def assert(*args)
+        # do nothing
+      end
+    end
+  end
+end

data/lib/basic_assert/version.rb

@@ -0,0 +1,3 @@
+module BasicAssert
+  VERSION = '0.1.0'.freeze
+end

data/lib/basic_assert.rb

@@ -0,0 +1,22 @@
+require 'basic_assert/version'
+require 'basic_assert/exception_raiser'
+require 'basic_assert/basic_asserter'
+require 'basic_assert/noop_asserter'
+
+# require_relative '../../lib/asserts'
+#
+
+
+# basic_assert
+#
+# assert_raise
+#
+# case Rails.configuration.assert_mode
+# when :raise
+#     include Asserts::ExceptionRaiser
+#     include Asserts::Methods
+#
+
+# # Set assertion mode, see assert initializer
+#     config.assert_mode = :ignore
+#

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: basic_assert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Massimiliano Janes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: 
+email:
+- massimiliano.janes@uqido.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/basic_assert.rb
+- lib/basic_assert/basic_asserter.rb
+- lib/basic_assert/exception_raiser.rb
+- lib/basic_assert/noop_asserter.rb
+- lib/basic_assert/version.rb
+homepage: https://github.com/maxjanes/basic_assert
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A basic, customizable assertion library for lightweight pre-postconditions
+  checking
+test_files: []