bendy 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 112813b4db4e44430d77d0e63ffc665af0631cb5
-  data.tar.gz: 375b6985f76d99f0f9fd6f9603caff68fe8eca40
+  metadata.gz: 0dfc661e95d819b889ed872393dc2a882329bc14
+  data.tar.gz: 7e0fb92dc1a7b384ba80d3bde27971bd143896c6
 SHA512:
-  metadata.gz: e94fbb1e395310ff7083209d1d907dacd742c98b9e81e776ffef2eb0a8d02068e4982172b68f635d0eacda976b91d9771d7803fbf82c4e6015853b5b38296ae6
-  data.tar.gz: 9c2eb3ae3d6903c07fd1ae7ca56c4b9607cebed81f09150a0577899bebc09eb3ab60b521092add1d989b0a6d8e7dd73576722a9f471113558dad64f76eea8c1f
+  metadata.gz: b38391de2e2102c8b944ad76faba5bf7e52a92765b0309dd697c21a353c1af86191894864b035cecaa6e95e9eac63d24d31da0db679aaef5a71456fe4038c982
+  data.tar.gz: 1354f7f3b762e8348f8d69101974a854acc40e6ffd664830520bd32c3ea2884c29dec6b317c42030f48195f9300fe34801bb1d6c663ddb390894872d0bc1cca1

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.yardopts

data/README.md

@@ -1,5 +1,7 @@
 # Bendy
 
