maskable_attributes 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Guterl
+
+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/README.md

@@ -0,0 +1,97 @@
+# maskable_attributes
+
+maskable attributes provides a simple way to mask the output of a
+method.  maskable attributes works really well with the decorator /
+presenter pattern.  We are using maskable attributes to hide job
+posting information from users who are not signed in.
+
+## Usage
+
+    require 'delegate'
+    require 'maskable_attributes'
+
+    class Person < Struct.new(:name, :email, :phone)
+    end
+
+    class MaskedPerson < DelegateClass(Person)
+
+      include MaskableAttributes
+
+      masked_attributes :email, :phone
+
+    end
+
+    person = Person.new('Michael', '513-347-1111', 'foo@bar.com')
+    masked = MaskedPerson.new(person)
+
+    masked.name  # => "Michael"
+    masked.phone # => "************"
+    masked.email # => "************"
+
+## Custom strategies
+
+You can provide a string, lambda, or a symbol (representing a
+predefined strategy) in order to further customize the masking.
+
+### String
+
+If you provide a string, that string will always be used to mask the
+attributes.
+
+    masked_attributes :email, :phone, :with => "HIDDEN"
+
+    masked.phone # => "HIDDEN"
+    masked.email # => "HIDDEN"
+
+### lambda / Proc
+
+If you provide a lambda it will be called with the original value
+passed to it.  This allows the masking to be different based on the
+attribute value.  You can see here we output the same number of stars
+as the length of the attribute
+
+    masked_attributes :email, :phone, :with => lambda { |v| "*" * v.size }
+
+    masked.phone # => "************"
+    masked.email # => "***********"
+
+### symbols
+
+Currently masked_attributes only provides 1 predefined strategy named
+:stars, which provides the same functionality from the lambda example above.
+
+    masked_attributes :email, :phone, :with => :stars
+
+    masked.phone # => "************"
+    masked.email # => "***********"
+
+You can easily add more strategies yourself.
+
+    MaskableAttributes.strategies[:dashes] = lambda { |v| "-" * v.size }
+
+    masked_attributes :email, :phone, :with => :dashes
+
+    masked.phone # => "------------"
+    masked.email # => "-----------"
+
+## Default string masking
+
+The default masking strategy is a string with 12 *'s.  You can
+override the default string masking if you choose to.
+
+    MaskableAttributes.default_masking = "HIDDEN"
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Michael Guterl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "maskable_attributes"
+    gem.summary = %Q{maskable attributes provides a simple way to mask or filter the output of a method.}
+    gem.description = %Q{maskable attributes provides a simple way to mask the output of a method.  maskable attributes works really well with the decorator / presenter pattern}
+    gem.email = "mguterl@gmail.com"
+    gem.homepage = "http://github.com/mguterl/maskable_attributes"
+    gem.authors = ["Michael Guterl"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "maskable_attributes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/maskable_attributes.rb

@@ -0,0 +1,48 @@
+module MaskableAttributes
+
+  class << self
+    attr_accessor :default_masking
+  end
+
+  DEFAULT_MASKING = "************"
+
+  self.default_masking = DEFAULT_MASKING
+
+  def self.strategies
+    @strategies ||= {}
+  end
+
+  strategies[:stars] = lambda { |v| "*" * v.size }
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def masked_attributes(*attributes)
+      options = attributes.last.is_a?(::Hash) ? attributes.pop : {}
+
+      attributes.each do |attribute|
+        define_method(attribute) do
+          if with = options[:with]
+            with = MaskableAttributes.strategies[with] if MaskableAttributes.strategies[with]
+            if with.respond_to?(:call)
+              if value = super
+                with.call(value)
+              else
+                nil
+              end
+            else
+              with
+            end
+          else
+            MaskableAttributes.default_masking
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/maskable_attributes.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{maskable_attributes}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Guterl"]
+  s.date = %q{2010-04-29}
+  s.description = %q{maskable attributes provides a simple way to mask the output of a method.  maskable attributes works really well with the decorator / presenter pattern}
+  s.email = %q{mguterl@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/maskable_attributes.rb",
+     "maskable_attributes.gemspec",
+     "spec/maskable_attributes_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mguterl/maskable_attributes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{maskable attributes provides a simple way to mask or filter the output of a method.}
+  s.test_files = [
+    "spec/maskable_attributes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/maskable_attributes_spec.rb

@@ -0,0 +1,113 @@
+require 'spec/spec_helper'
+
+class MaskedPerson < Struct.new(:name, :email, :phone)
+  include MaskableAttributes
+
+  masked_attributes :email, :phone
+end
+
+class CustomMaskedPerson < Struct.new(:name, :email, :phone)
+  include MaskableAttributes
+
+  masked_attributes :email, :phone, :with => "----------"
+end
+
+class CustomLambdaMaskedPerson < Struct.new(:name, :email, :phone)
+  include MaskableAttributes
+
+  masked_attributes :email, :phone, :with => lambda { |value| "*" * value.size }
+end
+
+class PredefinedStrategyMaskedPerson < Struct.new(:name, :email, :phone)
+  include MaskableAttributes
+
+  masked_attributes :email, :phone, :with => :stars
+end
+
+describe MaskableAttributes do
+
+  it 'should have a default masking' do
+    MaskableAttributes.default_masking.should == "************"
+  end
+
+  it 'should allow you to set default masking' do
+    MaskableAttributes.default_masking = "#(*$(W*$*(W$"
+    MaskableAttributes.default_masking.should == "#(*$(W*$*(W$"
+    MaskableAttributes.default_masking = MaskableAttributes::DEFAULT_MASKING
+  end
+
+  describe "with default masking" do
+
+    before do
+      @person = MaskedPerson.new("Michael", "michael@recruitmilitary.com")
+    end
+
+    it 'should mask the specified attributes' do
+      @person.email.should == MaskableAttributes.default_masking
+      @person.phone.should == MaskableAttributes.default_masking
+    end
+
+    it 'should not affect other attributes' do
+      @person.name.should == "Michael"
+    end
+
+  end
+
+  describe "with custom masking" do
+
+    before do
+      @person = CustomMaskedPerson.new("Michael", "michael@recruitmilitary.com")
+    end
+
+    it 'should mask the specified attributes' do
+      @person.email.should == "----------"
+      @person.phone.should == "----------"
+    end
+
+    it 'should not affect other attributes' do
+      @person.name.should == "Michael"
+    end
+
+  end
+
+  describe "with custom lambda masking" do
+
+    before do
+      @person = CustomLambdaMaskedPerson.new("Michael", "michael@recruitmilitary.com")
+    end
+
+    it 'should mask the specified attributes' do
+      @person.email.should == "*" * @person.email.size
+    end
+
+    it 'should return nil if the masked attribute is nil' do
+      @person.phone.should == nil
+    end
+
+    it 'should not affect other attributes' do
+      @person.name.should == "Michael"
+    end
+
+  end
+
+  describe "with symbol representing the strategy" do
+
+    before do
+      @person = PredefinedStrategyMaskedPerson.new("Michael", "michael@recruitmilitary.com")
+    end
+
+    it 'should mask the specified attributes' do
+      @person.email.should == "*" * @person.email.size
+    end
+
+    it 'should return nil if the masked attribute is nil' do
+      @person.phone.should == nil
+    end
+
+    it 'should not affect other attributes' do
+      @person.name.should == "Michael"
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'maskable_attributes'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: maskable_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Guterl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: maskable attributes provides a simple way to mask the output of a method.  maskable attributes works really well with the decorator / presenter pattern
+email: mguterl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/maskable_attributes.rb
+- maskable_attributes.gemspec
+- spec/maskable_attributes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mguterl/maskable_attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: maskable attributes provides a simple way to mask or filter the output of a method.
+test_files: 
+- spec/maskable_attributes_spec.rb
+- spec/spec_helper.rb