andand 1.3.1 → 1.3.3

data/History.txt

@@ -1,3 +1,12 @@
+== 1.3.2
+
+* 1 minor enhancement
+  * better docs
+* 2 major enhancement:
+  * Fix 1.9 warning (patch by George MacKerron)
+* 3 major enhancement:
+  * Remove deprecated gemspec information (patch by Anthony Panozzo)
+
 == 1.3.1 2008-07-12
 
 * 1 major enhancement:

data/{website/index.txt → README.textile}

@@ -1,10 +1,12 @@
 h1. Object#andand
 
-h1. → 'andand'
+h2. Breaking News
+
+@Object#andand@'s functionality is also available as part of the "RewriteRails":http://github.com/raganwald/rewrite_rails plug-in. If you are using Ruby on Rails, please consider using RewriteRails instead of the andand gem.
 
 h2. What
 
-_Object#andand_ lets us write:
+@Object#andand@ lets us write:
 
 <pre syntax="ruby">
 @phone = Location.find(:first, ...elided... ).andand.phone
@@ -24,7 +26,17 @@ entry.at('description').andand.inner_text
 
 h2. Installing
 
-<pre syntax="ruby">sudo gem install andand</pre>
+Update to RubyGems 1.2.0 before proceeding!!
+
+<pre syntax="ruby">sudo gem sources -a http://gems.github.com (you only have to do this once)
+sudo gem install raganwald-andand</pre>
+
+Or:
+
+<pre syntax="ruby">git clone git://github.com/raganwald/andand.git
+cd andand
+rake gem
+rake install_gem</pre>
 
 h2. The basics
 
@@ -55,19 +67,31 @@ Object#andand let&rsquo;s us write:
 list_of_lists.detect { ...elided... }.andand.inject(42) { ...elided ... }
 </pre>Object#andand emphasizes syntactic regularity: the goal was to make an @&&.@ operation that worked like @&&=@. @&&=@ looks just like normal assignment, you can use any expression on the RHS, only the semantics are different. The andand method also works just like a normal method invocation, only the semantics are modified.
 
-h3. Use andand to simplify your regular expression matching and extraction
+h3. Block-Structured andand
+
+You can use @andand@ with a block instead of a method:
+
+<pre syntax="ruby">
+@phone =  Location.find(:first, ...elided... ).andand { |location|
+  YellowPages.reverse_lookup(location).phone
+}
+</pre>If the receiver is nil, the block is not executed and @andand@ returns @nil@. If the receiver is not nil, it is passed as a parameter to the block and @andand@ returns the value of the block. This makes it possible to perform conditional evaluation and also to make the scope of the variable really obvious.
+
+h3. Scope
+
+@Object#andand@ only works for one method call. For example, @fu.andand.bar.blitz@ is going to call @nil.blitz@ if @fu@ is @nil@. That's because @fu.andand.bar@ is going to evaluate to @nil@, and then we will call the method @blitz@ on it. In most cases, you want to use @fu.andand.bar.andand.blitz@. If that seems awkward, you might want to reconsider violating the Law of Demeter in an environment where you can't be sure if your receiver is @nil@ or not.
 
-Do you ever find yourself wanting to extract a single value from a string using a regular expression? For example, Ruby's Tempfile class creates paths to files that end in .pid.n (where pid is your process id and n is some number). Do you have a path that might be a tempfile and you want to obtain the base name?
+Another example of this (pointed out by Jan Zimmek):
 
-Do you currently retrieve the MatchData object, check if it is nil, and get the first matching group if it isn't? How about:
+<pre syntax="ruby">
+x = nil
+x.andand.length > 3
+</pre>This results in a @NoMethodError@. Again, @x@ is @nil@, therefore @x.andand.length@ is @nil@, therefore we end up with @nil > 3@ which results in a @NoMethodError@. This can be fixed with @x.andand.length.andand > 3@ as above, or perhaps:
 
 <pre syntax="ruby">
-require 'tempfile'
-path = Tempfile.new('foo.bar').path
-	=> "/var/folders/UZ/UZyZsbVPEWqC7tTXrQBYGU+++TI/-Tmp-/foo.bar.1280.0"
-path.match('/([^/]+)\.[0-9]+\.[0-9]+$').andand[1]
-	=> "foo.bar"
-</pre>With @.andand[1]@, you extract the group in the regular expression safely: if the expression matches, you get the group. If the expression fails to match, you get nil. Which is what you want, isn't it? The contents of the group if the expression matches? Why should you need more than one line for something so simple?
+x = nil
+x.andand { |value| value.length > 3 }
+</pre>
 
 h3. Enhanced Object#tap
 
