monet 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a11fc10105edf8cce2166fb0bf751e84115374f
-  data.tar.gz: e895a699a3246d30ce4d46231a54eaaa0e4f58a7
+  metadata.gz: 4245512ca8fcbcf954b6e276d7dc978c9a680444
+  data.tar.gz: 19dd5cf3f272708cb87754604cc7902d33501144
 SHA512:
-  metadata.gz: 693e7e62a8ccbe89d7a17370961576848c48e7c172a8184db9c5447f533062251e6ba46ff8e9e29fc1b118cad1853e70b22dfe877eba8901395733119b83fee1
-  data.tar.gz: be761e3bf2fe43a9764a1b8b326bf779672113941ab1ee356b41c53436675ae7ce44c2b8b4dfa0da71c9a47553046ae4d6b5059f57bcf737b69cad7bf9c9911c
+  metadata.gz: ac0adb807b480ab762d914312f79938df763d165c52a0c43586cccd11c8b680863df007d7fd3fe132b6b33d4469e3104795fcf17924f9fa4fd287475294176b3
+  data.tar.gz: 95da6332f5b6d0af5ce48980ceedd1535ea21d472ac11c42e938a6fae25bf1b472efa6a74fd1739a61ab7afb1349bf6f5445d6800244e5f4a7b91ae3fc4de87c

data/.ruby-version

@@ -1 +1 @@
-2.0
+2.0.0-p247

data/.travis.yml

@@ -1,7 +1,14 @@
 language: ruby
 rvm:
   - 2.0
+  - 2.1
   - 1.9.3
   - rbx
+  - jruby-19mode
+
+matrix:
+  allow_failures:
+    - rvm: rbx
+    - rvm: jruby-19mode
 
 script: bundle exec rake test

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 group :test do
   gem 'flexmock'
-  gem 'pry'
+  gem 'jazz_hands'
   gem 'webmock'
   gem 'vcr'
 end

data/lib/monet/baseless_image.rb

@@ -7,5 +7,9 @@ module Monet
     def initialize(path)
       @path = path
     end
+
+    def image
+      Monet::Image.new @path
+    end
   end
-end
+end

data/lib/monet/baseline_control.rb

@@ -1,4 +1,4 @@
-require 'monet/path_router'
+require 'monet/image'
 require 'monet/changeset'
 require 'monet/baseless_image'
 require 'monet/compare'
@@ -11,20 +11,18 @@ module Monet
     attr_reader :flags
 
     def initialize(config)
-      @capture_dir = config.capture_dir
-      @baseline_dir = config.baseline_dir
+      @config = config
 
       strategy = Monet.const_get(config.compare_type)
 
+      @router = Monet::Router.new config
       @comparer = Monet::Compare.new(strategy)
-      @router = Monet::PathRouter.new(config)
       @flags = []
     end
 
     def run
-      captures.each do |capture|
-        baseline_path = @router.capture_to_baseline(capture)
-        compare @comparer.compare(baseline_path, capture)
+      captures.each do |img|
+        compare @comparer.compare(@router.baseline_dir(img.name), img.path)
       end
 
       @flags
@@ -40,29 +38,44 @@ module Monet
     end
 
     def captures
-      Dir.glob File.join(site_dir(@capture_dir), "*.png")
+      files = Dir.glob(File.join(@config.capture_dir, @config.site, "*.png"))
+      files.map do |path|
+        Monet::Image.new(path)
+      end
     end
 
     def discard(path)
       puts "discarding #{path}"
-      FileUtils.remove(path)
+      FileUtils.remove(path) if File.exists?(path)
     end
 
     def baseline(diff)
-      path = diff.path
-      to = site_dir(@baseline_dir)
+      image = diff.is_a?(String) ? Monet::Image.new(diff) : diff.image
 
-      FileUtils.mkpath to unless Dir.exists? to
-      FileUtils.move(path, to)
+      puts "baselining #{image.path}"
+      image = rebase(image)
 
-      puts "baselining #{path}"
+      # delete diff image
+      discard @router.diff_dir(image.name)
 
-      @router.capture_to_baseline(path)
+      image.thumbnail!(@router.thumbnail_dir) if @config.thumbnail?
+      image.path
     end
 
     private
