sane 0.8.0

data/ChangeLog

@@ -0,0 +1,18 @@
+* renamed println to sprint
+
+
+0.1.0
+ * add File.write [stolen from facets]
+
+0.0.8
+ * add __DIR__ [stolen from oldrcrs]
+
+0.0.6
+  * bug fix [require andand]
+
+0.0.5
+  * add dependency on andand, rogerdpack-rbeautify # essentials
+  * add dbg call [essential]
+
+0.0.3
+ * add assert method

data/README

@@ -0,0 +1,24 @@
+Collection of utilities to make ruby ...more friendly from the get-go [really things that *should* have been added to core, because of immense convenience]
+
+Currently this includes:
+
+require_rel glob
+  * require a file relative to the current file, i.e.
+  >> require_rel 'lib/filename'
+
+Object#in?
+ # ex:
+ >> 3.in? [1,2,3]
+ => true
+  
+println
+ like print, but with a carriage return at the end:
+ >> println 1,2,3
+ (prints 123\n)
+
+enumerable-extra
+  #new enumerable #map
+  >> [1,2,3].map(:to_s) # applies it automatically! far less ugly than [1,2,3].map &:to_s
+  => ["1", "2", "3"]
+
+Don't leave home without these!

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'jeweler'
+Jeweler::Tasks.new do |s|
+
+  s.name = %q{sane}
+  #     3: add hash_set_operators
+  # 0.2.2: add Regex+Regex, bug fixes
+  # 0.2.0:
+  #       add irb simple prompt, auto indent by default [sane defaults!]
+  #     1: add $: << '.', don't do Hash#hash on 1.9
+  # 0.1.
+  #     9 add irb autocompletion on by default [if you're in an IRB session, that is]
+  #     8 add Hash#hash
+  #     7 add File.binwrite
+  #       rename aliaz alias_h [ for alias hash ]
+  #     6 add File.binread [1.9 has it, 1.8 not]
+  #     5 remove #sum method [not rails compat]
+  #     4 add _dbg as a file
+  # 0.1.3 require 'pp' with _dbg
+  # 0.1.2 add singleton_class
+  # 0.1.1 add aliaz
+
+  s.homepage = 'http://github.com/rogerdpack/sane_ruby'
+  s.authors = ["Roger Pack"]
+  s.description = s.summary =  %q{Helper methods for ruby to make it easier to work with out of the box--things that are missing from core but should be there}
+  s.email = ["rogerdpack@gmail.com"]
+
+  s.add_runtime_dependency("require_all")
+  s.add_runtime_dependency("backports")
+  s.add_runtime_dependency("hash_set_operators")
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/lib/_dbg.rb

@@ -0,0 +1,3 @@
+# helper file to 'just' pull up a debugger prompt
+require 'sane'
+_dbg # that's all we need

data/lib/sane.rb

@@ -0,0 +1,8 @@
+# some uber useful gems
+require 'require_all'
+require 'backports/tools.rb' # backports
+require 'backports/1.9/io' # File.binread
+require 'hash_set_operators' # not sure why these aren't in core
+require_rel 'sane_ruby' # require all sub files
+
+

data/lib/sane_ruby/add_regexes.rb

@@ -0,0 +1,13 @@
+class Regexp
+   def +(other)
+     if other.is_a?(Regexp)
+       if self.options == other.options
+         Regexp.new(source + other.source, options)
+       else
+         Regexp.new(source + other.to_s, options)
+       end
+     else
+       Regexp.new(source + Regexp.escape(other.to_s), options)
+     end
+   end
+end

data/lib/sane_ruby/bugs.rb

@@ -0,0 +1,35 @@
+
+if RUBY_PLATFORM =~ /mingw|mswin/
+  class File
+    # buggy File.executable? on windows
+    class << self
+      undef :executable?
+      def executable? *args
+        File.stat(*args).executable?
+      end
+    end
+  end
+end
+
+if RUBY_VERSION == '1.9.1'
+  # 1.9.1 bug
+  if File.basename(__FILE__).frozen?
+    class File
+      class << self
+        alias :original_basename :basename
+        def File.basename *args
+          original_basename(*args).dup
+        end
+      end
+    end
+  end
+
+end
+
+
+=begin
+rubydoctest: non frozen
+>> File.basename(__FILE__).frozen?
+=> false
+
+=end

data/lib/sane_ruby/enumerable-extra.rb