@@ -121,7 +145,7 @@ h2. How to submit patches
 
 Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.
 
-The trunk repository is @svn://rubyforge.org/var/svn/andand/trunk@ for anonymous access.
+The public clone url is @git://github.com/raganwald/andand.git@. Fork you very much.
 
 h2. License
 
@@ -131,6 +155,8 @@ h2. Shout Out
 
 "Mobile Commons":http://mcommons.com/. Huge.
 
+Also interesting: "Wicked":http://github.com/wideopenspaces/wicked
+
 h2. Contact
 
-Comments are welcome. Send an email to "Reginald Braithwaite":mailto:raganwald+rubyforge@gmail.com.
+Comments are welcome. Send an email to "Reginald Braithwaite":mailto:raganwald@gmail.com.

data/lib/andand.rb

@@ -98,8 +98,8 @@ class Object
   include AndAnd::ObjectGoodies
 end
   
-unless Module.constants.include?('BlankSlate')
-  if Module.constants.include?('BasicObject')
+unless Module.constants.map { |c| c.to_s }.include?('BlankSlate')
+ if Module.constants.map { |c| c.to_s }.include?('BasicObject')
     module AndAnd
       class BlankSlate < BasicObject
       end

data/lib/andand/version.rb

@@ -2,7 +2,7 @@ module Andand #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 3
-    TINY  = 1
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/andand_spec.rb

@@ -0,0 +1,133 @@
+=begin
+
+Copyright (c) 2008 Reginald Braithwaite
+http://weblog.raganwald.com/2008/01/objectandand-objectme-in-ruby.html
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+=end
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'andand'
+
+class Symbol
+  def to_proc
+    Proc.new { |*args| args.shift.__send__(self, *args) }
+  end
+end
+
+describe AndAnd, "Basic Behaviour" do
+  it "should conditionally yield to a block" do
+    5.andand { |n| n*n }.should == 25
+    5.andand(&:succ).should == 6
+    nil.andand { |n| n*n }.should == nil
+    false.andand { |n| n*n }.should == false
+  end
+  it "should conditionally call a proc-able parameter" do
+    5.andand(:succ).should == 6
+    nil.andand(:succ).should == nil
+    false.andand(:succ).should == false
+  end
+  it "should conditionally proxy methods" do
+    5.andand.succ.should == 6
+    nil.andand.succ.should == nil
+    false.andand.succ.should == false
+    (1..10).andand.inject(&:+).should == 55
+    nil.andand.inject(&:+).should == nil
+    false.andand.inject(&:+).should == false
+    'HelloWeblogReaders'.andand[7,4].should == 'blog'
+    nil.andand[7,4].should == nil
+    false.andand[7,4].should == false
+    'HelloWeblogReaders'.andand.tr('Wb','Bd').should == 'HelloBedlogReaders'
+    nil.andand.tr('Wb','Bd').should == nil
+    false.andand.tr('Wb','Bd').should == false
+  end
+  it "should handle infix operators" do
+    (5.andand * 2).should == 10
+    (nil.andand * 2).should == nil
+    (false.andand * 2).should == false
+  end
+end
+
+describe AndAnd, "Me" do
+  it "should unconditionally yield to a block" do
+    5.me { |n| n*n }.should == 5
+    5.me(&:succ).should == 5
+    nil.me { |n| n || true }.should be_nil
+    false.me { |n| n || true }.should == false
+  end
+  it "should unconditionally call a proc-able parameter" do
+    5.me(:to_s).should == 5
+    nil.me(:to_s).should == nil
+    false.me(:to_s).should == false
+  end
+  it "should proxy methods" do
+    5.me.to_s.should == 5
+    nil.me.to_s.should == nil
+    false.me.to_s.should == false
+    (1..10).me.inject(&:+).should == (1..10)
+    'HelloWeblogReaders'.me[7,4].should == 'HelloWeblogReaders'
+    'HelloWeblogReaders'.me.tr('Wb','Bd').should == 'HelloWeblogReaders'
+  end
+  it "should handle infix operators" do
+    (5.me * 2).should == 5
+  end
+end
+
+describe AndAnd, "Mixing Me with AndAnd" do
+  it "should compose me.andand" do
+    frobbish = :blitz
+    :foo.me.andand do
+      frobbish = :bar
+    end.should == :foo
+    frobbish.should == :bar
+    nil.me.andand do
+      frobbish = :barbarella
+    end.should be_nil
+    frobbish.should == :bar
+    false.me.andand do
+      frobbish = :hope
+    end.should == false
+    frobbish.should == :bar
+  end
+end
+
+class Foo
+  def frobbish
+    'fnord'
+  end
+end
+
+describe AndAnd, "exception handling" do
+  it "should not swallow NoMethodErrors" do
+    foo = Foo.new
+    lambda do
+      foo.andand.frobbish
+      nil.andand.frobbish
+      nil.andand.hsibborf
+    end.should_not raise_error
+    lambda do
+      foo.andand.hsibborf
+    end.should raise_error
+  end
+end