-    def site_dir(base)
-      File.join base, @router.root_dir
+    # returns a new image for the moved image
+    def rebase(image)
+      new_path = @router.baseline_dir(image.name)
+
+      create_path_for_file(new_path)
+      FileUtils.move(image.path, new_path)
+
+      Monet::Image.new(new_path)
+    end
+
+    def create_path_for_file(file)
+      path = File.dirname(file)
+      FileUtils.mkpath path unless Dir.exists? path
     end
   end
 end

data/lib/monet/capture.rb

@@ -4,8 +4,8 @@ require "capybara"
 require 'capybara/poltergeist'
 require "capybara/dsl"
 
-require 'monet/config'
-require 'monet/path_router'
+require 'monet/router'
+require 'monet/image'
 
 module Monet
   class Capture
@@ -14,45 +14,46 @@ module Monet
     MAX_HEIGHT = 10000
 
     def initialize(config)
-      @config = Monet::Config.build_config(config)
-      @router = Monet::PathRouter.new(@config)
+      @config = config
+      @router = Monet::Router.new config
 
       Capybara.default_driver = @config.driver
     end
 
     def capture_all
-      @config.map.paths.each do |path|
-        capture(path)
-      end
-    end
-
-    def capture(path)
-      visit @router.build_url(path)
-
-      @config.dimensions.each do |width|
-        file_path = @router.route_url_path(path, width)
+      images = []
+      @router.capture_routes.map do |url, paths|
+        visit_once url
 
-        page.driver.resize(width, MAX_HEIGHT)
-        page.driver.render(file_path, full: true)
+        paths.each do |path|
+          image = Monet::Image.new path
+          capture(url, image)
 
-        thumbnail(file_path) if @config.thumbnail?
+          images << image
+        end
       end
+
+      images
     end
 
-    def thumbnail(path)
-      img = ChunkyPNG::Image.from_file(path)
-      short_edge = [img.width, img.height].min
-      save_path = @router.to_thumbnail_path(path)
-      save_dir = File.dirname save_path
+    def capture(url, image_or_save_path)
+      if image_or_save_path.is_a? String
+        image = Monet::Image.new image_or_save_path
+      else
+        image = image_or_save_path
+      end
 
-      puts save_path
+      visit_once url
 
-      cropped = img.crop(0, 0, short_edge, short_edge)
-      resized = cropped.resize(200, 200)
+      page.driver.resize(image.width, MAX_HEIGHT)
+      page.driver.render(image.path, full: true)
 
-      FileUtils.mkdir_p save_dir unless Dir.exists? save_dir
+      image.thumbnail!(@router.thumbnail_dir) if @config.thumbnail?
+    end
 
-      resized.save save_path
+    private
+    def visit_once(url)
+      visit url unless current_url == url
     end
   end
 end

data/lib/monet/capture_map.rb

@@ -1,11 +1,14 @@
 require 'spidr'
 require 'monet/url_helpers'
+require 'forwardable'
 
 module Monet
   class CaptureMap
     extend Forwardable
 
     class PathCollection
+      extend Forwardable
+
       include URLHelpers
       attr_reader :paths, :root_url
 
@@ -25,6 +28,8 @@ module Monet
       def normalized_path(path)
         path.chomp "/"
       end
+
+      def_delegators :paths, :size, :length, :count
     end
 
     class PathSpider < PathCollection
@@ -32,7 +37,10 @@ module Monet
       SKIP_PATHS = [/\?.*/]
 
       def paths
-        @paths = normalize Spidr.site(@root_url, ignore_links: ignores)
+        return @paths unless @paths.empty?
+
+        normalize Spidr.site(@root_url, ignore_links: ignores)
+        @paths.uniq!
       end
 
       def ignores
@@ -41,7 +49,7 @@ module Monet
 
       private
       def normalize(spider_results)
-        spider_results.history.map &:to_s
+        spider_results.history.each {|path| add(path.path) }
       end
     end
 
@@ -54,7 +62,7 @@ module Monet
       yield(@path_helper) if block_given?
     end
 
-    def_delegators :@path_helper, :paths, :paths=, :add, :root_url
+    def_delegators :@path_helper, :paths, :paths=, :add, :root_url, :size, :count, :length
 
     def type_mapper
       case @type

data/lib/monet/changeset.rb

@@ -8,6 +8,10 @@ module Monet
       @path = path
     end
 
+    def image
+      Monet::Image.new @path
+    end
+
     def modified?
       pixels_changed > 0
     end

data/lib/monet/config.rb

@@ -21,29 +21,29 @@ module Monet
 
     attr_accessor *DEFAULT_OPTIONS.keys
 
+    # configure via options
     def initialize(opts={})
       DEFAULT_OPTIONS.each do |opt, default|
         send "#{opt}=", opts[opt] || default
       end
     end
 
+    # configure via block
     def self.config(&block)
       cfg = new
-      block.call cfg
+      yield cfg if block_given?
+
       cfg
     end
 
+    # configure via YAML
     def self.load(path="./config.yaml")
-      config = YAML::load(File.open(path))
-      new(config)
-    end
-
-    def self.build_config(opts)
-      (opts.is_a? Monet::Config) ? opts : new(opts)
+      opts = YAML::load(File.open(path))
+      new(opts)
     end
 
     def base_url=(url)
-      @base_url ||= parse_uri(url) unless url.nil?
+      @base_url = parse_uri(url) unless url.nil?
     end
 
     def base_url
@@ -51,6 +51,12 @@ module Monet
       @base_url
     end
 
+    def site
+      parse_uri(base_url).host
+    end
+    alias_method :host, :site
+    alias_method :root_dir, :site
+
     def thumbnail?
       !!thumbnail
     end
@@ -68,13 +74,14 @@ module Monet
     end
 
     def map=(paths)
-      map.paths = paths unless paths.nil?
+      @map = nil
+      return @map if paths.nil?
+      paths == :spider ? map(paths) : (map.paths = paths)
     end
 
     def map(type=:explicit, &block)
       @map ||= CaptureMap.new(base_url, type)
-
-      block.call(@map) if block_given? && type == :explicit
+      yield @map if block_given?
 
       @map
     end

data/lib/monet/image.rb

@@ -0,0 +1,67 @@
+require 'chunky_png'
+require 'monet/config'
+require 'monet/url_helpers'
+
+module Monet
+  class Image
+    include URLHelpers
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = File.expand_path path
+    end
+
+    def is_diff?
+      name.include? "-diff"
+    end
+
+    def diff_path
+      @path.gsub(".png", "-diff.png")
+    end
+
+    def flagged?
+      File.exists? diff_path
+    end
+
+    def width
+      @width ||= File.basename(@path, ".png").split("-").last.to_i
+    end
+
+    def name
+      @name ||= File.basename @path
+    end
+
+    def basename
+      @path.split(File::SEPARATOR)[-2..-1].join(File::SEPARATOR)
+    end
+
+    def to_image
+      ChunkyPNG::Image.from_file(@path)
+    end
+
+    def root_dir
+      File.dirname @path
+    end
+
+    def thumbnail!(save_to=nil)
+      img = to_image
+      short_edge = [img.width, img.height].min
+
+      cropped = img.crop(0, 0, short_edge, short_edge)
+      resized = cropped.resize(200, 200)
+
+      if save_to.nil?
+        save_to = @path.gsub(".png", "-thumb.png")
+      else
+        save_to = File.join save_to, File.basename(@path)
+      end
+
+      save_dir = File.dirname(save_to)
+      FileUtils.mkdir_p save_dir unless Dir.exists?(save_dir)
+
+      resized.save save_to
+      save_to
+    end
+  end
+end

data/lib/monet/router.rb

@@ -0,0 +1,71 @@
+module Monet
+  class Router
+    include URLHelpers
+    TYPES = [
+      :baseline,
+      :capture,
+      :thumbnail
+    ]
+
+    def initialize(config)
+      @config = config
+    end
+
+    TYPES.each do |type|
+      define_method "#{type}_dir" do |filename=""|
+        File.join(@config.send("#{type}_dir"), @config.site, filename).chomp("/")
+      end
+
+      define_method "#{type}_url" do |filename|
+        type_dir = @config.send "#{type}_dir"
+        image_url(type_dir, filename)
+      end
+    end
+
+    def original_url(path)
+      url = path.split("/").last
+      path = url.split('|')[1..-1].join("/").gsub(/-\d+\.png/, "")
+
+      "#{@config.base_url}/#{path}"
+    end
+
+    def diff_dir(filename="")
+      filename = filename.gsub(".png", "-diff.png") unless filename.empty?
+      File.join(@config.baseline_dir, @config.site, filename).chomp("/")
+    end
+
+    def diff_url(path)
+      diff = basename diff_dir(path)
+      image_url(@config.baseline_dir, diff)
+    end
+
+    def capture_routes
+      urls = {}
+      @config.map.paths.each do |path|
+        url = "#{@config.base_url}#{path}".chomp("/")
+        @config.dimensions.each do |width|
+          urls[url] ||= []
+          urls[url] << url_to_filepath(url, width)
+        end
+      end
+
+      urls
+    end
+
+    def url_to_filepath(url, width="*")
+      uri = parse_uri(url)
+      name = File.join @config.site, "#{@config.site}#{uri.path.gsub(/\//, '|')}"
+      File.join @config.capture_dir, "#{name}-#{width}.png"
+    end
+
+    private
+    def basename(path)
+      File.basename path
+    end
+
+    def image_url(type_dir, name)
+      relative_path = Pathname.new(type_dir).relative_path_from(Pathname.new(File.join(type_dir, "..")))
+      "/#{relative_path}/#{@config.root_dir}/#{name}"
+    end
+  end
+end

data/lib/monet/tasks.rb

@@ -12,27 +12,30 @@ end
 namespace :monet do
   desc "clean out the baseline directory"
   task :clean, :path do |t, args|
-    Monet.clean load_config(args)
+    config = load_config(args)
+    Dir.glob(File.join(config.baseline_dir, "**", "*.png")).each do |img|
+      File.delete img
+    end
   end
 
   desc "Runs the site and grabs baselines"
   task :baseline => [:clean, :run] do
   end
 
-
   namespace :thumbnail do
     desc "Thumbnail all baseline images"
-    task :baseline do
+    task :baseline, :path do |t, args|
       config = load_config(args)
       capture = Monet::Capture.new config
 
       images_from_dir(config.baseline_dir).each do |image|
-        capture.thumbnail image
+        Monet::Image.new(image).thumbnail! config.thumbnail_dir
       end
     end
 
     desc "Thumnail all captured images"
-    task :captures do
+    task :captures, :path do |t, args|
+      config = load_config(args)
       capture = Monet::Capture.new config
 
       images_from_dir(config.capture_dir).each do |image|
@@ -44,7 +47,7 @@ namespace :monet do
   desc "Run the baseline comparison"
   task :run, :path do |t, args|
     config = load_config(args)
-    Monet.capture config
-    Monet.compare config
+    Monet::Capture.new(config).capture_all
+    Monet::BaselineControl.new(config).run
   end
 end

data/lib/monet/version.rb

@@ -1,3 +1,3 @@
 module Monet
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 end

data/lib/monet.rb

@@ -1,34 +1,9 @@
 require "monet/version"
 require 'monet/config'
-require "monet/capture"
-require "monet/compare"
-require "monet/baseline_control"
+require 'monet/capture'
+require 'monet/baseline_control'
+require 'monet/router'
+require 'monet/image'
 
 module Monet
-  class << self
-    def clean(opts)
-      config = load_config(opts)
-      Dir.glob(File.join(config.baseline_dir, "**", "*.png")).each do |img|
-        File.delete img
-      end
-    end
-
-    def capture(opts)
-      agent = Monet::Capture.new(load_config(opts))
-      agent.capture_all
-    end
-
-    def compare(opts)
-      control = Monet::BaselineControl.new(opts)
-      control.run
-    end
-
-    def config(&block)
-      Monet::Config.config block
-    end
-
-    def load_config(options)
-      Monet::Config.build_config(options)
-    end
-  end
 end

data/spec/capture_map_spec.rb

@@ -59,57 +59,12 @@ describe Monet::CaptureMap do
     end
   end
 
-  context "spider mapper", vcr: { cassette_name: "spider", record: :new_episodes } do
-    Given(:map) { Monet::CaptureMap.new("http://www.spider.io", :spider) }
+  context "spider mapper", vcr: { cassette_name: "spider-map", record: :new_episodes } do
+    Given(:map) { Monet::CaptureMap.new("http://staging.lance.com", :spider) }
     When(:paths) { map.paths }
