dassets 0.0.1 → 0.1.0

data/test/support/app/assets/.digests

@@ -0,0 +1,4 @@
+file1.txt,daa05c683a4913b268653f7a7e36a5b4
+file2.txt,9bbe1047cffbb590f59e0e5aeff46ae4
+grumpy_cat.jpg,b0d1f399a916f7a25c4c0f693c619013
+nested/file3.txt,d41d8cd98f00b204e9800998ecf8427e

data/test/support/app/assets/public/file1.txt

@@ -0,0 +1 @@
+file1.txt

data/test/support/app/assets/public/file2.txt

@@ -0,0 +1 @@
+file2.txt

data/test/support/app.rb

@@ -0,0 +1,10 @@
+require 'sinatra/base'
+
+class SinatraApp < Sinatra::Base
+
+  configure do
+    set :root, File.expand_path('..', __FILE__)
+    set :public_dir, File.expand_path('./app_public', __FILE__)
+  end
+
+end

data/test/support/config/assets.rb

@@ -0,0 +1,7 @@
+require 'dassets'
+
+Dassets.configure do |c|
+  c.root_path File.expand_path("../..", __FILE__)
+
+end
+

data/test/support/example.digests

@@ -0,0 +1,3 @@
+/path/to/file1,abc123
+/path/to/file2,123abc
+/path/to/file3,a1b2c3

data/test/support/public/file1-daa05c683a4913b268653f7a7e36a5b4.txt

@@ -0,0 +1 @@
+file1.txt

data/test/support/public/file2-9bbe1047cffbb590f59e0e5aeff46ae4.txt

@@ -0,0 +1 @@
+file2.txt

data/test/system/rack_tests.rb

@@ -0,0 +1,78 @@
+require 'assert'
+require 'assert-rack-test'
+require 'test/support/app'
+require 'dassets/server'
+
+module Dassets
+
+  class RackTests < Assert::Context
+    include Assert::Rack::Test
+
+    desc "the middleware in a rack app"
+    setup do
+      Dassets.init
+      app.use Dassets::Server
+    end
+    teardown do
+      Dassets.reset
+    end
+
+    def app
+      @app ||= SinatraApp
+    end
+
+  end
+
+  class SuccessTests < RackTests
+    desc "requesting an existing asset file"
+
+    should "return a successful response" do
+      resp = get '/file1-daa05c683a4913b268653f7a7e36a5b4.txt'
+      assert_equal 200, resp.status
+      assert_equal Dassets['/file1.txt'].content, resp.body
+    end
+
+    should "return a successful response with no body on HEAD requests" do
+      resp = head '/file2-9bbe1047cffbb590f59e0e5aeff46ae4.txt'
+      assert_equal 200, resp.status
+      assert_equal Dassets['/file2.txt'].size.to_s, resp.headers['Content-Length']
+      assert_empty resp.body
+    end
+
+  end
+
+  class NotModifiedTests < RackTests
+    desc "requesting an existing asset file that has not been modified"
+    setup do
+      @resp = get('/file1-daa05c683a4913b268653f7a7e36a5b4.txt', {}, {
+        'HTTP_IF_MODIFIED_SINCE' => Dassets['/file1.txt'].mtime.to_s
+      })
+    end
+
+    should "return a successful response" do
+      assert_equal 304, @resp.status
+      assert_empty @resp.body
+    end
+
+  end
+
+  class NotFoundTests < RackTests
+    desc "requesting an non-existing asset file"
+
+    should "return a not found response" do
+      resp = get '/file1-daa05c683a4913b268.txt'
+      assert_equal 404, resp.status
+
+      get '/file1-.txt'
+      assert_equal 404, resp.status
+
+      get '/file1.txt'
+      assert_equal 404, resp.status
+
+      get '/something-not-found'
+      assert_equal 404, resp.status
+    end
+
+  end
+
+end

data/test/unit/asset_file_tests.rb

