interrobang 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ceec7459be5080517cd7fb86a34a82d298a4566
-  data.tar.gz: 786219e05a0eb05f8ce748145847dfd993a25831
+  metadata.gz: 099c151998012c3b83493b640f45acbf91247f57
+  data.tar.gz: 2da0a2856a9e9f416898f205d514a66b6143a496
 SHA512:
-  metadata.gz: f0a2e2f65b003c5e1d5af6ac61634d284d502f44c45708f92715babd30e258f2ffea92d192d557a1340eb22e41039a54e12350799bb75fb75f12a7c4fc9b4767
-  data.tar.gz: 47ed4dfbe582b2151a7666430c910b1bbd7e3fb9243d47d3f8f01275175a6a9f47d04749186126fecaea8cbdde632eae65b75c44b4c1272660e9217cd67329f3
+  metadata.gz: 1160b524c4aad14728ee2ecd935ea249f941ff363da066996911e81ee2b1c63123e66d6ca3a9ae00a535137c0a6f34f8211a86be5c43fb7b9d3f93e1fb93e6ec
+  data.tar.gz: 1b13e92885ebf30278e6a463a788f79cdb4a0d354875104fc0afbb4331ef5be4292fd66f2eb2e04c08d63ef9887a9140146b53e527c65fe4e0dccef35d0f9dc6

data/.travis.yml

@@ -5,8 +5,11 @@ rvm:
   - 2.1
   - 2.0.0
   - ruby-head
