redactor 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7930ab02836e02e6b1a54666b637cef619becde9
-  data.tar.gz: 5005ab98df807eed1cbecb5618b8db60be254629
+  metadata.gz: 7a2cd8062ddf0427c5f9e0658c10ca0648773eb4
+  data.tar.gz: b991cd754a805b19ad6db954537b0c41ff91a5fc
 SHA512:
-  metadata.gz: 1ea215bfc5261dbbb927fe8d72dd0e6f206205ae4ac2e1b502034d14ae9799a045ce2a07c9fe1965e0b5380edcb414ccec58fb077d5bed9ff92e616a2fb6825e
-  data.tar.gz: 80ea8bbce965ea23c314b6c8e004f98617355dff8af5be3225f544b65d319354b775c7e3310bb9c2650597182d5a06c6d55d9174451df06e4efd5493cfee9ae2
+  metadata.gz: cc6e7d25df877a0d796b42b43687c84a9da5213233e72fe8380b1a61a7ad8a192f3c81045f4d4c49dab75e83b1e48397238d9562fe8b7394f66157f51e1701ec
+  data.tar.gz: 6a805cb5eeb3470149f2e44bcb7d31d495ecfd7822d7e074918f11d2dc5f10050bcbc21d793bd179b7716ebbeaec8f8a82d6032649d599876316b2974fdc21cf

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.2.2
+  - ruby-head

data/README.md

@@ -1,4 +1,4 @@
-# redactor
+# redactor [![Gem Version](https://badge.fury.io/rb/redactor.svg)](https://rubygems.org/gems/redactor) [![Build Status](https://travis-ci.org/TimPetricola/redactor.svg)](https://travis-ci.org/TimPetricola/redactor)
 
 Redact parts of text defined by custom rules (e.g. emails, phone numbers).
 
@@ -10,7 +10,7 @@ require 'redactor'
 input = 'To ride a kayak, contact me: tim.petricola@gmail.com or 1 234 567 8901.'
 
 # these rules are only good enough for an example
-Redactor.define do
+@redactor = Redactor.new do
   # US phone
   rule :phone, /(\+?1[ \.-]?)?\(?\d{3}\)?[ \.-]?\d{3}[ \.-]?\d{4}/
 
@@ -29,24 +29,32 @@ Redactor.define do
   end
 end
 
-Redactor.format(input)
+redactor.format(input)
 # => "To ride a [REDACTED], contact me: [REDACTED] or [REDACTED]."
 
-Redactor.format(input) do |extract|
+redactor.default_replacement = '$#@!&'
+# => "To ride a $\#@!&, contact me: $\#@!& or $\#@!&."
+
+redactor.format(input) do |extract|
   "[#{extract.reason.upcase}]"
 end
 # => "To ride a [PALINDROME], contact me: [EMAIL] or [PHONE]."
 
-Redactor.extract(input)
-# => [#<Redactor::Extract:0x007fc05c6b25a0
+redactor.extract(input)
+# => [#<Redactor::Extract:0x007ff259586008
 #   @finish=70,
-#   @rule=#<Redactor::Rule:0x007fc05f203970 @block=nil, @reason=:phone, @regex=/(\+?1[ \.-]?)?\(?\d{3}\)?[ \.-]?\d{3}[ \.-]?\d{4}/>,
+#   @rule=#<Redactor::Rule:0x007ff258b5aa20 @block=nil, @reason=:phone, @regex=/(\+?1[ \.-]?)?\(?\d{3}\)?[ \.-]?\d{3}[ \.-]?\d{4}/>,
 #   @start=56,
 #   @value="1 234 567 8901">,
-#  #<Redactor::Extract:0x007fc05c6b2230 @finish=52, @rule=#<Redactor::Rule:0x007fc05f203948 @block=nil, @reason=:email, @regex=/[\w\.]+(@|at)\w+(\.|dot)\w{1,3}/i>, @start=29, @value="tim.petricola@gmail.com">,
-#  #<Redactor::Extract:0x007fc05c6b19c0
+#  #<Redactor::Extract:0x007ff259585cc0
+#   @finish=52,
+#   @rule=#<Redactor::Rule:0x007ff258b5a9f8 @block=nil, @reason=:email, @regex=/[\w\.]+(@|at)\w+(\.|dot)\w{1,3}/i>,
+#   @start=29,
+#   @value="tim.petricola@gmail.com">,
+#  #<Redactor::Extract:0x007ff259585518
 #   @finish=15,