-    Then { paths.should == [
-      "http://www.spider.io",
-      "http://www.spider.io/anti-malware/",
-      "http://www.spider.io/viewability/",
-      "http://www.spider.io/press/",
-      "http://www.spider.io/team/",
-      "http://www.spider.io/blog/",
-      "http://www.spider.io/",
-      "http://www.spider.io/blog/2013/03/chameleon-botnet/",
-      "http://www.spider.io/blog/2013/12/cyber-criminals-defraud-display-advertisers-with-tdss/",
-      "http://www.spider.io/zeus",
-      "http://www.spider.io/blog/2013/11/how-to-defraud-display-advertisers-with-zeus/",
-      "http://www.spider.io/blog/2013/05/a-botnet-primer-for-display-advertisers/",
-      "http://www.spider.io/blog/2013/09/display-advertisers-funding-cybercriminals-since-2011/",
-      "http://www.spider.io/blog/2013/09/securing-the-legitimacy-of-display-ad-inventory/",
-      "http://www.spider.io/blog/2013/04/display-advertising-fraud-is-a-sell-side-problem/",
-      "http://www.spider.io/blog/2012/12/internet-explorer-data-leakage/",
-      "http://www.spider.io/blog/2013/08/sambreel-is-still-injecting-ads-video-advertisers-beware/",
-      "http://www.spider.io/blog/page/2/",
-      "http://www.spider.io/blog/2011/10/the-problem-with-client-side-analytics/",
-      "http://www.spider.io/blog/2012/12/responsible-disclosure/",
-      "http://www.spider.io/blog/2013/05/spider-io-granted-mrc-accreditation-for-viewable-impression-measurement/",
-      "http://www.spider.io/blog/2013/04/at-least-two-percent-of-monitored-display-ad-exchange-inventory-is-hidden/",
-      "http://www.spider.io/blog/2013/03/who-is-behind-the-chameleon-botnet/",
-      "http://www.spider.io/blog/page/3/",
-      "http://www.spider.io/blog/2013/02/which-display-ad-exchange-sells-the-highest-quality-inventory/",
-      "http://www.spider.io/blog/2012/12/there-are-two-ways-to-measure-ad-viewability-there-is-only-one-right-way/",
-      "http://www.spider.io/blog/page/4/",
-      "http://www.spider.io/blog/2012/12/review-of-iab-safeframe-1-0/",
-      "http://www.spider.io/blog/2012/10/qa-about-ad-viewability/",
-      "http://www.spider.io/blog/2012/10/the-first-technology-to-measure-the-viewability-of-iframed-ads-across-all-major-browsers-press-release/",
-      "http://www.spider.io/vSta98h",
-      "http://www.spider.io/blog/2012/07/join-us-for-a-tipple-at-spider-towers/",
-      "http://www.spider.io/blog/2012/07/startups-acquiring-startups-for-equity/",
-      "http://www.spider.io/blog/page/5/",
-      "http://www.spider.io/visibility-demo-screencast/",
-      "http://www.spider.io/blog/2012/07/whats-in-an-ip-address/",
-      "http://www.spider.io/blog/2011/12/physical-hack-day/",
-      "http://www.spider.io/blog/2011/11/our-first-hack-day/",
-      "http://www.spider.io/careers/",
-      "http://www.spider.io/blog/2011/10/extreme-architecting/",
-      "http://www.spider.io/blog/2011/09/how-to-catch-a-bot/",
-      "http://www.spider.io/blog/page/6/",
-      "http://www.spider.io/blog/2011/10/testing-javascript-with-mturk/",
-      "http://www.spider.io/blog/2011/10/demonstration-screencast-verifying-that-display-ads-are-visible-from-within-iframes/",
-      "http://www.spider.io/blog/2011/10/calling-out-to-researchersacademics/",
-      "http://www.spider.io/blog/page/7/"
-    ]}
+    Then { paths.size.should == 64 }
+    And { paths.first.end_with?("/").should be false }
+    And { paths.first.start_with?("http://").should be_false }
     And { paths.any? {|p| p.end_with? "css" }.should be_false }
   end
 end