@@ -0,0 +1,76 @@
+require 'assert'
+require 'dassets/asset_file'
+
+class Dassets::AssetFile
+
+  class BaseTests < Assert::Context
+    desc "Dassets::AssetFile"
+    setup do
+      @asset_file = Dassets::AssetFile.new('file1.txt', 'abc123')
+    end
+    subject{ @asset_file }
+
+    should have_cmeths :from_abs_path
+    should have_readers :path, :md5, :dirname, :extname, :basename
+    should have_readers :files_path, :cache_path, :href
+    should have_imeth :content, :mtime, :size, :mime_type, :exists?, :==
+
+    should "know its given path and md5" do
+      assert_equal 'file1.txt', subject.path
+      assert_equal 'abc123', subject.md5
+    end
+
+    should "know its dirname, extname, and basename" do
+      assert_equal '.',     subject.dirname
+      assert_equal '.txt',  subject.extname
+      assert_equal 'file1', subject.basename
+    end
+
+    should "build it's files_path from the path" do
+      assert_equal "#{Dassets.config.files_path}/file1.txt", subject.files_path
+
+      nested = Dassets::AssetFile.new('nested/file1.txt', 'abc123')
+      assert_equal "#{Dassets.config.files_path}/nested/file1.txt", nested.files_path
+    end
+
+    should "build it's cache_path from the path and the md5" do
+      assert_equal "file1-abc123.txt", subject.cache_path
+
+      nested = Dassets::AssetFile.new('nested/file1.txt', 'abc123')
+      assert_equal "nested/file1-abc123.txt", nested.cache_path
+    end
+
+    should "build it's href from the cache path" do
+      assert_equal "/file1-abc123.txt", subject.href
+
+      nested = Dassets::AssetFile.new('nested/file1.txt', 'abc123')
+      assert_equal "/nested/file1-abc123.txt", nested.href
+    end
+
+    should "be created from absolute file paths and have md5 computed" do
+      abs_file_path = File.join(Dassets.config.files_path, 'file1.txt')
+      exp_md5 = 'daa05c683a4913b268653f7a7e36a5b4'
+      file = Dassets::AssetFile.from_abs_path(abs_file_path)
+
+      assert_equal 'file1.txt', file.path
+      assert_equal exp_md5, file.md5
+    end
+
+    should "know it's content, mtime, size, mime_type, and if it exists" do
+      assert_equal "file1.txt\n", subject.content
+      assert_equal File.mtime(subject.files_path).httpdate, subject.mtime
+      assert_equal File.size?(subject.files_path), subject.size
+      assert_equal "text/plain", subject.mime_type
+      assert subject.exists?
+
+      null_file = Dassets::AssetFile.new('', '')
+      assert_nil null_file.content
+      assert_nil null_file.mtime
+      assert_nil null_file.size
+      assert_nil null_file.mime_type
+      assert_not null_file.exists?
+    end
+
+  end
+
+end

data/test/unit/config_tests.rb

@@ -0,0 +1,27 @@
+require 'assert'
+require 'ns-options/assert_macros'
+require 'dassets'
+
+class Dassets::Config
+
+  class BaseTests < Assert::Context
+    include NsOptions::AssertMacros
+    desc "Dassets::Config"
+    subject{ Dassets::Config }
+
+    should have_option  :root_path, Pathname, :required => true
+    should have_options :files_path, :digests_file_path
+
+    should "should use `apps/assets/public` as the default files path" do
+      exp_path = Dassets.config.root_path.join("app/assets/public").to_s
+      assert_equal exp_path, subject.files_path
+    end
+
+    should "should use `app/assets/.digests` as the default digests file path" do
+      exp_path = Dassets.config.root_path.join("app/assets/.digests").to_s
+      assert_equal exp_path, subject.digests_file_path
+    end
+
+  end
+
+end

data/test/unit/dassets_tests.rb

