dassets 0.6.2 → 0.7.0

data/README.md

@@ -25,24 +25,6 @@ Dassets.configure do |c|
 end
 ```
 
-### Digest
-
-You can use the CLI to digest your source files on demand:
-
-```
-$ dassets digest                       # digest all source files, OR
-$ dassets digest /path/to/source/file  # digest some specific files
-```
-
-Or you can programmatically digest files as needed:
-
-```ruby
-Dassets.digest_source_files                           # digest all source files, OR
-Dassets.digest_source_files ['/path/to/source/file']  # digest just some specific files
-```
-
-Digesting involves combining, compiling, fingerprinting, and outputting each source file.  Once a source has been digested, it is available for linking, serving, and/or caching.
-
 ### Link To
 
 ```rb
@@ -53,7 +35,7 @@ Dassets['img/logos/main.jpg'].href # => "/img/logos/main-a1b2c3.jpg"
 
 ### Serve
 
-In development, use the Dassets middleware to serve your digested asset files:
+Use the Dassets middleware to serve your digested asset files:
 
 ```ruby
 # `app` is a rack application
@@ -61,15 +43,6 @@ require 'dassets/server'
 app.use Dassets::Server
 ```
 
-In production, use the CLI to cache your digested asset files to the public dir:
-
-```
-# call the CLI in your deploy scripts or whatever
-$ dassets cache /path/to/public/dir
-```
-
-TODO: programmatically cache asset files
-
 ## Compiling
 
 Dassets compiles your asset source as part of its digest pipeline using "engines".  Engines transform source extensions and content.

data/lib/dassets/source_file.rb

@@ -1,18 +1,19 @@
 require 'fileutils'
 require 'dassets'
 require 'dassets/asset_file'
+require 'dassets/source_proxy'
 
 module Dassets
 
   class SourceFile
 
-    def self.find_by_digest_path(path)
+    def self.find_by_digest_path(path, cache = nil)
       # look in the configured source list
       source_files = Dassets.source_list.map{ |p| self.new(p) }
 
       # get the last matching one (in case two source files have the same digest
       # path the last one *should* be correct since it was last to be configured)
-      source_files.select{ |s| s.digest_path == path }.last || NullSourceFile.new(path)
+      source_files.select{ |s| s.digest_path == path }.last || NullSourceFile.new(path, cache)
     end
 
     attr_reader :file_path
@@ -80,16 +81,34 @@ module Dassets
 
   end
 
+  # A null source file is used to represent source that either doesn't exist
+  # or source that is a proxy (ie a combination)
+
   class NullSourceFile < SourceFile
-    attr_reader :file_path, :digest_path, :compiled, :fingerprint
-    def initialize(digest_path)
-      @file_path = ''
-      @ext_list = []
+
+    def initialize(digest_path, cache = nil)
+      @file_path, @ext_list = '', []
       @digest_path = digest_path
+      @source_compiled, @source_exists, @source_mtime = nil, false, nil
+
+      # if the digest path is a combination, build its proxy and use relevent
+      # properties as the source file properties
+      if Dassets.config.combination?(@digest_path)
+        source_proxy = SourceProxy.new(@digest_path, cache)
+        @source_compiled = source_proxy.content
+        @source_exists   = source_proxy.exists?
+        @source_mtime    = source_proxy.mtime
+      end
     end
+
+    def compiled; @source_compiled; end
+    def exists?;  @source_exists;   end
+    def mtime;    @source_mtime;    end
+
     def ==(other_source_file)
       self.file_path == other_source_file.file_path
     end
+
   end
 
 end

data/lib/dassets/source_proxy.rb

@@ -6,10 +6,10 @@ class Dassets::SourceProxy
 
   attr_reader :digest_path, :source_files, :cache
 
-  def initialize(digest_path, cache=nil)
+  def initialize(digest_path, cache = nil)
     @digest_path  = digest_path
-    @source_files = get_source_files(@digest_path)
     @cache = cache || NoCache.new
+    @source_files = get_source_files(@digest_path, @cache)
   end
 
   def key
