qualitysmith_extensions 0.0.6 → 0.0.7

data/lib/qualitysmith_extensions/array/group_by.rb

@@ -8,7 +8,7 @@
 #++
 
 require 'rubygems'
-require_gem 'facets'
+gem 'facets'
 require 'facet/array/delete_values_at'
 require 'facet/array/to_hash'
 class Array

data/lib/qualitysmith_extensions/kernel/die.rb

@@ -2,13 +2,14 @@
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
-# Submit to Facets?:: Yes
+# Submit to Facets?:: No.
+# Deprecated. Because I discovered Kernel::abort !
 #++
 
 module Kernel
-  def die(message)
+  def die(message, exit_code = 1)
     $stderr.puts message
-    exit 1
+    exit exit_code
   end
 end
 
@@ -35,5 +36,14 @@ class TheTest < Test::Unit::TestCase
     assert_equal "Aggh! I'm dying!", stderr.chomp
   end
 
+  def test_abort
+    stderr = capture_output $stderr do
+      assert_raise(SystemExit) do
+        abort "Aggh! I'm dying!"
+      end
+    end
+    assert_equal "Aggh! I'm dying!", stderr.chomp
+  end
+
 end
 =end

data/lib/qualitysmith_extensions/kernel/example_printer.rb

@@ -0,0 +1,75 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes
+# Developer notes::
+# * Can anyone think of a better name than put_statement?
+#   * Something more like xmp? sp? stp? xm? putst? -- Too cryptic?
+#   * verbose? -- too ambiguous (that could be the name for xmp, for example)
+# * xmp: Do the set_trace_func trick that irb_xmp/of_caller both use... so that the user doesn't have to pass in the local binding manually...
+# * Add class method for ExamplePrinter to set a template for use by xmp? So if you don't like the default ("=> #{result}"), you can specify your own...
+#++
+
+require 'rubygems'
+#require 'facets/core/binding/self/of_caller'
+
+# This was written because the irb/xmp that was already available seemed to be
+# needlessly complex and needlessly dependent upon "irb" stuff. This
+# alternative is dirt simple, and it still works.
+module ExamplePrinter
+  # Prints the given statement (+code+ -- a string) before evaluating it.
+  def put_statement(code, binding = nil)
+    # This didn't work. Still got this error: undefined local variable or method `x' for #<TheTest:0xb7dbc358> (NameError)
+#    Binding.of_caller do |caller_binding|
+#      puts caller_binding
+#      puts code
+#      eval code, caller_binding
+#    end
+    puts code
+    eval code, binding
+  end
+  alias_method :stp, :put_statement
+
+  # Pretty much compatible with irb/xmp. But you have currently have to pass
+  # in the binding manually if you have any local variables/methods that xmp
+  # should have access to.
+  def xmp(code, binding = nil)
+    result = put_statement(code, binding)
+    puts "=> #{result}"
+  end
+end
+
+include ExamplePrinter
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+gem     'qualitysmith_extensions'
+require 'qualitysmith_extensions/kernel/capture_output'
+require 'facets/core/string/margin'
+
+class TheTest < Test::Unit::TestCase
+  def test_puts_statement
+    result = nil
+    x = 1
+    output = capture_output { result = put_statement("3 + x", binding) }
+    assert_equal 4, result
+    assert_equal "3 + x", output.chomp
+  end
+  def test_xmp
+    x = 1
+    output = capture_output { xmp("3 + x", binding) }
+    assert_equal <<-End.margin, output.chomp
+      |3 + x
+      |=> 4
+    End
+  end
+end
+=end

data/lib/qualitysmith_extensions/module/alias_method.rb

@@ -0,0 +1,6 @@
+# Idea:
+#   Allow using hashes:
+#     alias_method :code_review => :view_commits 
+#     instead of 
+#     alias_method :code_review, :view_commits
+#   because I always forget which argument becomes the argument for which

data/lib/qualitysmith_extensions/module/attribute_accessors.rb

@@ -0,0 +1,46 @@
+# Copied from ActiveSupport because I couldn't get the ones in Facets to work...
+
+# Extends the module object with module and instance accessors for class attributes, 
+# just like the native attr* accessors for instance attributes.
+class Module # :nodoc:
+  def mattr_reader(*syms)
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+        
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+  
+  def mattr_writer(*syms)
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+        
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+  end
+  
+  def mattr_accessor(*syms)
+    mattr_reader(*syms)
+    mattr_writer(*syms)
+  end
+end

data/lib/qualitysmith_extensions/module/includable_once.rb

@@ -0,0 +1,10 @@
+
+#    mattr_accessor :already_included
+#    def self.already_included
+#      @@already_included ||= false
+#    end
+#
+#    def self.included(base_module)
+#      return if @@already_included
+#      @@already_included = true
+#

data/lib/qualitysmith_extensions/object/default.rb

@@ -0,0 +1,69 @@
+# Rationale:
+# The ||= "operator" is often used to set a default value.
+#   var ||= 'default'
+# Unfortunately, it does not give the desired behavior for when you want to give a default value to a *boolean* (which might have been already initialized to false).
+# When setting a variable to a default value, we actually only want to set it to the default if it's currently set to *nil*!
+# This was an attempt to supply that missing method...
+
+module Kernel
+  def default!(object, default_value)
+    case object
+    when NilClass
+      #object.become default_value
+      #object.replace default_value
+    else
+    end
+  end
+
+end
+
+
+class NilClass
+  def default!(default_value)
+    #self.become default_value
+    #self.replace default_value
+    #self = default_value
+
+    # Not sure how to implemnet this! ... without writing/using a C extension that lets me turn a NilClass object into another object.
+  end
+end
+class Object
+  def default!(default_value)
+    # This should have no effect on any objects other than instances of NilClass.
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class Foo
+  def do_it(options = {})
+    options[:how_many_times] ||= 3
+    #options[:actually_do_it]  ||= true     # Doesn't work! What if they explicitly set it to false? We would unconditionally be overriding it with true. We only want to set it to true if it's "not set yet" (if it's nil).
+    options[:actually_do_it].default! true  # This is how I'd like to do it. It makes it clear what we're doing (setting a default value).
+    options[:actually_do_it] = true if options[:actually_do_it].nil?   # This works, but you have to duplicate the variable name in two places. Plus it's not explicitly clear that true is being used as a *default* value.
+
+    options[:actually_do_it] ? "We did it #{options[:how_many_times]} times" : "We didn't actually do it"
+  end
+end
+
+class TheTest < Test::Unit::TestCase
+  def test_false
+    assert_equal "We didn't actually do it", Foo.new.do_it(:actually_do_it => false)
+  end
+  def test_true
+    assert_equal "We did it 3 times", Foo.new.do_it()
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/object/methods.rb

@@ -0,0 +1,58 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes
+# Developer notes::
+#++
+
+require 'rubygems'
+require 'facets/core/module/alias_method_chain'
+require 'extensions/symbol'   # to_proc
+
+class Object
+
+  # Adds the following features to the built-in Object#methods:
+  # * Provides the same +include_super+ option that Module#instance_methods has (Backwards compatible, because default is +true+)
+  # * Returns an array of symbols rather than strings (Not backwards compatible)
+  # * Sorts the array for you so you don't have to! (Not backwards compatible)
+  def methods_with_sorting_and_include_super(include_super = true)
+    if include_super
+      methods_without_sorting_and_include_super
+    else
+      (methods_without_sorting_and_include_super - Object.methods_without_sorting_and_include_super)
+    end.sort.map(&:to_sym)
+  end
+  alias_method_chain :methods, :sorting_and_include_super
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_1
+    assert_equal [:[]], Array.methods(false)
+    assert       Array.methods.size > Array.methods(false).size
+
+    assert       !Object.methods(true).include?(:[])
+    assert        Array. methods(true).include?(:[])
+  end
+end
+=end
+
+# Old idea:
+#
+# class Object
+#   def own_methods  # (or Object#my_methods)
+#     ((methods - Object.methods).sort)
+#       # Could just use self.class.instance_methods(false) but what if we also want class/module methods to be included?
+#   end
+# end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: qualitysmith_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
-date: 2007-03-23 00:00:00 -07:00
+  version: 0.0.7
+date: 2007-04-03 00:00:00 -07:00
 summary: A collection of reusable Ruby methods developed by QualitySmith.
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Tyler Rick and others
 files: 
@@ -42,12 +43,14 @@ files:
 - lib/qualitysmith_extensions/kernel/simulate_input.rb
 - lib/qualitysmith_extensions/kernel/die.rb
 - lib/qualitysmith_extensions/kernel/require_once.rb
+- lib/qualitysmith_extensions/kernel/example_printer.rb
 - lib/qualitysmith_extensions/kernel/all.rb
 - lib/qualitysmith_extensions/kernel/filter_output.rb
 - lib/qualitysmith_extensions/kernel/backtrace.rb
 - lib/qualitysmith_extensions/kernel/capture_output.rb
 - lib/qualitysmith_extensions/object/singleton_send.rb
-- lib/qualitysmith_extensions/object/own_methods.rb
+- lib/qualitysmith_extensions/object/methods.rb
+- lib/qualitysmith_extensions/object/default.rb
 - lib/qualitysmith_extensions/file/exact_match_regexp.rb
 - lib/qualitysmith_extensions/date/iso8601.rb
 - lib/qualitysmith_extensions/date/deprecated.rb
@@ -58,7 +61,10 @@ files:
 - lib/qualitysmith_extensions/console/command.rb
 - lib/qualitysmith_extensions/console/command.facets.1.8.54.rb
 - lib/qualitysmith_extensions/console/command.facets.1.8.51.rb
+- lib/qualitysmith_extensions/module/alias_method.rb
+- lib/qualitysmith_extensions/module/includable_once.rb
 - lib/qualitysmith_extensions/module/create_setter.rb
+- lib/qualitysmith_extensions/module/attribute_accessors.rb
 - lib/qualitysmith_extensions/enumerable/enum.rb
 - lib/qualitysmith_extensions/hash/to_query_string.rb
 - lib/qualitysmith_extensions/hash/all.rb

data/lib/qualitysmith_extensions/object/own_methods.rb

@@ -1,5 +0,0 @@
-# class Object
-#   def own_methods  # (or Object#my_methods)
-#     ((methods - Object.methods).sort) # (or just use self.class.instance_methods?)
-#   end
-# end