@@ -0,0 +1,49 @@
+require 'assert'
+require 'fileutils'
+require 'dassets'
+
+module Dassets
+
+  class BaseTests < Assert::Context
+    desc "Dassets"
+    subject{ Dassets }
+
+    should have_imeths :config, :configure, :init, :digests, :[]
+
+    should "return its `Config` class with the `config` method" do
+      assert_same Config, subject.config
+    end
+
+    should "read/parse the digests on init" do
+      subject.reset
+      assert_empty subject.digests
+
+      subject.init
+      assert_not_empty subject.digests
+    end
+
+    should "return asset files given a their path using the index operator" do
+      subject.init
+      file = subject['nested/file3.txt']
+
+      assert_kind_of Dassets::AssetFile, file
+      assert_equal 'nested/file3.txt', file.path
+      assert_equal 'd41d8cd98f00b204e9800998ecf8427e', file.md5
+
+      subject.reset
+    end
+
+    should "return an asset file with no fingerprint if path not in digests" do
+      file = subject['path/not/found.txt']
+      assert_equal '', file.md5
+
+      subject.init
+      file = subject['path/not/found.txt']
+      assert_equal '', file.md5
+
+      subject.reset
+    end
+
+  end
+
+end

data/test/unit/digests_file_tests.rb

@@ -0,0 +1,90 @@
+require 'assert'
+require 'fileutils'
+require 'dassets/digests_file'
+require 'dassets/asset_file'
+
+class Dassets::DigestsFile
+
+  class BaseTests < Assert::Context
+    desc "Dassets::DigestsFile"
+    setup do
+      @file_path = File.join(Dassets.config.root_path, 'example.digests')
+      @digests = Dassets::DigestsFile.new(@file_path)
+    end
+    subject{ @digests }
+
+    should have_reader :path
+    should have_imeths :asset_files, :asset_file, :to_hash, :save!
+    should have_imeths :[], :[]=, :delete, :each, :keys, :values, :empty?
+
+    should "know its path" do
+      assert_equal @file_path, subject.path
+    end
+
+    should "know its asset files" do
+      assert_equal subject.keys.size, subject.asset_files.size
+      assert_kind_of Dassets::AssetFile, subject.asset_files.first
+    end
+
+    should "get a specific asset file from its data" do
+      file = subject.asset_file('/path/to/file1')
+
+      assert_kind_of Dassets::AssetFile, file
+      assert_equal '/path/to/file1', file.path
+      assert_equal subject['/path/to/file1'], file.md5
+    end
+
+    should "know whether it is empty or not" do
+      assert_not_empty subject
+    end
+
+    should "read values with the index operator" do
+      assert_equal 'abc123', subject['/path/to/file1']
+    end
+
+    should "write values with the index operator" do
+      subject['/path/to/test'] = 'testytest'
+      assert_equal 'testytest', subject['/path/to/test']
+    end
+
+    should "remove values with the delete method" do
+      assert_includes '/path/to/file1', subject.keys
+
+      subject.delete '/path/to/file1'
+      assert_not_includes '/path/to/file1', subject.keys
+    end
+
+    should "know its hash representation" do
+      exp_hash = {
+        "/path/to/file1" => "abc123",
+        "/path/to/file2" => "123abc",
+        "/path/to/file3" => "a1b2c3"
+      }
+      subject_to_hash = subject.to_hash
+      subject_internal_hash = subject.instance_variable_get("@hash")
+
+      assert_equal exp_hash, subject_to_hash
+      assert_not_equal subject_internal_hash.object_id, subject_to_hash.object_id
+    end
+
+  end
+
+  class SaveTests < BaseTests
+    desc "on save"
+    setup do
+      FileUtils.mv(@file_path, "#{@file_path}.bak")
+    end
+    teardown do
+      FileUtils.mv("#{@file_path}.bak", @file_path)
+    end
+
+    should "write out the digests to the path" do
+      assert_not_file_exists subject.path
+      subject.save!
+
+      assert_file_exists subject.path
+    end
+
+  end
+
+end

data/test/unit/runner/cache_command_tests.rb