metadata

@@ -1,83 +1,63 @@
 --- !ruby/object:Gem::Specification 
 name: andand
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  prerelease: 
+  version: 1.3.3
 platform: ruby
 authors: 
-- Reginald Braithwaite
+- Reg Braithwaite
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-07-13 00:00:00 -04:00
-default_executable: 
+date: 2012-03-28 00:00:00 Z
 dependencies: []
 
-description: adds guarded method invocation to Ruby
-email: 
-- reg@braythwayt.com
+description: " Maybe Monad in idiomatic Ruby."
+email: reg@braythwayt.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- License.txt
-- Manifest.txt
-- README.txt
-- website/index.txt
+- README.textile
 files: 
 - History.txt
 - License.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- config/hoe.rb
-- config/requirements.rb
+- README.textile
 - lib/andand.rb
 - lib/andand/version.rb
-- log/debug.log
-- script/destroy
-- script/generate
-- script/txt2html
-- setup.rb
-- tasks/deployment.rake
-- tasks/environment.rake
-- tasks/website.rake
-- test/test_andand.rb
+- test/andand_spec.rb
 - test/test_helper.rb
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- website/template.rhtml
-has_rdoc: true
-homepage: http://andand.rubyforge.org
+homepage: http://github.com/raganwald/andand/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.textile
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: andand
-rubygems_version: 1.2.0
+rubyforge_project: 
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 2
-summary: adds guarded method invocation to Ruby
+specification_version: 3
+summary: The Maybe Monad in idiomatic Ruby
 test_files: 
-- test/test_andand.rb
+- test/andand_spec.rb
 - test/test_helper.rb

data/Manifest.txt

@@ -1,24 +0,0 @@
-History.txt
-License.txt
-Manifest.txt
-README.txt
-Rakefile
-config/hoe.rb
-config/requirements.rb
-lib/andand.rb
-lib/andand/version.rb
-log/debug.log
-script/destroy
-script/generate
-script/txt2html
-setup.rb
-tasks/deployment.rake
-tasks/environment.rake
-tasks/website.rake
-test/test_andand.rb
-test/test_helper.rb
-website/index.html
-website/index.txt
-website/javascripts/rounded_corners_lite.inc.js
-website/stylesheets/screen.css
-website/template.rhtml

data/README.txt

@@ -1,17 +0,0 @@
-README
-
-andand is a method that provides _guarded method invocation_, analagous to the && operator in Ruby, and especially &&=.
-
-For example:
-
-Instead of phone && phone = phone.trim, Ruby lets you say phone &&= phone.trim. So with andand, instead of:
-
-phone && phone.call
-
-We can write:
-
-phone.andand.call (A poor man's attempt to write phone&&.call)
-
-See:
-
-http://weblog.raganwald.com/2008/01/objectandand-objectme-in-ruby.html

data/Rakefile

@@ -1,4 +0,0 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -1,70 +0,0 @@
-require 'andand/version'
-
-AUTHOR = 'Reginald Braithwaite'  # can also be an array of Authors
-EMAIL = "reg@braythwayt.com"
-DESCRIPTION = "adds guarded method invocation to Ruby"
-GEM_NAME = 'andand' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'andand' # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-RUBYFORGE_USERNAME = "raganwald"
-def rubyforge_username
-  unless @config
-    begin
-      @config = YAML.load(File.read(File.expand_path(@config_file)))
-    rescue
-      puts <<-EOS
-ERROR: No rubyforge config file found: #{@config_file}
-Run 'rubyforge setup' to prepare your env for access to Rubyforge
- - See http://newgem.rubyforge.org/rubyforge.html for more details
-      EOS
-      exit
-    end
-  end
-  RUBYFORGE_USERNAME.replace @config["username"]
-end
-
-
-REV = nil 
-# UNCOMMENT IF REQUIRED: 
-# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
-VERS = Andand::VERSION::STRING + (REV ? ".#{REV}" : "")
-RDOC_OPTS = ['--quiet', '--title', 'andand documentation',
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps 
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
-    @extra_deps
-  end 
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.developer(AUTHOR, EMAIL)
-  p.description = DESCRIPTION
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-  
-  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
-  
-end
-
-CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
-hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
-hoe.rsync_args = '-av --delete --ignore-errors'