+[![Gem Version](https://badge.fury.io/rb/bendy.svg)](http://badge.fury.io/rb/bendy)
+
 This is a collection of helpful utilities in use at Bendyworks.
 
 ## Installation
@@ -23,7 +25,7 @@ are best off reading the code for things that catch your eye.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/bendy/fork )
+1. Fork it ( http://github.com/twopoint718/bendygem/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/bendy/array.rb

@@ -3,27 +3,27 @@
 
 module Bendy
 
-
-  refine Array do
-
-    ##
-    # +tails+ produces all sub-arrays by successively dropping leading
-    # elements:
+    # @!method tails()
+    #   +tails+ produces all sub-arrays by successively dropping leading
+    #   elements:
     #
-    #     [1, 2, 3].tails
-    #     # => [[1, 2, 3], [2, 3], [3], []]
+    #       [1, 2, 3].tails
+    #       # => [[1, 2, 3], [2, 3], [3], []]
 
+  refine Array do
     def tails
       (self.length + 1).times.map{ |i| self.drop(i) }
     end
+  end
 
-    ##
-    # +inits+ produces all sub-arrays by successively taking leading
-    # elements:
+    # @!method inits()
+    #   +inits+ produces all sub-arrays by successively taking leading
+    #   elements:
     #
-    #     [1, 2, 3].tails
-    #     # => [[], [1], [1, 2], [1, 2, 3]]</tt>
+    #       [1, 2, 3].inits
+    #       # => [[], [1], [1, 2], [1, 2, 3]]
 
+  refine Array do
     def inits
       (self.length + 1).times.map{ |i| self.take(i) }
     end

data/lib/bendy/hash.rb

@@ -0,0 +1,21 @@
+##
+# We're using refinements to _freedom patch_ Hash in a safe way.
+
+module Bendy
+
+    # @!method get_deep()
+    #   +get_deep+ digs into a hash along the "route" given by fields
+    #   elements:
+    #
+    #       { foo: { bar: { baz: 1 } } }.get_deep(:foo, :bar, :baz)
+    #       # => 1
+    #
+    #       { foo: { bar: { baz: 1 } } }.get_deep(:foo, :bar, :baz, :quux)
+    #       # => nil
+
+  refine Hash do
+    def get_deep(*fields)
+      fields.inject(self) {|acc,e| acc[e] if acc.is_a?(Hash)}
+    end
+  end
+end

data/lib/bendy/kernel.rb

@@ -0,0 +1,18 @@
+##
+# Refine the Kernel module
+
+module Bendy
+
+    # @!method require()
+    #   +require+ does the normal thing that require does, but also logs it
+
+  refine Kernel do
+    def require_with_log(name)
+      puts "require: #{name}"
+      old_require name
+    end
+
+    alias_method :old_require, :require
+    alias_method :require, :require_with_log
+  end
+end

data/lib/bendy/logical.rb

@@ -1,13 +1,9 @@
 module Bendy
 
-  ##
   # Some logical methods
-
   module Logical
 
-    ##
-    # call-seq:
-    #   implies(antecedent) { consequent } #=> true or consequent
+    # @!method implies(antecedent){ consequent } #=> true or consequent
     #
     # Material implication
     #
@@ -15,8 +11,8 @@ module Bendy
     # (antecedent), then pay attention to the second thing (consequent). But
     # if the first thing is false then the whole thing is true:
     #
+    # @example Extract the bar value given foo exists
     #     implies(foo){foo[:bar]}
-
     def implies(antecedent)
       !!antecedent ? yield : true
     end

data/lib/bendy/object.rb

@@ -1,19 +1,17 @@
+# Bendy module that _freedom patches_ Object and NilClass to add `try`, like
+# in ActiveSupport
 module Bendy
-  refine Object do
 
-    ##
-    # call-seq:
-    #   try(:some_method) #=> result of method or nil
-    #
-    # +try+ acts like a normal method call, unless it is being called
-    # on a +nil+ object, in which case it returns +nil+:
+    # !@method try(:some_method)
+    #   +try+ acts like a normal method call, unless it is being called
+    #   on a +nil+ object, in which case it returns +nil+:
     #
-    #     nil.try(:to_i)   # => nil
-    #     "10".try(:to_i)  # => 10
+    #       nil.try(:to_i)   # => nil
+    #       "10".try(:to_i)  # => 10
     #
-    # Copied pretty much verbatim from ActiveSupport:
-    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/try.rb
-
+    #   Copied pretty much verbatim from ActiveSupport:
+    #   https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/try.rb
+  refine Object do
     def try(*a, &b)
       if a.empty? && block_given?
         yield self
@@ -23,6 +21,15 @@ module Bendy
     end
   end
 
+    # !@method try(:some_method)
+    #   +try+ acts like a normal method call, unless it is being called
+    #   on a +nil+ object, in which case it returns +nil+:
+    #
+    #       nil.try(:to_i)   # => nil
+    #       "10".try(:to_i)  # => 10
+    #
+    #   Copied pretty much verbatim from ActiveSupport:
+    #   https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/try.rb
   refine NilClass do
     def try(*args)
       nil

data/lib/bendy/version.rb

@@ -1,3 +1,3 @@
 module Bendy
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/spec/bendy/hash_spec.rb

@@ -0,0 +1,21 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'bendy/hash'
+
+using Bendy
+
+describe Hash do
+  before do
+    @hash = { foo: { bar: { baz: 1 } } }
+  end
+
+  describe '#get_deep' do
+    it 'accesses a key inside a nested hash' do
+      @hash.get_deep(:foo, :bar, :baz).must_equal 1
+    end
+
+    it 'accesses a key inside a nested hash' do
+      @hash.get_deep(:foo, :bar, :baz, :quux).must_equal nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bendy
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Wilson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,10 +54,13 @@ files:
 - bendy.gemspec
 - lib/bendy.rb
 - lib/bendy/array.rb
+- lib/bendy/hash.rb
+- lib/bendy/kernel.rb
 - lib/bendy/logical.rb
 - lib/bendy/object.rb
 - lib/bendy/version.rb
 - spec/bendy/array_spec.rb
+- spec/bendy/hash_spec.rb
 - spec/bendy/logical_spec.rb
 - spec/bendy/object_spec.rb
 homepage: https://github.com/twopoint718/bendygem
@@ -86,5 +89,6 @@ specification_version: 4
 summary: A collection of helpful libraries
 test_files:
 - spec/bendy/array_spec.rb
+- spec/bendy/hash_spec.rb
 - spec/bendy/logical_spec.rb
 - spec/bendy/object_spec.rb