data_cleaner 0.0.1

data/README.txt

@@ -0,0 +1,77 @@
+= DataCleaner
+
+DataCleaner is a library to aid you in anonymising your data, for example when attempting to reproduce a bug in development, and only live data will do, but it's not safe to have a whole database of customer names, email, etc on your development machine.
+
+DataCleaner wants to make sure your data still looks real, and importantly, passes any validation your code might have. To achieve this it provides a DSL for you to specify the format of the data, along with helpers (using the faker gem) to generate common data.
+
+Only data that need anonymising needs to be specified, foreign keys, non-customer-identifiable data should be left alone.
+
+== Installation
+
+gem install data_cleaner
+
+== Usage
+  
+  require 'rubygems'
+  require 'data_cleaner'
+  
+  class TopSecret
+    attr_accessor :name, :email, :reference, :secret, :date
+    
+    def initialize(name, email, reference, secret, date)
+      @name = name
+      @email = email
+      @reference = reference
+      @secret = secret
+      @date = date
+    end
+    
+    def valid?
+      name.match(/^[a-z]+ [a-z]+$/i) &&
+      reference.match(/^[a-z]{3}[0-9]{1,5}$/) &&
+      date.is_a?(Time) || false
+    end
+    
+  end
+  
+  module DataCleaner::Formats
+    format "TopSecret" do |f|
+      f.name [:first_name, " ", :last_name]
+      f.email :email, &:name # passes the objects name to the email method
+      f.reference do |secret|
+        "#{secret.name[0..2].downcase}#{secret.date.strftime("%y")}"
+      end
+      f.secret "test"
+    end
+  end
+  
+  secret = TopSecret.new("Matthew Sadler", "mat@foo.com", "mat09", "I like kittens", Time.now)
+  puts secret.inspect
+  puts "is valid? #{secret.valid?}"
+  puts
+  
+  clean = DataCleaner::Cleaner.clean!(secret)
+  
+  puts clean.inspect
+  puts "is valid? #{clean.valid?}"
+
+prints:
+  
+  #<TopSecret:0x1015f7830 @email="mat@foo.com", @date=Mon Jan 17 16:53:19 +0000 2011, @name="Matthew Sadler", @secret="I like kittens", @reference="mat09">
+is valid? true
+  
+  #<TopSecret:0x1015f7830 @email="javier.kuhlman@franeckikonopelski.co.uk", @date=Mon Jan 17 16:53:19 +0000 2011, @name="Javier Kuhlman", @secret="test", @reference="jav11">
+is valid? true
+
+
+== Licence
+
+(The MIT License)
+
+Copyright © 2011 Matthew Sadler
+
+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/lib/data_cleaner/cleaner.rb

@@ -0,0 +1,121 @@
+module DataCleaner
+  # DataCleaner::Cleaner is a module which can either be mixed-in, or used
+  # standalone to anonymise the data held within objects.
+  # 
+  # DataCleaner::Cleaner relies on the object formats specified with
+  # DataCleaner::Formats.
+  # 
+  module Cleaner
+    # In the format 
+    #   :specifier => instance
+    # the method specifier will be called on instance
+    # 
+    # whereas with
+    #   :specifier => [instance, :method]
+    # the method method will be called on instance.
+    # 
+    # :specifier is used when describing the format of your object's attributes
+    # 
+    MAPPING = {
+      :name => Faker::Name,
+      :first_name => Faker::Name,
+      :last_name => Faker::Name,
+      :name_prefix => [Faker::Name, :prefix],
+      :name_suffix => [Faker::Name, :suffix],
+      
+      :phone_number => Faker::PhoneNumber,
+      
+      :city => Faker::Address,
+      :city_prefix => Faker::Address,
+      :city_suffix => Faker::Address,
+      :secondary_address => Faker::Address,
+      :street_address => Faker::Address,
+      :street_name => Faker::Address,
+      :street_suffix => Faker::Address,
+      :uk_country => Faker::Address,
+      :uk_county => Faker::Address,
+      :uk_postcode => Faker::Address,
+      :us_state => Faker::Address,
+      :us_state_abbr => Faker::Address,
+      :zip_code => Faker::Address,
+      
+      :domain_name => Faker::Internet,
+      :domain_suffix => Faker::Internet,
+      :domain_word => Faker::Internet,
+      :email => Faker::Internet,
+      :free_email => Faker::Internet,
+      :user_name => Faker::Internet,
+      
+      :bs => Faker::Company,
+      :catch_phrase => Faker::Company,
+      :company_name => [Faker::Company, :name],
+      :company_suffix => [Faker::Company, :suffix],
+      
+      :paragraph => Faker::Lorem,
+      :paragraphs => Faker::Lorem,
+      :sentence => Faker::Lorem,
+      :sentences => Faker::Lorem,
+      :words => Faker::Lorem,
+    }
+    
+    extend self
+    
+    # :call-seq: Cleaner.clean(obj) -> new_obj
+    # obj.clean -> new_obj
+    # 
+    # Returns an anonymised copy of obj.
+    # 
+    # Relies on obj.dup.
+    # 
+    def __clean__(object=self)
+      __clean__!(object.dup)
+    end
+    unless defined? clean
+      alias clean __clean__
+    end
+    
+    # :call-seq: Cleaner.clean!(obj) -> obj
+    # obj.clean! -> obj
+    # 
+    # Anonymises obj.
+    # 
+    def __clean__!(object=self)
+      format = DataCleaner::Formats.formats[object.class.name]
+      
+      format.attributes.each do |attribute, arguments|
+        object.send(:"#{attribute}=", __replacement__(arguments, object))
+      end
+      object
+    end
+    unless defined? clean!
+      alias clean! __clean__!
+    end
+    
+    private
+    def __replacement__(args, object)
+      args = args.dup
+      first = args.shift
+      
+      case first
+      when String
+        first
+      when Symbol
+        args.map! {|arg| if arg.is_a?(Proc) then arg.call(object) end || arg}
+        __data__(first, *args)
+      when Array
+        first.map do |e|
+          e = [e] unless e.is_a?(Array)
+          __replacement__(e, object)
+        end.join
+      when Proc
+        first.call(object)
+      end
+    end
+    
+    def __data__(type, *args)
+      klass, method = DataCleaner::Cleaner::MAPPING[type]
+      klass.send(method || type, *args)
+    end
+    
+  end
+end

data/lib/data_cleaner/format.rb

@@ -0,0 +1,32 @@
+module DataCleaner
+  # DataCleaner::Format can be used to describe the format of an object's
+  # attributes.
+  # 
+  # Example:
+  #   f = DataCleaner::Format.new("Person")
+  #   f.name [:first_name, " ", :last_name]
+  # 
+  # You most likely do not want to use this class directly, bu instead though
+  # DataCleaner::Formats.
+  # 
+  class Format < if defined? BasicObject then BasicObject else Object end
+    attr_accessor :klass, :attributes
+    
+    # :call-seq: Format.new(klass) -> format
+    # 
+    def initialize(klass)
+      @klass = klass
+      @attributes = []
+    end
+    
+    # :call-seq: format.attribute(:attr [, args...]) {|obj| block } -> format
+    # 
+    def attribute(name, *args, &block)
+      args.push(block) if block
+      attributes.push([name, args])
+      self
+    end
+    alias method_missing attribute
+    
+  end
+end

data/lib/data_cleaner/formats.rb

@@ -0,0 +1,50 @@
+unless :Symbol.respond_to?(:to_proc)
+  class Symbol
+    def to_proc
+      Proc.new(&method(:__apply__))
+    end
+    
+    private
+    def __apply__(obj, *args)
+      obj.send(self, *args)
+    end
+  end
+end
+
+module DataCleaner
+  # DataCleaner::Formats provides a DSL for describing, and method for looking
+  # up the format of object's attributes, such that they can be replaced with
+  # fake data, but still pass validation.
+  # 
+  # Not all attributes need be specified, only those that need be replaced.
+  # 
+  # Attributes will be processed in the order they are specified.
+  # 
+  # Example:
+  #   module DataCleaner::Formats
+  #     format "Person" do |f|
+  #       f.name [:first_name, " ", :last_name]
+  #       f.email :email, &:name # passes the name to the generate email method
+  #       # custom format, block is provided with the instance
+  #       f.reference do |instance|
+  #         "#{instance.name[0..2].downcase}#{rand(89) + 10}"
+  #       end
+  #     end
+  #   end
+  # 
+  module Formats
+    class << self; attr_accessor :formats end
+    self.formats = {}
+    
+    # :call-seq: format(klass) {|format| block } -> format
+    # 
+    # Yields a format object, which can be used to describe the format of klass.
+    # 
+    def self.format(klass)
+      obj = Format.new(klass)
+      yield obj
+      formats[klass.to_s] = obj
+    end
+    
+  end
+end

data/lib/data_cleaner.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'faker'
+
+require "#{File.dirname(__FILE__)}/data_cleaner/cleaner"
+require "#{File.dirname(__FILE__)}/data_cleaner/format"
+require "#{File.dirname(__FILE__)}/data_cleaner/formats"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: data_cleaner
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthew Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-17 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: faker
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :runtime
+  version_requirements: *id001
+description: A Ruby library to aid in removing sensitive data from objects
+email: mat@sourcetagsandcodes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/data_cleaner/cleaner.rb
+- lib/data_cleaner/format.rb
+- lib/data_cleaner/formats.rb
+- lib/data_cleaner.rb
+- README.txt
+has_rdoc: true
+homepage: http://github.com/matsadler/data_cleaner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+- --charset
+- utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby library to aid in removing sensitive data from objects
+test_files: []
+