-#   @rule=#<Redactor::Rule:0x007fc05f2038d0 @block=#<Proc:0x007fc05f2038f8@/Users/Tim/Projects/redact/test.rb:13>, @reason=:palindrome, @regex=nil>,
+#   @rule=#<Redactor::Rule:0x007ff258b5a980 @block=#<Proc:0x007ff258b5a9a8@/Users/Tim/Projects/redactor/test.rb:14>, @reason=:palindrome, @regex=nil>,
 #   @start=10,
 #   @value="kayak">]
+
 ```

data/lib/redactor/dsl.rb

@@ -1,12 +1,18 @@
-module Redactor
+class Redactor
   class DSL
+    attr_reader :redactor
+
+    def initialize(redactor)
+      @redactor = redactor
+    end
+
     def rule(reason, regex = nil, &block)
       rule = Rule.new(reason, regex, &block)
-      Redactor.register_rule(rule)
+      redactor.register_rule(rule)
     end
 
-    def self.run(block)
-      new.instance_eval(&block)
+    def self.run(redactor, block)
+      new(redactor).instance_eval(&block)
     end
   end
 end

data/lib/redactor/extract.rb

@@ -1,4 +1,4 @@
-module Redactor
+class Redactor
   class Extract
     attr_reader :rule, :value, :start, :finish
 

data/lib/redactor/rule.rb

@@ -1,4 +1,4 @@
-module Redactor
+class Redactor
   class Rule
     attr_reader :reason, :regex, :block
 

data/lib/redactor/version.rb

@@ -1,3 +1,3 @@
-module Redactor
-  VERSION = '0.1.0'
+class Redactor
+  VERSION = '0.2.0'
 end

data/lib/redactor.rb

@@ -1,30 +1,22 @@
-require 'redactor/clear'
-require 'redactor/dsl'
-require 'redactor/extract'
-require 'redactor/rule'
-
-module Redactor
+class Redactor
   DEFAULT_REPLACEMENT = '[REDACTED]'.freeze
 
-  class << self
-    attr_accessor :rules
-    attr_accessor :default_replacement
-  end
+  attr_accessor :rules, :default_replacement
 
-  self.rules = []
-  self.default_replacement = DEFAULT_REPLACEMENT
+  def initialize(rules = [], &block)
+    @default_replacement = DEFAULT_REPLACEMENT
+    @rules = Array(rules)
 
-  def self.define(&block)
-    DSL.run(block)
+    DSL.run(self, block) if block_given?
   end
 
-  def self.register_rule(rule)
+  def register_rule(rule)
     rules.push(rule)
   end
 
   # returns a list of Extract objects (including position and value)
   # matching predefined rules
-  def self.extract(from)
+  def extract(from)
     rules.reduce([]) do |extracts, rule|
       new_extracts = rule.extract(from).select do |extract|
         # do not consider new extract if colliding with existing one
@@ -36,10 +28,14 @@ module Redactor
 
   # replaces parts of text by [REDACTED]. The replacement string can be
   # customized by passing a block taking the Extract object as an argument
-  def self.format(text, &block)
+  def format(text, &block)
     extract(text).each_with_object(text.clone) do |extract, redacted_text|
       sub = block_given? ? block.call(extract) : default_replacement
       redacted_text[extract.start...extract.finish] = sub
     end
   end
 end
+
+require 'redactor/dsl'
+require 'redactor/extract'
+require 'redactor/rule'

data/spec/lib/{dsl_spec.rb → redactor/dsl_spec.rb}

@@ -8,13 +8,16 @@ describe Redactor::DSL do
           rule :foo, /foo/
         end
 
+        redactor = double
         rule = double('Redactor::Rule')
+
         expect(Redactor::Rule).to(
           receive(:new).with(:foo, /foo/).and_return(rule)
         )
-        expect(Redactor).to receive(:register_rule).with(rule)
 
-        Redactor::DSL.run(definitions)
+        expect(redactor).to receive(:register_rule).with(rule)
+
+        Redactor::DSL.run(redactor, definitions)
       end
     end
 
@@ -26,16 +29,19 @@ describe Redactor::DSL do
           rule(:foo, &proc)
         end
 
+        redactor = double
         rule = double('Redactor::Rule')
+
         expect(Redactor::Rule).to(
           receive(:new).with(:foo, nil) do |*_args, &block|
             expect(proc).to be(block)
             rule
           end
         )
-        expect(Redactor).to receive(:register_rule).with(rule)
 
-        Redactor::DSL.run(definitions)
+        expect(redactor).to receive(:register_rule).with(rule)
+
+        Redactor::DSL.run(redactor, definitions)
       end
     end
   end

data/spec/lib/{rules_spec.rb → redactor/rules_spec.rb}

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
-RSpec::Matchers.define :be_redacted do |reason|
+RSpec::Matchers.define :be_redacted do |reason, redactor|
   match do |actual|
-    Redactor.extract(actual).any? do |extract|
+    redactor.extract(actual).any? do |extract|
       extract.value == actual && extract.reason == reason
     end
   end
 end
 
 describe 'Redactor rules' do
-  before do
-    Redactor.define do
+  let(:redactor) do
+    Redactor.new do
       # US phone
       rule :phone, /(\+?1[ \.-]?)?\(?\d{3}\)?[ \.-]?\d{3}[ \.-]?\d{4}/
 
@@ -19,8 +19,6 @@ describe 'Redactor rules' do
     end
   end
 
-  after { Redactor.clear }
-
   {
     '1 234 567 8901' => :phone,
     '12345678901' => :phone,
@@ -36,7 +34,7 @@ describe 'Redactor rules' do
     'foo AT bar DOT baz' => :email
   }.each do |value, reason|
     describe(value) do
-      it { should be_redacted(reason) }
+      it { should be_redacted(reason, redactor) }
     end
   end
 end

data/spec/lib/redactor_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Redactor do
+  let(:foobar_rule) { Redactor::Rule.new(:foobar, /foobar/) }
+  let(:barbaz_rule) { Redactor::Rule.new(:barbaz, /barbaz/) }
+
+  it 'accepts a single rule' do
+    redactor = Redactor.new(foobar_rule)
+    expect(redactor.rules).to eq [foobar_rule]
+  end
+
+  it 'accepts an array of rule' do
+    redactor = Redactor.new([foobar_rule])
+    expect(redactor.rules).to eq [foobar_rule]
+  end
+
+  it 'accepts a block' do
+    redactor = Redactor.new do
+      rule :foo, /foo/
+    end
+    expect(redactor.rules.length).to be 1
+    expect(redactor.rules[0].reason).to eq :foo
+  end
+
+  describe '.extract' do
+    let(:redactor) do
+      redactor = Redactor.new
+      redactor.register_rule(foobar_rule)
+      redactor.register_rule(barbaz_rule)
+      redactor
+    end
+
+    it 'return extracts' do
+      text = 'hello barbaz foobar'
+      results = redactor.extract(text)
+      expect(results.first.rule).to be foobar_rule
+      expect(results.first.value).to eq 'foobar'
+      expect(results.last.rule).to be barbaz_rule
+      expect(results.last.value).to eq 'barbaz'
+    end
+
+    context 'colliding rules' do
+      it "only keep first defined rule's match" do
+        text = 'hello foobarbaz'
+        results = redactor.extract(text)
+        expect(results.size).to eq 1
+        expect(results.first.rule).to be foobar_rule
+      end
+    end
+  end
+
+  describe '.format' do
+    let(:redactor) do
+      redactor = Redactor.new
+      redactor.register_rule(foobar_rule)
+      redactor.register_rule(barbaz_rule)
+      redactor
+    end
+
+    it 'replaces redacted parts' do
+      text = 'hello barbaz foobar'
+      expect(redactor.format(text)).to eq 'hello [REDACTED] [REDACTED]'
+    end
+
+    it 'accepts a block for redacted strings' do
+      text = 'hello barbaz foobar'
+
+      redacted = redactor.format(text) do |extract|
+        "[#{extract.reason.upcase}]"
+      end
+
+      expect(redacted).to eq 'hello [BARBAZ] [FOOBAR]'
+    end
+
+    it 'does not mutate original string' do
+      text = 'hello barbaz foobar'
+      redactor.format(text)
+      expect(text).to eq 'hello barbaz foobar'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redactor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Petricola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -46,24 +46,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/redactor.rb
-- lib/redactor/clear.rb
 - lib/redactor/dsl.rb
 - lib/redactor/extract.rb
 - lib/redactor/rule.rb
 - lib/redactor/version.rb
 - redactor.gemspec
-- spec/lib/clear_spec.rb
-- spec/lib/dsl_spec.rb
-- spec/lib/extract_spec.rb
-- spec/lib/redact_spec.rb
-- spec/lib/rule_spec.rb
-- spec/lib/rules_spec.rb
+- spec/lib/redactor/dsl_spec.rb
+- spec/lib/redactor/extract_spec.rb
+- spec/lib/redactor/rule_spec.rb
+- spec/lib/redactor/rules_spec.rb
+- spec/lib/redactor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/TimPetricola/redactor
 licenses:
@@ -85,15 +84,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Redact parts of text defined by custom rules (e.g. emails, phone numbers)
 test_files:
-- spec/lib/clear_spec.rb
-- spec/lib/dsl_spec.rb
-- spec/lib/extract_spec.rb
-- spec/lib/redact_spec.rb
-- spec/lib/rule_spec.rb
-- spec/lib/rules_spec.rb
+- spec/lib/redactor/dsl_spec.rb
+- spec/lib/redactor/extract_spec.rb
+- spec/lib/redactor/rule_spec.rb
+- spec/lib/redactor/rules_spec.rb
+- spec/lib/redactor_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/redactor/clear.rb

@@ -1,5 +0,0 @@
-module Redactor
-  def self.clear
-    self.rules = []
-  end
-end

data/spec/lib/clear_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe 'clear' do
-  after { Redactor.clear }
-
-  it 'unload all rules' do
-    Redactor.clear
-    Redactor.register_rule(double)
-    expect { Redactor.clear }.to change { Redactor.rules.size }.from(1).to(0)
-  end
-end

data/spec/lib/redact_spec.rb

@@ -1,55 +0,0 @@
-require 'spec_helper'
-
-describe Redactor do
-  before do
-    @foobar_rule = Redactor::Rule.new(:foobar, /foobar/)
-    @barbaz_rule = Redactor::Rule.new(:barbaz, /barbaz/)
-    Redactor.register_rule(@foobar_rule)
-    Redactor.register_rule(@barbaz_rule)
-  end
-
-  after { Redactor.clear }
-
-  describe '.extract' do
-    it 'return extracts' do
-      text = 'hello barbaz foobar'
-      results = Redactor.extract(text)
-      expect(results.first.rule).to be @foobar_rule
-      expect(results.first.value).to eq 'foobar'
-      expect(results.last.rule).to be @barbaz_rule
-      expect(results.last.value).to eq 'barbaz'
-    end
-
-    context 'colliding rules' do
-      it "only keep first defined rule's match" do
-        text = 'hello foobarbaz'
-        results = Redactor.extract(text)
-        expect(results.size).to eq 1
-        expect(results.first.rule).to be @foobar_rule
-      end
-    end
-  end
-
-  describe '.format' do
-    it 'replaces redacted parts' do
-      text = 'hello barbaz foobar'
-      expect(Redactor.format(text)).to eq 'hello [REDACTED] [REDACTED]'
-    end
-
-    it 'accepts a block for redacted strings' do
-      text = 'hello barbaz foobar'
-
-      redacted = Redactor.format(text) do |extract|
-        "[#{extract.reason.upcase}]"
-      end
-
-      expect(redacted).to eq 'hello [BARBAZ] [FOOBAR]'
-    end
-
-    it 'does not mutate original string' do
-      text = 'hello barbaz foobar'
-      Redactor.format(text)
-      expect(text).to eq 'hello barbaz foobar'
-    end
-  end
-end