junk_drawer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0da0ad66a1221cb8d106b8364336f8039c09a6b
-  data.tar.gz: 20f73f5ec1a8501aaca7429d099baa271cf14fc6
+  metadata.gz: 033f2ab3b77953431ed14a2e0cfdf6f0b7f8d80b
+  data.tar.gz: 0b1b9ddb51d43c0760585b915f8448719d8b6ea8
 SHA512:
-  metadata.gz: 6f7b51bfb7acd57c1f433080fc473bfc49e603b02071f3757fc824b9f9ba3f1a773b8ef2d4892d50f8e3a08dca07097aece39f296f5584197d85ef3aa66b56c6
-  data.tar.gz: 5dac68fde062e4e81d9f82a79138e00d0c21395349501e322b6599f365c714284555099feb2475afd34a61dfcbefa657bacb0dcfc3e482640f9f3913b5d3e911
+  metadata.gz: 452971946ec2297e949ce82a14805732ae35e1c5862d71681af2f35dd9ad287f8596c933caede70c45409f7b4c095888af3041968ebdd01a047b438ec3e0928d
+  data.tar.gz: 5f5d67af5ba7ddeed0e9a5dc0003a1af62123a30393796da18a1ad76b9e99a0c1c80873c6d1e5abbf8946f9e3da01b7e771fec6fba55ce53e87454ff3f7641b7

data/.rubocop.yml

@@ -13,6 +13,9 @@ Metrics/BlockLength:
 RSpec/ExampleLength:
   Enabled: false
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
 # default disabled rules
 Style/AutoResourceCleanup:
   Enabled: true

data/README.md

@@ -1,11 +1,7 @@
 # JunkDrawer
 
-Welcome to your new gem! In this directory, you'll find the files you need to
-be able to package up your Ruby library into a gem. Put your Ruby code in the
-file `lib/junk_drawer`. To experiment with that code, run `bin/console` for an
-interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+`JunkDrawer` is a gem providing exactly one (and someday more) random utility
+that is commonly useful across projects.
 
 ## Installation
 
@@ -25,7 +21,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Callable
+
+`JunkDrawer::Callable` is a module that provides constraints and conveniences
+for objects that implement a single method `#call`. It comes with the
+philosophy that objects that *do* something, should do only one thing. When including the `JunkDrawer::Callable` in one of your classes, you will get the following:
+
+1) It raises an error if you try to implement a public method other than
+  `#call`.
+
+  ```ruby
+  class Foo
+    include JunkDrawer::Callable
+    def bar # Bad: can't define public method "#bar"
+    end
+  end
+  ```
+
+  produces:
+
+  ```
+  JunkDrawer::CallableError: invalid method name bar, only public method allowed is "call"
+  ```
+
+  Private methods are fine:
+
+  ```ruby
+  class Foo
+    include JunkDrawer::Callable
+  private
+    def bar # private methods are okay!
+    end
+  end
+  ```
+
+2) It delegates `call` on the class to a new instance:
+
+  ```ruby
+  class Foo
+    include JunkDrawer::Callable
+    def call(stuff)
+      puts "I am a Foo! I've got #{stuff}"
+    end
+  end
+  ```
+
+  ```
+  > Foo.call('a brochure')
+  I am a Foo! I've got a brochure
+  > Foo.new.call('a brochure')
+  I am a Foo! I've got a brochure
+  ```
+
+3) It implements `to_proc`, both on the class and instance, allowing operations
+  such as:
+
+  ```
+  > ['puppies', 'a cold', 'cheeseburgers'].each(&Foo)
+  I am a Foo! I've got puppies
+  I am a Foo! I've got a cold
+  I am a Foo! I've got cheeseburgers
+  ```
+
+  See here for a great explanation of `to_proc` and the `&` operator:
+
+  http://www.brianstorti.com/understanding-ruby-idiom-map-with-symbol/
 
 ## Development
 
@@ -41,11 +101,10 @@ git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygem
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/[USERNAME]/junk_drawer. This project is intended to be a
+https://github.com/mockdeep/junk_drawer. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected to
 adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/junk_drawer/callable.rb

@@ -10,6 +10,10 @@ module JunkDrawer
       raise NotImplementedError
     end
 
+    def to_proc
+      proc { |args| self.(*args) }
+    end
+
     # `ClassMethods` defines a class level method `call` that delegates to
     # an instance. It also causes an error to be raised if a public instance
     # method is defined with a name other than `call`
@@ -18,6 +22,10 @@ module JunkDrawer
         new.(*args)
       end
 
+      def to_proc
+        new.to_proc
+      end
+
       def method_added(method_name)
         return if method_name == :call || !public_method_defined?(method_name)
 

data/lib/junk_drawer/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module JunkDrawer
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: junk_drawer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-20 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler