assume 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d8e6d1cef180511bada22d9611eddd535a1f929ca4a38aae70800d66653411e
-  data.tar.gz: ab8ece061eea9f1b900f991ab2197a2ae09e6d832e1e552240bf36651768a6ee
+  metadata.gz: a7a6101652f07a693d31f7070d5e18dd06927742375ec9e0e4ee57a1b77b2ca3
+  data.tar.gz: 72dc5f2f56bdd8ec523e16e445c9146e6f64243bafb6cdd17bb7c7581d6299c2
 SHA512:
-  metadata.gz: 3586e10e23cb079f8379235a829dd107106f2aaf444903c8f4a8536522e583e38ed102c1a509673fd660f8e7be5791e0db57839078044ca427b1deeb5a5543d1
-  data.tar.gz: 94fba0ee942779ea52e89342b28ddf358f7c0a0f3ac09440c65a883a21ef4b541c2fd4e3818396e8464a2854f0a11283ba33cb0bae30b41edf777b9370132178
+  metadata.gz: 4721d719e7d90269d9c4d79b557c7ce04c739b277b9fa495db3757a65fcc428ceb6439e03f3a107253b583247facf4f8894a0a962dbc98825160e9e440b0a696
+  data.tar.gz: d2671defd34553365cbf23708a46ea9aabd0d715c9e3145c5a08fca63664707bf327b84cbbb2ff6176dc6eeb1800010cb88f7168dba9b58a608054f1feddf4d8

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.5

data/CHANGES.md

@@ -1,2 +1,5 @@
+### 0.1.1
+ - prevent misconfiguration of handler with an exception
+
 ### 0.1.0
  - initial release

data/Gemfile.lock

@@ -1,25 +1,18 @@
 PATH
   remote: .
   specs:
