patternmatching 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2007-06-03
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 ICHIYAMA Ryoichi
+
+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.

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+examples/enumerable_matching.rb
+examples/hash_matching.rb
+examples/matching.rb
+examples/object_matching.rb
+examples/partial_style_method.rb
+examples/partial_style_method2.rb
+lib/patternmatching.rb
+lib/patternmatching/pattern.rb
+lib/patternmatching/version.rb
+scripts/makemanifest.rb
+scripts/txt2html
+setup.rb
+spec/patternmatching_spec.rb
+spec/spec.opts
+spec/spec_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

@@ -0,0 +1,163 @@
+h1. PatternMatching module
+
+h1. → 'patternmatching'
+
+h2. What
+
+Provides a pure ruby module that:
+* can build structured objects easily
+* can enable pattern match of objects
+* can define method as a partial function style
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install patternmatching</pre>
+
+h2. The basics
+
+This module provides methods for tree pattern matching features.
+
+* For detail, see Wikipedia: "Pattern matching":http://en.wikipedia.org/wiki/Pattern_matching
+* Syntax based on meta-programming, like "rspec", and so on.
+
+Note: Default equivalence used in structured pattern matching is 
+based on "pattern === data", so "foo(Numeric)" matches with "foo(100)"
+
+Note: Not thread safe now.
+
+h2. Demonstration of usage
+
+<h3>Pattern matching expression</h3>
+<pre>
+require "patternmatching"
+
+# For DSL style code, include PatternMatching
+include PatternMatching
+
+# match example
+def calc(code)
+  make(code) {
+    seems as {plus(:x, :y)} do calc(x) + calc(y) end
+    seems as {mul(:x, :y)} do  calc(x) * calc(y) end
+    seems something do code end
+  }
+end
+
+code = build {plus(mul(100, 100), 200)}
+p calc(code) #=> 10200
+</pre>
+
+<h3>Partial style method</h3>
+<pre>
+require "patternmatching"
+
+# Structured data builder
+code = PatternMatching.build {plus(mul(100, 100), 200)}
+
+# Partial style method example
+class Calc
+  # At first, extends with the module
+  extend PatternMatching
+
+  # def calcm(o), as 3 partial styles
+  func(:calcm).seems as {plus(:x, :y)} do
+    calcm(x) + calcm(y)
+  end
+  func(:calcm).seems as {mul(:x, :y)} do
+    calcm(x) * calcm(y)
+  end
+  func(:calcm).seems as {:value} do
+    value
+  end
+end
+
+# use as standard method
+p Calc.new.calcm(code) #=> 10200
+</pre>
+
+<h3>Array/Enumerable pattern</h3>
+<pre>
+require "patternmatching"
+
+include PatternMatching
+
+# Example for matching Enumerable
+is = build { exact([1,2,3,4,5]) }
+make is do
+   # _!  matches rest of lists
+  seems as {exact([:a,:b, _!(:c)])} do
+    puts a.to_s + ", " + b.to_s  + " and " + c.to_s
+  end
+  seems something do
+    puts "not matched"
+  end
+end # => "1, 2, and 345"
+</pre>
+
+<h3>Hash pattern</h3>
+<pre>
+require "patternmatching"
+
+include PatternMatching
+
+# Example for matching Hash
+dict = build { {:name => "Taro", :age => 5} }
+make dict do
+  seems as {{:name => :name}} do
+    puts "He is " + name
+  end
+  seems something do
+    puts "no name"
+  end
+end # => "He is Taro"
+</pre>
+
+<h3>Non-Hash/Object pattern</h3>
+<pre>
+require "patternmatching"
+
+include PatternMatching
+
+class Person
+  def initialize(name, age)
+    @name = name
+    @age = age
+  end
+  attr :name
+  attr :age
+end
+
+# Example for matching Object except Hash
+person = Person.new("Jiro", 3)
+make person do
+  seems as {{:name => :name}} do
+    puts "He is " + name
+  end
+  seems something do
+    puts "no name"
+  end
+end # => "He is Jiro"
+</pre>
+
+h2. Forum
+
+
+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/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/patternmatching/trunk</code> for anonymous access.
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Link
+
+* "Web Site":http://patternmatching.rubyforge.org/
+* "Project Page":http://rubyforge.org/projects/patternmatching/
+
+h2. Contact
+
+Comments are welcome. Send an email to "ICHIYAMA Ryoichi":mailto:bellbind@gmail.com. "My blog":http://d.hatena.ne.jp/bellbind (written in Japanese) could be help you.
+

