dassets 0.2.0 → 0.3.0

data/lib/dassets/version.rb

@@ -1,3 +1,3 @@
 module Dassets
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

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

@@ -1,4 +1,5 @@
 file1.txt,daa05c683a4913b268653f7a7e36a5b4
 file2.txt,9bbe1047cffbb590f59e0e5aeff46ae4
 grumpy_cat.jpg,b0d1f399a916f7a25c4c0f693c619013
+nested/a-thing.txt.no-use,7413d18f2eba9c695a880aff67fde135
 nested/file3.txt,d41d8cd98f00b204e9800998ecf8427e

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

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

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

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

data/test/support/app/assets/nested/a-thing.txt.useless.dumb

@@ -0,0 +1 @@
+thing

data/test/support/app/assets/public/nested/a-thing.txt.no-use

@@ -0,0 +1,4 @@
+thing
+
+DUMB
+USELESS

data/test/support/config/assets.rb

@@ -1,7 +1,18 @@
 require 'dassets'
 
+@dumb_engine = Class.new(Dassets::Engine) do
+  def ext(in_ext); ''; end
+  def compile(input); "#{input}\nDUMB"; end
+end
+@useless_engine = Class.new(Dassets::Engine) do
+  def ext(in_ext); 'no-use'; end
+  def compile(input); "#{input}\nUSELESS"; end
+end
+
 Dassets.configure do |c|
   c.root_path File.expand_path("../..", __FILE__)
 
-end
+  c.engine 'dumb', @dumb_engine
+  c.engine 'useless', @useless_engine
 
+end

data/test/support/example.digests

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

data/test/support/public/nested/a-thing.txt-7413d18f2eba9c695a880aff67fde135.no-use

@@ -0,0 +1,4 @@
+thing
+
+DUMB
+USELESS

data/test/system/cache_cmd_run_tests.rb

@@ -0,0 +1,27 @@
+require 'assert'
+require 'fileutils'
+require 'dassets'
+
+module Dassets
+
+  class CacheCmdRunTests < Assert::Context
+    desc "the CacheCmd"
+    setup do
+      @cache_root_path = File.join(Dassets.config.root_path, 'public')
+      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
+      cmd = Dassets::Cmds::CacheCmd.new(@cache_root_path)
+      cmd.run
+
+      assert_file_exists @cache_root_path.to_s
+      cmd.digests.asset_files.each do |file|
+        assert_file_exists File.join(@cache_root_path, file.url)
+      end
+    end
+
+  end
+
+end

data/test/system/digest_cmd_run_tests.rb

