crosby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b6644351cbd94255b116edf49999a4aa7f8a202
+  data.tar.gz: d206eadba0406bd3d0df0f7c07f7d819ec6eb38a
+SHA512:
+  metadata.gz: 4a8bbab03e19b11417d517d44b76d7fa59c7a09d4d70fe35dc9ebb660538842d0ad8d431589b7296e0c431fb4575f174e314e16ffd46a41d91c82c393d3a6b90
+  data.tar.gz: 44460e785fa692c1249d98df48c912bd50a8b55f4fe6773d00c0dba1ddff5aeed78545110ffacf60c97af8995c47bd659d275010c34d847b4a2bd58ee7092e5d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "pry"
+
+# Specify your gem"s dependencies in crosby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dan Matthews
+
+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,211 @@
+# Crosby
+
+Allows for quality checks on `ActionMailer` emails when migrating to new systems.
+
+http://en.wikipedia.org/wiki/Philip_B._Crosby
+
+```
+Crosby's response to the quality crisis was the principle of
+"doing it right the first time" (DIRFT). He also included four major principles:
+
+The definition of quality is conformance to requirements
+  (requirements meaning both the product and the customer's requirements)
+The system of quality is prevention
+The performance standard is zero defects (relative to requirements)
+The measurement of quality is the price of nonconformance
+```
+
+This is a work in progress which came out of a need to compare emails generated
+on our 'nextjenn' platform to emails generated in our legacy codebase.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "crosby"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crosby
+
+## Configuration
+
+Crosby has 2 configurable values, `app_name` and `export_path` with the
+following defaults:
+
+```ruby
+Crosby.config
+# => { :app_name => "6f292f17", :export_path => "tmp/crosby" }
+```
+
+NOTE: The value of `app_name` is randomized and will not stay consistent across
+application loads unless specifically set. Config options can be set via a
+block.
+
+```ruby
+Crosby.config do |c|
+  c.app_name = "ExampleApp"
+  c.export_path = "../crosby_files"
+end
+```
+
+## Usage
+
+### Basic Usage
+
+Crosby exports a slightly curated version of `Mail::Message` objects produced
+by `ActionMailer` subclasses to a `.crosby` file. The class responsible for
+producing this file is `Crosby::Exporter`.
+
+```ruby
+exporter = Crosby::Exporter.new(
+  MailerClass, :method, 'a-unique-id'[, arg1[, arg2[, ...]]]
+)
+
+exporter.export
+```
+
+Also available is the `Crosby::Exporter#to_s` method which will return the
+`.crosby` file's contents as a string.
+
+```ruby
+exporter.to_s
+```
+
+### RSpec
+
+`Crosby::RSpecHelper` works with RSpec 1, 2 & 3, and adds the `#crosby_email`
+helper method. You can use this method to create `.crosby` files inside your
+existing tests.
+
+```ruby
+# spec_helper.rb
+
+require "crosby/rspec_helper"
+
+Crosby.config do |c|
+  # ...
+end
+```
+
+```ruby
+# spec/mailers/example_mailer_spec.rb
+require "spec_helper"
+
+describe ExampleMailer do
+  context "#notify" do
+    it "should send a notification email" do
+      mailer = ExampleMailer.notify(arg1, arg1)
+
+      # becomes
+      mailer = crosby_email(ExampleMailer, :notify, arg1, arg2)
+
+      # ...
+    end
+  end
+
+  # ...
+end
+```
+
+In the above example, Crosby will generate a uuid based on the mailer class,
+method name and argument values. While this is fine, it may be helpful to
+implicitly set the uuid. You can do this by setting the `@crosby_uuid` instance
+variable in your test.
+
+```ruby
+# spec/mailers/example_mailer_spec.rb
+require "spec_helper"
+
+describe ExampleMailer do
+  context "#notify" do
+    it "should send a notification email" do
+      @crosby_uuid = "example_mailer_notify"
+      mailer = crosby_email(ExampleMailer, :notify, arg1, arg2)
+
+      # ...
+    end
+  end
+
+  # ...
+end
+```
+
+### Generating a diff
+
+`Crosby::Diff` is responsible for comparing files of the same uuid to eachother.
+There must be at least 2 files with the same uuid present in the configured
+directory for a diff to be generated. If there are more than 2 files for a
+given uuid, a diff will be generated for each unique pair of files.
+
+```ruby
+Crosby::Diff.compare("example_mailer_notify")
+# => [diff_str, ...]
+```
+
+`Crosby::Diff.compare` returns an array of diff strings, one for each file pair.
+When no pairs are present, `compare` returns an empty array.
+
+```ruby
+Crosby::Diff.compare("not-an-existing-uuid")
+# => []
+```
+
+It also accepts an optional block, to be called once per diff string.
+
+```ruby
+Crosby::Diff.compare("example_mailer_notify") { |diff| puts diff }
+# diff output
+# => [diff_str, ...]
+```
+
+`Crosby::Diff.compare` and `Crosby::Diff.new` both accept an options hash to
+override `Crosby.config` settings.
+
+```ruby
+Crosby::Diff.compare("example_mailer_notify", :export_path => "../crosby_files")
+Crosby::Diff.new("example_mailer_notify", :export_path => "../crosby_files")
+```
+
+`Crosby::Diff` uses the excellent [Diffy gem](https://github.com/samg/diffy)
+behind the scenes. If you would like access to the `Diffy::Diff` objects, you
+can access them through the `Crosby::Diff#diffs` method.
+
+```ruby
+cdiff = Crosby::Diff.new("example_mailer_notify")
+cdiff.diffs
+# => [ [#<Diffy::Diff:0x00000000>, #<Diffy::Diff:0x00000001], [..., ...], ... ]
+```
+
+### Rake
+
+Crosby provides a simple `rake crosby:diff` command which outputs diffs for all
+of the uuids represented by files in the directory specified at
+`Crosby.config[:export_path]`.
+
+```ruby
+# Rakefile
+require "crosby/tasks"
+
+Crosby.config do |c|
+  c.export_path = "../crosby_files"
+end
+```
+
+```sh
+bundle exec rake crosby:diff
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/crosby/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,7 @@
+require "bundler/gem_tasks"
+
+task :console do
+  require "crosby"
+  require "pry"
+  Pry.start
+end

data/crosby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "crosby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "crosby"
+  spec.version       = Crosby::VERSION
+  spec.authors       = ["Dan Matthews"]
+  spec.email         = ["dan.matthews@teamsnap.com"]
+  spec.summary       = %q{Quality Assurance for ActionMailer}
+  spec.description   = %q{Allows generation and comparison of email output}
+  spec.homepage      = "https://github.com/teamsnap/crosby"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "diffy", "~> 3.0"
+  spec.add_dependency "nokogiri", "~> 1.6"
+end

data/lib/crosby/configuration.rb

@@ -0,0 +1,25 @@
+require "securerandom"
+
+module Crosby
+  class Configuration
+    attr_accessor :app_name, :export_path
+
+    def initialize
+      self.app_name = SecureRandom.hex(4)
+      self.export_path = "tmp/crosby"
+    end
+
+    def config(&block)
+      block.call(self) if block_given?
+      to_hsh
+    end
+
+    def to_hsh
+      {
+        :app_name => app_name,
+        :export_path => export_path
+      }
+    end
+    alias :to_h :to_hsh
+  end
+end

data/lib/crosby/diff.rb

@@ -0,0 +1,81 @@
+require "diffy"
+
+module Crosby
+  class Diff
+    class << self
+      def compare(uuid, options = {}, &block)
+        new(uuid, options).compare(&block)
+      end
+    end
+
+    def initialize(uuid, options = {})
+      @uuid = uuid
+      @config = Crosby.config.merge(options)
+    end
+
+    # https://github.com/samg/diffy#supported-formats
+    def compare(format = :color, &block)
+      diffs.map { |diff|
+        out = diff.to_s(format)
+        block_given? ? block.call(out) : out
+      }
+    end
+
+    def diffs
+      @diffs ||= [].tap { |diffs|
+        pairs.each { |pair|
+          diffs << Diffy::Diff.new(
+            *pair,
+            :context => 0,
+            :include_diff_info => true,
+            :source => "files"
+          )
+        }
+      }
+    end
+
+    private
+
+    def build_file_paths(pairs)
+      pairs.map { |pair|
+        pair.map { |filename|
+          File.realpath(File.join(@config[:export_path], filename))
+        }
+      }
+    end
+
+    def files
+      matcher = Regexp.new("#{@uuid}\\.crosby\\z")
+
+      Dir.new(@config[:export_path]).entries.select { |entry|
+        entry =~ matcher ? true : false
+      }
+    end
+
+    def pairs
+      [
+        :unique_pairs,
+        :sort_pairs,
+        :build_file_paths
+      ].reduce([]) { |obj, meth|
+        send(meth, obj)
+      }
+    end
+
+    def sort_pairs(pairs)
+      pairs.map { |pair|
+        pair.first =~ Regexp.new(@config[:app_name]) ? pair.reverse : pair
+      }
+    end
+
+    def unique_pairs(arr)
+      arr.tap { |pairs|
+        files.repeated_permutation(2) { |permutation|
+          pairs << permutation.sort unless permutation.uniq.length == 1
+        }
+
+        pairs.uniq!
+      }
+    end
+  end
+end

data/lib/crosby/errors.rb

@@ -0,0 +1,5 @@
+module Crosby
+  MissingDependency = Class.new(StandardError)
+  MissingRSpec = Class.new(StandardError)
+  UnsupportedVersion = Class.new(StandardError)
+end

data/lib/crosby/exporter.rb

@@ -0,0 +1,108 @@
+require "fileutils"
+require "securerandom"
+require "nokogiri"
+
+module Crosby
+  class Exporter
+    WRITE_MODE = "w"
+
+    attr_reader :mail
+
+    def initialize(mailer, method, uuid = SecureRandom.hex(8), *args)
+      @args = args
+      @mailer = mailer
+      @method = method
+      @uuid = uuid
+      @version = Crosby.action_mailer_version
+
+      config = Crosby.config
+      @path = config[:export_path]
+      @app_name = config[:app_name]
+    end
+
+    def export
+      ensure_path_exists
+      write
+      true
+    end
+
+    def to_s
+      create_mail unless mail
+
+      [
+        "TO: #{mail.to}",
+        "CC: #{mail.cc}",
+        "BCC: #{mail.bcc}",
+        "REPLY TO: #{mail.reply_to}",
+        "FROM: #{mail.from}",
+        "HTML:",
+        commonize_html(mail.html_part.body.raw_source),
+        "TEXT:",
+        commonize_text(mail.text_part.body.raw_source)
+      ].join("\n")
+    end
+
+    private
+
+    def commonize_html(str)
+      commonize_text(str)
+      compact(Nokogiri::HTML::Document.parse(commonize_text(str)).to_s)
+    end
+
+    def commonize_text(str)
+      str
+        .gsub(/([^=])=\n/, '\1') # single quotes required for encoding
+        .gsub(/=3D/, "=")
+    end
+
+    def compact(str)
+      str
+        .each_line
+        .reject(&:blank?)
+        .map{ |line|
+          line
+            .gsub(/\s+/, " ")
+            .gsub(/^ /, "")
+            .gsub(/ $/, "\n")
+            .gsub(/></, ">\n<")
+        }
+        .join
+    end
+
+    def create_mail
+      method = @method
+
+      case @version::MAJOR
+      when 2
+        method = "create_#{method}"
+      when 3
+        # supported, no additional action required
+      when 4
+        # supported, no additional action required
+      else
+        raise Crosby::UnsupportedVersion, "We do not yet support version " \
+          "#{@version::STRING} of ActionMailer"
+      end
+
+      @mail = @mailer.send(method, *@args)
+    end
+
+    def ensure_path_exists
+      @dir = Dir.new(FileUtils.mkdir_p(@path).first)
+    end
+
+    def file(&block)
+      File.open(filename, WRITE_MODE, &block)
+    end
+
+    def filename
+      File.join(@dir, "#{@mailer.name}.#{@method}.#{@app_name}.#{@uuid}.crosby")
+    end
+
+    def write
+      file do |f|
+        f.write(to_s)
+      end
+    end
+  end
+end

data/lib/crosby/rspec_helper.rb

@@ -0,0 +1,31 @@
+require "base64"
+require "crosby"
+
+module Crosby
+  module RSpecHelper
+    def crosby_email(mailer, method, *args)
+      @crosby_uuid ||= generate_crosby_digest(mailer, method, *args)
+      exporter = Crosby::Exporter.new(mailer, method, @crosby_uuid, *args)
+      return (exporter.export ? exporter.mail : false)
+    end
+
+    def generate_crosby_digest(*args)
+      Base64.encode64(args.map(&:to_s).join("|")).chomp
+    end
+  end
+end
+
+begin
+  if Kernel.const_defined?(:Spec)
+    class ActiveSupport::TestCase
+      include Crosby::RSpecHelper
+    end
+  else
+    RSpec.configure do |c|
+      c.include Crosby::RSpecHelper
+    end
+  end
+rescue NameError
+  raise Crosby::MissingRSpec, "Crosby can't find RSpec at the Spec::Runner " \
+                              "or RSpec namespace."
+end

data/lib/crosby/tasks.rb

@@ -0,0 +1,44 @@
+require "crosby"
+
+module Crosby
+  class Tasks
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      namespace :crosby do
+        desc "displays all diffs in the configured folder " +
+             "(#{Crosby.config[:export_path]})"
+        task :diff do
+          each_uuid do |uuid|
+            puts "============================================================"
+            puts "UUID: #{uuid}"
+            puts "============================================================"
+            Crosby::Diff.compare(uuid) { |diff| puts diff }
+          end
+        end
+      end
+    end
+
+    private
+
+    def each_uuid(&block)
+      [].tap { |uuids|
+        Dir.new(Crosby.config[:export_path]).each { |filename|
+          uuids << extract_uuid(filename) if filename =~ /\.crosby$/
+        }
+
+        uuids.compact!
+        uuids.uniq!
+        uuids.sort!
+
+        uuids.each { |uuid| block.call(uuid) } if block_given?
+      }
+    end
+
+    def extract_uuid(filename)
+      filename.gsub(/^.+\..+\..+\.(\S+)\.crosby$/, '\1')
+    end
+  end
+end
+
+Crosby::Tasks.new.install_tasks

data/lib/crosby/version.rb

@@ -0,0 +1,3 @@
+module Crosby
+  VERSION = "0.1.0"
+end

data/lib/crosby.rb

@@ -0,0 +1,20 @@
+require "crosby/version"
+
+module Crosby
+  def self.config(&block)
+    @@configuration ||= Configuration.new
+    @@configuration.config(&block)
+  end
+
+  def self.action_mailer_version
+    require "action_mailer/version"
+    ActionMailer::VERSION
+  rescue
+    raise Crosby::MissingDependency, "Some version of ActionMailer is required"
+  end
+end
+
+require "crosby/configuration"
+require "crosby/errors"
+require "crosby/exporter"
+require "crosby/diff"

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: crosby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Matthews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Allows generation and comparison of email output
+email:
+- dan.matthews@teamsnap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crosby.gemspec
+- lib/crosby.rb
+- lib/crosby/configuration.rb
+- lib/crosby/diff.rb
+- lib/crosby/errors.rb
+- lib/crosby/exporter.rb
+- lib/crosby/rspec_helper.rb
+- lib/crosby/tasks.rb
+- lib/crosby/version.rb
+homepage: https://github.com/teamsnap/crosby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Quality Assurance for ActionMailer
+test_files: []