data/Rakefile

@@ -0,0 +1,143 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'patternmatching', 'version')
+
+AUTHOR = 'ICHIYAMA Ryoichi'  # can also be an array of Authors
+EMAIL = "bellbind@gmail.com"
+DESCRIPTION = %{Provide a pure ruby module that 
+can build structured objects easily, 
+can enable pattern match of objects, 
+and can define method as a partial function style.}
+GEM_NAME = 'patternmatching' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+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 ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'patternmatching' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "patternmatching"
+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 = PatternMatching::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'patternmatching documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  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.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #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')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+# task :website => [:website_generate]
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.libs << "lib"
+end
+
+desc "Default task is to run specs"
+task :default => :spec
+

data/examples/enumerable_matching.rb

@@ -0,0 +1,16 @@
+
+require "patternmatching"
+
+include PatternMatching
+
+# Example for matching Enumerable
+inputs = build { exact([1,2,3,4,5]) }
+make inputs do
+  # _! matches rests of list
+  seems as {exact([:a,:b, _!(:c)])} do
+    puts a.to_s + ", " + b.to_s  + " and " + c.to_s
+  end
+  seems something do
+    puts "not matched"
+  end
+end # => "1, 2, and 345"

data/examples/hash_matching.rb

@@ -0,0 +1,16 @@
+
+require "patternmatching"
+
+include PatternMatching
+
+# Example for matching Hash
+dict = build { {:name => "Taro", :age => 5} }
+make dict do
+  seems as {{:name => :name}} do
+    puts "He is " + name
+  end
+  seems something do
+    puts "no name"
+  end
+end # => "He is Taro"
+

data/examples/matching.rb

@@ -0,0 +1,19 @@
+
+require "patternmatching"
+
+
+# For DSL style code, include PatternMatching
+include PatternMatching
+
+# match example
+def calc(code)
+  make (code) {
+    seems as {plus(:x, :y)} do calc(x) + calc(y) end
+    seems as {mul(:x, :y)} do  calc(x) * calc(y) end
+    seems something do code end
+  }
+end
+
+
+code = build {plus(mul(100, 100), 200)}
+p calc(code) #=> 10200

data/examples/object_matching.rb

@@ -0,0 +1,25 @@
+
+require "patternmatching"
+
+include PatternMatching
+
+class Person
+  def initialize(name, age)
+    @name = name
+    @age = age
+  end
+  attr :name
+  attr :age
+end
+
+# Example for matching Object except Hash
+person = Person.new("Jiro", 3) 
+make person do
+  seems as {{:name => :name}} do
+    puts "He is " + name
+  end
+  seems something do
+    puts "no name"
+  end
+end # => "He is Jiro"
+

data/examples/partial_style_method.rb

@@ -0,0 +1,24 @@
+require "patternmatching"
+
+# Structured data builder 
+code = PatternMatching.build {plus(mul(100, 100), 200)}
+
+# Partial style method example
+class Calc
+  # At first, extends with the module
+  extend PatternMatching
+  
+  # def calcm(o), as 3 partial styles
+  func(:calcm).seems as {plus(:x, :y)} do
+    calcm(x) + calcm(y)
+  end
+  func(:calcm).seems as {mul(:x, :y)} do
+    calcm(x) * calcm(y)
+  end
+  func(:calcm).seems as {:value} do
+    value
+  end
+end
+
+# use as standard method
+p Calc.new.calcm(code)