ragabash 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f525237ed9e30ba2686a2d1ee51f33105d4160af
-  data.tar.gz: 92961fbbd0a3934233c1fcfbd21cc2e4e9ce5414
+  metadata.gz: 37191f18ef1617949bfb78247a0ff61d6d28d767
+  data.tar.gz: 353ffee2ebe359a2f08a7ae86dfab9a04b0265d8
 SHA512:
-  metadata.gz: f2e1493d650a7fccfca4a4c7a2c50b36e6d3127f8126a3b5c9da3650a941e24c787a9aaa6c8c566ad38d8f3e69f3fc1cd1c22c8b972c9ef6b63350f2b9931606
-  data.tar.gz: f93225111a737a5fe8a50c436c93931a5149ddbd80db3644b2a08c06d9324c9bbca7b8e1683eb4c42f42fff8d34ea4b4e2c9bd0a29cbfa1c3258613eebb14fd7
+  metadata.gz: 0cf6d17680f55cc37c7689f4a7bab500a6d1a0c5840b130f8e99325cc951f2df229f60ce741cd4eba157cb32b8347976733106964a9e6b5fcfbaa04ec7eabc79
+  data.tar.gz: ead865fc572a59b48a37944e24d187aeb7dff5ece4a8144957b70fc367d776a67b473a3cf021623d3f48ce8e2516e1008eaa685e484fb5ef3f22142e42ced089

data/README.md

@@ -1,9 +1,11 @@
 # Ragabash
 