-    assume (0.1.0)
+    assume (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
     diff-lcs (1.4.4)
     io-console (0.5.6)
     irb (1.2.7)
       reline (>= 0.1.5)
-    parallel (1.20.1)
-    parser (2.7.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
     rake (10.5.0)
-    regexp_parser (2.0.0)
     reline (0.1.9)
       io-console (~> 0.5)
-    rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -33,19 +26,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.6.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.5)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -56,7 +36,6 @@ DEPENDENCIES
   irb
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -2,6 +2,10 @@
 
 Assume is a tool that helps you record your assumptions about code directly in the code you're writing. It is similiar in functionality to and directly inspired by [solid_assert](https://rubygems.org/gems/solid_assert).
 
+As opposed to solid_assert, this gem has you write your assumptions in ruby code blocks.
+The idea behind this is that the assumption does not need to be evaluated in your production/release environment, reserving expensive checks for development/test environments which only
+affect developers.
+
 ## What?
 
 We make lots of assumptions when we write code. [Programming with assertions](https://docs.oracle.com/javase/8/docs/technotes/guides/language/assert.html) is a technique that helps you catch problems with your assumptions earlier in the development process.  
@@ -9,7 +13,7 @@ We make lots of assumptions when we write code. [Programming with assertions](ht
 Assertions live in a subtle space between testing your code explicitly and
 raising exceptions to enforce your api behaviour or handle edge cases. It is not a replacement for either.
 
-This gem is an attempt to make the concept less computer-sciency and more english, encouraging you to think about and record your assumptions as you go, maybe even leave them in the codebase for your colleagues to find, so they may understand your thinking, and thus your code, better.
+This gem is an attempt to make the concept less computer-sciency and more english, encouraging you to think about and record your assumptions as you go and leave them in the codebase for your colleagues to find, so they may understand your thinking, and thus your code, better.
 
 ## Why tho?
 
@@ -30,7 +34,7 @@ end
 
 We know we don't need to perform another check on i, as we've exhausted all other options, but what happens when 'Dave' comes along next month and extends the enum to allow a 4?
 
-By recording our assumption in code, 'Dave' will (hopefully) test his new enum and quickly discover that he broke our previous assumptions.
+By recording our assumption in code, 'Dave' will (hopefully) test his new enum value and quickly discover that he broke our previous assumption.
 
 If he happens to read our code, it will say *right there in the code* that he's broken it, and he'll know to fix it.
 
@@ -72,17 +76,32 @@ You're doing some control flow you know will never happen
   def something(arg)
     case arg
     when 1
+      :option1
     when 2
+      :option2
     when 3
+      :option3
     else
       # instead of raise "this should never happen"
-      assume { false } # maybe real users don't need to notice, since this is not actually dangerous
+      # maybe real users don't need to notice, since this is not actually dangerous
+      assume { false }
+
+      :option1 # .. as long as we return the default option
     end
   end
 ```
 
 ## Installation
 
+Open `assume/lib/assume.rb` and copy/paste it into your project.
+
+The code is trivial, and you may want to customize it to behave
+differently or have a different interface.
+
+Since making this gem I have done this myself, and recommend it.
+
+### Using rubygems
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -114,7 +133,7 @@ require "assume/core_ext" # monkey-patches Object to provide the methods everywh
 ```
 
 ```ruby
-require "assume/refine" # Loads Assumptions
+require "assume/refine" # Loads Assumptions, a module containing a refinement
 
 class Whatever
   using Assumptions # assume's methods are now available in this class
@@ -181,7 +200,7 @@ Don't use assume and rescue BadAssumption as an error handling mechanism.
 Make your own error class and `raise`/`rescue` it.  
 Don't use assume to enforce the public api of a class/method. `raise ArgumentError` instead.  
 
-You should probably not use assume directly in a test case (you've already got expect/assert/whatever) but if the code under test uses assume and assume is enabled in your test suite, bonus! Your test suite is now more robust!
+You should probably not use assume directly in a test case (you've already got expect/assert/whatever) but if the code under test uses assume and assume is enabled in your test suite, bonus!
 
 ## Advanced
 
@@ -210,7 +229,7 @@ the block's #source_location method points it at. E.g. it will not print any sou
 
 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.
 
-Warning: Do not use `rspec` to run all the tests, they will fail as they are testing require statements. Use `rake`.
+Use `rake test` to run the tests. `rake` and `rake spec` also works.
 
 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).
 

data/Rakefile

@@ -3,12 +3,13 @@
 require "bundler/gem_tasks"
 
 task :spec do
-  sh "rspec spec/assume_spec.rb"
-  sh "rspec spec/core_ext_spec.rb"
-  sh "rspec spec/refine_spec.rb"
+  sh "bundle exec rspec spec/assume_spec.rb"
+  sh "bundle exec rspec spec/core_ext_spec.rb"
+  sh "bundle exec rspec spec/refine_spec.rb"
 end
 task default: :spec
+task test: :spec
 
 task :console do
-  exec 'bin/console'
+  exec 'bundle exec bin/console'
 end

data/assume.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Odin H B"]
   spec.email         = ["odinh2908@gmail.com"]
 
-  spec.summary       = "Write your assumptions down - in code"
-  spec.description   = "Assume encourages you to communicate with your team members and build confidence in your code"
+  spec.summary       = "Be honest about your (code's) assumptions"
+  spec.description   = "Assume is an assert library with a better name"
   spec.homepage      = "https://github.com/odinhb/assume"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/lib/assume/version.rb

@@ -1,3 +1,3 @@
 module Assume
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/assume.rb

@@ -35,6 +35,10 @@ module Assume
 
   class << self
     def handler=(handler)
+      unless handler.respond_to?(:call)
+        raise ArgumentError, "Assume::handler must respond to #call"
+      end
+
       @assumption_handler = handler
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assume
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Odin H B
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Assume encourages you to communicate with your team members and build
-  confidence in your code
+description: Assume is an assert library with a better name
 email:
 - odinh2908@gmail.com
 executables: []
@@ -76,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - CHANGES.md
 - Gemfile
 - Gemfile.lock
@@ -96,7 +96,7 @@ metadata:
   homepage_uri: https://github.com/odinhb/assume
   source_code_uri: https://github.com/odinhb/assume
   changelog_uri: https://github.com/odinhb/assume/CHANGES.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
-summary: Write your assumptions down - in code
+summary: Be honest about your (code's) assumptions
 test_files: []