mascherari 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ea5aa679829edcdf629788b7d7d2ac99299dfae
+  data.tar.gz: b32c17a9be5d43b8d86d383dff3b87681f082e8e
+SHA512:
+  metadata.gz: 4db1d0523ee705215fe12be85bf70824e5cfbcabfe6350f9fcec241948f1a4ddc6f29766b9d3950fa2fa1e38bcbcb011d297b04decac3ee10e4972f086dc50cf
+  data.tar.gz: 693d0f852d119e1c58872959974ecd4d292a952a533d39a26d911442a673479cbd82a46dd8935aad598a7e0a117eb587e40995a7e95bffacefb4fe5d24594bd9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robson Marques
+
+MIT License
+
+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,76 @@
+# Mascherari
+
+[![Build Status](https://travis-ci.org/robsonmarques/mascherari.png)](https://travis-ci.org/robsonmarques/mascherari)
+[![Code Climate](https://codeclimate.com/github/robsonmarques/mascherari.png)](https://codeclimate.com/github/robsonmarques/mascherari)
+
+An easy way to handle masks. (Work in progress)
+
+## Installation
+
+Simple as:
+
+    $ gem install mascherari
+
+## Usage
+
+To create masks for attributes, include Mascherari and set the format:
+
+```ruby
+class Person
+  include Mascherari
+
+  attr_accessor :phone, :mobile
+
+  attr_masked :phone, :mobile, :format => "(##) ####-####"
+end
+```
+
+That will give you two helpers for each attribute:
+
+```ruby
+# person.phone = "5554212035"
+# person.mobile = "5599213035"
+person.phone_masked
+=> "(55) 5421-2035"
+person.mobile_masked
+=> "(55) 9921-3035"
+
+# person.phone = "(55) 5421-2035"
+# person.mobile = "(55) 9921-3035"
+person.phone_unmasked
+=> "5554212035"
+person.mobile_unmasked
+=> "5599213035"
+```
+
+## Rails
+
+Add this line to your application's Gemfile:
+
+    gem 'mascherari'
+
+And then execute:
+
+    $ bundle
+
+You can include Mascherari in Rails models as:
+
+```ruby
+# config/initializers/mascherari.rb
+ActiveSupport.on_load :active_record do
+  include Mascherari
+end
+
+# app/models/person.rb
+class Person < ActiveRecord::Base
+  attr_masked :phone, :format => "(##) ####-####"
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task :default => :spec

data/lib/mascherari/attr_masked.rb

@@ -0,0 +1,24 @@
+module Mascherari
+  module AttrMasked
+    def attr_masked(*attrs, options)
+      attrs.each do |attr|
+        formatter = "#{attr}_format"
+        masked    = "#{attr}_masked"
+        unmasked  = "#{attr}_unmasked"
+        ivar      = "@#{formatter}"
+
+        define_method formatter do
+          instance_variable_get(ivar) || instance_variable_set(ivar, Formatter.new(options))
+        end
+
+        define_method masked do
+          send(formatter).mask send(attr)
+        end
+
+        define_method unmasked do
+          send(formatter).unmask send(attr)
+        end
+      end
+    end
+  end
+end

data/lib/mascherari/formatter.rb

@@ -0,0 +1,64 @@
+module Mascherari
+  class Formatter
+    attr_reader :format, :wildcard
+
+    def initialize(options = {})
+      @format = options.fetch :format
+      @wildcard = options.fetch :wildcard, "#"
+    end
+
+    def mask(raw_value)
+      prepare_value raw_value
+
+      formatted? ? value : add_mask
+    end
+
+    def unmask(raw_value)
+      prepare_value raw_value
+
+      formatted? ? remove_mask : value
+    end
+
+    protected
+
+    attr_reader :value
+
+    def prepare_value(raw_value)
+      @value = raw_value.to_s
+
+      valid_value?
+    end
+
+    def add_mask
+      value_chars = value.chars
+
+      format_chars do |char|
+        wildcard?(char) ? value_chars.shift : char
+      end
+    end
+
+    def remove_mask
+      format_chars do |char, index|
+        value[index] if wildcard?(char)
+      end
+    end
+
+    def format_chars(&block)
+      format.chars.map.with_index { |char, index| yield char, index }.join
+    end
+
+    def formatted?
+      value.size == format.size
+    end
+
+    def wildcard?(char)
+      char == wildcard
+    end
+
+    def valid_value?
+      unless formatted? || value.size == format.scan(wildcard).size
+        raise ArgumentError, "Value size don't match format"
+      end
+    end
+  end
+end

data/lib/mascherari/version.rb

@@ -0,0 +1,3 @@
+module Mascherari
+  VERSION = "0.0.1"
+end

data/lib/mascherari.rb

@@ -0,0 +1,9 @@
+require 'mascherari/version'
+require 'mascherari/attr_masked'
+require 'mascherari/formatter'
+
+module Mascherari
+  def self.included(base)
+    base.extend AttrMasked
+  end
+end

data/mascherari.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mascherari/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mascherari'
+  spec.version       = Mascherari::VERSION
+  spec.authors       = ['Robson Marques']
+  spec.email         = ['robsonmarques@gmail.com']
+  spec.summary       = 'An easy way to handle masks.'
+  spec.homepage      = 'http://github.com/robsonmarques/mascherari'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec', '~> 2.12'
+end

data/spec/attr_masked_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Mascherari::AttrMasked do
+  subject do
+    Person.new
+  end
+
+  context 'when attribute comes without mask' do
+    before do
+      subject.phone = "1234567890"
+      subject.mobile = "0987654321"
+    end
+
+    describe '#attribute_masked' do
+      it 'returns attribute with mask' do
+        expect(subject.phone_masked).to eq "(12) 3456-7890"
+        expect(subject.mobile_masked).to eq "(09) 8765-4321"
+      end
+    end
+
+    describe '#attribute_unmasked' do
+      it 'returns original attribute' do
+        expect(subject.phone_unmasked).to eq "1234567890"
+        expect(subject.mobile_unmasked).to eq "0987654321"
+      end
+    end
+  end
+
+  context 'when attribute comes with mask' do
+    before do
+      subject.phone = "(12) 3456-7890"
+      subject.mobile = "(09) 8765-4321"
+    end
+
+    describe '#attribute_masked' do
+      it 'returns original attribute' do
+        expect(subject.phone_masked).to eq "(12) 3456-7890"
+        expect(subject.mobile_masked).to eq "(09) 8765-4321"
+      end
+    end
+
+    describe '#attribute_unmasked' do
+      it 'returns attribute without mask' do
+        expect(subject.phone_unmasked).to eq "1234567890"
+        expect(subject.mobile_unmasked).to eq "0987654321"
+      end
+    end
+  end
+
+  context 'when attribute value changes' do
+    describe '#attribute_masked' do
+      it 'masks current value' do
+        subject.phone = "1234567890"
+
+        expect(subject.phone_masked).to eq "(12) 3456-7890"
+
+        subject.phone = "0987654321"
+
+        expect(subject.phone_masked).to eq "(09) 8765-4321"
+      end
+    end
+
+    describe '#attribute_unmasked' do
+      it 'unmasks current value' do
+        subject.phone = "(12) 3456-7890"
+
+        expect(subject.phone_unmasked).to eq "1234567890"
+
+        subject.phone = "(09) 8765-4321"
+
+        expect(subject.phone_unmasked).to eq "0987654321"
+      end
+    end
+  end
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Mascherari::Formatter do
+  subject do
+    described_class.new :format => "(##) ####-####"
+  end
+
+  describe '#mask' do
+    context 'when value is unmasked' do
+      it 'returns value with mask' do
+        expect(subject.mask "1234567890").to eq "(12) 3456-7890"
+      end
+    end
+
+    context 'when value is already masked' do
+      it 'returns value' do
+        expect(subject.mask "(12) 3456-7890").to eq "(12) 3456-7890"
+      end
+    end
+
+    context 'when value size is invalid' do
+      it 'raises an error' do
+        expect { subject.mask "23456789" }.to raise_error "Value size don't match format"
+        expect { subject.mask "91234567890" }.to raise_error "Value size don't match format"
+      end
+    end
+  end
+
+  describe '#unmask' do
+    context 'when value is masked' do
+      it 'returns value with mask' do
+        expect(subject.unmask "(12) 3456-7890").to eq "1234567890"
+      end
+    end
+
+    context 'when value is already unmasked' do
+      it 'returns value' do
+        expect(subject.unmask "1234567890").to eq "1234567890"
+      end
+    end
+
+    context 'when value size is invalid' do
+      it 'raises an error' do
+        expect { subject.unmask "(23) 456-789" }.to raise_error "Value size don't match format"
+        expect { subject.unmask "(123) 4456-7789" }.to raise_error "Value size don't match format"
+      end
+    end
+  end
+
+  context 'when using different wildcard' do
+    subject do
+      described_class.new :format => "(**) ****-****", :wildcard => "*"
+    end
+
+    describe '#mask' do
+      it 'returns value with mask' do
+        expect(subject.mask "1234567890").to eq "(12) 3456-7890"
+      end
+    end
+
+    describe '#unmask' do
+      it 'returns value without mask' do
+        expect(subject.unmask "(12) 3456-7890").to eq "1234567890"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'mascherari'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }

data/spec/support/base_classes.rb

@@ -0,0 +1,7 @@
+class Person
+  include Mascherari
+
+  attr_accessor :phone, :mobile
+
+  attr_masked :phone, :mobile, :format => "(##) ####-####"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mascherari
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robson Marques
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: 
+email:
+- robsonmarques@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mascherari.rb
+- lib/mascherari/attr_masked.rb
+- lib/mascherari/formatter.rb
+- lib/mascherari/version.rb
+- mascherari.gemspec
+- spec/attr_masked_spec.rb
+- spec/formatter_spec.rb
+- spec/spec_helper.rb
+- spec/support/base_classes.rb
+homepage: http://github.com/robsonmarques/mascherari
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: An easy way to handle masks.
+test_files:
+- spec/attr_masked_spec.rb
+- spec/formatter_spec.rb
+- spec/spec_helper.rb
+- spec/support/base_classes.rb