zucker 8 → 9

data/CHANGELOG

@@ -1,3 +1,17 @@
+2011-01-22 | Zucker 9
+* removed history versions (sorry, it caused too much gem/rdoc troubles)
+* add file cube: File.delete! and File.gsub
+* debug pack improvements
+  * binding: typos + return nil
+  * cc: support for ripl + return nil
+  * mm: also show eigenclass for modules + nicer displaying + return nil
+  * added Regexp#visualize
+* removed optional sandbox param
+* renamed xxx2proc to xxx_to_proc
+* changed rakefile/rspec/gemspec structure
+* more minor fixes and improvements
+
+
 2010-10-06 | Zucker 8
 * fixed a little alias_for bug
 * disabled rdoc creation when installing (in favour of the custom docs)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Jan Lelis
+Copyright (c) 2010-2011 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -2,6 +2,6 @@ See http://rubyzucker.info or doc/zucker_doc.html
 
 Please see the github wiki page, for discussion and contributing: http://wiki.github.com/janlelis/zucker
 
-Copyright (c) 2010 Jan Lelis, http://rbjl.net, released under the MIT license
+Copyright (c) 2010-2011 Jan Lelis, http://rbjl.net, released under the MIT license
 
 J-_-L

data/Rakefile

@@ -1,7 +1,6 @@
 require 'rake'
-# require 'rubygems'
-require 'rake/gempackagetask'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
+require 'fileutils'
 
 if RUBY_VERSION >= '1.9.2'
   require_relative 'lib/zucker'
@@ -9,47 +8,49 @@ else
   require 'lib/zucker'
 end
 
+@path = Rake.application.find_rakefile_location[1]
+
 desc 'Build documentation'
 task 'doc' do
-  zucker_path = Rake.application.find_rakefile_location[1]
-  ruby File.join(zucker_path, 'doc/zucker_doc.rb'), zucker_path
+  ruby File.join(@path, 'doc/zucker_doc.rb'), @path
 end
 
 task 'default' => 'spec'
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/*.rb']
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.ruby_opts = "-r " + File.join(@path, 'spec', 'spec_helper')
+
   if RUBY_VERSION < '1.9'
-    t.spec_files -= Zucker::NON_1_8_CUBES.map{|e| "spec/#{e}_spec.rb"}
+    t.pattern = File.join(@path, 'spec', '*_spec.rb')
+  else
+    t.pattern = File.join(@path, 'spec', '*.rb')
   end
 end
 
 # gem
-spec = Gem::Specification.new do |s|
-  s.name = 'zucker'
-  s.version = Zucker::VERSION
-  s.date = Zucker::DATE
-  s.authors = ['Jan Lelis','and others']
-  s.email = 'mail@janlelis.de'
-  s.summary = "Sweeten your Ruby code with this syntactic sugar :).
-Adds a lot of little helpers that you do not want to miss again.
-See http://rubyzucker.info"
-  s.description = s.summary
-  s.homepage = 'http://rubyzucker.info'
-  s.files = FileList[ '[a-zA-Z]*', 'lib/**/*' ].to_a
-  s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 1.8.7' # 1.9 recommended
-  s.add_development_dependency 'coderay'
-  s.has_rdoc = false
-  s.rdoc_options = '--version' # don't generate
+def gemspec
+  @gemspec ||= eval(File.read( File.join(@path, 'zucker.gemspec') ), binding, 'zucker.gemspec')
+end
+
+desc "Build the gem"
+task :gem => :gemspec do
+  sh "gem build zucker.gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
 end
 
 # release
 desc 'run specs, build doc, bump version, set date, copy version directories and add these changes to git'
-task 'prepare_release' => %w[spec doc] do # run specs and doc
+task 'prepare_release' => %w[spec] do # run specs
   # really want to release?
   print 'Do you really want to release? ...then enter release: '
   exit if $stdin.gets.chomp != 'release'
@@ -61,15 +62,7 @@ task 'prepare_release' => %w[spec doc] do # run specs and doc
   zucker_rb.sub! /DATE\s*=.*$/, "DATE = '#{Date.today}'"
   File.open 'lib/zucker.rb','w' do |f| f.write zucker_rb end
 
-  # copy version directories
-  `mkdir lib/zucker/#@v`
-  `cp lib/zucker/*.* lib/zucker/#@v/`
-  `mkdir desc/#@v`
-  `cp desc/*.* desc/#@v/`
-  `mkdir doc/#@v`
-  `cp doc/*.* doc/#@v/`
-  `mkdir spec/#@v`
-  `cp spec/*.* spec/#@v/`
+  `rake doc`
 
   # add changes to git and tag
   `git add .`
@@ -80,10 +73,10 @@ task 'prepare_release' => %w[spec doc] do # run specs and doc
    puts "prepared Zucker #@v gem release"
 end
 
-desc 'prepare_release, build gem, and push it to git and rubygems'
+desc 'prepare_release, build gem, and push it to git and display rubygems push command'
 task 'release' => %w[gem] do
+  `git push origin master`
   `git push origin master --tags`
-  last_gem = Dir['pkg/zucker-*.gem'].sort[-1] # TODO better sorting or date for zucker-10
-  exit if last_gem =~ /next/ # some error happened, do not pollute rubygems.org
+  last_gem = Dir['pkg/zucker-*.gem'].sort[-1] # TODO read version from lib/zucker.rb for zucker-10
   puts "gem push pkg/#{last_gem}"
 end

data/desc/alias_for.yaml

@@ -0,0 +1,17 @@
+alias_for:
+  summary: 'A different way to create aliases: Reversed order and you can pass multiple alias names.'
+  why: "It's clearer in which order to put the arguments."
+  methods:
+    alias_for, aliases_for: |
+      alias_for :methods, :ms # creates an alias for the method :methods with the name ms
+      module Enumerable
+        aliases_for :zip, :with, :%
+      end # creates multiple aliases
+    Module#method_alias_for, Module#method_aliases_for: |
+      # same as alias_for, but using Module#alias_method instead of alias
+  info: 
+  - Thanks to Kristian Mandrup for the idea and alias method specs.
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/aliases.yaml

@@ -0,0 +1,18 @@
+aliases:
+  summary: Some convenient aliases (and constants) for existing methods.
+  methods:
+    Object#is_an?: Object.is_a?
+    Enumerable#with: Enumerable#zip
+    Enumerable#%: Enumerable#zip
+    Array#**: Array#product
+    Hash#+: Hash#merge
+    Binding#[]: Binding#eval
+    File.filename: File.basename
+    Dir.join: File.join
+    Dir.split: File.split
+    Infinity: 1.0 / 0.0
+    NaN: 0.0 / 0.0
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/array.yaml

@@ -0,0 +1,13 @@
+array:
+  summary: Methods one could miss for ⇧Array⇧.
+  why:
+  - ⇧Array⇧ has ⇧&⇧ and ⇧|⇧, but why does it not have ⇧^⇧?
+  - ⇧sum⇧ is just needed pretty often..
+  methods:
+    Array#^: "[1,2,3,4] ^ [3,4,5,6]  # => [1,2,5,6]"
+    Array#sum: "[1,2,3,4,5].sum  # => 15"
+    Array#chrs: "[72, 97, 108, 108, 111].chrs  # => 'Hallo'"
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/array_to_proc.yaml

@@ -0,0 +1,16 @@
+array_to_proc:
+  summary: Calls the method named by the first paramenter and passes the other elements as paramaters.
+  why: When using ⇧Symbol#to_proc⇧, you often wish to pass parameters.
+  methods:
+    Array#to_proc: |
+      [1,2,3,4].map &[:*, 5] # => [5, 10, 15, 20]
+      # you can also chain them, if the first parameter is an Array
+      [1,2,3,4].map &[[:to_s, 2],[:+, 'b']]   # => ["1b", "10b", "11b", "100b"]
+  info:
+  - Inspired by →this article→http://www.sanityinc.com/articles/adding-array-to-proc-to-ruby→.
+  - "More about →to_proc→http://rbjl.net/29-become-a-proc-star→."
+  - Chaining inspired by →eregon→http://github.com/eregon/Classes/blob/master/to_proc.rb→.
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/binding.yaml

@@ -0,0 +1,22 @@
+binding:
+  summary: Adds a ⇧Binding#vars⇧. It gives you information about the current environment variables.
+  methods:
+    Binding#variables, Binding#vars: |
+     # shows your current environment's variables, irb example:
+     >> a=3
+     => 3
+     >> binding.vars
+     => #<Binding:0x94c4b50>
+     local variables
+      - a: 3
+      - _: #<Binding:0x94c4b50>
+     (instance variables)
+      - none
+     self
+      - main
+     block_given?
+      - false
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/blank.yaml

@@ -0,0 +1,9 @@
+blank:
+  summary: Does pretty the same as in ActiveSupport (Every object can be asked if it is blank).
+  why: It's too familiar ;)
+  methods:
+    Object#blank?: "'an object'.blank? # => false"
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/cc.yaml

@@ -0,0 +1,10 @@
+cc:
+  summary: ⇧c⇧ outputs the current method callstack.
+  methods:
+    c, cc: |
+      c # shows the method callstack
+      c true # do not hide irb/ripl callstack
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/class_to_proc.yaml

@@ -0,0 +1,11 @@
+class_to_proc:
+  summary: Creates a new instance of the class.
+  methods:
+    Class#to_proc: "[ [1,2],[3,5,6,7,3] ].map(&Set) # => [ Set[1,2], Set[5,6,7,3] ]"
+  info:
+  - Inspired by Ruby Facets.
+  - "More about →to_proc→http://rbjl.net/29-become-a-proc-star→."
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/dd.yaml

@@ -0,0 +1,23 @@
+dd:
+  summary: Easy debug printing with the ⇧p⇧ alternative ⇧.d⇧. It outputs to stdout and returns ⇧self⇧. Accepts a block.
+  methods:
+    Object#d, Object#dd: |
+      some.d.methods.d.noone.d.knows.d
+      # ...outputs 4 lines with the inspected objects
+      # => (result)
+
+      21+Math.sin(42).d
+      # outputs -0.916521547915634
+      # => 20.0834784520844
+
+      name = 'Earth'
+      'Hello ' + name.d{|e| "The length is: #{e.size}"}
+      # outputs "The length is: 5"
+      # => 'Hello Earth'
+  info:
+  - "This is inspired by the →⇧.tap⇧ method→http://moonbase.rydia.net/mental/blog/programming/eavesdropping-on-expressions→."
+  - There is also ⇧tap⇧ cube with more ⇧tap⇧ methods.
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/egonil.yaml

@@ -0,0 +1,15 @@
+egonil:
+  summary: Creates a block, where ⇧nil⇧ does not raise ⇧NoMethodError⇧s.
+  methods:
+    egonil, nn: |
+      egonil do
+        nil.some_methods.that[:do].not.exist
+      end # => nil
+
+      nn{ nil.some_methods.that[:do].not.exist } # => nil
+  info:
+  - See →this post→http://rbjl.net/26-the-28-bytes-of-ruby-joy→ for more information and discussion.
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/engine.yaml

@@ -0,0 +1,15 @@
+engine:
+  summary: Adds a ⇧RubyEngine⇧ class for easy compatibility checks.
+  methods:
+    RubyEngine: |
+    RubyEngine: "# outputs the interpreter name"
+    RubyEngine.mri?: "RubyEngine.mri? # true if using the official Ruby interpreter"
+    RubyEngine.jruby?: "RubyEngine.jruby? # true if using JRuby"
+    RubyEngine.rubinius?: "RubyEngine.rubinius? # true if using rubinius"
+    RubyEngine.ree?: "RubyEngine.ree? # true if using enterprise edition"
+    RubyEngine.ironruby?: "RubyEngine.ironruby? # true if using IronRuby"
+    RubyEngine.macruby?: "RubyEngine.macruby? # true if using MacRuby"
+    RubyEngine.cardinal?: "RubyEngine.cardinal? # true if using parrot"
+  versions:
+  - 1.9
+  - 1.8

data/desc/enumerable.yaml

@@ -0,0 +1,10 @@
+enumerable:
+  summary: ⇧Enumerable⇧ extensions.
+  methods:
+    Enumerable#mash: "[1,2,3].mash{|e| [e, e.to_s] } # => {1=>'1',2=>'2',3=>'3'}"
+  info:
+  - Inspired by Ruby Facets' ⇧mash⇧.
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/file.yaml

@@ -0,0 +1,15 @@
+file:
+  summary: Extensions for ⇧File⇧.
+  methods:
+    File#gsub: |
+      File.gsub 'some_filename', {
+        /hi/ => 'cu',
+        /\d/ => proc do ($&.to_i+1).to_s end
+      } # will read the file and substitute the hash keys with their values
+    File#delete!: "File.delete! 'some_filename' # will delete the file, don't care if it exist."
+  info:
+  - "Idea for ⇧.File#delete!⇧. from sugar-high."
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/hash.yaml

@@ -0,0 +1,14 @@
+hash:
+  summary: Some sugar for dealing with hashs.
+  methods:
+    Hash.zip: "Hash.zip [1,2,3], [4,5,6] # => {1=>4, 2=>5, 3=>6}"
+    Hash#<<: |
+      {1=>2} << [3, 4]   # => { 1=>2, 3=>4 }
+      {1=>2} << { 5=>6 } # => { 1=>2, 5=>6 }
+    Hash#&: "{ 1=>4, 2=>5, 3=>6 } & { 1=>4, 2=>7 } # => { 1=>4 }"
+  info:
+  - Some of the operators are inspired by Ruby Facets.
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/hash_to_proc.yaml

@@ -0,0 +1,10 @@
+hash_to_proc:
+  summary: Use a hash to apply procs to specific objects.
+  methods:
+    Hash#to_proc: "[1,2,3,4].map(&{\n2 => lambda {|e| e + 1000},\n4 => :to_s,\n}) # => [1, 1002, 3, '4']"
+  info:
+  - "More about →to_proc→http://rbjl.net/29-become-a-proc-star→."
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/info.yaml

@@ -0,0 +1,20 @@
+info:
+  summary: Access environment information with the ⇧Info⇧ module.
+  why: "You don't need to remember in which global variable, constant or special method the information you are searching for is hidden."
+  methods:
+    Info: |
+      # for example
+      Info.working_directory # Dir.pwd
+      Info.load_path         # $:
+      Info.platform          # RUBY_PLATFORM
+      Info.current_file      # similar to __FILE__
+      # you could also add them to the global namespace with: include Info
+      # see the source file for the list of accessors or
+      Info.list
+  info:
+  - Please note that it is not possible to put some of __THOSE_KEYWORDS__ in methods, so the result might slightly differ. This might affect ⇧current_file⇧, ⇧current_file_directory⇧, ⇧current_line⇧ and ⇧current_method⇧.
+  - Thanks to Facets for the ⇧caller⇧ Regexp.
+  versions:
+  - 1.9
+  - 1.8 (not all information)
+

data/desc/iterate.yaml

@@ -0,0 +1,16 @@
+iterate:
+  summary: Iterate over one or more collections.
+  why: "It's like ⇧.each⇧ with two differences: It feels more like a control structure and you can easily iterate over multiple objects."
+  methods:
+    iterate: |
+      iterate [1,2], [3,4,5] do |e,f|
+        puts "#{e},#{f}"
+      end
+      # outputs
+      #  1,3
+      #  2,4
+      #  ,5
+  versions:
+  - 1.9
+  - 1.8
+

data/desc/ivars.yaml

@@ -0,0 +1,19 @@
+ivars:
+  summary: This method lets you easily assign lots of instance variables.
+  why: |
+   Often, you have to write boilerplate code for assigning instance variables, for example this one:
+   ⇧def initialize(variable1, variable2)
+     @variable1, @variable2 = variable1, variable2
+   end⇧
+  methods:
+    instance_variables_from, ivars: |
+      def a_method(a = 1, b = 2)
+        instance_variables_from binding # assigns @a and @b
+
+        params = {:c => 3, :d => 4}
+        instance_variables_from params # # assigns @c and @d
+      end
+  versions:
+  - 1.9
+  - 1.8
+