-  - jruby-head
+  - jruby-9
   - rbx-2
 addons:
   code_climate:
     repo_token: 6f4b7c1f44b29f414ffb9b243b1f83cf5fa40eb297b4cd0c7761bf960487a8eb
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/interrobang.svg)](http://badge.fury.io/rb/interrobang)
 [![Build Status](https://travis-ci.org/fny/interrobang.svg?branch=master)](https://travis-ci.org/fny/interrobang)
 [![Test Coverage](https://codeclimate.com/github/fny/interrobang/badges/coverage.svg)](https://codeclimate.com/github/fny/interrobang)
+[![Code Climate](https://codeclimate.com/github/fny/interrobang/badges/gpa.svg)](https://codeclimate.com/github/fny/interrobang)
 [![Inline docs](http://inch-ci.org/github/fny/interrobang.svg?branch=master)](http://inch-ci.org/github/fny/interrobang)
 
 Convert your `predicate_methods?` into `bang_methods!` without abusing `method_missing`.
@@ -23,7 +24,7 @@ class Answer
 end
 ```
 
-`Interrobang` automagically adds corresponding bang methods for any predicate methods that end in a `?`. The bang methods explode when the predicate method returns a falsey value.
+`Interrobang` automagically adds corresponding bang methods for any predicate methods that end in a `?`. The bang methods explode when the predicate method returns a falsey value and otherwise return true.
 
 ```ruby
 # Pick your poison...
@@ -82,6 +83,8 @@ end
 Interrobang(NaySayer, :correct?) # => :correct!
 ```
 
+`Interrobang` returns `nil` instead of converting `bang_methods!` or `assignment_methods`.
+
 ### Filters
 
 Perhaps you'd like to convert methods that match a different pattern?
@@ -94,12 +97,11 @@ Interrobang(Answer, matching: %r{\Ais_.*\z})
 You can exclude methods that match the pattern with `except`.
 
 ```ruby
-Interrobang(Answer, matching: %r{\Ais_.*\z},
-                              except: [:is_factual,  :is_right])
+Interrobang(Answer, matching: %r{\Ais_.*\z}, except: [:is_factual,  :is_right])
 # => [:is_correct!]
 ```
 
-Maybe you'd like to state the methods to convert explicitly?
+Maybe you'd like to state the methods to convert explicitly? Use `only`. This will override the pattern or any exclusions.
 
 ```ruby
 Interrobang(Answer, only: :is_correct) # => [:is_correct!]
@@ -113,7 +115,7 @@ Interrobang(Answer, include_super: true,  prefix: 'ensure_')
 Answer.new.ensure_nil! # => Raises Interrobang::FalsePredicate
 ```
 
-Too lazy to type `Interrobang` a few timews? Just `extend` it. It's methods are `module_function`s.
+Too lazy to type `Interrobang` a few times? Just `extend` it. It's methods are `module_function`s.
 
 ```ruby
 class Answer

data/interrobang.gemspec

@@ -8,8 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Interrobang::VERSION
   spec.authors       = ["Faraz Yashar"]
   spec.email         = ["faraz.yashar@gmail.com"]
-  spec.summary       = "Convert your predicate_methods? into bang_methods! without
-abusing method_missing"
+  spec.summary       = "Convert your predicate_methods? into bang_methods!"
   spec.description   = "Convert your predicate_methods? into bang_methods! without
 abusing method_missing."
   spec.homepage      = 'https://github.com/fny/interrobang'

data/lib/interrobang.rb

@@ -3,7 +3,7 @@ require 'interrobang/version'
 # Convert your `#predicate_methods?` to `#bang_methods!`
 module Interrobang
   # Exception to raise when no block is provided for bangified falsey methods
-  FalsePredicate = Class.new(Exception)
+  FalsePredicate = Class.new(StandardError)
 
   # Regexp that matches methods that end in question marks.
   DEFAULT_PATTERN = %r{\A[^?]+\?\z}
@@ -59,7 +59,8 @@ module Interrobang
   end
 
   # Converts the specified predicate method to a bang method. Beware: bang
-  # methods will be created for undefined methods too.
+  # methods will be created for undefined methods too. Assignment methods (`method=`)
+  # and bang methods (`method!`) will not be converted.
   #
   # klass - The Class to target for bangification
   # predicate_method - The Symbol of the predicate method
@@ -71,7 +72,8 @@ module Interrobang
   #   prefix - The String prefix to add to front of the bangified method
   #   suffix - The String suffix to add to end of the bangified method
   #
-  # Returns the Symbol name of the bang method created.
+  # Returns the Symbol name of the bang method created or nil if the method
+  # was not bangified (ends in `!` or `=`.)
   def bangify_method(klass, predicate_method, prefix: '', suffix: '')
     predicate_method_string = predicate_method.to_s
     method_name_base =
@@ -79,9 +81,9 @@ module Interrobang
       when '=', '!'
         return
       when '?'
-        predicate_method.to_s[0..-2]
+        predicate_method_string[0..-2]
       else
-        predicate_method.to_s
+        predicate_method_string
       end
 
     bang_method = :"#{prefix}#{method_name_base}#{suffix}!"
@@ -100,7 +102,7 @@ module Interrobang
           if send(predicate_method, *args, &block)
             true
           else
-            raise(Interrobang::FalsePredicate, "#{predicate_method} is false")
+            fail Interrobang::FalsePredicate, "#{predicate_method} is false"
           end
         end
       end

data/lib/interrobang/version.rb

@@ -1,3 +1,3 @@
 module Interrobang
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/test/lib/interrobang_test.rb

@@ -1,22 +1,21 @@
 require File.expand_path('../../test_helper', __FILE__)
 
-SomeError = Class.new(Exception)
-
-def test_class
-  Class.new {
-    def true?; true; end
-    def veritable?; true; end
-    def so_true; true; end
-    def so_very_true; true; end
-    def false?; false; end
-    def so_false; false; end
-    def assignment=; end
-    def bang!; '!'; end
-    def with_argument?(bool); bool; end
-  }
-end
-
 describe Interrobang do
+  let(:klass) do
+    Class.new {
+      def true?; true; end
+      def veritable?; true; end
+      def so_true; true; end
+      def so_very_true; true; end
+      def false?; false; end
+      def so_false; false; end
+      def assignment=; end
+      def bang!; '!'; end
+      def with_argument?(bool); bool; end
+    }
+  end
+
+  SomeError = Class.new(StandardError)
 
   #
   # Bangify Class
@@ -30,70 +29,61 @@ describe Interrobang do
     '.bangify_class' =>
       -> (*args, &block) { Interrobang.bangify_class(*args, &block) }
   }
-  bangify_class_signatures.each do |method_call, method_block|
-    describe method_call do
+  bangify_class_signatures.each do |signature_name, bangify_class|
+    describe signature_name do
       it "converts all predicate? methods by default" do
-        klass = test_class
-        method_block.call klass
+        bangify_class.call klass
         assert klass.new.true!
         assert klass.new.veritable!
       end
 
       it "returns an array of symbols of the bangified methods" do
-        klass = test_class
-        assert_equal method_block.call(klass).sort, [:true!, :veritable!, :false!, :with_argument!].sort
+        assert_equal bangify_class.call(klass).sort, [:true!, :veritable!, :false!, :with_argument!].sort
       end
 
       it "converts all methods according to the provided prefix and suffix" do
-        klass = test_class
-        method_block.call(klass, prefix: 'prefix_', suffix: '_suffix')
+        bangify_class.call(klass, prefix: 'prefix_', suffix: '_suffix')
         assert klass.new.prefix_true_suffix!
         assert klass.new.prefix_veritable_suffix!
       end
 
       it "converts all methods that match the provided pattern" do
-        klass = test_class
-        method_block.call(klass, matching: %r{\Aso_.*\z})
+        bangify_class.call(klass, matching: %r{\Aso_.*\z})
         assert klass.new.so_true!
         assert klass.new.so_very_true!
         -> { klass.new.true! }.must_raise NoMethodError
       end
 
       it "converts all methods that match the provided pattern respected except" do
-        klass = test_class
-        method_block.call(klass, matching: %r{\Aso_.*\z}, except: [:so_very_true])
+        bangify_class.call(klass, matching: %r{\Aso_.*\z}, except: [:so_very_true])
         assert klass.new.so_true!
         -> { klass.new.so_very_true! }.must_raise NoMethodError
         -> { klass.new.true! }.must_raise NoMethodError
       end
 
       it "except option accepts a singular symbol" do
-        klass = test_class
-        method_block.call(klass, matching: %r{\Aso_.*\z}, except: :so_very_true)
+        bangify_class.call(klass, matching: %r{\Aso_.*\z}, except: :so_very_true)
         assert klass.new.so_true!
         -> { klass.new.so_very_true! }.must_raise NoMethodError
         -> { klass.new.true! }.must_raise NoMethodError
       end
 
       it "converts only the methods specified in the only option" do
-        klass = test_class
-        method_block.call(klass, only: [:so_true])
+        bangify_class.call(klass, only: [:so_true])
         assert klass.new.so_true!
         -> { klass.new.so_very_true! }.must_raise NoMethodError
         -> { klass.new.true! }.must_raise NoMethodError
       end
 
       it "except option accepts a singular symbol" do
-        klass = test_class
-        method_block.call(klass, only: :so_true)
+        bangify_class.call(klass, only: :so_true)
         assert klass.new.so_true!
         -> { klass.new.so_very_true! }.must_raise NoMethodError
         -> { klass.new.true! }.must_raise NoMethodError
       end
 
       it "converts only the methods specified in the only option with a block" do
-        klass = test_class
-        method_block.call(klass, only: [:so_false]) do
+        bangify_class.call(klass, only: [:so_false]) do
           raise SomeError
         end
         -> { klass.new.so_false! }.must_raise SomeError
@@ -102,8 +92,7 @@ describe Interrobang do
       end
 
       it "performs the provided block for the bang method" do
-        klass = test_class
-        method_block.call(klass) do
+        bangify_class.call(klass) do
           raise SomeError
         end
         assert klass.new.true!
@@ -111,8 +100,7 @@ describe Interrobang do
       end
 
       it "converts super methods when specified" do
-        klass = test_class
-        method_block.call(klass, include_super: true, prefix: 'ensure_')
+        bangify_class.call(klass, include_super: true, prefix: 'ensure_')
         -> { klass.new.ensure_nil! }.must_raise Interrobang::FalsePredicate
       end
     end
@@ -130,63 +118,63 @@ describe Interrobang do
     '.bangify_method' =>
       -> (*args, &block) { Interrobang.bangify_method(*args, &block) }
   }
-  bangify_method_signatures.each do |method_call, method_block|
-    describe method_call do
+  bangify_method_signatures.each do |signature_name, bangify_method|
+    describe signature_name do
       describe "with a method that ends in a ?" do
         it "adds a ! method dropping the ?" do
-          klass = test_class
-          method_block.call(klass, :true?)
+          bangify_method.call(klass, :true?)
           assert klass.new.true!
         end
 
         it "has no method missing shenanigans" do
-          klass = test_class
-          method_block.call(klass, :true?)
+          bangify_method.call(klass, :true?)
           assert klass.new.respond_to?(:true!)
         end
       end
 
       describe "with a method that does not end in a ?" do
         it "adds a ! method" do
-          klass = test_class
-          method_block.call(klass, :so_true)
+          bangify_method.call(klass, :so_true)
         end
       end
 
       it "returns the symbol of the bangified method" do
-        klass = test_class
-        assert_equal method_block.call(klass, :true?), :true!
+        assert_equal bangify_method.call(klass, :true?), :true!
       end
 
       it "works on methods with arguments" do
-        klass = test_class
-        method_block.call(klass, :with_argument?)
+        bangify_method.call(klass, :with_argument?)
         assert klass.new.with_argument!(true)
         -> { klass.new.with_argument!(false) }.must_raise Interrobang::FalsePredicate
       end
 
       it "does not convert assignment methods" do
-        klass = test_class
-        method_block.call(klass, :assignment_=)
-        -> { klass.new.assignment_! }.must_raise NoMethodError
+        assert_equal bangify_method.call(klass, :assignment=), nil
+        assert !klass.new.respond_to?(:assignment!)
       end
 
       it "does not convert bang methods" do
-        klass = test_class
-        method_block.call(klass, :bang!)
+        assert_equal bangify_method.call(klass, :bang!), nil
         assert_equal klass.new.bang!, '!'
       end
 
       it "converts undefined methods" do
-        klass = test_class
-        method_block.call(klass, :is_not_defined)
+        bangify_method.call(klass, :is_not_defined)
         assert klass.new.respond_to?(:is_not_defined!)
       end
 
+      it "raises errors with a message about the false predicate" do
+        bangify_method.call(klass, :false?)
+        begin
+          klass.new.false!
+        rescue Exception => e
+          assert_equal e.message, "false? is false"
+        end
+      end
+
       describe "options" do
         it "adds any provided prefix or suffix to the bang method" do
-          klass = test_class
-          method_block.call(klass, :true?, prefix: 'prefix_', suffix: '_suffix')
+          bangify_method.call(klass, :true?, prefix: 'prefix_', suffix: '_suffix')
           assert klass.new.prefix_true_suffix!
         end
       end
@@ -194,8 +182,7 @@ describe Interrobang do
       describe "falsey predicates" do
         describe "without a custom block" do
           it "raises a FalsePredicate error" do
-            klass = test_class
-            method_block.call(klass, :false?)
+            bangify_method.call(klass, :false?)
             err = -> { klass.new.false! }.must_raise Interrobang::FalsePredicate
             assert_equal err.message, 'false? is false'
           end
@@ -203,16 +190,14 @@ describe Interrobang do
 
         describe "with a provided block" do
           it "performs the provided block for the bang method" do
-            klass = test_class
-            method_block.call(klass, :false?) do
+            bangify_method.call(klass, :false?) do
               raise SomeError
             end
             -> { klass.new.false! }.must_raise SomeError
           end
 
           it "allows the provided block to take the predicate method as an argument" do
-            klass = test_class
-            method_block.call(klass, :false?) do |predicate_method|
+            bangify_method.call(klass, :false?) do |predicate_method|
               raise SomeError, "#{predicate_method} isn't true"
             end
             err = -> { klass.new.false! }.must_raise SomeError
@@ -238,4 +223,9 @@ describe Interrobang do
     -> { Answer.new.correct! }.must_raise(Interrobang::FalsePredicate)
   end
 
+  describe Interrobang::FalsePredicate do
+    it "can be rescued without specifying an exception" do
+      assert begin fail(Interrobang::FalsePredicate); rescue; true; end
+    end
+  end
 end

data/test/test_helper.rb

@@ -4,6 +4,7 @@ if ENV['CODECLIMATE_REPO_TOKEN']
 end
 
 require 'minitest/autorun'
+require 'minitest/hell'
 require 'minitest/pride'
 
 require File.expand_path('../../lib/interrobang', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interrobang
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Faraz Yashar
@@ -96,8 +96,7 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Convert your predicate_methods? into bang_methods! without abusing method_missing
+summary: Convert your predicate_methods? into bang_methods!
 test_files:
 - test/lib/interrobang_test.rb
 - test/test_helper.rb
-has_rdoc: