redacted 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 696543c83a20c2ec7c2e3e1be6062f94b220c5e6
-  data.tar.gz: e6a6d8bfd03718e43f5aae7b492ddf583a392a3d
+  metadata.gz: 898b8576effd7e89eeb8eb860a759bac5d686697
+  data.tar.gz: f74e3c61e9c52b704fb43015f8823de025ce039c
 SHA512:
-  metadata.gz: c90ebfe53f7445723c715c0871e7f6fd681ae41db835eae3ab773478945173a8e9c0ce54d1447bad0ec3227d764ec5f9cbb72b7130cb135a4c24ba231031fe4c
-  data.tar.gz: 25720cd8c67d238dff781e163da67c690b7af1b411f10c2f103e30c3056252e1532c79be7047c569ad22b465842e2622d8e9c886bb7a14fe4e3819a226072d3b
+  metadata.gz: 9bec6a5dbd663398a030755781daf8d0a2e6635fb8b2ce1bbaa862bace4d1b829d98746a38c82cc3aa052c5a06192a0fb86ad67dc0721bab59891a74ecfb97ed
+  data.tar.gz: a4054c2c4a49a5320c495becce7f2f8defc9213926c1aafbeb1894145ea3e3f4e89bdfa580312d2071560c97617907a9483695678596390f2281e128460fa316

data/Gemfile

@@ -1,8 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in redacted.gemspec
 gemspec
 
 group :development do
   gem 'pry', platforms: :ruby
 end
+
+group :test do
+  gem "codeclimate-test-reporter", require: false
+end

data/README.md

@@ -1,51 +1,53 @@
 # Redacted
+[![Circle CI](https://circleci.com/gh/kurtfunai/redacted/tree/master.png?style=badge)](https://circleci.com/gh/kurtfunai/redacted/tree/master) [![Code Climate](https://codeclimate.com/github/kurtfunai/redacted/badges/gpa.svg)](https://codeclimate.com/github/kurtfunai/redacted) [![Test Coverage](https://codeclimate.com/github/kurtfunai/redacted/badges/coverage.svg)](https://codeclimate.com/github/kurtfunai/redacted)
 
-The goal of Redacted is to take a block of text, turn it into Lorem ipsum of the same size, and then apply styles with CSS to make the text appear redacted! Just like top secret documents.
+The goal of Redacted is to take text like `My maple syrup was stolen by a moose!` and black it out, just like on a top secret document!
 
-Basically it takes a string like `My maple syrup was stolen by a moose!` and turns it into a blacked-out block of text that is roughly the same size.
+To keep the redacted information private, it turns the text into [Lorem ipsum](http://www.lipsum.com/). It tries its best to maintain the same size & shape of the text that is being redacted.
+
+Redacted works with both plain text and HTML.
 
 ## Installation
 
 Add this line to your application's Gemfile:
-
-    gem 'redacted'
+```ruby
+gem 'redacted'
+```
 
 And then execute:
-
-    $ bundle
+```bash
+$ bundle
+```
 
 In your application.css, include the css file:
-```
+```css
 /*
  *= require redacted
  */
 ```
-## Usage
 
-Redacted will convert both plaintext and HTML into redacted text.
+## Usage
 
 After installing the gem, you will have access to a couple new methods in your Rails Views.
 
-**Plain text (inline):**
+**redact(str)**
 ```ruby
-<%= redact('All of the maple syrup was stolen by aliens.')=>
-#=> Iusto eos eligendi non iure rerum quia accus
+# Plain text (inline):
+<%= redact("You know nothing Jon Snow") %>
+#=> Iusto eos eligendi non iu
 
-All of the maple syrup was stolen by <%= redact('aliens')=>.
+All of the maple syrup was stolen by <%= redact("aliens") %>.
 #=> All of the maple syrup was stolen by ducimu
-```
-The plain text method can create inline redacted text, or write out paragraphs to maintain the size/shape of paragraphs.
 
-**Plain text (paragraphs):**
-```ruby
-<%= redact('Roses are red.\nViolets are blue.\n\nAll our base\r\n are belong to you.')=>
-#=> <p>Roses are red.</p><p>Violets are blue.</p><p>All our base</p><p>are belong to you.</p>
+# Plain text (paragraphs):
+<%= redact("Roses are red.\nViolets are blue.\n\nAll our base\r\n are belong to you.") %>
+#=> <p>consequatur et</p><p>excepturi sed dol</p><p>maxime id su</p><p>at non quia nonotas</p>
 ```
-The `#redact` method will try to guess if the text should be inline or not, but you can also explictly call `redact_text` or `redact_paragraphs` if you want specific functionality.
+The `#redact` method will try to guess if the text should be inline or not, but you can also explictly call `redact_text(str)` for inline rendering, or `redact_paragraphs(str)` for paragraphs wrapped in `<p>` tags.
 
-**HTML**
+**redact_html(html_str)**
 ```ruby
-redact_html('<p>A mind needs books as a sword needs a whetstone<br>if it is to keep its edge.</p><div>- George R.R. Martin, A Game of Thrones</div>')
+redact_html("<p>A mind needs books as a sword needs a whetstone<br>if it is to keep its edge.</p><div>- George R.R. Martin, A Game of Thrones</div>")
 #=> <p>adipisci labore quae perferendis impedit autem <br>odit impedit dolorem rerum</p><div>et quibusdam qui quis accusantium ullam</div>
 ```
 Redacted parses the HTML string and replaces the text with lorem ipsum while maintaining the original HTML structure.
@@ -55,7 +57,7 @@ Redacted takes text like `Winter is coming.` and replaces it with lorem ipsum of
 
 It then returns the redacted text surrounded by `<span></span>` tags that have the class `.redacted-text`.
 ```ruby
-redact('Winter is coming.')
+redact("Winter is coming.")
 ```
 Becomes:
 ```html

data/Rakefile

@@ -28,7 +28,6 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test
 
 

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.1.6

data/lib/redacted.rb

@@ -2,7 +2,7 @@ require 'redacted/version'
 require 'redacted/action_view/helpers.rb'
 require 'redacted/engine.rb' if defined?(Rails)
 require 'redacted/railtie.rb' if defined?(Rails)
-require 'faker'
+require 'ffaker'
 require 'nokogiri'
 
 module Redacted

data/lib/redacted/version.rb

@@ -1,3 +1,3 @@
 module Redacted
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/redacted.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faker", "~> 1.4"
+  spec.add_dependency "ffaker", "~> 1.24.0"
   spec.add_dependency "nokogiri", "~> 1.6.3"
   spec.add_dependency "railties", ">= 3.2", "< 5.0"
 

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: redacted
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kurt Funai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/stylesheets/redacted.css
+- circle.yml
 - lib/redacted.rb
 - lib/redacted/action_view/helpers.rb
 - lib/redacted/engine.rb
@@ -184,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Convert strings into redacted text.
@@ -233,3 +234,4 @@ test_files:
 - test/redacted_helper_test.rb
 - test/redacted_test.rb
 - test/test_helper.rb
+has_rdoc: