freighthopper 0.1.9 → 0.1.11

data/README.textile

@@ -1,3 +1,142 @@
 h1. Freighthopper
 
-h2. Some monkeypatches for riding the Rails
+h2. Some monkeypatches for riding the Rails
+
+h3. Antonym Accessor
+
+Antonym accessor provides some simple ruby sugar for defining inverse relationships, like between private and public, enabled and disabled, on and off, etc.  I found myself defining these often enough I figured I'd extract the functionality.
+
+<pre><code>class Example
+  def private?() @private end
+  def private=(p) @private = p end
+  antonym_accessor :private => :public
+end
+
+e = Example.new
+e.private = true
+e.public? #=> false
+e.public = true
+e.private? #=> false
+</code></pre>
+
+h3. Define and alias
+
+The @alias_method_chain@ pattern requires you to def the method and then separately alias_method_chain it.  This pattern is not as dry as it could be.  Hence, @define_and_alias@.
+
+<pre><code>
+# What would previously have been:
+def foo_with_something(arg)
+  foo_without_something arg
+  5.times {puts arg}
+end
+alias_method_chain :foo, :something
+
+# Becomes:
+define_and_alias :foo, :something do |arg|
+  foo_without_something arg
+  5.times {puts arg}
+end
+</code></pre>
+
+One less line, and more dry.
+
+h3. Eval with options
+
+This is a slight tweak to @with_options@.  Here's the transformation in code:
+
+<pre><code># What was:
+map.with_options :name => 'freighthopper' do |fh|
+  fh.something
+  fh.that
+end
+
+# Becomes
+
+map.eval_with_options :name => 'freighthopper' do
+  something
+  that
+end
+</code></pre>
+
+h3. Is one of
+
+<pre><code># What was
+if object.is_a?(Foo) || object.is_a?(Bar) || object.is_a?(Bibble)
+  ...
+end
+
+#or maybe it was
+
+case object
+when Foo, Bar, Bibble
+  ...
+end
+
+#becomes
+if object.is_one_of? Foo, Bar, Bibble
+  ...
+end
+</code></pre>
+
+h3. Lazy alias
+
+<pre><code># What was:
+def to_s() name end
+#this is not the same as alias_method, because if #name
+#is defined through method missing / lazily, it won't
+#work.  Lazy alias is like alias_method, lazy-style
+
+lazy_alias :to_s, :name
+</code></pre>
+
+h3. Or if blank
+
+There are lots of implementations of this, but this is mine.  If the object has a blank method, it is called.  @or_if_blank@ can be called with an normal argument or a block.
+
+<pre><code>"".or_if_blank(:something_else) #=> :something_else
+
+[].or_if_blank { something_expensive_that_returns("hello") } #=> "hello"
+
+"not blank".or_if_blank(42) #=> "not blank"
+</code></pre>
+
+h3. Soft send
+
+This is like try.  It sends the method if the object responsds to the method, otherwise it returns nil.  Use like send.
+
+h3. Stdout extensions
+
+It bothers me that @p@, @puts@, @print@, and @pp@ all return @nil@.  This patch makes them return their arguments, which allows you to wrap anything with @p(...)@ and it'll still work.
+
+<pre><code>
+5 + p(5) #=> 10
+# 5</code></pre>
+
+Additionally, sometimes there's a puts left somewhere in your code and you'd really like to know where that stdout noise is coming from.  Enter @Kernel.trace_output@:
+
+<pre><code>Kernel.trace_output = true
+puts "hello"
+#test.rb:4:in `puts'
+#hello
+</code></pre>
+
+h3. String extensions
+
+TODO: documentation
+
+h3. Hash extensions
+
+TODO: documention
+
+h3. Float extension
+
+TODO: documentation
+
+h3. Array extensions
+
+TODO: documentation
+
+h3. ActiveRecord extensions
+
+TODO: documentation
+

data/lib/freighthopper.rb

@@ -2,5 +2,6 @@
   activerecord array float/to_s hash/map_keys string
   antonym_accessor array define_and_alias eval_with_options
   is_one_of lazy_alias or_if_blank soft_send stdout_extensions
+  fixnum
 }.each {|lib| require "freighthopper/#{lib}"}
 

data/lib/freighthopper/define_and_alias.rb

@@ -1,3 +1,5 @@
+require 'active_support'
+
 class Module
   def define_and_alias(target, feature, &blk)
     aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1

data/lib/freighthopper/fixnum.rb

@@ -0,0 +1,5 @@
+class Fixnum
+  def of(&blk)
+    (0...self).map &blk
+  end
+end

data/lib/freighthopper/or_if_blank.rb

@@ -1,3 +1,5 @@
+require 'freighthopper/soft_send'
+
 class Object  
   def or_if_blank(val = nil)
     if soft_send :blank?

data/test/antonym_accessor_test.rb

@@ -14,7 +14,7 @@ class HashForm < TestClass
   antonym_accessor :private => :public
 end
 
-class ArrayTest < Test::Unit::TestCase
+class AntonymAccessorTest < Test::Unit::TestCase
   def self.should_act_like_antonym_accessor
     should 'define a public= method' do
       @instance.public = true

data/test/fixnum_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../test_helper", __FILE__)
+require 'freighthopper/fixnum'
+
+class FixnumTest < Test::Unit::TestCase
+  context 'of' do
+    should 'give me five of what the block returns' do
+      assert_equal %w(hello hello), 2.of { "hello" }
+    end
+
+    should 'yield the index' do
+      assert_equal %w( 0 1 2 3 ), 4.of {|i| i.to_s }
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: freighthopper
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 1
-  - 9
-  version: 0.1.9
+  - 11
+  version: 0.1.11
 platform: ruby
 authors: 
 - Jacob Rothstein
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-24 00:00:00 -07:00
+date: 2010-07-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +41,7 @@ files:
 - lib/freighthopper/array/symbols.rb
 - lib/freighthopper/define_and_alias.rb
 - lib/freighthopper/eval_with_options.rb
+- lib/freighthopper/fixnum.rb
 - lib/freighthopper/float/to_s.rb
 - lib/freighthopper/hash/map_keys.rb
 - lib/freighthopper/is_one_of.rb
@@ -57,6 +58,7 @@ files:
 - test/antonym_accessor_test.rb
 - test/array_test.rb
 - test/define_and_alias_test.rb
+- test/fixnum_test.rb
 - test/float_test.rb
 - test/hash_test.rb
 - test/kernel_test.rb
@@ -102,6 +104,7 @@ test_files:
 - test/antonym_accessor_test.rb
 - test/array_test.rb
 - test/define_and_alias_test.rb
+- test/fixnum_test.rb
 - test/float_test.rb
 - test/hash_test.rb
 - test/kernel_test.rb