@@ -0,0 +1,70 @@
+require 'assert'
+require 'fileutils'
+require 'dassets'
+
+module Dassets
+
+  class DigestCmdRunTests < Assert::Context
+    desc "the DigestCmd"
+    setup do
+      Dassets.reset
+      Dassets.init
+      Dassets.digest_source_files
+
+      @addfile = 'addfile.txt'
+      @rmfile  = 'file1.txt'
+      @updfile = 'file2.txt'
+      @addfile_path = File.join(File.join(Dassets.config.source_path, @addfile))
+      @rmfile_path  = File.join(File.join(Dassets.config.source_path, @rmfile))
+      @updfile_path = File.join(File.join(Dassets.config.source_path, @updfile))
+
+      @rmfilecontents   = File.read(@rmfile_path)
+      @updfilecontents  = File.read(@updfile_path)
+      @orig_updfile_md5 = Dassets.digests[@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
+
+      Dassets.reset
+      Dassets.init
+      Dassets.digest_source_files
+    end
+
+    should "update the digests on all source files when run with no given paths" do
+      # check before state
+      assert_equal 5, Dassets.digests.paths.size
+      assert_not_includes @addfile, Dassets.digests.paths
+      assert_includes @rmfile, Dassets.digests.paths
+      assert_equal @orig_updfile_md5, Dassets.digests[@updfile]
+
+      Dassets.digest_source_files
+
+      # see the add, update and removal
+      assert_equal 5, Dassets.digests.paths.size
+      assert_includes @addfile, Dassets.digests.paths
+      assert_not_includes @rmfile, Dassets.digests.paths
+      assert_not_equal @orig_updfile_md5, Dassets.digests[@updfile]
+    end
+
+    should "update the digests on a single source file when given its path" do
+      assert_equal 5, Dassets.digests.paths.size
+      assert_not_includes @addfile, Dassets.digests.paths
+
+      Dassets.digest_source_files([@addfile_path])
+
+      # see the add, don't change anything else
+      assert_equal 6, Dassets.digests.paths.size
+      assert_includes @addfile, Dassets.digests.paths
+      assert_includes @rmfile, Dassets.digests.paths
+      assert_equal    @orig_updfile_md5, Dassets.digests[@updfile]
+    end
+
+  end
+
+end

data/test/unit/asset_file_tests.rb

@@ -12,7 +12,7 @@ class Dassets::AssetFile
 
     should have_cmeths :from_abs_path
     should have_readers :path, :md5, :dirname, :extname, :basename
-    should have_readers :files_path, :cache_path, :href
+    should have_readers :output_path, :url, :href
     should have_imeth :content, :mtime, :size, :mime_type, :exists?, :==
 
     should "know its given path and md5" do
@@ -26,21 +26,21 @@ class Dassets::AssetFile
       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
+    should "build it's output_path from the path" do
+      assert_equal "#{Dassets.config.output_path}/file1.txt", subject.output_path
 
       nested = Dassets::AssetFile.new('nested/file1.txt', 'abc123')
-      assert_equal "#{Dassets.config.files_path}/nested/file1.txt", nested.files_path
+      assert_equal "#{Dassets.config.output_path}/nested/file1.txt", nested.output_path
     end
 
-    should "build it's cache_path from the path and the md5" do
-      assert_equal "file1-abc123.txt", subject.cache_path
+    should "build it's url from the path and the md5" do
+      assert_equal "file1-abc123.txt", subject.url
 
       nested = Dassets::AssetFile.new('nested/file1.txt', 'abc123')
-      assert_equal "nested/file1-abc123.txt", nested.cache_path
+      assert_equal "nested/file1-abc123.txt", nested.url
     end
 
-    should "build it's href from the cache path" do
+    should "build it's href from the url" do
       assert_equal "/file1-abc123.txt", subject.href
 
       nested = Dassets::AssetFile.new('nested/file1.txt', 'abc123')
@@ -48,7 +48,7 @@ class Dassets::AssetFile
     end
 
     should "be created from absolute file paths and have md5 computed" do
-      abs_file_path = File.join(Dassets.config.files_path, 'file1.txt')
+      abs_file_path = File.join(Dassets.config.output_path, 'file1.txt')
       exp_md5 = 'daa05c683a4913b268653f7a7e36a5b4'
       file = Dassets::AssetFile.from_abs_path(abs_file_path)
 
@@ -58,8 +58,8 @@ class Dassets::AssetFile
 
     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 File.mtime(subject.output_path).httpdate, subject.mtime
+      assert_equal File.size?(subject.output_path), subject.size
       assert_equal "text/plain", subject.mime_type
       assert subject.exists?
 

data/test/unit/cmds/cache_cmd_tests.rb

@@ -0,0 +1,33 @@
+require 'assert'
+require 'fileutils'
+require 'dassets/cmds/cache_cmd'
+
+class Dassets::Cmds::CacheCmd
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Cmds::CacheCmd"
+    setup do
+      @cache_root_path = File.join(Dassets.config.root_path, 'public')
+      FileUtils.mkdir_p @cache_root_path
+      @cmd = Dassets::Cmds::CacheCmd.new(@cache_root_path)
+    end
+    subject{ @cmd }
+
+    should have_readers :cache_root_path, :digests
+
+    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::Digests, subject.digests
+    end
+
+    should "get it's asset files from the digests file" do
+      assert_equal 5, subject.digests.paths.size
+      assert_equal 5, subject.digests.asset_files.size
+    end
+
+  end
+
+end

data/test/unit/cmds/digest_cmd_tests.rb

@@ -0,0 +1,23 @@
+require 'assert'
+require 'dassets'
+require 'dassets/cmds/digest_cmd'
+
+class Dassets::Cmds::DigestCmd
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Cmds::DigestCmd"
+    setup do
+      @cmd = Dassets::Cmds::DigestCmd.new(['a/path'])
+    end
+    subject{ @cmd }
+
+    should have_readers :paths
+    should have_instance_method :run
+
+    should "know it's paths" do
+      assert_equal ['a/path'], subject.paths
+    end
+
+  end
+
+end

data/test/unit/config_tests.rb

@@ -7,20 +7,65 @@ class Dassets::Config
   class BaseTests < Assert::Context
     include NsOptions::AssertMacros
     desc "Dassets::Config"
-    subject{ Dassets::Config }
+    setup do
+      @config = Dassets::Config.new
+    end
+    subject{ @config }
 
-    should have_option  :assets_file, Pathname, :default => ENV['DASSETS_ASSETS_FILE']
-    should have_option  :root_path,   Pathname, :required => true
-    should have_options :files_path, :digests_file_path
+    should have_option :root_path,   Pathname, :required => true
+    should have_option :assets_file, Pathname, :default => ENV['DASSETS_ASSETS_FILE']
+    should have_options :source_path, :output_path, :digests_path
+    should have_reader :engines
+    should have_imeth :source, :engine
 
-    should "should use `apps/assets/public` as the default files path" do
+    should "should use `apps/assets` as the default source path" do
+      exp_path = Dassets.config.root_path.join("app/assets").to_s
+      assert_equal exp_path, subject.source_path
+    end
+
+    should "should use `apps/assets/public` as the default output path" do
       exp_path = Dassets.config.root_path.join("app/assets/public").to_s
-      assert_equal exp_path, subject.files_path
+      assert_equal exp_path, subject.output_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
+      assert_equal exp_path, subject.digests_path.to_s
+    end
+
+    should "set the source path and filter proc with the `sources` method" do
+      path = Dassets::RootPath.new 'app/asset_files'
+      filter = proc{ |paths| [] }
+
+      subject.source(path, &filter)
+      assert_equal path, subject.source_path
+      assert_equal filter, subject.source_filter
+    end
+
+    should "know its engines and return a NullEngine by default" do
+      assert_kind_of ::Hash, subject.engines
+      assert_kind_of Dassets::NullEngine, subject.engines['some']
+      assert_kind_of Dassets::NullEngine, subject.engines['thing']
+    end
+
+    should "allow registering new engines" do
+      empty_engine = Class.new(Dassets::Engine) do
+        def ext(input_ext); ''; end
+        def compile(input); ''; end
+      end
+
+      assert_kind_of Dassets::NullEngine, subject.engines['empty']
+      subject.engine 'empty', empty_engine, 'an' => 'opt'
+      assert_kind_of empty_engine, subject.engines['empty']
+
+      assert_equal({'an' => 'opt'}, subject.engines['empty'].opts)
+      assert_equal '', subject.engines['empty'].ext('empty')
+      assert_equal '', subject.engines['empty'].compile('some content')
+    end
+
+    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.output_path
     end
 
   end

data/test/unit/dassets_tests.rb

@@ -8,18 +8,28 @@ module Dassets
     desc "Dassets"
     subject{ Dassets }
 
-    should have_imeths :config, :configure, :init, :digests, :[]
+    should have_imeths :config, :sources, :digests
+    should have_imeths :configure, :reset, :init, :[]
+    should have_imeths :digest_source_files
 
-    should "return its `Config` class with the `config` method" do
-      assert_same Config, subject.config
+    should "return a `Config` instance with the `config` method" do
+      assert_kind_of Config, subject.config
+    end
+
+    should "read the source list on init" do
+      subject.reset
+      assert_empty subject.sources
+
+      subject.init
+      assert_not_empty subject.sources
     end
 
     should "read/parse the digests on init" do
       subject.reset
-      assert_empty subject.digests
+      assert_empty subject.digests.paths
 
       subject.init
-      assert_not_empty subject.digests
+      assert_not_empty subject.digests.paths
     end
 
     should "return asset files given a their path using the index operator" do
@@ -46,4 +56,48 @@ module Dassets
 
   end
 
+  class SourceListTests < BaseTests
+    desc "source list"
+
+    should "build from the configured source path and filter proc" do
+      config = Dassets::Config.new
+      config.source_path = "source_files" # test/support/source_files
+      exp_list = [
+        'test1.txt', '_ignored.txt', 'nested/test2.txt', 'nested/_nested_ignored.txt'
+      ].map{ |p| File.expand_path(p, config.source_path) }.sort
+
+      assert_equal exp_list, Dassets::SourceList.new(config)
+    end
+
+    should "filter out any paths in the output path" do
+      config = Dassets::Config.new
+      config.source_path = "source_files" # test/support/source_files
+      config.output_path = "source_files/nested"
+      exp_list = [
+        'test1.txt', '_ignored.txt'
+      ].map{ |p| File.expand_path(p, config.source_path) }.sort
+
+      assert_equal exp_list, Dassets::SourceList.new(config)
+    end
+
+    should "run the supplied source filter on the paths" do
+      config = Dassets::Config.new
+      config.source_path = "source_files" # test/support/source_files
+      config.source_filter = proc do |paths|
+        paths.reject{ |path| File.basename(path) =~ /^_/ }
+      end
+      exp_list = [
+        'test1.txt', 'nested/test2.txt'
+      ].map{ |p| File.expand_path(p, config.source_path) }.sort
+
+      assert_equal exp_list, Dassets::SourceList.new(config)
+
+      config.source "source_files" do |paths|
+        paths.reject{ |path| File.basename(path) =~ /^_/ }
+      end
+      assert_equal exp_list, Dassets::SourceList.new(config)
+    end
+
+  end
+
 end

data/test/unit/digests_tests.rb

@@ -0,0 +1,79 @@
+require 'assert'
+require 'fileutils'
+require 'dassets/digests'
+require 'dassets/asset_file'
+
+class Dassets::Digests
+
+  class BaseTests < Assert::Context
+    desc "Dassets::Digests"
+    setup do
+      @file_path = File.join(Dassets.config.root_path, 'example.digests')
+      @digests = Dassets::Digests.new(@file_path)
+    end
+    subject{ @digests }
+
+    should have_reader :file_path
+    should have_imeths :[], :[]=, :delete, :clear
+    should have_imeths :paths, :asset_files, :asset_file, :save!
+
+    should "know its file path" do
+      assert_equal @file_path, subject.file_path
+    end
+
+    should "know its asset files" do
+      assert_equal subject.paths.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 "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.paths
+
+      subject.delete 'path/to/file1'
+      assert_not_includes 'path/to/file1', subject.paths
+    end
+
+    should "clear values with the clear method" do
+      assert_not_empty subject.paths
+      subject.clear
+      assert_empty subject.paths
+    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 file path" do
+      assert_not_file_exists subject.file_path
+      subject.save!
+
+      assert_file_exists subject.file_path
+    end
+
+  end
+
+end