+[![Gem Version](https://badge.fury.io/rb/ragabash.svg)](https://badge.fury.io/rb/ragabash)
+[![Dependency Status](https://gemnasium.com/badges/github.com/nomoon/ragabash.svg)](https://gemnasium.com/github.com/nomoon/ragabash)
 [![Build Status](https://travis-ci.org/nomoon/ragabash.svg?branch=master)](https://travis-ci.org/nomoon/ragabash)
-[![Code Climate](https://codeclimate.com/github/nomoon/ragabash/badges/gpa.svg)](https://codeclimate.com/github/nomoon/ragabash)
 [![Test Coverage](https://codeclimate.com/github/nomoon/ragabash/badges/coverage.svg)](https://codeclimate.com/github/nomoon/ragabash/coverage)
-[![Dependency Status](https://gemnasium.com/badges/github.com/nomoon/ragabash.svg)](https://gemnasium.com/github.com/nomoon/ragabash)
+[![Code Climate](https://codeclimate.com/github/nomoon/ragabash/badges/gpa.svg)](https://codeclimate.com/github/nomoon/ragabash)
+[![Inline docs](http://inch-ci.org/github/nomoon/ragabash.svg?branch=master)](http://inch-ci.org/github/nomoon/ragabash)
 
 "A collection of useful extensions, refinements, and tools."
 

data/lib/ragabash.rb

@@ -3,6 +3,6 @@ require "ragabash/version"
 require "ragabash/refinements"
 require "ragabash/awesome_string_formatter"
 
+# A utility module full of useful things.
 module Ragabash
-  # Your code goes here...
 end

data/lib/ragabash/awesome_string_formatter.rb

@@ -2,12 +2,26 @@
 require "rouge"
 
 module Ragabash
+  # Custom String formatter module for +awesome_print+ gem.
+  #
+  # You can activate this automatically by including:
+  #  require "ragabash/ext/awesome_strings"
+  # You can also activate this as part of an awesome_print-based Pry printer by including:
+  #  require "ragabash/ext/pry_awesome_print"
   module AwesomeStringFormatter
-    def self.included(base)
-      base.send :alias_method, :cast_without_string, :cast
-      base.send :alias_method, :cast, :cast_with_string
+    class << self
+      # Intercept awesome_print type-cast method.
+      def included(base)
+        base.send :alias_method, :cast_without_string, :cast
+        base.send :alias_method, :cast, :cast_with_string
+      end
     end
 
+    # Replacement type-cast method for awesome_print.
+    #
+    # @param object [Object] the object to test
+    # @param type [Any] the type to test against
+    # @return [Boolean]
     def cast_with_string(object, type)
       object.is_a?(::String) ? :string : cast_without_string(object, type)
     end
@@ -22,6 +36,10 @@ module Ragabash
     R_LEXERS = ::Rouge::Lexer.all
     private_constant :MULTILINE_UNESCAPES, :R_FORMATTER, :R_LEXERS
 
+    # Format a String for awesome_print display.
+    #
+    # @param string [String] the String to format
+    # @return [String] the formatted String
     def awesome_string(string)
       lexers = ::Rouge::Guessers::Source.new(string).filter(R_LEXERS)
       if !lexers.empty?

data/lib/ragabash/refinements.rb

@@ -2,8 +2,47 @@
 require "ice_nine"
 
 module Ragabash
+  # A set of useful refinements for base classes.
+  #
+  # Activate these by including the following in an appropriate lexical scope:
+  #   using ::Ragabash::Refinements
   module Refinements
     # rubocop:disable Style/Alias
+
+    # @!method deep_freeze
+    #   Deep-freezes +self+.
+    #
+    #   Refines: +::Object+
+    #   @see http://www.rubydoc.info/gems/ice_nine/IceNine#deep_freeze-class_method
+
+    # @!method deep_freeze!
+    #   Deep-freezes +self+, but skips already-frozen objects.
+    #
+    #   Refines: +::Object+
+    #   @see http://www.rubydoc.info/gems/ice_nine/IceNine#deep_freeze%21-class_method
+
+    # @!method try_dup
+    #   Attempts to duplicate +self+, or returns +self+ on non-duplicable objects.
+    #
+    #   Refines: +::Object+, +::NilClass+, +::FalseClass+, +::TrueClass+, +::Symbol+,
+    #   +::Numeric+, +::BigDecimal+
+
+    # @!method deep_dup
+    #   Recursively duplicates +self+, including non-duplicable objects where necessary.
+    #
+    #   Refines: +::Object+, +::NilClass+, +::FalseClass+, +::TrueClass+, +::Symbol+,
+    #   +::Numeric+, +::BigDecimal+, +::Array+, +::Hash+, +::Set+
+
+    # @!method safe_copy
+    #   Returns +self+ if frozen or otherwise a frozen deep-duplicate.
+    #
+    #   Refines: +::Object+, +::NilClass+, +::FalseClass+, +::TrueClass+, +::Symbol+,
+    #   +::Numeric+, +::BigDecimal+, +::Array+, +::Hash+, +::Set+
+
+    # @!method frozen_copy
+    #   Alias of {safe_copy}.
+
+    #
     refine ::Object do
       def deep_freeze
         IceNine.deep_freeze(self)
@@ -19,7 +58,11 @@ module Ragabash
         self
       end
       alias deep_dup try_dup
-      alias safe_copy try_dup
+
+      def safe_copy
+        IceNine.deep_freeze(try_dup)
+      end
+      alias frozen_copy safe_copy
     end
 
     refine ::NilClass do
@@ -28,6 +71,7 @@ module Ragabash
       end
       alias deep_dup try_dup
       alias safe_copy try_dup
+      alias frozen_copy try_dup
     end
 
     refine ::FalseClass do
@@ -36,6 +80,7 @@ module Ragabash
       end
       alias deep_dup try_dup
       alias safe_copy try_dup
+      alias frozen_copy try_dup
     end
 
     refine ::TrueClass do
@@ -44,6 +89,7 @@ module Ragabash
       end
       alias deep_dup try_dup
       alias safe_copy try_dup
+      alias frozen_copy try_dup
     end
 
     refine ::Symbol do
@@ -52,6 +98,7 @@ module Ragabash
       end
       alias deep_dup try_dup
       alias safe_copy try_dup
+      alias frozen_copy try_dup
     end
 
     refine ::Numeric do
@@ -60,6 +107,7 @@ module Ragabash
       end
       alias deep_dup try_dup
       alias safe_copy try_dup
+      alias frozen_copy try_dup
     end
 
     # Necessary to re-override Numeric
@@ -71,20 +119,27 @@ module Ragabash
       alias deep_dup try_dup
 
       def safe_copy
-        frozen? ? self : dup
+        frozen? ? self : dup.freeze
       end
+      alias frozen_copy safe_copy
     end
 
     refine ::String do
       def safe_copy
-        frozen? ? self : dup
+        frozen? ? self : dup.freeze
       end
+      alias frozen_copy safe_copy
     end
 
     refine ::Array do
       def deep_dup
         map { |value| value.deep_dup } # rubocop:disable Style/SymbolProc
       end
+
+      def safe_copy
+        frozen? ? self : deep_dup.deep_freeze
+      end
+      alias frozen_copy safe_copy
     end
 
     refine ::Hash do
@@ -100,6 +155,11 @@ module Ragabash
         end
         hash
       end
+
+      def safe_copy
+        frozen? ? self : deep_dup.deep_freeze
+      end
+      alias frozen_copy safe_copy
     end
 
     refine ::Set do
@@ -111,6 +171,11 @@ module Ragabash
         end
         self.class[set_a]
       end
+
+      def safe_copy
+        frozen? ? self : deep_dup.deep_freeze
+      end
+      alias frozen_copy safe_copy
     end
   end
 end

data/lib/ragabash/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 module Ragabash
-  VERSION = "0.1.0"
+  # The version number.
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ragabash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Bellefleur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler