strmask 0.3.0 → 0.3.2

data/.ruby

@@ -0,0 +1,43 @@
+---
+source:
+- meta
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2009'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: qed
+  groups:
+  - test
+  development: true
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+conflicts: []
+repositories: []
+resources:
+  Homepage: http://rubyworks.github.com/strmask
+  Source Code: http://github.com/rubyworks/strmask
+  Mailing List: http://groups.google.com/group/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-07-19'
+summary: String Algebra
+title: String::Mask
+version: 0.3.2
+name: strmask
+description: ! 'String::Mask provides a kind-of string algebra useful for manipulating
+  strings
+
+  in comparitive ways, eg. add, subtract, xor, etc.'
+organization: RubyWorks
+date: '2011-10-27'

data/.yardopts

@@ -0,0 +1,9 @@
+--title "StrMask"
+--readme README.rdoc
+--output-dir doc
+--protected
+--private
+lib/**/*.rb
+-
+[A-Z]*.*
+

data/{HISTORY → HISTORY.rdoc}

@@ -1,4 +1,16 @@
-= HISTORY
+= RELEASE HISTORY
+
+== 0.3.2 / 2011-10-27
+
+Fixed bug that prevented plain strings from being coerced
+into masks. This release also brings the build system up
+to date with latest tools. (Note: 0.3.1 was botched).
+
+Changes:
+
+* Fixed issue with plain strings not being coerced.
+* Modernize build configuration.
+
 
 == 0.3.0 / 2010-04-18
 

data/NOTICE.rdoc

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+
+== String Mask
+
+Copyright:: (c) 2009 Thomas Sawyer, Rubyworks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/strmask
+
+    Copyright 2009 Thomas Sawyer. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice,
+          this list of conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/QED.rdoc

@@ -0,0 +1,62 @@
+= String Masking
+
+    require 'strmask'
+
+There are a few ways to create a string mask.
+
+    x1 = String::Mask.new("abc..123", '.')
+    x2 = String::Mask["abc..123", '.']
+    x3 = "abc..123".mask('.')
+
+All of the above examples are equivelent.
+
+    x1.assert == x2
+    x2.assert == x3
+    x3.assert == x1
+
+Notice in all these example we specified a dot ('.') as the escaping
+character. Leaving this off defaults the chracter to ASCII ESC ("\032").
+ASCII ESC is a good choice for real world usage, but for demonstration
+puposes a dot is clearly much easier to read.
+
+We will use the folowing two string masks to demonstrate the various masking
+operators below.
+
+    x1 = "abc..123".mask('.')
+    x2 = "ab..789.".mask('.')
+
+For Addition, as long as there is a value other then empty slot the character
+filters though, with the last string taking precedence.
+
+    (x1 + x2)  #=> "abc.7893".mask('.')
+    (x2 + x1)  #=> "abc.7123".mask('.')
+
+The OR operator is the same as addition.
+
+    (x1 | x2)  #=> "abc.7893".mask('.')
+    (x2 | x1)  #=> "abc.7123".mask('.')
+
+For Subtraction, where the characters are the same, the result is empty, where
+they differ the result reflects the last string.
+
+    (x1 - x2)  #=> "....789.".mask('.')
+    (x2 - x1)  #=> "..c..123".mask('.')
+
+For Multiplication (Exclusive AND), where the characters are the same the
+result is the same, where they differ the result reflects the later.
+
+    (x1 * x2)  #=> "ab..789.".mask('.')
+    (x2 * x1)  #=> "abc..123".mask('.')
+
+The AND operator, only slots that are the same (using ==) filter through.
+
+    (x1 & x2)  #=> "ab......".mask('.')
+    (x2 & x1)  #=> "ab......".mask('.')
+
+The XOR operator, only where there is an empty slot will the value filter
+through.
+
+    (x1 ^ x2)  #=> "..c.7..3".mask('.')
+    (x2 ^ x1)  #=> "..c.7..3".mask('.')
+
+

data/README.rdoc

@@ -1,7 +1,9 @@
 = String::Mask
 
-* home: http://rubyworks.github.com/strmask
-* work: http://github.com/rubyworks/strmask
+{Homepage}[http://rubyworks.github.com/strmask] |
+{Source Code}[http://github.com/rubyworks/strmask]
+
+{<img src="http://travis-ci.org/rubyworks/strmask.png" />}[http://travis-ci.org/rubyworks/strmask]
 
 
 == DESCRIPTION
@@ -10,6 +12,7 @@ Mask provides a string utility to manipulate strings
 in logicomathematical manner, ie. add, subtract, xor,
 etc.
 
+
 == SYNOPSIS
 
 Mask objects can be created explicitly via #new.
@@ -30,18 +33,18 @@ it repesents another mask akin to the first.
   "abc..123".mask('.') + "ab..789."   #=> "abc.7893"
 
 
-== HOW TO INSTALL
+== INSTALL
 
 To install with RubyGems simply open a console and type:
 
-  gem install mask
+  $ gem install strmask
 
 
-== COPYRIGHT
+== COPYRIGHTS
 
-Copyright (c) 2009 Thomas Sawyer
+Copyright (c) 2009 Thomas Sawyer, Rubyworks
 
-This program is ditributed unser the terms of the LGPL license.
+This program is ditributed unser the terms of the *FreeBSD* license.
 
-See the LICENSE or COPYING file for details.
+See the NOTICE.rdoc file for details.
 

data/lib/strmask.rb

@@ -9,31 +9,43 @@ class String
 
   # = Mask
   #
+  #--
+  # TODO: Probably need to create a proper #hash method.
+  #++
   class Mask
 
+    # Current version.
+    VERSION = "0.3.2"  # :erb: VERSION = "<%= version %>"
+
+    # Substitue (TODO: rename)
     ESC = "\032" # ASCII SUBSTITUTE
 
+    # New Mask.
+    #
+    # @param [String] string
+    #   Any regular or masked string.
+    #
+    # @param [String] re
+    #   Single character string used to mark empty slots.
+    #
     def self.[](string, re=nil)
       new(string, re)
     end
 
-  private
-
+    # Initialize new string mask.
+    #
+    # @param [String] string
+    #   Any regular or masked string.
+    #
+    # @param [String] re
+    #   Single character string used to mark empty slots.
+    #
     def initialize(string, re=nil)
       @to_str = string.dup
       @re     = re
       mask!(re) if re
     end
 
-    def convert(other)
-      case other
-      when Mask
-        other
-      else
-        self.class.new(other.to_s, re)
-      end
-    end
-
   public
 
     # The underlying string object.
@@ -56,10 +68,17 @@ class String
       to_str[*a]
     end
 
+    # Create a new mask with the same underlying string, but
+    # using a different empty slot.
+    #
+    # @param [String] re
+    #   Single character string used to mark empty slots.
+    #
     def mask(re)
       self.class.new(to_str,re)
     end
 
+    #
     def mask!(re)
       to_str.gsub!(re){ |s| ESC * s.size }
     end
@@ -226,6 +245,11 @@ class String
     #  end
     #end
 
+    #
+    #def coerce(other)
+    #  [self, other.mask(@re)]
+    #end
+
     # Delegate any missing methods to underlying string.
     #
     def method_missing(s, *a, &b)
@@ -236,6 +260,17 @@ class String
       end
     end
 
+    private
+
+    def convert(other)
+      case other
+      when Mask
+        other
+      else
+        self.class.new(other.to_s, @re)
+      end
+    end
+
   end
 
 end

data/lib/strmask.yml

@@ -0,0 +1,43 @@
+---
+source:
+- meta
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2009'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: qed
+  groups:
+  - test
+  development: true
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+conflicts: []
+repositories: []
+resources:
+  Homepage: http://rubyworks.github.com/strmask
+  Source Code: http://github.com/rubyworks/strmask
+  Mailing List: http://groups.google.com/group/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-07-19'
+summary: String Algebra
+title: String::Mask
+version: 0.3.2
+name: strmask
+description: ! 'String::Mask provides a kind-of string algebra useful for manipulating
+  strings
+
+  in comparitive ways, eg. add, subtract, xor, etc.'
+organization: RubyWorks
+date: '2011-10-27'

data/qed/strmask.rdoc

@@ -0,0 +1,61 @@
+= String Masking
+
+    require 'strmask'
+
+There are a few ways to create a string mask.
+
+    x1 = String::Mask.new("abc..123", '.')
+    x2 = String::Mask["abc..123", '.']
+    x3 = "abc..123".mask('.')
+
+All of the above examples are equivelent.
+
+    x1.assert == x2
+    x2.assert == x3
+    x3.assert == x1
+
+Notice in all these example we specified a dot ('.') as the escaping
+character. Leaving this off defaults the chracter to ASCII ESC ("\032").
+ASCII ESC is a good choice for real world usage, but for demonstration
+puposes a dot is clearly much easier to read.
+
+We will use the folowing two string masks to demonstrate the various masking
+operators below.
+
+    x1 = "abc..123".mask('.')
+    x2 = "ab..789.".mask('.')
+
+For Addition, as long as there is a value other then empty slot the character
+filters though, with the last string taking precedence.
+
+    (x1 + x2)  #=> "abc.7893".mask('.')
+    (x2 + x1)  #=> "abc.7123".mask('.')
+
+The OR operator is the same as addition.
+
+    (x1 | x2)  #=> "abc.7893".mask('.')
+    (x2 | x1)  #=> "abc.7123".mask('.')
+
+For Subtraction, where the characters are the same, the result is empty, where
+they differ the result reflects the last string.
+
+    (x1 - x2)  #=> "....789.".mask('.')
+    (x2 - x1)  #=> "..c..123".mask('.')
+
+For Multiplication (Exclusive AND), where the characters are the same the
+result is the same, where they differ the result reflects the later.
+
+    (x1 * x2)  #=> "ab..789.".mask('.')
+    (x2 * x1)  #=> "abc..123".mask('.')
+
+The AND operator, only slots that are the same (using ==) filter through.
+
+    (x1 & x2)  #=> "ab......".mask('.')
+    (x2 & x1)  #=> "ab......".mask('.')
+
+The XOR operator, only where there is an empty slot will the value filter
+through.
+
+    (x1 ^ x2)  #=> "..c.7..3".mask('.')
+    (x2 ^ x1)  #=> "..c.7..3".mask('.')
+

metadata

@@ -1,82 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: strmask
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2011-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &28079740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *28079740
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &28078940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *28078940
+description: ! 'String::Mask provides a kind-of string algebra useful for manipulating
+  strings
 
-date: 2010-04-18 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: |-
-  String::Mask provides a kind-of string algebra
-  useful for manipulating strings in in comparitive
-  ways, eg. add, subtract, xor, etc.
-email: 
+  in comparitive ways, eg. add, subtract, xor, etc.'
+email:
+- transfire@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: []
-
-files: 
+extra_rdoc_files:
+- HISTORY.rdoc
+- README.rdoc
+- QED.rdoc
+- NOTICE.rdoc
+files:
+- .ruby
+- .yardopts
 - lib/strmask.rb
-- meta/authors
-- meta/collection
-- meta/contact
-- meta/created
-- meta/description
-- meta/homepage
-- meta/license
-- meta/name
-- meta/released
-- meta/repository
-- meta/title
-- meta/version
+- lib/strmask.yml
+- qed/strmask.rdoc
 - test/test_strmask.rb
-- LICENSE
+- HISTORY.rdoc
 - README.rdoc
-- HISTORY
-has_rdoc: true
-homepage: http://rubyworks.github.com/strmask
-licenses: []
-
+- QED.rdoc
+- NOTICE.rdoc
+homepage: 
+licenses:
+- BSD-2-Clause
 post_install_message: 
-rdoc_options: 
-- --title
-- String::Mask API
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: strmask
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: String::Mask provides a kind-of string algebra
-test_files: 
-- test/test_strmask.rb
+summary: String Algebra
+test_files: []

data/LICENSE

@@ -1,23 +0,0 @@
-The MIT License
-
-Copyright (c) 2009 Peter Vanbroekhoven & Thomas Sawyer
-
-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/meta/authors

@@ -1 +0,0 @@
-Thomas Sawyer

data/meta/collection

@@ -1 +0,0 @@
-rubyworks

data/meta/contact

@@ -1 +0,0 @@
-rubyworks-mailinglist@googlegroups.com

data/meta/created

@@ -1 +0,0 @@
-2009-07-19

data/meta/description

@@ -1,3 +0,0 @@
-String::Mask provides a kind-of string algebra
-useful for manipulating strings in in comparitive
-ways, eg. add, subtract, xor, etc.

data/meta/homepage

@@ -1 +0,0 @@
-http://rubyworks.github.com/strmask

data/meta/license

@@ -1 +0,0 @@
-MIT

data/meta/name

@@ -1 +0,0 @@
-strmask

data/meta/released

@@ -1 +0,0 @@
-2010-04-18

data/meta/repository

@@ -1 +0,0 @@
-git://github.com/rubyworks/strmask.git

data/meta/title

@@ -1 +0,0 @@
-String::Mask

data/meta/version

@@ -1 +0,0 @@
-0.3.0