@@ -0,0 +1,161 @@
+module Enumerable  
+   EXTRA_VERSION = '0.1.0'
+
+   alias old_map map
+   alias old_collect collect
+=begin unused as it clashes with rails' own #sum
+  apparently
+  C:\dev\ruby\bridal>ruby test\functional\store_controller_test.rb
+test/functional/../test_helper
+C:/dev/ruby/bridal/config/../lib/sane-0.1.4/lib/enumerable-extra.rb:12:in `+': can't convert String into Array (TypeError)
+        from C:/dev/ruby/bridal/config/../lib/sane-0.1.4/lib/enumerable-extra.rb:12:in `sum'
+        from C:/dev/ruby/bridal/config/../lib/sane-0.1.4/lib/enumerable-extra.rb:12:in `each'
+        from C:/dev/ruby/bridal/config/../lib/sane-0.1.4/lib/enumerable-extra.rb:12:in `sum'
+        from C:/dev/ruby/bridal/vendor/rails/actionpack/lib/action_controller/layout.rb:189:in `layout_list'
+
+2.1
+
+   # Returns the numeric total of the elements of +enum+, using +total+ as
+   # an accumulator (0 by default). Raises an error if any of the elements
+   # are non-numeric.
+   #
+   def sum(total = 0)
+      each{ |val| total += val }
+      total
+   end
+=end
+
+   # Returns a new array containing the results of running +method+ once for
+   # every element in the enumerable object. If both arguments and a block
+   # are provided the arguments are processed first, then passed to
+   # the block.
+   #
+   # If no method is provided, then it behaves as the standard MRI method.
+   #
+   # Examples:
+   #
+   #  array = ['foo', 'bar']
+   #
+   #  # No arguments
+   #  array.map(:capitalize) => ['Foo', 'Bar']
+   #
+   #  # With arguments
+   #  array.map(:+, 'x') => ['foox', 'barx']
+   #
+   #  # With arguments and a block
+   #  array.map(:capitalize){ |e| e + 'x' } => ['Foox', 'Barx']
+   #
+   def map(method=nil, *args, &block)
+      if method
+         array  = []
+         method = method.to_sym unless method.is_a?(Symbol)
+
+         each{ |obj|
+            temp = obj.send(method, *args)
+            if block
+               array << block.call(temp)
+            else
+               array << temp
+            end
+         }
+
+         array
+      else
+         old_map(&block)
+      end
+   end
+
+   # Reset the aliases
+   alias collect map
+end
+
+class Array
+   alias old_map map
+   alias old_map! map!
+   alias old_collect collect
+   alias old_collect! collect!
+   #alias old_select select
+
+   # Returns a new array containing the results of running +block+ once for
+   # every element in the +array+.
+   #
+   # Examples:
+   #
+   #  array = ['foo', 'bar']
+   #
+   #  # No arguments
+   #  array.map(:capitalize) => ['Foo', 'Bar']
+   #
+   #  # With arguments
+   #  array.map(:+, 'x') => ['foox', 'barx']
+   #
+   #  # With arguments and a block
+   #  array.map(:capitalize){ |e| e + 'x' } => ['Foox', 'Barx']
+   #--
+   # The Array class actually has its own implementation of the +map+ method,
+   # hence the duplication.
+   # 
+   def map(method=nil, *args, &block)
+      if method
+         array  = []
+         method = method.to_sym unless method.is_a?(Symbol)
+
+         each{ |obj|
+            temp = obj.send(method, *args)
+            if block
+               array << block.call(temp)
+            else
+               array << temp
+            end
+         }
+         array
+      else
+         old_map(&block)
+      end
+   end
+
+   # Same as Array#map, but modifies the receiver in place. Also note that
+   # a block is _not_ required. If no block is given, an array of values
+   # is returned instead
+   #
+   def map!(method=nil, *args, &block)
+      self.replace(map(method, *args, &block))
+   end
+
+=begin
+   def select(method=nil, condition = nil, *args, &block)
+      array = [] unless block
+      if method
+         if block
+            warn 'block ignored when arguments provided'
+         end
+
+         if condition.nil?
+            raise 'condition must be provided if method is provided'
+         end
+
+         method = method.to_sym unless method.is_a?(Symbol)
+
+         each{ |obj|
+            if args.length > 0
+               if obj.send(method, condition, *args)
+                  array << obj
+               end
+            else
+               if obj.send(method, condition)
+                  array << obj                  
+               end
+            end
+         }
+
+         return array
+      else
+         old_select(&block)   
+      end
+   end
+=end
+
+   # Reset the aliases
+   alias collect map
+   alias collect! map!
+end

data/lib/sane_ruby/enumerable_brackets.rb

@@ -0,0 +1,10 @@
+module Enumerable
+ def [](pos)
+   idx = 0
+   self.each{|item|
+     return item if idx == pos
+     idx += 1
+   }
+ end
+end
+ 

data/lib/sane_ruby/hash_hashes.rb

@@ -0,0 +1,16 @@
+# extracted from from http://blog.playlouder.com/2008/05/07/an-interesting-ruby-hash-semantics-gotcha/
+
+if RUBY_VERSION < '1.9' # not sure if this is needed for 1.8.7 or not...
+# see http://kpumuk.info/ruby-on-rails/memo-5-use-ary-uniq-method-carefully-in-ruby and test it :)
+
+class Hash
+ def hash
+   inject(0) {|hash,pair| hash ^ pair.hash}
+ end
+
+ def eql?(other)
+   self == other
+ end
+end
+
+end

data/lib/sane_ruby/hash_set_operators_bug_fix.rb

@@ -0,0 +1,11 @@
+class Hash
+  # - should not affect the original
+  # nor delete if the key + value pair aren't equal
+  def -(hash)
+    out = self.dup
+    hash.keys.each do |key|
+      out.delete key if self[key] == hash[key]
+    end
+    out
+  end
+end

data/lib/sane_ruby/irb_startup_options.rb

@@ -0,0 +1,15 @@
+if defined? IRB
+
+  begin
+    require 'irb/completion'
 # this one can fail if readline isn't installed
+  rescue Exception
+  end
+  begin
+    IRB.conf[:AUTO_INDENT] = true
+    IRB.conf[:PROMPT_MODE] = :SIMPLE 
+    #require 'irb/ext/save-history' # this one might mess with peoples' local settings of it tho...
+  rescue Exception
+    # guess this was some *other* IRB module? defined elsewhere?
+  end
+
+end

data/lib/sane_ruby/sane_random.rb

@@ -0,0 +1,91 @@
+require 'require_all' # a necessary gem
+
+Thread.abort_on_exception = true # typically you *want* to know when a thread dies unexpectedly.
+
+require 'socket'
+BasicSocket.do_not_reverse_lookup = true
+
+# abstracted from require 'facets/file' ===>
+class File
+
+  # Writes the given data to the given path and closes the file.  This is
+  # done in binary mode, complementing <tt>IO.read</tt> in standard Ruby.
+  #
+  # Returns the number of bytes written.
+  #
+  # CREDIT: facets/Gavin Sinclair
+
+  def self.write(path, data)
+    File.open(path, "w") do |file|
+      return file.write(data)
+    end
+  end unless self.respond_to?(:write)
+
+  def self.binwrite(path, data)
+    File.open(path, "wb") do |file|
+      return file.write(data)
+    end
+  end
+
+end
+
+# more helpers
+class Object
+
+  # a helper for collection.include?
+  def in? collection
+    collection.include?(self)
+  end unless respond_to? :in
+
+  # ex: assert(some statement)
+  # or
+  # assert(some statement, "some helper string")
+  def assert(should_be_true, string = nil)
+    if(!should_be_true)
+      raise "assertion failed #{string}"
+    end
+  end unless respond_to? :assert
+
+  # helper to bring up a debugger
+  def _dbg
+    require 'rubygems'
+    require 'pp' # who would want debug without pp? not I
+    begin
+      require 'ruby-debug'
+      debugger
+    rescue LoadError => e
+      throw "unable to load ruby-debug gem for _dbg... #{e}"
+    end
+  end
+
+  # a method like puts but all on one line--very much like java's println
+  def sprint *args
+    print(*args)
+    puts
+  end
+
+  def alias_h hash
+    hash.each_pair {|new, old|
+      alias_method new, old
+    }
+  end
+
+  def singleton_class
+    class << self; self; end
+  end
+end
+
+# taken from http://oldrcrs.rubypal.com/rcr/show/309
+
+module Kernel
+  BASE_DIR = Dir.getwd
+  def __DIR__
+    dir = (/^(.+)?:\d+/ =~ caller[0]) ? File.expand_path(File.dirname($1), BASE_DIR) : nil
+    dir += '/' if dir
+    dir
+  end unless defined?(__DIR__)
+end
+
+if RUBY_VERSION >= '1.9.2'
+  $: << '.' # for some reason loading files from the cwd was taken out.  That is not sane.
+end

data/sane.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sane}
+  s.version = "0.8.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roger Pack"]
+  s.date = %q{2009-10-28}
+  s.description = %q{Helper methods for ruby to make it easier to work with out of the box--things that are missing from core but should be there}
+  s.email = ["rogerdpack@gmail.com"]
+  s.extra_rdoc_files = [
+    "ChangeLog",
+     "README"
+  ]
+  s.files = [
+    "ChangeLog",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "lib/_dbg.rb",
+     "lib/sane.rb",
+     "lib/sane_ruby/add_regexes.rb",
+     "lib/sane_ruby/bugs.rb",
+     "lib/sane_ruby/enumerable-extra.rb",
+     "lib/sane_ruby/enumerable_brackets.rb",
+     "lib/sane_ruby/hash_hashes.rb",
+     "lib/sane_ruby/hash_set_operators_bug_fix.rb",
+     "lib/sane_ruby/irb_startup_options.rb",
+     "lib/sane_ruby/sane_random.rb",
+     "sane.gemspec",
+     "spec/test_sane.spec",
+     "todo"
+  ]
+  s.homepage = %q{http://github.com/rogerdpack/sane_ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Helper methods for ruby to make it easier to work with out of the box--things that are missing from core but should be there}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<require_all>, [">= 0"])
+      s.add_runtime_dependency(%q<backports>, [">= 0"])
+      s.add_runtime_dependency(%q<hash_set_operators>, [">= 0"])
+    else
+      s.add_dependency(%q<require_all>, [">= 0"])
+      s.add_dependency(%q<backports>, [">= 0"])
+      s.add_dependency(%q<hash_set_operators>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<require_all>, [">= 0"])
+    s.add_dependency(%q<backports>, [">= 0"])
+    s.add_dependency(%q<hash_set_operators>, [">= 0"])
+  end
+end

data/spec/test_sane.spec

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../lib/sane'
+require 'rubygems'
+class TestSane; end
+
+describe TestSane do
+
+  before do
+    #Object.send(:remove_const, 'Klass') rescue nil
+  end
+
+  it "should have working __DIR__" do
+    __DIR__.should_not == nil
+  end
+
+  it "should write to files" do
+   filename = __DIR__ + '/test'
+   File.write(filename, "abc\n")
+   assert(File.exist?(filename))
+   if RUBY_PLATFORM =~ /mswin|mingw/
+     assert(File.binread(filename) == "abc\r\n") # it should have written it out *not* in binary mode
+   end
+   File.delete filename
+  end
+
+  class A
+    def go; 3; end
+    alias_h :go2 => :go
+  end
+
+  it "should aliaz right" do
+    A.new.go2.should == 3
+  end
+
+  it "should have a singleton_class method" do
+    class A; end
+    A.singleton_class.module_eval { def go; end }
+    A.go
+  end
+
+  it "should have a binread method" do
+    File.open("bin_test", "wb") do |f|; f.write "a\r\n"; end
+    assert File.binread("bin_test") == "a\r\n"
+  end  
+
+  it "should have a binwrite method" do
+   File.binwrite 'bin_test', "a\r\n"
+   assert File.binread("bin_test") == "a\r\n"
+  end
+
+  it "should hash hashes right" do
+    a = {}
+
+    a[{:a => 3, :b => 4}] = 3
+    assert a[{:b => 4, :a => 3}] == 3
+    assert a[{:b => 3, :a => 4}] == nil
+    a = {:a => 3}
+    a - {:a => 4}
+    assert a.length == 1
+ 
+  end
+
+  it "should allow regexes to be added" do
+    /a/ + /b/
+  end
+
+  it "should allow for brackets on enumerators" do
+    require 'backports' # ugh
+    assert "ab\r\nc".lines[0] == "ab\r\n"
+  end
+ 
+   
+end

data/todo

@@ -0,0 +1 @@
+merge with facets where possible!

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: sane
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+platform: ruby
+authors: 
+- Roger Pack
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-28 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: backports
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hash_set_operators
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Helper methods for ruby to make it easier to work with out of the box--things that are missing from core but should be there
+email: 
+- rogerdpack@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog
+- README
+files: 
+- ChangeLog
+- README
+- Rakefile
+- VERSION
+- lib/_dbg.rb
+- lib/sane.rb
+- lib/sane_ruby/add_regexes.rb
+- lib/sane_ruby/bugs.rb
+- lib/sane_ruby/enumerable-extra.rb
+- lib/sane_ruby/enumerable_brackets.rb
+- lib/sane_ruby/hash_hashes.rb
+- lib/sane_ruby/hash_set_operators_bug_fix.rb
+- lib/sane_ruby/irb_startup_options.rb
+- lib/sane_ruby/sane_random.rb
+- sane.gemspec
+- spec/test_sane.spec
+- todo
+has_rdoc: true
+homepage: http://github.com/rogerdpack/sane_ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Helper methods for ruby to make it easier to work with out of the box--things that are missing from core but should be there
+test_files: []
+