@@ -42,9 +42,9 @@ class Dassets::SourceProxy
     @source_fingerprint ||= Digest::MD5.new.hexdigest(source_content)
   end
 
-  def get_source_files(digest_path)
+  def get_source_files(digest_path, cache)
     Dassets.config.combinations[digest_path.to_s].map do |source_digest_path|
-      Dassets::SourceFile.find_by_digest_path(source_digest_path)
+      Dassets::SourceFile.find_by_digest_path(source_digest_path, cache)
     end
   end
 

data/lib/dassets/version.rb

@@ -1,3 +1,3 @@
 module Dassets
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/dassets.rb

@@ -32,13 +32,6 @@ module Dassets
     SourceList.new(self.config.sources)
   end
 
-  # Cmds
-
-  def self.digest_source_files(paths=nil)
-    require 'dassets/digest_cmd'
-    DigestCmd.new(paths).run
-  end
-
   class Config
     include NsOptions::Proxy
 
@@ -51,7 +44,7 @@ module Dassets
     def initialize
       super
       @sources = []
-      @combinations = Hash.new{ |h,k| [k] } # digest pass-thru if none defined
+      @combinations = Hash.new{ |h, k| [k] } # digest pass-thru if none defined
       @cache = DefaultCache.new
     end
 
@@ -62,6 +55,12 @@ module Dassets
     def combination(key_digest_path, value_digest_paths)
       @combinations[key_digest_path.to_s] = [*value_digest_paths]
     end
+
+    def combination?(key_digest_path)
+      # a digest path is only considered a combination is it is not the default
+      # pass-thru above
+      @combinations[key_digest_path.to_s] != [key_digest_path]
+    end
   end
 
   module SourceList

data/test/unit/config_tests.rb

@@ -16,7 +16,7 @@ class Dassets::Config
     should have_options :file_store
 
     should have_reader :combinations
-    should have_imeth :source, :combination
+    should have_imeth :source, :combination, :combination?
 
     should "register new sources with the `source` method" do
       path = '/path/to/app/assets'
@@ -45,6 +45,13 @@ class Dassets::Config
       assert_equal ['some/other.path'], subject.combinations['test/digest.path']
     end
 
+    should "know which digest paths are actual combinations and which are just pass-thrus" do
+      subject.combination 'some/combination.path', ['some.path', 'another.path']
+
+      assert     subject.combination? 'some/combination.path'
+      assert_not subject.combination? 'some/non-combo.path'
+    end
+
   end
 
 end

data/test/unit/dassets_tests.rb

@@ -9,7 +9,7 @@ module Dassets
     subject{ Dassets }
 
     should have_imeths :config, :configure, :init, :[]
-    should have_imeths :source_list, :digest_source_files
+    should have_imeths :source_list
 
     should "return a `Config` instance with the `config` method" do
       assert_kind_of Config, subject.config

data/test/unit/source_file_tests.rb

@@ -1,10 +1,11 @@
 require 'assert'
-require 'dassets/asset_file'
 require 'dassets/source_file'
 
+require 'dassets/asset_file'
+
 class Dassets::SourceFile
 
-  class BaseTests < Assert::Context
+  class UnitTests < Assert::Context
     desc "Dassets::SourceFile"
     setup do
       @file_path = TEST_SUPPORT_PATH.join('app/assets/file1.txt').to_s
@@ -50,17 +51,38 @@ class Dassets::SourceFile
       assert_not_same subject, found
     end
 
+  end
+
+  class NullSourceTests < UnitTests
+
     should "find a null src file if finding by an unknown digest path" do
       null_src = Dassets::NullSourceFile.new('not/found/digest/path')
       found = Dassets::SourceFile.find_by_digest_path('not/found/digest/path')
 
-      assert_equal null_src, found
+      assert_equal    null_src, found
       assert_not_same null_src, found
+
+      assert_equal '',    null_src.file_path
+      assert_equal false, null_src.exists?
+      assert_nil null_src.compiled
+      assert_nil null_src.mtime
+    end
+
+    should "'proxy' the digest path if the path is a combination" do
+      Dassets.config.combination 'file3.txt', ['file1.txt', 'file2.txt']
+      src_proxy      = Dassets::SourceProxy.new('file3.txt')
+      null_combo_src = Dassets::NullSourceFile.new('file3.txt')
+
+      assert_equal src_proxy.exists?, null_combo_src.exists?
+      assert_equal src_proxy.content, null_combo_src.compiled
+      assert_equal src_proxy.mtime,   null_combo_src.mtime
+
+      Dassets.config.combinations.delete('file3.txt')
     end
 
   end
 
-  class EngineTests < BaseTests
+  class EngineTests < UnitTests
     desc "compiled against engines"
     setup do
       @file_path = TEST_SUPPORT_PATH.join('app/assets/nested/a-thing.txt.useless.dumb')

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-12 00:00:00 Z
+date: 2013-08-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -97,8 +97,8 @@ description: Digest and serve HTML asset files
 email: 
 - kelly@kellyredding.com
 - collin.redding@me.com
-executables: 
-- dassets
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
@@ -109,16 +109,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/dassets
 - dassets.gemspec
 - lib/dassets.rb
 - lib/dassets/asset_file.rb
-- lib/dassets/cli.rb
 - lib/dassets/default_cache.rb
-- lib/dassets/digest_cmd.rb
 - lib/dassets/engine.rb
 - lib/dassets/file_store.rb
-- lib/dassets/runner.rb
 - lib/dassets/server.rb
 - lib/dassets/server/request.rb
 - lib/dassets/server/response.rb
@@ -145,16 +141,13 @@ files:
 - test/support/source_files/nested/_nested_ignored.txt
 - test/support/source_files/nested/test2.txt
 - test/support/source_files/test1.txt
-- test/system/digest_cmd_run_tests.rb
 - test/system/rack_tests.rb
 - test/unit/asset_file_tests.rb
 - test/unit/config_tests.rb
 - test/unit/dassets_tests.rb
 - test/unit/default_cache_tests.rb
-- test/unit/digest_cmd_tests.rb
 - test/unit/engine_tests.rb
 - test/unit/file_store_tests.rb
-- test/unit/runner_tests.rb
 - test/unit/server/request_tests.rb
 - test/unit/server/response_tests.rb
 - test/unit/server_tests.rb
@@ -214,16 +207,13 @@ test_files:
 - test/support/source_files/nested/_nested_ignored.txt
 - test/support/source_files/nested/test2.txt
 - test/support/source_files/test1.txt
-- test/system/digest_cmd_run_tests.rb
 - test/system/rack_tests.rb
 - test/unit/asset_file_tests.rb
 - test/unit/config_tests.rb
 - test/unit/dassets_tests.rb
 - test/unit/default_cache_tests.rb
-- test/unit/digest_cmd_tests.rb
 - test/unit/engine_tests.rb
 - test/unit/file_store_tests.rb
-- test/unit/runner_tests.rb
 - test/unit/server/request_tests.rb
 - test/unit/server/response_tests.rb
 - test/unit/server_tests.rb

data/bin/dassets

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-#
-# Copyright (c) 2013-Present Kelly Redding and Collin Redding
-#
-
-require 'dassets/cli'
-Dassets::CLI.run *ARGV

data/lib/dassets/cli.rb