@@ -0,0 +1,62 @@
+require 'assert'
+require 'fileutils'
+require 'dassets/runner/cache_command'
+
+class Dassets::Runner::CacheCommand
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Runner::CacheCommand"
+    setup do
+      @cache_root_path = File.join(Dassets.config.root_path, 'public')
+      FileUtils.mkdir_p @cache_root_path
+      @cmd = Dassets::Runner::CacheCommand.new(@cache_root_path)
+    end
+    teardown do
+      # FileUtils.rm_rf @cache_root_path
+    end
+    subject{ @cmd }
+
+    should have_readers :files_root_path, :cache_root_path, :digests_file, :asset_files
+
+    should "use the config's files path and its files root path" do
+      assert_equal Dassets.config.files_path, subject.files_root_path.to_s
+    end
+
+    should "know its given cache root path" do
+      assert_equal @cache_root_path, subject.cache_root_path.to_s
+    end
+
+    should "know it's digests file" do
+      assert_kind_of Dassets::DigestsFile, subject.digests_file
+    end
+
+    should "get it's asset files from the digests file" do
+      assert_equal 4, subject.digests_file.keys.size
+      assert_equal 4, subject.asset_files.size
+    end
+
+    should "use AssetFile objs for the asset files" do
+      assert_kind_of Dassets::AssetFile, subject.asset_files.first
+    end
+
+  end
+
+  class RunTests < BaseTests
+    desc "on run"
+    setup do
+      FileUtils.rm_rf(@cache_root_path)
+    end
+
+    should "create the cache root and write the cache files" do
+      assert_not_file_exists @cache_root_path.to_s
+      subject.run
+
+      assert_file_exists @cache_root_path.to_s
+      subject.asset_files.each do |file|
+        assert_file_exists File.join(@cache_root_path, file.cache_path)
+      end
+    end
+
+  end
+
+end

data/test/unit/runner/digest_command_tests.rb

@@ -0,0 +1,83 @@
+require 'assert'
+require 'fileutils'
+require 'dassets/runner/digest_command'
+
+class Dassets::Runner::DigestCommand
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Runner::DigestCommand"
+    setup do
+      @cmd = Dassets::Runner::DigestCommand.new([])
+    end
+    subject{ @cmd }
+
+    should have_instance_methods :asset_files, :digests_file, :run
+
+    should "know it's digests file" do
+      assert_kind_of Dassets::DigestsFile, subject.digests_file
+    end
+
+    should "get it's asset files from the config path by default" do
+      assert_equal 4, subject.asset_files.size
+      assert_equal 4, subject.digests_file.keys.size
+    end
+
+    should "get it's asset files from the args if passed" do
+      path_string = File.join(Dassets.config.files_path, 'file*')
+      digest_cmd  = Dassets::Runner::DigestCommand.new([path_string])
+
+      assert_equal 2, digest_cmd.asset_files.size
+    end
+
+    should "use AssetFile objs for the asset files" do
+      assert_kind_of Dassets::AssetFile, subject.asset_files.first
+    end
+
+  end
+
+  class RunTests < BaseTests
+    desc "on run"
+    setup do
+      @cmd.run
+      @addfile = 'addfile.txt'
+      @rmfile  = 'file1.txt'
+      @updfile = 'file2.txt'
+      @addfile_path = File.join(File.join(Dassets.config.files_path, @addfile))
+      @rmfile_path  = File.join(File.join(Dassets.config.files_path, @rmfile))
+      @updfile_path = File.join(File.join(Dassets.config.files_path, @updfile))
+
+      @rmfilecontents   = File.read(@rmfile_path)
+      @updfilecontents  = File.read(@updfile_path)
+      @orig_updfile_md5 = subject.digests_file[@updfile]
+
+      FileUtils.touch @addfile_path
+      FileUtils.rm @rmfile_path
+      File.open(@updfile_path, "w+"){ |f| f.write('an update') }
+    end
+    teardown do
+      File.open(@updfile_path, "w"){ |f| f.write @updfilecontents }
+      File.open(@rmfile_path,  "w"){ |f| f.write @rmfilecontents }
+      FileUtils.rm @addfile_path
+    end
+
+    should "update the digests_file on run" do
+      assert_equal 4, subject.digests_file.keys.size
+      assert_not_includes @addfile, subject.digests_file.keys
+      assert_includes @rmfile, subject.digests_file.keys
+      assert_equal @orig_updfile_md5, subject.digests_file[@updfile]
+
+      # recreate the cmd to reload asset files
+      @cmd = Dassets::Runner::DigestCommand.new([])
+      # run without writing the file
+      subject.run(false)
+
+      # see the add, update and removal
+      assert_equal 4, subject.digests_file.keys.size
+      assert_includes @addfile, subject.digests_file.keys
+      assert_not_includes @rmfile, subject.digests_file.keys
+      assert_not_equal @orig_updfile_md5, subject.digests_file[@updfile]
+    end
+
+  end
+
+end

data/test/unit/runner_tests.rb

@@ -0,0 +1,29 @@
+require 'assert'
+require 'pathname'
+require 'dassets/runner'
+
+class Dassets::Runner
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Runner"
+    setup do
+      @runner = Dassets::Runner.new(['null', 1, 2], 'some' => 'opts')
+    end
+    subject{ @runner }
+
+    should have_readers :cmd_name, :cmd_args, :opts
+
+    should "know its cmd, cmd_args, and opts" do
+      assert_equal 'null', subject.cmd_name
+      assert_equal [1,2],  subject.cmd_args
+      assert_equal 'opts', subject.opts['some']
+    end
+
+    should "complain about unknown cmds" do
+      runner = Dassets::Runner.new(['unknown'], {})
+      assert_raises(UnknownCmdError) { runner.run }
+    end
+
+  end
+
+end

data/test/unit/server/request_tests.rb

@@ -0,0 +1,76 @@
+require 'assert'
+require 'dassets/server/request'
+
+class Dassets::Server::Request
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Server::Request"
+    setup do
+      Dassets.init
+      @req = file_request('GET', '/file1-daa05c683a4913b268653f7a7e36a5b4.txt')
+    end
+    teardown do
+      Dassets.reset
+    end
+    subject{ @req }
+
+    should have_imeths :for_asset_file?, :asset_path, :asset_file
+
+    should "know its asset_path" do
+      assert_equal 'file1.txt', subject.asset_path
+    end
+
+    should "know its asset_file" do
+      assert_equal Dassets['file1.txt'], subject.asset_file
+    end
+
+    should "know if it is for an asset file" do
+      # find nested path with matching md5
+      req = file_request('GET', '/nested/file3-d41d8cd98f00b204e9800998ecf8427e.txt')
+      assert req.for_asset_file?
+
+      # find not nested path with matching md5
+      req = file_request('HEAD', '/file1-daa05c683a4913b268653f7a7e36a5b4.txt')
+      assert req.for_asset_file?
+
+      # find even if md5 is *not* matching - just need to have any md5
+      req = file_request('GET', '/file1-d41d8cd98f00b204e9800998ecf8427e.txt')
+      assert req.for_asset_file?
+
+      # no find on invalid md5
+      req = file_request('GET', '/file1-daa05c683a4913b268653f7a7e36a.txt')
+      assert_not req.for_asset_file?
+
+      # no find on missing md5
+      req = file_request('HEAD', '/file1.txt')
+      assert_not req.for_asset_file?
+
+      # no find on unknown file
+      req = file_request('GET', '/some-file.txt')
+      assert_not req.for_asset_file?
+
+      # no find on unknown file with an md5
+      req = file_request('GET', '/some-file-daa05c683a4913b268653f7a7e36a5b4.txt')
+      assert_not req.for_asset_file?
+    end
+
+    should "return an asset path and an empty asset file if request not for asset file" do
+      req = file_request('GET', '/some-file.txt')
+
+      assert_equal '', req.asset_path
+      assert_equal Dassets::AssetFile.new('', ''), req.asset_file
+    end
+
+    protected
+
+    def file_request(method, path_info)
+      require 'dassets/server/request'
+      Dassets::Server::Request.new({
+        'REQUEST_METHOD' => method,
+        'PATH_INFO'      => path_info
+      })
+    end
+
+  end
+
+end