redacted 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 696543c83a20c2ec7c2e3e1be6062f94b220c5e6
+  data.tar.gz: e6a6d8bfd03718e43f5aae7b492ddf583a392a3d
+SHA512:
+  metadata.gz: c90ebfe53f7445723c715c0871e7f6fd681ae41db835eae3ab773478945173a8e9c0ce54d1447bad0ec3227d764ec5f9cbb72b7130cb135a4c24ba231031fe4c
+  data.tar.gz: 25720cd8c67d238dff781e163da67c690b7af1b411f10c2f103e30c3056252e1532c79be7047c569ad22b465842e2622d8e9c886bb7a14fe4e3819a226072d3b

data/.gitignore

@@ -0,0 +1,31 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redacted.gemspec
+gemspec
+
+group :development do
+  gem 'pry', platforms: :ruby
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kurt Funai
+
+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,72 @@
+# 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.
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redacted'
+
+And then execute:
+
+    $ bundle
+
+In your application.css, include the css file:
+```
+/*
+ *= require redacted
+ */
+```
+## Usage
+
+Redacted will convert both plaintext and HTML into redacted text.
+
+After installing the gem, you will have access to a couple new methods in your Rails Views.
+
+**Plain text (inline):**
+```ruby
+<%= redact('All of the maple syrup was stolen by aliens.')=>
+#=> Iusto eos eligendi non iure rerum quia accus
+
+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>
+```
+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.
+
+**HTML**
+```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>')
+#=> <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.
+
+## How it works
+Redacted takes text like `Winter is coming.` and replaces it with lorem ipsum of the same string length.
+
+It then returns the redacted text surrounded by `<span></span>` tags that have the class `.redacted-text`.
+```ruby
+redact('Winter is coming.')
+```
+Becomes:
+```html
+<span class="redacted-text">quis saepe enimat</span>
+```
+Some basic CSS styles are included with the gem, but you can overwrite the look of the text by adding your own styles if you prefer.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redacted/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Redacted'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test
+
+

data/app/assets/stylesheets/redacted.css

@@ -0,0 +1,2 @@
+.redacted-text {background: #000;color:#000;}
+.redacted-text::selection {background: #000;color:#000;}

data/lib/redacted.rb

@@ -0,0 +1,10 @@
+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 'nokogiri'
+
+module Redacted
+end
+

data/lib/redacted/action_view/helpers.rb

@@ -0,0 +1,45 @@
+module Redacted
+  module ActionView
+    module Helpers
+      def ascii_redact str
+        length = str.length
+        "\u2588" * length unless length.zero?
+      end
+
+      def redact str
+        if str.include?("\n")
+          redact_paragraphs(str).join('').html_safe
+        else
+          redact_text(str).html_safe
+        end
+      end
+
+      def redact_paragraphs str
+        str.lines.map do |l|
+          "<p>#{redact_text(l.chomp)}</p>" if l.chomp.present?
+        end.reject{|l|l.nil?}
+      end
+
+      def redact_text str
+        return '' unless str
+        "<span class=\"redacted-text\">#{generate_fake_text(str)}</span>"
+      end
+
+      def redact_html html_str
+        doc = Nokogiri::HTML::DocumentFragment.parse(html_str)
+        doc.traverse do |ele|
+          ele.replace(redact_text(ele.content.chomp)) if ele.text?
+        end
+        doc.to_html
+      end
+
+      private
+      def generate_fake_text str
+        word_count = str.split.size
+        fake_text = Faker::Lorem.words(word_count).join(' ')
+        fake_text << Faker::Lorem.characters(str.length - fake_text.length) if str.length > fake_text.length
+        fake_text.slice(0, str.length)
+      end
+    end
+  end
+end

data/lib/redacted/engine.rb

@@ -0,0 +1,4 @@
+module Redacted
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/redacted/railtie.rb

@@ -0,0 +1,9 @@
+module Redacted
+  class Railtie < ::Rails::Railtie
+    initializer "redacted.configure_view_controller" do |app|
+      ActiveSupport.on_load :action_view do
+        include Redacted::ActionView::Helpers
+      end
+    end
+  end
+end

data/lib/redacted/version.rb

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

data/redacted.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redacted/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redacted"
+  spec.version       = Redacted::VERSION
+  spec.authors       = ["Kurt Funai"]
+  spec.email         = ["me@kurtfunai.com"]
+  spec.summary       = "Convert strings into redacted text."
+  spec.description   = "Allows a user to turn any string of text into a redacted block of the same size."
+  spec.homepage      = "http://kurtfunai.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "faker", "~> 1.4"
+  spec.add_dependency "nokogiri", "~> 1.6.3"
+  spec.add_dependency "railties", ">= 3.2", "< 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", "~> 4.1"
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ *= require redacted
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/welcome_controller.rb

@@ -0,0 +1,4 @@
+class WelcomeController < ApplicationController
+  def index
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/welcome/index.html.erb

@@ -0,0 +1,42 @@
+<h1>Welcome#index</h1>
+<p>Don't mind me... just redacting some stuff.</p>
+
+<h3>Example:</h3>
+<p>All of the maple syrup was stolen by aliens.</p>
+<p><%= redact('All of the maple syrup was stolen by aliens.') %></p>
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit. Tempore, molestias maiores sit doloribus officiis quibusdam quod perspiciatis minus cupiditate necessitatibus vitae architecto atque error eaque repellat et quae aliquam tenetur!
+<p><%= redact('Lorem ipsum dolor sit amet, consectetur adipisicing elit. Tempore, molestias maiores sit doloribus officiis quibusdam quod perspiciatis minus cupiditate necessitatibus vitae architecto atque error eaque repellat et quae aliquam tenetur!') %></p>
+
+<p>All of the maple syrup was stolen by <%= redact('aliens.') %></p>
+
+<br><br><br><br>
+<%
+@new_lines =
+'Lorem ipsum dolor sit amet, consectetur adipisicing elit. In, provident, cupiditate iusto magni eius tenetur voluptates quisquam nobis modi alias quia vitae necessitatibus et adipisci sunt placeat reprehenderit non molestiae.
+
+Quas, possimus unde a cumque quasi. Saepe aliquam ex nobis autem recusandae minus libero! Facere incidunt optio repellat aperiam autem quam non dolore recusandae. Perspiciatis corporis beatae maxime illum quis.
+
+Non aliquid architecto optio provident sequi placeat cupiditate similique voluptate eveniet nesciunt? Nisi, sint, veniam, delectus, obcaecati rem nobis veritatis explicabo saepe velit et impedit quae possimus qui quidem repellendus.'
+%>
+<%= @new_lines.html_safe %>
+<br>
+<%= redact(@new_lines).html_safe %>
+
+<br><br><br><br>
+<%
+@p_tags = '<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo, tempora, qui temporibus ut a sapiente natus voluptate incidunt soluta velit ullam recusandae veniam nulla. A laboriosam reprehenderit esse quas voluptates!</p>
+<p>Esse, similique, deleniti neque fuga ea perferendis praesentium vitae nam repudiandae atque labore nostrum autem omnis iusto in dolore blanditiis doloremque quae ut maxime placeat quo sit. Earum, enim, pariatur!</p>'
+%>
+<%= @p_tags.html_safe %>
+<br>
+<%= redact_html(@p_tags).html_safe %>
+
+
+<br><br><br><br>
+<%
+@br = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. Illo, tempora, qui temporibus ut a sapiente natus voluptate incidunt soluta velit ullam recusandae veniam nulla. A laboriosam reprehenderit esse quas voluptates!<br>Esse, similique, deleniti neque fuga ea perferendis praesentium vitae nam repudiandae atque labore nostrum autem omnis iusto in dolore blanditiis doloremque quae ut maxime placeat quo sit. Earum, enim, pariatur!'
+%>
+<%= @br.html_safe %>
+<br>
+<%= redact_html(@br).html_safe %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application