@@ -1,109 +0,0 @@
-require 'dassets/version'
-require 'dassets/runner'
-
-module Dassets
-
-  class CLI
-
-    def self.run(*args)
-      self.new.run(*args)
-    end
-
-    def initialize
-      @cli = CLIRB.new
-    end
-
-    def run(*args)
-      begin
-        @cli.parse!(args)
-        Dassets::Runner.new(@cli.args, @cli.opts).run
-      rescue CLIRB::HelpExit
-        puts help
-      rescue CLIRB::VersionExit
-        puts Dassets::VERSION
-      rescue Dassets::Runner::UnknownCmdError => err
-        $stderr.puts "#{err.message}\n\n"
-        $stderr.puts help
-        exit(1)
-      rescue Dassets::Runner::CmdError => err
-        $stderr.puts "#{err.message}"
-        exit(1)
-      rescue Dassets::Runner::CmdFail => err
-        exit(1)
-      rescue CLIRB::Error => exception
-        $stderr.puts "#{exception.message}\n\n"
-        $stderr.puts help
-        exit(1)
-      rescue Exception => exception
-        $stderr.puts "#{exception.class}: #{exception.message}"
-        $stderr.puts exception.backtrace.join("\n")
-        exit(1)
-      end
-      exit(0)
-    end
-
-    def help
-      "Usage: dassets [options] COMMAND\n"\
-      "\n"\
-      "Options:"\
-      "#{@cli}"
-    end
-
-  end
-
-  class CLIRB  # Version 1.0.0, https://github.com/redding/cli.rb
-    Error    = Class.new(RuntimeError);
-    HelpExit = Class.new(RuntimeError); VersionExit = Class.new(RuntimeError)
-    attr_reader :argv, :args, :opts, :data
-
-    def initialize(&block)
-      @options = []; instance_eval(&block) if block
-      require 'optparse'
-      @data, @args, @opts = [], [], {}; @parser = OptionParser.new do |p|
-        p.banner = ''; @options.each do |o|
-          @opts[o.name] = o.value; p.on(*o.parser_args){ |v| @opts[o.name] = v }
-        end
-        p.on_tail('--version', ''){ |v| raise VersionExit, v.to_s }
-        p.on_tail('--help',    ''){ |v| raise HelpExit,    v.to_s }
-      end
-    end
-
-    def option(*args); @options << Option.new(*args); end
-    def parse!(argv)
-      @args = (argv || []).dup.tap do |args_list|
-        begin; @parser.parse!(args_list)
-        rescue OptionParser::ParseError => err; raise Error, err.message; end
-      end; @data = @args + [@opts]
-    end
-    def to_s; @parser.to_s; end
-    def inspect
-      "#<#{self.class}:#{'0x0%x' % (object_id << 1)} @data=#{@data.inspect}>"
-    end
-
-    class Option
-      attr_reader :name, :opt_name, :desc, :abbrev, :value, :klass, :parser_args
-
-      def initialize(name, *args)
-        settings, @desc = args.last.kind_of?(::Hash) ? args.pop : {}, args.pop || ''
-        @name, @opt_name, @abbrev = parse_name_values(name, settings[:abbrev])
-        @value, @klass = gvalinfo(settings[:value])
-        @parser_args = if [TrueClass, FalseClass, NilClass].include?(@klass)
-          ["-#{@abbrev}", "--[no-]#{@opt_name}", @desc]
-        else
-          ["-#{@abbrev}", "--#{@opt_name} #{@opt_name.upcase}", @klass, @desc]
-        end
-      end
-
-      private
-
-      def parse_name_values(name, custom_abbrev)
-        [ (processed_name = name.to_s.strip.downcase), processed_name.gsub('_', '-'),
-          custom_abbrev || processed_name.gsub(/[^a-z]/, '').chars.first || 'a'
-        ]
-      end
-      def gvalinfo(v); v.kind_of?(Class) ? [nil,gklass(v)] : [v,gklass(v.class)]; end
-      def gklass(k); k == Fixnum ? Integer : k; end
-    end
-  end
-
-end

data/lib/dassets/digest_cmd.rb

@@ -1,41 +0,0 @@
-require 'fileutils'
-require 'dassets'
-require 'dassets/source_file'
-
-module Dassets; end
-class Dassets::DigestCmd
-
-  # TODO: need digest cmd to be aware of and digest combinations as well.
-  # going to wait on this for now b/c there are changes coming to how sources
-  # are obtained and the future of the digest cmd and I want to see how thost
-  # end up first.
-
-  attr_reader :paths
-
-  def initialize(abs_paths)
-    @paths = abs_paths || []
-  end
-
-  def run(io=nil)
-    files = @paths
-    if @paths.empty?
-      # always get the latest source list
-      files = Dassets.source_list
-    end
-
-    log io, "digesting #{files.count} source file(s) ..."
-    digest_the_files(files)
-  end
-
-  private
-
-  def digest_the_files(files)
-    files.each{ |f| Dassets::SourceFile.new(f).asset_file.digest! }
-  end
-
-  def log(io, msg)
-    io.puts msg if io
-  end
-
-end
-

data/lib/dassets/runner.rb

@@ -1,39 +0,0 @@
-require 'dassets'
-
-module Dassets; end
-class Dassets::Runner
-  UnknownCmdError = Class.new(ArgumentError)
-  CmdError = Class.new(RuntimeError)
-  CmdFail = Class.new(RuntimeError)
-
-  attr_reader :cmd_name, :cmd_args, :opts
-
-  def initialize(args, opts)
-    @opts = opts
-    @cmd_name = args.shift || ""
-    @cmd_args = args
-    @pwd = ENV['PWD']
-  end
-
-  def run
-    Dassets.init
-
-    case @cmd_name
-    when 'digest'
-      require 'dassets/digest_cmd'
-      abs_paths = @cmd_args.map{ |path| File.expand_path(path, @pwd) }
-      Dassets::DigestCmd.new(abs_paths).run($stdout)
-    when 'null'
-      NullCommand.new.run
-    else
-      raise UnknownCmdError, "unknown command `#{@cmd_name}`"
-    end
-  end
-
-  class NullCommand
-    def run
-      # if this was a real command it would do something here
-    end
-  end
-
-end

data/test/system/digest_cmd_run_tests.rb

@@ -1,68 +0,0 @@
-require 'assert'
-require 'fileutils'
-require 'dassets'
-
-module Dassets
-
-  class DigestCmdRunTests < Assert::Context
-    desc "the DigestCmd"
-    setup do
-      Dassets.config.file_store = TEST_SUPPORT_PATH.join('public').to_s
-      clear_store_path(Dassets.config.file_store.root)
-      Dassets.digest_source_files
-
-      @addfile = 'addfile.txt'
-      @addfile_src = source_path(@addfile)
-
-      @rmfile = 'file1.txt'
-      @rmfile_src = source_path(@rmfile)
-      @rmfile_contents = File.read(@rmfile_src)
-
-      FileUtils.touch @addfile_src
-      @addfile_out = store_path(@addfile)
-
-      @rmfile_out = store_path(@rmfile)
-      FileUtils.rm @rmfile_src
-    end
-    teardown do
-      File.open(@rmfile_src,  "w"){ |f| f.write @rmfile_contents }
-      FileUtils.rm @addfile_src
-
-      Dassets.digest_source_files
-      clear_store_path(Dassets.config.file_store.root)
-      Dassets.digest_source_files
-      Dassets.config.file_store = NullFileStore.new
-    end
-
-    should "update the digests on all source files when run with no given paths" do
-      clear_store_path(Dassets.config.file_store.root)
-      Dassets.digest_source_files
-
-      assert_file_exists @addfile_out
-      assert_not_file_exists @rmfile_out
-    end
-
-    should "update the digests on a single source file when given its path" do
-      clear_store_path(Dassets.config.file_store.root)
-      Dassets.digest_source_files([@addfile_src])
-
-      assert_file_exists @addfile_out
-    end
-
-    private
-
-    def source_path(file)
-      File.join(Dassets.config.sources.first.path, file)
-    end
-
-    def store_path(file)
-      Dassets.config.file_store.store_path(Dassets::AssetFile.new(file).url)
-    end
-
-    def clear_store_path(path)
-      Dir.glob(File.join(path, '*')).each{ |p| FileUtils.rm_r(p) } if path
-    end
-
-  end
-
-end

data/test/unit/digest_cmd_tests.rb

@@ -1,23 +0,0 @@
-require 'assert'
-require 'dassets'
-require 'dassets/digest_cmd'
-
-class Dassets::DigestCmd
-
-  class BaseTests < Assert::Context
-    desc "Dassets::DigestCmd"
-    setup do
-      @cmd = Dassets::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/runner_tests.rb

@@ -1,29 +0,0 @@
-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